diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ACS.SPiiPlusNET.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/ACS.SPiiPlusNET.dll deleted file mode 100644 index f21904b..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/ACS.SPiiPlusNET.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AXL.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AXL.dll deleted file mode 100644 index 0dd47e3..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AXL.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AXL.lib b/Machines/_out_prismatic_rd_ptop/x64-Debug/AXL.lib deleted file mode 100644 index d4eaa23..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AXL.lib and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ActUtlTypeLib.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/ActUtlTypeLib.dll deleted file mode 100644 index 8dcee07..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/ActUtlTypeLib.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Aurora.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Aurora.exe deleted file mode 100644 index 5fc7161..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Aurora.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Aurora.exe.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/Aurora.exe.config deleted file mode 100644 index ccbce02..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/Aurora.exe.config +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Aurora.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/Aurora.xml deleted file mode 100644 index 4aead6a..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/Aurora.xml +++ /dev/null @@ -1,22585 +0,0 @@ - - - - Aurora - - - - - Setting For Aurora UI - - - - - eLeftMenuCollapse - - - - CollapseAsDefault - - - NoCollapseAsDefault - - - 확장 버튼 감춤 - - - - eLeftMenuTreeExpand - - - - ExpandAllAsDefault - - - NotExpandAsDefault - - - ExpandSingleSelected - - - - LeftMenuSetting - - - - ExpandSingleSelected - - - LeftMenuCollapse - - - LeftMenuTreeExpand - - - ExpandSingleSelected - - - - ToastNotificationSetting - - - - ToastAlign - - - LifeTime - - - Width - - - MaxCount - - - OffsetX - - - OffsetY - - - - FullScreenOption - - - - ShowCloseButton - - - HorizontalAlign - - - verticalAlign - - - LeftMargin - - - RightMargin - - - TopMargin - - - BottomMargin - - - - ChartView.xaml에 대한 상호 작용 논리 - - - ChartView - - - - - InitializeComponent - - - - - CorrelationChart.xaml에 대한 상호 작용 논리 - - - CorrelationChart - - - - - InitializeComponent - - - - - ItemListView.xaml에 대한 상호 작용 논리 - - - ItemListView - - - - - InitializeComponent - - - - - LineChartMulti.xaml에 대한 상호 작용 논리 - - - LineChartMulti - - - - - InitializeComponent - - - - - LineChartMultiItems.xaml에 대한 상호 작용 논리 - - - LineChartMultiItems - - - - - InitializeComponent - - - - - LineChartView.xaml에 대한 상호 작용 논리 - - - LineChartView - - - - - InitializeComponent - - - - - MultiSeriesChart - - - - - InitializeComponent - - - - - ProcessCapabilityChart - - - - - InitializeComponent - - - - - SeriesChart - - - - - InitializeComponent - - - - - RulerHorizontal - - - - - InitializeComponent - - - - - RulerVertical - - - - - InitializeComponent - - - - - DefectMapView - - - - - InitializeComponent - - - - - ImageOverlay - - - - - InitializeComponent - - - - - LiveView.xaml에 대한 상호 작용 논리 - - - - - LiveView - - - - - InitializeComponent - - - - - LogControl.xaml에 대한 상호 작용 논리 - - - LogControl - - - - - InitializeComponent - - - - - MessageDialog - - - - - InitializeComponent - - - - - EmergencyButton - - - - - InitializeComponent - - - - - VPStatus.xaml에 대한 상호 작용 논리 - - - VPStatusView - - - - - InitializeComponent - - - - - SequenceButton - - - - - InitializeComponent - - - - - 소켓 디바이스 추상 클래스 - - - - - Socket 직접 호출 - - - - - Socket 비동기 식으로 처리할 경우 해당 함수 override 하여 사용 할 것. - - - - - - - 그랩 준비 명령 - - camera id - 카메라에 적용할 param - 0 : success, !0 : error - - - - 그랩 시작 명령 - - camera id - Scan 구분용 ID - 그랩할 frame count - 카메라에 적용할 param - 0 : success, !0 : error - - - - 그랩 종료 명령 - - camera id - 0 : success, !0 : error - - - - sw trigger 명령 - - camera id - 0 : success, !0 : error - - - - imagePath의 이미지를 그랩하는 sw trigger 명령 - - camera id - 이미지 경로 - 0 : success, !0 : error - - - - exposure 변경 명령 - - camera id - exposure - 0 : success, !0 : error - - - - exposure 확인 명령 - - camera id - exposure - - - - gain 변경 명령 - - camera id - gain - 0 : success, !0 : error - - - - gain 확인 - - camera id - gain - - - - 그래버에 연결된 Camera 이름 리스트 확인 명령 - - Camera 이름 리스트 - - - - camera 설정 업데이트 명령 - - camera id - camera 설정 - 0 : success, !0 : error - - - - camera 설정 확인 명령 - - camera id - camera 설정 - - - - camera 에 param 전송 명령 - - camera id - param - 0 : success, !0 : error - - - - 인터페이스와 어답터 라이브러리 버전 - - 버전 - - - Modbus Serial Connection Config Class - - Implemented by inheriting IConnConfig. - - - - - - Slave Id - - - - - Serial Communication Protocol - - - - TCP Modbus Connection Config class - - Implemented by inheriting IConnConfig. - - - - - - Socket Address - - - - - Slave Id - - - - Modbus TCP Config. - - Implemented by inheriting IDeviceConfig. - - - - - - ConnConfig - - - - - ModubsTCPConfig - - - - Modbus RTU Config. - - Implemented by inheriting IDeviceConfig. - - - - - - ConnConfig - - - - - ModbusRTUConfig - - - - Modbus ASCII Config. - - Implemented by inheriting IDeviceConfig. - - - - - - ConnConfig - - - - - ModbusASCIIConfig - - - - 비동기 소켓에서 발생한 에러 처리를 위한 이벤트 Argument Class - - - 비동기 소켓의 연결 및 연결해제 이벤트 처리를 위한 Argument Class - - - 비동기 소캣의 데이터 전송 이벤트 처리를 위한 Argument Class - - - 비동기 소켓의 데이터 수신 이벤트 처리를 위한 Argument Class - - - 비동기 서버의 Accept 이벤트를 위한 Argument Class - - - delegate 정의 - - - - Digital IO 클래스 - - - - @param channel channel 지정 - 만약 channel이 음수라면 모든 channel에 대해서 명령 수행 - - - @param channel channel 지정 - 만약 channel이 음수라면 모든 channel에 대해서 명령 수행 - - - @param channel channel 지정 - 만약 channel이 음수라면 모든 channel에 대해서 명령 수행 - - - - Motor abstract class. - - - - note: 현재 이게 없으면 - Motor 인터페이스를 통해 Mover(C++)에게 native handle을 전달할 방법이 없음 - 대안1. C#으로 Motor를 안 만든다. (말도안됨) - 대안2. C++에서 C# 모터를 역으로 호출할 수 있는 wrapper를 추가한다 - - 우선 NativeMotor에 둔다 - - - - Move Range - - double move range - - - - Get motor velocity Range - - unsinged integer range - - - - Set motor velocity - - velocity - E1.OK or error - - - - Get motor velocity - - velocity - - - - Get current motor position - - current position - - - - Set motor target position - - - ABS or INC - E1.OK or error - - - - Get motor target posision - - current target position - - - - Set servo on/off - - - ok or error - - - - Start homing - - ok or error - - - - Move motor axis. - - ok or error - - - - Start jog - - 1 or -1 - jog velocity - ok or error - - - - Start jog increment - - - - ok or error - - - - Stop move. - - ok or error - - - - Is servo on? - - true or false - - - - Is home complete? - - true or false - - - - Is Alarm exist? - - true or false. - - - - Is axis moving? - - true or false - - - - Clear alarm. - - ok or error - - - - Get alarm list. - - list of alarms - - - - BaseConfig Motor Config. - - - - Connection configuration - ConnConfig - - - - - Move range - - - - - Velocity Range - - - - - Default Velocity - - - - - Reverse Direction - - - - - Disable movement check - - - - - Native Digital IO - - - - - Native handle for C++ - - - - - Constructor - - - - - - Create Mock Digital IO - - - - - - Activate - - - - - - - Deactivate - - - - - - Write Bit - - - - - - - - Write Word - - - - - - - - Write double word - - - - - - - - Write real(float) - - - - - - - - Write bit block - - - - - - - - - Write word block - - - - - - - - - Read bit - - - - - - - Read word - - - - - - - Read double word - - - - - - - Read real - - - - - - - Read bit block - - - - - - - - Read word block - - - - - - - - 시리얼 통신 Class - - - - - Gets the number of bytes of data in the receive buffer. - - - - - Gets the number of bytes of data in the send buffer. - - - - - 시리얼 통신 Class - - - - - - - - 데이터 수신 시 event 등록 - - - - - - 데이터 수신 시 event 해제 - - - - - - 에러 수신 시 event 등록 - - - - - - 에러 수신 시 event 해제 - - - - - - Port Open. - - - - - - - check if port already opened. - - - - - - Close opened port. - - - - - - Write. - - Write할 스트링 Data - - - - - Write하고 응답을 읽는다. - - Write할 String Data - - - - - Server로부터 스트링데이터를 읽는다. - - - - - - 버퍼에 있는 스트링을 읽는다. - - - - - - - - ReadExisting - - - - - - - - - Write byte array data - - - - - - - - WriteAndRead - - - - - - - - - 최대 nReadBuffer.Length(Byte)를 1회 Read 한다. - Output의 크기(Byte)는 nReadBuffer.Length보다 작거나 같다. - - - - - - - Output의 길이가 nReadBuffer.Length(Byte)가 될때까지 반복 Read 한다. - Timeout : Default - - - - - - - Output의 길이가 requestLength(Byte)가 될 때까지 반복 Read 한다. - Timeout : Default - - - - - - - - Output의 길이가 requestLength(Byte)가 될 때까지 반복 Read 한다. - - - - Timeout - - - - - Output에 msgHeader와 msgFooter가 모두 포함될 때까지 반복 Read 한다. - Timeout : Default - - - - - - - - - Output에 msgHeader와 msgFooter가 모두 포함될 때까지 반복 Read 한다. - - - - - Timeout - - - - - IsOpen? - - - - - - Gets the number of bytes of data in the receive buffer. - - - - - Gets the number of bytes of data in the send buffer. - - - - - 데이터 수신 시 event 등록 - - - - - - 데이터 수신 시 event 해제 - - - - - - 에러 수신 시 event 등록 - - - - - - 에러 수신 시 event 해제 - - - - - public bool IsConnected { get; set; } = false; - - - 데이터 수신을 비동기적으로 처리 - - - 데이터 수신 처리 콜백 함수 - - - 데이터 송신을 비동기적으로 처리 - - - 데이터 송신 처리 콜백 함수 - - - 소켓 연결을 비동기적으로 종료 - - - 소켓 연결 종료를 처리하는 콜백 함수 - - - 비동기 소켓 - - - - Socket 직접 호출 - - - - - Socket 비동기 식으로 처리할 경우 해당 함수 override 하여 사용 할 것. - - - - - - - 그랩 준비 명령 - - 카메라에 적용할 param - 0 : success, !0 : error - - - - 그랩 시작 명령 - - Scan 구분용 ID - 그랩할 frame count - Scan 카메라에 적용할 param - 0 : success, !0 : error - - - - 그랩 종료 명령 - - 0 : success, !0 : error - - - - sw trigger 명령 - - 0 : success, !0 : error - - - - imagePath의 이미지를 그랩하는 sw trigger 명령 - - 이미지 경로 - 0 : success, !0 : error - - - - exposure 변경 명령 - - exposure - 0 : success, !0 : error - - - - exposure 확인 명령 - - exposure - - - - gain 변경 명령 - - gain - 0 : success, !0 : error - - - - gain 확인 - - gain - - - - camera 설정 업데이트 명령 - - camera 설정 - 0 : success, !0 : error - - - - camera 설정 확인 명령 - - camera 설정 - - - - camera 에 param 전송 명령 - - param - 0 : success, !0 : error - - - - 인터페이스와 어답터 라이브러리 버전 - - 버전 - - - - - - - - - Manager Interface for Ingredients - - - - - DataKeys - 등록된 Ingredient Name 리스트 - - - - - - Ingredient 가져오기. - - - - - - - Ingredient Indexer - - - - - - - Ingredient의 Data Path가져오기 - - - - - - Manager Interface for Model - - - - - New Model - - - - - - - Rename Model - - - - - - - - Copy Model - - - - - - - - Remove Model - - - - - - - Save Model Item - - - - - - - - - Reload Model Item - - - - - - - - Clone 제공. 편의상 - - - - - - - - View를 제어할 때 사용 - - - - - MainMenu를 선택적으로 Enable/Disable할 수 있다. 하나라도 Disable이면 서랍메뉴는 Disable - - Enable/Disable 설정 - View ID List - - - - - 모든 MainMenu를 Enable/Disable할 수 있다. 서랍메뉴도 함께 Enable/Disable 된다. - - Enable/Disable 설정 - 제외할 View ID - - - - - Menu를 변경한다. - - 변경할 Main ID - 변경할 Sub ID. 미입력 시 현재값 - - - - - 화면 인터락 - - screen lock or unlock - - - - - 도어 자물쇠 Lock/Unlock - - door lock or unlock - - - - - 타워램프 On/Off - - Red, Orange, Green - - - - - 좌상단 전체화면 버튼기능 - - 전체화면 모드인지 창모드인지 - - - - - 현재 view가 full screen모드를 지원하면 full screen으로 변경하는 기능 - - full screen모드인지 일반모드인지 - - - - - 언어변경 - - LanguageDefs의 값 참조. 혹은 직접 코드 입력 ex. en-US - - - - - LogInDialog창 띄움 - - - - - - 등록한 전체 메뉴의 리스트 제공 - - - - - - FixedContent Top 영역의 Visiblity - - - - - - - FixedContent Bottom 영역의 Visiblity - - - - - - - FixedContent Left 영역의 Visiblity - - - - - - - FixedContent Right 영역의 Visiblity - - - - - - - 현재 뷰의 아이디 반환 - - - - - - Recipe Info에 id, name 외에도 날짜나 Model Name 정보 등이 추가될 예정이며 이를 저장할 기능이 필요 - - - - - - 변동부에서 특정 상황에 해당 subject의 recipe를 저장하지 못하도록 막기 혹은 풀기 - - 설정할 recipe ID - 막기 : true, 풀기 : false - - - - - 해당 subject가 save lock 되어있는지 확인 - - - - - - - View를 등록할 때 사용 - - - - - Register Title Component. 타이틀바 하단 중앙 - - - - - - - Register Fixed Component. 컨텐츠 영역 상단 - - - - - - - View가 변경되어도 바뀌지 않는 고정영역의 content를 등록한다. - - - - - - - - - - Only use Inspection UI. Register Bottom Component. MainBody 아래 - - - - - - - Register Status Component. 최하단 - - - - - - - 스크린 락 화면을 등록 - - - - - - - Aurora 플랫폼에 viewGroup 을 등록한다. - ViewGroup 설정 여부에 따라 Aurora 플랫폼의 기본 UI Layout 이 변경된다. - Group 의 개수가 2 개 이상이면 Aurora 플랫폼의 기본 UI Layout 이 - GroupView 또는 MenuView style 이 적용된다. - - - 각 viewGroup 를 구분하는 key 값으로 활용되며, viewGroup 간에 유일하여야 한다. - - - 각 viewGroup 을 표시하는 Icon 이다. - 해당 Icon 이 설정되면, MenuView style 의 UI Layout 이 적용되고, - 설정되지 않으면, GroupView style 의 UI Layout 이 적용된다. - - - 해당 viewGroup 의 접근을 사용자 계정의 그룹 권한에 따라 접근을 제한하는 데 사용된다. - 기본값은 PermissionLevel.NONE 로 권한에 따른 접근에 제한이 없다. - - - - - Aurora 플랫폼에 view 를 등록한다. - ViewGroup 설정 여부에 따라 Aurora 플랫폼의 기본 UI Layout 이 변경된다. - - - 각 view 를 구분하는 key 값으로 활용되며, view 간에 유일하여야 한다. - viewGroup 이 등록되어 있다면, 등록된 Group 내에서 view 간에 유일하여야 한다. - - - 직접 구현한 view (FrameworkElement: UserControl 등) 또는 - Aurora 플랫폼에서 제공하는 view 인 - DeviceSettingView, RecipeSettingView, EquipSettingView 등을 사용할 수 있다. - - - 해당 View의 접근을 사용자 계정의 그룹 권한에 따라 View 의 접근을 제한하는 데 사용된다. - 기본값은 PermissionLevel.NONE 로 권한에 따른 접근에 제한이 없다. - - - ViewSelect 버튼 선택시 각 view 가 보여질 방법에 대한 enum 값이며, - ViewPlace.Dialog 는 Dialog 내에 - ViewPlace.LeftInBody, ViewPlace.RightInBody 는 Main Body 의 Left, Right 영역에 - ViewPlace.ReplaceAtIcon 은 현재 영역의 Icon 자리를 대체하여 각 view 를 보여준다. - - - 등록된 Group 의 name 으로 해당 Group 의 SubItem 으로 view 가 등록된다. - - - Group 내에서 보여줄 ViewSelect 버튼의 Icon 이다. - ViewSelect 버튼은 MainStatusView 영역에 Group 의 순서대로 Icon 으로 표시된다. - - - - - View 변경 시 발생되는 delegate를 등록 - - main ID, sub ID를 파라메터로 받고 View 변경 가능여부를 리턴함 - - - - - Title Bar의 우상단 Device Status를 클릭 시 발생되는 delegate를 등록, 등록하지 않을 시 default View 사용 - - Action - - - - - Title Bar의 우상단 Recipe Status를 클릭 시 발생되는 delegate를 등록 - - Action - - - - - If ShowSubMenuBar is false, only one SubView should be registered. - - - - - If AddButtonType is used, AddSubMenu cannot be used. - - - - - - - - - - - - - - - - - - - Sub's permission cannot be less than Main's permission. - - - - - - - - - - - - - - - - - - - - - - - - - 성공시 테이블 이름, 실패시 빈 문자열 - - - - - - 성공시 0 (E1.OK) 실패시 음수 에러코드. - - - - - - 성공시 테이블 이름, 실패시 빈 문자열 - - - - - 성공시 테이블 목록, 실패시 빈 목록 - - - - - - 성공시 0 (E1.OK) 실패시 음수 에러코드. - 단, 저장이 성공한 것은 아니며, 저장 요청이 성공이라는 의미이다. - - - - - - 검색 조건을 담을 데이터 - 갱신 내용을 담은 데이터 - 검색 데이터중 조건으로 사용될 프로퍼티 이름들 - 갱신 데이터중 갱신할 내용으로 사용될 프로퍼티 이름들 - 성공시 갱신된 데이터 갯수, 실패시 음수 에러코드 - - - - - 범위 검색 조건 필드 이름 - 범위 검색 from 값 - 범위 검색 to 값 - 데이터 목록을 얻을 수 있는 Reader - - - - - DataGravityServiceView - - - - - InitializeComponent - - - - - CollectionHubServiceView.xaml에 대한 상호 작용 논리 - - - MongoDBServiceView - - - - - InitializeComponent - - - - - 쿼리 시 Range, Limit개수, 오름/내림차순(default:오름) 정보, TimeZone 설정 - - - - - DataSinkServiceView.xaml에 대한 상호 작용 논리 - - - DataHubServiceView - - - - - InitializeComponent - - - - - Data to File Uploader - - - - - Constructor - - RPC Service Name - - - - - - - - - - Parser 추가 - - data 이름 - - - - - Upload Data. Sync Api - - - - - - - Upload data async. - - - - - - - Upload data. - - - 완료 Delegate - - - - - eStreamDirectoryDepth - - - - - eStreamDirectory1Depth - - - - - eStreamDirectory2Depth - - - - - eStreamDirectory3Depth - - - - - StramDirectoryDepth - - - - - StreamDataUploadClientConfig - - - - Upload Chunk Size - - - RemoteRootDirectory - - - IsOverwriteSameFile - - - BaseFileName - - - Extension - - - MakeDirectoryAutomatically - - - DirectoryDepth - - - Constructor - - - - File Upload Server (Client로부터 파일을 받아 저장한다.) - - - - - 생성자 - - 업로드 서비스명. 클라이언트가 이를 이용해 업로드 - - - - - - - - - - Stream Upload file client to Server - - - - - 생성자 - - 서버의 서비스 이름 - - - - - - StreamFileUploadClientConfig - - - - - - - - Upload file - - 업로드할 파일 경로 - 업로드할 서버 디렉토리 경로 - - - - - awaitable upload file api - - 업로드할 파일 경로 - 업로드할 서버 디렉토리 경로 - - - - - 비동기 file upload - - 업로드할 파일 경로 - 업로드할 서버 디렉토리 경로 - 완료 Delegate - 진행률 Delegate - - - - - StreamFileUploadClientConfig - - - - - FileChunkSize - - - - - 서버의 업로드 경로의 Root. - - - - - 동일 파일 있을시 덮어쓸지의 여부. false인 경우 업로드 실패한다. - - - - - 생성자. - - - - - StreamTalkClient - - - - - 생성자 - - Manager의 서비스 이름 - - - - - - StreamTalkClientConfig - - - - - - - - GetTotalMessageCount - - - - - - GetTotalDataSize - - - - - - GetLastTransferTime - - - - - - 1:1 신규 Talk을 생성한다. - UI Thread에서만 허용한다. - awaitable api. - - - - - - - Talk Phrase. 관용구 - - - - 관용구 - - - 사용횟수 - - - - StreamTalkClientConfig - - - - EventServer. Manager로부터 온 메시지를 처리한다. - - - EventRequester. Manager에게 이벤트를 보낸다. - - - ChatName. 미 설정시 로그인 id. 미 로그인시 guest로 설정된다. - - - 관용구 리스트 - - - Talk으로부터 파일을 받을때 너무 크면 바로 파일로 저장 - - - 바로 파일로 저장시의 Min Size - - - - 생성자 - - - - - Config를 담는 저장형식 - - - - - Recipe를 담는 저장형식 - - - - - Setting을 담는 저장형식 - - - - - Model을 담는 저장형식 - - - - - Device를 담는 저장형식 - - - - - Config 종류별로 Item(Subject)을 담는 저장형식 - - - - - 장비의 기본 정보들, 대시보드 구성용 - - - - - Normal, Dryrun, Transfer - - - - - Main 시퀀스를 정할 수 있으면 해당 시퀀스의 동작여부 - - - - - Door가 열려있으면 True - - - - - Stream 브로드캐스트 퍼블리셔. 퍼블리셔 이름은 유일하다. - - - - - 생성자 - - - - - - - - StreamBroadcastPubConfig - - - - - - - - 파서 추가 - - - - - - - 노티 브로드캐스트 - - - - - - - object 퍼블리시 - - - - - - - - - Publish - - - - - - - - - StreamBroadcastPubConfig class - - - - - 자동 압축 여부 - - - - - 압축 최소 크기 - - - - - 압축 알고리즘 - - - - - 생성자 - - - - - 브로드캐스트 구독 - - - - - 구독 Delegate - - - - - - - - - 생성자 - - - - - - - - StreamBroadcastSubConfig - - - - - - - - 파서 추가 - - - - - - - 구독 Delegate 등록 - - - - - - StreamBroadcastSubConfig - - - - - 생성자 - - - - - IStreamParser. 데이터 변환기 - - - - - Data -> Byte[] 변환기 - - - - - - - byte[] -> Data 변환기 - - - - - - - 스트림 Serialiable Parser - - - - - - - - - - - 스트림 string parser - - - - - string -> Byte[] 변환기 - - - - - - - byte[] -> string 변환기 - - - - - - - 스트림 Json Parser - - 객체 Type - - - - 객체 -> Byte[] 변환기 - - - - - - - byte[] -> 객체 변환기 - - - - - - - int, double, bool, long - - - - - - - - - - - - int, double - - - - - - - - - - - - - - - Stream엔진 연결 클래스. - - - - - 생성자 - - 연결의 이름. 다른 연결과의 구분자. - - - - - - - - - - Stream Utilization - - - - - Get Service Name from appId - - - - - - - Get Machine Name from appId - - - - - - - Get Line Name from appId - - - - - - - Get Machine No from appId - - - - - - - GetId except serviceName - - - - - - - 데이터 게시 스트림 서비스 - - - - - 생성자 - - 게시 서비스명. 구독에서 사용 - - - - - - - - - - - 데이터 변환 파서 등록 - - - - - - - 데이터 게시 - - - - - - - - - 데이터 게시 기본 - - - - - - - - 데이터 게시 컨피그 - - - - - Message가 Exchange에 전달되었는지 체크하는 속성. - - - - - 게시에 걸리는 TimeOut설정.0 이면 설정하지 않도록 한다. - - - - - 초안에 처리되어야하는 메시지임을 말한다. - - - - 자동 압축 설정 - - - 압축 최소 Size 설정 - - - 압축 알고리즘 - - - - 생성자 - - - - - Stream RPC Client - - - - - 비동기 서버응답에 대한 Delegate - - server id - message name - - - - - - Constructor - - Server의 서비스 이름 - 필요시 사용 - - - - 파서 추가 - - 추가할 메시지 이름. - 요청데이터 파서 - 응답데이터 파서 - - - - 요청 파서 추가 - - 추가할 메시지 이름 - 요청 파서 - - - - 응답 파서 추가 - - 추가할 메시지 이름 - 응답 파서 - - - - - - - - - - 비동기 RPC요청 - - - - 압축 여부 - - - - - Request and Reply - - - - - - - - - awaitable Request and Reply - - - - - - - - - Listner를 설정하지 않으면 응답처리 하지 않고 대상에게 Publish만 수행한다. - - - - - - StreamClientConfig - - - - 응답 최대 대기 시간 - - - 자동 압축 설정 - - - 압축 최소 Size 설정 - - - 압축 알고리즘 - - - 생성자 - - - - 스트림 RPC 서버 서비스 - - - - - RPC Server Requested Delegate - - - - - - - - - - 생성자 - - 서버의 서비스명 - - - - - ServiceName을 추후 변경원할 경우 사용 - - - - - - 파서 추가 - - - 클라이언트가 보내온 데이터 파서 - 클라이언트로 보낼 데이터 파서 - - - - 파서 추가. 한개만 등록 - - - - - - - 파서 추가 한개만 등록 - - - - - - - - - - - - - Listner를 설정하지 않으면 응답처리 하지 않고 대상에게 Publish만 수행한다. - - - - - - 스트림 RPC 서버 컨피그 - - - - - 병렬처리 갯수. 서버의 부하가 심해질때 갯수를 늘려라. - - - - 응답에 대한 자동 압축 설정 - - - 응답에 대한 압축 최소 Size 설정 - - - 응답에 대한 압축 알고리즘 - - - - 생성자 - - - - - Stream 통계 interface - - - - 총 메시지 갯수 - - - 총 데이터 Size - - - 마지막 전송 시간 - - - - Stream 베이스 클래스 - - - - - Sevice Logger - - - - - service - - - - - Send Parser - - - - - Receive Parser - - - - - 자동 압축 여부 - - - - - 압축 알고리즘 - - - - - 압축 최소 Size - - - - - 총 보낸 메시지 갯수 - - - - - 총 받은 메시지 갯수 - - - - - 마지막 성공 시간 - - - - - 총 보낸 데이터 크기 - - - - - 총 받은 데이터 크기 - - - - - Connector를 외부에서 생성했는지 자체 생성했는지의 여부 - - - - - 생성자 - - - - - - Send 파서 추가 - - - - - - - Receive 파서 추가 - - - - - - - Topic별 자동 압축 - - - - - - - Encoding을 파싱한다. 주로 압축. - - - - - - - - 데이터 변환. Object -> data - - - - - - - - - - 데이터 역변환. byte array -> object - - - - - - - - - - DoActivate - - StreamServiceConfig - - - - - DoDeactivate - - - - - - 마지막 전송 시간 - - - - - - 총 메시지 갯수 구하기 - - - - - - 총 데이터 크기 구하기 - - - - - - StreamServiceConfig - - - - - 메시지 브로커. - - - - - 로그를 출력할 최소 레벨을 지정한다. - - - - - Stream 구독 서비스 - - - - - 구독 Delegate - - 장비ID+서비스이름 - - - - - - 생성자 - - 게시 서비스 이름 - - - - - - 구독 데이터 파서 추가 - - - - - - - - - - - - - 구독 Delegate 등록 - - - - - - 스트림 게시 서비스 컨피그 - - - - - 구독할 라인 명. *은 모든 라인을 의미 - - - - - 구독할 장비 명. *은 모든 장비를 의미 - - - - - 구독할 호기 명. *은 모든 장비를 의미 - 장비의 호기는 반드시 숫자로 기입할 것. 장비가 아닌 경우 영문+숫자혼합을 사용할 것 - - - - - 생성자 - - - - - 가동상태. IDLE(메인시퀀스 비가동, Alarm 없음), RUN(메인시퀀스 가동), BD(메인시퀀스 비가동, Alarm 있음) - - - - ServiceType. - - set ServiceType in Service constructor. - - - - - - ServiceId. - - - - EventPublisher - - 디바이스를 상속받은 디바이스내에서 이벤트를 발송할때 사용할 수 있다. - - - - - - MonitoringInterval - - - - - IsInterval (Not period) - - - - - MonitoringJob - - - - - check if device is activated. - - - - - 디바이스가 연결상태에서 통신에러가 있는지 확인용도. - CommError가 Set되면 SYS_DEVICE_IS_COMM_ERROR 이벤트가 발생한다. - - - - - Active device (connect) - - 성공여부. 0(E1.OK) or error - - - - Active device (connect) - - device config - 성공여부. 0(E1.OK) or error - - - - Deactivate device (disconnect) - - 성공여부. 0(E1.OK) or error - - - - DoActivate. abstact method. - - - - - - - DoDeactivate. abstract method. - - - - - - SetMonitoringService. protected method. - - - - true : interval, false : period - - - - StartMonitoringService. Protected Method. - - - - - StopMonitoringMethod. Protected Method. - - - - - Device Config interface. - - - - - 언어 국가 코드 - - - - - 영어-미국 - - - - - 영어-싱가포르 - - - - - 한국어-한국 - - - - - 베트남어-베트남 - - - - - 간체중국어-중국 - - - - - 스페인어-스페인 - - - - - Language Array - - - - - Interface for IngredientItem - - - - - Interface for Ingredient - - - - - Item List about Ingredient - - - - - - 수동으로 특정 아이템을 활성화하기. - - - - - - - Activated Item (수동으로 Active시킨 아이템 이름) - - - - - - Activated Item (수동으로 Active시킨 아이템) - - - - - - 이름으로 IngredientItem검색하기 - - - - - - - 이름으로 검색하기. Indexer - - - - - - - Object Clone Method. 편의목적. - - - - - - - Ingredient Reload - - - - - - - Ingredient Reload - - - - - - - Ingredient Save - - - - - - - - SaveIngredient - - - - - - - - RenameIngredient - - - - - - - - CopyIngredient - - - - - - - - RemoveIngredient - - - - - - - CreatNewIngredient - - - - - - - Aurora System Event Definition Class - - - - - Equipment loading completion event (from system) - - - - - Equipment loading failure event (from system) - - - - - not yet implemented - - - - Event indicating that settings have been changed. (from system) - - Event Param : Setting Id - - - - - Device activation event (from system) - - Event Param : activated device id. - - - - - Device deactivation event (from system) - - Event Param : deactivated device id - - - - - Device activation event (from system) - - Event Param : activated device id. - - - - - Device deactivation event (from system) - - Event Param : deactivated device id - - - - - Device communication error event.(from system) - - Event Param : string deviceId, bool isCommError - - - - - Service communication error event.(from system) - - Event Param : string serviceId, bool isCommError - - - - - Recipe activation event(from system) - - Event Param : RecipeInfo - - - - - Recipe entry change event (from system) - - Event Param : RecipeEntryChangedParam - - - - - Recipe reload event.(from system) - - Event Param : Subject - - - - - Recipe item change event(from system) - - Event Param : Subject - - - - - 활성화된 레시피의 모델을 바꾸거나, 해당 모델을 변경했을때 (from system) - - Event Param : Subject (empty면 전체변경, subject존재시 해당 subject만 변경) - - - - - Model activated event.(from system) - - Event Param : Subject - - - - - MODEL reload event.(from system) - - Event Param : Subject - - - - - Model item changed event(from system) - - Event Param : Model Name - - - - - Model name changed event(from system) - - Event Param : Model Name - - - - - - Model entry changed event(from system) - - - - - Ingredient entry changed event(from system) - - - - Ingredient activation event(from system) - - Event Param : RecipeInfo - - - - - - Ingredient Item changed event(from system) - - - - - Ingredient reloaded event(from system) - - - - - Model item changed event(from system) - - Event Param : Language - - - - - - not yet implemented - - - - System alarm occured event(to system) - - Event Param : Boolean value indicating whether an alarm has occurred - - - - - Menu changed event (from system) - - Event Param : (mainName, subName) - - - - - Alarm set event (from system) - - Event Param : AlarmDescription - - - - - Alarm reset event (from system) - - Event Param : AlarmDescription - - - - - Alarm reset all event (from system) - - Event Param : List of AlarmDescription - - - - - - Alarm descriptions reloded event (from system) - - - - - Permission changed(log-in or log-out) event(from system). - - - - Screen interlock request event (to system) - - Event Param : Boolen value for whether screen lock or unlock - - - - - Door open/close event (to system) - - Event Param : Boolen value for whether door open or close - - - - - Tower lamp request event (to system) - - Event Param : eTowerLamp - - - - - Tower lamp request event (to system) - - Event Param : -
1. MainMenu or 0 : Main menu 이름 또는 menu index로 페이지 변경요청 -
2. (MainMenu or 0, true or false) : Main menu 이름 또는 index 면서 submenu 보일지 말지 결정 -
3. (MainMenu, Submenu or 0) : Main Menu 이름, sub menu 이름 또는 index로 메뉴 변경 요청 -
4. (MainMenu or 0, null) : Main Menu이름 or Index로 이동 -
-
-
- - Menu enable request event (to system) - - Event Param : boolean value for all menu enable or disable. - - - - - - Window mode request event (to system) - - - - - Full screen mode request event (to system) - - - - Manual backup start event (to system) - - Event Param : backup id (name) - - - - - Toast message request event (to system) - - Event Param : Message - - - - - - Toast message clear event (to system) - - - - - Language change request event (to system) - - Event Param : language - - - - - - - true false - - - - - - - - - - - 등록된 바로가기 키가 눌렸을 때 - - Event Param : Event ID, 현재 화면(Main ID, Sub ID) - - - - - - AuroraSettings - - - - Equipment - - - UI Preference - - - - EquipmentInfo - - - - - 장비명 - - - - - 장비 위치 - - - - - Machine No. - - - - - Machine is simulation mode or not. - - - - - Button Auto Logger Name. - - - - - After boot, connect device automatically - - - - - Alarm관련 설정 - - - - - Alarm Config Class - - - - - Alarm Description에서 Description Column을 사용할지 여부 - - - - - Alarm Description에서 UseSolution Column을 사용할지 여부 - - - - - Alarm Description에서 Use Column을 사용할지 여부 - - - - - Detail 기능을 사용할지 여부. 알람 팝업에서 Detail버튼 클릭 시 미리 등록한 이미지나 pdf를 띄울 수 있다. - - - - - Alarm History View에서 최대 몇 중까지 보여줄지 - - - - - 입력된 경로에 해당하는 directory를 생성한다 - - 생성할 directory 경로 - 성공할 경우 입력된 path를 반환함 - - - - 입력된 경로에 해당하는 directory를 강제로 생성한다 -
만약, 같은 이름의 파일이 존재한다면 삭제하고 생성한다 -
- 생성할 directory 경로 - 성공할 경우 입력된 path를 반환함 -
- - - 입력된 경로에 해당하는 directory를 삭제 -
만약, 같은 이름의 파일이 존재한다면 삭제하고 생성한다 -
- 삭제할 directory 경로 - 하위 directory나 file을 포함하는 경우에 삭제 여부 - 성공할 경우 입력된 path를 반환함 -
- - - 입력된 경로에 해당하는 directory를 삭제 -
만약, 같은 이름의 파일이 존재한다면 삭제하고 생성한다 -
- 삭제할 directory 경로 - 하위 directory나 file을 포함하는 경우에 삭제 여부 - 성공할 경우 입력된 path를 반환함 -
- - - 입력된 경로의 파일에 text 내용을 기록한다. -
만약 디렉토리가 존재하지 않으면 실패한다. -
만약 파일이 존재하지 않는다면 생성한다. -
만약 파일이 존재한다면 덮어쓴다. -
- 기록될 파일 경로 - 파일에 기록될 text 내용 - 성공할 경우 입력된 path을 그대로 반환함 -
- - - 입력된 경로의 파일에 text 내용을 기록한다. -
만약, 디렉토리가 존재하지 않으면 생성한다. -
만약, 파일이 존재하지 않는다면 생성한다. -
만약, 파일이 존재한다면 덮어쓴다. -
- 기록될 파일 경로 - 파일에 기록될 text 내용 - 성공할 경우 입력된 path을 그대로 반환함 -
- - - 디렉터리와 그 내용을 새 위치로 복사한다. - - 복사할 디렉터리의 경로 - 새 위치에 대한 경로 - 성공할 경우 복사한 경로 to를 반환함 - - - - 파일 또는 디렉터리와 그 내용을 새 위치로 이동한다. - - 이동할 파일 또는 디렉터리의 경로 - 새 위치에 대한 경로 - 성공할 경우 이동된 경로 to를 반환함 - - - - Alarm Description excel을 import한다. - - Alarm Description excel 경로 - - - - - Alarm Description excel을 export한다. - - export할 경로 - - - - - 알람을 발생 시킨다. - - 발생시킬 알람 코드 - Alarm Description의 해당 Property에 셋 해준다. 알람 이벤트를 받을 때 활용할 수 있다. - - - - - 특정 알람을 리셋 시킨다. - - 리셋시킬 알람 코드 - - - - - 현재 발생되어 있는 모든 알람을 리셋시킨다. - - - - - - 특정 Alarm Description을 읽는다. - - 읽을 알람의 코드 - - - - - Alarm Description을 다시 로드한다. - - - - - - 로드된 모든 Alarm Description을 읽는다. - - - - - - 현재 발생된 알람의 코드 리스트를 읽는다. - - - - - - 현재 발생된 알람의 History데이터를 읽는다. - - - - - - - 외부 모듈에서 지정한 알람을 추가로 등록한다. - - 추가로 등록할 Alarm Description - 추가 등록 code의 offset. 기존 코드와 겹치지 않도록 주의할 것. - - - - - Interface for ModelItem - - - - - Interface for ModelEntry - - - - - 모델 목록 - - - - - - Subject목록 - - - - - - ModelItem가져오기 - - - - - - - - Device Activated 상태표시 - - - - - - - Service Activated 상태표시 - - - - - - - Device를 그룹으로 묶어서 Activated 상태표시 - - - - - - - - 다국어 정보 추가 - - 언어-국가. ex. "ko-KR", "zh-CN", "en-US" ... - - - - returned object will be published by EVENT parameter - - - 시퀀스 실행상태 - - - 정지상태 - - - 실행상태 - - - Stop이 눌려서 정지중인 상태 - - - EmergencyStop을 처리중인 상태 - - - ForceError로 인해 Stop및 ForceError 처리중인 상태 - - - 일시정지중인 상태 - - - 시퀀스 종료상태로 Complete delegate처리중 - - - - SeqNodeIds Class. Predefined Node Ids. - - - - 시작노드 - - - 종료노드 - - - 이벤트큐등 종료를 명확히 하기 위한 빈종료노드 - - - 에러노드 - - - - ISequence class. - - - - 사용자가 설정한 시퀀스 Id - - - 시퀀스 현재 실행상태확인 - - - 한단계씩 이동하기 위한 모드 - - - Run상태변경 이벤트 - - - 시퀀스 노드 변경 이벤트 - - - - 시퀀스 시작 - - 시작 Parameter - 완료 Delegate - Context를 초기화할지의 여부 - 0 or error - - - - 시퀀스 정지 - - 0 or error - - - - 시퀀스 강제 정지 - - 0 or error - - - - 시퀀스 Cycle Stop. SeqeunceContext.IsCycleStopped 변수 확인후 정지시나리오는 직접구현필요. - 실제 Stop은 처리되지 않는다. - - - - - - CycleStop 상태인지 확인. - - - - - - 시퀀스 일시 정지 - - 0 or error - - - - 시퀀스 일시 정지후 Resume - - 0 or error - - - - Context에서 Param Search - - 0 or error - - - thread-safe - - - thread-safe - - - thread-safe - - - - BuilderInstance를 받아올 때 사용 - - - - - - - Main Sequence가 돌고 있는지 여부를 리턴 - - - - - - Main Sequence의 상태를 설정 - - - - - - - - ISequence.Stop()명령어 발생 후 해당 시간(ms) 내에 Node가 종료되지 않을 시 Thread 강제종료 - 시퀀스 천이 로그 표시여부(true:미표시, false:표시 - default) - 시퀀스 천이로그 레벨(0:V, 1:D, e:I - default, 3:W, 4:E) - - - - - - IEquipmentSetup class. - - 장비생성을 위해 필수로 상속받아야 하는 Interface. - 하나의 프로젝트의 하나만 존재해야한다. - - - - - Aurora 환경변수 - 장비로딩시 플랫폼에서 Set해주는 변수로, - Application.Current.AuroraEnv()사용보다 권장된다. - - - - - Equipment Name - - 장비명 - - - Setting Registration Api - - - register("Foo", new FooSetting()); - - - - - - - - RegisterIngredientItem - - - - - Model Registration Api - - - register(new Glass(), () => new UCGlassEditor(new UCGlassEditorViewModel(AuroraEnv))); - - - - - - - Recipe Registration Api - - - register(RecipeIds.Common, new CommonRecipe(), (id, item) => new UCRecipeMain(AuroraEnv)); - - - - - - - Device Registration Api - - - registry.Register(DeviceIds.Light, - () => new LightDevice(DeviceIds.Light, eLight.LvsPn, Status.IsSimulation), LightConfig.GetDefaultConfig(), - device => new UCLightControl() { DataContext = new UCLightControlViewModel(AuroraEnv, device) }); - - - - - - - sequence registration Api - - - register(SequenceIds.PLCMonitor, PLCMonitor.Builder(DeviceIds.PLCDevice)); - - - - - - - view registration Api - - - MainMenu recipe = new MainMenu(ViewIds.Recipe, MenuIcon.GetMenuIcon(eMenuIcon.RECIPE)); - recipe.AddSubMenu(ViewIds.Recipe, new UCRecipe()); - recipe.AddSubMenu(ViewIds.GlassEditor, new UCModel() { DataContext = new UCModelViewModel(Application.Current.AuroraEnv(), null) }); - manager.RegisterMainMenu(recipe); - - - - - - - - RegisterShortcuts - - - - - build main status view - - - builder.ShowCI(true) - .ShowClock(true) - .ShowTowerLamp(false) - .AddLanguage("ko-KR", "zh-CN", "en-US") - .AddComponent(DoorStatus) - .AddDeviceActiveStatus(DeviceIds.ACS) - .AddDeviceActiveStatus(DeviceIds.PLCDevice); // PLC_REMOVE - - - - - - - register multilanguage resources - - - register(typeof(StrTokens)); - - - - - - - - Shutdown 가능한 상태인지 리턴 - - Shotdown 가능 or 불가능 - - - - 장비로딩이 완료되고 장비가 시작되었음을 알림. - - - - - 프로그램이 종료상태에 있음을 알림. - - - - - Alarm이 발생되었음을 알림. - - 발생된 alarm의 code. - 중알람인지? - - - - Alarm이 해제되었음을 알림. - - 해제된 alarm code 리스트 - - - RecipeView Interface - - 커스텀 레시피 뷰어를 구현할때 상속받아야 하는 인터페이스로 - 레시피가 변경되었을때와 Reload되었을때의 할일을 구현한다. - - - - - - 현재 뷰어의 레시피가 변경되었음을 알림. - 뷰모델에서 해당 레시피로 갱신해주어야 한다. - - - - - - 현재 뷰어의 레시피가 리로드되었음을 알림. - - - - - - 현재 편집중인 화면에서 모델이 변경되었고, 모델이 변경되었을때 레시피화면에 - 모델정보를 표시하고 있다든지, 다른 데이터가 영향을 받는 경우 처리요청 - - - - - - Save되기 전에 호출 - - Save되는 recipe ID - Save되는 recipe name - - - - Save되고나서 전에 호출 - - Save되는 recipe ID - Save되는 recipe name - - - ModelView Interface - - 모델이 변경되었거나, 저장전 해야할일을 수행할 수 있다. - - - - - - 해당 모델뷰어의 모델이 변경되었음을 알림. - - - - - - 현재 뷰어의 레시피가 리로드되었음을 알림. - - - - - - Model Rename이 가능한지 확인 - - 기존 이름 - 신규 이름 - 불가시 불가사유 기재 - - - - - Save되기 전에 호출 - - Save되는 Model name - - - - Save되고나서 전에 호출 - - Save되는 Model name - - - Ingredient ViewModel Interface - - - - 해당 itemName으로 변경되었음을 알림 - - - - - - item이 reload되었음을 알림 - - - - - - 해당 Item이 사용중인지 확인 - - 아이템이름 - - - - - Save되기 전에 호출 - - Save되는 Ingredient Item name - - - - Save되고나서 전에 호출 - - Save되는 Ingredient Item name - - - - Device Registry Interface. - - - - - Device Register. - - - - - - - - - - Device Registry Interface. - - - - - Device Register. - - - - - - - - - - - Setting Register - - - - - - - - - RecipeItemEditorFactory - - - - - - - - IngredientItemEditorFactory - - - - - - - - IngredientsRegister - - - - activate 가능여부 - - - - - - ModelItemEditorFactory - - - - - - - - Model을 등록한다. - - 모델 ID - IModelItem 상속받아 만든 Item - 커스텀 에디터 뷰 - Recipe와 종속관계로 사용할지 여부, 한번이라도 true를 입력하면 true임 - - - - - RecipeRegister - - - - - - - - - SequenceRegister - - - - 시퀀스 빌더 instance를 보관하여 전역변수를 통해 값을 전달하기 위함 - Main 시퀀스로 등록 시 가동상태를 확인할 수 있다. - - - - - Shortcut 등록 - - id - 해당 shortcut의 설명 - - - - - Language resource register - - - - - - Event Message Class - - - EventMessage 생성자 - - - - - - - Event Subject - - - Event Param - - - Event Source - - - - IRecipeItem - - - - - IRecipeEntry - - - - - - - - - - - - Model이름을 가져온다. - (ModelRecipeItem을 상속받은 Item이 등록되어있어야 한다.) - - - - - - - 활성화된 모델이름을 가져온다. - (ModelRecipeItem을 상속받은 Item이 등록되어있어야 한다.) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 기존 (id, name)을 대체 - - - - - Device abstract class - - - - - Device View에서 그룹 보기 시 필요하며 미기입 시 DeviceType으로 표기 - - - - DeviceType. - - set DeviceType in device constructor. - - - - - Communication Type for device - - set CommType in device constructor. - - - - - - DeviceId. - - - - NativeHandle - - c++ device only. - - - - - EventPublisher - - 디바이스를 상속받은 디바이스내에서 이벤트를 발송할때 사용할 수 있다. - - - - - - MonitoringInterval - - - - - IsInterval (Not period) - - - - - MonitoringJob - - - - EventPublisher - - HiddenDevice인지 확인. HiddenDevice인 경우 디바이스 설정화면에 나타나지 않는다. - - - - - - check if device is activated. - - - - - 디바이스가 연결상태에서 통신에러가 있는지 확인용도. - CommError가 Set되면 SYS_DEVICE_IS_COMM_ERROR 이벤트가 발생한다. - - - - - 디바이스가 시뮬상태인지를 나타낸다. - - - - - 알람이 있는지 확인. - - - - - Device Setting View에서 항상 Custom View가 보이도록 함. false면 Activated 시에만 보임. - - - - - add alarm to alarm list. - - - - - - - Clear specific alarm code - - - - - - Clear alarm code list - - - - - - Get Last Alarm - - Alarm Code No. - - - - Get Alarm List - - Alarm List - - - - Clear all alarms - - - - - Active device (connect) - - 성공여부. 0(E1.OK) or error - - - - Active device (connect) - - device config - 성공여부. 0(E1.OK) or error - - - - Deactivate device (disconnect) - - 성공여부. 0(E1.OK) or error - - - - DoActivate. abstact method. - - - - - - - DoDeactivate. abstract method. - - - - - - SetMonitoringService. protected method. - - - - true : interval, false : period - - - - StartMonitoringService. Protected Method. - - - - - StopMonitoringMethod. Protected Method. - - - - interface에 정의되지 않은 추가적인 명령을 사용하기 위함 - end-to-end 로 정의한 message - - - - Device Config interface. - - - - - Device Connnection Configuration. - - - - - Device Connection Type - - - - Serial Port - - - Socket - - - Modbus - - - Etc - - - - Device Connection Config Interface - - - - - Device Enumarable Type. - 생성자에서 지정해주세요. 추가원하는 DeviceType은 연락주세요. - - - - ETC. 지정하지 않을시 디폴트 - - - 카메라 디바이스. - - - 트리거 디바이스. - - - 아르고스 디바이스. - - - 디펙수집기 디바이스. - - - 모터 디바이스. - - - 무버 디바이스. - - - 조명 디바이스. - - - 디지털IO 디바이스. - - - 라인프로파일러 디바이스. - - - 파워미터 디바이스. - - - 변위센서 디바이스. - - - 칠러 디바이스. - - - 레이저 디바이스. - - - 집진기 디바이스. - - - IO 디바이스. - - - 컨트롤러 디바이스. - - - PLC 디바이스. - - - - 1. Find Stream Engine - 2. Change Stream Settings - 3. Get Machine List - 4. Get Current Stream Statistics - - - - - 현재 중알람 목록 - - - - - - 현재 경알람 목록 - - - - - - 최근 중알람 목록 - - - - - - 최근 경알람 목록 - - - - - - ID중복은 추가 안 하지만 Key중복은 로그만 뿌리고 추가한다. - - - - - - - - - 메뉴 enable/disable을 위해 필요한 callback형식. params는 Func가 미지원하여 별도로 만들었음. - - enable/disable - view ids - - - - - View Manger Class for register views - - - - - Register Main menu - - Main menu view group - - - - - Register Title Component. 타이틀바 하단 중앙 - - - - - - - Register Fixed Component. 컨텐츠 영역 상단 - - - - - - - Only use Inspection UI. Register Bottom Component. MainBody 아래 - - - - - - - Register Status Component. 최하단 - - - - - - - Register Screen Interlock - - - - - - - MainMenu를 선택적으로 Enable/Disable할 수 있다. 하나라도 Disable이면 서랍메뉴는 Disable - - Enable/Disable 설정 - View ID List - - - - - 모든 MainMenu를 Enable/Disable할 수 있다. 서랍메뉴도 함께 Enable/Disable 된다. - - Enable/Disable 설정 - 제외할 View ID - - - - - Menu를 변경한다. - - 변경할 Main ID - 변경할 Sub ID. 미입력 시 현재값 - - - - - 화면 인터락 - - screen lock or unlock - - - - - 도어 자물쇠 Lock/Unlock - - door lock or unlock - - - - - 타워램프 On/Off - - Red, Orange, Green - - - - - 좌상단 전체화면 버튼기능 - - 전체화면 모드인지 창모드인지 - - - - - 창모드인지? - - - - - - 현재 view가 full screen모드를 지원하면 full screen으로 변경하는 기능 - - full screen모드인지 일반모드인지 - - - - - 언어변경 - - LanguageDefs의 값 참조. 혹은 직접 코드 입력 ex. en-US - - - - - 등록한 전체 메뉴의 리스트 제공 - - - - - - FixedContent Top 영역의 Visiblity - - - - - - - FixedContent Bottom 영역의 Visiblity - - - - - - - FixedContent Left 영역의 Visiblity - - - - - - - FixedContent Right 영역의 Visiblity - - - - - - Participants : [0] : me, [1..n] : others - - - - 인자로 들어 문자에 특수 문자가 존재 하는지 여부를 검사 한다. - - - - - - - - - - AccountManagementDialog - - - - - InitializeComponent - - - - - ChangePasswordDialog - - - - - InitializeComponent - - - - - Interaction logic for ErrorMessageDialog.xaml - - - ErrorMessageDialog - - - - - InitializeComponent - - - - - LogInDialog - - - - - InitializeComponent - - - - - AccountDialog - - - - - InitializeComponent - - - - - AccountButton - - - - - InitializeComponent - - - - - 부팅 시에만 사용하는 당일 알람 읽는 기능 - - - - - - params : from, node ID, activated - - - - @param string sequenceId - 서비스할 sequence ID. 단지, 로그 출력 용도로 사용됨 - @param int numOfWorker - work를 수행할 work thread 갯수. - 최대 동시수행 흐름에 맞게 설정하는 것을 권장한다. - - - - BoxPlot에서 사용하는 기본 통계값을 계산한다. - - - - - - - Singleton 객체 가져오기 - - - - - - - - T 형식의 데이터를 CSV에 한줄로 추가 - - - - - - - - - - - - DataTable 타입의 데이터에서 DataColumnCollection을 가져와서 헤더를 만드는 함수 - - - - - - - - - DataTable 타입의 데이터에서 DataRow를 가져와 내용을 채우는 함수 - - - - - - - - - DataTable을 CSV로 쓰는 함수 - - - - - - - - DataTable을 CSV로 쓰는 함수 - - - - - - - - - CSV를 DataTable로 읽는 함수 - - - - - - - 버전 정보를 넣으면 빌드 시간을 반환. - - - - - - - SingleView.xaml에 대한 상호 작용 논리 - - - SingleView - - - - - InitializeComponent - - - - - Interaction logic for UCInspecChatView.xaml - - - UCInspecChatView - - - - - InitializeComponent - - - - - LiveViewAll.xaml에 대한 상호 작용 논리 - - - CombineView - - - - - InitializeComponent - - - - - MainStatusView - - - - - InitializeComponent - - - - - MainView.xaml에 대한 상호 작용 논리 - - - MainView - - - - - InitializeComponent - - - - - Interaction logic for LogSettingView.xaml - - - LogSettingView - - - - - InitializeComponent - - - - - 상대경로면 절대경로로 업뎃해서 사용하자. - - - - - - - 1. Path확인 (TextBox로는 편집이 안 되므로 Loading됐다면 정상 Path이다. - 2. Json이 정상 로딩 된 상태인지 확인 - - - - - - 1. Valid 확인 - 2. Hislog config가 맞는지 확인 - - - - - - - - Interaction logic for EllipseButton.xaml - - - EllipseButton - - - - - InitializeComponent - - - - - AccordionUC.xaml에 대한 상호 작용 논리 - - - UCAccordion - - - - - Accordion 메뉴 IsEnabled에 해당하며, Folding 버튼 제외한 나머지가 Enable/Disable된다. - - - - - InitializeComponent - - - - - MainVisionButton - - - - - InitializeComponent - - - - - Interaction logic for UCMainBody.xaml - - - UCMainBody - - - - - InitializeComponent - - - - - Interaction logic for UCMainTitle.xaml - - - UCMainTitle - - - - - InitializeComponent - - - - - Interaction logic for WinMainScreen.xaml - - - WinMainScreen - - - - - InitializeComponent - - - - - UCDeviceStatusView.xaml에 대한 상호 작용 논리 - - - UCDeviceStatusView - - - - - InitializeComponent - - - - - Interaction logic for WinRecipeSelect.xaml - - - WinRecipeSelect - - - - - InitializeComponent - - - - - UCSequenceSettingView.xaml에 대한 상호 작용 논리 - - - UCSequenceSettingView - - - - - InitializeComponent - - - - - Interaction logic for ShortcutView.xaml - - - ShortcutView - - - - - InitializeComponent - - - - - Interaction logic for UCStreamFileUploadClient.xaml - - - UCStreamFileUploadClient - - - - - InitializeComponent - - - - - Interaction logic for UCStreamBroadCaster.xaml - - - UCStreamTalkClient - - - - - - - - - - - - InitializeComponent - - - - - Interaction logic for UCChatRoomSummary.xaml - - - UCChatRoomSummary - - - - - InitializeComponent - - - - - Interaction logic for UCFavoritePhrases.xaml - - - UCFavoritePhrases - - - - - InitializeComponent - - - - - Interaction logic for WinAuroraTalk.xaml - - - WinAuroraTalk - - - - - InitializeComponent - - - - - Interaction logic for WinChatPiece.xaml - - - UCChatPiece - - - - - InitializeComponent - - - - - Interaction logic for WinChatRoom.xaml - - - WinChatRoom - - - - - InitializeComponent - - - - - Interaction logic for WinStreamImageViewer.xaml - - - WinStreamImageViewer - - - - - InitializeComponent - - - - - AlarmHistoryPopupView.xaml에 대한 상호 작용 논리 - - - AlarmHistoryPopupView - - - - - InitializeComponent - - - - - Interaction logic for AlarmDescView.xaml - - - AlarmDescView - - - - - InitializeComponent - - - - - Interaction logic for AlarmDetailPopup.xaml - - - AlarmDetailPopup - - - - - InitializeComponent - - - - - Interaction logic for AlarmHistoryView.xaml - - - AlarmHistoryView - - - - - InitializeComponent - - - - - Interaction logic for AlarmPopup.xaml - - - AlarmPopup - - - - - InitializeComponent - - - - - DevGrabberView.xaml에 대한 상호 작용 논리 - - - DevCameraView - - - - - InitializeComponent - - - - - MavinInferLoadModelInfoView - - - - - InitializeComponent - - - - - MavinInferView - - - - - InitializeComponent - - - - - DeviceStatusView.xaml에 대한 상호 작용 논리 - - - DeviceStatusView - - - - - InitializeComponent - - - - - DevVisionFlowView - - - - - InitializeComponent - - - - - AutoBackupView.xaml에 대한 상호 작용 논리 - - - AutoBackupView2 - - - - - InitializeComponent - - - - - AutoBackupView.xaml에 대한 상호 작용 논리 - - - AutoBackupView - - - - - InitializeComponent - - - - - Interaction logic for UCSettingPort.xaml - - - UCSettingPort - - - - - InitializeComponent - - - - - Interaction logic for UCWinDeviceInit.xaml - - - WinDeviceInit - - - - - InitializeComponent - - - - - FreeSpace.xaml에 대한 상호 작용 논리 - - - DiskUsageView - - - - - InitializeComponent - - - - - FilterView.xaml에 대한 상호 작용 논리 - - - FilterView - - - - - InitializeComponent - - - - - HislogView.xaml에 대한 상호 작용 논리 - - - HislogView - - - - - InitializeComponent - - - - - EditModelView - - - - - 입력값 - - - - - 입력값 - - - - - 입력 뷰 - - - - - InitializeComponent - - - - - Interaction logic for UCRecipe.xaml - - - UCModel - - - - - UCModel - - DataContext를 외부에서 주입할지. 직접생성할지의 여부 - - - - InitializeComponent - - - - - Interaction logic for WinModelList.xaml - - - WinModelList - - - - - 선택된 모델이름 - - - - - WinModelList - - - - - - InitializeComponent - - - - - Interaction logic for WinModelNameInput.xaml - - - WinModelNameInput - - - - - InitializeComponent - - - - - Interaction logic for UCModel.xaml - - - UCIngredient - - - - - UCIngredient 생성자 - - Ingredient의 name - DataContext를 외부에서 주입할지. 직접생성할지의 여부 - - - - InitializeComponent - - - - - Interaction logic for WinModelList.xaml - - - WinIngredient - - - - - 사용을 눌러 선택된 Item결과값을 갖고 있다. - - - - - itemName - - Window에 사용할 Ingredient의 이름 - Window에 활성화할 Item. 삭제할 수 없다. - - - - InitializeComponent - - - - - Interaction logic for UCDevPropertyGrid.xaml - - - UCDevPropertyGrid - - - - - 디폴트 생성자 - 서치박스 있음, 첫 실행 시 접어서 표시 - - - - - 생성자 오버로딩 - - 서치박스 표시여부 - 첫 실행 시 펼칠지 여부 - - - - InitializeComponent - - - - - Interaction logic for UCRecipe.xaml - - - UCRecipe - - - - - Recipe Viewer Default Class. - No need to create datacontext at machine project. - - - - - - InitializeComponent - - - - - RecipeInfoVM Class - - - - - ResultSingleIcon.xaml에 대한 상호 작용 논리 - - - ResultSingleIcon - - - - - InitializeComponent - - - - - ResultView.xaml에 대한 상호 작용 논리 - - - ResultView - - - - - InitializeComponent - - - - - RunningView.xaml에 대한 상호 작용 논리 - - - RunningView - - - - - InitializeComponent - - - - - separater.xaml에 대한 상호 작용 논리 - - - separater - - - - - InitializeComponent - - - - - UCServiceSettingView.xaml에 대한 상호 작용 논리 - - - UCServiceSettingView - - - - - InitializeComponent - - - - - SeqButton.xaml에 대한 상호 작용 논리 - - - SequenceButtonView - - - - - InitializeComponent - - - - - Interaction logic for UCSequenceDiagram.xaml - - - UCSequenceDiagram - - - - - InitializeComponent - - - - - Interaction logic for WinSequenceDiagram.xaml - - - WinSequenceDiagram - - - - - InitializeComponent - - - - - Show Toast message, Log level Information (Log.I) - - - null is not use Log - - - - Show Toast message, Log level Information (Log.I) - - - null is not use Log - - - - Show Toast message, Log level Error (Log.E) - - - null is not use Log - - - - Show Toast message, Log level Warning (Log.W) - - - null is not use Log - - - - Interaction logic for UCHome.xaml - - - WinKBDNumber - - - - - InitializeComponent - - - - - DevLightStrobeSimpleView - - - - - InitializeComponent - - - - - DevLightStrobeView - - - - - InitializeComponent - - - - - LogViewWindow.xaml에 대한 상호 작용 논리 - - - InfoView - - - - - InitializeComponent - - - - - LogViewWindow.xaml에 대한 상호 작용 논리 - - - LogViewWindow - - - - - InitializeComponent - - - - - Pre-defined menu icons - - - - - https://www.lge.co.kr/kr/company/info/ci/graphicmotif/html/ko_manual_guide.html - - - - - Brushes for LG - - - - - DevArgosVPView - - - - - InitializeComponent - - - - - CsvFilePanel.xaml에 대한 상호 작용 논리 - - - CsvFilePanel - - - - - InitializeComponent - - - - - PmacCommView - - - - - InitializeComponent - - - - - Initializes a new instance of the DelegateCommand class. - - execute function - can execute function - - - - Initializes a new instance of the DelegateCommand class. - - indicate an execute function - - - - can executes event handler - - - - - implement of icommand can execute method - - parameter by default of icomand interface - can execute or not - - - - implement of icommand interface execute method - - parameter by default of icomand interface - - - - CanExecute 값을 즉시 업데이트 하고 싶을 때 호출 - - - - - LogViewWindow.xaml에 대한 상호 작용 논리 - - - OpenSourceLicenseView - - - - - InitializeComponent - - - - - PropertyGridEx - - - - - InitializeComponent - - - - - DevLightView - - - - - InitializeComponent - - - - - IOMapControllerView - - - - - InitializeComponent - - - - - IOMapItemPanel.xaml에 대한 상호 작용 논리 - - - IOMapItemPanel - - - - - InitializeComponent - - - - - MotorJog - - - - - InitializeComponent - - - - - MoverJog - - - - - InitializeComponent - - - - - EquipSettingView - - - - - InitializeComponent - - - - - DeviceSettingView - - - - - InitializeComponent - - - - - IOMapEditorView.xaml에 대한 상호 작용 논리 - - - IOMapEditorView - - - - - InitializeComponent - - - - - DigitalIOView - - - - - InitializeComponent - - - - - EditRecipeView - - - - - InitializeComponent - - - - - RecipeListView - - - - - InitializeComponent - - - - - RecipeSettingView - - - - - InitializeComponent - - - - - RecipeSubjectView - - - - - InitializeComponent - - - - - 플랫폼에서 사용하는 Path 정보 - - - - - Model 저장 폴더이름 - - - - - Recipe 저장 폴더이름 - - - - - Setting 저장 폴더이름 - - - - - Ingredient 저장 폴더이름 - - - - - Alarm Description 폴더이름 - - - - - Device Setting 저장 폴더이름 - - - - - Service Setting 저장 폴더이름 - - - - - OSC html 저장 폴더이름 - - - - - MainWindow.xaml에 대한 상호 작용 논리 - - - MainWindow - - - - - InitializeComponent - - - - - IAuroraEnvironment calss for aurora environment variables. - - - - - Event Publisher for publish event. - - - - - Event Observable for subscribe event. - - - - - Setting Entry - - - - - Model Manager - - - - - Recipe Manager - - - - - Ingredients Manager - - - - - Sequence Entry - - - - - Service Mnaager - - - - - Stream Manager - - - - - Device Mnaager - - - - - Alarm Service - - - - - ViewManager - - - - - LangTokens class - - - - - PropertyChanged event. - - - - - Language Token - - - - - Token Indexer - - Token Id - Token string - - - - Find Token - - Token Id - whether camel case or not (default true) - default token - - - - - Add Token Resources file. - - - - - - Change Language - - Langugae - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to Absolute. - - - - - Looks up a localized string similar to Acceleration. - - - - - Looks up a localized string similar to Account. - - - - - Looks up a localized string similar to Account list. - - - - - Looks up a localized string similar to Account management panel. - - - - - Looks up a localized string similar to Account server. - - - - - Looks up a localized string similar to Account setting. - - - - - Looks up a localized string similar to Accounts in this group. - - - - - Looks up a localized string similar to Activated. - - - - - Looks up a localized string similar to Activate recipe. - - - - - Looks up a localized string similar to Active. - - - - - Looks up a localized string similar to Add. - - - - - Looks up a localized string similar to Add account group. - - - - - Looks up a localized string similar to Add camera. - - - - - Looks up a localized string similar to Add group. - - - - - Looks up a localized string similar to Add item. - - - - - Looks up a localized string similar to Add line. - - - - - Looks up a localized string similar to Add new account. - - - - - Looks up a localized string similar to Add point. - - - - - Looks up a localized string similar to Address. - - - - - Looks up a localized string similar to Add ROI. - - - - - Looks up a localized string similar to Add To List. - - - - - Looks up a localized string similar to Aging Start. - - - - - Looks up a localized string similar to Aging Stop. - - - - - Looks up a localized string similar to Aging Test. - - - - - Looks up a localized string similar to Alarm. - - - - - Looks up a localized string similar to Algorithm. - - - - - Looks up a localized string similar to Align. - - - - - Looks up a localized string similar to Align calibration file. - - - - - Looks up a localized string similar to Align cam.. - - - - - Looks up a localized string similar to Align NG. - - - - - Looks up a localized string similar to Align OK, apply?. - - - - - Looks up a localized string similar to Align group 1. - - - - - Looks up a localized string similar to Align group 2. - - - - - Looks up a localized string similar to Align keep days. - - - - - Looks up a localized string similar to Align light IR. - - - - - Looks up a localized string similar to Align light WHITE. - - - - - Looks up a localized string similar to Align margin. - - - - - Looks up a localized string similar to Align monitor. - - - - - Looks up a localized string similar to Align offset. - - - - - Looks up a localized string similar to Align save image format. - - - - - Looks up a localized string similar to Align save path. - - - - - Looks up a localized string similar to Align spec recipe. - - - - - Looks up a localized string similar to All. - - - - - Looks up a localized string similar to All Clear. - - - - - Looks up a localized string similar to Id already exists.. - - - - - Looks up a localized string similar to Name already exists.. - - - - - Looks up a localized string similar to A name that is in use cannot be changed. - - - - - Looks up a localized string similar to Another 'AURORA' is running. Check.. - - - - - Looks up a localized string similar to Apply. - - - - - Looks up a localized string similar to Apply Pattern. - - - - - Looks up a localized string similar to Apply permission. - - - - - Looks up a localized string similar to Attenuator Control. - - - - - Looks up a localized string similar to Do you want shutdown?. - - - - - Looks up a localized string similar to Auto backup. - - - - - Looks up a localized string similar to Automatically Connect Devices. - - - - - Looks up a localized string similar to Automatically Connect Services. - - - - - Looks up a localized string similar to Auto. - - - - - Looks up a localized string similar to Available Storage %. - - - - - Looks up a localized string similar to Back. - - - - - Looks up a localized string similar to Backup. - - - - - Looks up a localized string similar to Backup time. - - - - - Looks up a localized string similar to Base config. - - - - - Looks up a localized string similar to Bit In/Out. - - - - - Looks up a localized string similar to Bit Input ( PLC → PC ). - - - - - Looks up a localized string similar to Bit/mm. - - - - - Looks up a localized string similar to Bit Output ( PC → PLC ). - - - - - Looks up a localized string similar to Blob Size Threshold. - - - - - Looks up a localized string similar to Bottom. - - - - - Looks up a localized string similar to by Manual. - - - - - Looks up a localized string similar to CAD Loader. - - - - - Looks up a localized string similar to Calculate Grid. - - - - - Looks up a localized string similar to Calibration. - - - - - Looks up a localized string similar to Camera. - - - - - Looks up a localized string similar to Camera Config. - - - - - Looks up a localized string similar to Cam-Laser Calibration. - - - - - Looks up a localized string similar to Cam. Resolution. - - - - - Looks up a localized string similar to Cam. values. - - - - - Looks up a localized string similar to Cancel. - - - - - Looks up a localized string similar to Capacity. - - - - - Looks up a localized string similar to Capture. - - - - - Looks up a localized string similar to Category. - - - - - Looks up a localized string similar to Change. - - - - - Looks up a localized string similar to Change password. - - - - - Looks up a localized string similar to ChangeValue. - - - - - Looks up a localized string similar to Channel ID. - - - - - Looks up a localized string similar to Channels. - - - - - Looks up a localized string similar to Check complete. - - - - - Looks up a localized string similar to The currently used recipe is '{0}: {1}'. - Please check if it matches the actual stage state before starting.. - - - - - Looks up a localized string similar to Chuck. - - - - - Looks up a localized string similar to Clear. - - - - - Looks up a localized string similar to Clear. - - - - - Looks up a localized string similar to Clear password. - - - - - Looks up a localized string similar to Clicked Position. - - - - - Looks up a localized string similar to Click to Log In. - - - - - Looks up a localized string similar to Click to Log Out. - - - - - Looks up a localized string similar to Clone. - - - - - Looks up a localized string similar to Close. - - - - - Looks up a localized string similar to Alarm code. - - - - - Looks up a localized string similar to Code. - - - - - Looks up a localized string similar to Collection align. - - - - - Looks up a localized string similar to Collection inspect. - - - - - Looks up a localized string similar to Columns. - - - - - Looks up a localized string similar to Completed. - - - - - Looks up a localized string similar to Complete inspection. - - - - - Looks up a localized string similar to Config. - - - - - Looks up a localized string similar to Confirm. - - - - - Looks up a localized string similar to Confirm New Password. - - - - - Looks up a localized string similar to Connect. - - - - - Looks up a localized string similar to Connect/Disconnect. - - - - - Looks up a localized string similar to Convert Data File To Correction File. - - - - - Looks up a localized string similar to Coordinates. - - - - - Looks up a localized string similar to Copy. - - - - - Looks up a localized string similar to Copy point. - - - - - Looks up a localized string similar to Copy recipe. - - - - - Looks up a localized string similar to Corner. - - - - - Looks up a localized string similar to Correction File. - - - - - Looks up a localized string similar to Count. - - - - - Looks up a localized string similar to Created Time. - - - - - Looks up a localized string similar to Create mark. - - - - - Looks up a localized string similar to Crop height. - - - - - Looks up a localized string similar to Crop width. - - - - - Looks up a localized string similar to Crop X. - - - - - Looks up a localized string similar to Crop Y. - - - - - Looks up a localized string similar to Cross. - - - - - Looks up a localized string similar to Current. - - - - - Looks up a localized string similar to Current Password. - - - - - Looks up a localized string similar to Current Pos. - - - - - Looks up a localized string similar to Current Position. - - - - - Looks up a localized string similar to Dark edge value range. - - - - - Looks up a localized string similar to Database. - - - - - Looks up a localized string similar to Database connect. - - - - - Looks up a localized string similar to Data File. - - - - - Looks up a localized string similar to Data save. - - - - - Looks up a localized string similar to Days. - - - - - Looks up a localized string similar to Deactivated. - - - - - Looks up a localized string similar to Default values. - - - - - Looks up a localized string similar to Default velocity. - - - - - Looks up a localized string similar to Defect Threashold. - - - - - Looks up a localized string similar to Alarm definitions. - - - - - Looks up a localized string similar to Degree (º). - - - - - Looks up a localized string similar to Del. - - - - - Looks up a localized string similar to Delete. - - - - - Looks up a localized string similar to Delete After Backup. - - - - - Looks up a localized string similar to Delete All. - - - - - Looks up a localized string similar to Delete camera. - - - - - Looks up a localized string similar to Deleted. - - - - - Looks up a localized string similar to Delete inspection item. - - - - - Looks up a localized string similar to Delete point. - - - - - Looks up a localized string similar to Delete ROI. - - - - - Looks up a localized string similar to Desc.. - - - - - Looks up a localized string similar to Description. - - - - - Looks up a localized string similar to Deselect All. - - - - - Looks up a localized string similar to Desktop. - - - - - Looks up a localized string similar to Destination base path. - - - - - Looks up a localized string similar to Detail. - - - - - Looks up a localized string similar to Details. - - - - - Looks up a localized string similar to Device. - - - - - Looks up a localized string similar to Device activation. - - - - - Looks up a localized string similar to Device Config. - - - - - Looks up a localized string similar to Device configuration. - - - - - Looks up a localized string similar to Device group. - - - - - Looks up a localized string similar to Device groups. - - - - - Looks up a localized string similar to Device setting. - - - - - Looks up a localized string similar to Device setup. - - - - - Looks up a localized string similar to Device status. - - - - - Looks up a localized string similar to Digital IO Map. - - - - - Looks up a localized string similar to Dim IR. - - - - - Looks up a localized string similar to Dim level. - - - - - Looks up a localized string similar to Dim range. - - - - - Looks up a localized string similar to Dim WHITE. - - - - - Looks up a localized string similar to Direction. - - - - - Looks up a localized string similar to Disabled. - - - - - Looks up a localized string similar to Distance. - - - - - Looks up a localized string similar to Distance between marks (mm). - - - - - Looks up a localized string similar to Double-click to add an item to the point.. - - - - - Looks up a localized string similar to Edge direction. - - - - - Looks up a localized string similar to Edge find direction. - - - - - Looks up a localized string similar to Edge threshold. - - - - - Looks up a localized string similar to Edit. - - - - - Looks up a localized string similar to Edit alarm. - - - - - Looks up a localized string similar to Editing Model. - - - - - Looks up a localized string similar to Edit Items. - - - - - Looks up a localized string similar to Edit Position. - - - - - Looks up a localized string similar to Emergency Stop. - - - - - Looks up a localized string similar to Empty String. - - - - - Looks up a localized string similar to Enable. - - - - - Looks up a localized string similar to Enabled. - - - - - Looks up a localized string similar to End. - - - - - Looks up a localized string similar to End X. - - - - - Looks up a localized string similar to End Y. - - - - - Looks up a localized string similar to Entry. - - - - - Looks up a localized string similar to Equipment. - - - - - Looks up a localized string similar to Equipment info. - - - - - Looks up a localized string similar to Equipment name. - - - - - Looks up a localized string similar to Error. - - - - - Looks up a localized string similar to ERROR / ALARM REPORT. - - - - - Looks up a localized string similar to Every. - - - - - Looks up a localized string similar to Execute. - - - - - Looks up a localized string similar to Exit. - - - - - Looks up a localized string similar to Exit Full Screen. - - - - - Looks up a localized string similar to Press [Esc] Key To Exit Full Screen. - - - - - Looks up a localized string similar to Export. - - - - - Looks up a localized string similar to Export to Excel. - - - - - Looks up a localized string similar to Exposure. - - - - - Looks up a localized string similar to NG. - - - - - Looks up a localized string similar to Fail to update alarm definitions. - - - - - Looks up a localized string similar to File List. - - - - - Looks up a localized string similar to File Name. - - - - - Looks up a localized string similar to Filter. - - - - - Looks up a localized string similar to Find direction. - - - - - Looks up a localized string similar to Finish. - - - - - Looks up a localized string similar to Fit Center. - - - - - Looks up a localized string similar to Fit Pattern. - - - - - Looks up a localized string similar to Fit Size. - - - - - Looks up a localized string similar to Focus. - - - - - Looks up a localized string similar to Frame count. - - - - - Looks up a localized string similar to Frequency. - - - - - Looks up a localized string similar to From. - - - - - Looks up a localized string similar to Gain. - - - - - Looks up a localized string similar to Gap. - - - - - Looks up a localized string similar to Gap X [Bit]. - - - - - Looks up a localized string similar to Gap Y [Bit]. - - - - - Looks up a localized string similar to Generate. - - - - - Looks up a localized string similar to Generate New. - - - - - Looks up a localized string similar to Generation. - - - - - Looks up a localized string similar to Get camera info. - - - - - Looks up a localized string similar to Get defect image. - - - - - Looks up a localized string similar to Get monitoring image. - - - - - Looks up a localized string similar to Get Pos. - - - - - Looks up a localized string similar to Glass. - - - - - Looks up a localized string similar to Glass Model. - - - - - Looks up a localized string similar to Glass Size. - - - - - Looks up a localized string similar to Go. - - - - - Looks up a localized string similar to Grid. - - - - - Looks up a localized string similar to Group. - - - - - Looks up a localized string similar to Group list. - - - - - Looks up a localized string similar to Group name. - - - - - Looks up a localized string similar to Group priority. - - - - - Looks up a localized string similar to Heavy. - - - - - Looks up a localized string similar to Height. - - - - - Looks up a localized string similar to Help. - - - - - Looks up a localized string similar to Hidden menu. - - - - - Looks up a localized string similar to Hislog Config. - - - - - Looks up a localized string similar to Alarm history. - - - - - Looks up a localized string similar to Home. - - - - - Looks up a localized string similar to Hook command. - - - - - Looks up a localized string similar to Host address. - - - - - Looks up a localized string similar to Host port. - - - - - Looks up a localized string similar to ID. - - - - - Looks up a localized string similar to Ignore. - - - - - Looks up a localized string similar to Image format. - - - - - Looks up a localized string similar to Image proc desciption file. - - - - - Looks up a localized string similar to Import. - - - - - Looks up a localized string similar to Import from Csv. - - - - - Looks up a localized string similar to Import from Excel. - - - - - Looks up a localized string similar to Index. - - - - - Looks up a localized string similar to Info. - - - - - Looks up a localized string similar to Information. - - - - - Looks up a localized string similar to Init. - - - - - Looks up a localized string similar to Initialization. - - - - - Looks up a localized string similar to Initialize. - - - - - Looks up a localized string similar to Initial position. - - - - - Looks up a localized string similar to Input. - - - - - Looks up a localized string similar to Inspect. - - - - - Looks up a localized string similar to Inspect cam.. - - - - - Looks up a localized string similar to Inspection camera cal.. - - - - - Looks up a localized string similar to Inspect config file vp1. - - - - - Looks up a localized string similar to Inspect config file vp2. - - - - - Looks up a localized string similar to Inspect group 1. - - - - - Looks up a localized string similar to Inspect group 2. - - - - - Looks up a localized string similar to Inspection. - - - - - Looks up a localized string similar to Inspection config file path. - - - - - Looks up a localized string similar to Inspection param path. - - - - - Looks up a localized string similar to Inspection recipe file path. - - - - - Looks up a localized string similar to Inspect light IR. - - - - - Looks up a localized string similar to Inspect light WHITE. - - - - - Looks up a localized string similar to Inspect recipe. - - - - - Looks up a localized string similar to Inspect recipe file. - - - - - Looks up a localized string similar to Inspect save image format. - - - - - Looks up a localized string similar to Inspect save path. - - - - - Looks up a localized string similar to Installation. - - - - - Looks up a localized string similar to IP. - - - - - Looks up a localized string similar to IP address. - - - - - Looks up a localized string similar to Item. - - - - - Looks up a localized string similar to A item in use cannot be deleted.. - - - - - Looks up a localized string similar to Item List. - - - - - Looks up a localized string similar to Jog. - - - - - Looks up a localized string similar to Jog step. - - - - - Looks up a localized string similar to Keep days. - - - - - Looks up a localized string similar to Lamp. - - - - - Looks up a localized string similar to Laser. - - - - - Looks up a localized string similar to Laser Atten. - - - - - Looks up a localized string similar to Laser (Bottom). - - - - - Looks up a localized string similar to Laser Distance. - - - - - Looks up a localized string similar to Laser Distance Offset. - - - - - Looks up a localized string similar to Laser Frequency. - - - - - Looks up a localized string similar to Laser Monitoring (Bottom). - - - - - Looks up a localized string similar to Laser Monitoring (Top). - - - - - Looks up a localized string similar to Laser On Time. - - - - - Looks up a localized string similar to Laser Pos. - - - - - Looks up a localized string similar to Laser Pos2. - - - - - Looks up a localized string similar to Laser Pos Move. - - - - - Looks up a localized string similar to Laser Power. - - - - - Looks up a localized string similar to Laser Power2. - - - - - Looks up a localized string similar to Laser Recipe List. - - - - - Looks up a localized string similar to Laser (Top). - - - - - Looks up a localized string similar to Last login. - - - - - Looks up a localized string similar to Length. - - - - - Looks up a localized string similar to Level. - - - - - Looks up a localized string similar to Light. - - - - - Looks up a localized string similar to Light channel IR. - - - - - Looks up a localized string similar to Light channel WHITE. - - - - - Looks up a localized string similar to Light config. - - - - - Looks up a localized string similar to Light Control. - - - - - Looks up a localized string similar to Light values. - - - - - Looks up a localized string similar to Line. - - - - - Looks up a localized string similar to Line 1. - - - - - Looks up a localized string similar to Line 2. - - - - - Looks up a localized string similar to Line detection. - - - - - Looks up a localized string similar to Line Process. - - - - - Looks up a localized string similar to Line profiler. - - - - - Looks up a localized string similar to List. - - - - - Looks up a localized string similar to List Count. - - - - - Looks up a localized string similar to Live view. - - - - - Looks up a localized string similar to Liveview port. - - - - - Looks up a localized string similar to LMC302 view. - - - - - Looks up a localized string similar to Load. - - - - - Looks up a localized string similar to Load Data File. - - - - - Looks up a localized string similar to Load image. - - - - - Looks up a localized string similar to Location. - - - - - Looks up a localized string similar to Log control. - - - - - Looks up a localized string similar to Log In. - - - - - Looks up a localized string similar to Log Out. - - - - - Looks up a localized string similar to Log Setting. - - - - - Looks up a localized string similar to Machine No. - - - - - Looks up a localized string similar to Main. - - - - - Looks up a localized string similar to MainCamWindow. - - - - - Looks up a localized string similar to Manage account group. - - - - - Looks up a localized string similar to Management account. - - - - - Looks up a localized string similar to Manual. - - - - - Looks up a localized string similar to Manual Backup. - - - - - Looks up a localized string similar to Mark. - - - - - Looks up a localized string similar to Mark detection. - - - - - Looks up a localized string similar to Mark distance spec:. - - - - - Looks up a localized string similar to Mark finder. - - - - - Looks up a localized string similar to Mark found. - - - - - Looks up a localized string similar to Mark image path. - - - - - Looks up a localized string similar to Mark register. - - - - - Looks up a localized string similar to Mark Size X. - - - - - Looks up a localized string similar to Mark Size Y. - - - - - Looks up a localized string similar to Mark Test Points. - - - - - Looks up a localized string similar to Mask. - - - - - Looks up a localized string similar to Master mark image. - - - - - Looks up a localized string similar to Max. - - - - - Looks up a localized string similar to Maxmum. - - - - - Looks up a localized string similar to Measure. - - - - - Looks up a localized string similar to Measure camera resolution. - - - - - Looks up a localized string similar to Measure image. - - - - - Looks up a localized string similar to Measure Test Points. - - - - - Looks up a localized string similar to Measure. - - - - - Looks up a localized string similar to Message. - - - - - Looks up a localized string similar to Method. - - - - - Looks up a localized string similar to Min. - - - - - Looks up a localized string similar to Minimum. - - - - - Looks up a localized string similar to Min-line seperation. - - - - - Looks up a localized string similar to Misc.. - - - - - Looks up a localized string similar to Modbus TCP Settings. - - - - - Looks up a localized string similar to Mode. - - - - - Looks up a localized string similar to Model Data. - - - - - Looks up a localized string similar to Model Editor. - - - - - Looks up a localized string similar to Model information. - - - - - Looks up a localized string similar to Model List. - - - - - Looks up a localized string similar to Models in use cannot be deleted.. - - - - - Looks up a localized string similar to Monitoring. - - - - - Looks up a localized string similar to Motion config. - - - - - Looks up a localized string similar to Motion Parameter. - - - - - Looks up a localized string similar to Motor ID. - - - - - Looks up a localized string similar to Motor T. - - - - - Looks up a localized string similar to Motor X. - - - - - Looks up a localized string similar to Motor XY Pos. - - - - - Looks up a localized string similar to Motor Y. - - - - - Looks up a localized string similar to Motor Z. - - - - - Looks up a localized string similar to Move. - - - - - Looks up a localized string similar to Move range. - - - - - Looks up a localized string similar to New recipe is automatically created. - - - - - Looks up a localized string similar to The recipe currently in use cannot be deleted. - - - - - Looks up a localized string similar to Input New Name. - - - - - Looks up a localized string similar to Multilang example. - - - - - Looks up a localized string similar to Multi-line detection. - - - - - Looks up a localized string similar to N/A. - - - - - Looks up a localized string similar to Name. - - - - - Looks up a localized string similar to Name. - - - - - Looks up a localized string similar to {0} inspection. - - - - - Looks up a localized string similar to New. - - - - - Looks up a localized string similar to New Correction File. - - - - - Looks up a localized string similar to New Password. - - - - - Looks up a localized string similar to New recipe. - - - - - Looks up a localized string similar to Next. - - - - - Looks up a localized string similar to NG data keep days. - - - - - Looks up a localized string similar to No. - - - - - Looks up a localized string similar to Node address. - - - - - Looks up a localized string similar to Not completed. - - - - - Looks up a localized string similar to Nothing Selected. - - - - - Looks up a localized string similar to Num lines. - - - - - Looks up a localized string similar to Num X. - - - - - Looks up a localized string similar to Num Y. - - - - - Looks up a localized string similar to Off. - - - - - Looks up a localized string similar to Offset. - - - - - Looks up a localized string similar to Offset X. - - - - - Looks up a localized string similar to Offset Y. - - - - - Looks up a localized string similar to Ok. - - - - - Looks up a localized string similar to OK data keep days. - - - - - Looks up a localized string similar to On. - - - - - Looks up a localized string similar to Open Alarm Details Folder. - - - - - Looks up a localized string similar to Optional. - - - - - Looks up a localized string similar to Order. - - - - - Looks up a localized string similar to Order By. - - - - - Looks up a localized string similar to Origin path. - - - - - Looks up a localized string similar to Original path and prefix. - - - - - Looks up a localized string similar to Output. - - - - - Looks up a localized string similar to Overlap Rate. - - - - - Looks up a localized string similar to Panel Info. - - - - - Looks up a localized string similar to Param. - - - - - Looks up a localized string similar to Parameter. - - - - - Looks up a localized string similar to Password. - - - - - Looks up a localized string similar to Pattern. - - - - - Looks up a localized string similar to Pattern Type. - - - - - Looks up a localized string similar to Peak mode. - - - - - Looks up a localized string similar to Period. - - - - - Looks up a localized string similar to Permissions. - - - - - Looks up a localized string similar to Pixel threshold(H). - - - - - Looks up a localized string similar to Pixel threshold(L). - - - - - Looks up a localized string similar to Play. - - - - - Looks up a localized string similar to The alarm(code: '{0}') occurred in PLC. - - - - - Looks up a localized string similar to Point. - - - - - Looks up a localized string similar to Port. - - - - - Looks up a localized string similar to Port number. - - - - - Looks up a localized string similar to Pos. - - - - - Looks up a localized string similar to Position. - - - - - Looks up a localized string similar to Power (Atten). - - - - - Looks up a localized string similar to Power (Laser). - - - - - Looks up a localized string similar to PowerMeter. - - - - - Looks up a localized string similar to Powermeter. - - - - - Looks up a localized string similar to Powermeter Measure and Monitor. - - - - - Looks up a localized string similar to Prefix. - - - - - Looks up a localized string similar to Preview. - - - - - Looks up a localized string similar to previous Selected Model. - - - - - Looks up a localized string similar to Priority. - - - - - Looks up a localized string similar to Process 1 Glass. - - - - - Looks up a localized string similar to Progress Bar Test. - - - - - Looks up a localized string similar to Pulse. - - - - - Looks up a localized string similar to Rad.. - - - - - Looks up a localized string similar to Radius. - - - - - Looks up a localized string similar to Range. - - - - - Looks up a localized string similar to Ratio. - - - - - Looks up a localized string similar to Real distance. - - - - - Looks up a localized string similar to Real X [mm]. - - - - - Looks up a localized string similar to Real Y [mm]. - - - - - Looks up a localized string similar to Re-Capture. - - - - - Looks up a localized string similar to Recipe. - - - - - Looks up a localized string similar to Recipe Editor. - - - - - Looks up a localized string similar to Recipe List. - - - - - Looks up a localized string similar to Recipe Test. - - - - - Looks up a localized string similar to Ref. point detect. - - - - - Looks up a localized string similar to Regist. - - - - - Looks up a localized string similar to Register. - - - - - Looks up a localized string similar to Register mark image. - - - - - Looks up a localized string similar to Relative. - - - - - Looks up a localized string similar to Reload. - - - - - Looks up a localized string similar to Reload from config file. - - - - - Looks up a localized string similar to Remain Cycle. - - - - - Looks up a localized string similar to Remove. - - - - - Looks up a localized string similar to Remove recipe. - - - - - Looks up a localized string similar to Remove Selected. - - - - - Looks up a localized string similar to Rename. - - - - - Looks up a localized string similar to Rename recipe. - - - - - Looks up a localized string similar to Repeat. - - - - - Looks up a localized string similar to Repeat Count. - - - - - Looks up a localized string similar to Request Glass Enter. - - - - - Looks up a localized string similar to Request Glass Exit. - - - - - Looks up a localized string similar to Reset. - - - - - Looks up a localized string similar to Reset All. - - - - - Looks up a localized string similar to Reset Cycle. - - - - - Looks up a localized string similar to Reset Time. - - - - - Looks up a localized string similar to Resize height. - - - - - Looks up a localized string similar to Resize width. - - - - - Looks up a localized string similar to Resolution. - - - - - Looks up a localized string similar to Restore to default. - - - - - Looks up a localized string similar to Result. - - - - - Looks up a localized string similar to Reverse direction. - - - - - Looks up a localized string similar to Reverse motor T. - - - - - Looks up a localized string similar to Reverse motor X. - - - - - Looks up a localized string similar to Reverse motor Y. - - - - - Looks up a localized string similar to Reverse motor Z. - - - - - Looks up a localized string similar to Review. - - - - - Looks up a localized string similar to Review Cam. - - - - - Looks up a localized string similar to RTC X [Bit]. - - - - - Looks up a localized string similar to RTC Y [Bit]. - - - - - Looks up a localized string similar to Safety. - - - - - Looks up a localized string similar to Same Value. - - - - - Looks up a localized string similar to Save. - - - - - Looks up a localized string similar to Save As. - - - - - Looks up a localized string similar to Save Calibration Data. - - - - - Looks up a localized string similar to Save Data File. - - - - - Looks up a localized string similar to Save recipe. - - - - - Looks up a localized string similar to Save to config file. - - - - - Looks up a localized string similar to Save to Csv. - - - - - Looks up a localized string similar to Scale. - - - - - Looks up a localized string similar to Scan ID. - - - - - Looks up a localized string similar to Scanner Calibration. - - - - - Looks up a localized string similar to Scanner Direction. - - - - - Looks up a localized string similar to Scan time (ms). - - - - - Looks up a localized string similar to Score. - - - - - Looks up a localized string similar to Search direction. - - - - - Looks up a localized string similar to Select. - - - - - Looks up a localized string similar to Select All. - - - - - Looks up a localized string similar to Selected account. - - - - - Looks up a localized string similar to Selected group. - - - - - Looks up a localized string similar to Select recipe. - - - - - Looks up a localized string similar to Seperated image index. - - - - - Looks up a localized string similar to SEQ End. - - - - - Looks up a localized string similar to SEQ Start. - - - - - Looks up a localized string similar to Sequence button. - - - - - Looks up a localized string similar to Serial Settings. - - - - - Looks up a localized string similar to Servo on. - - - - - Looks up a localized string similar to Set. - - - - - Looks up a localized string similar to Set active. - - - - - Looks up a localized string similar to Set All. - - - - - Looks up a localized string similar to Set ▼. - - - - - Looks up a localized string similar to Set Initial Condition. - - - - - Looks up a localized string similar to Set New Correction File. - - - - - Looks up a localized string similar to Set position. - - - - - Looks up a localized string similar to Set position. - - - - - Looks up a localized string similar to Set Time. - - - - - Looks up a localized string similar to Setting. - - - - - Looks up a localized string similar to Settings. - - - - - Looks up a localized string similar to Setup. - - - - - Looks up a localized string similar to Shot Count. - - - - - Looks up a localized string similar to Shot Count (Laser). - - - - - Looks up a localized string similar to Shot Mode. - - - - - Looks up a localized string similar to Shot Process. - - - - - Looks up a localized string similar to Shot Split (Line). - - - - - Looks up a localized string similar to Shot Split (Spot). - - - - - Looks up a localized string similar to Shot Test. - - - - - Looks up a localized string similar to Side (Top/Bottom). - - - - - Looks up a localized string similar to Simulation Mode. - - - - - Looks up a localized string similar to Size. - - - - - Looks up a localized string similar to Socket address. - - - - - Looks up a localized string similar to Socket Settings. - - - - - Looks up a localized string similar to Solution. - - - - - Looks up a localized string similar to Spec.. - - - - - Looks up a localized string similar to Speed. - - - - - Looks up a localized string similar to Split Param. - - - - - Looks up a localized string similar to Stage. - - - - - Looks up a localized string similar to Standard point. - - - - - Looks up a localized string similar to Start. - - - - - Looks up a localized string similar to Start Pos. - - - - - Looks up a localized string similar to Start Position. - - - - - Looks up a localized string similar to Start preview. - - - - - Looks up a localized string similar to Start simulation. - - - - - Looks up a localized string similar to Start simulation all. - - - - - Looks up a localized string similar to Start X. - - - - - Looks up a localized string similar to Start Y. - - - - - Looks up a localized string similar to State. - - - - - Looks up a localized string similar to Status. - - - - - Looks up a localized string similar to Step. - - - - - Looks up a localized string similar to Stop. - - - - - Looks up a localized string similar to Storage duration. - - - - - Looks up a localized string similar to Storage File Count. - - - - - Looks up a localized string similar to #16Bit. - - - - - Looks up a localized string similar to #32Bit. - - - - - Looks up a localized string similar to #32Bit real. - - - - - Looks up a localized string similar to Strobe on time. - - - - - Looks up a localized string similar to Sw trigger. - - - - - Looks up a localized string similar to Sw trigger interval. - - - - - Looks up a localized string similar to System Settings. - - - - - Looks up a localized string similar to Target Pos. - - - - - Looks up a localized string similar to Target position. - - - - - Looks up a localized string similar to Tcolor. - - - - - Looks up a localized string similar to Teach. - - - - - Looks up a localized string similar to Teach align pos X. - - - - - Looks up a localized string similar to Teach align pos Y. - - - - - Looks up a localized string similar to Teaching. - - - - - Looks up a localized string similar to Teach mark position. - - - - - Looks up a localized string similar to Alarm time. - - - - - Looks up a localized string similar to To. - - - - - Looks up a localized string similar to Toggle between palette and color value panels.. - - - - - Looks up a localized string similar to Toggle this button and pick a color by pressing 'shift'.. - - - - - Looks up a localized string similar to Toggling. - - - - - Looks up a localized string similar to Top. - - - - - Looks up a localized string similar to Total Cycle. - - - - - Looks up a localized string similar to Total offset. - - - - - Looks up a localized string similar to Trigger all. - - - - - Looks up a localized string similar to Trigger once. - - - - - Looks up a localized string similar to Troubleshooting. - - - - - Looks up a localized string similar to Type. - - - - - Looks up a localized string similar to Type (Laser). - - - - - Looks up a localized string similar to Uniformity. - - - - - Looks up a localized string similar to Unit. - - - - - Looks up a localized string similar to Unload. - - - - - Looks up a localized string similar to Unlock. - - - - - Looks up a localized string similar to Update map to device. - - - - - Looks up a localized string similar to Use. - - - - - Looks up a localized string similar to Use local. - - - - - Looks up a localized string similar to User ID. - - - - - Looks up a localized string similar to Use subcribe frame image. - - - - - Looks up a localized string similar to Use sw trigger. - - - - - Looks up a localized string similar to Use X. - - - - - Looks up a localized string similar to Use X distance. - - - - - Looks up a localized string similar to Use Y. - - - - - Looks up a localized string similar to Use Y distance. - - - - - Looks up a localized string similar to UVW Align Test. - - - - - Looks up a localized string similar to Vaccum Status. - - - - - Looks up a localized string similar to Value. - - - - - Looks up a localized string similar to Velocity. - - - - - Looks up a localized string similar to Velocity level. - - - - - Looks up a localized string similar to Velocity range. - - - - - Looks up a localized string similar to Verify. - - - - - Looks up a localized string similar to Vietnamese. - - - - - Looks up a localized string similar to Viewer. - - - - - Looks up a localized string similar to Vision. - - - - - Looks up a localized string similar to VP. - - - - - Looks up a localized string similar to Warning. - - - - - Looks up a localized string similar to [Warning] Be careful not to select [Delete after backup] option for recipe folder. - - - - - Looks up a localized string similar to Width. - - - - - Looks up a localized string similar to With Description Only. - - - - - Looks up a localized string similar to Word In/Out. - - - - - Looks up a localized string similar to Word Input ( PLC → PC ). - - - - - Looks up a localized string similar to Word Output ( PC → PLC ). - - - - - Looks up a localized string similar to Working Pos. - - - - - Looks up a localized string similar to Zoom. - - - - - AuroraApp - - - - - InitializeComponent - - - - - Application Entry Point. - - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Holder for reflection information generated from aurora_dev_pb.proto - - - File descriptor for aurora_dev_pb.proto - - - Field number for the "min" field. - - - Field number for the "max" field. - - - Field number for the "min" field. - - - Field number for the "max" field. - - - Field number for the "min" field. - - - Field number for the "max" field. - - - Field number for the "alarm" field. - - - Field number for the "alarm" field. - - - - Specifies that the text binding should be triggered at every change. - - - - - Specifies a base path property for relative path names. - - - - - Initializes a new instance of the class. - - Name of the base path property. - - - - Gets or sets the name of the base path property. - - The name of the base path property. - - - - Specifies whether a property or event should be displayed in a Properties window. - - - - - Initializes a new instance of the class. - - true if a property or event can be modified at design time; otherwise, false. The default is true. - - - - Gets a value indicating whether an object is browsable. - - true if the object is browsable; otherwise, false. - - - - Specifies the name of the category in which to group the property or event when displayed in a PropertyGrid control. - - - - - Initializes a new instance of the class. - - The category. - - - - Gets the category. - - The category. - - - - Specifies the name of the properties that controls the IsChecked and Content of checkable items. - - - - - Initializes a new instance of the class. - - Name of the IsChecked property. - Name of the Content property. - - - - Gets or sets the name of the IsChecked property. - - The name of the property. - - - - Gets or sets the name of the content property. - - The name of the content property. - - - - Defines a column for displaying an item collection. Typically used with . - - - - - Initializes a new instance of the class. - - Name of the property. - - - - Initializes a new instance of the class. - - Name of the property. - The header. - Name of the item source property. - - - - Initializes a new instance of the class. - - The property name. - The header. - The format string. - The width. - The alignment. - The columns is read only if set to true. - Name of the items source property. - - - - Gets or sets the alignment (L, R, C or S). - - The alignment. - - - - Gets or sets a value indicating whether the column values are read only (overriding default binding mode). - - true if the column is read only; otherwise, false. - If this property is set to true, the binding mode will be one-way also for properties with setters. - - - - Gets or sets the index of the column. - - The index of the column. - - - - Gets or sets the format string. - - The format string. - - - - Gets or sets the header. - - The header. - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the name of the items source property. - - The name of the item source property. - - - - Gets or sets the width ("Auto", "0.5*" etc. are ok). - - The width. - - - - Specifies the name of a property that provides columns for a data grid. - - - - - Initializes a new instance of the class. - - Name of the property. - - - - Gets or sets the name of the property. - - The name of the property. - - - - Specifies that the value is a comment. - - - - - Specifies that the value contains content that should be handled by a ContentControl. - - - - - Specifies a converter that should be used for the property. - - - - - Initializes a new instance of the class. - - Type of the converter. - - - - Gets or sets the type of the converter. - - The type of the converter. - - - - Specifies that the decorated property should get its DefaultExtension from the specified property. - - - - - Initializes a new instance of the class. - - Name of the property that contains the default extension. - - - - Gets or sets the name of the property. - - The name of the property. - - - - Specifies a description for a property or event. - - - - - Initializes a new instance of the class. - - The description. - - - - Gets the description stored in this attribute. - - The description. - - - - Specifies that the property is a directory path. - - - - - Specifies the path used to get the selected value of an item. - - - - - Initializes a new instance of the class. - - The path used to get the display value. - - - - Gets or sets the path. - - The path. - - - - Specifies the display name for a property, event, or public void method which takes no arguments. - - - - - Initializes a new instance of the class. - - The display name. - - - - Gets the display name. - - The display name. - - - - Specifies that it should be easy to insert new items in a List property. When the DataGrid control is used, the easy insert properties will be set. - - - - - Initializes a new instance of the class. - - if set to true [easy insert]. - - - - Initializes a new instance of the class. - - enable easy insert by keyboard if set to true. - enable easy insert by mouse if set to true. - - - - Gets a value indicating whether easy insert by keyboard is enabled. - - true if easy insert is enabled; otherwise, false. - - - - Gets a value indicating whether easy insert by mouse is enabled. - - true if easy insert is enabled; otherwise, false. - - - - Specifies whether the property this attribute is bound to is editable. - - - - - Initializes a new instance of the class. - - Allow edit if set to true. - - - - Indicates whether or not the field/property allows editing of the - value. - - - When true, the field/property is editable. - - When false, the field/property is not editable. - - - - - - Specifies the name of a property that controls the enabled/disabled state of the attributed property. - - - - - Initializes a new instance of the class. - - Name of the property. - - - - Initializes a new instance of the class. - - Name of the property. - The property value that enables the attributed property. - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the value that enables the attributed property. - - - - - Specifies the name of a property that controls the enabled/disabled state of the attributed property. - - - - - Initializes a new instance of the class. - - Name of the enumeration property. - The enumeration value that enables the attributed property. - - - - Gets the name of the property that determines if the decorated property is enabled or not. - - The name of the property. - - - - Gets the value that enables the decorated property. - - The value. - - - - Specifies that the control representing the property should fill the entire size of the tab page. - - This requires only one property on the tab page. - - - - Specifies the name of a property that contains a file path filter. - - - - - Initializes a new instance of the class. - - Name of the property that contains the filter. - - - - Gets or sets the name of the property. - - The name of the property. - - - - Specifies the font family, size and weight. - - - - - Initializes a new instance of the class. - - The font family. - The size. - The weight. - - - - Gets or sets the font family. - - The font family. - - - - Gets or sets the font size. - - The size. - - - - Gets or sets the font weight. - - The weight. - - - - Specifies that a font family selector should be used. - - - - - Specifies the font size, weight and the name of a property that contains the font family. - - - - - Initializes a new instance of the class. - - The size. - The weight. - - - - Initializes a new instance of the class. - - Name of the font family property. - The size. - The weight. - - - - Gets or sets the name of the font family property. - - The name of the font family property. - - - - Gets or sets the size. - - The size. - - - - Gets or sets the weight. - - The weight. - - - - Specifies a format string. - - - - - Initializes a new instance of the class. - - The format string. - - - - Gets or sets the format string. - - The format string. - - - - Header placement values. - - - - - Header on the left. - - - - - Header above. - - - - - Hidden header. - - - - - Collapsed header. - - - - - Specifies the property header placement. - - - - - Initializes a new instance of the class. - - The placement. - - - - Gets or sets the header placement. - - The header placement. - - - - Specifies the heights of the property control. - - - - - Initializes a new instance of the class. - - The height. - Height of the min. - Height of the max. - - - - Gets or sets the height. - - The height. - - - - Gets or sets the maximum height. - - The maximum height. - - - - Gets or sets the minimum height. - - The minimum height. - - - - Specifies how an object or text in a control is horizontally aligned relative to an element of the control. - - - - - The object or text is aligned on the left of the control element. - - - - - The object or text is aligned in the center of the control element. - - - - - The object or text is aligned on the right of the control element. - - - - - Specifies the horizontal alignment. - - - - - Initializes a new instance of the class. - - The alignment. - - - - Gets or sets the horizontal alignment. - - The horizontal alignment. - - - - Specifies the indentation level for the decorated property. - - - - - Initializes a new instance of the class. - - The indentation level. - - - - Gets or sets the indentation level. - - - The indentation level. - - - - - Defines the InputDirection of a grid (the direction the current cell is moved when Enter is pressed) - - - - - Move horizontally. - - - - - Move vertically. - - - - - Specifies the input direction for the decorated property. - - - - - Initializes a new instance of the class. - - The input direction. - - - - Gets or sets the input direction. - - The input direction. - - - - Specifies that the decorated property is an input file. - - - - - Initializes a new instance of the class. - - The default extension. - The filter. - - - - Initializes a new instance of the class. - - The default extension. - The filter. - - - - Initializes a new instance of the class. - - The default extension. - - - - Initializes a new instance of the class. - - - - - Gets or sets the default extension. - - The default extension. - - - - Gets or sets the filter. - - The filter. - - - - Gets or sets the initial directory path. - - The initial directory path. - - - - Specifies the item header property. - - - - - Initializes a new instance of the class. - - The item header property. - - - - Gets or sets the item header property. - - The item header property. - - - - Specifies the name of a property that contains values for the attributed property. - - - - - Initializes a new instance of the class. - - Name of the property. - - - - Gets or sets the name of the property. - - The name of the property. - - - - Specifies properties for lists. - - - - - Initializes a new instance of the class. - - can add items if set to true. - can remove items if set to true. - The max number of items. - - - - Gets or sets a value indicating whether this instance can add items to the list. - - true if this instance can add; otherwise, false. - - - - Gets or sets a value indicating whether this instance can remove items from the list. - - true if this instance can remove; otherwise, false. - - - - Gets or sets the maximum number of items. - - The maximum number of items. - - - - Specifies the name of a property that contains values for the items in the decorated list property. - - - - - Initializes a new instance of the class. - - Name of the property. - - - - Gets or sets the name of the property. - - The name of the property. - - - - Specifies that the property is optional. - - The name of a property that controls the state of the property can also be specified. - Properties marked with [Optional] will have a checkbox as the label. - The checkbox will enable/disable the property value editor. - Example usage: - [Optional] // requires a property type - [Optional("HasSomething")] // relates to other property HasSomething - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the property. - - - - Gets or sets the name of the property. - - The name of the property. - - - - Specifies that the decorated property is an output file. - - - - - Initializes a new instance of the class. - - The default extension. - The filter. - - - - Initializes a new instance of the class. - - The default extension. - - - - Initializes a new instance of the class. - - - - - Specifies whether the property this attribute is bound to is read-only or read/write. - - - - - Initializes a new instance of the class. - - true to show that the property this attribute is bound to is read-only; false to show that the property is read/write. - - - - Gets a value indicating whether the property this attribute is bound to is read-only. - - true if the property this attribute is bound to is read-only; false if the property is read/write. - - - - Specifies that the property is resettable. - - Properties marked with [Resettable] will have a reset button. - The button will reset the property to the configured reset value. - Example usage: - [Resettable] // Button label is "Reset" - [Resettable("Default")] // Button label is "Default" - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The label. - - - - Gets or sets the button label. - - The button label. - - - - Specifies the path used to get the selected value of an item. - - - - - Initializes a new instance of the class. - - The path used to get the selected value. - - - - Gets or sets the path. - - The path. - - - - Defines the style of selector controls. - - - - - Automatic style. - - - - - Use radio buttons. - - - - - Use combo box. - - - - - Use list box. - - - - - Specifies what control style a selector property should use. - - - - - Initializes a new instance of the class. - - The selector style. - - - - Gets the selector style. - - The selector style. - - - - Specifies that the property can be edited by a slider. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The minimum. - The maximum. - - - - Initializes a new instance of the class. - - The minimum. - The maximum. - The small change. - The large change. - - - - Initializes a new instance of the class. - - The minimum. - The maximum. - The small change. - The large change. - if set to true [snap to ticks]. - The tick frequency. - - - - Gets or sets the large change. - - The large change. - - - - Gets or sets the maximum. - - The maximum. - - - - Gets or sets the minimum. - - The minimum. - - - - Gets or sets the small change. - - The small change. - - - - Gets or sets a value indicating whether [snap to ticks]. - - true if [snap to ticks]; otherwise, false. - - - - Gets or sets the tick frequency. - - The tick frequency. - - - - Specifies the property sorting index number. - - The sort index is used to sort the tabs, categories and properties. - - - - Initializes a new instance of the class. - - Index of the sort. - - - - Gets or sets the index of the sort. - - The index of the sort. - - - - Specifies that the property can be edited by a spin control. - - See MSDN. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The small change. - - - - Initializes a new instance of the class. - - The small change. - The large change. - - - - Initializes a new instance of the class. - - The small change. - The large change. - The minimum. - The maximum. - - - - Gets or sets the small change. - - The small change. - - - - Gets or sets the large change. - - The large change. - - - - Gets or sets the maximum. - - The maximum. - - - - Gets or sets the minimum. - - The minimum. - - - - Specifies the name of property that controls the visibility state of the attributed property. - - - - - Initializes a new instance of the class. - - Name of the property that determines the visibility of the attributed property. - - - - Initializes a new instance of the class. - - Name of the property that determines the visibility of the attributed property. - The property value that makes the attributed property visible. - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the value that makes the attributed property visible. - - - - - Specifies that the property should be edited in wide mode. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - if set to true [show header]. - - - - Gets or sets a value indicating whether [show header]. - - true if [show header]; otherwise, false. - - - - Specifies the width of the editing control. - - - - - Initializes a new instance of the class. - - The width. - - - - Gets or sets the width. - - The width. - - - - Indicates where an item should be dropped. - - - - - Add the item to the target item. - - - - - Insert the item before the target item. - - - - - Insert the item after the target item. - - - - - Allows an object to be dragged. - - - - - Gets a value indicating whether this instance is possible to drag. - - - - - Detaches this instance (for move and drop somewhere else). - - - - - Specifies the current state of the modifier keys (SHIFT, CTRL, and ALT), as well as the state of the mouse buttons. - - - - - No modifier keys or mouse buttons are pressed. - - - - - The left mouse button is pressed. - - - - - The right mouse button is pressed. - - - - - The shift key is pressed. - - - - - The control key is pressed. - - - - - The middle mouse button is pressed. - - - - - The alt key is pressed. - - - - - Specifies the effects of a drag-and-drop operation. - - - - - The drop target does not accept the data. - - - - - The data is copied to the drop target. - - - - - The data from the drag source is moved to the drop target. - - - - - The data from the drag source is linked to the drop target. - - - - - Allows an object to receive dropped items. - - - - - Determines whether the specified can be dropped here. - - The node. - The position where the should be dropped. - The drag/drop effect. - true if this instance accepts a drop of the specified ; otherwise, false. - - - - Drops the specified at this object. - - The items to drop. - The position where the should be dropped. - The drag/drop effect. - The initial drag/drop key states. - - - - Provides a base class implementing INotifyPropertyChanged. - - - - - Occurs when a property value changes. - - - - - Called when the specified property has been changed. - - Name of the property. - The old value. - The new value. - - - - Raises the property changed event. - - Name of the property. - - - - Sets the property value. - - The type of the property. - The field. - The value. - Name of the property. - - True if the property was set. - - This method uses the CallerMemberNameAttribute to determine the property name. - - - - Verifies the property name. - - Name of the property. - - - - Provides a behavior that let you capture the contents of a control to a bitmap and copy it to the clipboard. - - - - - Initializes static members of the class. - - - - - Gets the command property. - - The command property. - - - - Gets the gesture property. - - The gesture property. - - - - Gets the command property. - - The element. - - A KeyCommand. - - - - - Gets the gesture property. - - The element. - - A KeyGesture. - - - - - Sets the command property. - - The element. - The value. - - - - Sets the gesture property. - - The element. - The value. - - - - Grabs the specified element and copies to clipboard. - - The element. - The resolution (dots per inch). - - - - Called when the command has changed. - - The sender. - The instance containing the event data. - - - - Called when gesture has changed. - - The sender. - The instance containing the event data. - - - - Contains behaviors for the control. - - - - - Identifies the NavigateToString dependency property. - - - - - Gets the value of the NavigateToString property. - - The object. - The string. - - - - Sets the value of the NavigateToString property. - - The object. - The value. - - - - The navigate to string changed. - - The d. - The e. - - - - Provides a CommandBinding based on delegates. - - - - - The execute action. - - - - - The can execute function. - - - - - Initializes a new instance of the class. - - The command. - The execute action. - The can execute function. - - - - Executes the delegate. - - The sender. - The instance containing the event data. - - - - Determines whether this command can execute. - - The sender. - The instance containing the event data. - - - - Provides a command binding that passes to command parameter to delegates. - - The type of the command parameter. - - - - The execute action. - - - - - The can execute function. - - - - - Initializes a new instance of the class. - - The command. - The execute action. - The can execute function. - - - - Executes the delegate. - - The sender. - The instance containing the event data. - - - - Determines whether this command can execute. - - The sender. - The instance containing the event data. - - - - Represents a delegate command. - - - - - The can execute. - - - - - The execute. - - - - - Initializes a new instance of the class. - - The execute. - - - - Initializes a new instance of the class. - - The execute. - The can execute. - - - - Occurs when changes occur that affect whether or not the command should execute. - - - - - Defines the method that determines whether the command can execute in its current state. - - Data used by the command. If the command does not require data to be passed, this object can be set to null. - - true if this command can be executed; otherwise, false. - - - - - Defines the method to be called when the command is invoked. - - Data used by the command. If the command does not require data to be passed, this object can be set to null. - - - - Raises the can execute changed. - - - - - Compares two sequences. - - Type of item in the sequences. - - Compares elements from the two input sequences in turn. If we - run out of list before finding unequal elements, then the shorter - list is deemed to be the lesser list. - - - - - Object used for comparing each element. - - - - - Initializes a new instance of the class using the default comparer for {T}. - - - - - Initializes a new instance of the class using the specified comparer for {T}. - - Comparer for comparing each pair of items from the sequences. - - - - Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other. - - First sequence. - Second sequence. - - A signed integer that indicates the relative values of and , as shown in the following table.Value Meaning Less than zero is less than .Zero equals .Greater than zero is greater than . - - - - - Defines a comparer that uses a collection of sort descriptions. - - - - - - Gets the sort descriptions. - - - The sort descriptions. - - - - - Implements a generic object comparer that using natural comparison on strings. - - - - - The string comparer - - - - - Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other. - - The first object to compare. - The second object to compare. - - A signed integer that indicates the relative values of and , as shown in the following table.Value Meaning Less than zero is less than .Zero equals .Greater than zero is greater than . - - - - - Implements an item comparer that uses reflection and a list of sort descriptions. - - - - - The enumerable comparer. - - - - - Initializes a new instance of the class. - - - - - Gets the sort descriptions. - - - The sort descriptions. - - - - - Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other. - - The first object to compare. - The second object to compare. - - A signed integer that indicates the relative values of and , as shown in the following table.Value Meaning Less than zero is less than . Zero equals . Greater than zero is greater than . - - - - - Implements a natural comparer for strings. - - - - - The comparer for sequences of objects. - - - - - The regular expression used to split numbers and text. - - - - - Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other. - - The first object to compare. - The second object to compare. - - A signed integer that indicates the relative values of and , as shown in the following table.Value Meaning Less than zero is less than .Zero equals .Greater than zero is greater than . - - - - - Represents an image that avoids blurring over pixel boundaries. - - The Bitmap element is using the ActualWidth/Height of the image for the control size. - It also offsets the image to avoid blurring over pixel boundaries. - http://blogs.msdn.com/b/dwayneneed/archive/2007/10/05/blurry-bitmaps.aspx - - - - Identifies the dependency property. - - - - - The source downloaded. - - - - - The source failed. - - - - - The pixel offset. - - - - - Initializes a new instance of the class. - - - - - The bitmap failed. - - - - - Gets or sets the source. - - The source. - - - - When overridden in a derived class, measures the size in layout required for child elements and determines a size for the -derived class. - - The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available. - - The size that this element determines it needs during layout, based on its calculations of child element sizes. - - - - - Called when rendering. - - The dc. - - - - Called when the source changed. - - The d. - The instance containing the event data. - - - - Applies the visual transform. - - The point. - The v. - if set to true [inverse]. - - The transformed point. - - - - - Determines if two points are close. - - The point1. - The point2. - - True if close. - - - - - Determines of two values are close. - - The value1. - The value2. - - True if close. - - - - - Gets the pixel offset. - - - The pixel offset. - - - - - Gets the visual transform. - - The v. - - The . - - Gets the matrix that will convert a point from "above" the - coordinate space of a visual into the the coordinate space - "below" the visual. - - - - Called when layout is updated. - - The sender. - The instance containing the event data. - - - - Called when the source has downloaded. - - The sender. - The instance containing the event data. - - - - Called when source failed. - - The sender. - The instance containing the event data. - - - - Tries to apply the visual transform. - - The point. - The v. - if set to true [inverse]. - if set to true [throw on error]. - if set to true [success]. - - The . - - - - - Represents a control that shows a check mark (not editable CheckBox without the box). - - - - - Identifies the dependency property. - - - - - Initializes static members of the class. - - - - - Gets or sets a value indicating whether this instance is checked. - - true if this instance is checked; otherwise, false. - - - - Represents a control that lets the user pick a color. - - - - - Identifies the dependency property. - - - - - The color picker panel part constant. - - - - - The color picker panel. - - - - - Initializes static members of the class. - - - - - Gets or sets the selected color. - - The color of the selected. - - - - Called when is called. - - - - - Coerces the value of the property. - - The base value. - - The coerced value. - - - - - Reports when a combo box's popup opens. - - The event data for the event. - - - - Handles changes in selected color. - - The instance containing the event data. - - - - Coerces the selected color value. - - The sender. - The base value. - - The coerced value. - - - - - Handles changes in selected color. - - The d. - The instance containing the event data. - - - - Handles the event. - - The sender. - The instance containing the event data. - - - - Represents a control that lets the user pick a color. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - The HSV control part name. - - - - - The predefined color panel part name - - - - - The max number of recent colors. - - - - - The show hsv panel. - - - - - The HSV control. - - - - - The picking timer. - - - - - The within color change. - - - - - The within component change. - - - - - Initializes static members of the class. - - - - - Initializes a new instance of the class. - - - - - The property changed. - - - - - The predefined colors selection changed event - - - - - Gets the recent colors. - - The recent colors. - - - - Gets the standard colors. - - The standard colors. - - - - Gets or sets the localized strings. - - - - - Gets the theme colors. - - The theme colors. - - - - Gets the opacity colors. - - The opacity colors. - - - - Gets or sets the alpha value. - - The alpha. - - - - Gets or sets the blue. - - The blue. - - - - Gets or sets the brightness. - - The brightness. - - - - Gets or sets the green. - - The green. - - - - Gets or sets the hue. - - The hue. - - - - Gets or sets a value indicating whether this user is picking colors on the screen. - - - - - Gets or sets the max number of recent colors. - - The max number of recent colors. - - - - Gets or sets the red value. - - The red. - - - - Gets or sets the saturation. - - The saturation. - - - - Gets or sets the selected color. - - The color of the selected. - - - - Gets or sets a value indicating whether to show the HSV panel. - - The backing field is static. - - - - Determines whether the user is color picking. - - - true if the user is picking a color; otherwise, false. - - - - - When overridden in a derived class, is invoked whenever application code or internal processes call . - - - - - Coerces the selected color value. - - The base value. - - The coerced selected color value. - - - - - Called when a color component is changed. - - The instance containing the event data. - - - - Called when the IsPicking property is changed. - - - - - Called when the selected color changed. - - The new color. - The old color. - - - - The raise property changed. - - The property. - - - - Coerces the selected color value. - - The d. - The base value. - - The coerce selected color value. - - - - - Called when a color component is changed. - - The d. - The instance containing the event data. - - - - Initializes the palettes. - - - - - The is picking changed. - - The d. - The e. - - - - The selected color changed. - - The d. - The e. - - - - The add color to recent colors if missing. - - The color. - - - - Handles the event. - - The sender. - The instance containing the event data. - - - - Called when the panel is unloaded. - - The sender. - The instance containing the event data. - - - - Picks a color from the current mouse position. - - The sender. - The instance containing the event data. - - - - Determines whether the color picking key is pressed. - - - true if the key is down; otherwise, false. - - - - - Updates the opacity variation collection. - - The currently selected color. - - - - Updates the hue, saturation and brightness properties. - - The currently selected color. - - - - Updates the red, green, blue and alpha properties. - - The color. - - - - Provides localized strings for the color picker panel. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the tool tip for the 'color picker' button. - - - - - Gets or sets the tool tip for the 'toggle panel' button. - - - - - Gets or sets the 'HSV' string. - - - - - Gets or sets 'RecentColors' string. - - - - - Gets or sets the 'Opacity variations' string. - - - - - Gets or sets the 'Standard colors' string. - - - - - Gets or sets the 'Theme colors' string. - - - - - Gets or sets the 'Values' string. - - - - - Represents a color slider. - - Original code by Ury Jamshy, 21 July 2011. - See http://www.codeproject.com/KB/WPF/ColorPicker010.aspx - The Code Project Open License (CPOL) - http://www.codeproject.com/info/cpol10.aspx - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Initializes static members of the class. - - - - - Gets or sets the left color. - - - - - Gets or sets the right color. - - - - - The hsv control. - - Original code by Ury Jamshy, 21 July 2011. - See http://www.codeproject.com/KB/WPF/ColorPicker010.aspx - The Code Project Open License (CPOL) - http://www.codeproject.com/info/cpol10.aspx - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - The thumb name. - - - - - The thumb transform. - - - - - The thumb. - - - - - The within update flag. - - - - - Initializes static members of the class. - - - - - The on thumb drag completed. - - The sender. - The e. - - - - The on thumb drag completed. - - The sender. - - - - Gets or sets Hue. - - - - - Gets or sets Saturation. - - - - - Gets or sets SelectedColor. - - - - - Gets or sets Value. - - - - - The on apply template. - - - - - Invoked when an unhandled �routed event is raised on this element. Implement this method to add class handling for this event. - - The that contains the event data. The event data reports that the left mouse button was pressed. - - - - The on render size changed. - - The size info. - - - - The on hue changed. - - The related object. - The e. - - - - The on saturation changed. - - The related object. - The e. - - - - The on thumb drag delta. - - The sender. - The e. - - - - The on value changed. - - The related object. - The e. - - - - Limit value to range (0 , max] - - The value. - The max. - - The limit value. - - - - - The on thumb drag delta. - - The e. - - - - The update position and saturation and value. - - The position x. - The position y. - - - - The update selected color. - - - - - The update thumb position. - - - - - The spectrum slider. - - Original code by Ury Jamshy, 21 July 2011. - See http://www.codeproject.com/KB/WPF/ColorPicker010.aspx - The Code Project Open License (CPOL) - http://www.codeproject.com/info/cpol10.aspx - - - - Identifies the dependency property. - - - - - The within changing flag. - - - - - Initializes static members of the class. - - - - - Initializes a new instance of the class. - - - - - Gets or sets Hue. - - - - - The on value changed. - - The old value. - The new value. - - - - The on hue property changed. - - The related object. - The e. - - - - The set background. - - - - - Represents a control that lets the user change the size of elements in a . - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - The element. - - - - - The height. - - - - - The previous parent height. - - - - - The previous parent width. - - - - - The start drag point. - - - - - The width. - - - - - Initializes static members of the class. - - - - - Initializes a new instance of the class. - - - - - Gets a value indicating whether this splitter is horizontal. - - - - - Gets or sets a value indicating whether to resize elements proportionally. - - Set to false if you don't want the element to be resized when the parent is resized. - - - - Gets or sets the thickness (height or width, depending on orientation). - - The thickness. - - - - Invoked when an unhandled  attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. - - The that contains the event data. This event data reports details about the mouse button that was pressed and the handled state. - - - - Invoked when an unhandled  attached event is raised on this element. Implement this method to add class handling for this event. - - The that contains the event data. - - - - Invoked when an unhandled  attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. - - The that contains the event data. - - - - Invoked when an unhandled  routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. - - The that contains the event data. The event data reports that the mouse button was released. - - - - The dock changed. - - The d. - The e. - - - - The thickness changed. - - The d. - The e. - - - - Adjusts the height. - - The dy. - The dock. - - The adjust height. - - - - - Adjusts the width. - - The dx. - The dock. - - The adjust width. - - - - - Called when the control is loaded. - - The sender. - The instance containing the event data. - - - - Called when the control is unloaded. - - The sender. - The instance containing the event data. - - - - Called when the parent element size is changed. - - The sender. - The instance containing the event data. - - - - Sets the height of the target. - - The new height. - - - - Sets the width of the target. - - The new width. - - - - Updates the width or height . - - - - - Updates the target element (the element the DockPanelSplitter works on). - - - - - Provides an editable text block. - - - - - Identifies the dependency property. - - - - - Flags if it is an internal change in the IsEditing property - - - - - The old focus element. - - - - - The text box. - - - - - Initializes static members of the class. - - - - - Gets or sets a value indicating whether this instance is editing. - - - - - Gets or sets the horizontal alignment of the content when editing - - - - - Gets or sets the vertical alignment of the content when editing - - - - - Begins the edit. - - - - - Ends the edit. - - if set to true [commit]. - - - - Handles changes in IsEditing. - - - - - TextBox key down handler. - - The sender. - The instance containing the event data. - - - - TextBox lost focus handler. - - The sender. - The instance containing the event data. - - - - Represents a menu item with a SelectedValue property that can bind to Enum values. - - - - - Identifies the dependency property. - - - - - Gets or sets the selected value. - - The selected value. - - - - The selected value changed. - - The d. - The e. - - - - Called when a menu item is clicked. - - The sender. - The instance containing the event data. - - - - Called when selected value changed. - - - - - Represents a control that allows the user to pick a directory. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Initializes static members of the class. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the browse command. - - The browse command. - - - - Gets or sets the explore command. - - The explore command. - - - - Gets or sets the directory. - - - - - Gets or sets FolderBrowserDialogService. - - - - - Gets or sets the content on the "browse" button. - - - - - Gets or sets the content on the "explore" button. - - - - - Gets or sets the ToolTip on the "browse" button. - - - - - Gets or sets the ToolTip on the "explore" button. - - - - - Open the browse dialog. - - - - - Opens Windows Explorer with the current directory. - - - - - Represents a control that allows the user to pick a file. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Initializes static members of the class. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the browse command. - - The browse command. - - - - Gets or sets the explore command. - - The explore command. - - - - Gets or sets the open command. - - The open command. - - - - Gets or sets the default extension. - - The default extension. - - - - Gets or sets a value indicating whether the allows users to select multiple files. - - true if multiple selections are allowed; otherwise, false. The default is false. - When this feature is enabled, use the property to get/set the filenames. - - - - Gets a value indicating whether input is enabled. - - If the is in multi-select mode, disable free form text input. - - - - Gets or sets the file dialog service. - - The file dialog service. - - - - Gets or sets the base path. - - The base path. - - - - Gets or sets the initial directory. - - The initial directory path. - - - - Gets or sets the file path. - - The file path. - - - - Gets or sets the file paths. - - The file paths. - - - - Gets or sets the filter. - - The filter. - - - - Gets or sets a value indicating whether to use the File Open Dialog. - - The "File Open" dialog is used if the property is set to true; otherwise, the File Save dialog is used. - - - - Gets or sets the content on the "browse" button. - - - - - Gets or sets the content on the "explore" button. - - - - - Gets or sets the content on the "open" button. - - - - - Gets or sets the ToolTip on the "browse" button. - - - - - Gets or sets the ToolTip on the "explore" button. - - - - - Gets or sets the ToolTip on the "open" button. - - - - - Gets the selected file paths. - - - A sequence of file paths. - - - - - Ensures synchronization between and properties when is enabled - - The . - The instance containing the event data. - - - - Shows the open or save file dialog. - - - - - Starts Windows Explorer with the current file. - - - - - Opens the current file. - - - - - Determines whether the file can be opened. - - - true if the file exists; otherwise, false. - - - - - Determines whether the file can be explored. - - - true if the file exists; otherwise, false. - - - - - Gets the absolute path. - - The file path. - - The get absolute path. - - - - - Gets the absolute paths. - - The file paths. - - The get absolute paths. - - - - - Gets the relative path. - - The file path. - - The get relative path. - - - - - Gets the relative paths. - - The file paths. - - The get relative paths. - - - - - The file dialog interface. - - - - - Shows the open file dialog. - - The filename. - The filter. - The default extension. - - True if the user pressed ok. - - - - - Shows the open files dialog. - - The filenames. - The filter. - The default extension. - - True if the user pressed ok. - - - - - Shows the save file dialog. - - The filename. - The filter. - The default extension. - - True if the user pressed ok. - - - - - The browser dialog interface. - - - - - Shows the folder browser dialog. - - The directory. - show the new folder button if set to true . - The description. - Use description for title if set to true . - - True if the user pressed ok. - - - - - Represents a TextBox with a bindable StringFormat property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - The user is changing. - - - - - Initializes static members of the class. - - - - - Gets or sets the format provider. - - The format provider. - - - - Gets or sets the string format. - - The string format. - - - - Gets or sets the value. - - The value. - - - - The string format changed. - - The d. - The e. - - - - The text changed callback. - - The d. - The e. - - - - The value changed callback. - - The d. - The e. - - - - Unformats the text. - - The s. - - The un format. - - - - - Updates the text. - - - - - Updates the value. - - - - - Represents a slider with header and value entry. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Initializes static members of the class. - - - - - Gets or sets the header. - - The header. - - - - Gets or sets the string format for the entry control. - - The header. - - - - Gets or sets the content alignment for the entry control. - - The alignment. - - - - Gets or sets the large change. - - The large change. - - - - Gets or sets the maximum. - - The maximum. - - - - Gets or sets the minimum. - - The minimum. - - - - Gets or sets the SmallChange. - - The SmallChange. - - - - Gets or sets the width of the header part. - - The width. - - - - Gets or sets the width of the entry control. - - The width. - - - - Gets or sets the value. - - The value. - - - - Provides a lightweight control for displaying hyperlinks. - - - - - Identifies the dependency property. - - - - - Initializes static members of the class. - - - - - Gets or sets the navigation URI. - - The navigate URI. - - - - Invoked when an unhandled �attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. - - The that contains the event data. This event data reports details about the mouse button that was pressed and the handled state. - - - - Represents a popup control that provides a data template for the popup. - - - - - Identifies the dependency property. - - - - - Initializes static members of the class. - - - - - Gets or sets the popup template. - - The popup template. - - - - Represents a control that shows a list of radio buttons. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - The part panel. - - - - - The panel. - - - - - Initializes static members of the class. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the description converter. - - The description converter. - - - - Gets or sets the type of the enumeration. - - The type of the enumeration. - - - - Gets or sets the item margin. - - The item margin. - - - - Gets or sets the item padding. - - The item padding. - - - - Gets or sets the orientation. - - The orientation. - - - - Gets or sets the value. - - The value. - - - - When overridden in a derived class, is invoked whenever application code or internal processes call . - - - - - Called when the has changed or the has changed. - - The sender. - The event args. - - - - Handles data context changes. - - The sender. - The event args. - - - - Updates the content. - - - - - Represents a slider that calls IEditableObject.BeginEdit/EndEdit when thumb dragging. - - - - - The on thumb drag completed. - - The e. - - - - The on thumb drag started. - - The e. - - - - Represents a spinner control. - - - - - The part down. - - - - - The part up. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - The down button. - - - - - The up button. - - - - - Initializes static members of the class. - - - - - Gets or sets the culture used when parsing the LargeChange/SmallChange properties. - - The culture. - - - - Gets or sets down button geometry. - - Down button geometry. - - - - Gets or sets the large change. - - The large change. - - - - Gets or sets the maximum. - - The maximum. - - - - Gets or sets the minimum. - - The minimum. - - - - Gets or sets the repeat SmallChange (milliseconds). - - The repeat SmallChange. - - - - Gets or sets the SmallChange. - - The SmallChange. - - - - Gets or sets the width of the spin buttons. - - The width of the spin button. - - - - Gets or sets up button geometry. - - Up button geometry. - - - - Gets or sets the value. - - The value. - - - - When overridden in a derived class, is invoked whenever application code or internal processes call . - - - - - Invoked when an unhandled  attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. - - The that contains the event data. - - - - Invoked when an unhandled  attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. - - The that contains the event data. - - - - Coerces the spinner value. - - The d. - The basevalue. - - The coerce spinner value. - - - - - The spinner value changed. - - The d. - The e. - - - - Changes the value. - - The sign of the change. - The is Large Change. - - - - Coerces the spinner value. - - The basevalue. - - The coerced value. - - - - - Handles down button clicks. - - The sender. - The instance containing the event data. - - - - Check if an object is of a numeric type. - - The value. - - True if the value is of a numeric type. - - - - - Handles up button clicks. - - The sender. - The instance containing the event data. - - - - Represents a stack panel that counts the number of visible children. - - - - - Identifies the dependency property. - - - - - Gets the number of visible children. - - The visible children count. - - - - Arranges the content of a element. - - The that this element should use to arrange its child elements. - - The that represents the arranged size of this element and its child elements. - - - - - Represents a TextBlock than can be disabled. - - - - - Initializes static members of the class. - - - - - Represents a TextBox that can update the binding on enter. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether to select all on focus. - - - true if all should be selected; otherwise, false. - - - - - Gets or sets a value indicating whether to scroll to home on focus. - - - true if scroll is enabled; otherwise, false. - - - - - Gets or sets a value indicating whether MoveFocusOnEnter. - - - - - Gets or sets a value indicating whether UpdateBindingOnEnter. - - - - - The on preview key down. - - The e. - - - - Invoked when an unhandled  routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. - - The that contains the event data. The event data reports that the left mouse button was pressed. - - - - Handles the got keyboard focus event. - - The sender. - The instance containing the event data. - - - - Converts an array of instances to a instance by checking if all items equal the parameter. - - - - - Converts source values to a value for the binding target. The data binding engine calls this method when it propagates the values from source bindings to the binding target. - - The array of values that the source bindings in the produces. The value indicates that the source binding has no value to provide for conversion. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value.If the method returns null, the valid null value is used.A return value of . indicates that the converter did not produce a value, and that the binding will use the if it is available, or else will use the default value.A return value of . indicates that the binding does not transfer the value or use the or the default value. - - - - - Converts a binding target value to the source binding values. - - The value that the binding target produces. - The array of types to convert to. The array length indicates the number and types of values that are suggested for the method to return. - The converter parameter to use. - The culture to use in the converter. - - An array of values that have been converted from the target value back to the source values. - - - - - - Converts instances to instances. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether to invert visibility. - - - - - Gets or sets the not visible value. - - The not visible value. - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts instances to instances. - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts instances to instances. - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts instances to hex instances. - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts instances to hex instances. - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts instances to instances.. - - - - - The string to color map. - - - - - Gets the string to color map. - - The color map. - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Gets the error message for the bound data. - - Note that the instance and column(property) name must be provided in the constructor. There is probably a better way to do this.... - - - - The instance - - - - - The column name - - - - - Initializes a new instance of the class. - - The instance. - Name of the column. - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts instances to instances. - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts instances to instances. - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts instances to description instances. - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Enum to Boolean converter - Usage 'Converter={StaticResource EnumToBooleanConverter}, ConverterParameter={x:Static value...}' - - - - - Gets or sets the type of the enum. - - The type of the enum. - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts an Enum to a list of the enum type values - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts instances to instances. - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - The grid length list converter. - - - - - The splitter chars. - - - - - Returns whether this converter can convert an object of the given type to the type of this converter, using the specified context. - - An that provides a format context. - A that represents the type you want to convert from. - - true if this converter can perform the conversion; otherwise, false. - - - - - Converts the given object to the type of this converter, using the specified context and culture information. - - An that provides a format context. - The to use as the current culture. - The to convert. - - An that represents the converted value. - - The conversion cannot be performed. - - - - Converts a hue values to instances. - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Gets the error message for the bound data. - - Note that the instance and column(property) name must be provided in the constructor. There is probably a better way to do this.... - - - - The instance - - - - - The column name - - - - - Initializes a new instance of the class. - - The instance. - Name of the column. - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Null to bool value converter - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether the source value is null. - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts instances to instances. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the not null visibility. - - The not null visibility. - - - - Gets or sets the null visibility. - - The null visibility. - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts instances to instances. - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - The self provider. - - - - - The provide value. - - The service provider. - - The provide value. - - - - - Converts instances to instances.. - - The format string can be specified as the converter parameter. - - - - The formatter. - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts lists to instances. - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts instances to instances. - - - - - Initializes a new instance of the class. - - The value returned when the specified value equals the parameter. - - - - Gets a value indicating whether the value returned when the specified value equals the parameter. - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts instances to instances. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the visibility to return when the value to convert equals the converter parameter. - - The equals visibility. - - - - Gets or sets the visibility to return when the value to convert does not equal the converter parameter. - - The not equals visibility. - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts instances to instances. - - - - - Initializes a new instance of the class. - Initializes a new instance of the class. - - - - - Gets or sets the not null visibility. - - The not null visibility. - - - - Gets or sets the null visibility. - - The null visibility. - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Defines the content of a cell. - - - - - Gets or sets the horizontal alignment. - - - The horizontal alignment. - - - - - Gets or sets the binding path. - - - The binding path. - - - - - Gets or sets the binding source. - - - The binding source. - - This is used for the DataContext of the cell. - - - - Gets or sets a value indicating whether the binding mode should be one-way. - - - true if the binding mode should be one-way; otherwise, false. - - - - - Gets or sets the format string. - - - The format string. - - - - - Gets or sets the converter. - - - The converter. - - - - - Gets or sets the converter parameter. - - - The converter parameter. - - - - - Gets or sets the converter culture. - - - The converter culture. - - - - - Gets or sets the source for the IsEnabled binding. - - - - - Gets or sets the IsEnabled binding path. - - - The binding path. - - - - - Gets or sets the IsEnabled converter parameter. - - - The converter parameter. - - - - - Gets or sets the background source. - - - The binding source. - - - - - Gets or sets the background binding path. - - - The binding path. - - - - - Implements the default cell definition factory. - - - - - Registers the value converter for the specified type. - - The type of instances the converter is applied to. - The converter. - - - - Creates the cell definition for the specified cell. - - The d. - - The cell definition - - - - - Creates the cell definition object. - - The cell descriptor. - - A cell definition. - - - - - Applies the properties to the specified cell definition. - - The cell definition. - The cell descriptor. - - - - Contains all the data that can be used to create a in a . - - - - - Gets or sets the property definition. - - - The property definition. - - - - - Gets or sets the property descriptor. - - - The descriptor. - - - - - Gets or sets the type of the property. - - - The type of the property. - - - - - Gets or sets the item. - - - The item. - - - - - Gets or sets the binding path. - - - The binding path. - - - - - Gets or sets the binding source. - - - The binding source. - - - - - Gets the attributes. - - - The attributes. - - - - - Defines a cell that contains a boolean property. - - - - - - Defines a cell that contains a color property. - - - - - Defines a cell that contains a selectable property. - - - - - - Gets or sets a value indicating whether this instance is editable. - - - true if this instance is editable; otherwise, false. - - - - - Gets or sets the items source. - - - The items source. - - - - - Gets or sets the items source property. - - - The items source property. - - - - - Gets or sets the selected value path. - - - The selected value path. - - - - - Gets or sets the display member path. - - - The display member path. - - - - - Defines a cell that displays the content with data templates. - - - - - - Gets or sets the display template. - - - The data template. - - - - - Gets or sets the edit template. - - - The data template. - - - - - Defines a cell that contains a string property. - - - - - - Gets or sets the maximum length. - - - The maximum length. - - - - - Represents a range of cells. - - - - - Initializes a new instance of the class. - - The cell1. - The cell2. - - - - Gets the top left cell. - - - The top left cell reference. - - - - - Gets the bottom right cell. - - - The bottom right cell reference. - - - - - Gets the index of the top row. - - - The zero-based index. - - - - - Gets the index of the bottom row. - - - The zero-based index. - - - - - Gets the index of the left column. - - - The zero-based index. - - - - - Gets the index of the right column. - - - The zero-based index. - - - - - Gets the number of rows. - - - The number of rows. - - - - - Gets the number of columns. - - - The number of columns. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Represents a cell reference. - - - - - The column. - - - - - The row. - - - - - Initializes a new instance of the struct. - - The row. - The column. - - - - Gets the column. - - - - - Gets the row. - - - - - Converts a column number to a column name. - - The column. - - The to column name. - - - - - Converts a row number to a row name. - - The row. - - The to row name. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Determines whether the specified is equal to this instance. - - Another object to compare to. - true if the specified is equal to this instance; otherwise, false. - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - The cell ref converter. - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Creates display and edit controls for the DataGrid. - - - - - Creates the display control with data binding. - - The cell definition. - - The control. - - - - - Creates the edit control with data binding. - - The cell definition. - - The control. - - - - - Creates the display control. - - The cell definition. - The display control. - - - - Creates the edit control. - - The cell definition. - - The control. - - - - - Creates a container with background binding. - - The cell definition. - The control to add to the container. - The container element. - - - - Creates a binding. - - The cd. - - A binding. - - - - - Creates the one way binding. - - The cell definition. - - A binding. - - - - - Creates a check box control with data binding. - - The cell definition. - - A CheckBox. - - - - - Creates a color picker control with data binding. - - The cell definition. - - A color picker. - - - - - Creates a color preview control with data binding. - - The cell definition. - - A preview control. - - - - - Creates a combo box with data binding. - - The cell definition. - - A ComboBox. - - - - - Creates a text block control with data binding. - - The cell definition. - - A TextBlock. - - - - - Creates a text block control for a selector cell. - - The cell definition. - - A TextBlock. - - - - - Creates a text box with data binding. - - The cell definition. - - A TextBox. - - - - - Creates the template control. - - The definition. - The data template. - A content control. - - - - Sets the IsEnabled binding. - - The cell definition. - The element. - - - - Sets the background binding. - - The cell definition. - The control. - - - - Sets the background binding. - - The cell definition. - The container. - - - - Focuses on the parent data grid. - - The . - - - - Displays enumerable data in a customizable grid. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - The auto fill box. - - - - - The auto fill selection. - - - - - The column grid. - - - - - The column scroll viewer. - - - - - The column selection background. - - - - - The current background. - - - - - The grid. - - - - - The row grid. - - - - - The row scroll viewer. - - - - - The row selection background. - - - - - The selection. - - - - - The selection background. - - - - - The sheet grid. - - - - - The sheet scroll viewer. - - - - - The top left cell. - - - - - The horizontal scroll bar visibility to height converter - - - - - The vertical scroll bar visibility to height converter - - - - - The cell map. - - - - - The column header map. - - - - - The row header map. - - - - - The sort descriptors - - - - - The sort description markers - - - - - The auto fill box. - - - - - The auto fill cell. - - - - - The auto fill selection. - - - - - The auto fill tool tip. - - - - - The auto filler. - - - - - The index in the sheet grid where new cells can be inserted. - - The selection and auto fill controls should always be at the end of the sheetGrid children collection. - - - - The column grid control. - - - - - The row grid control. - - - - - The column scroll view control. - - - - - The column selection background control. - - - - - The current background control. - - - - - The current editor. - - - - - The editing cells. - - - - - The end pressed. - - - - - The sheet grid control. - - - - - The row scroll viewer control. - - - - - The row selection background control. - - - - - The selection control. - - - - - The selection background control. - - - - - The sheet scroll viewer control. - - - - - Reference to the collection that has subscribed to the INotifyCollectionChanged event. - - - - - The top/left control. - - - - - Flag used for collection changed notification suspension. - - - - - The synchronized collection - - - - - Initializes static members of the class. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the header used for the add item row/column. Default is "*". - - The add item header. - - - - Gets or sets the alternating rows background brush. - - The alternating rows background. - - - - Gets or sets the auto fill cell. - - The auto fill cell. - - - - Gets or sets a value indicating whether to auto generate columns. - - - - - Gets or sets a value indicating whether to allow automatic insert mode. - - - - - Gets or sets a value indicating whether this grid can clear cells. - - true if this instance can clear; otherwise, false . - - - - Gets or sets a value indicating whether this instance can delete. - - true if this instance can delete; otherwise, false . - - - - Gets or sets a value indicating whether this instance can insert. - - true if this instance can insert; otherwise, false . - - - - Gets or sets a value indicating whether this instance can resize columns. - - true if this instance can resize columns; otherwise, false . - - - - Gets or sets a value indicating whether this instance can resize rows. - - true if this instance can resize rows; otherwise, false . - - - - Gets or sets a value indicating whether only cells in the changed column should be changed when changing value for a selection. - - true if only cells in the current column should be changed; otherwise, false . - - - - Gets the column definitions. - - The column definitions. - - - - Gets or sets the height of the column headers. - - The height of the column header. - - - - Gets or sets the columns context menu. - - The columns context menu. - - - - Gets or sets the columns context menu. - - The columns context menu. - - - - Gets or sets the control factory. - - - - - Gets or sets the cell definition factory. - - - - - Gets or sets the create item function. - - The create item. - - - - Gets or sets the custom sort comparer. - - The custom sort comparer. - - - - Gets or sets the create column header function. - - The create column header. - - - - Gets or sets the current cell. - - - - - Gets or sets the default column width. - - The default width of the column. - - - - Gets or sets the default horizontal alignment. - - The default horizontal alignment. - - - - Gets or sets the default height of the row. - - The default height of the row. - - - - Gets or sets a value indicating whether easy insert by keyboard (press enter/down/right to add new rows/columns) is enabled. - - true if easy insert is enabled; otherwise, false. - - - - Gets or sets a value indicating whether easy insert by mouse (mouse down outside existing rows/columns) is enabled. - - true if easy insert is enabled; otherwise, false. - - - - Gets or sets the grid line brush. - - The grid line brush. - - - - Gets or sets the header border brush. - - The header border brush. - - - - Gets or sets the input direction (the moving direction of the current cell when Enter is pressed). - - The input direction. - - - - Gets or sets a value indicating whether the auto fill is enabled or not. - - If auto fill is enabled, true; otherwise false. - - - - Gets or sets a value indicating whether the current cell will change after the user has pressed Enter. - - If the feature is enabled, true; otherwise false. - - - - Gets or sets the binding path to the item headers (row or column headers, depending on the property. - - - - - Gets or sets the items source. - - The items source. - - - - Gets or sets the row headers source. - - The row headers source. - - - - Gets or sets the column headers source. - - The column headers source. - - - - Gets or sets the row headers format string. - - The row headers format string. - - - - Gets or sets the column headers format string. - - The column headers format string. - - - - Gets the row definitions. - - The row definitions. - - - - Gets or sets the width of the row headers. - - The width of the row header. - - - - Gets or sets the rows context menu. - - The rows context menu. - - - - Gets the selected cells. - - The selected cells. - - - - Gets or sets the selected items. - - The selected items. - - - - Gets or sets the cell defining the selection area. The selection area is defined by the CurrentCell and SelectionCell. - - - - - Gets or sets a value indicating whether to wrap items in the defined columns. - - true if items should be wrapped; otherwise, false . - - - - Gets the collection view. - - - The collection view. - - - - - Gets a value indicating whether to use rows for the items. - - true if the items are in rows; otherwise, false . - - - - Gets the number of columns. - - The number of columns. - - - - Gets the number of rows. - The number of rows. - - - - Gets a value indicating whether to use columns for the items. - - - - - Gets the operator. - - - - - Gets the row/column definitions. - - The row/column definitions. - - - - Gets a value indicating whether this instance can delete columns. - - true if this instance can delete columns; otherwise, false . - - - - Gets a value indicating whether this instance can delete rows. - - true if this instance can delete rows; otherwise, false . - - - - Gets a value indicating whether this instance can insert columns. - - true if this instance can insert columns; otherwise, false . - - - - Gets a value indicating whether this instance can insert rows. - - true if this instance can insert rows; otherwise, false . - - - - When overridden in a derived class, is invoked whenever application code or internal processes call . - - - - - Receives events from the centralized event manager. - - The type of the calling this method. - Object that originated the event. - Event data. - - true if the listener handled the event. It is considered an error by the handling in WPF to register a listener for an event that the listener does not handle. Regardless, the method should return false if it receives an event that it does not recognize or handle. - - - - - Pastes the content from the clipboard to the selected cells. - - - - - Gets the column/row definition for the specified cell. - - The cell reference. - - The column/row definition. - - - - - Implements the paste operation. - - - - - Sets the values in the specified range. - - The values. - The range. - The range that was actually set. - - - - Gets the clipboard data. - - A two-dimensional array of values. - - - - Scroll the specified cell into view. - - The cell reference. - - - - Implements the copy operation. - - - - - Implements the cut operation. - - - - - Gets the selection cell range. - - The cell range. - - - - Copies the selected cells to the clipboard. - - The separator. - - - - Gets the formatted string value for the specified cell. - - The cell. - The value. - - The cell string. - - - - - Exports the grid to comma separated values. - - The range. - The separator. - Include a header if set to true. - - The comma separated values string. - - - - - Invoked when an unhandled  attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. - - The that contains the event data. - - - - Handles mouse left button down events. - - The event arguments. - - - - Handles mouse left button up events. - - The event arguments. - - - - Handles mouse move events. - - The event arguments. - - - - Handles mouse wheel preview events. - - The event arguments. - - - - Handles text input events. - - The event arguments. - - - - Handles KeyDown events on the grid. - - The event arguments. - - - - Creates the operator for the current items source. - - The operator. - - - - Splits a string separated by \n and \t into an array. - - The text. - - An 2-dimensional array of strings. - - - - - Implements the clear operation. - - - - - Gets the default value for the specified cell. - - The cell. - The default value. - - - - Gets the cell values of the specified cell range. - - The range. - - An array of cell values. - - - - - Gets the string values of the specified cell range. - - The range. - The values (optional). - - An array of cell strings. - - - - - Tries to set the value in the specified cell. - - The cell. - The value. - - True if the value was set. - - - - - Determines whether all elements in the specified array are serializable. - - The array. - - true if all elements of the array are serializable, false otherwise. - - - - - Clamps a value between a minimum and maximum limit. - - The value. - The minimum. - The maximum. - - The clamped value. - - - - - Encodes the specified string for use in a comma separated value file. - - The input string. - - The encoded string. - - - - - Formats the specified value with the specified format string. - - The value. - The format string. - - The format value. - - - - - The set element position. - - The element. - The cell. - - - - Coerces the current cell. - - The . - The base value. - - The coerced current cell. - - - - - Coerces the selection cell. - - The sender. - The base value. - - The coerced selection cell. - - - - - Gets the cell reference for the specified position. - - The position. - if set to true [is in auto fill mode]. - The relative to. - - The cell reference. - - - - - Gets the element at the specified cell. - - The cell reference. - - The element, or null if the cell was not found. - - - - - Gets the cell value from the Content property for the specified cell. - - The cell reference. - - The cell value. - - - - - Gets the position of the specified cell. - - The cell reference. - - The upper-left position of the cell. - - - - - Removes the current editor control. - - - - - Inserts an item. - - The index. - Determines whether the grid should be updated. - - The actual index of the inserted item, -1 if no item was inserted. - - - - - Changes the current cell with the specified delta. - - The change in rows. - The change in columns. - - - - Shows the text box editor. - - - true if the text editor was shown, false otherwise. - - - - - Opens the combo box control. - - - true if the combo box was shown, false otherwise. - - - - - Creates the display control for the specified cell. - - The cell. - - The display control. - - - - - Creates the edit control for the specified cell. - - The cell. - - The edit control. - - - - - Shows the edit control for the current cell. - - - - - Updates the content of the specified cell. - - The cell reference. - - - - Handles changes in the current cell. - - The cell that was changed. - - - - Inserts the display control for the specified cell. - - The cell reference. - - - - Handles mouse left button down events on the add item cell. - - The sender. - The event arguments. - - - - Handles mouse down events on the auto fill box. - - The sender. - The event arguments. - - - - Handles mouse down events on the column grid. - - The sender. - The event arguments. - - - - Handles mouse up events on the column grid. - - The sender. - The event arguments. - - - - Handles mouse move events on the column grid. - - The sender. - The event arguments. - - - - Handles changes in the column scroll viewer. - - The sender. - The event arguments. - - - - Handles the column splitter change completed event. - - The sender. - The drag completed event args. - - - - Handles the column splitter change delta event. - - The sender. - The event arguments. - - - - The column splitter change started. - - The sender. - The drag started event args. - - - - The column splitter double click. - - The sender. - The event arguments. - - - - Clears the content in the selected cells. - - - - - Deletes the selected columns. - - - - - Deletes the selected rows. - - - - - Clears the sort descriptions. - - - - - Sorts the selected columns/rows in the specified direction. - - The sort direction. - Append the sort description if set to true. - - - - Updates the sort descriptions of the collection view and the visual markers. - - - - - Determines whether the current column/row can be sorted. - - - true if this instance can sort; otherwise, false. - - - - - Toggles the sort direction for the current column/row. - - Append the sort description if set to true. - - - - Enumerate the items in the specified cell range. This is used to update the SelectedItems property. - - The range. - - The items enumeration. - - - - - Finds the next column that contains an empty cell. - - The row. - The column. - The delta column. - - The new column. - - - - - Finds the next row that contains an empty cell. - - The row. - The column. - The delta row. - - The new row. - - - - - Gets the column element for the specified column. - - The column. - - The column element. - - - - - Gets the row element for the specified row. - - The row. - - The row element. - - - - - Gets the column header for the specified column. - - The column. - - The column header. - - - - - Gets the column width for the specified column. - - The column index. - - The column width. - - - - - Gets the format string for the specified cell. - - The cell reference. - - The format string. - - - - - Gets the row header. - - The j. - - The get row header. - - - - - Gets the row height for the specified row. - - The row index. - - The row height. - - - - - Inserts columns at the selected column. - - - - - Inserts rows at the selection. - - - - - Refreshes the collection view and updates the grid content, if the ItemsSource is not implementing INotifyCollectionChanged. - - - - - Handles changes to the items collection. - - The event arguments. - - - - Handles mouse down events on the row grid. - - The sender. - The event arguments. - - - - Handles mouse up events on the row grid. - - The sender. - The event arguments. - - - - Handles mouse move events on the row grid. - - The sender. - The event arguments. - - - - Handles changes in the row scroll viewer. - - The sender. - The event arguments. - - - - Handles the row splitter change completed event. - - The sender. - The drag completed event args. - - - - Handles the row splitter change delta event. - - The sender. - The event arguments. - - - - The row splitter change started. - - The sender. - The drag started event args. - - - - The row splitter double click. - - The sender. - The event arguments. - - - - Handles scroll changes in the scroll viewers (both horizontal and vertical). - - The sender. - The event arguments. - - - - Selects all cells. - - - - - Sets the boolean value in the selected cells. - - The value. - - True if cells were modified. - - - - - Handles mouse down events on the grid sheet. - - The sender. - The event arguments. - - - - Handles key down events in the TextBox editor. - - The sender. - The event arguments. - - - - Converts the specified array to a csv string. - - The input. - The separator. - Determines whether to encode the elements. - - The to string. - - - - - Toggles the check in the current cell. - - - True if the cell was modified. - - - - - Handles mouse down events on the top/left selection control. - - The sender. - The event arguments. - - - - Sets the width of the specified column. - - The column to change. - The new width. - - - - Handles automatic insert of items. - - The cell. - true if an item was inserted; otherwise false. - - - - Handles change in current cell. - - - - - Handles change in selected cells. - - - - - Updates the selection visibility. - - - - - Handles changes in the property. - - - - - Clears the content of the control. - - - - - Updates the cells of the grid. - - The number of rows. - The number of columns. - - - - Updates the column widths and row heights. - - - - - Updates the sort description markers. - - - - - Updates the specified columns. - - The column index. - - - - Handles changes in the property. - - - - - Updates all the UIElements of the grid (both cells, headers, row and column lines). - - - - - Updates the rows. - - The number rows. - - - - Get a height for InserterRow - - - - - Adds an "insert" row. - - The number of rows. - This row is below/to the right of the data rows/columns. - - - - Handles changes to the property. - - The instance containing the event data. - - - - Resizes all columns automatically. - - - - - Resizes all rows automatically. - - - - - Auto-sizes the specified column. - - The column. - The calculated width of the column. - - - - Auto-sizes the specified row. - - The row. - - - - Copies the selected cells to the clipboard, tab-separated. - - - - - Cuts the selected items. - - - - - Provides a standard set of related commands. - - - - - Initializes static members of the class. - - - - - Gets the delete columns command. - - The delete columns command. - - - - Gets the delete rows command. - - The delete rows command. - - - - Gets the insert columns command. - - The insert columns command. - - - - Gets the insert rows command. - - The insert rows command. - - - - Gets the sort ascending command. - - The sort ascending command. - - - - Gets the sort descending command. - - The sort descending command. - - - - Gets the clear sort command. - - The clear sort command. - - - - Defines a column in a . - - - - - Initializes a new instance of the class. - - - - - Gets or sets the column width. - - The width. - - - - Provides a base class for column and row definitions in a . - - - - - Initializes a new instance of the class. - - - - - Gets or sets the converter. - - The converter. - - - - Gets or sets the converter culture. - - The converter culture. - - - - Gets or sets the converter parameter. - - The converter parameter. - - - - Gets or sets the format string. - - The format string. - - - - Gets or sets the header. - - The header. - - - - Gets or sets the tooltip. - - The tooltip. - - - - Gets or sets the horizontal alignment. - - The horizontal alignment. - - - - Gets or sets a value indicating whether this instance is editable (for ComboBox). - - - - - Gets or sets a value indicating whether this instance is read only. - - - - - Gets or sets the items source (for ComboBox). - - The items source. - - - - Gets or sets the property name of an items source (for ComboBox). - - The items source property. - - - - Gets or sets the selected value path (for ComboBox). - - - The selected value path. - - - - - Gets or sets the display member path. - - - The display member path. - - - - - Gets or sets the max length (for TextBox). - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the name of a property that determines the state of the cell. - - - The name of the related property. - - - - - Gets or sets the value that enables the cell. - - This property is used if the property is set. - - - - Gets or sets the background brush. - - - The background. - - If set, this overrides . - - - - Gets or sets the background property. - - - The background property. - - - - - Gets or sets a value indicating whether the items can be sorted by this column/row. - - - true if items can be sorted; otherwise, false. - - - - - Defines a row in a . - - - - - Initializes a new instance of the class. - - - - - Gets or sets the row height. - - The height. - - - - Defines a template column in a . - - - - - Gets or sets the cell template. - - A data template that contains display controls. - - - - Gets or sets the cell template used when editing the cell. - - A data template that contains edit controls. - - - - Specifies a factory for the . - - - - - Creates the cell definition for the specified cell. - - The cell descriptor. - - The cell definition - - - - - Specifies a control factory for the . - - - - - Creates the display control with data binding. - - The cell definition. - - The control. - - - - - Creates the edit control with data binding. - - The cell definition. - - The control. - - - - - Specifies DataGrid functionality that depends on the type of items source. - - - - - Auto-generates the columns. - - - - - Updates the property definitions. - - - - - Gets the type of the property in the specified cell. - - The cell. - - The type of the property. - - - - - Creates the cell descriptor for the specified cell. - - The cell. - A cell descriptor. - - - - Gets the binding path for the specified cell. - - The cell. - - The binding path - - - - - Gets the value in the specified cell. - - The cell. - The value - - - - Converts the items source index to a collection view index. - - The index in the items source. - The index in the collection view - - - - Inserts an item at the specified index. - - The index. - - The index of the inserted item if insertion is successful, -1 otherwise. - - - - - Gets the item in the specified cell. - - The cell reference. - - The . - - - - - Tries to set cell value in the specified cell. - - The cell. - The value. - true if the cell value was set. - - - - Gets the data context for the specified cell. - - The cell. - The context object. - - - - Determines whether columns can be deleted. - - true if columns can be deleted; otherwise false. - - - - Determines whether rows can be deleted. - - true if rows can be deleted; otherwise false. - - - - Determines whether columns can be inserted. - - true if columns can be inserted; otherwise false. - - - - Determines whether rows can be inserted. - - true if rows can be inserted; otherwise false. - - - - Deletes columns at the specified index. - - The index. - The number of columns to delete. - - - - Deletes rows at the specified index. - - The index. - The number of rows to delete. - - - - Inserts columns at the specified index. - - The index. - The number of columns to insert. - - - - Inserts rows at the specified index. - - The index. - The number of rows to insert. - - - - Gets the number of rows. - - The number. - - - - Gets the number of columns. - - The number. - - - - Determines whether items can be sorted by the specified column/row index. - - The column index if items are in rows, otherwise the row index. - - true if the items can be sorted; false otherwise. - - - - - Represents an abstract base class for operators. - - An operator implements operations for a based on the different data its - binds to. - - - - The property descriptors. - - - - - Initializes a new instance of the class. - - The owner. - - - - Gets or sets the default horizontal alignment. - - - The default horizontal alignment. - - - - - Gets or sets the default column width. - - - The default width of the columns. - - - - - Gets the this.owner datagrid. - - - - - Determines whether columns can be deleted. - - - true if columns can be deleted; otherwise false. - - - - - Determines whether rows can be deleted. - - - true if rows can be deleted; otherwise false. - - - - - Determines whether columns can be inserted. - - - true if columns can be inserted; otherwise false. - - - - - Determines whether rows can be inserted. - - - true if rows can be inserted; otherwise false. - - - - - Deletes the columns. - - The index. - The number of columns to delete. - - - - Deletes the rows. - - The index. - The number of rows to delete. - - - - Inserts columns at the specified index. - - The index. - The number of columns to insert. - - - - Inserts rows at the specified index. - - The index. - The number of rows to insert. - - - - Gets the number of items. - - The number. - - - - Gets the number of rows. - - - The number. - - - - - Gets the number of columns. - - - The number. - - - - - Determines whether items can be sorted by the specified column/row index. - - The column index if items are in rows, otherwise the row index. - - true if the items can be sorted; false otherwise. - - - - - Gets the value in the specified cell. - - The cell. - The value - - - - Gets the type of the property in the specified cell. - - The cell. - The type of the property. - - - - Gets the type of the property in the specified cell. - - The definition. - The cell. - The current value. - - The type of the property. - - - - - Converts the collection view index to an items source index. - - The index in the collection view. - The index in the items source - - - - Converts the items source index to a collection view index. - - The index in the items source. - The index in the collection view - - - - Auto-generates the columns. - - - - - Updates the property definitions. - - - - - Creates the cell descriptor for the specified cell. - - The cell. - A cell descriptor. - - - - Gets the property descriptor. - - The property definition. - The item. - The cell. - - The property descriptor. - - - - - Gets the property definition for the specified cell. - - The cell. - The property definition. - - - - Tries to set cell value in the specified cell. - - The cell. - The value. - true if the cell value was set. - - - - Gets the data context for the specified cell. - - The cell. - The context object. - - - - Gets the item in the specified cell. - - The cell reference. - - The . - au - - - - Inserts an item to at the specified index. - - The index. - - The index of the inserted item if insertion is successful, -1 otherwise. - - - - - Gets the binding path for the specified cell. - - The cell. - - The binding path - - - - - Sets value of the specified cell to the specified value. - - The cell to change. - The value. - - - - Deletes the item at the specified index. - - The index. - - true if rows can be inserted; otherwise false. - - - - - Gets the type of the items in the items source. - - The items source. - The type. - - - - Creates a new instance of the specified type. - - The type. - - The new instance. - - - - - Sets the properties from descriptor. - - The property definition. - The descriptor. - - - - Generates column definitions based on a list of items. - - The list. - A sequence of column definitions. - - - - Tries to convert an object to the specified type. - - The value. - The target type. - The converted value. - - True if conversion was successful. - - - - - Tries to get the item of the specified index. - - The sequence. - The index. - The item. - - false if the index was not found in the sequence; otherwise true. - - - - - Tries to get the index of the specified item. - - The sequence. - The item. - The index. - false if the item was not found in the sequence; otherwise true. - - - - Represents an operator for when its ItemsSource is of type ><. - - - - - Initializes a new instance of the class. - - The owner. - - - - Determines whether columns can be deleted. - - - true if columns can be deleted; otherwise false. - - - - - Determines whether columns can be inserted. - - - true if columns can be inserted; otherwise false. - - - - - Deletes the item at the specified index. - - The index. - - true if rows can be inserted; otherwise false. - - - - - Deletes the columns. - - The index. - The number of columns to delete. - - - - Inserts the columns. - - The index. - The number of columns to insert. - - - - Insert column header to ColumnHeadersSource. - - The position. - - - - Generate column definitions based on a list of items. - - The list of items. - A sequence of column definitions. - - - - Gets the item in cell. - - The cell reference. - - The . - - - - - Inserts item to . - - The index. - - The index of the inserted item if insertion is successful, -1 otherwise. - - - - - Sets value to item in cell. - - The cell reference. - The value. - - - - Gets the binding path for the specified cell. - - The cell. - - The binding path - - - - - Determines whether items can be sorted by the specified column/row index. - - The column index if items are in rows, otherwise the row index. - - true if the items can be sorted; false otherwise. - - - - - Represents an operator for when its ItemsSource is of type . - - - - - Initializes a new instance of the class. - - The owner. - - - - Generate column definitions based on a list of items. - - The list of items. - A sequence of column definitions. - The constraint is that all the items in the ItemsSource's should be of the same type. - For non built in type, a - public static T Parse(string s, IFormatProvider formatProvider) and - public string ToString(string format, IFormatProvider formatProvider) should be defined. - interface type is not acceptable for no object instance can be created based on it. - - - - Gets the item in cell. - - The cell reference. - - The item . - - - - - Inserts item to . - - The index. - - The index of the inserted item if insertion is successful, -1 otherwise. - - - - - Sets value to item in cell. - - The cell reference. - The value. - - - - Gets the item index for the specified cell. - - The cell. - - The get item index. - - - - - Gets the binding path for the specified cell. - - The cell. - - The binding path - - - - - Gets property descriptors from one instance. - - The items. - The target item type. - - The . - - - - - Represents an operator for when its WrapItems property is true. - - - - - Initializes a new instance of the class. - - The owner. - - - - Gets the number of rows. - - - The number. - - - - - Gets the number of columns. - - - The number. - - - - - Determines whether items can be sorted by the specified column/row index. - - The column index if items are in rows, otherwise the row index. - - true if the items can be sorted; false otherwise. - - - - - Gets the item index for the specified cell. - - The cell. - - The get item index. - - - - - Converts values. - - - - - - Gets or sets the collapsed value. - - - The collapsed value. - - - - - Gets or sets the hidden value. - - - The hidden value. - - - - - Gets or sets the visible value. - - - The visible value. - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Represents an about dialog. - - - AboutDialog - - - - - The vm. - - - - - Initializes a new instance of the class. - - The owner. - - - - Sets the image used in the about dialog. - Example: - d.Image = new BitmapImage(new Uri(@"pack://application:,,,/AssemblyName;component/Images/about.png")); - - The image. - - - - Sets the update status. - - The update status. - - - - The copy click. - - The sender. - The e. - - - - The ok click. - - The sender. - The e. - - - - The system info click. - - The sender. - The e. - - - - InitializeComponent - - - - - Represents a viewmodel for the about dialog. - - - - - Initializes a new instance of the class. - - An assembly. - - - - Gets AssemblyVersion. - - - - - Gets BuildTime. - - - - - Gets CLRversion. - - - - - Gets Comments. - - - - - Gets Company. - - - - - Gets or sets the copy report text. - - The copy report text. - - - - Gets Copyright. - - - - - Gets Domain. - - - - - Gets or sets the file info. - - The file info. - - - - Gets FileName. - - - - - Gets FileVersion. - - - - - Gets or sets the file version info. - - The file version info. - - - - Gets or sets Image. - - - - - Gets MachineName. - - - - - Gets OSVersion. - - - - - Gets Platform. - - - - - Gets Processors. - - - - - Gets ProductName. - - - - - Gets ServicePack. - - - - - Gets or sets the system info text. - - The system info text. - - - - Gets or sets UpdateStatus. - - - - - Gets User. - - - - - Gets Version. - - - - - Gets the report. - - - The get report. - - - - - Represents a property editing dialog. - - - PropertyDialog - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether the apply button is visible. - - true if this instance can apply; otherwise, false . - - - - Gets the property control. - - The property control. - - - - This stores the current "copy" of the object. - If it is non-null, then we are in the middle of an - editable operation. - - The object. - - Clone of current object - - - - - This restores the state of the current object from the passed clone object. - - Object to restore state from - - - - - Clones the object memberwise. - - The SRC. - - The memberwise clone. - - - - - The apply button click. - - The sender. - The e. - - - - Begins the edit. - - - - - The cancel button click. - - The sender. - The e. - - - - Cancels the edit. - - - - - The close button click. - - The sender. - The e. - - - - Commits the changes. - - - - - Ends the edit. - - - - - The help button click. - - The sender. - The e. - - - - The ok button click. - - The sender. - The e. - - - - The property dialog data context changed. - - The sender. - The e. - - - - InitializeComponent - - - - - Represents a common dialog box (Win32::SHBrowseForFolder()) that allows a user to select a folder. - - - - - The browse info. - - - - - Initializes a new instance of the class. - Constructs a BrowseForFolderDialog with default BrowseInfoFlags set to BIF_NEWDIALOGSTYLE. - - - - - The browse callback proc. - - The hwnd. - The u msg. - The l param. - The lp data. - - - - The browse info flags. - - - - - No specified BIF_xxx flags. - - - - - Only return file system directories. If the user selects folders that are not part of the file system, the OK button is grayed. - - - - - Do not include network folders below the domain level in the dialog box's tree view control. - - - - - Include a status area in the dialog box. - - - - - Only return file system ancestors. An ancestor is a subfolder that is beneath the root folder in the namespace hierarchy. - - - - - Include an edit control in the browse dialog box that allows the user to type the name of an item. - - - - - If the user types an invalid name into the edit box, the browse dialog box will call the application's BrowseCallbackProc with the BFFM_VALIDATEFAILED message. - - - - - Use the new user interface. Setting this flag provides the user with a larger dialog box that can be resized. - - - - - Use the new user interface, including an edit box. This flag is equivalent to BIF_EDITBOX | BIF_NEWDIALOGSTYLE. - - - - - The browse dialog box can display URLs. The BIF_USENEWUI and BIF_BROWSEINCLUDEFILES flags must also be set. - - - - - When combined with BIF_NEWDIALOGSTYLE, adds a usage hint to the dialog box in place of the edit box. - - - - - Do not include the New Folder button in the browse dialog box. - - - - - When the selected item is a shortcut, return the PIDL of the shortcut itself rather than its target. - - - - - Only return computers. If the user selects anything other than a computer, the OK button is grayed. - - - - - Only allow the selection of printers. If the user selects anything other than a printer, the OK button is grayed. - - - - - The browse dialog box will display files as well as folders. - - - - - The browse dialog box can display shareable resources on remote systems. - - - - - The message from browser. - - - - - The dialog box has finished initializing. - - - - - The selection has changed in the dialog box. - - - - - (ANSI) The user typed an invalid name into the dialog's edit box. A nonexistent folder is considered an invalid name. - - - - - (Unicode) The user typed an invalid name into the dialog's edit box. A nonexistent folder is considered an invalid name. - - - - - An IUnknown interface is available to the dialog box. - - - - - The message to browser. - - - - - Win32 API macro - start of user defined window message range. - - - - - (ANSI) Sets the status text. Set lpData to point to a null-terminated string with the desired text. - - - - - Enables or disables the dialog box's OK button. lParam - To enable, set to a nonzero value. To disable, set to zero. - - - - - (ANSI) Specifies the path of a folder to select. - - - - - (Unicode) Specifies the path of a folder to select. - - - - - (Unicode) Sets the status text. Set lpData to point to a null-terminated string with the desired text. - - - - - Sets the text that is displayed on the dialog box's OK button. - - - - - Specifies the path of a folder to expand in the Browse dialog box. - - - - - Provides direct access to the Win32::SHBrowseForFolder() BROWSEINFO structure used to create the dialog in ShowDialog(). - - - - - Provides direct access to the ulFlags field of the Win32::SHBrowseForFolder() structure used to create the dialog in ShowDialog(). - - - - - Gets or sets the initially selected and expanded folder path. Overrides SelectedFolder. - - - - - Gets or sets the initially selected folder path. - - - - - Gets or sets the text for the dialog's OK button. - - - - - Gets the current and or final selected folder path. - - - - - Gets or sets the string that is displayed above the tree view control in the dialog box (must set BEFORE calling ShowDialog()). - - - - - The send message w. - - The h wnd. - The msg. - The w param. - The l param. - - The . - - - - - The send message w. - - The h wnd. - The msg. - The w param. - The str. - - The . - - - - - Shows the dialog (Win32::SHBrowseForFolder()). - - - True if OK was pressed. - - - - - Shows the dialog (Win32::SHBrowseForFolder()) with its hwndOwner set to the handle of 'owner'. - - The owner. - - True if OK was pressed. - - - - - The sh browse for folder w. - - The bi. - - The . - - - - - The sh get path from id list. - - The pidl. - The path. - - The sh get path from id list. - - - - - The browse event handler. - - The hwnd. - The u msg. - The l param. - The lp data. - - The browse event handler. - - - - - The p invoke sh browse for folder. - - The owner. - - True if OK was pressed. - - - - - The browseinfow. - - - - - A handle to the owner window for the dialog box. - - - - - A pointer to an item identifier list (PIDL) specifying the location of the root folder from which to start browsing. - - - - - The address of a buffer to receive the display name of the folder selected by the user. The size of this buffer is assumed to be MAX_PATH characters. - - - - - The address of a null-terminated string that is displayed above the tree view control in the dialog box. - - - - - Flags specifying the options for the dialog box. - - - - - A BrowseCallbackProc delegate that the dialog box calls when an event occurs. - - - - - An application-defined value that the dialog box passes to the BrowseCallbackProc delegate, if one is specified. - - - - - A variable to receive the image associated with the selected folder. The image is specified as an index to the system image list. - - - - - Represents a wizard dialog. - - - WizardDialog - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Initializes a new instance of the class. - - - - - Gets or sets CurrentPage. - - - - - Gets or sets Pages. - - - - - The current page_ changed. - - The sender. - The e. - - - - The back button_ click. - - The sender. - The e. - - - - The bind page. - - - - - The cancel button_ click. - - The sender. - The e. - - - - The finish button_ click. - - The sender. - The e. - - - - The next button_ click. - - The sender. - The e. - - - - The wizard dialog_ loaded. - - The sender. - The e. - - - - InitializeComponent - - - - - Provides reflection extensions. - - - - - Filters on the and . - - The enumeration type. - The array. - - The filtered values. - - - - - Gets the attributes of the specified type. - - The type of attribute to get. - The field info. - The inherit flag. - - The attributes enumeration. - - - - - Return the first attribute of a given type for the specified property descriptor. - - An attribute type. - The property descriptor. - The first attribute of the specified type. - - - - Gets the value of the first attribute of the specified type. - - The type of the attribute. - The type of the result. - The descriptor. - The mapping function. - The default value. - The value returned from the mapping function, or the default value if the attribute was not found. - - - - Gets the first attribute of the specified type. - - The descriptor. - Type of the attribute. - The first attribute of the specified type. - - - - Determines whether the property is read-only. - - The property descriptor. - true if the property is read-only; otherwise, false. - - - - Gets the category for the specified property. - - The property descriptor. - The category. - - - - Gets the description for the specified property. - - The property descriptor. - The description. - - - - Gets the display name for the specified property. - - The property descriptor. - The display name. - - - - Provides extrapolation functionality for the auto filler. - - - - - The get cell value function. - - - - - The set cell value function. - - - - - Initializes a new instance of the class. - - The get cell value. - The try set cell value. - - - - The auto fill. - - The current cell. - The selection cell. - The auto fill ref. - - - - Tries to extrapolate the specified cells. - - The cell to extrapolate. - The current cell. - The selection cell. - The auto fill cell reference. - The result. - - True if extrapolation was successful. - - - - - Clamps the specified value between i0 and i1. - - The input. - The minimum value. - The maximum value. - - The periodic clamp. - - - - - Tries to extrapolate. - - The cell. - The first source cell. - The second source cell. - The result. - - True is extrapolation was successful. - - - - - Captures a screen shot using gdi32 functions. - - See http://stackoverflow.com/questions/1736287/capturing-a-window-with-wpf - - - - The ternary raster operations. - - - - - dest = source - - - - - dest = source OR dest - - - - - dest = source AND dest - - - - - dest = source XOR dest - - - - - dest = source AND (NOT dest) - - - - - dest = (NOT source) - - - - - dest = (NOT src) AND (NOT dest) - - - - - dest = (source AND pattern) - - - - - dest = (NOT source) OR dest - - - - - dest = pattern - - - - - dest = DPSnoo - - - - - dest = pattern XOR dest - - - - - dest = (NOT dest) - - - - - dest = BLACK - - - - - dest = WHITE - - - - - Captures the specified rectangle from the screen. - - A bitmap. - - - The area to capture. - - A bitmap. - - - - - Gets the cursor position relative to the specified visual. - - The visual to relate to. - - A . - - - - - The get mouse screen position. - - - The . - - - - - The get cursor pos. - - The pt. - - The get cursor pos. - - - - - The bit blt. - - The hdc. - The n x dest. - The n y dest. - The n width. - The n height. - The hdc src. - The n x src. - The n y src. - The dw rop. - - The bit blt. - - - - - The create bitmap. - - The n width. - The n height. - The c planes. - The c bits per pel. - The lpv bits. - - The . - - - - - The create compatible bitmap. - - The hdc. - The n width. - The n height. - - The . - - - - - The create compatible dc. - - The hdc. - - The . - - - - - The delete object. - - The h object. - - The delete object. - - - - - The get dc. - - The h wnd. - - The . - - - - - The release dc. - - The h wnd. - The h dc. - - The release dc. - - - - - The select object. - - The hdc. - The hgdiobj. - - The . - - - - - The win 32 point. - - - - - The x. - - - - - The y. - - - - - Static helper methods. - - - - - Initializes static members of the class. - - - - - Gets the automatic color. - - - - - Gets the undefined color. - - - - - Change the alpha value of a color. - - The source color. - The new alpha value. - - The new color. - - - - - Converts CMYK values to a . - - The cyan value. - The magenta value. - The yellow value. - The black value. - - The color. - - - - - Calculates the difference between two s. - - The first color. - The second color. - - L2-norm in RGBA space. - - - - - Converts RGB values to CMYK. - - The r. - The g. - The b. - - The CMYK values. - - - - - Convert a to a hexadecimal string. - - The source color. - - The color to hex. - - - - - Converts from a to HSV values (double) - - The source color. - - Array of [Hue,Saturation,Value] in the range [0,1] - - - - - Converts from a to HSV values (byte) - - The source color. - - Array of [Hue,Saturation,Value] in the range [0,255] - - - - - Convert a to unsigned int - - The source color. - - The color to uint. - - - - - Calculates the complementary color. - - The source color. - - The complementary color. - - - - - Gets the hue spectrum colors. - - The number of colors. - - The spectrum. - - - - - Convert a hexadecimal string to . - - The hex input string. - - The color. - - - - - Converts from HSV to a RGB . - - The hue. - The saturation. - The value. - The alpha. - - The color. - - - - - Convert from HSV to . - http://en.wikipedia.org/wiki/HSL_color_space - - The Hue value [0,1]. - The saturation value [0,1]. - The brightness value [0,1]. - The alpha value [0.1]. - - The color. - - - - - Calculate the difference in hue between two s. - - The first color. - The second color. - - The hue difference. - - - - - Linear interpolation between two s. - - The first color. - The second color. - The interpolation factor. - - The interpolated color. - - - - - Convert an unsigned int (32bit) to . - - The unsigned integer. - - The color. - - - - - TimeSpan parser that use a format string to evaluate the input string. - - Supports the following format codes: D, DD, H, HH, M, MM, S, SS, d, dd, h, hh, m, mm, s, ss, f, ff, fff - - - - The special characters. - - - - - The conversion expression. - - - - - Initializes a new instance of the class. - - The format string. - - - - Gets or sets the regular expression. - - - - - Parses the specified time span string. - - The value. - - A time span. - - - - - The password helper. - - - - - Identifies the dependency property. - - - - - Identifies the Password attached dependency property. - - - - - Identifies the IsUpdating attached dependency property. - - - - - Gets the attach state. - - The dp. - - true if the control is attached. - - - - - Gets the password. - - The dp. - The password. - - - - Attaches the behaviour. - - The dp. - if set to true [value]. - - - - The set password. - - The dp. - The value. - - - - Attaches the password changed event handler. - - The sender. - The event arguments. - - - - The get is updating. - - The dp. - - The get is updating. - - - - - The on password property changed. - - The sender. - The e. - - - - The password changed. - - The sender. - The e. - - - - The set is updating. - - The dp. - The value. - - - - Addition, subtraction and multiplication for all kinds of objects (by reflection to invoke the operators). - - - - - Tries to parse the specified string. - - The target type. - The arguments. - The format provider. - The result. - - true if parsing successful, false otherwise. - - - - - Performs addition with the op_Addition operator. A return value indicates whether the addition succeeded or failed. - - The first object. - The second object. - The sum. - - True if the addition succeeded. - - - - - Performs multiplication with the op_Multiplication operator. A return value indicates whether the addition succeeded or failed. - - The first object. - The second object. - The product. - - True if the multiplication succeeded. - - - - - Performs subtraction with the op_Subtraction operator. A return value indicates whether the addition succeeded or failed. - - The first object. - The second object. - The difference. - - True if the subtraction succeeded. - - - - - Tries to invoke invoke the specified method. - - The method name. - The o 1. - The o 2. - The result. - - The try invoke. - - - - - Formats the TimeSpan to a string. - - See http://www.java2s.com/Open-Source/CSharp/Sound-Mp3/stamp/Microsoft/Office/PowerPoint/STAMP/Core/TimeSpanFormatter.cs.htm - - - - The format parser. - - - - - Initializes a new instance of the class. - - - - - Converts the value of a specified timespan to an equivalent string representation using specified format and culture-specific formatting information. - - A format string containing formatting specifications. - An object to format. - An object that supplies format information about the current instance. - - The string representation of the value of , formatted as specified by and . - - - - - Returns an object that provides formatting services for the specified type. - - An object that specifies the type of format object to return. - - An instance of the object specified by , if the implementation can supply that type of object; otherwise, null. - - - - - Evaluates a match. - - The match. - The time span. - - The evaluate match. - - - - - Gets the match evaluator for the specified time span. - - The time span. - - The match evaluator. - - - - - Parses a string to a TimeSpan. - - - - - The parser expression. - - - - - Parses the specified value. - - The value. - The format string. - - A TimeSpan. - - - - - The type helper. - - - - - The generic sequence type. - - - - - Finds the biggest common type of items in the list. - - The list. - - The biggest common type. - - - - - Gets the underlying enum type of the specified type, if the specified type is a nullable type. - - The type. - - The type of the underlying enum. - - - - - Gets the type of the items in the specified enumeration. - - The enumerable. - - The type of the items. - - - - - Gets the item type from a list type. - - The list type. - - The of the elements. - - - - - Determines whether the first type is assignable from the specified second type. - - Type of the first type. - The type of the second type. - - True if it is assignable. - - - - - Gets inner generic type of an IList>IList< - - The list. - - The . - - - - - Gets the type of the inner list of a IList>IList< - - The list. - - The type of the inner list. Return null if only interface type can be retrieved. - - - - - Determines whether the type is IList{IList}. - - The type. - - true if the type is IList{IList}; otherwise, false. - - - - - Represents a bag of items. - - - - - Initializes a new instance of the class. - - The objects. - - - - Occurs when a property value changes. - - - - - Gets the biggest common type of the objects. - - The type of the biggest. - - - - Gets the objects in the bag. - - The objects. - - - - Gets or sets a value indicating whether to suspend property changed notifications. - - true if notifications are suspended; otherwise, false . - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Raises the property changed event. - - The property. - - - - The relay property changed. - - The sender. - The e. - - - - Adds subscriptions to property changed notifications. - - - - - Removes the subscriptions to property changed notifications. - - - - - Provides a property descriptor for an object in the . - - - - - The component type. - - - - - The default descriptor. - - - - - Initializes a new instance of the class. - - The default descriptor. - Type of the component. - - - - When overridden in a derived class, gets the type of the component this property is bound to. - - - - A that represents the type of component this property is bound to. When the or methods are invoked, the object specified might be an instance of this type. - - - - - When overridden in a derived class, gets a value indicating whether this property is read-only. - - - - true if the property is read-only; otherwise, false. - - - - - When overridden in a derived class, gets the type of the property. - - - - A that represents the type of the property. - - - - - When overridden in a derived class, returns whether resetting an object changes its value. - - The component to test for reset capability. - - true if resetting the component changes its value; otherwise, false. - - - - - When overridden in a derived class, gets the current value of the property on a component. - - The component with the property for which to retrieve the value. - - The value of a property for a given component. - - - - - When overridden in a derived class, resets the value for this property of the component to the default value. - - The component with the property value that is to be reset to the default value. - - - - When overridden in a derived class, sets the value of the component to a different value. - - The component with the property value that is to be set. - The new value. - - - - When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. - - The component with the property to be examined for persistence. - - true if the property should be persisted; otherwise, false. - - - - - Gets the type of the . - - The type. - - The . - - - - - Provides a type description provider for the . - - - - - The default type provider. - - - - - Initializes a new instance of the class. - - - - - Gets a custom type descriptor for the given type and object. - - The type of object for which to retrieve the type descriptor. - An instance of the type. Can be null if no instance was passed to the . - - An that can provide metadata for the type. - - - - - Provides a custom type descriptor for the . - - - - - The bag. - - - - - Initializes a new instance of the class. - - The parent. - The instance. - - - - Get the properties of the items bag. - - - The property descriptor collection. - - - - - Specifies the control type for categories. - - - - - Group boxes. - - - - - Expander controls. - - - - - Content control. Remember to set the CategoryControlTemplate. - - - - - Represents a group in a . - - - - - Initializes a new instance of the class. - - - - - Gets or sets the description. - - The description. - - - - Gets or sets the header. - - The header. - - - - Gets or sets the icon. - - The icon. - - - - Gets the properties. - - - - - The to string. - - - The to string. - - - - - Defines functionality to create controls for a . - - - - - Creates the control for a property. - - The property item. - The options. - - A element. - - - - - Creates the error control. - - The pi. - The instance. - The tab. - - - - - Sets validation error style for tooltips - - - - - - - - Updates the tab for validation results. - - The tab. - The error information. - - - - Defines functionality to build the model for a . - - - - - Creates the model. - - The instance. - if set to true enumerable types instances will use the enumerated objects instead of the instance itself. - The options. - - The tabs. - - - - - Specifies options for the PropertyGrid - - - - - Gets the required (opt-in) attribute. - - The required attribute. - - - - Gets a value indicating whether to show declared properties only. - - true if only declared properties should be shown; otherwise, false . - - - - Gets a value indicating whether to show read only properties. - - true if read only properties should be shown; otherwise, false . - - - - Represents options for the property control factory. - - - - - Gets or sets the limiting number of values for enum properties that can shown with radio buttons. - - The limit. If the number of values exceeds the limit, a selector control will be used. - - - - Gets or sets the validation error template. - - - The validation error template. - - - - - Gets or sets the validation error style. - - - The validation error style. - - - - - Provides an for a specified type. - - PropertyConverters can be registered in the .Converters collection. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Type of the property. - The converter. - Convert nullable objects if set to true. - - - - Gets or sets template for this type. - - - - - Gets or sets a value indicating whether to convert nullable objects. - - true if nullable objects should be converted; otherwise, false. - - - - Gets or sets the type to edit. - - - - - Gets the target type of the converter. - - - The target type. - - - - - Determines whether the specified type is assignable to the EditedType. - - The type. - - true if the specified type is assignable; otherwise, false . - - - - - Specifies how the label widths are shared. - - - - - The shared in tab. - - - - - The shared in group. - - - - - The not shared. - - - - - Specifies the layout for checkboxes. - - - - - Show the header, then the check box without content - - - - - Hide the header, show the check box with the display name as content - - - - - Collapse the header, show the check box with the display name as content - - - - - Specifies the visibility of the tab strip. - - - - - The tabs are visible. - - - - - The tabs are visible if there is more than one tab. - - - - - The tab strip is collapsed. The contents of the tab pages will be stacked vertically in the control. - - - - - The property control. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - The selected tab id property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - The panel part name. - - - - - The scroll control part name. - - - - - The tab control part name. - - - - - The value to visibility converter. - - - - - The value to boolean converter. - - - - - Converts a list of values to a boolean value. Returns true if all values equal the converter parameter. - - - - - The null to boolean converter. - - - - - The zero to visibility converter. - - - - - The current selected object type. - - - - - The panel control. - - - - - The scroll viewer. - - - - - The tab control. - - - - - Initializes static members of the class. - - - - - Gets or sets the category control template. - - The category control template. - - - - Gets or sets the type of the category control. - - The type of the category control. - - - - Gets or sets the category header template. - - The category header template. - - - - Gets or sets CurrentObject. - - - - - Gets or sets the description icon. - - The description icon. - - - - Gets or sets the alignment for description icons. - - The description icon alignment. - - - - Gets or sets a value indicating whether label column resizing is enabled. - - - - - Gets or sets the maximum number of values to show for radio buttons lists. - - The limit. - - - - Gets or sets the indentation. - - - The indentation. - - - - - Gets or sets the type of label width sharing. - - The label width sharing. - - - - Gets or sets the maximum width of the label. - - The maximum width of the label. - - - - Gets or sets the minimum width of the property labels. - - The minimum width. - - - - Gets or sets a value indicating whether to move focus on unhandled Enter key down events. - - true if move focus on enter; otherwise, false . - - - - Gets or sets the control factory. - - - - - Gets or sets the operator. - - The operator. - - - - Gets or sets the selected object. - - The selected object. - - - - Gets or sets the selected objects. - - The selected objects. - - - - Gets or sets the index of the selected tab. - - The index of the selected tab. - - - - Gets or sets the selected tab id. - - - - - Gets or sets the check box layout. - - The check box layout. - - - - Gets or sets a value indicating whether to show description icons. - - - - - Gets or sets the tab header template. - - The tab header template. - - - - Gets or sets the tab page header template. - - The tab page header template. - - - - Gets or sets the tab strip placement. - - The tab strip placement. - - - - Gets or sets the tool tip template. - - The tool tip template. - - - - Gets or sets a value indicating the tab visibility state. - - The tab visibility state. - - - - Gets or sets the validation error style. - - The validation error style. - - - - Gets or sets the validation error template. - - The validation error template. - - - - Gets or sets the validation template. - - The validation template. - - - - Gets or sets the required attribute type. - - The required attribute type. - - - - Gets or sets a value indicating whether to show declared properties only. - - true if only declared properties should be shown; otherwise, false . - - - - Gets or sets a value indicating whether to show read only properties]. - - true if read only properties should be shown; otherwise, false . - - - - Creates the controls. - - The instance. - The tabs. - - - - Creates the controls (not using tab control). - - The instance. - The tab collection. - - - - When overridden in a derived class, is invoked whenever application code or internal processes call . - - - - - Creates a tool tip. - - The content. - - The tool tip. - - - - - Invoked when an unhandled KeyDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. - - The that contains the event data. - - - - Called when the selected object is changed. - - The e. - - - - The appearance changed. - - The d. - The e. - - - - Creates the content control and property panel. - - The g. - The tab items. - The index. - Stretch the panel if set to true. - - The property panel. - - - - - Adds the tab page header if TabPageHeaderTemplate is specified. - - The tab. - The tab panel. - - - - Creates and adds the property panel. - - The panel where the property panel should be added. - The property. - The instance. - The tab. - - - - Configures the panel. - - - - - Configures the property control - - - - - Configures the label. - - - - - Adds the label. - - - - - Configures the property control. - - - - - Creates the label control. - - The property item. - - An element. - - - - - Creates the property control. - - The property item. - - An element. - - - - - Handles changes in SelectedObjects. - - The instance containing the event data. - - - - Called when the selected objects collection is changed. - - The sender. - The instance containing the event data. - - - - Set CurrentObject when SelectedObjects is changed. - - SelectedObjects. - - - - Updates the controls. - - - - - Handles changes of the selected tab. - - - The event arguments. - - - - - Handles changes of the selected tab index. - - - The event arguments. - - - - - Provides a control factory for the control. - - - - - The font family converter - - - - - The cached font families. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the list of converters. - - The converters. - - - - Gets or sets the list of type editors. - - The editors. - - - - Gets or sets the file dialog service. - - The file dialog service. - - - - Gets or sets the folder browser dialog service. - - The folder browser dialog service. - - - - Gets or sets a value indicating whether to use the DatePicker control for DateTime values. - - - - - Creates the control for a property. - - The property item. - The options. - - A element. - - - - - Creates the error control. - - - - - sets error style for control - - - - - - - Updates the tab for validation results. - - The tab. - The error information. - - - - Converts the horizontal alignment. - - The alignment to convert. - - A . - - - - - Creates the checkbox control. - - The property. - - The control. - - - - - Creates a control based on a template from a a . - - The property. - The editor. - - A . - - - - - Creates the brush control. - - The property. - - The control. - - - - - Creates the color control. - - The property. - - The control. - - - - - Creates the combo box control. - - The property. - - The control. - - - - - Creates a comment control. - - The property. - - The control. - - - - - Creates a content control. - - The property. - - A . - - - - - Creates the date time control. - - The property. - - The control. - - - - - Creates the default control. - - The property. - - The control. - - - - - Creates a dictionary control. - - The property. - - The control. - - - - - Creates the directory path control. - - The property. - - The control. - - - - - Gets the values for the specified enumeration type. - - The enumeration type. - A sequence of values. - - - - Creates the select control. - - The property. - The options. - - The control. - - - - - Creates the file path control. - - The property. - - The control. - - - - - Creates the font family control. - - The property. - - The control. - - - - - Creates the font preview. - - The property. - - The control. - - - - - Creates the grid control. - - The property. - - The control. - - - - - Creates the HTML control. - - The property. - - The control. - - - - - Creates the image control. - - The property. - - The control. - - - - - Creates the link control. - - The property. - - The control. - - - - - Creates the password control. - - The property. - - The control. - - - - - Creates the secure password control. - - The property. - - The control. - - - - - Creates the slider control. - - The property. - - The control. - - - - - Creates the spin control. - - The property. - - The control. - - - - - Creates a sequence of checkboxes. - - The property. - - A FrameworkElement. - - - - - Updates the converter from the Converters collection. - - The property. - - - - Determines whether the specified type is a reference type or a . - - The type. - - true if the specified type can be set to null; otherwise, false. - - - - - Gets the font families. - - - List of font families. - - - - - Creates a model for the control. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the default name of the category. - - The default name of the category. - - - - Gets or sets the default name of the tab. - - The default name of the tab. - - - - Gets or sets the enabled pattern. - - The enabled pattern. - - - - Gets or sets a value indicating whether each property should inherit the category attribute from the property declared before. - - - - - Gets or sets a value indicating whether to add spaces at the camel bumps of the display names. - - true if display names should be modified; otherwise, false . - - - - Gets or sets the optional pattern. - - The optional pattern. - - - - Gets or sets the visible pattern. - - The visible pattern. - - - - Gets or sets the current category. - - The current category. - - - - Gets or sets the declaring type of the current category. - - The type of the current category. - - - - Gets or sets the type of the current component. - - The type of the current component. - This is used to avoid that Category attributes are inherited from superclass to subclass. - - - - Creates the property model. - - The instance. - if set to true [is enumerable]. - The options. - - A list of . - - - - - Creates a property item. - - The property descriptor. - The property descriptors. - The instance. - - A property item. - - - - - Resets this factory. - - - - - Creates property items for all properties in the specified object. - - The object instance. - The options. - - Enumeration of PropertyItem. - - - - - Creates the property item instance. - - The property descriptor. - The collection of property descriptors. - - A property item. - - - - - Gets the category for the specified property. - - The property descriptor. - The declaring type. - - A category string. - - - - - Gets the description for the specified property. - - The property descriptor. - The declaring type. - - A description string. - - - - - Gets the display name for the specified property. - - The property descriptor. - The declaring type. - - A display name string. - - - - - Gets the localized description. - - The key. - Type of the declaring. - - The localized description. - - - - - Gets the localized string. - - The key. - The declaring type. - - The localized string. - - - - - Sets the properties. - - The property item. - The instance. - - - - Sets the attribute. - - The attribute. - The pi. - The instance. - - - - Represents a property in a . - - - - - Initializes a new instance of the class. - - The property descriptor. - The property descriptors. - - - - Gets or sets the input direction (for DataGrid control). - - The input direction. - - - - Gets or sets a value indicating whether 'easy insert' by keyboard is enabled in a DataGrid control. - - true if easy insert is enabled; otherwise, false. - - - - Gets or sets a value indicating whether 'easy insert' by mouse is enabled in a DataGrid control. - - true if easy insert is enabled; otherwise, false. - - - - Gets or sets a value indicating whether to accept return. - - - - - Gets the actual type of the property. - - If a converter is defined, the target type will be set. - - - - Gets or sets a value indicating whether to auto update text. - - - - - Gets or sets the indentation level of the header. - - - The indentation level. - - - - - Gets or sets the category. - - The category. - - - - Gets the columns. - - The columns. - - - - Gets or sets the converter. - - The converter. - - - - Gets or sets the converter culture. - - The converter culture. - - - - Gets or sets the converter parameter. - - The converter parameter. - - - - Gets the data types. - - The data types. - - - - Gets or sets the tool tip. - - The tool tip. - - - - Gets or sets the property descriptor. - - The descriptor. - - - - Gets or sets a value indicating whether this property is read only. - - true if this property is read only; otherwise, false. - - - - Gets or sets the display name. - - The display name. - - - - Gets or sets the file path default extension. - - The file path default extension. - - - - Gets or sets the file path filter. - - The file path filter. - - - - Gets or sets the initial directory path. - - The initial directory path. - - - - Gets or sets the filter descriptor. - - The filter descriptor. - - - - Gets or sets the default extension descriptor. - - The default extension descriptor. - - - - Gets or sets the font family property descriptor. - - The font family property descriptor. - - - - Gets or sets the font family. - - The font family. - - - - Gets or sets the size of the font. - - The size of the font. - - - - Gets or sets the open type weight. - - The font weight. - - - - Gets or sets the format string. - - The format string. - - - - Gets or sets the header placement. - - The header placement. - - - - Gets or sets the horizontal alignment. - - - - - Gets or sets a value indicating whether to stretch to the available tab size. - - true if fill is enabled; otherwise, false. - - - - Gets or sets the height. - - The height. - - - - Gets or sets a value indicating whether the property is a comment. - - - - - Gets or sets a value indicating whether the property contains content that should be shown in a ContentControl. - - - - - Gets or sets a value indicating whether the property is a directory path. - - - - - Gets or sets a value indicating whether the property is editable. - - - - - Gets or sets the is enabled descriptor. - - The is enabled descriptor. - - - - Gets or sets the value that enables the property. - - - - - Gets or sets a value indicating whether the property is a file open dialog. - - - - - Gets or sets a value indicating whether the property is a file path. - - - - - Gets or sets a value indicating whether this property is a font family selector. - - - - - Gets or sets a value indicating whether this property is optional. - - - - - Gets a value indicating whether this property is enabled by a radio button. - - - - - Gets or sets a value indicating whether the property is a password. - - - - - Gets or sets a value indicating whether this property should show a slider. - - - - - Gets or sets a value indicating whether this property should show spin buttons. - - - - - Gets or sets the is visible descriptor. - - The is visible descriptor. - - - - Gets or sets the value that makes the property visible. - - - - - Gets or sets the items source. - - The items source. - - - - Gets or sets the path that is used to get the SelectedValue from the SelectedItem of a Selector. - - The path used to get the SelectedValue. The default is an empty string. - - - - Gets or sets the display member path. - - - The display member path. - - - - - Gets or sets a descriptor that provides the ItemsSource. - - The ItemsSource . - - - - Gets or sets the items source for list items. - - The items source. - - - - Gets or sets a value indicating whether items can be added to the list. - - - - - Gets or sets a value indicating whether items can be removed from the list. - - - - - Gets or sets the list maximum number of items. - - The list maximum number of items. - - - - Gets or sets the max length. - - - - - Gets or sets the maximum height. - - The maximum height. - - - - Gets or sets the minimum height. - - The minimum height. - - - - Gets or sets a value indicating whether to move focus on enter. - - - - - Gets or sets the optional descriptor. - - The optional descriptor. - - - - Gets or sets the descriptor for the property that enables/disables by a radio button. - - The descriptor. - - - - Gets or sets the value used by the radio button to enable/disable. - - The value that enables. - - - - Gets or sets the optional value. - - The optional value. - - - - Gets or sets a value indicating whether to preview fonts. - - true if fonts should be previewed; otherwise, false . - - - - Gets or sets the properties. - - The properties. - - - - Gets or sets the property icon. - - The property icon. - - - - Gets or sets the relative path descriptor. - - The relative path descriptor. - - - - Gets or sets the reset command. - - The reset command. - - - - Gets or sets the reset header. - - The reset header. - - - - Gets or sets the slider large change. - - - - - Gets or sets the slider maximum. - - - - - Gets or sets the slider minimum. - - - - - Gets or sets the slider small change. - - - - - Gets or sets a value indicating whether the slider snaps to the ticks. - - - - - Gets or sets the slider tick frequency. - - - - - Gets or sets the index of the sort. - - The index of the sort. - - - - Gets or sets the spin control large change. - - - - - Gets or sets the spin control maximum. - - - - - Gets or sets the spin control minimum. - - - - - Gets or sets the spin control small change. - - - - - Gets or sets the tab. - - The tab. - - - - Gets or sets the text wrapping. - - The text wrapping. - - - - Gets or sets a value indicating whether the property should use radio buttons. - - - - - Gets or sets the width. - - The width. - - - - Gets the name of the property. - - The name of the property. - - - - Gets or sets the name of the Content property for a property of checkable items. - - - - - Gets or sets the name of the IsChecked property for a property of checkable items. - - - - - Creates a binding. - - The trigger. - Assign the converter if set to true. - - The binding. - - - - - Creates a one way binding. - - - The binding. - - - - - Gets the first attribute of the specified type. - - Type of attribute. - - The attribute, or null. - - - - - Gets the attributes of the specified type. - - Type of attribute. - - Enumerable of T. - - - - - Gets the property descriptor for the specified property. - - The property name. - - A property descriptor. - - - - - Determines whether the specified type is assignable from this property type. - - The type. - - true if ok; otherwise, false . - - - - - Gets the type of the converter target. - - - The target type. - - - - - Represents a tab in a . - - - - - Indicates whether the tab contains errors. - - - - - Indicates whether the tab contains warnnigs. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the description. - - The description. - - - - Gets or sets the id. - - - - - Gets the groups. - - - - - Gets or sets a value indicating whether this tab contains properties with errors. - - true if this tab has errors; otherwise, false. - - - - Gets or sets a value indicating whether this tab contains properties with warnings. - - - true if this instance has warnings; otherwise, false. - - - - - Gets or sets the header. - - The header. - - - - Gets or sets the icon. - - The icon. - - - - Determines whether the tab contains the specified property. - - Name of the property. - - true if the tab contains the specified property; otherwise, false. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Updates the has errors property. - - The instance. - - - - Updates the has errors property. - - The instance. - - - - Defines a data template for the specified type. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Type to edit. - The data template. - - - - Gets or sets the type to edit. - - - - - Gets or sets template for this type. - - - - - Determines whether the specified type is assignable to the EditedType. - - The type. - - true if the specified type is assignable; otherwise, false . - - - - - Provides an insertion bar adorner. - - See also blog post. - - - - The pen. - - - - - The triangle. - - - - - The adorner layer. - - - - - The is separator horizontal. - - - - - Initializes static members of the class. - - - - - Initializes a new instance of the class. - - if set to true [is separator horizontal]. - if set to true [is in first half]. - The adorned element. - The adorner layer. - - - - Gets or sets a value indicating whether IsInFirstHalf. - - - - - Detaches this instance from the adorner layer. - - - - - When overridden in a derived class, participates in rendering operations that are directed by the layout system. The rendering instructions for this element are not used directly when this method is invoked, and are instead preserved for later asynchronous use by layout and drawing. - - The drawing instructions for a specific element. This context is provided to the layout system. - - - - Calculates the start and end point. - - The start point. - The end point. - - - - Draws the triangle. - - The drawing context. - The origin. - The angle. - - - - Represents a hierarchical list box. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - A map from item to parent. This is used to set the Level property when the container of the item is generated. - - - - - A map from item to children. This is used to show the child items. - - - - - The is expanded map. - - - - - A map from children collection to item. - - - - - A map from item to level. This is used to set the Level property of the containers. - - - - - Dummy object that acts as the root node. - - - - - Initializes static members of the class. - - - - - Gets or sets the binding path to the children of an item. - - The binding path. - - - - Gets or sets the hierarchy source. - - The hierarchy source. - - - - Gets or sets the indentation. - - The indentation. - - - - Gets or sets the binding path to the IsExpanded property of the items. - - A binding path. - - - - Gets or sets the binding path to the IsSelected property of the items. - - A binding path. - - - - When overridden in a derived class, is invoked whenever application code or internal processes call . - - - - - Handles child collection changes. - - The sender. - The instance containing the event data. - - - - Gets the container from the specified index. - - The index. - - The container. - - - - - Collapses the specified item. - - The item to collapse. - - - - Expands the specified item. - - The item to expand. - - - - Gets the container from an item. - - The item. - - The container. - - - - - Creates or identifies the element used to display a specified item. - - - A . - - - - - Determines if the specified item is (or is eligible to be) its own ItemContainer. - - Specified item. - - true if the item is its own ItemContainer; otherwise, false. - - - - - Responds to the event. - - Provides data for . - - - - Prepares the specified element to display the specified item. - - Container used to display the specified item. - The item to display. - - - - Provides an appropriate implementation for this control, as part of the WPF automation infrastructure. - - The type-specific implementation. - - - - Subscribes for changes on the specified collection. - - The collection to observe. - - - - Removes the change subscription for the specified collection. - - The collection to stop observing. - - - - Handles changes in the HierarchySource. - - The instance containing the event data. - - - - Handles changes in indentation. - - - - - Inserts the specified items in the tree. - - The parent item. - The new items. - The starting index of the new items. - Could not get parent index in TreeListBox. - - - - Gets the children of the specified item. - - The item. - A list of children. - - - - Gets the next sibling to the parent of the specified item. - - The item. - The sibling item. - - - - Removes the specified items from the tree. - - The items to remove. - - - - Clears the items. - - - - - Removes the specified item. - - The item. - - - - Inserts the specified item. - - The index to insert the item at. - The item. - The parent of the item. - - - - Adds the item. - - The item. - - - - Gets the children collection of the specified item by reflection. - - The item. - A list of children. - - - - Exposes types to UI Automation. - - - - - Initializes a new instance of the class. - - The owner. - - - - Gets the name of the that is associated with this . - This method is called by . - - A string that contains "ListBox". - - - - Gets the collection of child elements of the - that is associated with this . - This method is called by . - - The collection of child elements. - - - - Drag/drop helper class for the . - - Based on blog post. - - - - Identifies the DragDropTemplate attached dependency property. - - - - - Identifies the IsDragSource attached dependency property. - - - - - Identifies the IsDropTarget attached dependency property. - - - - - The instance. - - - - - The format. - - - - - The dragged data. - - - - - The drop position. - - - - - The has vertical orientation. - - - - - The initial mouse position. - - - - - The insertion adorner. - - - - - The is in first half. - - - - - The source item container. - - - - - The source items control. - - - - - The target item container. - - - - - The target items control. - - - - - The top window. - - - - - Keeps track of the initial drag/drop key states. - - - - - Gets the instance singleton. - - - - - Gets the drag/drop template. - - The object. - - A data template. - - - - - Gets the IsDragSource value. - - The object. - - The value. - - - - - Gets the IsDropTarget value. - - The object. - - The value. - - - - - Gets the relative position. - - The container. - The clicked point. - The vertical orientation. - - The relative position. - - - - - Determines if the specified movement is big enough. - - The initial mouse position. - The current position. - - True if the movement is big enough. - - - - - The set drag drop template. - - The object. - The value. - - - - The set is drag source. - - The object. - The value. - - - - The set is drop target. - - The object. - The value. - - - - Determines if the drag source changed. - - The object. - The event args. - - - - Determines if the drop target changed. - - The object. - The event args. - - - - Creates or updates the insertion adorner. - - - - - Decides the drop target. - - The event args. - - - - Handles the PreviewMouseLeftButtonDown event on the drag source. - - The sender. - The event args. - - - - Handles the PreviewMouseLeftButtonUp event on the drag source. - - The sender. - The event args. - - - - Handles the PreviewMouseMove event on the drag source. - - The sender. - The event args. - - - - Handles the PreviewDragEnter event on the drop target. - - The sender. - The event args. - - - - Handles the PreviewDragLeave event on the drop target. - - The sender. - The event args. - - - - Handles the PreviewDragOver event on the drop target. - - The sender. - The event args. - - - - Handles the PreviewDrop event on the drop target. - - The sender. - The event args. - - - - Removes the adorners. - - - - - Removes the insertion adorner. - - - - - Updates the adorner. - - - - - Represents a container for items in the . - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Gets the expand toggle command. - - The command. - - - - Gets or sets a value indicating whether this item has child items. - - - - - Gets or sets a value indicating whether this instance should preview as a drop target. - - - - - Gets or sets a value indicating whether this instance is expanded. - - - - - Gets or sets the hierarchy level of the item. - - The level. - - - - Gets the padding due to hierarchy level and the parent control Indentation. - - The level padding. - - - - Gets the parent . - - - - - Handles changes in or (in the parent control). - - - - - Handles changes in the property. - - - - - Provides binding utility extension methods. - - - - - The value to boolean converter. - - - - - Binds the IsEnabled property of the specified element to the specified property and value. - - The element. - The path. - The converter parameter (optional). - The binding source (optional). - - - - Provides utilities related to s. - - - - - Converts a string from camel case to a string where space is inserted before each capital letter. - - Name of the variable. - - A string. - - - - - Converts the specified string to horizontal alignment. - - The string to convert. - A value. - - - - The ButtonChrome element - This element is a theme-specific type that is used as an optimization - for a common complex rendering used in Aero - - - - - DependencyProperty for property. - - - - - The Background property defines the brush used to fill the background of the button. - - - - - DependencyProperty for property. - - - - - The BorderBrush property defines the brush used to draw the outer border. - - - - - DependencyProperty for property. - - - - - When true the chrome renders with a mouse over look. - - - - - DependencyProperty for property. - - - - - When true the chrome renders with a mouse over look. - - - - - DependencyProperty for property. - - - - - When true the chrome renders with a pressed look. - - - - - DependencyProperty for property. - - - - - When true, the left border will have round corners, otherwise they will be square. - - - - - Updates DesiredSize of the ButtonChrome. Called by parent UIElement. This is the first pass of layout. - - - ButtonChrome basically inflates the desired size of its one child by 2 on all four sides - - Available size is an "upper limit" that the return value should not exceed. - The ButtonChrome's desired size. - - - - ButtonChrome computes the position of its single child inside child's Margin and calls Arrange - on the child. - - - ButtonChrome basically inflates the desired size of its one child by 2 on all four sides - - Size the ContentPresenter will assume. - - - - Render callback. - - - - - The SystemDropShadowChrome element - This element is a theme-specific type that is used as an optimization - for a common complex rendering used in Aero - - - - - DependencyProperty for property. - - - - - The Color property defines the Color used to fill the shadow region. - - - - - DependencyProperty for property. - - - - - The CornerRadius property defines the CornerRadius of the object casting the shadow. - - - - - Render callback. - - - - - https://github.com/andypelzer/GraphSharp/blob/master/Graph%23.Controls - https://wpfextensions.codeplex.com/ - - - - Applied to the presenter. - - - Applied to the scrollviewer. - - - Gets or sets the active modifier mode. - - - Gets or sets the mode of the zoom control. - - - The content should fill the given space. - - - The content will be represented in its original size. - - - The content will be zoomed with a custom percent. - - - - GeneratedInternalTypeHelper - - - - - CreateInstance - - - - - GetPropertyValue - - - - - SetPropertyValue - - - - - CreateDelegate - - - - - AddEventHandler - - -
-
diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraACS.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraACS.dll deleted file mode 100644 index cf4a249..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraACS.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraCAS.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraCAS.dll deleted file mode 100644 index 07b3806..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraCAS.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraCellTracker.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraCellTracker.dll deleted file mode 100644 index 6893a17..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraCellTracker.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraChiller.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraChiller.dll deleted file mode 100644 index 91984e3..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraChiller.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraDeviceCommon.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraDeviceCommon.dll deleted file mode 100644 index 713e226..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraDeviceCommon.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraIO.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraIO.dll deleted file mode 100644 index 7d4551f..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraIO.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLBAD.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLBAD.dll deleted file mode 100644 index 022e229..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLBAD.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLaser.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLaser.dll deleted file mode 100644 index dd30e5a..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLaser.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLaser.dll.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLaser.dll.config deleted file mode 100644 index 1136035..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLaser.dll.config +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLaserScanner.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLaserScanner.dll deleted file mode 100644 index 733c3d6..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLaserScanner.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLaserScanner.dll.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLaserScanner.dll.config deleted file mode 100644 index 7ea7af3..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLaserScanner.dll.config +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLight.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLight.dll deleted file mode 100644 index 7636182..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraLight.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraMXComponent.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraMXComponent.dll deleted file mode 100644 index ba399f0..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraMXComponent.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraMelsecNet.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraMelsecNet.dll deleted file mode 100644 index 58bfb95..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraMelsecNet.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraMotionBoard.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraMotionBoard.dll deleted file mode 100644 index cac5eeb..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraMotionBoard.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraMotor.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraMotor.dll deleted file mode 100644 index 9dd052f..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraMotor.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraNative.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraNative.dll deleted file mode 100644 index 0457f45..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraNative.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraOCT.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraOCT.dll deleted file mode 100644 index d386358..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraOCT.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraPLC.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraPLC.dll deleted file mode 100644 index 58b66bb..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraPLC.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraPowerMeter.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraPowerMeter.dll deleted file mode 100644 index 0b628b8..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraPowerMeter.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraUIComponent.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraUIComponent.dll deleted file mode 100644 index f6e9120..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraUIComponent.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraUIComponent.dll.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraUIComponent.dll.config deleted file mode 100644 index 64d661f..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/AuroraUIComponent.dll.config +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Aurora_OSC.html b/Machines/_out_prismatic_rd_ptop/x64-Debug/Aurora_OSC.html deleted file mode 100644 index 10bba84..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/Aurora_OSC.html +++ /dev/null @@ -1,960 +0,0 @@ - - - - - - - - -
-

- Open Source Software Notice - OSSNotice-7857_Aurora2 플랫폼_2.0.14_241226.html -

- -

This product from LG Electronics, Inc. contains the open source software detailed below. Please refer to the indicated open source licenses (as are included following this notice) for the terms and conditions of their use.

- - - - - - -
-

Please be informed that - - LG Electronics, Inc. - - - product may contain open source software listed in the tables below. -

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Open source lists under Permissive License.
Open SourceLicenseCopyright
- - ClosedXML - 0.96.0 - - - - -

- MIT -

- -
-

Copyright (c) 2016 ClosedXML

-
- - ControlzEx - 4.4.0 - - - - -

- MIT -

- -
-

Copyright (c) 2015-2019 Jan Karger, Bastian Schmidt

-
- - Costura - 5.6.0 - - - - -

- MIT -

- -
-

Copyright (c) 2012 Simon Cropp and contributors

-
- - CsvHelper - 27.2.1 - - - - -

- MS-PL -

- -
-

Copyright 2009-2021 Josh Close
Copyright 1987-2004 Adobe Systems Incorporated
Copyright 1997-2006 Adobe Systems Incorporated

-
- - dotnet-runtime - 5.0.0 - - - - -

- MIT -

- -
-

Copyright (c) .NET Foundation and Contributors

-
- - dotnet-runtime - 4.3.0 - - - - -

- MIT -

- -
-

Copyright (c) .NET Foundation and Contributors

-
- - dotnet-runtime - 4.4.0 - - - - -

- MIT -

- -
-

Copyright (c) .NET Foundation and Contributors

-
- - dotnet-runtime - 4.3.1 - - - - -

- MIT -

- -
-

Copyright (c) .NET Foundation and Contributors

-
- - dotnet-runtime - 7.0.0 - - - - -

- MIT -

- -
-

Copyright (c) .NET Foundation and Contributors

-
- - dotnet-runtime - 4.5.0 - - - - -

- MIT -

- -
-

Copyright (c) .NET Foundation and Contributors

-
- - dotnet-runtime - 6.0.0 - - - - -

- MIT -

- -
-

Copyright (c) .NET Foundation and Contributors

-
- - dotnet-runtime - 4.6.0 - - - - -

- MIT -

- -
-

Copyright (c) .NET Foundation and Contributors

-
- - dotnet-runtime - 4.5.1 - - - - -

- MIT -

- -
-

Copyright (c) .NET Foundation and Contributors

-
- - dotnet-runtime - 4.7.0 - - - - -

- MIT -

- -
-

Copyright (c) .NET Foundation and Contributors

-
- - dotnet-runtime - 4.5.3 - - - - -

- MIT -

- -
-

Copyright (c) .NET Foundation and Contributors

-
- - dotnet-runtime - 4.5.4 - - - - -

- MIT -

- -
-

Copyright (c) .NET Foundation and Contributors

-
- - dotnet-runtime - 4.7.3 - - - - -

- MIT -

- -
-

Copyright (c) .NET Foundation and Contributors

-
- - dotnet-runtime - 4.5.5 - - - - -

- MIT -

- -
-

Copyright (c) .NET Foundation and Contributors

-
- - dotnet-runtime - 1.6.1 - - - - -

- MIT -

- -
-

Copyright (c) .NET Foundation and Contributors

-
- - dotnet-runtime - 1.1.0 - - - - -

- MIT -

- -
-

Copyright (c) .NET Foundation and Contributors

-
- - dotnet-runtime - 1.0.0 - - - - -

- MIT -

- -
-

Copyright (c) .NET Foundation and Contributors

-
- - ExcelNumberFormat - 1.1.0 - - - - -

- MIT -

- -
-

Copyright (c) 2017 andersnm

-
- - Fody - 6.5.2 - - - - -

- MIT -

- -
-

Copyright (c) Simon Cropp

-
- - grpc-dotnet - 2.49.0 - - - - -

- Apache-2.0 -

- -
-

Copyright 2019 The gRPC
Copyright 2015 gRPC
Copyright 2011-2019 Twitter, Inc.

-
- - Json.NET - 13.0.1 - - - - -

- MIT -

- -
-

Copyright (c) 2007 James Newton-King

-
- - Json.NET - 13.0.2 - - - - -

- MIT -

- -
-

Copyright (c) 2007 James Newton-King

-
- - K4os.Compression.LZ4 - 1.3.8 - - - - -

- MIT -

- -
-

Copyright (c) 2017 Milosz Krajewski

-
- - MahApps.Metro - 2.4.5 - - - - -

- MIT -

- -
-

-
- - MahApps.Metro.IconPacks - 4.11.0 - - - - -

- MIT -

- -
-

Copyright (c) MahApps, Jan Karger

-
- - mathnet-numerics - 5.0.0 - - - - -

- MIT -

- -
-

Copyright (c) 2002-2022 Math.NET

-
- - nuget:ChartKit - 1.0.2309.233 - - - - -

- MIT -

- -
-

-
- - nuget:ChartKit.SkiaSharpView - 1.0.2309.233 - - - - -

- MIT -

- -
-

-
- - Open-XML-SDK - 2.16.0 - - - - -

- MIT -

- -
-

Copyright (c) Tunnel Vision Laboratories, LLC
Copyright (c) .NET Foundation and Contributors
Copyright (c) 2007 James Newton-King

-
- - OpenCV - 3.4.8 - - - - -

- BSD-3-Clause -

- -
-

Copyright (C) 2000, Intel Corporation, all rights reserved.
Copyright (c) 1991-1997 Silicon Graphics, Inc.
Copyright (c) 1991-1997 Silicon Graphics, Inc.

-
- - Portable.Licensing - 1.1.0 - - - - -

- MIT -

- -
-

copyright (c) 2012 - 2013 Nauck IT KG http://www.nauck-it.de

-
- - Protocol Buffers - 3.23.2 - - - - -

- BSD-3-Clause -

- -
-

Copyright (c) 2008-2022 Google Inc.

-
- - Protocol Buffers - 3.12.0 - - - - -

- BSD-3-Clause -

- -
-

-
- - rabbitmq-dotnet-client - 6.8.1 - - - - -

- Apache-2.0 -

- -
-

Copyright (c) 2007-2020 VMware, Inc.
Copyright (c) 2011-2020 VMware, Inc. or its affiliates
Copyright (c) 2013-2020 VMware, Inc. or its affiliates

-
- - rapidjson Parser - 1.1.0 - - - - -

- MIT -

- -
-

Copyright (c) 2015 THL A29 Limited, a Tencent company, and Milo Yip.

-
- - SharpVectors - 1.7.7 - - - - -

- BSD-3-Clause -

- -
-

Copyright (c) 2010 - 2018, Elinam LLC
Copyright (c) 2010 - 2021, Elinam LLC
Copyright (c) Microsoft Corporation
Copyright (c) 2009, 2010, 2013-2016 by the Brotli Authors

-
- - SkiaSharp - 2.88.8 - - - - -

- MIT -

- -
-

Copyright (c) 2017-2018 Microsoft Corporation
Copyright (c) 2015-2016 Xamarin, Inc.

-
- - SkiaSharp - 2.88.5 - - - - -

- MIT -

- -
-

Copyright (c) 2017-2018 Microsoft Corporation
Copyright (c) 2015-2016 Xamarin, Inc.

-
- - SkiaSharp - 2.8.2.5 - - - - -

- MIT -

- -
-

Copyright (c) 2017-2018 Microsoft Corporation
Copyright (c) 2015-2016 Xamarin, Inc.

-
- - Windows-API-CodePack-NET - 1.1.2 - - - - -

- MIT -

- -
-

-
- - XamlBehaviorsWpf - 1.1.39 - - - - -

- MIT -

- -
-

Copyright (c) Microsoft

-
-
- - - - - - - -

- Apache-2.0

-
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-

- - - -

- BSD-3-Clause

-
Copyright (c) <year> <owner>. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

-

- - - -

- MIT

-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

-

- - - -

- MS-PL

-
Microsoft Public License (Ms-PL)

This license governs use of the accompanying software. If you use the software, you accept this license. If you do not accept the license, do not use the software.

1. Definitions
The terms "reproduce," "reproduction," "derivative works," and "distribution" have the same meaning here as under U.S. copyright law. A "contribution" is the original software, or any additions or changes to the software. A "contributor" is any person that distributes its contribution under this license. "Licensed patents" are a contributor's patent claims that read directly on its contribution.

2. Grant of Rights
(A) Copyright Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free copyright license to reproduce its contribution, prepare derivative works of its contribution, and distribute its contribution or any derivative works that you create.

(B) Patent Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free license under its licensed patents to make, have made, use, sell, offer for sale, import, and/or otherwise dispose of its contribution in the software or derivative works of the contribution in the software.

3. Conditions and Limitations
(A) No Trademark License- This license does not grant you rights to use any contributors' name, logo, or trademarks.

(B) If you bring a patent claim against any contributor over patents that you claim are infringed by the software, your patent license from such contributor to the software ends automatically.

(C) If you distribute any portion of the software, you must retain all copyright, patent, trademark, and attribution notices that are present in the software.

(D) If you distribute any portion of the software in source code form, you may do so only under this license by including a complete copy of this license with your distribution. If you distribute any portion of the software in compiled or object code form, you may only do so under a license that complies with this license.

(E) The software is licensed "as-is." You bear the risk of using it. The contributors give no express warranties, guarantees, or conditions. You may have additional consumer rights under your local laws which this license cannot change. To the extent permitted under your local laws, the contributors exclude the implied warranties of merchantability, fitness for a particular purpose and non-infringement.

-

- - - - - - -
- - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/BouncyCastle.Crypto.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/BouncyCastle.Crypto.dll deleted file mode 100644 index 5ef4591..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/BouncyCastle.Crypto.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/BouncyCastle.Crypto.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/BouncyCastle.Crypto.xml deleted file mode 100644 index 2695f5d..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/BouncyCastle.Crypto.xml +++ /dev/null @@ -1,30592 +0,0 @@ - - - - BouncyCastle.Crypto - - - - return the X9ECParameters object for the named curve represented by - the passed in object identifier. Null if the curve isn't present. - - @param oid an object identifier representing a named curve, if present. - - - return the object identifier signified by the passed in name. Null - if there is no object identifier associated with name. - - @return the object identifier associated with name, if present. - - - return the named curve name represented by the given object identifier. - - - returns an enumeration containing the name strings for curves - contained in this structure. - - - Return the DER encoding of the object, null if the DER encoding can not be made. - - @return a DER byte array, null otherwise. - - - Mutable class for building ASN.1 constructed objects such as SETs or SEQUENCEs. - - - a general purpose ASN.1 decoder - note: this class differs from the - others in that it returns null after it has read the last object in - the stream. If an ASN.1 Null is encountered a Der/BER Null object is - returned. - - - Create an ASN1InputStream based on the input byte array. The length of DER objects in - the stream is automatically limited to the length of the input array. - - @param input array containing ASN.1 encoded data. - - - Create an ASN1InputStream where no DER object will be longer than limit. - - @param input stream containing ASN.1 encoded data. - @param limit maximum size of a DER encoded object. - - - build an object given its tag and the number of bytes to construct it from. - - - A Null object. - - - Create a base ASN.1 object from a byte array. - The byte array to parse. - The base ASN.1 object represented by the byte array. - - If there is a problem parsing the data, or parsing an object did not exhaust the available data. - - - - Read a base ASN.1 object from a stream. - The stream to parse. - The base ASN.1 object represented by the byte array. - If there is a problem parsing the data. - - - return an Octet string from a tagged object. - - @param obj the tagged object holding the object we want. - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - return an Octet string from the given object. - - @param obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - @param string the octets making up the octet string. - - - return an Asn1Sequence from the given object. - - @param obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Return an ASN1 sequence from a tagged object. There is a special - case here, if an object appears to have been explicitly tagged on - reading but we were expecting it to be implicitly tagged in the - normal course of events it indicates that we lost the surrounding - sequence - so we need to add it back (this will happen if the tagged - object is a sequence that contains other sequences). If you are - dealing with implicitly tagged sequences you really should - be using this method. - - @param obj the tagged object. - @param explicitly true if the object is meant to be explicitly tagged, - false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - return the object at the sequence position indicated by index. - - @param index the sequence number (starting at zero) of the object - @return the object at the sequence position indicated by index. - - - return an ASN1Set from the given object. - - @param obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Return an ASN1 set from a tagged object. There is a special - case here, if an object appears to have been explicitly tagged on - reading but we were expecting it to be implicitly tagged in the - normal course of events it indicates that we lost the surrounding - set - so we need to add it back (this will happen if the tagged - object is a sequence that contains other sequences). If you are - dealing with implicitly tagged sets you really should - be using this method. - - @param obj the tagged object. - @param explicitly true if the object is meant to be explicitly tagged - false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - return the object at the set position indicated by index. - - @param index the set number (starting at zero) of the object - @return the object at the set position indicated by index. - - - ASN.1 TaggedObject - in ASN.1 notation this is any object preceded by - a [n] where n is some number - these are assumed to follow the construction - rules (as with sequences). - - - @param tagNo the tag number for this object. - @param obj the tagged object. - - - @param explicitly true if the object is explicitly tagged. - @param tagNo the tag number for this object. - @param obj the tagged object. - - - return whether or not the object may be explicitly tagged. -

- Note: if the object has been read from an input stream, the only - time you can be sure if isExplicit is returning the true state of - affairs is if it returns false. An implicitly tagged object may appear - to be explicitly tagged, so you need to understand the context under - which the reading was done as well, see GetObject below.

-
- - return whatever was following the tag. -

- Note: tagged objects are generally context dependent if you're - trying to extract a tagged object you should be going via the - appropriate GetInstance method.

-
- - Return the object held in this tagged object as a parser assuming it has - the type of the passed in tag. If the object doesn't have a parser - associated with it, the base object is returned. - - - iso.org.dod.internet.private.enterprise.legion-of-the-bouncy-castle -

1.3.6.1.4.1.22554

-
- - pbe(1) algorithms -

1.3.6.1.4.1.22554.1

-
- - SHA-1(1) -

1.3.6.1.4.1.22554.1.1

-
- - SHA-2.SHA-256; 1.3.6.1.4.1.22554.1.2.1 - - - SHA-2.SHA-384; 1.3.6.1.4.1.22554.1.2.2 - - - SHA-2.SHA-512; 1.3.6.1.4.1.22554.1.2.3 - - - SHA-2.SHA-224; 1.3.6.1.4.1.22554.1.2.4 - - - PKCS-5(1)|PKCS-12(2) - SHA-1.PKCS5; 1.3.6.1.4.1.22554.1.1.1 - - - SHA-1.PKCS12; 1.3.6.1.4.1.22554.1.1.2 - - - SHA-256.PKCS12; 1.3.6.1.4.1.22554.1.2.1.1 - - - SHA-256.PKCS12; 1.3.6.1.4.1.22554.1.2.1.2 - - - AES(1) . (CBC-128(2)|CBC-192(22)|CBC-256(42)) - 1.3.6.1.4.1.22554.1.1.2.1.2 - - - 1.3.6.1.4.1.22554.1.1.2.1.22 - - - 1.3.6.1.4.1.22554.1.1.2.1.42 - - - 1.3.6.1.4.1.22554.1.1.2.2.2 - - - 1.3.6.1.4.1.22554.1.1.2.2.22 - - - 1.3.6.1.4.1.22554.1.1.2.2.42 - - - signature(2) algorithms - - - Sphincs-256 - - - XMSS - - - XMSS^MT - - - key_exchange(3) algorithms - - - NewHope - - - - Extension to tie an alternate certificate to the containing certificate. -
-                LinkedCertificate := SEQUENCE {
-                    digest        DigestInfo,                   -- digest of PQC certificate
-                    certLocation  GeneralName,                  -- location of PQC certificate
-                    certIssuer    [0] Name OPTIONAL,            -- issuer of PQC cert (if different from current certificate)
-                    cACerts       [1] GeneralNames OPTIONAL,    -- CA certificates for PQC cert (one of more locations)
-            }
-            
-
- - A BER Null object. - - - return the DER octets that make up this string. - - - create an empty sequence - - - create a sequence containing one object - - - create a sequence containing a vector of objects. - - - create an empty sequence - - - create a set containing one object - - - create a set containing a vector of objects. - - - BER TaggedObject - in ASN.1 notation this is any object preceded by - a [n] where n is some number - these are assumed to follow the construction - rules (as with sequences). - - - @param tagNo the tag number for this object. - @param obj the tagged object. - - - @param explicitly true if an explicitly tagged object. - @param tagNo the tag number for this object. - @param obj the tagged object. - - - create an implicitly tagged object that contains a zero - length sequence. - - - See https://www.bsi.bund.de/cae/servlet/contentblob/471398/publicationFile/30615/BSI-TR-03111_pdf.pdf - - - 0.4.0.127.0.7.1 - - - ElGamal Elliptic Curve Key Agreement and Key Derivation according to X963 OID: 0.4.0.127.0.7.1.1.5.1.1 - - - ElGamal Elliptic Curve Key Agreement and Key Derivation according to X963 - with hash function SHA-1 - OID: 0.4.0.127.0.7.1.1.5.1.1.1 - - - ElGamal Elliptic Curve Key Agreement and Key Derivation according to X963 - with hash function SHA224 - OID: 0.4.0.127.0.7.1.1.5.1.1.2 - - - ElGamal Elliptic Curve Key Agreement and Key Derivation according to X963 - with hash function SHA256 - OID: 0.4.0.127.0.7.1.1.5.1.1.3 - - - ElGamal Elliptic Curve Key Agreement and Key Derivation according to X963 - with hash function SHA384 - OID: 0.4.0.127.0.7.1.1.5.1.1.4 - - - ElGamal Elliptic Curve Key Agreement and Key Derivation according to X963 - with hash function SHA512 - OID: 0.4.0.127.0.7.1.1.5.1.1.5 - - - ElGamal Elliptic Curve Key Agreement and Key Derivation according to X963 - with hash function RIPEMD160 - OID: 0.4.0.127.0.7.1.1.5.1.1.6 - - - Key Derivation Function for Session Keys - - -
-            CAKeyUpdAnnContent ::= SEQUENCE {
-                                        oldWithNew   CmpCertificate, -- old pub signed with new priv
-                                        newWithOld   CmpCertificate, -- new pub signed with old priv
-                                        newWithNew   CmpCertificate  -- new pub signed with new priv
-             }
-            
- @return a basic ASN.1 object representation. -
- -
-            CertConfirmContent ::= SEQUENCE OF CertStatus
-            
- @return a basic ASN.1 object representation. -
- -
-            CertifiedKeyPair ::= SEQUENCE {
-                                             certOrEncCert       CertOrEncCert,
-                                             privateKey      [0] EncryptedValue      OPTIONAL,
-                                             -- see [CRMF] for comment on encoding
-                                             publicationInfo [1] PKIPublicationInfo  OPTIONAL
-                  }
-            
- @return a basic ASN.1 object representation. -
- -
-            CertOrEncCert ::= CHOICE {
-                                 certificate     [0] CMPCertificate,
-                                 encryptedCert   [1] EncryptedValue
-                      }
-            
- @return a basic ASN.1 object representation. -
- -
-            CertRepMessage ::= SEQUENCE {
-                                     caPubs       [1] SEQUENCE SIZE (1..MAX) OF CMPCertificate
-                                                                                        OPTIONAL,
-                                     response         SEQUENCE OF CertResponse
-            }
-            
- @return a basic ASN.1 object representation. -
- -
-            CertResponse ::= SEQUENCE {
-                                       certReqId           INTEGER,
-                                       -- to match this response with corresponding request (a value
-                                       -- of -1 is to be used if certReqId is not specified in the
-                                       -- corresponding request)
-                                       status              PKIStatusInfo,
-                                       certifiedKeyPair    CertifiedKeyPair    OPTIONAL,
-                                       rspInfo             OCTET STRING        OPTIONAL
-                                       -- analogous to the id-regInfo-utf8Pairs string defined
-                                       -- for regInfo in CertReqMsg [CRMF]
-                        }
-            
- @return a basic ASN.1 object representation. -
- -
-            CertStatus ::= SEQUENCE {
-                              certHash    OCTET STRING,
-                              -- the hash of the certificate, using the same hash algorithm
-                              -- as is used to create and verify the certificate signature
-                              certReqId   INTEGER,
-                              -- to match this confirmation with the corresponding req/rep
-                              statusInfo  PKIStatusInfo OPTIONAL
-            }
-            
- @return a basic ASN.1 object representation. -
- -
-             Challenge ::= SEQUENCE {
-                             owf                 AlgorithmIdentifier  OPTIONAL,
-            
-                             -- MUST be present in the first Challenge; MAY be omitted in
-                             -- any subsequent Challenge in POPODecKeyChallContent (if
-                             -- omitted, then the owf used in the immediately preceding
-                             -- Challenge is to be used).
-            
-                             witness             OCTET STRING,
-                             -- the result of applying the one-way function (owf) to a
-                             -- randomly-generated INTEGER, A.  [Note that a different
-                             -- INTEGER MUST be used for each Challenge.]
-                             challenge           OCTET STRING
-                             -- the encryption (under the public key for which the cert.
-                             -- request is being made) of Rand, where Rand is specified as
-                             --   Rand ::= SEQUENCE {
-                             --      int      INTEGER,
-                             --       - the randomly-generated INTEGER A (above)
-                             --      sender   GeneralName
-                             --       - the sender's name (as included in PKIHeader)
-                             --   }
-                  }
-             
- @return a basic ASN.1 object representation. -
- - Note: the addition of attribute certificates is a BC extension. - - -
-             CMPCertificate ::= CHOICE {
-                        x509v3PKCert        Certificate
-                        x509v2AttrCert      [1] AttributeCertificate
-              }
-             
- Note: the addition of attribute certificates is a BC extension. - - @return a basic ASN.1 object representation. -
- -
-            CrlAnnContent ::= SEQUENCE OF CertificateList
-            
- @return a basic ASN.1 object representation. -
- -
-            ErrorMsgContent ::= SEQUENCE {
-                                   pKIStatusInfo          PKIStatusInfo,
-                                   errorCode              INTEGER           OPTIONAL,
-                                   -- implementation-specific error codes
-                                   errorDetails           PKIFreeText       OPTIONAL
-                                   -- implementation-specific error details
-            }
-            
- @return a basic ASN.1 object representation. -
- -
-            GenMsgContent ::= SEQUENCE OF InfoTypeAndValue
-            
- @return a basic ASN.1 object representation. -
- -
-            GenRepContent ::= SEQUENCE OF InfoTypeAndValue
-            
- @return a basic ASN.1 object representation. -
- - Example InfoTypeAndValue contents include, but are not limited - to, the following (un-comment in this ASN.1 module and use as - appropriate for a given environment): -
-               id-it-caProtEncCert    OBJECT IDENTIFIER ::= {id-it 1}
-                  CAProtEncCertValue      ::= CMPCertificate
-               id-it-signKeyPairTypes OBJECT IDENTIFIER ::= {id-it 2}
-                 SignKeyPairTypesValue   ::= SEQUENCE OF AlgorithmIdentifier
-               id-it-encKeyPairTypes  OBJECT IDENTIFIER ::= {id-it 3}
-                 EncKeyPairTypesValue    ::= SEQUENCE OF AlgorithmIdentifier
-               id-it-preferredSymmAlg OBJECT IDENTIFIER ::= {id-it 4}
-                  PreferredSymmAlgValue   ::= AlgorithmIdentifier
-               id-it-caKeyUpdateInfo  OBJECT IDENTIFIER ::= {id-it 5}
-                  CAKeyUpdateInfoValue    ::= CAKeyUpdAnnContent
-               id-it-currentCRL       OBJECT IDENTIFIER ::= {id-it 6}
-                  CurrentCRLValue         ::= CertificateList
-               id-it-unsupportedOIDs  OBJECT IDENTIFIER ::= {id-it 7}
-                  UnsupportedOIDsValue    ::= SEQUENCE OF OBJECT IDENTIFIER
-               id-it-keyPairParamReq  OBJECT IDENTIFIER ::= {id-it 10}
-                  KeyPairParamReqValue    ::= OBJECT IDENTIFIER
-               id-it-keyPairParamRep  OBJECT IDENTIFIER ::= {id-it 11}
-                  KeyPairParamRepValue    ::= AlgorithmIdentifer
-               id-it-revPassphrase    OBJECT IDENTIFIER ::= {id-it 12}
-                  RevPassphraseValue      ::= EncryptedValue
-               id-it-implicitConfirm  OBJECT IDENTIFIER ::= {id-it 13}
-                  ImplicitConfirmValue    ::= NULL
-               id-it-confirmWaitTime  OBJECT IDENTIFIER ::= {id-it 14}
-                  ConfirmWaitTimeValue    ::= GeneralizedTime
-               id-it-origPKIMessage   OBJECT IDENTIFIER ::= {id-it 15}
-                  OrigPKIMessageValue     ::= PKIMessages
-               id-it-suppLangTags     OBJECT IDENTIFIER ::= {id-it 16}
-                  SuppLangTagsValue       ::= SEQUENCE OF UTF8String
-            
-             where
-            
-               id-pkix OBJECT IDENTIFIER ::= {
-                  iso(1) identified-organization(3)
-                  dod(6) internet(1) security(5) mechanisms(5) pkix(7)}
-             and
-                  id-it   OBJECT IDENTIFIER ::= {id-pkix 4}
-             
-
- -
-            InfoTypeAndValue ::= SEQUENCE {
-                                    infoType               OBJECT IDENTIFIER,
-                                    infoValue              ANY DEFINED BY infoType  OPTIONAL
-            }
-            
- @return a basic ASN.1 object representation. -
- -
-            KeyRecRepContent ::= SEQUENCE {
-                                    status                  PKIStatusInfo,
-                                    newSigCert          [0] CMPCertificate OPTIONAL,
-                                    caCerts             [1] SEQUENCE SIZE (1..MAX) OF
-                                                                      CMPCertificate OPTIONAL,
-                                    keyPairHist         [2] SEQUENCE SIZE (1..MAX) OF
-                                                                      CertifiedKeyPair OPTIONAL
-                         }
-            
- @return a basic ASN.1 object representation. -
- -
-            OobCertHash ::= SEQUENCE {
-                                 hashAlg     [0] AlgorithmIdentifier     OPTIONAL,
-                                 certId      [1] CertId                  OPTIONAL,
-                                 hashVal         BIT STRING
-                                 -- hashVal is calculated over the Der encoding of the
-                                 -- self-signed certificate with the identifier certID.
-                  }
-            
- @return a basic ASN.1 object representation. -
- -
-             PbmParameter ::= SEQUENCE {
-                                   salt                OCTET STRING,
-                                   -- note:  implementations MAY wish to limit acceptable sizes
-                                   -- of this string to values appropriate for their environment
-                                   -- in order to reduce the risk of denial-of-service attacks
-                                   owf                 AlgorithmIdentifier,
-                                   -- AlgId for a One-Way Function (SHA-1 recommended)
-                                   iterationCount      INTEGER,
-                                   -- number of times the OWF is applied
-                                   -- note:  implementations MAY wish to limit acceptable sizes
-                                   -- of this integer to values appropriate for their environment
-                                   -- in order to reduce the risk of denial-of-service attacks
-                                   mac                 AlgorithmIdentifier
-                                   -- the MAC AlgId (e.g., DES-MAC, Triple-DES-MAC [PKCS11],
-               }   -- or HMAC [RFC2104, RFC2202])
-            
- @return a basic ASN.1 object representation. -
- - Creates a new PkiBody. - @param type one of the TYPE_* constants - @param content message content - - -
-            PkiBody ::= CHOICE {       -- message-specific body elements
-                   ir       [0]  CertReqMessages,        --Initialization Request
-                   ip       [1]  CertRepMessage,         --Initialization Response
-                   cr       [2]  CertReqMessages,        --Certification Request
-                   cp       [3]  CertRepMessage,         --Certification Response
-                   p10cr    [4]  CertificationRequest,   --imported from [PKCS10]
-                   popdecc  [5]  POPODecKeyChallContent, --pop Challenge
-                   popdecr  [6]  POPODecKeyRespContent,  --pop Response
-                   kur      [7]  CertReqMessages,        --Key Update Request
-                   kup      [8]  CertRepMessage,         --Key Update Response
-                   krr      [9]  CertReqMessages,        --Key Recovery Request
-                   krp      [10] KeyRecRepContent,       --Key Recovery Response
-                   rr       [11] RevReqContent,          --Revocation Request
-                   rp       [12] RevRepContent,          --Revocation Response
-                   ccr      [13] CertReqMessages,        --Cross-Cert. Request
-                   ccp      [14] CertRepMessage,         --Cross-Cert. Response
-                   ckuann   [15] CAKeyUpdAnnContent,     --CA Key Update Ann.
-                   cann     [16] CertAnnContent,         --Certificate Ann.
-                   rann     [17] RevAnnContent,          --Revocation Ann.
-                   crlann   [18] CRLAnnContent,          --CRL Announcement
-                   pkiconf  [19] PKIConfirmContent,      --Confirmation
-                   nested   [20] NestedMessageContent,   --Nested Message
-                   genm     [21] GenMsgContent,          --General Message
-                   genp     [22] GenRepContent,          --General Response
-                   error    [23] ErrorMsgContent,        --Error Message
-                   certConf [24] CertConfirmContent,     --Certificate confirm
-                   pollReq  [25] PollReqContent,         --Polling request
-                   pollRep  [26] PollRepContent          --Polling response
-            }
-            
- @return a basic ASN.1 object representation. -
- -
-            PkiConfirmContent ::= NULL
-            
- @return a basic ASN.1 object representation. -
- -
-            PKIFailureInfo ::= BIT STRING {
-            badAlg               (0),
-              -- unrecognized or unsupported Algorithm Identifier
-            badMessageCheck      (1), -- integrity check failed (e.g., signature did not verify)
-            badRequest           (2),
-              -- transaction not permitted or supported
-            badTime              (3), -- messageTime was not sufficiently close to the system time, as defined by local policy
-            badCertId            (4), -- no certificate could be found matching the provided criteria
-            badDataFormat        (5),
-              -- the data submitted has the wrong format
-            wrongAuthority       (6), -- the authority indicated in the request is different from the one creating the response token
-            incorrectData        (7), -- the requester's data is incorrect (for notary services)
-            missingTimeStamp     (8), -- when the timestamp is missing but should be there (by policy)
-            badPOP               (9)  -- the proof-of-possession failed
-            certRevoked         (10),
-            certConfirmed       (11),
-            wrongIntegrity      (12),
-            badRecipientNonce   (13), 
-            timeNotAvailable    (14),
-              -- the TSA's time source is not available
-            unacceptedPolicy    (15),
-              -- the requested TSA policy is not supported by the TSA
-            unacceptedExtension (16),
-              -- the requested extension is not supported by the TSA
-            addInfoNotAvailable (17)
-              -- the additional information requested could not be understood
-              -- or is not available
-            badSenderNonce      (18),
-            badCertTemplate     (19),
-            signerNotTrusted    (20),
-            transactionIdInUse  (21),
-            unsupportedVersion  (22),
-            notAuthorized       (23),
-            systemUnavail       (24),    
-            systemFailure       (25),
-              -- the request cannot be handled due to system failure
-            duplicateCertReq    (26) 
-            
-
- - Basic constructor. - - - Return the number of string elements present. - - @return number of elements present. - - - Return the UTF8STRING at index. - - @param index index of the string of interest - @return the string at index. - - -
-            PkiFreeText ::= SEQUENCE SIZE (1..MAX) OF UTF8String
-            
-
- - Value for a "null" recipient or sender. - - -
-             PkiHeader ::= SEQUENCE {
-                       pvno                INTEGER     { cmp1999(1), cmp2000(2) },
-                       sender              GeneralName,
-                       -- identifies the sender
-                       recipient           GeneralName,
-                       -- identifies the intended recipient
-                       messageTime     [0] GeneralizedTime         OPTIONAL,
-                       -- time of production of this message (used when sender
-                       -- believes that the transport will be "suitable"; i.e.,
-                       -- that the time will still be meaningful upon receipt)
-                       protectionAlg   [1] AlgorithmIdentifier     OPTIONAL,
-                       -- algorithm used for calculation of protection bits
-                       senderKID       [2] KeyIdentifier           OPTIONAL,
-                       recipKID        [3] KeyIdentifier           OPTIONAL,
-                       -- to identify specific keys used for protection
-                       transactionID   [4] OCTET STRING            OPTIONAL,
-                       -- identifies the transaction; i.e., this will be the same in
-                       -- corresponding request, response, certConf, and PKIConf
-                       -- messages
-                       senderNonce     [5] OCTET STRING            OPTIONAL,
-                       recipNonce      [6] OCTET STRING            OPTIONAL,
-                       -- nonces used to provide replay protection, senderNonce
-                       -- is inserted by the creator of this message; recipNonce
-                       -- is a nonce previously inserted in a related message by
-                       -- the intended recipient of this message
-                       freeText        [7] PKIFreeText             OPTIONAL,
-                       -- this may be used to indicate context-specific instructions
-                       -- (this field is intended for human consumption)
-                       generalInfo     [8] SEQUENCE SIZE (1..MAX) OF
-                                            InfoTypeAndValue     OPTIONAL
-                       -- this may be used to convey context-specific information
-                       -- (this field not primarily intended for human consumption)
-            }
-            
- @return a basic ASN.1 object representation. -
- -
-             PKIHeader ::= SEQUENCE {
-                       pvno                INTEGER     { cmp1999(1), cmp2000(2) },
-                       sender              GeneralName,
-                       -- identifies the sender
-                       recipient           GeneralName,
-                       -- identifies the intended recipient
-                       messageTime     [0] GeneralizedTime         OPTIONAL,
-                       -- time of production of this message (used when sender
-                       -- believes that the transport will be "suitable"; i.e.,
-                       -- that the time will still be meaningful upon receipt)
-                       protectionAlg   [1] AlgorithmIdentifier     OPTIONAL,
-                       -- algorithm used for calculation of protection bits
-                       senderKID       [2] KeyIdentifier           OPTIONAL,
-                       recipKID        [3] KeyIdentifier           OPTIONAL,
-                       -- to identify specific keys used for protection
-                       transactionID   [4] OCTET STRING            OPTIONAL,
-                       -- identifies the transaction; i.e., this will be the same in
-                       -- corresponding request, response, certConf, and PKIConf
-                       -- messages
-                       senderNonce     [5] OCTET STRING            OPTIONAL,
-                       recipNonce      [6] OCTET STRING            OPTIONAL,
-                       -- nonces used to provide replay protection, senderNonce
-                       -- is inserted by the creator of this message; recipNonce
-                       -- is a nonce previously inserted in a related message by
-                       -- the intended recipient of this message
-                       freeText        [7] PKIFreeText             OPTIONAL,
-                       -- this may be used to indicate context-specific instructions
-                       -- (this field is intended for human consumption)
-                       generalInfo     [8] SEQUENCE SIZE (1..MAX) OF
-                                            InfoTypeAndValue     OPTIONAL
-                       -- this may be used to convey context-specific information
-                       -- (this field not primarily intended for human consumption)
-            }
-            
- @return a basic ASN.1 object representation. -
- - Creates a new PkiMessage. - - @param header message header - @param body message body - @param protection message protection (may be null) - @param extraCerts extra certificates (may be null) - - -
-            PkiMessage ::= SEQUENCE {
-                             header           PKIHeader,
-                             body             PKIBody,
-                             protection   [0] PKIProtection OPTIONAL,
-                             extraCerts   [1] SEQUENCE SIZE (1..MAX) OF CMPCertificate
-                                                                                OPTIONAL
-            }
-            
- @return a basic ASN.1 object representation. -
- -
-            PkiMessages ::= SEQUENCE SIZE (1..MAX) OF PkiMessage
-            
- @return a basic ASN.1 object representation. -
- - @param status - - - @param status - @param statusString - - -
-             PkiStatusInfo ::= SEQUENCE {
-                 status        PKIStatus,                (INTEGER)
-                 statusString  PkiFreeText     OPTIONAL,
-                 failInfo      PkiFailureInfo  OPTIONAL  (BIT STRING)
-             }
-            
-             PKIStatus:
-               granted                (0), -- you got exactly what you asked for
-               grantedWithMods        (1), -- you got something like what you asked for
-               rejection              (2), -- you don't get it, more information elsewhere in the message
-               waiting                (3), -- the request body part has not yet been processed, expect to hear more later
-               revocationWarning      (4), -- this message contains a warning that a revocation is imminent
-               revocationNotification (5), -- notification that a revocation has occurred
-               keyUpdateWarning       (6)  -- update already done for the oldCertId specified in CertReqMsg
-            
-             PkiFailureInfo:
-               badAlg           (0), -- unrecognized or unsupported Algorithm Identifier
-               badMessageCheck  (1), -- integrity check failed (e.g., signature did not verify)
-               badRequest       (2), -- transaction not permitted or supported
-               badTime          (3), -- messageTime was not sufficiently close to the system time, as defined by local policy
-               badCertId        (4), -- no certificate could be found matching the provided criteria
-               badDataFormat    (5), -- the data submitted has the wrong format
-               wrongAuthority   (6), -- the authority indicated in the request is different from the one creating the response token
-               incorrectData    (7), -- the requester's data is incorrect (for notary services)
-               missingTimeStamp (8), -- when the timestamp is missing but should be there (by policy)
-               badPOP           (9)  -- the proof-of-possession failed
-            
-             
-
- -
-            PollRepContent ::= SEQUENCE OF SEQUENCE {
-                    certReqId              INTEGER,
-                    checkAfter             INTEGER,  -- time in seconds
-                    reason                 PKIFreeText OPTIONAL
-                }
-            
- @return a basic ASN.1 object representation. -
- -
-            PollReqContent ::= SEQUENCE OF SEQUENCE {
-                                   certReqId              INTEGER
-            }
-            
- @return a basic ASN.1 object representation. -
- -
-            PopoDecKeyChallContent ::= SEQUENCE OF Challenge
-            
- @return a basic ASN.1 object representation. -
- -
-            PopoDecKeyRespContent ::= SEQUENCE OF INTEGER
-            
- @return a basic ASN.1 object representation. -
- -
-            ProtectedPart ::= SEQUENCE {
-                               header    PKIHeader,
-                               body      PKIBody
-            }
-            
- @return a basic ASN.1 object representation. -
- -
-            RevAnnContent ::= SEQUENCE {
-                  status              PKIStatus,
-                  certId              CertId,
-                  willBeRevokedAt     GeneralizedTime,
-                  badSinceDate        GeneralizedTime,
-                  crlDetails          Extensions  OPTIONAL
-                   -- extra CRL details (e.g., crl number, reason, location, etc.)
-            }
-            
- @return a basic ASN.1 object representation. -
- -
-            RevDetails ::= SEQUENCE {
-                             certDetails         CertTemplate,
-                              -- allows requester to specify as much as they can about
-                              -- the cert. for which revocation is requested
-                              -- (e.g., for cases in which serialNumber is not available)
-                              crlEntryDetails     Extensions       OPTIONAL
-                              -- requested crlEntryExtensions
-                        }
-            
- @return a basic ASN.1 object representation. -
- -
-            RevRepContent ::= SEQUENCE {
-                   status       SEQUENCE SIZE (1..MAX) OF PKIStatusInfo,
-                   -- in same order as was sent in RevReqContent
-                   revCerts [0] SEQUENCE SIZE (1..MAX) OF CertId OPTIONAL,
-                   -- IDs for which revocation was requested
-                   -- (same order as status)
-                   crls     [1] SEQUENCE SIZE (1..MAX) OF CertificateList OPTIONAL
-                   -- the resulting CRLs (there may be more than one)
-              }
-            
- @return a basic ASN.1 object representation. -
- -
-            RevReqContent ::= SEQUENCE OF RevDetails
-            
- @return a basic ASN.1 object representation. -
- - return an Attribute object from the given object. - - @param o the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-            Attribute ::= SEQUENCE {
-                attrType OBJECT IDENTIFIER,
-                attrValues SET OF AttributeValue
-            }
-            
-
- -
-            Attributes ::=
-              SET SIZE(1..MAX) OF Attribute -- according to RFC 5652
-            
- @return -
- - Return the first attribute matching the given OBJECT IDENTIFIER - - - Return all the attributes matching the OBJECT IDENTIFIER oid. The vector will be - empty if there are no attributes of the required type present. - - @param oid type of attribute required. - @return a vector of all the attributes found of type oid. - - - Return a new table with the passed in attribute added. - - @param attrType - @param attrValue - @return - - - return an AuthenticatedData object from a tagged object. - - @param obj the tagged object holding the object we want. - @param isExplicit true if the object is meant to be explicitly - tagged false otherwise. - @throws ArgumentException if the object held by the - tagged object cannot be converted. - - - return an AuthenticatedData object from the given object. - - @param obj the object we want converted. - @throws ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-             AuthenticatedData ::= SEQUENCE {
-                   version CMSVersion,
-                   originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
-                   recipientInfos RecipientInfos,
-                   macAlgorithm MessageAuthenticationCodeAlgorithm,
-                   digestAlgorithm [1] DigestAlgorithmIdentifier OPTIONAL,
-                   encapContentInfo EncapsulatedContentInfo,
-                   authAttrs [2] IMPLICIT AuthAttributes OPTIONAL,
-                   mac MessageAuthenticationCode,
-                   unauthAttrs [3] IMPLICIT UnauthAttributes OPTIONAL }
-            
-             AuthAttributes ::= SET SIZE (1..MAX) OF Attribute
-            
-             UnauthAttributes ::= SET SIZE (1..MAX) OF Attribute
-            
-             MessageAuthenticationCode ::= OCTET STRING
-             
-
- - Produce an object suitable for an Asn1OutputStream. -
-             AuthenticatedData ::= SEQUENCE {
-                   version CMSVersion,
-                   originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
-                   recipientInfos RecipientInfos,
-                   macAlgorithm MessageAuthenticationCodeAlgorithm,
-                   digestAlgorithm [1] DigestAlgorithmIdentifier OPTIONAL,
-                   encapContentInfo EncapsulatedContentInfo,
-                   authAttrs [2] IMPLICIT AuthAttributes OPTIONAL,
-                   mac MessageAuthenticationCode,
-                   unauthAttrs [3] IMPLICIT UnauthAttributes OPTIONAL }
-            
-             AuthAttributes ::= SET SIZE (1..MAX) OF Attribute
-            
-             UnauthAttributes ::= SET SIZE (1..MAX) OF Attribute
-            
-             MessageAuthenticationCode ::= OCTET STRING
-             
-
- - return an AuthEnvelopedData object from a tagged object. - - @param obj the tagged object holding the object we want. - @param isExplicit true if the object is meant to be explicitly - tagged false otherwise. - @throws ArgumentException if the object held by the - tagged object cannot be converted. - - - return an AuthEnvelopedData object from the given object. - - @param obj the object we want converted. - @throws ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-            AuthEnvelopedData ::= SEQUENCE {
-              version CMSVersion,
-              originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
-              recipientInfos RecipientInfos,
-              authEncryptedContentInfo EncryptedContentInfo,
-              authAttrs [1] IMPLICIT AuthAttributes OPTIONAL,
-              mac MessageAuthenticationCode,
-              unauthAttrs [2] IMPLICIT UnauthAttributes OPTIONAL }
-            
-
- - Produce an object suitable for an Asn1OutputStream. - -
-            AuthEnvelopedData ::= SEQUENCE {
-              version CMSVersion,
-              originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
-              recipientInfos RecipientInfos,
-              authEncryptedContentInfo EncryptedContentInfo,
-              authAttrs [1] IMPLICIT AuthAttributes OPTIONAL,
-              mac MessageAuthenticationCode,
-              unauthAttrs [2] IMPLICIT UnauthAttributes OPTIONAL }
-            
-
- - The other Revocation Info arc - id-ri OBJECT IDENTIFIER ::= { iso(1) identified-organization(3) - dod(6) internet(1) security(5) mechanisms(5) pkix(7) ri(16) } - - - RFC 3274 - CMS Compressed Data. -
-            CompressedData ::= Sequence {
-             version CMSVersion,
-             compressionAlgorithm CompressionAlgorithmIdentifier,
-             encapContentInfo EncapsulatedContentInfo
-            }
-            
-
- - return a CompressedData object from a tagged object. - - @param ato the tagged object holding the object we want. - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the object held by the - tagged object cannot be converted. - - - return a CompressedData object from the given object. - - @param _obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - RFC 3274 - CMS Compressed Data. -
-            CompressedData ::= SEQUENCE {
-             version CMSVersion,
-             compressionAlgorithm CompressionAlgorithmIdentifier,
-             encapContentInfo EncapsulatedContentInfo
-            }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-            ContentInfo ::= Sequence {
-                     contentType ContentType,
-                     content
-                     [0] EXPLICIT ANY DEFINED BY contentType OPTIONAL }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-            ContentInfo ::= SEQUENCE {
-                     contentType ContentType,
-                     content
-                     [0] EXPLICIT ANY DEFINED BY contentType OPTIONAL }
-            
-
- - return an AuthEnvelopedData object from a tagged object. - - @param obj the tagged object holding the object we want. - @param isExplicit true if the object is meant to be explicitly - tagged false otherwise. - @throws ArgumentException if the object held by the - tagged object cannot be converted. - - - return an AuthEnvelopedData object from the given object. - - @param obj the object we want converted. - @throws ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-            MQVuserKeyingMaterial ::= SEQUENCE {
-              ephemeralPublicKey OriginatorPublicKey,
-              addedukm [0] EXPLICIT UserKeyingMaterial OPTIONAL  }
-            
-
- - return an EncryptedContentInfo object from the given object. - - @param obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-            EncryptedContentInfo ::= Sequence {
-                contentType ContentType,
-                contentEncryptionAlgorithm ContentEncryptionAlgorithmIdentifier,
-                encryptedContent [0] IMPLICIT EncryptedContent OPTIONAL
-            }
-            
-
- -
-            EncryptedContentInfo ::= SEQUENCE {
-                contentType ContentType,
-                contentEncryptionAlgorithm ContentEncryptionAlgorithmIdentifier,
-                encryptedContent [0] IMPLICIT EncryptedContent OPTIONAL
-            }
-            
-
- -
-                  EncryptedData ::= SEQUENCE {
-                                version CMSVersion,
-                                encryptedContentInfo EncryptedContentInfo,
-                                unprotectedAttrs [1] IMPLICIT UnprotectedAttributes OPTIONAL }
-            
- @return a basic ASN.1 object representation. -
- - return an EnvelopedData object from a tagged object. - - @param obj the tagged object holding the object we want. - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the object held by the - tagged object cannot be converted. - - - return an EnvelopedData object from the given object. - - @param obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-            EnvelopedData ::= Sequence {
-                version CMSVersion,
-                originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
-                recipientInfos RecipientInfos,
-                encryptedContentInfo EncryptedContentInfo,
-                unprotectedAttrs [1] IMPLICIT UnprotectedAttributes OPTIONAL
-            }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-            EnvelopedData ::= SEQUENCE {
-                version CMSVersion,
-                originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
-                recipientInfos RecipientInfos,
-                encryptedContentInfo EncryptedContentInfo,
-                unprotectedAttrs [1] IMPLICIT UnprotectedAttributes OPTIONAL
-            }
-            
-
- - return a KekIdentifier object from a tagged object. - - @param obj the tagged object holding the object we want. - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the object held by the - tagged object cannot be converted. - - - return a KekIdentifier object from the given object. - - @param obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-            KekIdentifier ::= Sequence {
-                keyIdentifier OCTET STRING,
-                date GeneralizedTime OPTIONAL,
-                other OtherKeyAttribute OPTIONAL
-            }
-            
-
- - return a KekRecipientInfo object from a tagged object. - - @param obj the tagged object holding the object we want. - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the object held by the - tagged object cannot be converted. - - - return a KekRecipientInfo object from the given object. - - @param obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-            KekRecipientInfo ::= Sequence {
-                version CMSVersion,  -- always set to 4
-                kekID KekIdentifier,
-                keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
-                encryptedKey EncryptedKey
-            }
-            
-
- - return an KeyAgreeRecipientIdentifier object from a tagged object. - - @param obj the tagged object holding the object we want. - @param isExplicit true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the object held by the - tagged object cannot be converted. - - - return an KeyAgreeRecipientIdentifier object from the given object. - - @param obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-            KeyAgreeRecipientIdentifier ::= CHOICE {
-                issuerAndSerialNumber IssuerAndSerialNumber,
-                rKeyId [0] IMPLICIT RecipientKeyIdentifier
-            }
-            
-
- - return a KeyAgreeRecipientInfo object from a tagged object. - - @param obj the tagged object holding the object we want. - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the object held by the - tagged object cannot be converted. - - - return a KeyAgreeRecipientInfo object from the given object. - - @param obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - * Produce an object suitable for an Asn1OutputStream. - *
-                     * KeyAgreeRecipientInfo ::= Sequence {
-                     *     version CMSVersion,  -- always set to 3
-                     *     originator [0] EXPLICIT OriginatorIdentifierOrKey,
-                     *     ukm [1] EXPLICIT UserKeyingMaterial OPTIONAL,
-                     *     keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
-                     *     recipientEncryptedKeys RecipientEncryptedKeys
-                     * }
-            		 *
-            		 * UserKeyingMaterial ::= OCTET STRING
-                     * 
-
- - return a KeyTransRecipientInfo object from the given object. - - @param obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-            KeyTransRecipientInfo ::= Sequence {
-                version CMSVersion,  -- always set to 0 or 2
-                rid RecipientIdentifier,
-                keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
-                encryptedKey EncryptedKey
-            }
-            
-
- -
-            MetaData ::= SEQUENCE {
-              hashProtected        BOOLEAN,
-              fileName             UTF8String OPTIONAL,
-              mediaType            IA5String OPTIONAL,
-              otherMetaData        Attributes OPTIONAL
-            }
-            
- @return -
- - return an OriginatorIdentifierOrKey object from a tagged object. - - @param o the tagged object holding the object we want. - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the object held by the - tagged object cannot be converted. - - - return an OriginatorIdentifierOrKey object from the given object. - - @param o the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-             OriginatorIdentifierOrKey ::= CHOICE {
-                 issuerAndSerialNumber IssuerAndSerialNumber,
-                 subjectKeyIdentifier [0] SubjectKeyIdentifier,
-                 originatorKey [1] OriginatorPublicKey
-             }
-            
-             SubjectKeyIdentifier ::= OCTET STRING
-             
-
- - return an OriginatorInfo object from a tagged object. - - @param obj the tagged object holding the object we want. - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the object held by the - tagged object cannot be converted. - - - return an OriginatorInfo object from the given object. - - @param obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-            OriginatorInfo ::= Sequence {
-                certs [0] IMPLICIT CertificateSet OPTIONAL,
-                crls [1] IMPLICIT CertificateRevocationLists OPTIONAL
-            }
-            
-
- - return an OriginatorPublicKey object from a tagged object. - - @param obj the tagged object holding the object we want. - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the object held by the - tagged object cannot be converted. - - - return an OriginatorPublicKey object from the given object. - - @param obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-            OriginatorPublicKey ::= Sequence {
-                algorithm AlgorithmIdentifier,
-                publicKey BIT STRING
-            }
-            
-
- - return an OtherKeyAttribute object from the given object. - - @param o the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-            OtherKeyAttribute ::= Sequence {
-                keyAttrId OBJECT IDENTIFIER,
-                keyAttr ANY DEFINED BY keyAttrId OPTIONAL
-            }
-            
-
- - return a OtherRecipientInfo object from a tagged object. - - @param obj the tagged object holding the object we want. - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the object held by the - tagged object cannot be converted. - - - return a OtherRecipientInfo object from the given object. - - @param obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-            OtherRecipientInfo ::= Sequence {
-               oriType OBJECT IDENTIFIER,
-               oriValue ANY DEFINED BY oriType }
-            
-
- - return a OtherRevocationInfoFormat object from a tagged object. - - @param obj the tagged object holding the object we want. - @param explicit true if the object is meant to be explicitly - tagged false otherwise. - @exception IllegalArgumentException if the object held by the - tagged object cannot be converted. - - - return a OtherRevocationInfoFormat object from the given object. - - @param obj the object we want converted. - @exception IllegalArgumentException if the object cannot be converted. - - - Produce an object suitable for an ASN1OutputStream. -
-            OtherRevocationInfoFormat ::= SEQUENCE {
-                 otherRevInfoFormat OBJECT IDENTIFIER,
-                 otherRevInfo ANY DEFINED BY otherRevInfoFormat }
-            
-
- - return a PasswordRecipientInfo object from a tagged object. - - @param obj the tagged object holding the object we want. - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the object held by the - tagged object cannot be converted. - - - return a PasswordRecipientInfo object from the given object. - - @param obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-            PasswordRecipientInfo ::= Sequence {
-              version CMSVersion,   -- Always set to 0
-              keyDerivationAlgorithm [0] KeyDerivationAlgorithmIdentifier
-                                        OPTIONAL,
-             keyEncryptionAlgorithm KeyEncryptionAlgorithmIdentifier,
-             encryptedKey EncryptedKey }
-            
-
- - return an RecipientEncryptedKey object from a tagged object. - - @param obj the tagged object holding the object we want. - @param isExplicit true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the object held by the - tagged object cannot be converted. - - - return a RecipientEncryptedKey object from the given object. - - @param obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-            RecipientEncryptedKey ::= SEQUENCE {
-                rid KeyAgreeRecipientIdentifier,
-                encryptedKey EncryptedKey
-            }
-            
-
- - return a RecipientIdentifier object from the given object. - - @param o the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-             RecipientIdentifier ::= CHOICE {
-                 issuerAndSerialNumber IssuerAndSerialNumber,
-                 subjectKeyIdentifier [0] SubjectKeyIdentifier
-             }
-            
-             SubjectKeyIdentifier ::= OCTET STRING
-             
-
- - Produce an object suitable for an Asn1OutputStream. -
-            RecipientInfo ::= CHOICE {
-                ktri KeyTransRecipientInfo,
-                kari [1] KeyAgreeRecipientInfo,
-                kekri [2] KekRecipientInfo,
-                pwri [3] PasswordRecipientInfo,
-                ori [4] OtherRecipientInfo }
-            
-
- - return a RecipientKeyIdentifier object from a tagged object. - - @param _ato the tagged object holding the object we want. - @param _explicit true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the object held by the - tagged object cannot be converted. - - - return a RecipientKeyIdentifier object from the given object. - - @param _obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-             RecipientKeyIdentifier ::= Sequence {
-                 subjectKeyIdentifier SubjectKeyIdentifier,
-                 date GeneralizedTime OPTIONAL,
-                 other OtherKeyAttribute OPTIONAL
-             }
-            
-             SubjectKeyIdentifier ::= OCTET STRING
-             
-
- -
-               ScvpReqRes ::= SEQUENCE {
-               request  [0] EXPLICIT ContentInfo OPTIONAL,
-               response     ContentInfo }
-            
- @return the ASN.1 primitive representation. -
- - a signed data object. - - - Produce an object suitable for an Asn1OutputStream. -
-            SignedData ::= Sequence {
-                version CMSVersion,
-                digestAlgorithms DigestAlgorithmIdentifiers,
-                encapContentInfo EncapsulatedContentInfo,
-                certificates [0] IMPLICIT CertificateSet OPTIONAL,
-                crls [1] IMPLICIT CertificateRevocationLists OPTIONAL,
-                signerInfos SignerInfos
-              }
-            
-
- -
-            SignedData ::= SEQUENCE {
-                version CMSVersion,
-                digestAlgorithms DigestAlgorithmIdentifiers,
-                encapContentInfo EncapsulatedContentInfo,
-                certificates [0] IMPLICIT CertificateSet OPTIONAL,
-                crls [1] IMPLICIT CertificateRevocationLists OPTIONAL,
-                signerInfos SignerInfos
-              }
-            
-
- - return a SignerIdentifier object from the given object. - - @param o the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-             SignerIdentifier ::= CHOICE {
-                 issuerAndSerialNumber IssuerAndSerialNumber,
-                 subjectKeyIdentifier [0] SubjectKeyIdentifier
-             }
-            
-             SubjectKeyIdentifier ::= OCTET STRING
-             
-
- - Produce an object suitable for an Asn1OutputStream. -
-              SignerInfo ::= Sequence {
-                  version Version,
-                  SignerIdentifier sid,
-                  digestAlgorithm DigestAlgorithmIdentifier,
-                  authenticatedAttributes [0] IMPLICIT Attributes OPTIONAL,
-                  digestEncryptionAlgorithm DigestEncryptionAlgorithmIdentifier,
-                  encryptedDigest EncryptedDigest,
-                  unauthenticatedAttributes [1] IMPLICIT Attributes OPTIONAL
-              }
-            
-              EncryptedDigest ::= OCTET STRING
-            
-              DigestAlgorithmIdentifier ::= AlgorithmIdentifier
-            
-              DigestEncryptionAlgorithmIdentifier ::= AlgorithmIdentifier
-             
-
- - creates a time object from a given date - if the date is between 1950 - and 2049 a UTCTime object is Generated, otherwise a GeneralizedTime - is used. - - - Produce an object suitable for an Asn1OutputStream. -
-            Time ::= CHOICE {
-                        utcTime        UTCTime,
-                        generalTime    GeneralizedTime }
-            
-
- -
-            TimeStampAndCRL ::= SEQUENCE {
-                timeStamp   TimeStampToken,          -- according to RFC 3161
-                crl         CertificateList OPTIONAL -- according to RFC 5280
-             }
-            
- @return -
- -
-            TimeStampedData ::= SEQUENCE {
-              version              INTEGER { v1(1) },
-              dataUri              IA5String OPTIONAL,
-              metaData             MetaData OPTIONAL,
-              content              OCTET STRING OPTIONAL,
-              temporalEvidence     Evidence
-            }
-            
- @return -
- -
-            TimeStampTokenEvidence ::=
-               SEQUENCE SIZE(1..MAX) OF TimeStampAndCrl
-            
- @return -
- -
-            AttributeTypeAndValue ::= SEQUENCE {
-                      type         OBJECT IDENTIFIER,
-                      value        ANY DEFINED BY type }
-            
- @return a basic ASN.1 object representation. -
- -
-            CertId ::= SEQUENCE {
-                            issuer           GeneralName,
-                            serialNumber     INTEGER }
-            
- @return a basic ASN.1 object representation. -
- -
-            CertReqMessages ::= SEQUENCE SIZE (1..MAX) OF CertReqMsg
-            
- @return a basic ASN.1 object representation. -
- - Creates a new CertReqMsg. - @param certReq CertRequest - @param popo may be null - @param regInfo may be null - - -
-            CertReqMsg ::= SEQUENCE {
-                               certReq   CertRequest,
-                               pop       ProofOfPossession  OPTIONAL,
-                               -- content depends upon key type
-                               regInfo   SEQUENCE SIZE(1..MAX) OF AttributeTypeAndValue OPTIONAL }
-            
- @return a basic ASN.1 object representation. -
- -
-            CertRequest ::= SEQUENCE {
-                                 certReqId     INTEGER,          -- ID for matching request and reply
-                                 certTemplate  CertTemplate,  -- Selected fields of cert to be issued
-                                 controls      Controls OPTIONAL }   -- Attributes affecting issuance
-            
- @return a basic ASN.1 object representation. -
- -
-             CertTemplate ::= SEQUENCE {
-                 version      [0] Version               OPTIONAL,
-                 serialNumber [1] INTEGER               OPTIONAL,
-                 signingAlg   [2] AlgorithmIdentifier   OPTIONAL,
-                 issuer       [3] Name                  OPTIONAL,
-                 validity     [4] OptionalValidity      OPTIONAL,
-                 subject      [5] Name                  OPTIONAL,
-                 publicKey    [6] SubjectPublicKeyInfo  OPTIONAL,
-                 issuerUID    [7] UniqueIdentifier      OPTIONAL,
-                 subjectUID   [8] UniqueIdentifier      OPTIONAL,
-                 extensions   [9] Extensions            OPTIONAL }
-            
- @return a basic ASN.1 object representation. -
- - Sets the X.509 version. Note: for X509v3, use 2 here. - - - Sets the issuer unique ID (deprecated in X.509v3) - - - Sets the subject unique ID (deprecated in X.509v3) - - -
-             CertTemplate ::= SEQUENCE {
-                 version      [0] Version               OPTIONAL,
-                 serialNumber [1] INTEGER               OPTIONAL,
-                 signingAlg   [2] AlgorithmIdentifier   OPTIONAL,
-                 issuer       [3] Name                  OPTIONAL,
-                 validity     [4] OptionalValidity      OPTIONAL,
-                 subject      [5] Name                  OPTIONAL,
-                 publicKey    [6] SubjectPublicKeyInfo  OPTIONAL,
-                 issuerUID    [7] UniqueIdentifier      OPTIONAL,
-                 subjectUID   [8] UniqueIdentifier      OPTIONAL,
-                 extensions   [9] Extensions            OPTIONAL }
-            
- @return a basic ASN.1 object representation. -
- -
-            Controls  ::= SEQUENCE SIZE(1..MAX) OF AttributeTypeAndValue
-            
- @return a basic ASN.1 object representation. -
- -
-            EncKeyWithID ::= SEQUENCE {
-                 privateKey           PrivateKeyInfo,
-                 identifier CHOICE {
-                    string               UTF8String,
-                    generalName          GeneralName
-                } OPTIONAL
-            }
-            
- @return -
- -
-               EncryptedKey ::= CHOICE {
-                   encryptedValue        EncryptedValue, -- deprecated
-                   envelopedData     [0] EnvelopedData }
-                   -- The encrypted private key MUST be placed in the envelopedData
-                   -- encryptedContentInfo encryptedContent OCTET STRING.
-            
-
- -
-            EncryptedValue ::= SEQUENCE {
-                                intendedAlg   [0] AlgorithmIdentifier  OPTIONAL,
-                                -- the intended algorithm for which the value will be used
-                                symmAlg       [1] AlgorithmIdentifier  OPTIONAL,
-                                -- the symmetric algorithm used to encrypt the value
-                                encSymmKey    [2] BIT STRING           OPTIONAL,
-                                -- the (encrypted) symmetric key used to encrypt the value
-                                keyAlg        [3] AlgorithmIdentifier  OPTIONAL,
-                                -- algorithm used to encrypt the symmetric key
-                                valueHint     [4] OCTET STRING         OPTIONAL,
-                                -- a brief description or identifier of the encValue content
-                                -- (may be meaningful only to the sending entity, and used only
-                                -- if EncryptedValue might be re-examined by the sending entity
-                                -- in the future)
-                                encValue       BIT STRING }
-                                -- the encrypted value itself
-            
- @return a basic ASN.1 object representation. -
- -
-            OptionalValidity ::= SEQUENCE {
-                                   notBefore  [0] Time OPTIONAL,
-                                   notAfter   [1] Time OPTIONAL } --at least one MUST be present
-            
- @return a basic ASN.1 object representation. -
- -
-             PkiArchiveOptions ::= CHOICE {
-                 encryptedPrivKey     [0] EncryptedKey,
-                 -- the actual value of the private key
-                 keyGenParameters     [1] KeyGenParameters,
-                 -- parameters which allow the private key to be re-generated
-                 archiveRemGenPrivKey [2] BOOLEAN }
-                 -- set to TRUE if sender wishes receiver to archive the private
-                 -- key of a key pair that the receiver generates in response to
-                 -- this request; set to FALSE if no archival is desired.
-            
-
- -
-            PkiPublicationInfo ::= SEQUENCE {
-                             action     INTEGER {
-                                            dontPublish (0),
-                                            pleasePublish (1) },
-                             pubInfos  SEQUENCE SIZE (1..MAX) OF SinglePubInfo OPTIONAL }
-            -- pubInfos MUST NOT be present if action is "dontPublish"
-            -- (if action is "pleasePublish" and pubInfos is omitted,
-            -- "dontCare" is assumed)
-            
- @return a basic ASN.1 object representation. -
- - Password-based MAC value for use with POPOSigningKeyInput. - - - Creates a new PKMACValue. - @param params parameters for password-based MAC - @param value MAC of the DER-encoded SubjectPublicKeyInfo - - - Creates a new PKMACValue. - @param aid CMPObjectIdentifiers.passwordBasedMAC, with PBMParameter - @param value MAC of the DER-encoded SubjectPublicKeyInfo - - -
-            PKMACValue ::= SEQUENCE {
-                 algId  AlgorithmIdentifier,
-                 -- algorithm value shall be PasswordBasedMac 1.2.840.113533.7.66.13
-                 -- parameter value is PBMParameter
-                 value  BIT STRING }
-            
- @return a basic ASN.1 object representation. -
- -
-            PopoPrivKey ::= CHOICE {
-                   thisMessage       [0] BIT STRING,         -- Deprecated
-                    -- possession is proven in this message (which contains the private
-                    -- key itself (encrypted for the CA))
-                   subsequentMessage [1] SubsequentMessage,
-                    -- possession will be proven in a subsequent message
-                   dhMAC             [2] BIT STRING,         -- Deprecated
-                   agreeMAC          [3] PKMACValue,
-                   encryptedKey      [4] EnvelopedData }
-            
-
- - Creates a new Proof of Possession object for a signing key. - @param poposkIn the PopoSigningKeyInput structure, or null if the - CertTemplate includes both subject and publicKey values. - @param aid the AlgorithmIdentifier used to sign the proof of possession. - @param signature a signature over the DER-encoded value of poposkIn, - or the DER-encoded value of certReq if poposkIn is null. - - -
-            PopoSigningKey ::= SEQUENCE {
-                                 poposkInput           [0] PopoSigningKeyInput OPTIONAL,
-                                 algorithmIdentifier   AlgorithmIdentifier,
-                                 signature             BIT STRING }
-             -- The signature (using "algorithmIdentifier") is on the
-             -- DER-encoded value of poposkInput.  NOTE: If the CertReqMsg
-             -- certReq CertTemplate contains the subject and publicKey values,
-             -- then poposkInput MUST be omitted and the signature MUST be
-             -- computed on the DER-encoded value of CertReqMsg certReq.  If
-             -- the CertReqMsg certReq CertTemplate does not contain the public
-             -- key and subject values, then poposkInput MUST be present and
-             -- MUST be signed.  This strategy ensures that the public key is
-             -- not present in both the poposkInput and CertReqMsg certReq
-             -- CertTemplate fields.
-            
- @return a basic ASN.1 object representation. -
- - Creates a new PopoSigningKeyInput with sender name as authInfo. - - - Creates a new PopoSigningKeyInput using password-based MAC. - - - Returns the sender field, or null if authInfo is publicKeyMac - - - Returns the publicKeyMac field, or null if authInfo is sender - - -
-            PopoSigningKeyInput ::= SEQUENCE {
-                   authInfo             CHOICE {
-                                            sender              [0] GeneralName,
-                                            -- used only if an authenticated identity has been
-                                            -- established for the sender (e.g., a DN from a
-                                            -- previously-issued and currently-valid certificate
-                                            publicKeyMac        PKMacValue },
-                                            -- used if no authenticated GeneralName currently exists for
-                                            -- the sender; publicKeyMac contains a password-based MAC
-                                            -- on the DER-encoded value of publicKey
-                   publicKey           SubjectPublicKeyInfo }  -- from CertTemplate
-            
- @return a basic ASN.1 object representation. -
- - Creates a ProofOfPossession with type raVerified. - - - Creates a ProofOfPossession for a signing key. - - - Creates a ProofOfPossession for key encipherment or agreement. - @param type one of TYPE_KEY_ENCIPHERMENT or TYPE_KEY_AGREEMENT - - -
-            ProofOfPossession ::= CHOICE {
-                                      raVerified        [0] NULL,
-                                      -- used if the RA has already verified that the requester is in
-                                      -- possession of the private key
-                                      signature         [1] PopoSigningKey,
-                                      keyEncipherment   [2] PopoPrivKey,
-                                      keyAgreement      [3] PopoPrivKey }
-            
- @return a basic ASN.1 object representation. -
- -
-            SinglePubInfo ::= SEQUENCE {
-                   pubMethod    INTEGER {
-                      dontCare    (0),
-                      x500        (1),
-                      web         (2),
-                      ldap        (3) },
-                  pubLocation  GeneralName OPTIONAL }
-            
- @return a basic ASN.1 object representation. -
- - - Table of the available named parameters for GOST 3410-2001 / 2012. - - - - return the ECDomainParameters object for the given OID, null if it - isn't present. - - @param oid an object identifier representing a named parameters, if present. - - - returns an enumeration containing the name strings for curves - contained in this structure. - - - return the named curve name represented by the given object identifier. - - -
-             Gost28147-89-Parameters ::=
-                           SEQUENCE {
-                                   iv                   Gost28147-89-IV,
-                                   encryptionParamSet   OBJECT IDENTIFIER
-                            }
-            
-               Gost28147-89-IV ::= OCTET STRING (SIZE (8))
-             
-
- - table of the available named parameters for GOST 3410-94. - - - return the GOST3410ParamSetParameters object for the given OID, null if it - isn't present. - - @param oid an object identifier representing a named parameters, if present. - - - returns an enumeration containing the name strings for parameters - contained in this structure. - - - Base class for an application specific object - - - Return the enclosed object assuming explicit tagging. - - @return the resulting object - @throws IOException if reconstruction fails. - - - Return the enclosed object assuming implicit tagging. - - @param derTagNo the type tag that should be applied to the object's contents. - @return the resulting object - @throws IOException if reconstruction fails. - - - return a Bit string from the passed in object - - @exception ArgumentException if the object cannot be converted. - - - return a Bit string from a tagged object. - - @param obj the tagged object holding the object we want - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - @param data the octets making up the bit string. - @param padBits the number of extra bits at the end of the string. - - - Return the octets contained in this BIT STRING, checking that this BIT STRING really - does represent an octet aligned string. Only use this method when the standard you are - following dictates that the BIT STRING will be octet aligned. - - @return a copy of the octet aligned data. - - - @return the value of the bit string as an int (truncating if necessary) - - - Der BMPString object. - - - return a BMP string from the given object. - - @param obj the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - return a BMP string from a tagged object. - - @param obj the tagged object holding the object we want - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - basic constructor - byte encoded string. - - - basic constructor - - - return a bool from the passed in object. - - @exception ArgumentException if the object cannot be converted. - - - return a DerBoolean from the passed in bool. - - - return a Boolean from a tagged object. - - @param obj the tagged object holding the object we want - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - return an integer from the passed in object - - @exception ArgumentException if the object cannot be converted. - - - return an Enumerated from a tagged object. - - @param obj the tagged object holding the object we want - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - Class representing the DER-type External - - - Creates a new instance of DerExternal - See X.690 for more informations about the meaning of these parameters - @param directReference The direct reference or null if not set. - @param indirectReference The indirect reference or null if not set. - @param dataValueDescriptor The data value descriptor or null if not set. - @param externalData The external data in its encoded form. - - - Creates a new instance of DerExternal. - See X.690 for more informations about the meaning of these parameters - @param directReference The direct reference or null if not set. - @param indirectReference The indirect reference or null if not set. - @param dataValueDescriptor The data value descriptor or null if not set. - @param encoding The encoding to be used for the external data - @param externalData The external data - - - The encoding of the content. Valid values are -
    -
  • 0 single-ASN1-type
  • -
  • 1 OCTET STRING
  • -
  • 2 BIT STRING
  • -
-
- - Generalized time object. - - - return a generalized time from the passed in object - - @exception ArgumentException if the object cannot be converted. - - - return a Generalized Time object from a tagged object. - - @param obj the tagged object holding the object we want - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - The correct format for this is YYYYMMDDHHMMSS[.f]Z, or without the Z - for local time, or Z+-HHMM on the end, for difference between local - time and UTC time. The fractional second amount f must consist of at - least one number with trailing zeroes removed. - - @param time the time string. - @exception ArgumentException if string is an illegal format. - - - base constructor from a local time object - - - Return the time. - @return The time string as it appeared in the encoded object. - - - return the time - always in the form of - YYYYMMDDhhmmssGMT(+hh:mm|-hh:mm). -

- Normally in a certificate we would expect "Z" rather than "GMT", - however adding the "GMT" means we can just use: -

-                dateF = new SimpleDateFormat("yyyyMMddHHmmssz");
-            
- To read in the time and Get a date which is compatible with our local - time zone.

-
- - return a Graphic String from the passed in object - - @param obj a DerGraphicString or an object that can be converted into one. - @exception IllegalArgumentException if the object cannot be converted. - @return a DerGraphicString instance, or null. - - - return a Graphic String from a tagged object. - - @param obj the tagged object holding the object we want - @param explicit true if the object is meant to be explicitly - tagged false otherwise. - @exception IllegalArgumentException if the tagged object cannot - be converted. - @return a DerGraphicString instance, or null. - - - basic constructor - with bytes. - @param string the byte encoding of the characters making up the string. - - - Der IA5String object - this is an ascii string. - - - return a IA5 string from the passed in object - - @exception ArgumentException if the object cannot be converted. - - - return an IA5 string from a tagged object. - - @param obj the tagged object holding the object we want - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - basic constructor - with bytes. - - - basic constructor - without validation. - - - Constructor with optional validation. - - @param string the base string to wrap. - @param validate whether or not to check the string. - @throws ArgumentException if validate is true and the string - contains characters that should not be in an IA5String. - - - return true if the passed in String can be represented without - loss as an IA5String, false otherwise. - - @return true if in printable set, false otherwise. - - - return an integer from the passed in object - - @exception ArgumentException if the object cannot be converted. - - - return an Integer from a tagged object. - - @param obj the tagged object holding the object we want - @param isExplicit true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - in some cases positive values Get crammed into a space, - that's not quite big enough... - - - Apply the correct validation for an INTEGER primitive following the BER rules. - - @param bytes The raw encoding of the integer. - @return true if the (in)put fails this validation. - - - A Null object. - - - Der NumericString object - this is an ascii string of characters {0,1,2,3,4,5,6,7,8,9, }. - - - return a Numeric string from the passed in object - - @exception ArgumentException if the object cannot be converted. - - - return an Numeric string from a tagged object. - - @param obj the tagged object holding the object we want - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - basic constructor - with bytes. - - - basic constructor - without validation.. - - - Constructor with optional validation. - - @param string the base string to wrap. - @param validate whether or not to check the string. - @throws ArgumentException if validate is true and the string - contains characters that should not be in a NumericString. - - - Return true if the string can be represented as a NumericString ('0'..'9', ' ') - - @param str string to validate. - @return true if numeric, fale otherwise. - - - return an Oid from the passed in object - - @exception ArgumentException if the object cannot be converted. - - - return an object Identifier from a tagged object. - - @param obj the tagged object holding the object we want - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - Return true if this oid is an extension of the passed in branch, stem. - @param stem the arc or branch that is a possible parent. - @return true if the branch is on the passed in stem, false otherwise. - - - The octets making up the octet string. - - - Der PrintableString object. - - - return a printable string from the passed in object. - - @exception ArgumentException if the object cannot be converted. - - - return a Printable string from a tagged object. - - @param obj the tagged object holding the object we want - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - basic constructor - byte encoded string. - - - basic constructor - this does not validate the string - - - Constructor with optional validation. - - @param string the base string to wrap. - @param validate whether or not to check the string. - @throws ArgumentException if validate is true and the string - contains characters that should not be in a PrintableString. - - - return true if the passed in String can be represented without - loss as a PrintableString, false otherwise. - - @return true if in printable set, false otherwise. - - - create an empty sequence - - - create a sequence containing one object - - - create a sequence containing a vector of objects. - - - A Der encoded set object - - - create an empty set - - - @param obj - a single object that makes up the set. - - - @param v - a vector of objects making up the set. - - - Der T61String (also the teletex string) - 8-bit characters - - - return a T61 string from the passed in object. - - @exception ArgumentException if the object cannot be converted. - - - return an T61 string from a tagged object. - - @param obj the tagged object holding the object we want - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - basic constructor - with bytes. - - - basic constructor - with string. - - - DER TaggedObject - in ASN.1 notation this is any object preceded by - a [n] where n is some number - these are assumed to follow the construction - rules (as with sequences). - - - @param tagNo the tag number for this object. - @param obj the tagged object. - - - @param explicitly true if an explicitly tagged object. - @param tagNo the tag number for this object. - @param obj the tagged object. - - - create an implicitly tagged object that contains a zero - length sequence. - - - Der UniversalString object. - - - return a Universal string from the passed in object. - - @exception ArgumentException if the object cannot be converted. - - - return a Universal string from a tagged object. - - @param obj the tagged object holding the object we want - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - basic constructor - byte encoded string. - - - UTC time object. - - - return an UTC Time from the passed in object. - - @exception ArgumentException if the object cannot be converted. - - - return an UTC Time from a tagged object. - - @param obj the tagged object holding the object we want - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - The correct format for this is YYMMDDHHMMSSZ (it used to be that seconds were - never encoded. When you're creating one of these objects from scratch, that's - what you want to use, otherwise we'll try to deal with whatever Gets read from - the input stream... (this is why the input format is different from the GetTime() - method output). -

- @param time the time string.

-
- - base constructor from a DateTime object - - - return the time as a date based on whatever a 2 digit year will return. For - standardised processing use ToAdjustedDateTime(). - - @return the resulting date - @exception ParseException if the date string cannot be parsed. - - - return the time as an adjusted date - in the range of 1950 - 2049. - - @return a date in the range of 1950 to 2049. - @exception ParseException if the date string cannot be parsed. - - - return the time - always in the form of - YYMMDDhhmmssGMT(+hh:mm|-hh:mm). -

- Normally in a certificate we would expect "Z" rather than "GMT", - however adding the "GMT" means we can just use: -

-                dateF = new SimpleDateFormat("yyMMddHHmmssz");
-            
- To read in the time and Get a date which is compatible with our local - time zone.

-

- Note: In some cases, due to the local date processing, this - may lead to unexpected results. If you want to stick the normal - convention of 1950 to 2049 use the GetAdjustedTime() method.

-
- - - Return a time string as an adjusted date with a 4 digit year. - This goes in the range of 1950 - 2049. - - - - Der UTF8String object. - - - return an UTF8 string from the passed in object. - - @exception ArgumentException if the object cannot be converted. - - - return an UTF8 string from a tagged object. - - @param obj the tagged object holding the object we want - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - basic constructor - byte encoded string. - - - basic constructor - - - return a Videotex String from the passed in object - - @param obj a DERVideotexString or an object that can be converted into one. - @exception IllegalArgumentException if the object cannot be converted. - @return a DERVideotexString instance, or null. - - - return a Videotex String from a tagged object. - - @param obj the tagged object holding the object we want - @param explicit true if the object is meant to be explicitly - tagged false otherwise. - @exception IllegalArgumentException if the tagged object cannot - be converted. - @return a DERVideotexString instance, or null. - - - basic constructor - with bytes. - @param string the byte encoding of the characters making up the string. - - - Der VisibleString object. - - - return a Visible string from the passed in object. - - @exception ArgumentException if the object cannot be converted. - - - return a Visible string from a tagged object. - - @param obj the tagged object holding the object we want - @param explicitly true if the object is meant to be explicitly - tagged false otherwise. - @exception ArgumentException if the tagged object cannot - be converted. - - - basic constructor - byte encoded string. - - - basic constructor - - - Edwards Elliptic Curve Object Identifiers (RFC 8410) - - - - RFC 3126: 4.3.1 Certificate Values Attribute Definition - - CertificateValues ::= SEQUENCE OF Certificate - - - - -
-            CommitmentTypeIndication ::= SEQUENCE {
-                 commitmentTypeId   CommitmentTypeIdentifier,
-                 commitmentTypeQualifier   SEQUENCE SIZE (1..MAX) OF
-                         CommitmentTypeQualifier OPTIONAL }
-            
-
- - Commitment type qualifiers, used in the Commitment-Type-Indication attribute (RFC3126). - -
-               CommitmentTypeQualifier ::= SEQUENCE {
-                   commitmentTypeIdentifier  CommitmentTypeIdentifier,
-                   qualifier          ANY DEFINED BY commitmentTypeIdentifier OPTIONAL }
-             
-
- - Creates a new CommitmentTypeQualifier instance. - - @param commitmentTypeIdentifier a CommitmentTypeIdentifier value - - - Creates a new CommitmentTypeQualifier instance. - - @param commitmentTypeIdentifier a CommitmentTypeIdentifier value - @param qualifier the qualifier, defined by the above field. - - - Creates a new CommitmentTypeQualifier instance. - - @param as CommitmentTypeQualifier structure - encoded as an Asn1Sequence. - - - Returns a DER-encodable representation of this instance. - - @return a Asn1Object value - - - - RFC 3126: 4.2.1 Complete Certificate Refs Attribute Definition - - CompleteCertificateRefs ::= SEQUENCE OF OtherCertID - - - - - - RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition - - CompleteRevocationRefs ::= SEQUENCE OF CrlOcspRef - - - - - - RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition - - CrlIdentifier ::= SEQUENCE - { - crlissuer Name, - crlIssuedTime UTCTime, - crlNumber INTEGER OPTIONAL - } - - - - - - RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition - - CRLListID ::= SEQUENCE - { - crls SEQUENCE OF CrlValidatedID - } - - - - - - RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition - - CrlOcspRef ::= SEQUENCE { - crlids [0] CRLListID OPTIONAL, - ocspids [1] OcspListID OPTIONAL, - otherRev [2] OtherRevRefs OPTIONAL - } - - - - - - RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition - - CrlValidatedID ::= SEQUENCE { - crlHash OtherHash, - crlIdentifier CrlIdentifier OPTIONAL} - - - - - - RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition - - OcspIdentifier ::= SEQUENCE { - ocspResponderID ResponderID, - -- As in OCSP response data - producedAt GeneralizedTime - -- As in OCSP response data - } - - - - - - RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition - - OcspListID ::= SEQUENCE { - ocspResponses SEQUENCE OF OcspResponsesID - } - - - - - - RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition - - OcspResponsesID ::= SEQUENCE { - ocspIdentifier OcspIdentifier, - ocspRepHash OtherHash OPTIONAL - } - - - - - - - OtherCertID ::= SEQUENCE { - otherCertHash OtherHash, - issuerSerial IssuerSerial OPTIONAL - } - - - - - - - OtherHash ::= CHOICE { - sha1Hash OtherHashValue, -- This contains a SHA-1 hash - otherHash OtherHashAlgAndValue - } - - OtherHashValue ::= OCTET STRING - - - - - - Summary description for OtherHashAlgAndValue. - - - - OtherHashAlgAndValue ::= SEQUENCE { - hashAlgorithm AlgorithmIdentifier, - hashValue OtherHashValue - } - - OtherHashValue ::= OCTET STRING - - - - - - RFC 3126: 4.2.2 Complete Revocation Refs Attribute Definition - - OtherRevRefs ::= SEQUENCE - { - otherRevRefType OtherRevRefType, - otherRevRefs ANY DEFINED BY otherRevRefType - } - - OtherRevRefType ::= OBJECT IDENTIFIER - - - - - - RFC 3126: 4.3.2 Revocation Values Attribute Definition - - OtherRevVals ::= SEQUENCE - { - otherRevValType OtherRevValType, - otherRevVals ANY DEFINED BY otherRevValType - } - - OtherRevValType ::= OBJECT IDENTIFIER - - - - - - - OtherSigningCertificate ::= SEQUENCE { - certs SEQUENCE OF OtherCertID, - policies SEQUENCE OF PolicyInformation OPTIONAL - } - - - - - - RFC 5126: 6.3.4. revocation-values Attribute Definition - - RevocationValues ::= SEQUENCE { - crlVals [0] SEQUENCE OF CertificateList OPTIONAL, - ocspVals [1] SEQUENCE OF BasicOCSPResponse OPTIONAL, - otherRevVals [2] OtherRevVals OPTIONAL - } - - - - - - - SignaturePolicyId ::= SEQUENCE { - sigPolicyIdentifier SigPolicyId, - sigPolicyHash SigPolicyHash, - sigPolicyQualifiers SEQUENCE SIZE (1..MAX) OF SigPolicyQualifierInfo OPTIONAL - } - - SigPolicyId ::= OBJECT IDENTIFIER - - SigPolicyHash ::= OtherHashAlgAndValue - - - - - - - SignaturePolicyIdentifier ::= CHOICE { - SignaturePolicyId SignaturePolicyId, - SignaturePolicyImplied SignaturePolicyImplied - } - - SignaturePolicyImplied ::= NULL - - - - - -
-              SignerAttribute ::= SEQUENCE OF CHOICE {
-                  claimedAttributes   [0] ClaimedAttributes,
-                  certifiedAttributes [1] CertifiedAttributes }
-            
-              ClaimedAttributes ::= SEQUENCE OF Attribute
-              CertifiedAttributes ::= AttributeCertificate -- as defined in RFC 3281: see clause 4.1.
-             
-
- - Signer-Location attribute (RFC3126). - -
-               SignerLocation ::= SEQUENCE {
-                   countryName        [0] DirectoryString OPTIONAL,
-                   localityName       [1] DirectoryString OPTIONAL,
-                   postalAddress      [2] PostalAddress OPTIONAL }
-            
-               PostalAddress ::= SEQUENCE SIZE(1..6) OF DirectoryString
-             
-
- -
-               SignerLocation ::= SEQUENCE {
-                   countryName        [0] DirectoryString OPTIONAL,
-                   localityName       [1] DirectoryString OPTIONAL,
-                   postalAddress      [2] PostalAddress OPTIONAL }
-            
-               PostalAddress ::= SEQUENCE SIZE(1..6) OF DirectoryString
-            
-               DirectoryString ::= CHOICE {
-                     teletexString           TeletexString (SIZE (1..MAX)),
-                     printableString         PrintableString (SIZE (1..MAX)),
-                     universalString         UniversalString (SIZE (1..MAX)),
-                     utf8String              UTF8String (SIZE (1.. MAX)),
-                     bmpString               BMPString (SIZE (1..MAX)) }
-             
-
- - - - SigPolicyQualifierInfo ::= SEQUENCE { - sigPolicyQualifierId SigPolicyQualifierId, - sigQualifier ANY DEFINED BY sigPolicyQualifierId - } - - SigPolicyQualifierId ::= OBJECT IDENTIFIER - - - - - constructor - - -
-            ContentHints ::= SEQUENCE {
-              contentDescription UTF8String (SIZE (1..MAX)) OPTIONAL,
-              contentType ContentType }
-            
-
- - Create from OCTET STRING whose octets represent the identifier. - - - Create from byte array representing the identifier. - - - The definition of ContentIdentifier is -
-            ContentIdentifier ::=  OCTET STRING
-            
- id-aa-contentIdentifier OBJECT IDENTIFIER ::= { iso(1) - member-body(2) us(840) rsadsi(113549) pkcs(1) pkcs9(9) - smime(16) id-aa(2) 7 } -
- - constructor - - -
-            EssCertID ::= SEQUENCE {
-                certHash Hash,
-                issuerSerial IssuerSerial OPTIONAL }
-            
-
- -
-             EssCertIDv2 ::=  SEQUENCE {
-                 hashAlgorithm     AlgorithmIdentifier
-                          DEFAULT {algorithm id-sha256},
-                 certHash          Hash,
-                 issuerSerial      IssuerSerial OPTIONAL
-             }
-            
-             Hash ::= OCTET STRING
-            
-             IssuerSerial ::= SEQUENCE {
-                 issuer         GeneralNames,
-                 serialNumber   CertificateSerialNumber
-             }
-             
-
- - constructor - - -
-             OtherCertID ::= SEQUENCE {
-                 otherCertHash    OtherHash,
-                 issuerSerial     IssuerSerial OPTIONAL }
-            
-             OtherHash ::= CHOICE {
-                 sha1Hash     OCTET STRING,
-                 otherHash    OtherHashAlgAndValue }
-            
-             OtherHashAlgAndValue ::= SEQUENCE {
-                 hashAlgorithm    AlgorithmIdentifier,
-                 hashValue        OCTET STRING }
-            
-             
-
- - constructors - - - The definition of OtherSigningCertificate is -
-            OtherSigningCertificate ::=  SEQUENCE {
-                 certs        SEQUENCE OF OtherCertID,
-                 policies     SEQUENCE OF PolicyInformation OPTIONAL
-            }
-            
- id-aa-ets-otherSigCert OBJECT IDENTIFIER ::= { iso(1) - member-body(2) us(840) rsadsi(113549) pkcs(1) pkcs9(9) - smime(16) id-aa(2) 19 } -
- - constructors - - - The definition of SigningCertificate is -
-            SigningCertificate ::=  SEQUENCE {
-                 certs        SEQUENCE OF EssCertID,
-                 policies     SEQUENCE OF PolicyInformation OPTIONAL
-            }
-            
- id-aa-signingCertificate OBJECT IDENTIFIER ::= { iso(1) - member-body(2) us(840) rsadsi(113549) pkcs(1) pkcs9(9) - smime(16) id-aa(2) 12 } -
- - The definition of SigningCertificateV2 is -
-            SigningCertificateV2 ::=  SEQUENCE {
-                 certs        SEQUENCE OF EssCertIDv2,
-                 policies     SEQUENCE OF PolicyInformation OPTIONAL
-            }
-            
- id-aa-signingCertificateV2 OBJECT IDENTIFIER ::= { iso(1) - member-body(2) us(840) rsadsi(113549) pkcs(1) pkcs9(9) - smime(16) id-aa(2) 47 } -
- - return the X9ECParameters object for the named curve represented by - the passed in object identifier. Null if the curve isn't present. - - @param oid an object identifier representing a named curve, if present. - - - return the object identifier signified by the passed in name. Null - if there is no object identifier associated with name. - - @return the object identifier associated with name, if present. - - - return the named curve name represented by the given object identifier. - - - returns an enumeration containing the name strings for curves - contained in this structure. - - - 1.3.6.1.4.1.11591.15 - ellipticCurve - - - Marker interface for CHOICE objects - if you implement this in a roll-your-own - object, any attempt to tag the object implicitly will convert the tag to an - explicit one as the encoding rules require. -

- If you use this interface your class should also implement the getInstance - pattern which takes a tag object and the tagging mode used. -

-
- - basic interface for Der string objects. - - - The CscaMasterList object. This object can be wrapped in a - CMSSignedData to be published in LDAP. - -
-             CscaMasterList ::= SEQUENCE {
-               version                CscaMasterListVersion,
-               certList               SET OF Certificate }
-               
-             CscaMasterListVersion :: INTEGER {v0(0)}
-             
-
- - The DataGroupHash object. -
-             DataGroupHash  ::=  SEQUENCE {
-                  dataGroupNumber         DataGroupNumber,
-                  dataGroupHashValue     OCTET STRING }
-            
-             DataGroupNumber ::= INTEGER {
-                     dataGroup1    (1),
-                     dataGroup1    (2),
-                     dataGroup1    (3),
-                     dataGroup1    (4),
-                     dataGroup1    (5),
-                     dataGroup1    (6),
-                     dataGroup1    (7),
-                     dataGroup1    (8),
-                     dataGroup1    (9),
-                     dataGroup1    (10),
-                     dataGroup1    (11),
-                     dataGroup1    (12),
-                     dataGroup1    (13),
-                     dataGroup1    (14),
-                     dataGroup1    (15),
-                     dataGroup1    (16) }
-            
-             
-
- - The LDSSecurityObject object (V1.8). -
-             LDSSecurityObject ::= SEQUENCE {
-               version                LDSSecurityObjectVersion,
-               hashAlgorithm          DigestAlgorithmIdentifier,
-               dataGroupHashValues    SEQUENCE SIZE (2..ub-DataGroups) OF DataHashGroup,
-               ldsVersionInfo         LDSVersionInfo OPTIONAL
-                 -- if present, version MUST be v1 }
-            
-             DigestAlgorithmIdentifier ::= AlgorithmIdentifier,
-            
-             LDSSecurityObjectVersion :: INTEGER {V0(0)}
-             
-
- -
-            LDSVersionInfo ::= SEQUENCE {
-               ldsVersion PRINTABLE STRING
-               unicodeVersion PRINTABLE STRING
-             }
-            
- @return -
- - The id-isismtt-cp-accredited OID indicates that the certificate is a - qualified certificate according to Directive 1999/93/EC of the European - Parliament and of the Council of 13 December 1999 on a Community - Framework for Electronic Signatures, which additionally conforms the - special requirements of the SigG and has been issued by an accredited CA. - - - Certificate extensionDate of certificate generation - -
-            		DateOfCertGenSyntax ::= GeneralizedTime
-             
-
- - Attribute to indicate that the certificate holder may sign in the name of - a third person. May also be used as extension in a certificate. - - - Attribute to indicate admissions to certain professions. May be used as - attribute in attribute certificate or as extension in a certificate - - - Monetary limit for transactions. The QcEuMonetaryLimit QC statement MUST - be used in new certificates in place of the extension/attribute - MonetaryLimit since January 1, 2004. For the sake of backward - compatibility with certificates already in use, SigG conforming - components MUST support MonetaryLimit (as well as QcEuLimitValue). - - - A declaration of majority. May be used as attribute in attribute - certificate or as extension in a certificate - - - - Serial number of the smart card containing the corresponding private key - -
-            		ICCSNSyntax ::= OCTET STRING (SIZE(8..20))
-             
-
- - - Reference for a file of a smartcard that stores the public key of this - certificate and that is used as �security anchor�. - -
-            		PKReferenceSyntax ::= OCTET STRING (SIZE(20))
-             
-
- - Some other restriction regarding the usage of this certificate. May be - used as attribute in attribute certificate or as extension in a - certificate. - -
-            		RestrictionSyntax ::= DirectoryString (SIZE(1..1024))
-             
- - @see Org.BouncyCastle.Asn1.IsisMtt.X509.Restriction -
- - - (Single)Request extension: Clients may include this extension in a - (single) Request to request the responder to send the certificate in the - response message along with the status information. Besides the LDAP - service, this extension provides another mechanism for the distribution - of certificates, which MAY optionally be provided by certificate - repositories. - -
-            		RetrieveIfAllowed ::= BOOLEAN
-             
-
- - SingleOCSPResponse extension: The certificate requested by the client by - inserting the RetrieveIfAllowed extension in the request, will be - returned in this extension. - - @see Org.BouncyCastle.Asn1.IsisMtt.Ocsp.RequestedCertificate - - - Base ObjectIdentifier for naming authorities - - - SingleOCSPResponse extension: Date, when certificate has been published - in the directory and status information has become available. Currently, - accrediting authorities enforce that SigG-conforming OCSP servers include - this extension in the responses. - -
-            		CertInDirSince ::= GeneralizedTime
-             
-
- - Hash of a certificate in OCSP. - - @see Org.BouncyCastle.Asn1.IsisMtt.Ocsp.CertHash - - -
-            		NameAtBirth ::= DirectoryString(SIZE(1..64)
-             
- - Used in - {@link Org.BouncyCastle.Asn1.X509.SubjectDirectoryAttributes SubjectDirectoryAttributes} -
- - Some other information of non-restrictive nature regarding the usage of - this certificate. May be used as attribute in atribute certificate or as - extension in a certificate. - -
-                          AdditionalInformationSyntax ::= DirectoryString (SIZE(1..2048))
-            
- - @see Org.BouncyCastle.Asn1.IsisMtt.X509.AdditionalInformationSyntax -
- - Indicates that an attribute certificate exists, which limits the - usability of this public key certificate. Whenever verifying a signature - with the help of this certificate, the content of the corresponding - attribute certificate should be concerned. This extension MUST be - included in a PKC, if a corresponding attribute certificate (having the - PKC as base certificate) contains some attribute that restricts the - usability of the PKC too. Attribute certificates with restricting content - MUST always be included in the signed document. - -
-            		LiabilityLimitationFlagSyntax ::= BOOLEAN
-             
-
- - ISIS-MTT PROFILE: The responder may include this extension in a response to - send the hash of the requested certificate to the responder. This hash is - cryptographically bound to the certificate and serves as evidence that the - certificate is known to the responder (i.e. it has been issued and is present - in the directory). Hence, this extension is a means to provide a positive - statement of availability as described in T8.[8]. As explained in T13.[1], - clients may rely on this information to be able to validate signatures after - the expiry of the corresponding certificate. Hence, clients MUST support this - extension. If a positive statement of availability is to be delivered, this - extension syntax and OID MUST be used. -

-

-

-                CertHash ::= SEQUENCE {
-                  hashAlgorithm AlgorithmIdentifier,
-                  certificateHash OCTET STRING
-                }
-            
-
- - Constructor from Asn1Sequence. -

- The sequence is of type CertHash: -

-

-                 CertHash ::= SEQUENCE {
-                   hashAlgorithm AlgorithmIdentifier,
-                   certificateHash OCTET STRING
-                 }
-             
- - @param seq The ASN.1 sequence. -
- - Constructor from a given details. - - @param hashAlgorithm The hash algorithm identifier. - @param certificateHash The hash of the whole DER encoding of the certificate. - - - Produce an object suitable for an Asn1OutputStream. -

- Returns: -

-

-                 CertHash ::= SEQUENCE {
-                   hashAlgorithm AlgorithmIdentifier,
-                   certificateHash OCTET STRING
-                 }
-             
- - @return an Asn1Object -
- - ISIS-MTT-Optional: The certificate requested by the client by inserting the - RetrieveIfAllowed extension in the request, will be returned in this - extension. -

- ISIS-MTT-SigG: The signature act allows publishing certificates only then, - when the certificate owner gives his isExplicit permission. Accordingly, there - may be �nondownloadable� certificates, about which the responder must provide - status information, but MUST NOT include them in the response. Clients may - get therefore the following three kind of answers on a single request - including the RetrieveIfAllowed extension: -

    -
  • a) the responder supports the extension and is allowed to publish the - certificate: RequestedCertificate returned including the requested - certificate
  • -
  • b) the responder supports the extension but is NOT allowed to publish - the certificate: RequestedCertificate returned including an empty OCTET - STRING
  • -
  • c) the responder does not support the extension: RequestedCertificate is - not included in the response
  • -
- Clients requesting RetrieveIfAllowed MUST be able to handle these cases. If - any of the OCTET STRING options is used, it MUST contain the DER encoding of - the requested certificate. -

-

-                       RequestedCertificate ::= CHOICE {
-                         Certificate Certificate,
-                         publicKeyCertificate [0] EXPLICIT OCTET STRING,
-                         attributeCertificate [1] EXPLICIT OCTET STRING
-                       }
-            
-
- - Constructor from a given details. -

- Only one parameter can be given. All other must be null. - - @param certificate Given as Certificate - - - Produce an object suitable for an Asn1OutputStream. -

- Returns: -

-

-                        RequestedCertificate ::= CHOICE {
-                          Certificate Certificate,
-                          publicKeyCertificate [0] EXPLICIT OCTET STRING,
-                          attributeCertificate [1] EXPLICIT OCTET STRING
-                        }
-             
- - @return an Asn1Object -
- - Some other information of non-restrictive nature regarding the usage of this - certificate. - -
-               AdditionalInformationSyntax ::= DirectoryString (SIZE(1..2048))
-            
-
- - Constructor from a given details. - - @param information The describtion of the information. - - - Produce an object suitable for an Asn1OutputStream. -

- Returns: -

-

-               AdditionalInformationSyntax ::= DirectoryString (SIZE(1..2048))
-             
- - @return an Asn1Object -
- - An Admissions structure. -

-

-                        Admissions ::= SEQUENCE
-                        {
-                          admissionAuthority [0] EXPLICIT GeneralName OPTIONAL
-                          namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL
-                          professionInfos SEQUENCE OF ProfessionInfo
-                        }
-             

-

- - @see Org.BouncyCastle.Asn1.IsisMtt.X509.AdmissionSyntax - @see Org.BouncyCastle.Asn1.IsisMtt.X509.ProfessionInfo - @see Org.BouncyCastle.Asn1.IsisMtt.X509.NamingAuthority -
- - Constructor from Asn1Sequence. -

- The sequence is of type ProcurationSyntax: -

-

-                        Admissions ::= SEQUENCE
-                        {
-                          admissionAuthority [0] EXPLICIT GeneralName OPTIONAL
-                          namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL
-                          professionInfos SEQUENCE OF ProfessionInfo
-                        }
-             
- - @param seq The ASN.1 sequence. -
- - Constructor from a given details. -

- Parameter professionInfos is mandatory. - - @param admissionAuthority The admission authority. - @param namingAuthority The naming authority. - @param professionInfos The profession infos. - - - Produce an object suitable for an Asn1OutputStream. -

- Returns: -

-

-                   Admissions ::= SEQUENCE
-                   {
-                     admissionAuthority [0] EXPLICIT GeneralName OPTIONAL
-                     namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL
-                     professionInfos SEQUENCE OF ProfessionInfo
-                   }
-             

-

- - @return an Asn1Object -
- - Attribute to indicate admissions to certain professions. -

-

-                 AdmissionSyntax ::= SEQUENCE
-                 {
-                   admissionAuthority GeneralName OPTIONAL,
-                   contentsOfAdmissions SEQUENCE OF Admissions
-                 }
-             

- Admissions ::= SEQUENCE - { - admissionAuthority [0] EXPLICIT GeneralName OPTIONAL - namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL - professionInfos SEQUENCE OF ProfessionInfo - } -

- NamingAuthority ::= SEQUENCE - { - namingAuthorityId OBJECT IDENTIFIER OPTIONAL, - namingAuthorityUrl IA5String OPTIONAL, - namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL - } -

- ProfessionInfo ::= SEQUENCE - { - namingAuthority [0] EXPLICIT NamingAuthority OPTIONAL, - professionItems SEQUENCE OF DirectoryString (SIZE(1..128)), - professionOIDs SEQUENCE OF OBJECT IDENTIFIER OPTIONAL, - registrationNumber PrintableString(SIZE(1..128)) OPTIONAL, - addProfessionInfo OCTET STRING OPTIONAL - } -

-

-

- ISIS-MTT PROFILE: The relatively complex structure of AdmissionSyntax - supports the following concepts and requirements: -

    -
  • External institutions (e.g. professional associations, chambers, unions, - administrative bodies, companies, etc.), which are responsible for granting - and verifying professional admissions, are indicated by means of the data - field admissionAuthority. An admission authority is indicated by a - GeneralName object. Here an X.501 directory name (distinguished name) can be - indicated in the field directoryName, a URL address can be indicated in the - field uniformResourceIdentifier, and an object identifier can be indicated in - the field registeredId.
  • -
  • The names of authorities which are responsible for the administration of - title registers are indicated in the data field namingAuthority. The name of - the authority can be identified by an object identifier in the field - namingAuthorityId, by means of a text string in the field - namingAuthorityText, by means of a URL address in the field - namingAuthorityUrl, or by a combination of them. For example, the text string - can contain the name of the authority, the country and the name of the title - register. The URL-option refers to a web page which contains lists with - officially registered professions (text and possibly OID) as well as - further information on these professions. Object identifiers for the - component namingAuthorityId are grouped under the OID-branch - id-isis-at-namingAuthorities and must be applied for.
  • -
  • See http://www.teletrust.de/anwend.asp?Id=30200&Sprache=E_&HomePG=0 - for an application form and http://www.teletrust.de/links.asp?id=30220,11 - for an overview of registered naming authorities.
  • -
  • By means of the data type ProfessionInfo certain professions, - specializations, disciplines, fields of activity, etc. are identified. A - profession is represented by one or more text strings, resp. profession OIDs - in the fields professionItems and professionOIDs and by a registration number - in the field registrationNumber. An indication in text form must always be - present, whereas the other indications are optional. The component - addProfessionInfo may contain additional applicationspecific information in - DER-encoded form.
  • -
-

- By means of different namingAuthority-OIDs or profession OIDs hierarchies of - professions, specializations, disciplines, fields of activity, etc. can be - expressed. The issuing admission authority should always be indicated (field - admissionAuthority), whenever a registration number is presented. Still, - information on admissions can be given without indicating an admission or a - naming authority by the exclusive use of the component professionItems. In - this case the certification authority is responsible for the verification of - the admission information. -

-

-

- This attribute is single-valued. Still, several admissions can be captured in - the sequence structure of the component contentsOfAdmissions of - AdmissionSyntax or in the component professionInfos of Admissions. The - component admissionAuthority of AdmissionSyntax serves as default value for - the component admissionAuthority of Admissions. Within the latter component - the default value can be overwritten, in case that another authority is - responsible. The component namingAuthority of Admissions serves as a default - value for the component namingAuthority of ProfessionInfo. Within the latter - component the default value can be overwritten, in case that another naming - authority needs to be recorded. -

- The length of the string objects is limited to 128 characters. It is - recommended to indicate a namingAuthorityURL in all issued attribute - certificates. If a namingAuthorityURL is indicated, the field professionItems - of ProfessionInfo should contain only registered titles. If the field - professionOIDs exists, it has to contain the OIDs of the professions listed - in professionItems in the same order. In general, the field professionInfos - should contain only one entry, unless the admissions that are to be listed - are logically connected (e.g. they have been issued under the same admission - number). - - @see Org.BouncyCastle.Asn1.IsisMtt.X509.Admissions - @see Org.BouncyCastle.Asn1.IsisMtt.X509.ProfessionInfo - @see Org.BouncyCastle.Asn1.IsisMtt.X509.NamingAuthority - - - Constructor from Asn1Sequence. -

- The sequence is of type ProcurationSyntax: -

-

-                 AdmissionSyntax ::= SEQUENCE
-                 {
-                   admissionAuthority GeneralName OPTIONAL,
-                   contentsOfAdmissions SEQUENCE OF Admissions
-                 }
-             

- Admissions ::= SEQUENCE - { - admissionAuthority [0] EXPLICIT GeneralName OPTIONAL - namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL - professionInfos SEQUENCE OF ProfessionInfo - } -

- NamingAuthority ::= SEQUENCE - { - namingAuthorityId OBJECT IDENTIFIER OPTIONAL, - namingAuthorityUrl IA5String OPTIONAL, - namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL - } -

- ProfessionInfo ::= SEQUENCE - { - namingAuthority [0] EXPLICIT NamingAuthority OPTIONAL, - professionItems SEQUENCE OF DirectoryString (SIZE(1..128)), - professionOIDs SEQUENCE OF OBJECT IDENTIFIER OPTIONAL, - registrationNumber PrintableString(SIZE(1..128)) OPTIONAL, - addProfessionInfo OCTET STRING OPTIONAL - } -

- - @param seq The ASN.1 sequence. -
- - Constructor from given details. - - @param admissionAuthority The admission authority. - @param contentsOfAdmissions The admissions. - - - Produce an object suitable for an Asn1OutputStream. -

- Returns: -

-

-                 AdmissionSyntax ::= SEQUENCE
-                 {
-                   admissionAuthority GeneralName OPTIONAL,
-                   contentsOfAdmissions SEQUENCE OF Admissions
-                 }
-             

- Admissions ::= SEQUENCE - { - admissionAuthority [0] EXPLICIT GeneralName OPTIONAL - namingAuthority [1] EXPLICIT NamingAuthority OPTIONAL - professionInfos SEQUENCE OF ProfessionInfo - } -

- NamingAuthority ::= SEQUENCE - { - namingAuthorityId OBJECT IDENTIFIER OPTIONAL, - namingAuthorityUrl IA5String OPTIONAL, - namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL - } -

- ProfessionInfo ::= SEQUENCE - { - namingAuthority [0] EXPLICIT NamingAuthority OPTIONAL, - professionItems SEQUENCE OF DirectoryString (SIZE(1..128)), - professionOIDs SEQUENCE OF OBJECT IDENTIFIER OPTIONAL, - registrationNumber PrintableString(SIZE(1..128)) OPTIONAL, - addProfessionInfo OCTET STRING OPTIONAL - } -

- - @return an Asn1Object -
- - @return Returns the admissionAuthority if present, null otherwise. - - - @return Returns the contentsOfAdmissions. - - - A declaration of majority. -

-

-                      DeclarationOfMajoritySyntax ::= CHOICE
-                      {
-                        notYoungerThan [0] IMPLICIT INTEGER,
-                        fullAgeAtCountry [1] IMPLICIT SEQUENCE
-                        {
-                          fullAge BOOLEAN DEFAULT TRUE,
-                          country PrintableString (SIZE(2))
-                        }
-                        dateOfBirth [2] IMPLICIT GeneralizedTime
-                      }
-            
-

- fullAgeAtCountry indicates the majority of the owner with respect to the laws - of a specific country. - - - Produce an object suitable for an Asn1OutputStream. -

- Returns: -

-

-                       DeclarationOfMajoritySyntax ::= CHOICE
-                       {
-                         notYoungerThan [0] IMPLICIT INTEGER,
-                         fullAgeAtCountry [1] IMPLICIT SEQUENCE
-                         {
-                           fullAge BOOLEAN DEFAULT TRUE,
-                           country PrintableString (SIZE(2))
-                         }
-                         dateOfBirth [2] IMPLICIT GeneralizedTime
-                       }
-             
- - @return an Asn1Object -
- - @return notYoungerThan if that's what we are, -1 otherwise - - - Monetary limit for transactions. The QcEuMonetaryLimit QC statement MUST be - used in new certificates in place of the extension/attribute MonetaryLimit - since January 1, 2004. For the sake of backward compatibility with - certificates already in use, components SHOULD support MonetaryLimit (as well - as QcEuLimitValue). -

- Indicates a monetary limit within which the certificate holder is authorized - to act. (This value DOES NOT express a limit on the liability of the - certification authority). -

-

-               MonetaryLimitSyntax ::= SEQUENCE
-               {
-                 currency PrintableString (SIZE(3)),
-                 amount INTEGER,
-                 exponent INTEGER
-               }
-            
-

- currency must be the ISO code. -

- value = amount�10*exponent - - - Constructor from a given details. -

-

- value = amount�10^exponent - - @param currency The currency. Must be the ISO code. - @param amount The amount - @param exponent The exponent - - - Produce an object suitable for an Asn1OutputStream. -

- Returns: -

-

-                MonetaryLimitSyntax ::= SEQUENCE
-                {
-                  currency PrintableString (SIZE(3)),
-                  amount INTEGER,
-                  exponent INTEGER
-                }
-             
- - @return an Asn1Object -
- - Names of authorities which are responsible for the administration of title - registers. - -
-                        NamingAuthority ::= SEQUENCE 
-                        {
-                          namingAuthorityID OBJECT IDENTIFIER OPTIONAL,
-                          namingAuthorityUrl IA5String OPTIONAL,
-                          namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
-                        }
-            
- @see Org.BouncyCastle.Asn1.IsisMtt.X509.AdmissionSyntax - -
- - Profession OIDs should always be defined under the OID branch of the - responsible naming authority. At the time of this writing, the work group - �Recht, Wirtschaft, Steuern� (�Law, Economy, Taxes�) is registered as the - first naming authority under the OID id-isismtt-at-namingAuthorities. - - - Constructor from Asn1Sequence. -

-

-

-                         NamingAuthority ::= SEQUENCE
-                         {
-                           namingAuthorityID OBJECT IDENTIFIER OPTIONAL,
-                           namingAuthorityUrl IA5String OPTIONAL,
-                           namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
-                         }
-             
- - @param seq The ASN.1 sequence. -
- - @return Returns the namingAuthorityID. - - - @return Returns the namingAuthorityText. - - - @return Returns the namingAuthorityUrl. - - - Constructor from given details. -

- All parameters can be combined. - - @param namingAuthorityID ObjectIdentifier for naming authority. - @param namingAuthorityUrl URL for naming authority. - @param namingAuthorityText Textual representation of naming authority. - - - Produce an object suitable for an Asn1OutputStream. -

- Returns: -

-

-                         NamingAuthority ::= SEQUENCE
-                         {
-                           namingAuthorityID OBJECT IDENTIFIER OPTIONAL,
-                           namingAuthorityUrl IA5String OPTIONAL,
-                           namingAuthorityText DirectoryString(SIZE(1..128)) OPTIONAL
-                         }
-             
- - @return an Asn1Object -
- - Attribute to indicate that the certificate holder may sign in the name of a - third person. -

- ISIS-MTT PROFILE: The corresponding ProcurationSyntax contains either the - name of the person who is represented (subcomponent thirdPerson) or a - reference to his/her base certificate (in the component signingFor, - subcomponent certRef), furthermore the optional components country and - typeSubstitution to indicate the country whose laws apply, and respectively - the type of procuration (e.g. manager, procuration, custody). -

-

- ISIS-MTT PROFILE: The GeneralName MUST be of type directoryName and MAY only - contain: - RFC3039 attributes, except pseudonym (countryName, commonName, - surname, givenName, serialNumber, organizationName, organizationalUnitName, - stateOrProvincename, localityName, postalAddress) and - SubjectDirectoryName - attributes (title, dateOfBirth, placeOfBirth, gender, countryOfCitizenship, - countryOfResidence and NameAtBirth). -

-
-                          ProcurationSyntax ::= SEQUENCE {
-                            country [1] EXPLICIT PrintableString(SIZE(2)) OPTIONAL,
-                            typeOfSubstitution [2] EXPLICIT DirectoryString (SIZE(1..128)) OPTIONAL,
-                            signingFor [3] EXPLICIT SigningFor 
-                          }
-                          
-                          SigningFor ::= CHOICE 
-                          { 
-                            thirdPerson GeneralName,
-                            certRef IssuerSerial 
-                          }
-            
- -
- - Constructor from Asn1Sequence. -

- The sequence is of type ProcurationSyntax: -

-

-                           ProcurationSyntax ::= SEQUENCE {
-                             country [1] EXPLICIT PrintableString(SIZE(2)) OPTIONAL,
-                             typeOfSubstitution [2] EXPLICIT DirectoryString (SIZE(1..128)) OPTIONAL,
-                             signingFor [3] EXPLICIT SigningFor
-                           }
-             

- SigningFor ::= CHOICE - { - thirdPerson GeneralName, - certRef IssuerSerial - } -

- - @param seq The ASN.1 sequence. -
- - Constructor from a given details. -

-

- Either generalName or certRef MUST be - null. - - @param country The country code whose laws apply. - @param typeOfSubstitution The type of procuration. - @param certRef Reference to certificate of the person who is represented. - - - Constructor from a given details. -

-

- Either generalName or certRef MUST be - null. - - @param country The country code whose laws apply. - @param typeOfSubstitution The type of procuration. - @param thirdPerson The GeneralName of the person who is represented. - - - Produce an object suitable for an Asn1OutputStream. -

- Returns: -

-

-                           ProcurationSyntax ::= SEQUENCE {
-                             country [1] EXPLICIT PrintableString(SIZE(2)) OPTIONAL,
-                             typeOfSubstitution [2] EXPLICIT DirectoryString (SIZE(1..128)) OPTIONAL,
-                             signingFor [3] EXPLICIT SigningFor
-                           }
-             

- SigningFor ::= CHOICE - { - thirdPerson GeneralName, - certRef IssuerSerial - } -

- - @return an Asn1Object -
- - Professions, specializations, disciplines, fields of activity, etc. - -
-                          ProfessionInfo ::= SEQUENCE 
-                          {
-                            namingAuthority [0] EXPLICIT NamingAuthority OPTIONAL,
-                            professionItems SEQUENCE OF DirectoryString (SIZE(1..128)),
-                            professionOids SEQUENCE OF OBJECT IDENTIFIER OPTIONAL,
-                            registrationNumber PrintableString(SIZE(1..128)) OPTIONAL,
-                            addProfessionInfo OCTET STRING OPTIONAL 
-                          }
-            
- - @see Org.BouncyCastle.Asn1.IsisMtt.X509.AdmissionSyntax -
- - Rechtsanw�ltin - - - Rechtsanwalt - - - Rechtsbeistand - - - Steuerberaterin - - - Steuerberater - - - Steuerbevollm�chtigte - - - Steuerbevollm�chtigter - - - Notarin - - - Notar - - - Notarvertreterin - - - Notarvertreter - - - Notariatsverwalterin - - - Notariatsverwalter - - - Wirtschaftspr�ferin - - - Wirtschaftspr�fer - - - Vereidigte Buchpr�ferin - - - Vereidigter Buchpr�fer - - - Patentanw�ltin - - - Patentanwalt - - - Constructor from Asn1Sequence. -

-

-

-                           ProfessionInfo ::= SEQUENCE
-                           {
-                             namingAuthority [0] EXPLICIT NamingAuthority OPTIONAL,
-                             professionItems SEQUENCE OF DirectoryString (SIZE(1..128)),
-                             professionOids SEQUENCE OF OBJECT IDENTIFIER OPTIONAL,
-                             registrationNumber PrintableString(SIZE(1..128)) OPTIONAL,
-                             addProfessionInfo OCTET STRING OPTIONAL
-                           }
-             
- - @param seq The ASN.1 sequence. -
- - Constructor from given details. -

- professionItems is mandatory, all other parameters are - optional. - - @param namingAuthority The naming authority. - @param professionItems Directory strings of the profession. - @param professionOids DERObjectIdentfier objects for the - profession. - @param registrationNumber Registration number. - @param addProfessionInfo Additional infos in encoded form. - - - Produce an object suitable for an Asn1OutputStream. -

- Returns: -

-

-                           ProfessionInfo ::= SEQUENCE
-                           {
-                             namingAuthority [0] EXPLICIT NamingAuthority OPTIONAL,
-                             professionItems SEQUENCE OF DirectoryString (SIZE(1..128)),
-                             professionOids SEQUENCE OF OBJECT IDENTIFIER OPTIONAL,
-                             registrationNumber PrintableString(SIZE(1..128)) OPTIONAL,
-                             addProfessionInfo OCTET STRING OPTIONAL
-                           }
-             
- - @return an Asn1Object -
- - @return Returns the addProfessionInfo. - - - @return Returns the namingAuthority. - - - @return Returns the professionItems. - - - @return Returns the professionOids. - - - @return Returns the registrationNumber. - - - Some other restriction regarding the usage of this certificate. -

-

-             RestrictionSyntax ::= DirectoryString (SIZE(1..1024))
-            
-
- - Constructor from DirectoryString. -

- The DirectoryString is of type RestrictionSyntax: -

-

-                  RestrictionSyntax ::= DirectoryString (SIZE(1..1024))
-             
- - @param restriction A IAsn1String. -
- - Constructor from a given details. - - @param restriction The description of the restriction. - - - Produce an object suitable for an Asn1OutputStream. -

- Returns: -

-

-                  RestrictionSyntax ::= DirectoryString (SIZE(1..1024))
-             

-

- - @return an Asn1Object -
- - Produce an object suitable for an Asn1OutputStream. -
-            cast5CBCParameters ::= Sequence {
-                                      iv         OCTET STRING DEFAULT 0,
-                                             -- Initialization vector
-                                      keyLength  Integer
-                                             -- Key length, in bits
-                                 }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-            IDEA-CBCPar ::= Sequence {
-                                 iv    OCTET STRING OPTIONAL -- exactly 8 octets
-                             }
-            
-
- - The NetscapeCertType object. -
-               NetscapeCertType ::= BIT STRING {
-                    SSLClient               (0),
-                    SSLServer               (1),
-                    S/MIME                  (2),
-                    Object Signing          (3),
-                    Reserved                (4),
-                    SSL CA                  (5),
-                    S/MIME CA               (6),
-                    Object Signing CA       (7) }
-            
-
- - Basic constructor. - - @param usage - the bitwise OR of the Key Usage flags giving the - allowed uses for the key. - e.g. (X509NetscapeCertType.sslCA | X509NetscapeCertType.smimeCA) - - - This is designed to parse - the PublicKeyAndChallenge created by the KEYGEN tag included by - Mozilla based browsers. -
-              PublicKeyAndChallenge ::= SEQUENCE {
-                spki SubjectPublicKeyInfo,
-                challenge IA5STRING
-              }
-            
-              
-
- - - KMACwithSHAKE128-params ::= SEQUENCE { - kMACOutputLength INTEGER DEFAULT 256, -- Output length in bits - customizationString OCTET STRING DEFAULT ''H - } - - - - - KMACwithSHAKE256-params ::= SEQUENCE { - kMACOutputLength INTEGER DEFAULT 512, -- Output length in bits - customizationString OCTET STRING DEFAULT ''H - } - - - - Utility class for fetching curves using their NIST names as published in FIPS-PUB 186-3 - - - return the X9ECParameters object for the named curve represented by - the passed in object identifier. Null if the curve isn't present. - - @param oid an object identifier representing a named curve, if present. - - - return the object identifier signified by the passed in name. Null - if there is no object identifier associated with name. - - @return the object identifier associated with name, if present. - - - return the named curve name represented by the given object identifier. - - - returns an enumeration containing the name strings for curves - contained in this structure. - - - 2.16.840.1.101.3.4.3.5 - - - 2.16.840.1.101.3.4.3.6 - - - 2.16.840.1.101.3.4.3.7 - - - 2.16.840.1.101.3.4.3.8 - - - 2.16.840.1.101.3.4.3.9 - - - 2.16.840.1.101.3.4.3.10 - - - 2.16.840.1.101.3.4.3.11 - - - 2.16.840.1.101.3.4.3.12 - - - 2.16.840.1.101.3.4.3.9 - - - 2.16.840.1.101.3.4.3.10 - - - 2.16.840.1.101.3.4.3.11 - - - 2.16.840.1.101.3.4.3.12 - - - From RFC 3657 - - - Produce an object suitable for an Asn1OutputStream. -
-            BasicOcspResponse       ::= Sequence {
-                 tbsResponseData      ResponseData,
-                 signatureAlgorithm   AlgorithmIdentifier,
-                 signature            BIT STRING,
-                 certs                [0] EXPLICIT Sequence OF Certificate OPTIONAL }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-            CertID          ::=     Sequence {
-                hashAlgorithm       AlgorithmIdentifier,
-                issuerNameHash      OCTET STRING, -- Hash of Issuer's DN
-                issuerKeyHash       OCTET STRING, -- Hash of Issuers public key
-                serialNumber        CertificateSerialNumber }
-            
-
- - create a CertStatus object with a tag of zero. - - - Produce an object suitable for an Asn1OutputStream. -
-             CertStatus ::= CHOICE {
-                             good        [0]     IMPLICIT Null,
-                             revoked     [1]     IMPLICIT RevokedInfo,
-                             unknown     [2]     IMPLICIT UnknownInfo }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-            CrlID ::= Sequence {
-                crlUrl               [0]     EXPLICIT IA5String OPTIONAL,
-                crlNum               [1]     EXPLICIT Integer OPTIONAL,
-                crlTime              [2]     EXPLICIT GeneralizedTime OPTIONAL }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-            OcspRequest     ::=     Sequence {
-                tbsRequest                  TBSRequest,
-                optionalSignature   [0]     EXPLICIT Signature OPTIONAL }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-            OcspResponse ::= Sequence {
-                responseStatus         OcspResponseStatus,
-                responseBytes          [0] EXPLICIT ResponseBytes OPTIONAL }
-            
-
- - The OcspResponseStatus enumeration. -
-            OcspResponseStatus ::= Enumerated {
-                successful            (0),  --Response has valid confirmations
-                malformedRequest      (1),  --Illegal confirmation request
-                internalError         (2),  --Internal error in issuer
-                tryLater              (3),  --Try again later
-                                            --(4) is not used
-                sigRequired           (5),  --Must sign the request
-                unauthorized          (6)   --Request unauthorized
-            }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-            Request         ::=     Sequence {
-                reqCert                     CertID,
-                singleRequestExtensions     [0] EXPLICIT Extensions OPTIONAL }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-            ResponderID ::= CHOICE {
-                 byName          [1] Name,
-                 byKey           [2] KeyHash }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-            ResponseBytes ::=       Sequence {
-                responseType   OBJECT IDENTIFIER,
-                response       OCTET STRING }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-            ResponseData ::= Sequence {
-                version              [0] EXPLICIT Version DEFAULT v1,
-                responderID              ResponderID,
-                producedAt               GeneralizedTime,
-                responses                Sequence OF SingleResponse,
-                responseExtensions   [1] EXPLICIT Extensions OPTIONAL }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-            RevokedInfo ::= Sequence {
-                 revocationTime              GeneralizedTime,
-                 revocationReason    [0]     EXPLICIT CRLReason OPTIONAL }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-            ServiceLocator ::= Sequence {
-                issuer    Name,
-                locator   AuthorityInfoAccessSyntax OPTIONAL }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-            Signature       ::=     Sequence {
-                signatureAlgorithm      AlgorithmIdentifier,
-                signature               BIT STRING,
-                certs               [0] EXPLICIT Sequence OF Certificate OPTIONAL}
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-             SingleResponse ::= Sequence {
-                     certID                       CertID,
-                     certStatus                   CertStatus,
-                     thisUpdate                   GeneralizedTime,
-                     nextUpdate         [0]       EXPLICIT GeneralizedTime OPTIONAL,
-                     singleExtensions   [1]       EXPLICIT Extensions OPTIONAL }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-            TBSRequest      ::=     Sequence {
-                version             [0]     EXPLICIT Version DEFAULT v1,
-                requestorName       [1]     EXPLICIT GeneralName OPTIONAL,
-                requestList                 Sequence OF Request,
-                requestExtensions   [2]     EXPLICIT Extensions OPTIONAL }
-            
-
- - class for breaking up an Oid into it's component tokens, ala - java.util.StringTokenizer. We need this class as some of the - lightweight Java environment don't support classes like - StringTokenizer. - - - return an Attribute object from the given object. - - @param o the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-            Attr ::= Sequence {
-                attrType OBJECT IDENTIFIER,
-                attrValues Set OF AttributeValue
-            }
-            
-
- - Pkcs10 Certfication request object. -
-            CertificationRequest ::= Sequence {
-              certificationRequestInfo  CertificationRequestInfo,
-              signatureAlgorithm        AlgorithmIdentifier{{ SignatureAlgorithms }},
-              signature                 BIT STRING
-            }
-            
-
- - Pkcs10 CertificationRequestInfo object. -
-              CertificationRequestInfo ::= Sequence {
-               version             Integer { v1(0) } (v1,...),
-               subject             Name,
-               subjectPKInfo   SubjectPublicKeyInfo{{ PKInfoAlgorithms }},
-               attributes          [0] Attributes{{ CRIAttributes }}
-              }
-            
-              Attributes { ATTRIBUTE:IOSet } ::= Set OF Attr{{ IOSet }}
-            
-              Attr { ATTRIBUTE:IOSet } ::= Sequence {
-                type    ATTRIBUTE.&id({IOSet}),
-                values  Set SIZE(1..MAX) OF ATTRIBUTE.&Type({IOSet}{\@type})
-              }
-             
-
- - Produce an object suitable for an Asn1OutputStream. -
-            ContentInfo ::= Sequence {
-                     contentType ContentType,
-                     content
-                     [0] EXPLICIT ANY DEFINED BY contentType OPTIONAL }
-            
-
- - The EncryptedData object. -
-                  EncryptedData ::= Sequence {
-                       version Version,
-                       encryptedContentInfo EncryptedContentInfo
-                  }
-            
-            
-                  EncryptedContentInfo ::= Sequence {
-                      contentType ContentType,
-                      contentEncryptionAlgorithm  ContentEncryptionAlgorithmIdentifier,
-                      encryptedContent [0] IMPLICIT EncryptedContent OPTIONAL
-                }
-            
-                EncryptedContent ::= OCTET STRING
-             
-
- - Produce an object suitable for an Asn1OutputStream. -
-             EncryptedPrivateKeyInfo ::= Sequence {
-                  encryptionAlgorithm AlgorithmIdentifier {{KeyEncryptionAlgorithms}},
-                  encryptedData EncryptedData
-             }
-            
-             EncryptedData ::= OCTET STRING
-            
-             KeyEncryptionAlgorithms ALGORITHM-IDENTIFIER ::= {
-                      ... -- For local profiles
-             }
-             
-
- -
-            MacData ::= SEQUENCE {
-                mac      DigestInfo,
-                macSalt  OCTET STRING,
-                iterations INTEGER DEFAULT 1
-                -- Note: The default is for historic reasons and its use is deprecated. A
-                -- higher value, like 1024 is recommended.
-            
- @return the basic DERObject construction. -
- - the infamous Pfx from Pkcs12 - - - PKCS#1: 1.2.840.113549.1.1.15 - - - PKCS#1: 1.2.840.113549.1.1.16 - - -
-             id-alg-AEADChaCha20Poly1305 OBJECT IDENTIFIER ::=
-             { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1)
-                pkcs9(9) smime(16) alg(3) 18 }
-            
-             AEADChaCha20Poly1305Nonce ::= OCTET STRING (SIZE(12))
-             
-
- - PKCS#9: 1.2.840.113549.1.9.16.2.37 - RFC 4108 - - - PKCS#9: 1.2.840.113549.1.9.16.2.38 - RFC 4108 - - - PKCS#9: 1.2.840.113549.1.9.16.2.54 RFC7030 - - - PKCS#9: 1.2.840.113549.1.9.16.2.43 RFC7030 - - - PKCS#9: 1.2.840.113549.1.9.16.2.40 RFC7030 - - - RFC 5958 - -
-              [IMPLICIT TAGS]
-            
-              OneAsymmetricKey ::= SEQUENCE {
-                  version                   Version,
-                  privateKeyAlgorithm       PrivateKeyAlgorithmIdentifier,
-                  privateKey                PrivateKey,
-                  attributes            [0] Attributes OPTIONAL,
-                  ...,
-                  [[2: publicKey        [1] PublicKey OPTIONAL ]],
-                  ...
-              }
-            
-              PrivateKeyInfo ::= OneAsymmetricKey
-            
-              Version ::= INTEGER { v1(0), v2(1) } (v1, ..., v2)
-            
-              PrivateKeyAlgorithmIdentifier ::= AlgorithmIdentifier
-                                                 { PUBLIC-KEY,
-                                                   { PrivateKeyAlgorithms } }
-            
-              PrivateKey ::= OCTET STRING
-                                 -- Content varies based on type of key.  The
-                                 -- algorithm identifier dictates the format of
-                                 -- the key.
-            
-              PublicKey ::= BIT STRING
-                                 -- Content varies based on type of key.  The
-                                 -- algorithm identifier dictates the format of
-                                 -- the key.
-            
-              Attributes ::= SET OF Attribute { { OneAsymmetricKeyAttributes } }
-              
-
- - Return true if a public key is present, false otherwise. - - - For when the public key is an ASN.1 encoding. - - - Return the public key as a raw bit string. - - - The default version - - -
-              RSAES-OAEP-params ::= SEQUENCE {
-                 hashAlgorithm      [0] OAEP-PSSDigestAlgorithms     DEFAULT sha1,
-                 maskGenAlgorithm   [1] PKCS1MGFAlgorithms  DEFAULT mgf1SHA1,
-                 pSourceAlgorithm   [2] PKCS1PSourceAlgorithms  DEFAULT pSpecifiedEmpty
-               }
-            
-               OAEP-PSSDigestAlgorithms    ALGORITHM-IDENTIFIER ::= {
-                 { OID id-sha1 PARAMETERS NULL   }|
-                 { OID id-sha256 PARAMETERS NULL }|
-                 { OID id-sha384 PARAMETERS NULL }|
-                 { OID id-sha512 PARAMETERS NULL },
-                 ...  -- Allows for future expansion --
-               }
-               PKCS1MGFAlgorithms    ALGORITHM-IDENTIFIER ::= {
-                 { OID id-mgf1 PARAMETERS OAEP-PSSDigestAlgorithms },
-                ...  -- Allows for future expansion --
-               }
-               PKCS1PSourceAlgorithms    ALGORITHM-IDENTIFIER ::= {
-                 { OID id-pSpecified PARAMETERS OCTET STRING },
-                 ...  -- Allows for future expansion --
-              }
-             
- @return the asn1 primitive representing the parameters. -
- - This outputs the key in Pkcs1v2 format. -
-                  RsaPrivateKey ::= Sequence {
-                                      version Version,
-                                      modulus Integer, -- n
-                                      publicExponent Integer, -- e
-                                      privateExponent Integer, -- d
-                                      prime1 Integer, -- p
-                                      prime2 Integer, -- q
-                                      exponent1 Integer, -- d mod (p-1)
-                                      exponent2 Integer, -- d mod (q-1)
-                                      coefficient Integer -- (inverse of q) mod p
-                                  }
-            
-                  Version ::= Integer
-             
-

This routine is written to output Pkcs1 version 0, private keys.

-
- - The default version - - -
-             RSASSA-PSS-params ::= SEQUENCE {
-               hashAlgorithm      [0] OAEP-PSSDigestAlgorithms  DEFAULT sha1,
-                maskGenAlgorithm   [1] PKCS1MGFAlgorithms  DEFAULT mgf1SHA1,
-                saltLength         [2] INTEGER  DEFAULT 20,
-                trailerField       [3] TrailerField  DEFAULT trailerFieldBC
-              }
-            
-             OAEP-PSSDigestAlgorithms    ALGORITHM-IDENTIFIER ::= {
-                { OID id-sha1 PARAMETERS NULL   }|
-                { OID id-sha256 PARAMETERS NULL }|
-                { OID id-sha384 PARAMETERS NULL }|
-                { OID id-sha512 PARAMETERS NULL },
-                ...  -- Allows for future expansion --
-             }
-            
-             PKCS1MGFAlgorithms    ALGORITHM-IDENTIFIER ::= {
-               { OID id-mgf1 PARAMETERS OAEP-PSSDigestAlgorithms },
-                ...  -- Allows for future expansion --
-             }
-            
-             TrailerField ::= INTEGER { trailerFieldBC(1) }
-             
- @return the asn1 primitive representing the parameters. -
- - a Pkcs#7 signed data object. - - - Produce an object suitable for an Asn1OutputStream. -
-             SignedData ::= Sequence {
-                 version Version,
-                 digestAlgorithms DigestAlgorithmIdentifiers,
-                 contentInfo ContentInfo,
-                 certificates
-                     [0] IMPLICIT ExtendedCertificatesAndCertificates
-                              OPTIONAL,
-                 crls
-                     [1] IMPLICIT CertificateRevocationLists OPTIONAL,
-                 signerInfos SignerInfos }
-            
-
- - a Pkcs#7 signer info object. - - - Produce an object suitable for an Asn1OutputStream. -
-              SignerInfo ::= Sequence {
-                  version Version,
-                  issuerAndSerialNumber IssuerAndSerialNumber,
-                  digestAlgorithm DigestAlgorithmIdentifier,
-                  authenticatedAttributes [0] IMPLICIT Attributes OPTIONAL,
-                  digestEncryptionAlgorithm DigestEncryptionAlgorithmIdentifier,
-                  encryptedDigest EncryptedDigest,
-                  unauthenticatedAttributes [1] IMPLICIT Attributes OPTIONAL
-              }
-            
-              EncryptedDigest ::= OCTET STRING
-            
-              DigestAlgorithmIdentifier ::= AlgorithmIdentifier
-            
-              DigestEncryptionAlgorithmIdentifier ::= AlgorithmIdentifier
-             
-
- - the elliptic curve private key object from SEC 1 - - - ECPrivateKey ::= SEQUENCE { - version INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1), - privateKey OCTET STRING, - parameters [0] Parameters OPTIONAL, - publicKey [1] BIT STRING OPTIONAL } - - - return the X9ECParameters object for the named curve represented by - the passed in object identifier. Null if the curve isn't present. - - @param oid an object identifier representing a named curve, if present. - - - return the object identifier signified by the passed in name. Null - if there is no object identifier associated with name. - - @return the object identifier associated with name, if present. - - - return the named curve name represented by the given object identifier. - - - returns an enumeration containing the name strings for curves - contained in this structure. - - - EllipticCurve OBJECT IDENTIFIER ::= { - iso(1) identified-organization(3) certicom(132) curve(0) - } - - - Handler class for dealing with S/MIME Capabilities - - - general preferences - - - encryption algorithms preferences - - - return an Attr object from the given object. - - @param o the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - returns an ArrayList with 0 or more objects of all the capabilities - matching the passed in capability Oid. If the Oid passed is null the - entire set is returned. - - - Produce an object suitable for an Asn1OutputStream. -
-            SMIMECapabilities ::= Sequence OF SMIMECapability
-            
-
- - general preferences - - - encryption algorithms preferences - - - Produce an object suitable for an Asn1OutputStream. -
-            SMIMECapability ::= Sequence {
-                capabilityID OBJECT IDENTIFIER,
-                parameters ANY DEFINED BY capabilityID OPTIONAL
-            }
-            
-
- - Handler for creating a vector S/MIME Capabilities - - - The SmimeEncryptionKeyPreference object. -
-            SmimeEncryptionKeyPreference ::= CHOICE {
-                issuerAndSerialNumber   [0] IssuerAndSerialNumber,
-                receipentKeyId          [1] RecipientKeyIdentifier,
-                subjectAltKeyIdentifier [2] SubjectKeyIdentifier
-            }
-            
-
- - @param sKeyId the subjectKeyIdentifier value (normally the X.509 one) - - - elliptic curves defined in "ECC Brainpool Standard Curves and Curve Generation" - http://www.ecc-brainpool.org/download/draft_pkix_additional_ecc_dp.txt - - - return the X9ECParameters object for the named curve represented by - the passed in object identifier. Null if the curve isn't present. - - @param oid an object identifier representing a named curve, if present. - - - return the object identifier signified by the passed in name. Null - if there is no object identifier associated with name. - - @return the object identifier associated with name, if present. - - - return the named curve name represented by the given object identifier. - - - returns an enumeration containing the name strings for curves - contained in this structure. - - -
-            Accuracy ::= SEQUENCE {
-                        seconds        INTEGER              OPTIONAL,
-                        millis     [0] INTEGER  (1..999)    OPTIONAL,
-                        micros     [1] INTEGER  (1..999)    OPTIONAL
-                        }
-            
-
- -
-               MessageImprint ::= SEQUENCE  {
-                  hashAlgorithm                AlgorithmIdentifier,
-                  hashedMessage                OCTET STRING  }
-            
-
- -
-            TimeStampReq ::= SEQUENCE  {
-             version                      INTEGER  { v1(1) },
-             messageImprint               MessageImprint,
-               --a hash algorithm OID and the hash value of the data to be
-               --time-stamped
-             reqPolicy             TSAPolicyId              OPTIONAL,
-             nonce                 INTEGER                  OPTIONAL,
-             certReq               BOOLEAN                  DEFAULT FALSE,
-             extensions            [0] IMPLICIT Extensions  OPTIONAL
-            }
-            
-
- -
-            TimeStampResp ::= SEQUENCE  {
-              status                  PkiStatusInfo,
-              timeStampToken          TimeStampToken     OPTIONAL  }
-            
-
- -
-            
-                 TstInfo ::= SEQUENCE  {
-                    version                      INTEGER  { v1(1) },
-                    policy                       TSAPolicyId,
-                    messageImprint               MessageImprint,
-                      -- MUST have the same value as the similar field in
-                      -- TimeStampReq
-                    serialNumber                 INTEGER,
-                     -- Time-Stamping users MUST be ready to accommodate integers
-                     -- up to 160 bits.
-                    genTime                      GeneralizedTime,
-                    accuracy                     Accuracy                 OPTIONAL,
-                    ordering                     BOOLEAN             DEFAULT FALSE,
-                    nonce                        INTEGER                  OPTIONAL,
-                      -- MUST be present if the similar field was present
-                      -- in TimeStampReq.  In that case it MUST have the same value.
-                    tsa                          [0] GeneralName          OPTIONAL,
-                    extensions                   [1] IMPLICIT Extensions   OPTIONAL  }
-            
-             
-
- - - Base OID: 1.2.804.2.1.1.1 - - - DSTU4145 Little Endian presentation. OID: 1.2.804.2.1.1.1.1.3.1.1 - - - DSTU4145 Big Endian presentation. OID: 1.2.804.2.1.1.1.1.3.1.1.1 - - - DSTU7564 256-bit digest presentation. - - - DSTU7564 384-bit digest presentation. - - - DSTU7564 512-bit digest presentation. - - - DSTU7564 256-bit mac presentation. - - - DSTU7564 384-bit mac presentation. - - - DSTU7564 512-bit mac presentation. - - - DSTU7624 in ECB mode with 128 bit block/key presentation - - - DSTU7624 in ECB mode with 256 bit block/key presentation - - - DSTU7624 in ECB mode with 512 bit block/key presentation - - - DSTU7624 in CTR mode with 128 bit block/key presentation - - - DSTU7624 in CTR mode with 256 bit block/key presentation - - - DSTU7624 in CTR mode with 512 bit block/key presentation - - - DSTU7624 in CFB mode with 128 bit block/key presentation - - - DSTU7624 in CFB mode with 256 bit block/key presentation - - - DSTU7624 in CFB mode with 512 bit block/key presentation - - - DSTU7624 in MAC mode with 128 bit block/key presentation - - - DSTU7624 in MAC mode with 256 bit block/key presentation - - - DSTU7624 in MAC mode with 512 bit block/key presentation - - - DSTU7624 in CBC mode with 128 bit block/key presentation - - - DSTU7624 in CBC mode with 256 bit block/key presentation - - - DSTU7624 in CBC mode with 512 bit block/key presentation - - - DSTU7624 in OFB mode with 128 bit block/key presentation - - - DSTU7624 in OFB mode with 256 bit block/key presentation - - - DSTU7624 in OFB mode with 512 bit block/key presentation - - - DSTU7624 in GMAC (GCM witout encryption) mode with 128 bit block/key presentation - - - DSTU7624 in GMAC (GCM witout encryption) mode with 256 bit block/key presentation - - - DSTU7624 in GMAC (GCM witout encryption) mode with 512 bit block/key presentation - - - DSTU7624 in CCM mode with 128 bit block/key presentation - - - DSTU7624 in CCM mode with 256 bit block/key presentation - - - DSTU7624 in CCM mode with 512 bit block/key presentation - - - DSTU7624 in XTS mode with 128 bit block/key presentation - - - DSTU7624 in XTS mode with 256 bit block/key presentation - - - DSTU7624 in XTS mode with 512 bit block/key presentation - - - DSTU7624 in key wrap (KW) mode with 128 bit block/key presentation - - - DSTU7624 in key wrap (KW) mode with 256 bit block/key presentation - - - DSTU7624 in key wrap (KW) mode with 512 bit block/key presentation - - - dump a Der object as a formatted string with indentation - - @param obj the Asn1Object to be dumped out. - - - dump out a DER object as a formatted string, in non-verbose mode - - @param obj the Asn1Encodable to be dumped out. - @return the resulting string. - - - Dump out the object as a string - - @param obj the Asn1Encodable to be dumped out. - @param verbose if true, dump out the contents of octet and bit strings. - @return the resulting string. - - - Holding class for the AttributeTypeAndValue structures that make up an RDN. - - -
-            AttributeTypeAndValue ::= SEQUENCE {
-                      type         OBJECT IDENTIFIER,
-                      value        ANY DEFINED BY type }
-            
- @return a basic ASN.1 object representation. -
- -
-             DirectoryString ::= CHOICE {
-               teletexString               TeletexString (SIZE (1..MAX)),
-               printableString             PrintableString (SIZE (1..MAX)),
-               universalString             UniversalString (SIZE (1..MAX)),
-               utf8String                  UTF8String (SIZE (1..MAX)),
-               bmpString                   BMPString (SIZE (1..MAX))  }
-            
-
- - Holding class for a single Relative Distinguished Name (RDN). - - - Create a single valued RDN. - - @param oid RDN type. - @param value RDN value. - - - Create a multi-valued RDN. - - @param aAndVs attribute type/value pairs making up the RDN - - - Return the number of AttributeTypeAndValue objects in this RDN, - - @return size of RDN, greater than 1 if multi-valued. - - - *
-                     * RelativeDistinguishedName ::=
-                     *                     SET OF AttributeTypeAndValue
-            
-                     * AttributeTypeAndValue ::= SEQUENCE {
-                     *        type     AttributeType,
-                     *        value    AttributeValue }
-                     * 
- * @return this object as its ASN1Primitive type -
- - The AccessDescription object. -
-            AccessDescription  ::=  SEQUENCE {
-                  accessMethod          OBJECT IDENTIFIER,
-                  accessLocation        GeneralName  }
-            
-
- - create an AccessDescription with the oid and location provided. - - - - @return the access method. - - - - @return the access location - - - - Return the OID in the Algorithm entry of this identifier. - - - - - Return the parameters structure in the Parameters entry of this identifier. - - - - Produce an object suitable for an Asn1OutputStream. -
-                 AlgorithmIdentifier ::= Sequence {
-                                       algorithm OBJECT IDENTIFIER,
-                                       parameters ANY DEFINED BY algorithm OPTIONAL }
-            
-
- - - Don't use this one if you are trying to be RFC 3281 compliant. - Use it for v1 attribute certificates only. - - Our GeneralNames structure - - - Produce an object suitable for an Asn1OutputStream. -
-             AttCertIssuer ::= CHOICE {
-                  v1Form   GeneralNames,  -- MUST NOT be used in this
-                                          -- profile
-                  v2Form   [0] V2Form     -- v2 only
-             }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-             AttCertValidityPeriod  ::= Sequence {
-                  notBeforeTime  GeneralizedTime,
-                  notAfterTime   GeneralizedTime
-             }
-            
-
- - return an Attr object from the given object. - - @param o the object we want converted. - @exception ArgumentException if the object cannot be converted. - - - Produce an object suitable for an Asn1OutputStream. -
-            Attr ::= Sequence {
-                attrType OBJECT IDENTIFIER,
-                attrValues Set OF AttributeValue
-            }
-            
-
- - @param obj - @return - - - Produce an object suitable for an Asn1OutputStream. -
-             AttributeCertificate ::= Sequence {
-                  acinfo               AttributeCertificateInfo,
-                  signatureAlgorithm   AlgorithmIdentifier,
-                  signatureValue       BIT STRING
-             }
-            
-
- - Produce an object suitable for an Asn1OutputStream. -
-              AttributeCertificateInfo ::= Sequence {
-                   version              AttCertVersion -- version is v2,
-                   holder               Holder,
-                   issuer               AttCertIssuer,
-                   signature            AlgorithmIdentifier,
-                   serialNumber         CertificateSerialNumber,
-                   attrCertValidityPeriod   AttCertValidityPeriod,
-                   attributes           Sequence OF Attr,
-                   issuerUniqueID       UniqueIdentifier OPTIONAL,
-                   extensions           Extensions OPTIONAL
-              }
-            
-              AttCertVersion ::= Integer { v2(1) }
-             
-
- - The AuthorityInformationAccess object. -
-             id-pe-authorityInfoAccess OBJECT IDENTIFIER ::= { id-pe 1 }
-            
-             AuthorityInfoAccessSyntax  ::=
-                  Sequence SIZE (1..MAX) OF AccessDescription
-             AccessDescription  ::=  Sequence {
-                   accessMethod          OBJECT IDENTIFIER,
-                   accessLocation        GeneralName  }
-            
-             id-ad OBJECT IDENTIFIER ::= { id-pkix 48 }
-             id-ad-caIssuers OBJECT IDENTIFIER ::= { id-ad 2 }
-             id-ad-ocsp OBJECT IDENTIFIER ::= { id-ad 1 }
-             
-
- - create an AuthorityInformationAccess with the oid and location provided. - - - The AuthorityKeyIdentifier object. -
-             id-ce-authorityKeyIdentifier OBJECT IDENTIFIER ::=  { id-ce 35 }
-            
-               AuthorityKeyIdentifier ::= Sequence {
-                  keyIdentifier             [0] IMPLICIT KeyIdentifier           OPTIONAL,
-                  authorityCertIssuer       [1] IMPLICIT GeneralNames            OPTIONAL,
-                  authorityCertSerialNumber [2] IMPLICIT CertificateSerialNumber OPTIONAL  }
-            
-               KeyIdentifier ::= OCTET STRING
-             
- -
- - * - * Calulates the keyidentifier using a SHA1 hash over the BIT STRING - * from SubjectPublicKeyInfo as defined in RFC2459. - * - * Example of making a AuthorityKeyIdentifier: - *
-            	     *   SubjectPublicKeyInfo apki = new SubjectPublicKeyInfo((ASN1Sequence)new ASN1InputStream(
-            		 *       publicKey.getEncoded()).readObject());
-                     *   AuthorityKeyIdentifier aki = new AuthorityKeyIdentifier(apki);
-                     * 
- * - * -
- - create an AuthorityKeyIdentifier with the GeneralNames tag and - the serial number provided as well. - - - create an AuthorityKeyIdentifier with the GeneralNames tag and - the serial number provided. - - - create an AuthorityKeyIdentifier with a precomputed key identifier - - - create an AuthorityKeyIdentifier with a precomupted key identifier - and the GeneralNames tag and the serial number provided as well. - - - Produce an object suitable for an Asn1OutputStream. - - - create a cA=true object for the given path length constraint. - - @param pathLenConstraint - - - Produce an object suitable for an Asn1OutputStream. -
-            BasicConstraints := Sequence {
-               cA                  Boolean DEFAULT FALSE,
-               pathLenConstraint   Integer (0..MAX) OPTIONAL
-            }
-            
-
- - PKIX RFC-2459 - - The X.509 v2 CRL syntax is as follows. For signature calculation, - the data that is to be signed is ASN.1 Der encoded. - -
-             CertificateList  ::=  Sequence  {
-                  tbsCertList          TbsCertList,
-                  signatureAlgorithm   AlgorithmIdentifier,
-                  signatureValue       BIT STRING  }
-             
-
- - This class helps to support crossCerfificatePairs in a LDAP directory - according RFC 2587 - -
-                 crossCertificatePairATTRIBUTE::={
-                   WITH SYNTAX   CertificatePair
-                   EQUALITY MATCHING RULE certificatePairExactMatch
-                   ID joint-iso-ccitt(2) ds(5) attributeType(4) crossCertificatePair(40)}
-             
- -
The forward elements of the crossCertificatePair attribute of a - CA's directory entry shall be used to store all, except self-issued - certificates issued to this CA. Optionally, the reverse elements of the - crossCertificatePair attribute, of a CA's directory entry may contain a - subset of certificates issued by this CA to other CAs. When both the forward - and the reverse elements are present in a single attribute value, issuer name - in one certificate shall match the subject name in the other and vice versa, - and the subject public key in one certificate shall be capable of verifying - the digital signature on the other certificate and vice versa. - - When a reverse element is present, the forward element value and the reverse - element value need not be stored in the same attribute value; in other words, - they can be stored in either a single attribute value or two attribute - values.
- -
-                   CertificatePair ::= SEQUENCE {
-                     forward		[0]	Certificate OPTIONAL,
-                     reverse		[1]	Certificate OPTIONAL,
-                     -- at least one of the pair shall be present -- }
-             
-
- - Constructor from Asn1Sequence. -

- The sequence is of type CertificatePair: -

-

-                   CertificatePair ::= SEQUENCE {
-                     forward		[0]	Certificate OPTIONAL,
-                     reverse		[1]	Certificate OPTIONAL,
-                     -- at least one of the pair shall be present -- }
-             
- - @param seq The ASN.1 sequence. -
- - Constructor from a given details. - - @param forward Certificates issued to this CA. - @param reverse Certificates issued by this CA to other CAs. - - - Produce an object suitable for an Asn1OutputStream. -

- Returns: -

-

-                   CertificatePair ::= SEQUENCE {
-                     forward		[0]	Certificate OPTIONAL,
-                     reverse		[1]	Certificate OPTIONAL,
-                     -- at least one of the pair shall be present -- }
-             
- - @return a DERObject -
- - @return Returns the forward. - - - @return Returns the reverse. - - - Construct a CertificatePolicies object containing one PolicyInformation. - - @param name the name to be contained. - - - Produce an object suitable for an ASN1OutputStream. -
-            CertificatePolicies ::= SEQUENCE SIZE {1..MAX} OF PolicyInformation
-            
-
- - CertPolicyId, used in the CertificatePolicies and PolicyMappings - X509V3 Extensions. - -
-                 CertPolicyId ::= OBJECT IDENTIFIER
-             
-
- - Return the distribution points making up the sequence. - - @return DistributionPoint[] - - - Produce an object suitable for an Asn1OutputStream. -
-            CrlDistPoint ::= Sequence SIZE {1..MAX} OF DistributionPoint
-            
-
- - The CRLNumber object. -
-            CRLNumber::= Integer(0..MAX)
-            
-
- - The CRLReason enumeration. -
-            CRLReason ::= Enumerated {
-             unspecified             (0),
-             keyCompromise           (1),
-             cACompromise            (2),
-             affiliationChanged      (3),
-             superseded              (4),
-             cessationOfOperation    (5),
-             certificateHold         (6),
-             removeFromCRL           (8),
-             privilegeWithdrawn      (9),
-             aACompromise           (10)
-            }
-            
-
- - The DigestInfo object. -
-            DigestInfo::=Sequence{
-                     digestAlgorithm  AlgorithmIdentifier,
-                     digest OCTET STRING }
-            
-
- - DisplayText class, used in - CertificatePolicies X509 V3 extensions (in policy qualifiers). - -

It stores a string in a chosen encoding. -

-             DisplayText ::= CHOICE {
-                  ia5String        IA5String      (SIZE (1..200)),
-                  visibleString    VisibleString  (SIZE (1..200)),
-                  bmpString        BMPString      (SIZE (1..200)),
-                  utf8String       UTF8String     (SIZE (1..200)) }
-             

- @see PolicyQualifierInfo - @see PolicyInformation -
- - Constant corresponding to ia5String encoding. - - - - Constant corresponding to bmpString encoding. - - - - Constant corresponding to utf8String encoding. - - - - Constant corresponding to visibleString encoding. - - - - Describe constant DisplayTextMaximumSize here. - - - - Creates a new DisplayText instance. - - @param type the desired encoding type for the text. - @param text the text to store. Strings longer than 200 - characters are truncated. - - - Creates a new DisplayText instance. - - @param text the text to encapsulate. Strings longer than 200 - characters are truncated. - - - Creates a new DisplayText instance. -

Useful when reading back a DisplayText class - from it's Asn1Encodable form.

- - @param contents an Asn1Encodable instance. -
- - Returns the stored string object. - - @return the stored text as a string. - - - The DistributionPoint object. -
-            DistributionPoint ::= Sequence {
-                 distributionPoint [0] DistributionPointName OPTIONAL,
-                 reasons           [1] ReasonFlags OPTIONAL,
-                 cRLIssuer         [2] GeneralNames OPTIONAL
-            }
-            
-
- - The DistributionPointName object. -
-            DistributionPointName ::= CHOICE {
-                fullName                 [0] GeneralNames,
-                nameRelativeToCRLIssuer  [1] RDN
-            }
-            
-
- - The extendedKeyUsage object. -
-                 extendedKeyUsage ::= Sequence SIZE (1..MAX) OF KeyPurposeId
-            
-
- - Returns all extended key usages. - The returned ArrayList contains DerObjectIdentifier instances. - @return An ArrayList with all key purposes. - - - The GeneralName object. -
-             GeneralName ::= CHOICE {
-                  otherName                       [0]     OtherName,
-                  rfc822Name                      [1]     IA5String,
-                  dNSName                         [2]     IA5String,
-                  x400Address                     [3]     ORAddress,
-                  directoryName                   [4]     Name,
-                  ediPartyName                    [5]     EDIPartyName,
-                  uniformResourceIdentifier       [6]     IA5String,
-                  iPAddress                       [7]     OCTET STRING,
-                  registeredID                    [8]     OBJECT IDENTIFIER}
-            
-             OtherName ::= Sequence {
-                  type-id    OBJECT IDENTIFIER,
-                  value      [0] EXPLICIT ANY DEFINED BY type-id }
-            
-             EDIPartyName ::= Sequence {
-                  nameAssigner            [0]     DirectoryString OPTIONAL,
-                  partyName               [1]     DirectoryString }
-             
-
- - When the subjectAltName extension contains an Internet mail address, - the address MUST be included as an rfc822Name. The format of an - rfc822Name is an "addr-spec" as defined in RFC 822 [RFC 822]. - - When the subjectAltName extension contains a domain name service - label, the domain name MUST be stored in the dNSName (an IA5String). - The name MUST be in the "preferred name syntax," as specified by RFC - 1034 [RFC 1034]. - - When the subjectAltName extension contains a URI, the name MUST be - stored in the uniformResourceIdentifier (an IA5String). The name MUST - be a non-relative URL, and MUST follow the URL syntax and encoding - rules specified in [RFC 1738]. The name must include both a scheme - (e.g., "http" or "ftp") and a scheme-specific-part. The scheme- - specific-part must include a fully qualified domain name or IP - address as the host. - - When the subjectAltName extension contains a iPAddress, the address - MUST be stored in the octet string in "network byte order," as - specified in RFC 791 [RFC 791]. The least significant bit (LSB) of - each octet is the LSB of the corresponding byte in the network - address. For IP Version 4, as specified in RFC 791, the octet string - MUST contain exactly four octets. For IP Version 6, as specified in - RFC 1883, the octet string MUST contain exactly sixteen octets [RFC - 1883]. - - - Create a GeneralName for the given tag from the passed in string. -

- This constructor can handle: -

    -
  • rfc822Name
  • -
  • iPAddress
  • -
  • directoryName
  • -
  • dNSName
  • -
  • uniformResourceIdentifier
  • -
  • registeredID
  • -
- For x400Address, otherName and ediPartyName there is no common string - format defined. -

- Note: A directory name can be encoded in different ways into a byte - representation. Be aware of this if the byte representation is used for - comparing results. -

- - @param tag tag number - @param name string representation of name - @throws ArgumentException if the string encoding is not correct or - not supported. -
- - Construct a GeneralNames object containing one GeneralName. - The name to be contained. - - - Produce an object suitable for an Asn1OutputStream. -
-            GeneralNames ::= Sequence SIZE {1..MAX} OF GeneralName
-            
-
- - Class for containing a restriction object subtrees in NameConstraints. See - RFC 3280. - -
-            
-                   GeneralSubtree ::= SEQUENCE
-                   {
-                     baseName                    GeneralName,
-                     minimum         [0]     BaseDistance DEFAULT 0,
-                     maximum         [1]     BaseDistance OPTIONAL
-                   }
-             
- - @see org.bouncycastle.asn1.x509.NameConstraints - -
- - Constructor from a given details. - - According RFC 3280, the minimum and maximum fields are not used with any - name forms, thus minimum MUST be zero, and maximum MUST be absent. -

- If minimum is null, zero is assumed, if - maximum is null, maximum is absent.

- - @param baseName - A restriction. - @param minimum - Minimum - - @param maximum - Maximum -
- - Produce an object suitable for an Asn1OutputStream. - - Returns: - -
-                   GeneralSubtree ::= SEQUENCE
-                   {
-                     baseName                    GeneralName,
-                     minimum         [0]     BaseDistance DEFAULT 0,
-                     maximum         [1]     BaseDistance OPTIONAL
-                   }
-             
- - @return a DERObject -
- - The Holder object. -

- For an v2 attribute certificate this is: - -

-                       Holder ::= SEQUENCE {
-                             baseCertificateID   [0] IssuerSerial OPTIONAL,
-                                      -- the issuer and serial number of
-                                      -- the holder's Public Key Certificate
-                             entityName          [1] GeneralNames OPTIONAL,
-                                      -- the name of the claimant or role
-                             objectDigestInfo    [2] ObjectDigestInfo OPTIONAL
-                                      -- used to directly authenticate the holder,
-                                      -- for example, an executable
-                       }
-            
-

-

- For an v1 attribute certificate this is: - -

-                    subject CHOICE {
-                     baseCertificateID [0] EXPLICIT IssuerSerial,
-                     -- associated with a Public Key Certificate
-                     subjectName [1] EXPLICIT GeneralNames },
-                     -- associated with a name
-            
-

-
- - Constructor for a holder for an v1 attribute certificate. - - @param tagObj The ASN.1 tagged holder object. - - - Constructor for a holder for an v2 attribute certificate. * - - @param seq The ASN.1 sequence. - - - Constructs a holder from a IssuerSerial. - @param baseCertificateID The IssuerSerial. - @param version The version of the attribute certificate. - - - Returns 1 for v2 attribute certificates or 0 for v1 attribute - certificates. - @return The version of the attribute certificate. - - - Constructs a holder with an entityName for v2 attribute certificates or - with a subjectName for v1 attribute certificates. - - @param entityName The entity or subject name. - - - Constructs a holder with an entityName for v2 attribute certificates or - with a subjectName for v1 attribute certificates. - - @param entityName The entity or subject name. - @param version The version of the attribute certificate. - - - Constructs a holder from an object digest info. - - @param objectDigestInfo The object digest info object. - - - Returns the entityName for an v2 attribute certificate or the subjectName - for an v1 attribute certificate. - - @return The entityname or subjectname. - - - The Holder object. -
-             Holder ::= Sequence {
-                   baseCertificateID   [0] IssuerSerial OPTIONAL,
-                            -- the issuer and serial number of
-                            -- the holder's Public Key Certificate
-                   entityName          [1] GeneralNames OPTIONAL,
-                            -- the name of the claimant or role
-                   objectDigestInfo    [2] ObjectDigestInfo OPTIONAL
-                            -- used to directly authenticate the holder,
-                            -- for example, an executable
-             }
-            
-
- - Implementation of IetfAttrSyntax as specified by RFC3281. - - - - - - -
-            
-              IetfAttrSyntax ::= Sequence {
-                policyAuthority [0] GeneralNames OPTIONAL,
-                values Sequence OF CHOICE {
-                  octets OCTET STRING,
-                  oid OBJECT IDENTIFIER,
-                  string UTF8String
-                }
-              }
-            
-             
-
- - Produce an object suitable for an Asn1OutputStream. -
-             IssuerSerial  ::=  Sequence {
-                  issuer         GeneralNames,
-                  serial         CertificateSerialNumber,
-                  issuerUid      UniqueIdentifier OPTIONAL
-             }
-            
-
- -
-            IssuingDistributionPoint ::= SEQUENCE { 
-              distributionPoint          [0] DistributionPointName OPTIONAL, 
-              onlyContainsUserCerts      [1] BOOLEAN DEFAULT FALSE, 
-              onlyContainsCACerts        [2] BOOLEAN DEFAULT FALSE, 
-              onlySomeReasons            [3] ReasonFlags OPTIONAL, 
-              indirectCRL                [4] BOOLEAN DEFAULT FALSE,
-              onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE }
-            
-
- - Constructor from given details. - - @param distributionPoint - May contain an URI as pointer to most current CRL. - @param onlyContainsUserCerts Covers revocation information for end certificates. - @param onlyContainsCACerts Covers revocation information for CA certificates. - - @param onlySomeReasons - Which revocation reasons does this point cover. - @param indirectCRL - If true then the CRL contains revocation - information about certificates ssued by other CAs. - @param onlyContainsAttributeCerts Covers revocation information for attribute certificates. - - - Constructor from Asn1Sequence - - - @return Returns the distributionPoint. - - - @return Returns the onlySomeReasons. - - - The KeyPurposeID object. -
-                KeyPurposeID ::= OBJECT IDENTIFIER
-            
-
- - The KeyUsage object. -
-                id-ce-keyUsage OBJECT IDENTIFIER ::=  { id-ce 15 }
-            
-                KeyUsage ::= BIT STRING {
-                     digitalSignature        (0),
-                     nonRepudiation          (1),
-                     keyEncipherment         (2),
-                     dataEncipherment        (3),
-                     keyAgreement            (4),
-                     keyCertSign             (5),
-                     cRLSign                 (6),
-                     encipherOnly            (7),
-                     decipherOnly            (8) }
-             
-
- - Basic constructor. - - @param usage - the bitwise OR of the Key Usage flags giving the - allowed uses for the key. - e.g. (KeyUsage.keyEncipherment | KeyUsage.dataEncipherment) - - - Constructor from a given details. - -

permitted and excluded are Vectors of GeneralSubtree objects.

- - @param permitted Permitted subtrees - @param excluded Excluded subtrees -
- - NoticeReference class, used in - CertificatePolicies X509 V3 extensions - (in policy qualifiers). - -
-              NoticeReference ::= Sequence {
-                  organization     DisplayText,
-                  noticeNumbers    Sequence OF Integer }
-            
-             
- - @see PolicyQualifierInfo - @see PolicyInformation -
- - Creates a new NoticeReference instance. - - @param organization a String value - @param numbers a Vector value - - - Creates a new NoticeReference instance. - - @param organization a String value - @param noticeNumbers an ASN1EncodableVector value - - - Creates a new NoticeReference instance. - - @param organization displayText - @param noticeNumbers an ASN1EncodableVector value - - - Creates a new NoticeReference instance. -

Useful for reconstructing a NoticeReference - instance from its encodable/encoded form.

- - @param as an Asn1Sequence value obtained from either - calling @{link ToAsn1Object()} for a NoticeReference - instance or from parsing it from a Der-encoded stream. -
- - Describe ToAsn1Object method here. - - @return a Asn1Object value - - - ObjectDigestInfo ASN.1 structure used in v2 attribute certificates. - -
-             
-               ObjectDigestInfo ::= SEQUENCE {
-                    digestedObjectType  ENUMERATED {
-                            publicKey            (0),
-                            publicKeyCert        (1),
-                            otherObjectTypes     (2) },
-                                    -- otherObjectTypes MUST NOT
-                                    -- be used in this profile
-                    otherObjectTypeID   OBJECT IDENTIFIER OPTIONAL,
-                    digestAlgorithm     AlgorithmIdentifier,
-                    objectDigest        BIT STRING
-               }
-              
-            
- -
- - The public key is hashed. - - - The public key certificate is hashed. - - - An other object is hashed. - - - Constructor from given details. -

- If digestedObjectType is not {@link #publicKeyCert} or - {@link #publicKey} otherObjectTypeID must be given, - otherwise it is ignored.

- - @param digestedObjectType The digest object type. - @param otherObjectTypeID The object type ID for - otherObjectDigest. - @param digestAlgorithm The algorithm identifier for the hash. - @param objectDigest The hash value. -
- - Produce an object suitable for an Asn1OutputStream. - -
-             
-               ObjectDigestInfo ::= SEQUENCE {
-                    digestedObjectType  ENUMERATED {
-                            publicKey            (0),
-                            publicKeyCert        (1),
-                            otherObjectTypes     (2) },
-                                    -- otherObjectTypes MUST NOT
-                                    -- be used in this profile
-                    otherObjectTypeID   OBJECT IDENTIFIER OPTIONAL,
-                    digestAlgorithm     AlgorithmIdentifier,
-                    objectDigest        BIT STRING
-               }
-              
-            
-
- - The OtherName object. -
-            OtherName ::= SEQUENCE {
-                 type-id    OBJECT IDENTIFIER,
-                 value      [0] EXPLICIT ANY DEFINED BY type-id }
-            
-
- - OtherName factory method. - @param obj the object used to construct an instance of - OtherName. It must be an instance of OtherName - or ASN1Sequence. - @return the instance of OtherName built from the - supplied object. - @throws java.lang.IllegalArgumentException if the object passed - to the factory is not an instance of OtherName or something that - can be converted into an appropriate ASN1Sequence. - - - Base constructor. - @param typeID the type of the other name. - @param value the ANY object that represents the value. - - - PolicyMappings V3 extension, described in RFC3280. -
-                PolicyMappings ::= Sequence SIZE (1..MAX) OF Sequence {
-                  issuerDomainPolicy      CertPolicyId,
-                  subjectDomainPolicy     CertPolicyId }
-             
- - @see RFC 3280, section 4.2.1.6 -
- - Creates a new PolicyMappings instance. - - @param seq an Asn1Sequence constructed as specified - in RFC 3280 - - - Creates a new PolicyMappings instance. - - @param mappings a HashMap value that maps - string oids - to other string oids. - - - PolicyQualifierId, used in the CertificatePolicies - X509V3 extension. - -
-                id-qt          OBJECT IDENTIFIER ::=  { id-pkix 2 }
-                id-qt-cps      OBJECT IDENTIFIER ::=  { id-qt 1 }
-                id-qt-unotice  OBJECT IDENTIFIER ::=  { id-qt 2 }
-              PolicyQualifierId ::=
-                   OBJECT IDENTIFIER ( id-qt-cps | id-qt-unotice )
-             
-
- - Policy qualifiers, used in the X509V3 CertificatePolicies - extension. - -
-               PolicyQualifierInfo ::= Sequence {
-                   policyQualifierId  PolicyQualifierId,
-                   qualifier          ANY DEFINED BY policyQualifierId }
-             
-
- - Creates a new PolicyQualifierInfo instance. - - @param policyQualifierId a PolicyQualifierId value - @param qualifier the qualifier, defined by the above field. - - - Creates a new PolicyQualifierInfo containing a - cPSuri qualifier. - - @param cps the CPS (certification practice statement) uri as a - string. - - - Creates a new PolicyQualifierInfo instance. - - @param as PolicyQualifierInfo X509 structure - encoded as an Asn1Sequence. - - - Returns a Der-encodable representation of this instance. - - @return a Asn1Object value - - - -
-            PrivateKeyUsagePeriod ::= SEQUENCE
-            {
-            notBefore       [0]     GeneralizedTime OPTIONAL,
-            notAfter        [1]     GeneralizedTime OPTIONAL }
-            
-
-
- - The BiometricData object. -
-            BiometricData  ::=  SEQUENCE {
-                  typeOfBiometricData  TypeOfBiometricData,
-                  hashAlgorithm        AlgorithmIdentifier,
-                  biometricDataHash    OCTET STRING,
-                  sourceDataUri        IA5String OPTIONAL  }
-            
-
- - The Iso4217CurrencyCode object. -
-            Iso4217CurrencyCode  ::=  CHOICE {
-                  alphabetic              PrintableString (SIZE 3), --Recommended
-                  numeric              INTEGER (1..999) }
-            -- Alphabetic or numeric currency code as defined in ISO 4217
-            -- It is recommended that the Alphabetic form is used
-            
-
- - The MonetaryValue object. -
-            MonetaryValue  ::=  SEQUENCE {
-                  currency              Iso4217CurrencyCode,
-                  amount               INTEGER,
-                  exponent             INTEGER }
-            -- value = amount * 10^exponent
-            
-
- - The QCStatement object. -
-            QCStatement ::= SEQUENCE {
-              statementId        OBJECT IDENTIFIER,
-              statementInfo      ANY DEFINED BY statementId OPTIONAL}
-            
-
- - The SemanticsInformation object. -
-                   SemanticsInformation ::= SEQUENCE {
-                     semanticsIdentifier        OBJECT IDENTIFIER   OPTIONAL,
-                     nameRegistrationAuthorities NameRegistrationAuthorities
-                                                                     OPTIONAL }
-                     (WITH COMPONENTS {..., semanticsIdentifier PRESENT}|
-                      WITH COMPONENTS {..., nameRegistrationAuthorities PRESENT})
-            
-                 NameRegistrationAuthorities ::=  SEQUENCE SIZE (1..MAX) OF
-                     GeneralName
-             
-
- - The TypeOfBiometricData object. -
-             TypeOfBiometricData ::= CHOICE {
-               predefinedBiometricType   PredefinedBiometricType,
-               biometricDataOid          OBJECT IDENTIFIER }
-            
-             PredefinedBiometricType ::= INTEGER {
-               picture(0),handwritten-signature(1)}
-               (picture|handwritten-signature)
-             
-
- - The ReasonFlags object. -
-            ReasonFlags ::= BIT STRING {
-               unused(0),
-               keyCompromise(1),
-               cACompromise(2),
-               affiliationChanged(3),
-               superseded(4),
-               cessationOfOperation(5),
-               certficateHold(6)
-            }
-            
-
- - @param reasons - the bitwise OR of the Key Reason flags giving the - allowed uses for the key. - - - Implementation of the RoleSyntax object as specified by the RFC3281. - -
-             RoleSyntax ::= SEQUENCE {
-                             roleAuthority  [0] GeneralNames OPTIONAL,
-                             roleName       [1] GeneralName
-                       }
-             
-
- - RoleSyntax factory method. - @param obj the object used to construct an instance of - RoleSyntax. It must be an instance of RoleSyntax - or Asn1Sequence. - @return the instance of RoleSyntax built from the - supplied object. - @throws java.lang.ArgumentException if the object passed - to the factory is not an instance of RoleSyntax or - Asn1Sequence. - - - Constructor. - @param roleAuthority the role authority of this RoleSyntax. - @param roleName the role name of this RoleSyntax. - - - Constructor. Invoking this constructor is the same as invoking - new RoleSyntax(null, roleName). - @param roleName the role name of this RoleSyntax. - - - Utility constructor. Takes a string argument representing - the role name, builds a GeneralName to hold the role name - and calls the constructor that takes a GeneralName. - @param roleName - - - Constructor that builds an instance of RoleSyntax by - extracting the encoded elements from the Asn1Sequence - object supplied. - @param seq an instance of Asn1Sequence that holds - the encoded elements used to build this RoleSyntax. - - - Gets the role authority of this RoleSyntax. - @return an instance of GeneralNames holding the - role authority of this RoleSyntax. - - - Gets the role name of this RoleSyntax. - @return an instance of GeneralName holding the - role name of this RoleSyntax. - - - Gets the role name as a java.lang.string object. - @return the role name of this RoleSyntax represented as a - string object. - - - Gets the role authority as a string[] object. - @return the role authority of this RoleSyntax represented as a - string[] array. - - - Implementation of the method ToAsn1Object as - required by the superclass ASN1Encodable. - -
-             RoleSyntax ::= SEQUENCE {
-                             roleAuthority  [0] GeneralNames OPTIONAL,
-                             roleName       [1] GeneralName
-                       }
-             
-
- - This outputs the key in Pkcs1v2 format. -
-                 RSAPublicKey ::= Sequence {
-                                     modulus Integer, -- n
-                                     publicExponent Integer, -- e
-                                 }
-            
-
- - Structure for a name or pseudonym. - -
-                  NameOrPseudonym ::= CHOICE {
-                	   surAndGivenName SEQUENCE {
-                	     surName DirectoryString,
-                	     givenName SEQUENCE OF DirectoryString 
-                    },
-                	   pseudonym DirectoryString 
-                  }
-            
- - @see org.bouncycastle.asn1.x509.sigi.PersonalData - -
- - Constructor from DERString. -

- The sequence is of type NameOrPseudonym: -

-

-                  NameOrPseudonym ::= CHOICE {
-                	   surAndGivenName SEQUENCE {
-                	     surName DirectoryString,
-                	     givenName SEQUENCE OF DirectoryString
-                    },
-                	   pseudonym DirectoryString
-                  }
-            
- @param pseudonym pseudonym value to use. -
- - Constructor from Asn1Sequence. -

- The sequence is of type NameOrPseudonym: -

-

-                   NameOrPseudonym ::= CHOICE {
-                 	   surAndGivenName SEQUENCE {
-                 	     surName DirectoryString,
-                 	     givenName SEQUENCE OF DirectoryString
-                     },
-                 	   pseudonym DirectoryString
-                   }
-             
- - @param seq The ASN.1 sequence. -
- - Constructor from a given details. - - @param pseudonym The pseudonym. - - - Constructor from a given details. - - @param surname The surname. - @param givenName A sequence of directory strings making up the givenName - - - Produce an object suitable for an Asn1OutputStream. -

- Returns: -

-

-                   NameOrPseudonym ::= CHOICE {
-                 	   surAndGivenName SEQUENCE {
-                 	     surName DirectoryString,
-                 	     givenName SEQUENCE OF DirectoryString
-                     },
-                 	   pseudonym DirectoryString
-                   }
-             
- - @return an Asn1Object -
- - Contains personal data for the otherName field in the subjectAltNames - extension. -

-

-                 PersonalData ::= SEQUENCE {
-                   nameOrPseudonym NameOrPseudonym,
-                   nameDistinguisher [0] INTEGER OPTIONAL,
-                   dateOfBirth [1] GeneralizedTime OPTIONAL,
-                   placeOfBirth [2] DirectoryString OPTIONAL,
-                   gender [3] PrintableString OPTIONAL,
-                   postalAddress [4] DirectoryString OPTIONAL
-                   }
-             
- - @see org.bouncycastle.asn1.x509.sigi.NameOrPseudonym - @see org.bouncycastle.asn1.x509.sigi.SigIObjectIdentifiers -
- - Constructor from Asn1Sequence. -

- The sequence is of type NameOrPseudonym: -

-

-                 PersonalData ::= SEQUENCE {
-                   nameOrPseudonym NameOrPseudonym,
-                   nameDistinguisher [0] INTEGER OPTIONAL,
-                   dateOfBirth [1] GeneralizedTime OPTIONAL,
-                   placeOfBirth [2] DirectoryString OPTIONAL,
-                   gender [3] PrintableString OPTIONAL,
-                   postalAddress [4] DirectoryString OPTIONAL
-                   }
-             
- - @param seq The ASN.1 sequence. -
- - Constructor from a given details. - - @param nameOrPseudonym Name or pseudonym. - @param nameDistinguisher Name distinguisher. - @param dateOfBirth Date of birth. - @param placeOfBirth Place of birth. - @param gender Gender. - @param postalAddress Postal Address. - - - Produce an object suitable for an Asn1OutputStream. -

- Returns: -

-

-                 PersonalData ::= SEQUENCE {
-                   nameOrPseudonym NameOrPseudonym,
-                   nameDistinguisher [0] INTEGER OPTIONAL,
-                   dateOfBirth [1] GeneralizedTime OPTIONAL,
-                   placeOfBirth [2] DirectoryString OPTIONAL,
-                   gender [3] PrintableString OPTIONAL,
-                   postalAddress [4] DirectoryString OPTIONAL
-                   }
-             
- - @return an Asn1Object -
- - Object Identifiers of SigI specifciation (German Signature Law - Interoperability specification). - - - Key purpose IDs for German SigI (Signature Interoperability - Specification) - - - Certificate policy IDs for German SigI (Signature Interoperability - Specification) - - - Other Name IDs for German SigI (Signature Interoperability Specification) - - - To be used for for the generation of directory service certificates. - - - ID for PersonalData - - - Certificate is conform to german signature law. - - - This extension may contain further X.500 attributes of the subject. See also - RFC 3039. - -
-                 SubjectDirectoryAttributes ::= Attributes
-                 Attributes ::= SEQUENCE SIZE (1..MAX) OF Attribute
-                 Attribute ::= SEQUENCE
-                 {
-                   type AttributeType
-                   values SET OF AttributeValue
-                 }
-            
-                 AttributeType ::= OBJECT IDENTIFIER
-                 AttributeValue ::= ANY DEFINED BY AttributeType
-             
- - @see org.bouncycastle.asn1.x509.X509Name for AttributeType ObjectIdentifiers. -
- - Constructor from Asn1Sequence. - - The sequence is of type SubjectDirectoryAttributes: - -
-                  SubjectDirectoryAttributes ::= Attributes
-                  Attributes ::= SEQUENCE SIZE (1..MAX) OF Attribute
-                  Attribute ::= SEQUENCE
-                  {
-                    type AttributeType
-                    values SET OF AttributeValue
-                  }
-            
-                  AttributeType ::= OBJECT IDENTIFIER
-                  AttributeValue ::= ANY DEFINED BY AttributeType
-             
- - @param seq - The ASN.1 sequence. -
- - Constructor from an ArrayList of attributes. - - The ArrayList consists of attributes of type {@link Attribute Attribute} - - @param attributes The attributes. - - - - Produce an object suitable for an Asn1OutputStream. - - Returns: - -
-                  SubjectDirectoryAttributes ::= Attributes
-                  Attributes ::= SEQUENCE SIZE (1..MAX) OF Attribute
-                  Attribute ::= SEQUENCE
-                  {
-                    type AttributeType
-                    values SET OF AttributeValue
-                  }
-            
-                  AttributeType ::= OBJECT IDENTIFIER
-                  AttributeValue ::= ANY DEFINED BY AttributeType
-             
- - @return a DERObject -
- - @return Returns the attributes. - - - The SubjectKeyIdentifier object. -
-            SubjectKeyIdentifier::= OCTET STRING
-            
-
- - Calculates the keyIdentifier using a SHA1 hash over the BIT STRING - from SubjectPublicKeyInfo as defined in RFC3280. - - @param spki the subject public key info. - - - Return a RFC 3280 type 1 key identifier. As in: -
-            (1) The keyIdentifier is composed of the 160-bit SHA-1 hash of the
-            value of the BIT STRING subjectPublicKey (excluding the tag,
-            length, and number of unused bits).
-            
- @param keyInfo the key info object containing the subjectPublicKey field. - @return the key identifier. -
- - Return a RFC 3280 type 2 key identifier. As in: -
-            (2) The keyIdentifier is composed of a four bit type field with
-            the value 0100 followed by the least significant 60 bits of the
-            SHA-1 hash of the value of the BIT STRING subjectPublicKey.
-            
- @param keyInfo the key info object containing the subjectPublicKey field. - @return the key identifier. -
- - The object that contains the public key stored in a certficate. -

- The GetEncoded() method in the public keys in the JCE produces a DER - encoded one of these.

-
- - for when the public key is an encoded object - if the bitstring - can't be decoded this routine raises an IOException. - - @exception IOException - if the bit string doesn't represent a Der - encoded object. - - - for when the public key is an encoded object - if the bitstring - can't be decoded this routine raises an IOException. - - @exception IOException - if the bit string doesn't represent a Der - encoded object. - - - for when the public key is raw bits... - - - Produce an object suitable for an Asn1OutputStream. -
-            SubjectPublicKeyInfo ::= Sequence {
-                                     algorithm AlgorithmIdentifier,
-                                     publicKey BIT STRING }
-            
-
- - Target structure used in target information extension for attribute - certificates from RFC 3281. - -
-                Target  ::= CHOICE {
-                  targetName          [0] GeneralName,
-                  targetGroup         [1] GeneralName,
-                  targetCert          [2] TargetCert
-                }
-            
- -

- The targetCert field is currently not supported and must not be used - according to RFC 3281.

-
- - Creates an instance of a Target from the given object. -

- obj can be a Target or a {@link Asn1TaggedObject}

- - @param obj The object. - @return A Target instance. - @throws ArgumentException if the given object cannot be - interpreted as Target. -
- - Constructor from Asn1TaggedObject. - - @param tagObj The tagged object. - @throws ArgumentException if the encoding is wrong. - - - Constructor from given details. -

- Exactly one of the parameters must be not null.

- - @param type the choice type to apply to the name. - @param name the general name. - @throws ArgumentException if type is invalid. -
- - @return Returns the targetGroup. - - - @return Returns the targetName. - - - Produce an object suitable for an Asn1OutputStream. - - Returns: - -
-                Target  ::= CHOICE {
-                  targetName          [0] GeneralName,
-                  targetGroup         [1] GeneralName,
-                  targetCert          [2] TargetCert
-                }
-            
- - @return an Asn1Object -
- - Target information extension for attributes certificates according to RFC - 3281. - -
-                      SEQUENCE OF Targets
-            
- -
- - Creates an instance of a TargetInformation from the given object. -

- obj can be a TargetInformation or a {@link Asn1Sequence}

- - @param obj The object. - @return A TargetInformation instance. - @throws ArgumentException if the given object cannot be interpreted as TargetInformation. -
- - Constructor from a Asn1Sequence. - - @param seq The Asn1Sequence. - @throws ArgumentException if the sequence does not contain - correctly encoded Targets elements. - - - Returns the targets in this target information extension. -

- The ArrayList is cloned before it is returned.

- - @return Returns the targets. -
- - Constructs a target information from a single targets element. - According to RFC 3281 only one targets element must be produced. - - @param targets A Targets instance. - - - According to RFC 3281 only one targets element must be produced. If - multiple targets are given they must be merged in - into one targets element. - - @param targets An array with {@link Targets}. - - - Produce an object suitable for an Asn1OutputStream. - - Returns: - -
-                     SEQUENCE OF Targets
-            
- -

- According to RFC 3281 only one targets element must be produced. If - multiple targets are given in the constructor they are merged into one - targets element. If this was produced from a - {@link Org.BouncyCastle.Asn1.Asn1Sequence} the encoding is kept.

- - @return an Asn1Object -
- - Targets structure used in target information extension for attribute - certificates from RFC 3281. - -
-                       Targets ::= SEQUENCE OF Target
-                      
-                       Target  ::= CHOICE {
-                         targetName          [0] GeneralName,
-                         targetGroup         [1] GeneralName,
-                         targetCert          [2] TargetCert
-                       }
-                      
-                       TargetCert  ::= SEQUENCE {
-                         targetCertificate    IssuerSerial,
-                         targetName           GeneralName OPTIONAL,
-                         certDigestInfo       ObjectDigestInfo OPTIONAL
-                       }
-            
- - @see org.bouncycastle.asn1.x509.Target - @see org.bouncycastle.asn1.x509.TargetInformation -
- - Creates an instance of a Targets from the given object. -

- obj can be a Targets or a {@link Asn1Sequence}

- - @param obj The object. - @return A Targets instance. - @throws ArgumentException if the given object cannot be interpreted as Target. -
- - Constructor from Asn1Sequence. - - @param targets The ASN.1 SEQUENCE. - @throws ArgumentException if the contents of the sequence are - invalid. - - - Constructor from given targets. -

- The ArrayList is copied.

- - @param targets An ArrayList of {@link Target}s. - @see Target - @throws ArgumentException if the ArrayList contains not only Targets. -
- - Returns the targets in an ArrayList. -

- The ArrayList is cloned before it is returned.

- - @return Returns the targets. -
- - Produce an object suitable for an Asn1OutputStream. - - Returns: - -
-                       Targets ::= SEQUENCE OF Target
-            
- - @return an Asn1Object -
- - The TbsCertificate object. -
-            TbsCertificate ::= Sequence {
-                 version          [ 0 ]  Version DEFAULT v1(0),
-                 serialNumber            CertificateSerialNumber,
-                 signature               AlgorithmIdentifier,
-                 issuer                  Name,
-                 validity                Validity,
-                 subject                 Name,
-                 subjectPublicKeyInfo    SubjectPublicKeyInfo,
-                 issuerUniqueID    [ 1 ] IMPLICIT UniqueIdentifier OPTIONAL,
-                 subjectUniqueID   [ 2 ] IMPLICIT UniqueIdentifier OPTIONAL,
-                 extensions        [ 3 ] Extensions OPTIONAL
-                 }
-            
-

- Note: issuerUniqueID and subjectUniqueID are both deprecated by the IETF. This class - will parse them, but you really shouldn't be creating new ones.

-
- - PKIX RFC-2459 - TbsCertList object. -
-            TbsCertList  ::=  Sequence  {
-                 version                 Version OPTIONAL,
-                                              -- if present, shall be v2
-                 signature               AlgorithmIdentifier,
-                 issuer                  Name,
-                 thisUpdate              Time,
-                 nextUpdate              Time OPTIONAL,
-                 revokedCertificates     Sequence OF Sequence  {
-                      userCertificate         CertificateSerialNumber,
-                      revocationDate          Time,
-                      crlEntryExtensions      Extensions OPTIONAL
-                                                    -- if present, shall be v2
-                                           }  OPTIONAL,
-                 crlExtensions           [0]  EXPLICIT Extensions OPTIONAL
-                                                    -- if present, shall be v2
-                                           }
-            
-
- - creates a time object from a given date - if the date is between 1950 - and 2049 a UTCTime object is Generated, otherwise a GeneralizedTime - is used. - - - - Return our time as DateTime. - - A date time. - - - Produce an object suitable for an Asn1OutputStream. -
-            Time ::= CHOICE {
-                        utcTime        UTCTime,
-                        generalTime    GeneralizedTime }
-            
-
- - UserNotice class, used in - CertificatePolicies X509 extensions (in policy - qualifiers). -
-             UserNotice ::= Sequence {
-                  noticeRef        NoticeReference OPTIONAL,
-                  explicitText     DisplayText OPTIONAL}
-            
-             
- - @see PolicyQualifierId - @see PolicyInformation -
- - Creates a new UserNotice instance. - - @param noticeRef a NoticeReference value - @param explicitText a DisplayText value - - - Creates a new UserNotice instance. - - @param noticeRef a NoticeReference value - @param str the explicitText field as a string. - - - Creates a new UserNotice instance. -

Useful from reconstructing a UserNotice instance - from its encodable/encoded form. - - @param as an ASN1Sequence value obtained from either - calling @{link toASN1Object()} for a UserNotice - instance or from parsing it from a DER-encoded stream.

-
- - Generator for Version 1 TbsCertificateStructures. -
-             TbsCertificate ::= Sequence {
-                  version          [ 0 ]  Version DEFAULT v1(0),
-                  serialNumber            CertificateSerialNumber,
-                  signature               AlgorithmIdentifier,
-                  issuer                  Name,
-                  validity                Validity,
-                  subject                 Name,
-                  subjectPublicKeyInfo    SubjectPublicKeyInfo,
-                  }
-             
- -
- - Generator for Version 2 AttributeCertificateInfo -
-             AttributeCertificateInfo ::= Sequence {
-                   version              AttCertVersion -- version is v2,
-                   holder               Holder,
-                   issuer               AttCertIssuer,
-                   signature            AlgorithmIdentifier,
-                   serialNumber         CertificateSerialNumber,
-                   attrCertValidityPeriod   AttCertValidityPeriod,
-                   attributes           Sequence OF Attr,
-                   issuerUniqueID       UniqueIdentifier OPTIONAL,
-                   extensions           Extensions OPTIONAL
-             }
-             
- -
- - @param attribute - - - Produce an object suitable for an Asn1OutputStream. -
-             V2Form ::= Sequence {
-                  issuerName            GeneralNames  OPTIONAL,
-                  baseCertificateID     [0] IssuerSerial  OPTIONAL,
-                  objectDigestInfo      [1] ObjectDigestInfo  OPTIONAL
-                    -- issuerName MUST be present in this profile
-                    -- baseCertificateID and objectDigestInfo MUST NOT
-                    -- be present in this profile
-             }
-            
-
- - Generator for Version 2 TbsCertList structures. -
-              TbsCertList  ::=  Sequence  {
-                   version                 Version OPTIONAL,
-                                                -- if present, shall be v2
-                   signature               AlgorithmIdentifier,
-                   issuer                  Name,
-                   thisUpdate              Time,
-                   nextUpdate              Time OPTIONAL,
-                   revokedCertificates     Sequence OF Sequence  {
-                        userCertificate         CertificateSerialNumber,
-                        revocationDate          Time,
-                        crlEntryExtensions      Extensions OPTIONAL
-                                                      -- if present, shall be v2
-                                             }  OPTIONAL,
-                   crlExtensions           [0]  EXPLICIT Extensions OPTIONAL
-                                                      -- if present, shall be v2
-                                             }
-             
- - Note: This class may be subject to change -
- - Generator for Version 3 TbsCertificateStructures. -
-             TbsCertificate ::= Sequence {
-                  version          [ 0 ]  Version DEFAULT v1(0),
-                  serialNumber            CertificateSerialNumber,
-                  signature               AlgorithmIdentifier,
-                  issuer                  Name,
-                  validity                Validity,
-                  subject                 Name,
-                  subjectPublicKeyInfo    SubjectPublicKeyInfo,
-                  issuerUniqueID    [ 1 ] IMPLICIT UniqueIdentifier OPTIONAL,
-                  subjectUniqueID   [ 2 ] IMPLICIT UniqueIdentifier OPTIONAL,
-                  extensions        [ 3 ] Extensions OPTIONAL
-                  }
-             
- -
- - an X509Certificate structure. -
-             Certificate ::= Sequence {
-                 tbsCertificate          TbsCertificate,
-                 signatureAlgorithm      AlgorithmIdentifier,
-                 signature               BIT STRING
-             }
-            
-
- - The default converter for X509 DN entries when going from their - string value to ASN.1 strings. - - - Apply default conversion for the given value depending on the oid - and the character range of the value. - - @param oid the object identifier for the DN entry - @param value the value associated with it - @return the ASN.1 equivalent for the string value. - - - an object for the elements in the X.509 V3 extension block. - - - Convert the value of the passed in extension to an object. - The extension to parse. - The object the value string contains. - If conversion is not possible. - - - Subject Directory Attributes - - - Subject Key Identifier - - - Key Usage - - - Private Key Usage Period - - - Subject Alternative Name - - - Issuer Alternative Name - - - Basic Constraints - - - CRL Number - - - Reason code - - - Hold Instruction Code - - - Invalidity Date - - - Delta CRL indicator - - - Issuing Distribution Point - - - Certificate Issuer - - - Name Constraints - - - CRL Distribution Points - - - Certificate Policies - - - Policy Mappings - - - Authority Key Identifier - - - Policy Constraints - - - Extended Key Usage - - - Freshest CRL - - - Inhibit Any Policy - - - Authority Info Access - - - Subject Info Access - - - Logo Type - - - BiometricInfo - - - QCStatements - - - Audit identity extension in attribute certificates. - - - NoRevAvail extension in attribute certificates. - - - TargetInformation extension in attribute certificates. - - - Expired Certificates on CRL extension - - - Constructor from Asn1Sequence. - - the extensions are a list of constructed sequences, either with (Oid, OctetString) or (Oid, Boolean, OctetString) - - - constructor from a table of extensions. -

- it's is assumed the table contains Oid/string pairs.

-
- - Constructor from a table of extensions with ordering. -

- It's is assumed the table contains Oid/string pairs.

-
- - Constructor from two vectors - - @param objectIDs an ArrayList of the object identifiers. - @param values an ArrayList of the extension values. - - - constructor from a table of extensions. -

- it's is assumed the table contains Oid/string pairs.

-
- - Constructor from a table of extensions with ordering. -

- It's is assumed the table contains Oid/string pairs.

-
- - Constructor from two vectors - - @param objectIDs an ArrayList of the object identifiers. - @param values an ArrayList of the extension values. - - - return an Enumeration of the extension field's object ids. - - - return the extension represented by the object identifier - passed in. - - @return the extension if it's present, null otherwise. - - - return the parsed value of the extension represented by the object identifier - passed in. - - @return the parsed value of the extension if it's present, null otherwise. - - -
-                 Extensions        ::=   SEQUENCE SIZE (1..MAX) OF Extension
-            
-                 Extension         ::=   SEQUENCE {
-                    extnId            EXTENSION.&id ({ExtensionSet}),
-                    critical          BOOLEAN DEFAULT FALSE,
-                    extnValue         OCTET STRING }
-             
-
- - Generator for X.509 extensions - - - Reset the generator - - - - Add an extension with the given oid and the passed in value to be included - in the OCTET STRING associated with the extension. - - OID for the extension. - True if critical, false otherwise. - The ASN.1 object to be included in the extension. - - - - Add an extension with the given oid and the passed in byte array to be wrapped - in the OCTET STRING associated with the extension. - - OID for the extension. - True if critical, false otherwise. - The byte array to be wrapped. - - - Return true if there are no extension present in this generator. - True if empty, false otherwise - - - Generate an X509Extensions object based on the current state of the generator. - An X509Extensions object - - -
-                 RDNSequence ::= SEQUENCE OF RelativeDistinguishedName
-            
-                 RelativeDistinguishedName ::= SET SIZE (1..MAX) OF AttributeTypeAndValue
-            
-                 AttributeTypeAndValue ::= SEQUENCE {
-                                               type  OBJECT IDENTIFIER,
-                                               value ANY }
-             
-
- - country code - StringType(SIZE(2)) - - - organization - StringType(SIZE(1..64)) - - - organizational unit name - StringType(SIZE(1..64)) - - - Title - - - common name - StringType(SIZE(1..64)) - - - street - StringType(SIZE(1..64)) - - - device serial number name - StringType(SIZE(1..64)) - - - locality name - StringType(SIZE(1..64)) - - - state, or province name - StringType(SIZE(1..64)) - - - Naming attributes of type X520name - - - businessCategory - DirectoryString(SIZE(1..128) - - - postalCode - DirectoryString(SIZE(1..40) - - - dnQualifier - DirectoryString(SIZE(1..64) - - - RFC 3039 Pseudonym - DirectoryString(SIZE(1..64) - - - RFC 3039 DateOfBirth - GeneralizedTime - YYYYMMDD000000Z - - - RFC 3039 PlaceOfBirth - DirectoryString(SIZE(1..128) - - - RFC 3039 DateOfBirth - PrintableString (SIZE(1)) -- "M", "F", "m" or "f" - - - RFC 3039 CountryOfCitizenship - PrintableString (SIZE (2)) -- ISO 3166 - codes only - - - RFC 3039 CountryOfCitizenship - PrintableString (SIZE (2)) -- ISO 3166 - codes only - - - ISIS-MTT NameAtBirth - DirectoryString(SIZE(1..64) - - - RFC 3039 PostalAddress - SEQUENCE SIZE (1..6) OF - DirectoryString(SIZE(1..30)) - - - RFC 2256 dmdName - - - id-at-telephoneNumber - - - id-at-organizationIdentifier - - - id-at-name - - - Email address (RSA PKCS#9 extension) - IA5String. -

Note: if you're trying to be ultra orthodox, don't use this! It shouldn't be in here.

-
- - more from PKCS#9 - - - email address in Verisign certificates - - - LDAP User id. - - - determines whether or not strings should be processed and printed - from back to front. - - - default look up table translating OID values into their common symbols following - the convention in RFC 2253 with a few extras - - - look up table translating OID values into their common symbols following the convention in RFC 2253 - - - look up table translating OID values into their common symbols following the convention in RFC 1779 - - - - look up table translating common symbols into their OIDS. - - - Return a X509Name based on the passed in tagged object. - - @param obj tag object holding name. - @param explicitly true if explicitly tagged false otherwise. - @return the X509Name - - - Constructor from Asn1Sequence - - the principal will be a list of constructed sets, each containing an (OID, string) pair. - - - Constructor from a table of attributes with ordering. -

- it's is assumed the table contains OID/string pairs, and the contents - of the table are copied into an internal table as part of the - construction process. The ordering ArrayList should contain the OIDs - in the order they are meant to be encoded or printed in ToString.

-
- - Constructor from a table of attributes with ordering. -

- it's is assumed the table contains OID/string pairs, and the contents - of the table are copied into an internal table as part of the - construction process. The ordering ArrayList should contain the OIDs - in the order they are meant to be encoded or printed in ToString.

-

- The passed in converter will be used to convert the strings into their - ASN.1 counterparts.

-
- - Takes two vectors one of the oids and the other of the values. - - - Takes two vectors one of the oids and the other of the values. -

- The passed in converter will be used to convert the strings into their - ASN.1 counterparts.

-
- - Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or - some such, converting it into an ordered set of name attributes. - - - Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or - some such, converting it into an ordered set of name attributes with each - string value being converted to its associated ASN.1 type using the passed - in converter. - - - Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or - some such, converting it into an ordered set of name attributes. If reverse - is true, create the encoded version of the sequence starting from the - last element in the string. - - - Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or - some such, converting it into an ordered set of name attributes with each - string value being converted to its associated ASN.1 type using the passed - in converter. If reverse is true the ASN.1 sequence representing the DN will - be built by starting at the end of the string, rather than the start. - - - Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or - some such, converting it into an ordered set of name attributes. lookUp - should provide a table of lookups, indexed by lowercase only strings and - yielding a DerObjectIdentifier, other than that OID. and numeric oids - will be processed automatically. -
- If reverse is true, create the encoded version of the sequence - starting from the last element in the string. - @param reverse true if we should start scanning from the end (RFC 2553). - @param lookUp table of names and their oids. - @param dirName the X.500 string to be parsed. -
- - Takes an X509 dir name as a string of the format "C=AU, ST=Victoria", or - some such, converting it into an ordered set of name attributes. lookUp - should provide a table of lookups, indexed by lowercase only strings and - yielding a DerObjectIdentifier, other than that OID. and numeric oids - will be processed automatically. The passed in converter is used to convert the - string values to the right of each equals sign to their ASN.1 counterparts. -
- @param reverse true if we should start scanning from the end, false otherwise. - @param lookUp table of names and oids. - @param dirName the string dirName - @param converter the converter to convert string values into their ASN.1 equivalents -
- - return an IList of the oids in the name, in the order they were found. - - - return an IList of the values found in the name, in the order they - were found. - - - return an IList of the values found in the name, in the order they - were found, with the DN label corresponding to passed in oid. - - - The X509Name object to test equivalency against. - If true, the order of elements must be the same, - as well as the values associated with each element. - - - test for equivalence - note: case is ignored. - - - convert the structure to a string - if reverse is true the - oids and values are listed out starting with the last element - in the sequence (ala RFC 2253), otherwise the string will begin - with the first element of the structure. If no string definition - for the oid is found in oidSymbols the string value of the oid is - added. Two standard symbol tables are provided DefaultSymbols, and - RFC2253Symbols as part of this class. - - @param reverse if true start at the end of the sequence and work back. - @param oidSymbols look up table strings for oids. - - - * It turns out that the number of standard ways the fields in a DN should be - * encoded into their ASN.1 counterparts is rapidly approaching the - * number of machines on the internet. By default the X509Name class - * will produce UTF8Strings in line with the current recommendations (RFC 3280). - *

- * An example of an encoder look like below: - *

-                 * public class X509DirEntryConverter
-                 *     : X509NameEntryConverter
-                 * {
-                 *     public Asn1Object GetConvertedValue(
-                 *         DerObjectIdentifier  oid,
-                 *         string               value)
-                 *     {
-                 *         if (str.Length() != 0 && str.charAt(0) == '#')
-                 *         {
-                 *             return ConvertHexEncoded(str, 1);
-                 *         }
-                 *         if (oid.Equals(EmailAddress))
-                 *         {
-                 *             return new DerIA5String(str);
-                 *         }
-                 *         else if (CanBePrintable(str))
-                 *         {
-                 *             return new DerPrintableString(str);
-                 *         }
-                 *         else if (CanBeUTF8(str))
-                 *         {
-                 *             return new DerUtf8String(str);
-                 *         }
-                 *         else
-                 *         {
-                 *             return new DerBmpString(str);
-                 *         }
-                 *     }
-                 * }
-            	 * 
- *

-
- - Convert an inline encoded hex string rendition of an ASN.1 - object back into its corresponding ASN.1 object. - - @param str the hex encoded object - @param off the index at which the encoding starts - @return the decoded object - - - return true if the passed in string can be represented without - loss as a PrintableString, false otherwise. - - - Convert the passed in string value into the appropriate ASN.1 - encoded object. - - @param oid the oid associated with the value in the DN. - @param value the value of the particular DN component. - @return the ASN.1 equivalent for the value. - - - class for breaking up an X500 Name into it's component tokens, ala - java.util.StringTokenizer. We need this class as some of the - lightweight Java environment don't support classes like - StringTokenizer. - - - A general class that reads all X9.62 style EC curve tables. - - - return a X9ECParameters object representing the passed in named - curve. The routine returns null if the curve is not present. - - @param name the name of the curve requested - @return an X9ECParameters object or null if the curve is not available. - - - return the object identifier signified by the passed in name. Null - if there is no object identifier associated with name. - - @return the object identifier associated with name, if present. - - - return a X9ECParameters object representing the passed in named - curve. - - @param oid the object id of the curve requested - @return an X9ECParameters object or null if the curve is not available. - - - return an enumeration of the names of the available curves. - - @return an enumeration of the names of the available curves. - - - ASN.1 def for Diffie-Hellman key exchange KeySpecificInfo structure. See - RFC 2631, or X9.42, for further details. - - - Produce an object suitable for an Asn1OutputStream. -
-             KeySpecificInfo ::= Sequence {
-                 algorithm OBJECT IDENTIFIER,
-                 counter OCTET STRING SIZE (4..4)
-             }
-            
-
- - ANS.1 def for Diffie-Hellman key exchange OtherInfo structure. See - RFC 2631, or X9.42, for further details. - - - Produce an object suitable for an Asn1OutputStream. -
-             OtherInfo ::= Sequence {
-                 keyInfo KeySpecificInfo,
-                 partyAInfo [0] OCTET STRING OPTIONAL,
-                 suppPubInfo [2] OCTET STRING
-             }
-            
-
- - table of the current named curves defined in X.962 EC-DSA. - - - return the X9ECParameters object for the named curve represented by - the passed in object identifier. Null if the curve isn't present. - - @param oid an object identifier representing a named curve, if present. - - - return the object identifier signified by the passed in name. Null - if there is no object identifier associated with name. - - @return the object identifier associated with name, if present. - - - return the named curve name represented by the given object identifier. - - - returns an enumeration containing the name strings for curves - contained in this structure. - - - Produce an object suitable for an Asn1OutputStream. -
-            Parameters ::= CHOICE {
-               ecParameters ECParameters,
-               namedCurve   CURVES.&id({CurveNames}),
-               implicitlyCA Null
-            }
-            
-
- - ASN.1 def for Elliptic-Curve Curve structure. See - X9.62, for further details. - - - Produce an object suitable for an Asn1OutputStream. -
-             Curve ::= Sequence {
-                 a               FieldElement,
-                 b               FieldElement,
-                 seed            BIT STRING      OPTIONAL
-             }
-            
-
- - ASN.1 def for Elliptic-Curve ECParameters structure. See - X9.62, for further details. - - - Return the ASN.1 entry representing the Curve. - - @return the X9Curve for the curve in these parameters. - - - Return the ASN.1 entry representing the FieldID. - - @return the X9FieldID for the FieldID in these parameters. - - - Return the ASN.1 entry representing the base point G. - - @return the X9ECPoint for the base point in these parameters. - - - Produce an object suitable for an Asn1OutputStream. -
-             ECParameters ::= Sequence {
-                 version         Integer { ecpVer1(1) } (ecpVer1),
-                 fieldID         FieldID {{FieldTypes}},
-                 curve           X9Curve,
-                 base            X9ECPoint,
-                 order           Integer,
-                 cofactor        Integer OPTIONAL
-             }
-            
-
- - class for describing an ECPoint as a Der object. - - - Produce an object suitable for an Asn1OutputStream. -
-             ECPoint ::= OCTET STRING
-            
-

- Octet string produced using ECPoint.GetEncoded().

-
- - Class for processing an ECFieldElement as a DER object. - - - Produce an object suitable for an Asn1OutputStream. -
-             FieldElement ::= OCTET STRING
-            
-

-

    -
  1. if q is an odd prime then the field element is - processed as an Integer and converted to an octet string - according to x 9.62 4.3.1.
  2. -
  3. if q is 2m then the bit string - contained in the field element is converted into an octet - string with the same ordering padded at the front if necessary. -
  4. -
-

-
- - ASN.1 def for Elliptic-Curve Field ID structure. See - X9.62, for further details. - - - Constructor for elliptic curves over prime fields - F2. - @param primeP The prime p defining the prime field. - - - Constructor for elliptic curves over binary fields - F2m. - @param m The exponent m of - F2m. - @param k1 The integer k1 where xm + - xk1 + 1 - represents the reduction polynomial f(z). - - - Constructor for elliptic curves over binary fields - F2m. - @param m The exponent m of - F2m. - @param k1 The integer k1 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z). - @param k2 The integer k2 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z). - @param k3 The integer k3 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z).. - - - Produce a Der encoding of the following structure. -
-             FieldID ::= Sequence {
-                 fieldType       FIELD-ID.&id({IOSet}),
-                 parameters      FIELD-ID.&Type({IOSet}{@fieldType})
-             }
-            
-
- - id-dsa-with-sha1 OBJECT IDENTIFIER ::= { iso(1) member-body(2) - us(840) x9-57 (10040) x9cm(4) 3 } - - - X9.63 - - - X9.42 - - - reader for Base64 armored objects - read the headers and then start returning - bytes when the data is reached. An IOException is thrown if the CRC check - is detected and fails. -

- By default a missing CRC will not cause an exception. To force CRC detection use: -

-                 ArmoredInputStream aIn = ...
-            
-                 aIn.setDetectMissingCRC(true);
-             
-

-
- - decode the base 64 encoded input data. - - @return the offset the data starts in out. - - - Create a stream for reading a PGP armoured message, parsing up to a header - and then reading the data that follows. - - @param input - - - Create an armoured input stream which will assume the data starts - straight away, or parse for headers first depending on the value of - hasHeaders. - - @param input - @param hasHeaders true if headers are to be looked for, false otherwise. - - - @return true if we are inside the clear text section of a PGP - signed message. - - - @return true if the stream is actually at end of file. - - - Return the armor header line (if there is one) - @return the armor header line, null if none present. - - - Return the armor headers (the lines after the armor header line), - @return an array of armor headers, null if there aren't any. - - - Reads up to len bytes of data from the input stream into - an array of bytes. An attempt is made to read as many as - len bytes, but a smaller number may be read. - The number of bytes actually read is returned as an integer. - - The first byte read is stored into element b[off], the - next one into b[off+1], and so on. The number of bytes read - is, at most, equal to len. - - NOTE: We need to override the custom behavior of Java's {@link InputStream#read(byte[], int, int)}, - as the upstream method silently swallows {@link IOException IOExceptions}. - This would cause CRC checksum errors to go unnoticed. - - @see Related BC bug report - @param b byte array - @param off offset at which we start writing data to the array - @param len number of bytes we write into the array - @return total number of bytes read into the buffer - - @throws IOException if an exception happens AT ANY POINT - - - Change how the stream should react if it encounters missing CRC checksum. - The default value is false (ignore missing CRC checksums). If the behavior is set to true, - an {@link IOException} will be thrown if a missing CRC checksum is encountered. - - @param detectMissing ignore missing CRC sums - - - Basic output stream. - - - encode the input data producing a base 64 encoded byte array. - - - Set an additional header entry. Any current value(s) under the same name will be - replaced by the new one. A null value will clear the entry for name. * - @param name the name of the header entry. - @param v the value of the header entry. - - - Set an additional header entry. The current value(s) will continue to exist together - with the new one. Adding a null value has no effect. - - @param name the name of the header entry. - @param value the value of the header entry. - - - Reset the headers to only contain a Version string (if one is present). - - - Start a clear text signed message. - @param hashAlgorithm - - - Note: Close() does not close the underlying stream. So it is possible to write - multiple objects using armoring to a single stream. - - - Basic type for a image attribute packet. - - - Reader for PGP objects. - - - Returns the next packet tag in the stream. - - - - A stream that overlays our input stream, allowing the user to only read a segment of it. - NB: dataLength will be negative if the segment length is in the upper range above 2**31. - - - - Base class for a PGP object. - - - Basic output stream. - - - Create a stream representing a general packet. - Output stream to write to. - - - Create a stream representing an old style partial object. - Output stream to write to. - The packet tag for the object. - - - Create a stream representing a general packet. - Output stream to write to. - Packet tag. - Size of chunks making up the packet. - If true, the header is written out in old format. - - - Create a new style partial input stream buffered into chunks. - Output stream to write to. - Packet tag. - Size of chunks making up the packet. - - - Create a new style partial input stream buffered into chunks. - Output stream to write to. - Packet tag. - Buffer to use for collecting chunks. - - - Flush the underlying stream. - - - Finish writing out the current packet without closing the underlying stream. - - - Generic compressed data object. - - - The algorithm tag value. - - - Basic tags for compression algorithms. - - - Basic type for a PGP packet. - - - Base class for a DSA public key. - - - The stream to read the packet from. - - - The format, as a string, always "PGP". - - - Return the standard PGP encoding of the key. - - - Base class for a DSA secret key. - - - @param in - - - The format, as a string, always "PGP". - - - Return the standard PGP encoding of the key. - - - @return x - - - Base class for an ECDH Public Key. - - - The stream to read the packet from. - - - Base class for an ECDSA Public Key. - - - The stream to read the packet from. - - - Base class for an EC Public Key. - - - The stream to read the packet from. - - - The format, as a string, always "PGP". - - - Return the standard PGP encoding of the key. - - - Base class for an EC Secret Key. - - - The format, as a string, always "PGP". - - - Return the standard PGP encoding of the key. - - - Base class for an ElGamal public key. - - - The format, as a string, always "PGP". - - - Return the standard PGP encoding of the key. - - - Base class for an ElGamal secret key. - - - @param in - - - @param x - - - The format, as a string, always "PGP". - - - Return the standard PGP encoding of the key. - - - Basic packet for an experimental packet. - - - Basic tags for hash algorithms. - - - Base interface for a PGP key. - - - - The base format for this key - in the case of the symmetric keys it will generally - be raw indicating that the key is just a straight byte representation, for an asymmetric - key the format will be PGP, indicating the key is a string of MPIs encoded in PGP format. - - "RAW" or "PGP". - - - Note: you can only read from this once... - - - Generic literal data packet. - - - The format tag value. - - - The modification time of the file in milli-seconds (since Jan 1, 1970 UTC) - - - Basic type for a marker packet. - - - Basic packet for a modification detection code packet. - - - A multiple precision integer - - - Generic signature object - - - The encryption algorithm tag. - - - The hash algorithm tag. - - - Basic PGP packet tag types. - - - Public Key Algorithm tag numbers. - - - Basic packet for a PGP public key. - - - Basic packet for a PGP public key. - - - Construct a version 4 public key packet. - - - Basic packet for a PGP public subkey - - - Construct a version 4 public subkey packet. - - - Base class for an RSA public key. - - - Construct an RSA public key from the passed in stream. - - - The modulus. - The public exponent. - - - The format, as a string, always "PGP". - - - Return the standard PGP encoding of the key. - - - Base class for an RSA secret (or priate) key. - - - The format, as a string, always "PGP". - - - Return the standard PGP encoding of the key. - - - The string to key specifier class. - - - The hash algorithm. - - - The IV for the key generation algorithm. - - - The iteration count - - - The protection mode - only if GnuDummyS2K - - - Basic packet for a PGP secret key. - - - Basic packet for a PGP secret key. - - - Generic signature packet. - - - Generate a version 4 signature packet. - - @param signatureType - @param keyAlgorithm - @param hashAlgorithm - @param hashedData - @param unhashedData - @param fingerprint - @param signature - - - Generate a version 2/3 signature packet. - - @param signatureType - @param keyAlgorithm - @param hashAlgorithm - @param fingerprint - @param signature - - - return the keyId - @return the keyId that created the signature. - - - return the signature trailer that must be included with the data - to reconstruct the signature - - @return byte[] - - - * return the signature as a set of integers - note this is normalised to be the - * ASN.1 encoding of what appears in the signature packet. - - - Return the byte encoding of the signature section. - @return uninterpreted signature bytes. - - - Return the creation time in milliseconds since 1 Jan., 1970 UTC. - - - Basic type for a PGP Signature sub-packet. - - - Return the generic data making up the packet. - - - reader for signature sub-packets - - - Basic PGP signature sub-packet tag types. - - - Packet embedded signature - - - packet giving signature creation time. - - - packet giving signature expiration time. - - - Identifier for the Modification Detection (packets 18 and 19) - - - Identifier for the AEAD Encrypted Data Packet (packet 20) and version 5 - Symmetric-Key Encrypted Session Key Packets (packet 3) - - - Identifier for the Version 5 Public-Key Packet format and corresponding new - fingerprint format - - - Returns if modification detection is supported. - - - Returns if a particular feature is supported. - - - packet giving signature creation time. - - - packet giving time after creation at which the key expires. - - - Return the number of seconds after creation time a key is valid for. - - @return second count for key validity. - - - Packet holding the key flag values. - - - - Return the flag values contained in the first 4 octets (note: at the moment - the standard only uses the first one). - - - - Class provided a NotationData object according to - RFC2440, Chapter 5.2.3.15. Notation Data - - - packet giving signature creation time. - - - packet giving whether or not the signature is signed using the primary user ID for the key. - - - packet giving whether or not is revocable. - - - packet giving signature creation time. - - - packet giving signature expiration time. - - - return time in seconds before signature expires after creation time. - - - packet giving the User ID of the signer. - - - packet giving trust. - - - - Represents revocation key OpenPGP signature sub packet. - - - - - Represents revocation reason OpenPGP signature sub packet. - - - - Basic type for a symmetric key encrypted packet. - - - Basic tags for symmetric key algorithms - - - Basic type for a symmetric encrypted session key packet - - - @return int - - - @return S2k - - - @return byte[] - - - @return int - - - Basic type for a trust packet. - - - Basic type for a user attribute packet. - - - Basic type for a user attribute sub-packet. - - - return the generic data making up the packet. - - - reader for user attribute sub-packets - - - Basic PGP user attribute sub-packet tag types. - - - Basic type for a user ID packet. - - - Compressed data objects - - - The algorithm used for compression - - - Get the raw input stream contained in the object. - - - Return an uncompressed input stream which allows reading of the compressed data. - - - Class for producing compressed data packets. - - - -

- Return an output stream which will save the data being written to - the compressed object. -

-

- The stream created can be closed off by either calling Close() - on the stream or Close() on the generator. Closing the returned - stream does not close off the Stream parameter outStr. -

-
- Stream to be used for output. - A Stream for output of the compressed data. - - - -
- - -

- Return an output stream which will compress the data as it is written to it. - The stream will be written out in chunks according to the size of the passed in buffer. -

-

- The stream created can be closed off by either calling Close() - on the stream or Close() on the generator. Closing the returned - stream does not close off the Stream parameter outStr. -

-

- Note: if the buffer is not a power of 2 in length only the largest power of 2 - bytes worth of the buffer will be used. -

-

- Note: using this may break compatibility with RFC 1991 compliant tools. - Only recent OpenPGP implementations are capable of accepting these streams. -

-
- Stream to be used for output. - The buffer to use. - A Stream for output of the compressed data. - - - - -
- - Close the compressed object.summary> - - - - Thrown if the IV at the start of a data stream indicates the wrong key is being used. - - - - Return the raw input stream for the data stream. - - - Return true if the message is integrity protected. - True, if there is a modification detection code namespace associated - with this stream. - - - Note: This can only be called after the message has been read. - True, if the message verifies, false otherwise - - - Generator for encrypted objects. - - - Existing SecureRandom constructor. - The symmetric algorithm to use. - Source of randomness. - - - Creates a cipher stream which will have an integrity packet associated with it. - - - Base constructor. - The symmetric algorithm to use. - Source of randomness. - PGP 2.6.x compatibility required. - - - - Add a PBE encryption method to the encrypted object using the default algorithm (S2K_SHA1). - - - Conversion of the passphrase characters to bytes is performed using Convert.ToByte(), which is - the historical behaviour of the library (1.7 and earlier). - - - - Add a PBE encryption method to the encrypted object. - - Conversion of the passphrase characters to bytes is performed using Convert.ToByte(), which is - the historical behaviour of the library (1.7 and earlier). - - - - Add a PBE encryption method to the encrypted object. - - The passphrase is encoded to bytes using UTF8 (Encoding.UTF8.GetBytes). - - - - Add a PBE encryption method to the encrypted object. - - Allows the caller to handle the encoding of the passphrase to bytes. - - - - Add a public key encrypted session key to the encrypted object. - - - -

- If buffer is non null stream assumed to be partial, otherwise the length will be used - to output a fixed length packet. -

-

- The stream created can be closed off by either calling Close() - on the stream or Close() on the generator. Closing the returned - stream does not close off the Stream parameter outStr. -

-
-
- - -

- Return an output stream which will encrypt the data as it is written to it. -

-

- The stream created can be closed off by either calling Close() - on the stream or Close() on the generator. Closing the returned - stream does not close off the Stream parameter outStr. -

-
-
- - -

- Return an output stream which will encrypt the data as it is written to it. - The stream will be written out in chunks according to the size of the passed in buffer. -

-

- The stream created can be closed off by either calling Close() - on the stream or Close() on the generator. Closing the returned - stream does not close off the Stream parameter outStr. -

-

- Note: if the buffer is not a power of 2 in length only the largest power of 2 - bytes worth of the buffer will be used. -

-
-
- - -

- Close off the encrypted object - this is equivalent to calling Close() on the stream - returned by the Open() method. -

-

- Note: This does not close the underlying output stream, only the stream on top of - it created by the Open() method. -

-
-
- - A holder for a list of PGP encryption method packets. - - - Generic exception class for PGP encoding/decoding problems. - - - Key flag values for the KeyFlags subpacket. - - - - General class to handle JCA key pairs and convert them into OpenPGP ones. -

- A word for the unwary, the KeyId for an OpenPGP public key is calculated from - a hash that includes the time of creation, if you pass a different date to the - constructor below with the same public private key pair the KeyIs will not be the - same as for previous generations of the key, so ideally you only want to do - this once. -

-
-
- - Create a key pair from a PgpPrivateKey and a PgpPublicKey. - The public key. - The private key. - - - The keyId associated with this key pair. - - - - Generator for a PGP master and subkey ring. - This class will generate both the secret and public key rings - - - - - Create a new key ring generator using old style checksumming. It is recommended to use - SHA1 checksumming where possible. - - - Conversion of the passphrase characters to bytes is performed using Convert.ToByte(), which is - the historical behaviour of the library (1.7 and earlier). - - The certification level for keys on this ring. - The master key pair. - The id to be associated with the ring. - The algorithm to be used to protect secret keys. - The passPhrase to be used to protect secret keys. - Packets to be included in the certification hash. - Packets to be attached unhashed to the certification. - input secured random. - - - - Create a new key ring generator. - - - Conversion of the passphrase characters to bytes is performed using Convert.ToByte(), which is - the historical behaviour of the library (1.7 and earlier). - - The certification level for keys on this ring. - The master key pair. - The id to be associated with the ring. - The algorithm to be used to protect secret keys. - The passPhrase to be used to protect secret keys. - Checksum the secret keys with SHA1 rather than the older 16 bit checksum. - Packets to be included in the certification hash. - Packets to be attached unhashed to the certification. - input secured random. - - - - Create a new key ring generator. - - The certification level for keys on this ring. - The master key pair. - The id to be associated with the ring. - The algorithm to be used to protect secret keys. - - If true, conversion of the passphrase to bytes uses Encoding.UTF8.GetBytes(), otherwise the conversion - is performed using Convert.ToByte(), which is the historical behaviour of the library (1.7 and earlier). - - The passPhrase to be used to protect secret keys. - Checksum the secret keys with SHA1 rather than the older 16 bit checksum. - Packets to be included in the certification hash. - Packets to be attached unhashed to the certification. - input secured random. - - - - Create a new key ring generator. - - The certification level for keys on this ring. - The master key pair. - The id to be associated with the ring. - The algorithm to be used to protect secret keys. - The passPhrase to be used to protect secret keys. - Checksum the secret keys with SHA1 rather than the older 16 bit checksum. - Packets to be included in the certification hash. - Packets to be attached unhashed to the certification. - input secured random. - - - - Create a new key ring generator. - - - Conversion of the passphrase characters to bytes is performed using Convert.ToByte(), which is - the historical behaviour of the library (1.7 and earlier). - - The certification level for keys on this ring. - The master key pair. - The id to be associated with the ring. - The algorithm to be used to protect secret keys. - The hash algorithm. - The passPhrase to be used to protect secret keys. - Checksum the secret keys with SHA1 rather than the older 16 bit checksum. - Packets to be included in the certification hash. - Packets to be attached unhashed to the certification. - input secured random. - - - - Create a new key ring generator. - - The certification level for keys on this ring. - The master key pair. - The id to be associated with the ring. - The algorithm to be used to protect secret keys. - The hash algorithm. - - If true, conversion of the passphrase to bytes uses Encoding.UTF8.GetBytes(), otherwise the conversion - is performed using Convert.ToByte(), which is the historical behaviour of the library (1.7 and earlier). - - The passPhrase to be used to protect secret keys. - Checksum the secret keys with SHA1 rather than the older 16 bit checksum. - Packets to be included in the certification hash. - Packets to be attached unhashed to the certification. - input secured random. - - - - Create a new key ring generator. - - - Allows the caller to handle the encoding of the passphrase to bytes. - - The certification level for keys on this ring. - The master key pair. - The id to be associated with the ring. - The algorithm to be used to protect secret keys. - The hash algorithm. - The passPhrase to be used to protect secret keys. - Checksum the secret keys with SHA1 rather than the older 16 bit checksum. - Packets to be included in the certification hash. - Packets to be attached unhashed to the certification. - input secured random. - - - Add a subkey to the key ring to be generated with default certification. - - - - Add a subkey to the key ring to be generated with default certification. - - The key pair. - The hash algorithm. - - - - Add a signing subkey to the key ring to be generated with default certification and a primary key binding signature. - - The key pair. - The hash algorithm. - The primary-key binding hash algorithm. - - - - Add a subkey with specific hashed and unhashed packets associated with it and - default certification using SHA-1. - - Public/private key pair. - Hashed packet values to be included in certification. - Unhashed packets values to be included in certification. - - - - - Add a subkey with specific hashed and unhashed packets associated with it and - default certification. - - Public/private key pair. - Hashed packet values to be included in certification. - Unhashed packets values to be included in certification. - The hash algorithm. - exception adding subkey: - - - - - Add a signing subkey with specific hashed and unhashed packets associated with it and - default certifications, including the primary-key binding signature. - - Public/private key pair. - Hashed packet values to be included in certification. - Unhashed packets values to be included in certification. - The hash algorithm. - The primary-key binding hash algorithm. - exception adding subkey: - - - - Return the secret key ring. - - - Return the public key ring that corresponds to the secret key ring. - - - - Thrown if the key checksum is invalid. - - - - Class for processing literal data objects. - - - The special name indicating a "for your eyes only" packet. - - - The format of the data stream - Binary or Text - - - The file name that's associated with the data stream. - - - Return the file name as an unintrepreted byte array. - - - The modification time for the file. - - - The raw input stream for the data stream. - - - The input stream representing the data stream. - - - Class for producing literal data packets. - - - The special name indicating a "for your eyes only" packet. - - - - Generates literal data objects in the old format. - This is important if you need compatibility with PGP 2.6.x. - - If true, uses old format. - - - -

- Open a literal data packet, returning a stream to store the data inside the packet. -

-

- The stream created can be closed off by either calling Close() - on the stream or Close() on the generator. Closing the returned - stream does not close off the Stream parameter outStr. -

-
- The stream we want the packet in. - The format we are using. - The name of the 'file'. - The length of the data we will write. - The time of last modification we want stored. -
- - -

- Open a literal data packet, returning a stream to store the data inside the packet, - as an indefinite length stream. The stream is written out as a series of partial - packets with a chunk size determined by the size of the passed in buffer. -

-

- The stream created can be closed off by either calling Close() - on the stream or Close() on the generator. Closing the returned - stream does not close off the Stream parameter outStr. -

-

- Note: if the buffer is not a power of 2 in length only the largest power of 2 - bytes worth of the buffer will be used.

-
- The stream we want the packet in. - The format we are using. - The name of the 'file'. - The time of last modification we want stored. - The buffer to use for collecting data to put into chunks. -
- - -

- Open a literal data packet for the passed in FileInfo object, returning - an output stream for saving the file contents. -

-

- The stream created can be closed off by either calling Close() - on the stream or Close() on the generator. Closing the returned - stream does not close off the Stream parameter outStr. -

-
- The stream we want the packet in. - The format we are using. - The FileInfo object containg the packet details. -
- - - Close the literal data packet - this is equivalent to calling Close() - on the stream returned by the Open() method. - - - - - A PGP marker packet - in general these should be ignored other than where - the idea is to preserve the original input stream. - - - - - General class for reading a PGP object stream. -

- Note: if this class finds a PgpPublicKey or a PgpSecretKey it - will create a PgpPublicKeyRing, or a PgpSecretKeyRing for each - key found. If all you are trying to do is read a key ring file use - either PgpPublicKeyRingBundle or PgpSecretKeyRingBundle.

-
-
- - Return the next object in the stream, or null if the end is reached. - On a parse error - - - - Return all available objects in a list. - - An IList containing all objects from this factory, in order. - - - - Read all available objects, returning only those that are assignable to the specified type. - - The type of objects to return. All other objects are ignored. - An IList containing the filtered objects from this factory, in order. - - - A one pass signature object. - - - Initialise the signature object for verification. - - - Verify the calculated signature against the passed in PgpSignature. - - - Holder for a list of PgpOnePassSignature objects. - - - Padding functions. - - - A password based encryption object. - - - Return the raw input stream for the data stream. - - - Return the decrypted input stream, using the passed in passphrase. - - Conversion of the passphrase characters to bytes is performed using Convert.ToByte(), which is - the historical behaviour of the library (1.7 and earlier). - - - - Return the decrypted input stream, using the passed in passphrase. - - The passphrase is encoded to bytes using UTF8 (Encoding.UTF8.GetBytes). - - - - Return the decrypted input stream, using the passed in passphrase. - - Allows the caller to handle the encoding of the passphrase to bytes. - - - - General class to contain a private key for use with other OpenPGP objects. - - - - Create a PgpPrivateKey from a keyID, the associated public data packet, and a regular private key. - - ID of the corresponding public key. - the public key data packet to be associated with this private key. - the private key data packet to be associated with this private key. - - - The keyId associated with the contained private key. - - - The public key packet associated with this private key, if available. - - - The contained private key. - - - General class to handle a PGP public key object. - - - - Create a PgpPublicKey from the passed in lightweight one. - - - Note: the time passed in affects the value of the key's keyId, so you probably only want - to do this once for a lightweight key, or make sure you keep track of the time you used. - - Asymmetric algorithm type representing the public key. - Actual public key to associate. - Date of creation. - If pubKey is not public. - On key creation problem. - - - Constructor for a sub-key. - - - Copy constructor. - The public key to copy. - - - The version of this key. - - - The creation time of this key. - - - The number of valid days from creation time - zero means no expiry. - WARNING: This method will return 1 for keys with version > 3 that expire in less than 1 day - - - Return the trust data associated with the public key, if present. - A byte array with trust data, null otherwise. - - - The number of valid seconds from creation time - zero means no expiry. - - - The keyId associated with the public key. - - - The fingerprint of the key - - - - Check if this key has an algorithm type that makes it suitable to use for encryption. - - - Note: with version 4 keys KeyFlags subpackets should also be considered when present for - determining the preferred use of the key. - - - true if this key algorithm is suitable for encryption. - - - - True, if this could be a master key. - - - The algorithm code associated with the public key. - - - The strength of the key in bits. - - - The public key contained in the object. - A lightweight public key. - If the key algorithm is not recognised. - - - Allows enumeration of any user IDs associated with the key. - An IEnumerable of string objects. - - - Allows enumeration of any user attribute vectors associated with the key. - An IEnumerable of PgpUserAttributeSubpacketVector objects. - - - Allows enumeration of any signatures associated with the passed in id. - The ID to be matched. - An IEnumerable of PgpSignature objects. - - - Allows enumeration of signatures associated with the passed in user attributes. - The vector of user attributes to be matched. - An IEnumerable of PgpSignature objects. - - - Allows enumeration of signatures of the passed in type that are on this key. - The type of the signature to be returned. - An IEnumerable of PgpSignature objects. - - - Allows enumeration of all signatures/certifications associated with this key. - An IEnumerable with all signatures/certifications. - - - Return all signatures/certifications directly associated with this key (ie, not to a user id). - - @return an iterator (possibly empty) with all signatures/certifications. - - - Check whether this (sub)key has a revocation signature on it. - True, if this (sub)key has been revoked. - - - Add a certification for an id to the given public key. - The key the certification is to be added to. - The ID the certification is associated with. - The new certification. - The re-certified key. - - - Add a certification for the given UserAttributeSubpackets to the given public key. - The key the certification is to be added to. - The attributes the certification is associated with. - The new certification. - The re-certified key. - - - - Remove any certifications associated with a user attribute subpacket on a key. - - The key the certifications are to be removed from. - The attributes to be removed. - - The re-certified key, or null if the user attribute subpacket was not found on the key. - - - - Remove any certifications associated with a given ID on a key. - The key the certifications are to be removed from. - The ID that is to be removed. - The re-certified key, or null if the ID was not found on the key. - - - Remove a certification associated with a given ID on a key. - The key the certifications are to be removed from. - The ID that the certfication is to be removed from. - The certfication to be removed. - The re-certified key, or null if the certification was not found. - - - Remove a certification associated with a given user attributes on a key. - The key the certifications are to be removed from. - The user attributes that the certfication is to be removed from. - The certification to be removed. - The re-certified key, or null if the certification was not found. - - - Add a revocation or some other key certification to a key. - The key the revocation is to be added to. - The key signature to be added. - The new changed public key object. - - - Remove a certification from the key. - The key the certifications are to be removed from. - The certfication to be removed. - The modified key, null if the certification was not found. - - - A public key encrypted data object. - - - The key ID for the key used to encrypt the data. - - - - Return the algorithm code for the symmetric algorithm used to encrypt the data. - - - - Return the decrypted data stream for the packet. - - - - Class to hold a single master public key and its subkeys. -

- Often PGP keyring files consist of multiple master keys, if you are trying to process - or construct one of these you should use the PgpPublicKeyRingBundle class. -

-
-
- - Return the first public key in the ring. - - - Return the public key referred to by the passed in key ID if it is present. - - - Allows enumeration of all the public keys. - An IEnumerable of PgpPublicKey objects. - - - - Returns a new key ring with the public key passed in either added or - replacing an existing one. - - The public key ring to be modified. - The public key to be inserted. - A new PgpPublicKeyRing - - - Returns a new key ring with the public key passed in removed from the key ring. - The public key ring to be modified. - The public key to be removed. - A new PgpPublicKeyRing, or null if pubKey is not found. - - - - Often a PGP key ring file is made up of a succession of master/sub-key key rings. - If you want to read an entire public key file in one hit this is the class for you. - - - - Build a PgpPublicKeyRingBundle from the passed in input stream. - Input stream containing data. - If a problem parsing the stream occurs. - If an object is encountered which isn't a PgpPublicKeyRing. - - - Return the number of key rings in this collection. - - - Allow enumeration of the public key rings making up this collection. - - - Allow enumeration of the key rings associated with the passed in userId. - The user ID to be matched. - An IEnumerable of key rings which matched (possibly none). - - - Allow enumeration of the key rings associated with the passed in userId. - The user ID to be matched. - If true, userId need only be a substring of an actual ID string to match. - An IEnumerable of key rings which matched (possibly none). - - - Allow enumeration of the key rings associated with the passed in userId. - The user ID to be matched. - If true, userId need only be a substring of an actual ID string to match. - If true, case is ignored in user ID comparisons. - An IEnumerable of key rings which matched (possibly none). - - - Return the PGP public key associated with the given key id. - The ID of the public key to return. - - - Return the public key ring which contains the key referred to by keyId - key ID to match against - - - - Return true if a key matching the passed in key ID is present, false otherwise. - - key ID to look for. - - - - Return a new bundle containing the contents of the passed in bundle and - the passed in public key ring. - - The PgpPublicKeyRingBundle the key ring is to be added to. - The key ring to be added. - A new PgpPublicKeyRingBundle merging the current one with the passed in key ring. - If the keyId for the passed in key ring is already present. - - - - Return a new bundle containing the contents of the passed in bundle with - the passed in public key ring removed. - - The PgpPublicKeyRingBundle the key ring is to be removed from. - The key ring to be removed. - A new PgpPublicKeyRingBundle not containing the passed in key ring. - If the keyId for the passed in key ring is not present. - - - General class to handle a PGP secret key object. - - - - Conversion of the passphrase characters to bytes is performed using Convert.ToByte(), which is - the historical behaviour of the library (1.7 and earlier). - - - - - Conversion of the passphrase characters to bytes is performed using Convert.ToByte(), which is - the historical behaviour of the library (1.7 and earlier). - - - - - If utf8PassPhrase is true, conversion of the passphrase to bytes uses Encoding.UTF8.GetBytes(), otherwise the conversion - is performed using Convert.ToByte(), which is the historical behaviour of the library (1.7 and earlier). - - - - - Allows the caller to handle the encoding of the passphrase to bytes. - - - - - Conversion of the passphrase characters to bytes is performed using Convert.ToByte(), which is - the historical behaviour of the library (1.7 and earlier). - - - - - If utf8PassPhrase is true, conversion of the passphrase to bytes uses Encoding.UTF8.GetBytes(), otherwise the conversion - is performed using Convert.ToByte(), which is the historical behaviour of the library (1.7 and earlier). - - - - - Allows the caller to handle the encoding of the passphrase to bytes. - - - - - Check if this key has an algorithm type that makes it suitable to use for signing. - - - Note: with version 4 keys KeyFlags subpackets should also be considered when present for - determining the preferred use of the key. - - - true if this key algorithm is suitable for use with signing. - - - - True, if this is a master key. - - - Detect if the Secret Key's Private Key is empty or not - - - The algorithm the key is encrypted with. - - - The key ID of the public key associated with this key. - - - Return the S2K usage associated with this key. - - - Return the S2K used to process this key. - - - The public key associated with this key. - - - Allows enumeration of any user IDs associated with the key. - An IEnumerable of string objects. - - - Allows enumeration of any user attribute vectors associated with the key. - An IEnumerable of string objects. - - - Extract a PgpPrivateKey from this secret key's encrypted contents. - - Conversion of the passphrase characters to bytes is performed using Convert.ToByte(), which is - the historical behaviour of the library (1.7 and earlier). - - - - Extract a PgpPrivateKey from this secret key's encrypted contents. - - The passphrase is encoded to bytes using UTF8 (Encoding.UTF8.GetBytes). - - - - Extract a PgpPrivateKey from this secret key's encrypted contents. - - Allows the caller to handle the encoding of the passphrase to bytes. - - - - - Return a copy of the passed in secret key, encrypted using a new password - and the passed in algorithm. - - - Conversion of the passphrase characters to bytes is performed using Convert.ToByte(), which is - the historical behaviour of the library (1.7 and earlier). - - The PgpSecretKey to be copied. - The current password for the key. - The new password for the key. - The algorithm to be used for the encryption. - Source of randomness. - - - - Return a copy of the passed in secret key, encrypted using a new password - and the passed in algorithm. - - - The passphrase is encoded to bytes using UTF8 (Encoding.UTF8.GetBytes). - - The PgpSecretKey to be copied. - The current password for the key. - The new password for the key. - The algorithm to be used for the encryption. - Source of randomness. - - - - Return a copy of the passed in secret key, encrypted using a new password - and the passed in algorithm. - - - Allows the caller to handle the encoding of the passphrase to bytes. - - The PgpSecretKey to be copied. - The current password for the key. - The new password for the key. - The algorithm to be used for the encryption. - Source of randomness. - - - Replace the passed the public key on the passed in secret key. - Secret key to change. - New public key. - A new secret key. - If KeyId's do not match. - - - - Parse a secret key from one of the GPG S expression keys associating it with the passed in public key. - - - Conversion of the passphrase characters to bytes is performed using Convert.ToByte(), which is - the historical behaviour of the library (1.7 and earlier). - - - - - Parse a secret key from one of the GPG S expression keys associating it with the passed in public key. - - - The passphrase is encoded to bytes using UTF8 (Encoding.UTF8.GetBytes). - - - - - Parse a secret key from one of the GPG S expression keys associating it with the passed in public key. - - - Allows the caller to handle the encoding of the passphrase to bytes. - - - - - Parse a secret key from one of the GPG S expression keys. - - - Conversion of the passphrase characters to bytes is performed using Convert.ToByte(), which is - the historical behaviour of the library (1.7 and earlier). - - - - - Parse a secret key from one of the GPG S expression keys. - - - The passphrase is encoded to bytes using UTF8 (Encoding.UTF8.GetBytes). - - - - - Parse a secret key from one of the GPG S expression keys. - - - Allows the caller to handle the encoding of the passphrase to bytes. - - - - - Parse a secret key from one of the GPG S expression keys. - - - - - Class to hold a single master secret key and its subkeys. -

- Often PGP keyring files consist of multiple master keys, if you are trying to process - or construct one of these you should use the PgpSecretKeyRingBundle class. -

-
-
- - Return the public key for the master key. - - - Return the master private key. - - - Allows enumeration of the secret keys. - An IEnumerable of PgpSecretKey objects. - - - - Return an iterator of the public keys in the secret key ring that - have no matching private key. At the moment only personal certificate data - appears in this fashion. - - An IEnumerable of unattached, or extra, public keys. - - - - Replace the public key set on the secret ring with the corresponding key off the public ring. - - Secret ring to be changed. - Public ring containing the new public key set. - - - - Return a copy of the passed in secret key ring, with the master key and sub keys encrypted - using a new password and the passed in algorithm. - - The PgpSecretKeyRing to be copied. - The current password for key. - The new password for the key. - The algorithm to be used for the encryption. - Source of randomness. - - - - Returns a new key ring with the secret key passed in either added or - replacing an existing one with the same key ID. - - The secret key ring to be modified. - The secret key to be inserted. - A new PgpSecretKeyRing - - - Returns a new key ring with the secret key passed in removed from the key ring. - The secret key ring to be modified. - The secret key to be removed. - A new PgpSecretKeyRing, or null if secKey is not found. - - - - Often a PGP key ring file is made up of a succession of master/sub-key key rings. - If you want to read an entire secret key file in one hit this is the class for you. - - - - Build a PgpSecretKeyRingBundle from the passed in input stream. - Input stream containing data. - If a problem parsing the stream occurs. - If an object is encountered which isn't a PgpSecretKeyRing. - - - Return the number of rings in this collection. - - - Allow enumeration of the secret key rings making up this collection. - - - Allow enumeration of the key rings associated with the passed in userId. - The user ID to be matched. - An IEnumerable of key rings which matched (possibly none). - - - Allow enumeration of the key rings associated with the passed in userId. - The user ID to be matched. - If true, userId need only be a substring of an actual ID string to match. - An IEnumerable of key rings which matched (possibly none). - - - Allow enumeration of the key rings associated with the passed in userId. - The user ID to be matched. - If true, userId need only be a substring of an actual ID string to match. - If true, case is ignored in user ID comparisons. - An IEnumerable of key rings which matched (possibly none). - - - Return the PGP secret key associated with the given key id. - The ID of the secret key to return. - - - Return the secret key ring which contains the key referred to by keyId - The ID of the secret key - - - - Return true if a key matching the passed in key ID is present, false otherwise. - - key ID to look for. - - - - Return a new bundle containing the contents of the passed in bundle and - the passed in secret key ring. - - The PgpSecretKeyRingBundle the key ring is to be added to. - The key ring to be added. - A new PgpSecretKeyRingBundle merging the current one with the passed in key ring. - If the keyId for the passed in key ring is already present. - - - - Return a new bundle containing the contents of the passed in bundle with - the passed in secret key ring removed. - - The PgpSecretKeyRingBundle the key ring is to be removed from. - The key ring to be removed. - A new PgpSecretKeyRingBundle not containing the passed in key ring. - If the keyId for the passed in key ring is not present. - - - A PGP signature object. - - - The OpenPGP version number for this signature. - - - The key algorithm associated with this signature. - - - The hash algorithm associated with this signature. - - - Return true if this signature represents a certification. - - - - Verify the signature as certifying the passed in public key as associated - with the passed in user attributes. - - User attributes the key was stored under. - The key to be verified. - True, if the signature matches, false otherwise. - - - - Verify the signature as certifying the passed in public key as associated - with the passed in ID. - - ID the key was stored under. - The key to be verified. - True, if the signature matches, false otherwise. - - - Verify a certification for the passed in key against the passed in master key. - The key we are verifying against. - The key we are verifying. - True, if the certification is valid, false otherwise. - - - Verify a key certification, such as revocation, for the passed in key. - The key we are checking. - True, if the certification is valid, false otherwise. - - - The ID of the key that created the signature. - - - The creation time of this signature. - - - - Return true if the signature has either hashed or unhashed subpackets. - - - - - Return true if the passed in signature type represents a certification, false if the signature type is not. - - - true if signatureType is a certification, false otherwise. - - - Generator for PGP signatures. - - - Create a generator for the passed in keyAlgorithm and hashAlgorithm codes. - - - Initialise the generator for signing. - - - Initialise the generator for signing. - - - Return the one pass header associated with the current signature. - - - Return a signature object containing the current signature state. - - - Generate a certification for the passed in ID and key. - The ID we are certifying against the public key. - The key we are certifying against the ID. - The certification. - - - Generate a certification for the passed in userAttributes. - The ID we are certifying against the public key. - The key we are certifying against the ID. - The certification. - - - Generate a certification for the passed in key against the passed in master key. - The key we are certifying against. - The key we are certifying. - The certification. - - - Generate a certification, such as a revocation, for the passed in key. - The key we are certifying. - The certification. - - - A list of PGP signatures - normally in the signature block after literal data. - - - Generator for signature subpackets. - - - - Base constructor, creates an empty generator. - - - - - Constructor for pre-initialising the generator from an existing one. - - - sigSubV an initial set of subpackets. - - - - - Add a TrustSignature packet to the signature. The values for depth and trust are largely - installation dependent but there are some guidelines in RFC 4880 - 5.2.3.13. - - true if the packet is critical. - depth level. - trust amount. - - - - Set the number of seconds a key is valid for after the time of its creation. - A value of zero means the key never expires. - - True, if should be treated as critical, false otherwise. - The number of seconds the key is valid, or zero if no expiry. - - - - Set the number of seconds a signature is valid for after the time of its creation. - A value of zero means the signature never expires. - - True, if should be treated as critical, false otherwise. - The number of seconds the signature is valid, or zero if no expiry. - - - - Set the creation time for the signature. -

- Note: this overrides the generation of a creation time when the signature - is generated.

-
-
- - - Sets revocation reason sub packet - - - - - Sets revocation key sub packet - - - - - Sets issuer key sub packet - - - - Container for a list of signature subpackets. - - - Return true if a particular subpacket type exists. - - @param type type to look for. - @return true if present, false otherwise. - - - Return all signature subpackets of the passed in type. - @param type subpacket type code - @return an array of zero or more matching subpackets. - - - - Return the number of seconds a signature is valid for after its creation date. - A value of zero means the signature never expires. - - Seconds a signature is valid for. - - - - Return the number of seconds a key is valid for after its creation date. - A value of zero means the key never expires. - - Seconds a signature is valid for. - - - Return the number of packets this vector contains. - - - Container for a list of user attribute subpackets. - - - Basic utility class. - - - - Conversion of the passphrase characters to bytes is performed using Convert.ToByte(), which is - the historical behaviour of the library (1.7 and earlier). - - - - - The passphrase is encoded to bytes using UTF8 (Encoding.UTF8.GetBytes). - - - - - Allows the caller to handle the encoding of the passphrase to bytes. - - - - Write out the passed in file as a literal data packet. - - - Write out the passed in file as a literal data packet in partial packet format. - - - - Return either an ArmoredInputStream or a BcpgInputStream based on whether - the initial characters of the stream are binary PGP encodings or not. - - - - Generator for old style PGP V3 Signatures. - - - Create a generator for the passed in keyAlgorithm and hashAlgorithm codes. - - - Initialise the generator for signing. - - - Initialise the generator for signing. - - - Return the one pass header associated with the current signature. - - - Return a V3 signature object containing the current signature state. - - - Utility functions for looking a S-expression keys. This class will move when it finds a better home! -

- Format documented here: - http://git.gnupg.org/cgi-bin/gitweb.cgi?p=gnupg.git;a=blob;f=agent/keyformat.txt;h=42c4b1f06faf1bbe71ffadc2fee0fad6bec91a97;hb=refs/heads/master -

-
- - - Wrap a PKIMessage ASN.1 structure. - - PKI message. - - - - Create a PKIMessage from the passed in bytes. - - BER/DER encoding of the PKIMessage - - - - Return true if this message has protection bits on it. A return value of true - indicates the message can be used to construct a ProtectedPKIMessage. - - - - - Wrapper for a PKIMessage with protection attached to it. - - - - - Wrap a general message. - - If the general message does not have protection. - The General message - - - - Wrap a PKI message. - - If the PKI message does not have protection. - The PKI message - - - - Message header - - - - - Message Body - - - - - Return the underlying ASN.1 structure contained in this object. - - PKI Message structure - - - - Determine whether the message is protected by a password based MAC. Use verify(PKMACBuilder, char[]) - to verify the message if this method returns true. - - true if protection MAC PBE based, false otherwise. - - - - Return the extra certificates associated with this message. - - an array of extra certificates, zero length if none present. - - - - Verify a message with a public key based signature attached. - - a factory of signature verifiers. - true if the provider is able to create a verifier that validates the signature, false otherwise. - - - - Verify a message with password based MAC protection. - - MAC builder that can be used to construct the appropriate MacCalculator - the MAC password - true if the passed in password and MAC builder verify the message, false otherwise. - if algorithm not MAC based, or an exception is thrown verifying the MAC. - - - - The 'Signature' parameter is only available when generating unsigned attributes. - - - - containing class for an CMS Authenticated Data object - - - return the object identifier for the content MAC algorithm. - - - return a store of the intended recipients for this message - - - return the ContentInfo - - - return a table of the digested attributes indexed by - the OID of the attribute. - - - return a table of the undigested attributes indexed by - the OID of the attribute. - - - return the ASN.1 encoded representation of this object. - - - General class for generating a CMS authenticated-data message. - - A simple example of usage. - -
-                  CMSAuthenticatedDataGenerator  fact = new CMSAuthenticatedDataGenerator();
-            
-                  fact.addKeyTransRecipient(cert);
-            
-                  CMSAuthenticatedData         data = fact.generate(content, algorithm, "BC");
-             
-
- - base constructor - - - constructor allowing specific source of randomness - @param rand instance of SecureRandom to use - - - generate an enveloped object that contains an CMS Enveloped Data - object using the given provider and the passed in key generator. - - - generate an authenticated object that contains an CMS Authenticated Data object - - - Parsing class for an CMS Authenticated Data object from an input stream. -

- Note: that because we are in a streaming mode only one recipient can be tried and it is important - that the methods on the parser are called in the appropriate order. -

-

- Example of use - assuming the first recipient matches the private key we have. -

-                  CMSAuthenticatedDataParser     ad = new CMSAuthenticatedDataParser(inputStream);
-            
-                  RecipientInformationStore  recipients = ad.getRecipientInfos();
-            
-                  Collection  c = recipients.getRecipients();
-                  Iterator    it = c.iterator();
-            
-                  if (it.hasNext())
-                  {
-                      RecipientInformation   recipient = (RecipientInformation)it.next();
-            
-                      CMSTypedStream recData = recipient.getContentStream(privateKey, "BC");
-            
-                      processDataStream(recData.getContentStream());
-            
-                      if (!Arrays.equals(ad.getMac(), recipient.getMac())
-                      {
-                          System.err.println("Data corrupted!!!!");
-                      }
-                  }
-              
- Note: this class does not introduce buffering - if you are processing large files you should create - the parser with: -
-                      CMSAuthenticatedDataParser     ep = new CMSAuthenticatedDataParser(new BufferedInputStream(inputStream, bufSize));
-              
- where bufSize is a suitably large buffer size. -

-
- - return the object identifier for the mac algorithm. - - - return the ASN.1 encoded encryption algorithm parameters, or null if - there aren't any. - - - return a store of the intended recipients for this message - - - return a table of the unauthenticated attributes indexed by - the OID of the attribute. - @exception java.io.IOException - - - return a table of the unauthenticated attributes indexed by - the OID of the attribute. - @exception java.io.IOException - - - General class for generating a CMS authenticated-data message stream. -

- A simple example of usage. -

-                  CMSAuthenticatedDataStreamGenerator edGen = new CMSAuthenticatedDataStreamGenerator();
-            
-                  edGen.addKeyTransRecipient(cert);
-            
-                  ByteArrayOutputStream  bOut = new ByteArrayOutputStream();
-            
-                  OutputStream out = edGen.open(
-                                          bOut, CMSAuthenticatedDataGenerator.AES128_CBC, "BC");*
-                  out.write(data);
-            
-                  out.close();
-             
-

-
- - base constructor - - - constructor allowing specific source of randomness - @param rand instance of SecureRandom to use - - - Set the underlying string size for encapsulated data - - @param bufferSize length of octet strings to buffer the data. - - - Use a BER Set to store the recipient information - - - generate an enveloped object that contains an CMS Enveloped Data - object using the given provider and the passed in key generator. - @throws java.io.IOException - - - generate an enveloped object that contains an CMS Enveloped Data object - - - generate an enveloped object that contains an CMS Enveloped Data object - - - base constructor - - - constructor allowing specific source of randomness - - @param rand instance of SecureRandom to use - - - containing class for an CMS AuthEnveloped Data object - - - containing class for an CMS Compressed Data object - - - Return the uncompressed content. - - @return the uncompressed content - @throws CmsException if there is an exception uncompressing the data. - - - Return the uncompressed content, throwing an exception if the data size - is greater than the passed in limit. If the content is exceeded getCause() - on the CMSException will contain a StreamOverflowException - - @param limit maximum number of bytes to read - @return the content read - @throws CMSException if there is an exception uncompressing the data. - - - return the ContentInfo - - - return the ASN.1 encoded representation of this object. - - - * General class for generating a compressed CMS message. - *

- * A simple example of usage.

- *

- *

-                *      CMSCompressedDataGenerator fact = new CMSCompressedDataGenerator();
-                *      CMSCompressedData data = fact.Generate(content, algorithm);
-                * 
- *

-
- - Generate an object that contains an CMS Compressed Data - - - Class for reading a CMS Compressed Data stream. -
-                 CMSCompressedDataParser cp = new CMSCompressedDataParser(inputStream);
-            
-                 process(cp.GetContent().GetContentStream());
-             
- Note: this class does not introduce buffering - if you are processing large files you should create - the parser with: -
-                  CMSCompressedDataParser     ep = new CMSCompressedDataParser(new BufferedInputStream(inputStream, bufSize));
-              
- where bufSize is a suitably large buffer size. -
- - General class for generating a compressed CMS message stream. -

- A simple example of usage. -

-
-                  CMSCompressedDataStreamGenerator gen = new CMSCompressedDataStreamGenerator();
-            
-                  Stream cOut = gen.Open(outputStream, CMSCompressedDataStreamGenerator.ZLIB);
-            
-                  cOut.Write(data);
-            
-                  cOut.Close();
-             
-
- - base constructor - - - Set the underlying string size for encapsulated data - - @param bufferSize length of octet strings to buffer the data. - - - Close the underlying data stream. - @throws IOException if the close fails. - - - containing class for an CMS Enveloped Data object - - - return the object identifier for the content encryption algorithm. - - - return a store of the intended recipients for this message - - - return the ContentInfo - - - return a table of the unprotected attributes indexed by - the OID of the attribute. - - - return the ASN.1 encoded representation of this object. - - - - General class for generating a CMS enveloped-data message. - - A simple example of usage. - -
-                  CmsEnvelopedDataGenerator  fact = new CmsEnvelopedDataGenerator();
-            
-                  fact.AddKeyTransRecipient(cert);
-            
-                  CmsEnvelopedData         data = fact.Generate(content, algorithm);
-             
-
-
- - Constructor allowing specific source of randomness - Instance of SecureRandom to use. - - - - Generate an enveloped object that contains a CMS Enveloped Data - object using the passed in key generator. - - - - Generate an enveloped object that contains an CMS Enveloped Data object. - - - Generate an enveloped object that contains an CMS Enveloped Data object. - - - Parsing class for an CMS Enveloped Data object from an input stream. -

- Note: that because we are in a streaming mode only one recipient can be tried and it is important - that the methods on the parser are called in the appropriate order. -

-

- Example of use - assuming the first recipient matches the private key we have. -

-                  CmsEnvelopedDataParser     ep = new CmsEnvelopedDataParser(inputStream);
-            
-                  RecipientInformationStore  recipients = ep.GetRecipientInfos();
-            
-                  Collection  c = recipients.getRecipients();
-                  Iterator    it = c.iterator();
-            
-                  if (it.hasNext())
-                  {
-                      RecipientInformation   recipient = (RecipientInformation)it.next();
-            
-                      CMSTypedStream recData = recipient.getContentStream(privateKey);
-            
-                      processDataStream(recData.getContentStream());
-                  }
-              
- Note: this class does not introduce buffering - if you are processing large files you should create - the parser with: -
-                      CmsEnvelopedDataParser     ep = new CmsEnvelopedDataParser(new BufferedInputStream(inputStream, bufSize));
-              
- where bufSize is a suitably large buffer size. -

-
- - return the object identifier for the content encryption algorithm. - - - return the ASN.1 encoded encryption algorithm parameters, or null if - there aren't any. - - - return a store of the intended recipients for this message - - - return a table of the unprotected attributes indexed by - the OID of the attribute. - @throws IOException - - - General class for generating a CMS enveloped-data message stream. -

- A simple example of usage. -

-                  CmsEnvelopedDataStreamGenerator edGen = new CmsEnvelopedDataStreamGenerator();
-            
-                  edGen.AddKeyTransRecipient(cert);
-            
-                  MemoryStream  bOut = new MemoryStream();
-            
-                  Stream out = edGen.Open(
-                                          bOut, CMSEnvelopedDataGenerator.AES128_CBC);*
-                  out.Write(data);
-            
-                  out.Close();
-             
-

-
- - Constructor allowing specific source of randomness - Instance of SecureRandom to use. - - - Set the underlying string size for encapsulated data. - Length of octet strings to buffer the data. - - - Use a BER Set to store the recipient information. - - - - Generate an enveloped object that contains an CMS Enveloped Data - object using the passed in key generator. - - - - generate an enveloped object that contains an CMS Enveloped Data object - @throws IOException - - - generate an enveloped object that contains an CMS Enveloped Data object - @throws IOException - - - General class for generating a CMS enveloped-data message. - - A simple example of usage. - -
-                  CMSEnvelopedDataGenerator  fact = new CMSEnvelopedDataGenerator();
-            
-                  fact.addKeyTransRecipient(cert);
-            
-                  CMSEnvelopedData         data = fact.generate(content, algorithm, "BC");
-             
-
- - Constructor allowing specific source of randomness - Instance of SecureRandom to use. - - - add a recipient. - - @param cert recipient's public key certificate - @exception ArgumentException if there is a problem with the certificate - - - add a recipient - - @param key the public key used by the recipient - @param subKeyId the identifier for the recipient's public key - @exception ArgumentException if there is a problem with the key - - - add a KEK recipient. - @param key the secret key to use for wrapping - @param keyIdentifier the byte string that identifies the key - - - add a KEK recipient. - @param key the secret key to use for wrapping - @param keyIdentifier the byte string that identifies the key - - - Add a key agreement based recipient. - - @param agreementAlgorithm key agreement algorithm to use. - @param senderPrivateKey private key to initialise sender side of agreement with. - @param senderPublicKey sender public key to include with message. - @param recipientCert recipient's public key certificate. - @param cekWrapAlgorithm OID for key wrapping algorithm to use. - @exception SecurityUtilityException if the algorithm requested cannot be found - @exception InvalidKeyException if the keys are inappropriate for the algorithm specified - - - Add multiple key agreement based recipients (sharing a single KeyAgreeRecipientInfo structure). - - @param agreementAlgorithm key agreement algorithm to use. - @param senderPrivateKey private key to initialise sender side of agreement with. - @param senderPublicKey sender public key to include with message. - @param recipientCerts recipients' public key certificates. - @param cekWrapAlgorithm OID for key wrapping algorithm to use. - @exception SecurityUtilityException if the algorithm requested cannot be found - @exception InvalidKeyException if the keys are inappropriate for the algorithm specified - - - - Add a generator to produce the recipient info required. - - a generator of a recipient info object. - - - - Generic routine to copy out the data we want processed. - - - This routine may be called multiple times. - - - - a holding class for a byte array of data to be processed. - - - A clone of the byte array - - - a holding class for a file of data to be processed. - - - The file handle - - - general class for handling a pkcs7-signature message. - - A simple example of usage - note, in the example below the validity of - the certificate isn't verified, just the fact that one of the certs - matches the given signer... - -
-              IX509Store              certs = s.GetCertificates();
-              SignerInformationStore  signers = s.GetSignerInfos();
-            
-              foreach (SignerInformation signer in signers.GetSigners())
-              {
-                  ArrayList       certList = new ArrayList(certs.GetMatches(signer.SignerID));
-                  X509Certificate cert = (X509Certificate) certList[0];
-            
-                  if (signer.Verify(cert.GetPublicKey()))
-                  {
-                      verified++;
-                  }
-              }
-             
-
- - Content with detached signature, digests precomputed - - @param hashes a map of precomputed digests for content indexed by name of hash. - @param sigBlock the signature object. - - - base constructor - content with detached signature. - - @param signedContent the content that was signed. - @param sigData the signature object. - - - base constructor - with encapsulated content - - - Return the version number for this object. - - - return the collection of signers that are associated with the - signatures for the message. - - - return a X509Store containing the attribute certificates, if any, contained - in this message. - - @param type type of store to create - @return a store of attribute certificates - @exception NoSuchStoreException if the store type isn't available. - @exception CmsException if a general exception prevents creation of the X509Store - - - return a X509Store containing the public key certificates, if any, contained - in this message. - - @param type type of store to create - @return a store of public key certificates - @exception NoSuchStoreException if the store type isn't available. - @exception CmsException if a general exception prevents creation of the X509Store - - - return a X509Store containing CRLs, if any, contained - in this message. - - @param type type of store to create - @return a store of CRLs - @exception NoSuchStoreException if the store type isn't available. - @exception CmsException if a general exception prevents creation of the X509Store - - - - Return the DerObjectIdentifier associated with the encapsulated - content info structure carried in the signed data. - - - - return the ContentInfo - - - return the ASN.1 encoded representation of this object. - - - return the ASN.1 encoded representation of this object using the specified encoding. - - @param encoding the ASN.1 encoding format to use ("BER" or "DER"). - - - Replace the signerinformation store associated with this - CmsSignedData object with the new one passed in. You would - probably only want to do this if you wanted to change the unsigned - attributes associated with a signer, or perhaps delete one. - - @param signedData the signed data object to be used as a base. - @param signerInformationStore the new signer information store to use. - @return a new signed data object. - - - Replace the certificate and CRL information associated with this - CmsSignedData object with the new one passed in. - - @param signedData the signed data object to be used as a base. - @param x509Certs the new certificates to be used. - @param x509Crls the new CRLs to be used. - @return a new signed data object. - @exception CmsException if there is an error processing the stores - - - * general class for generating a pkcs7-signature message. - *

- * A simple example of usage. - * - *

-                 *      IX509Store certs...
-                 *      IX509Store crls...
-                 *      CmsSignedDataGenerator gen = new CmsSignedDataGenerator();
-                 *
-                 *      gen.AddSigner(privKey, cert, CmsSignedGenerator.DigestSha1);
-                 *      gen.AddCertificates(certs);
-                 *      gen.AddCrls(crls);
-                 *
-                 *      CmsSignedData data = gen.Generate(content);
-                 * 
- *

-
- - Constructor allowing specific source of randomness - Instance of SecureRandom to use. - - - * add a signer - no attributes other than the default ones will be - * provided here. - * - * @param key signing key to use - * @param cert certificate containing corresponding public key - * @param digestOID digest algorithm OID - - - add a signer, specifying the digest encryption algorithm to use - no attributes other than the default ones will be - provided here. - - @param key signing key to use - @param cert certificate containing corresponding public key - @param encryptionOID digest encryption algorithm OID - @param digestOID digest algorithm OID - - - add a signer - no attributes other than the default ones will be - provided here. - - - add a signer, specifying the digest encryption algorithm to use - no attributes other than the default ones will be - provided here. - - - * add a signer with extra signed/unsigned attributes. - * - * @param key signing key to use - * @param cert certificate containing corresponding public key - * @param digestOID digest algorithm OID - * @param signedAttr table of attributes to be included in signature - * @param unsignedAttr table of attributes to be included as unsigned - - - add a signer, specifying the digest encryption algorithm, with extra signed/unsigned attributes. - - @param key signing key to use - @param cert certificate containing corresponding public key - @param encryptionOID digest encryption algorithm OID - @param digestOID digest algorithm OID - @param signedAttr table of attributes to be included in signature - @param unsignedAttr table of attributes to be included as unsigned - - - * add a signer with extra signed/unsigned attributes. - * - * @param key signing key to use - * @param subjectKeyID subjectKeyID of corresponding public key - * @param digestOID digest algorithm OID - * @param signedAttr table of attributes to be included in signature - * @param unsignedAttr table of attributes to be included as unsigned - - - add a signer, specifying the digest encryption algorithm, with extra signed/unsigned attributes. - - @param key signing key to use - @param subjectKeyID subjectKeyID of corresponding public key - @param encryptionOID digest encryption algorithm OID - @param digestOID digest algorithm OID - @param signedAttr table of attributes to be included in signature - @param unsignedAttr table of attributes to be included as unsigned - - - add a signer with extra signed/unsigned attributes based on generators. - - - add a signer, specifying the digest encryption algorithm, with extra signed/unsigned attributes based on generators. - - - add a signer with extra signed/unsigned attributes based on generators. - - - add a signer, including digest encryption algorithm, with extra signed/unsigned attributes based on generators. - - - generate a signed object that for a CMS Signed Data object - - - generate a signed object that for a CMS Signed Data - object - if encapsulate is true a copy - of the message will be included in the signature. The content type - is set according to the OID represented by the string signedContentType. - - - generate a signed object that for a CMS Signed Data - object - if encapsulate is true a copy - of the message will be included in the signature with the - default content type "data". - - - generate a set of one or more SignerInformation objects representing counter signatures on - the passed in SignerInformation object. - - @param signer the signer to be countersigned - @param sigProvider the provider to be used for counter signing. - @return a store containing the signers. - - - Parsing class for an CMS Signed Data object from an input stream. -

- Note: that because we are in a streaming mode only one signer can be tried and it is important - that the methods on the parser are called in the appropriate order. -

-

- A simple example of usage for an encapsulated signature. -

-

- Two notes: first, in the example below the validity of - the certificate isn't verified, just the fact that one of the certs - matches the given signer, and, second, because we are in a streaming - mode the order of the operations is important. -

-
-                  CmsSignedDataParser     sp = new CmsSignedDataParser(encapSigData);
-            
-                  sp.GetSignedContent().Drain();
-            
-                  IX509Store              certs = sp.GetCertificates();
-                  SignerInformationStore  signers = sp.GetSignerInfos();
-            
-                  foreach (SignerInformation signer in signers.GetSigners())
-                  {
-                      ArrayList       certList = new ArrayList(certs.GetMatches(signer.SignerID));
-                      X509Certificate cert = (X509Certificate) certList[0];
-            
-                      Console.WriteLine("verify returns: " + signer.Verify(cert));
-                  }
-             
- Note also: this class does not introduce buffering - if you are processing large files you should create - the parser with: -
-                      CmsSignedDataParser     ep = new CmsSignedDataParser(new BufferedInputStream(encapSigData, bufSize));
-              
- where bufSize is a suitably large buffer size. -
- - base constructor - with encapsulated content - - - base constructor - - @param signedContent the content that was signed. - @param sigData the signature object. - - - Return the version number for the SignedData object - - @return the version number - - - return the collection of signers that are associated with the - signatures for the message. - @throws CmsException - - - return a X509Store containing the attribute certificates, if any, contained - in this message. - - @param type type of store to create - @return a store of attribute certificates - @exception org.bouncycastle.x509.NoSuchStoreException if the store type isn't available. - @exception CmsException if a general exception prevents creation of the X509Store - - - return a X509Store containing the public key certificates, if any, contained - in this message. - - @param type type of store to create - @return a store of public key certificates - @exception NoSuchStoreException if the store type isn't available. - @exception CmsException if a general exception prevents creation of the X509Store - - - return a X509Store containing CRLs, if any, contained - in this message. - - @param type type of store to create - @return a store of CRLs - @exception NoSuchStoreException if the store type isn't available. - @exception CmsException if a general exception prevents creation of the X509Store - - - - Return the DerObjectIdentifier associated with the encapsulated - content info structure carried in the signed data. - - - - Replace the signerinformation store associated with the passed - in message contained in the stream original with the new one passed in. - You would probably only want to do this if you wanted to change the unsigned - attributes associated with a signer, or perhaps delete one. -

- The output stream is returned unclosed. -

- @param original the signed data stream to be used as a base. - @param signerInformationStore the new signer information store to use. - @param out the stream to Write the new signed data object to. - @return out. -
- - Replace the certificate and CRL information associated with this - CMSSignedData object with the new one passed in. -

- The output stream is returned unclosed. -

- @param original the signed data stream to be used as a base. - @param certsAndCrls the new certificates and CRLs to be used. - @param out the stream to Write the new signed data object to. - @return out. - @exception CmsException if there is an error processing the CertStore -
- - General class for generating a pkcs7-signature message stream. -

- A simple example of usage. -

-
-                  IX509Store                   certs...
-                  CmsSignedDataStreamGenerator gen = new CmsSignedDataStreamGenerator();
-            
-                  gen.AddSigner(privateKey, cert, CmsSignedDataStreamGenerator.DIGEST_SHA1);
-            
-                  gen.AddCertificates(certs);
-            
-                  Stream sigOut = gen.Open(bOut);
-            
-                  sigOut.Write(Encoding.UTF8.GetBytes("Hello World!"));
-            
-                  sigOut.Close();
-             
-
- - Constructor allowing specific source of randomness - Instance of SecureRandom to use. - - - Set the underlying string size for encapsulated data - - @param bufferSize length of octet strings to buffer the data. - - - add a signer - no attributes other than the default ones will be - provided here. - @throws NoSuchAlgorithmException - @throws InvalidKeyException - - - add a signer, specifying the digest encryption algorithm - no attributes other than the default ones will be - provided here. - @throws NoSuchProviderException - @throws NoSuchAlgorithmException - @throws InvalidKeyException - - - add a signer with extra signed/unsigned attributes. - @throws NoSuchAlgorithmException - @throws InvalidKeyException - - - add a signer with extra signed/unsigned attributes - specifying digest - encryption algorithm. - @throws NoSuchProviderException - @throws NoSuchAlgorithmException - @throws InvalidKeyException - - - add a signer - no attributes other than the default ones will be - provided here. - @throws NoSuchAlgorithmException - @throws InvalidKeyException - - - add a signer - no attributes other than the default ones will be - provided here. - @throws NoSuchProviderException - @throws NoSuchAlgorithmException - @throws InvalidKeyException - - - add a signer with extra signed/unsigned attributes. - @throws NoSuchAlgorithmException - @throws InvalidKeyException - - - generate a signed object that for a CMS Signed Data object - - - generate a signed object that for a CMS Signed Data - object - if encapsulate is true a copy - of the message will be included in the signature with the - default content type "data". - - - generate a signed object that for a CMS Signed Data - object using the given provider - if encapsulate is true a copy - of the message will be included in the signature with the - default content type "data". If dataOutputStream is non null the data - being signed will be written to the stream as it is processed. - @param out stream the CMS object is to be written to. - @param encapsulate true if data should be encapsulated. - @param dataOutputStream output stream to copy the data being signed to. - - - generate a signed object that for a CMS Signed Data - object - if encapsulate is true a copy - of the message will be included in the signature. The content type - is set according to the OID represented by the string signedContentType. - - - generate a signed object that for a CMS Signed Data - object using the given provider - if encapsulate is true a copy - of the message will be included in the signature. The content type - is set according to the OID represented by the string signedContentType. - @param out stream the CMS object is to be written to. - @param signedContentType OID for data to be signed. - @param encapsulate true if data should be encapsulated. - @param dataOutputStream output stream to copy the data being signed to. - - - Default type for the signed data. - - - Constructor allowing specific source of randomness - Instance of SecureRandom to use. - - - Add the attribute certificates contained in the passed in store to the - generator. - - @param store a store of Version 2 attribute certificates - @throws CmsException if an error occurse processing the store. - - - Add a store of precalculated signers to the generator. - - @param signerStore store of signers - - - Return a map of oids and byte arrays representing the digests calculated on the content during - the last generate. - - @return a map of oids (as string objects) and byte[] representing digests. - - - Return the digest algorithm using one of the standard JCA string - representations rather than the algorithm identifier (if possible). - - - Return the digest encryption algorithm using one of the standard - JCA string representations rather than the algorithm identifier (if - possible). - - - Default authenticated attributes generator. - - - Initialise to use all defaults - - - Initialise with some extra attributes or overrides. - - @param attributeTable initial attribute table to use. - - - Create a standard attribute table from the passed in parameters - this will - normally include contentType and messageDigest. If the constructor - using an AttributeTable was used, entries in it for contentType and - messageDigest will override the generated ones. - - @param parameters source parameters for table generation. - - @return a filled in IDictionary of attributes. - - - @param parameters source parameters - @return the populated attribute table - - - Default signed attributes generator. - - - Initialise to use all defaults - - - Initialise with some extra attributes or overrides. - - @param attributeTable initial attribute table to use. - - - Create a standard attribute table from the passed in parameters - this will - normally include contentType, signingTime, and messageDigest. If the constructor - using an AttributeTable was used, entries in it for contentType, signingTime, and - messageDigest will override the generated ones. - - @param parameters source parameters for table generation. - - @return a filled in Hashtable of attributes. - - - @param parameters source parameters - @return the populated attribute table - - - the RecipientInfo class for a recipient who has been sent a message - encrypted using a secret key known to the other side. - - - decrypt the content and return an input stream. - - - the RecipientInfo class for a recipient who has been sent a message - encrypted using key agreement. - - - decrypt the content and return an input stream. - - - the KeyTransRecipientInformation class for a recipient who has been sent a secret - key encrypted using their public key that needs to be used to - extract the message. - - - decrypt the content and return it as a byte array. - - - a basic index for an originator. - - - Return the certificates stored in the underlying OriginatorInfo object. - - @return a Store of X509CertificateHolder objects. - - - Return the CRLs stored in the underlying OriginatorInfo object. - - @return a Store of X509CRLHolder objects. - - - Return the underlying ASN.1 object defining this SignerInformation object. - - @return a OriginatorInfo. - - - the RecipientInfo class for a recipient who has been sent a message - encrypted using a password. - - - return the object identifier for the key derivation algorithm, or null - if there is none present. - - @return OID for key derivation algorithm, if present. - - - decrypt the content and return an input stream. - - - - PKCS5 scheme-2 - password converted to bytes assuming ASCII. - - - - PKCS5 scheme-2 - password converted to bytes using UTF-8. - - - - Generate a RecipientInfo object for the given key. - - - A - - - A - - - A - - - - - * return the object identifier for the key encryption algorithm. - * - * @return OID for key encryption algorithm. - - - * return the ASN.1 encoded key encryption algorithm parameters, or null if - * there aren't any. - * - * @return ASN.1 encoding of key encryption algorithm parameters. - - - Return the MAC calculated for the content stream. Note: this call is only meaningful once all - the content has been read. - - @return byte array containing the mac. - - - Return the first RecipientInformation object that matches the - passed in selector. Null if there are no matches. - - @param selector to identify a recipient - @return a single RecipientInformation object. Null if none matches. - - - Return the number of recipients in the collection. - - @return number of recipients identified. - - - Return all recipients in the collection - - @return a collection of recipients. - - - Return possible empty collection with recipients matching the passed in RecipientID - - @param selector a recipient id to select against. - @return a collection of RecipientInformation objects. - - - a basic index for a signer. - - - If the passed in flag is true, the signer signature will be based on the data, not - a collection of signed attributes, and no signed attributes will be included. - - @return the builder object - - - Provide a custom signed attribute generator. - - @param signedGen a generator of signed attributes. - @return the builder object - - - Provide a generator of unsigned attributes. - - @param unsignedGen a generator for signed attributes. - @return the builder object - - - Build a generator with the passed in X.509 certificate issuer and serial number as the signerIdentifier. - - @param contentSigner operator for generating the final signature in the SignerInfo with. - @param certificate X.509 certificate related to the contentSigner. - @return a SignerInfoGenerator - @throws OperatorCreationException if the generator cannot be built. - - - Build a generator with the passed in subjectKeyIdentifier as the signerIdentifier. If used you should - try to follow the calculation described in RFC 5280 section 4.2.1.2. - - @param signerFactory operator factory for generating the final signature in the SignerInfo with. - @param subjectKeyIdentifier key identifier to identify the public key for verifying the signature. - @return a SignerInfoGenerator - - - an expanded SignerInfo block from a CMS Signed message - - - Protected constructor. In some cases clients have their own idea about how to encode - the signed attributes and calculate the signature. This constructor is to allow developers - to deal with that by extending off the class and overriding e.g. SignedAttributes property. - - @param baseInfo the SignerInformation to base this one on. - - - return the version number for this objects underlying SignerInfo structure. - - - return the object identifier for the signature. - - - return the signature parameters, or null if there aren't any. - - - return the content digest that was calculated during verification. - - - return the object identifier for the signature. - - - return the signature/encryption algorithm parameters, or null if - there aren't any. - - - return a table of the signed attributes - indexed by - the OID of the attribute. - - - return a table of the unsigned attributes indexed by - the OID of the attribute. - - - return the encoded signature - - - Return a SignerInformationStore containing the counter signatures attached to this - signer. If no counter signatures are present an empty store is returned. - - - return the DER encoding of the signed attributes. - @throws IOException if an encoding error occurs. - - - verify that the given public key successfully handles and confirms the - signature associated with this signer. - - - verify that the given certificate successfully handles and confirms - the signature associated with this signer and, if a signingTime - attribute is available, that the certificate was valid at the time the - signature was generated. - - - Return the base ASN.1 CMS structure that this object contains. - - @return an object containing a CMS SignerInfo structure. - - - Return a signer information object with the passed in unsigned - attributes replacing the ones that are current associated with - the object passed in. - - @param signerInformation the signerInfo to be used as the basis. - @param unsignedAttributes the unsigned attributes to add. - @return a copy of the original SignerInformationObject with the changed attributes. - - - Return a signer information object with passed in SignerInformationStore representing counter - signatures attached as an unsigned attribute. - - @param signerInformation the signerInfo to be used as the basis. - @param counterSigners signer info objects carrying counter signature. - @return a copy of the original SignerInformationObject with the changed attributes. - - - Create a store containing a single SignerInformation object. - - @param signerInfo the signer information to contain. - - - Create a store containing a collection of SignerInformation objects. - - @param signerInfos a collection signer information objects to contain. - - - Return the first SignerInformation object that matches the - passed in selector. Null if there are no matches. - - @param selector to identify a signer - @return a single SignerInformation object. Null if none matches. - - - The number of signers in the collection. - - - An ICollection of all signers in the collection - - - Return possible empty collection with signers matching the passed in SignerID - - @param selector a signer id to select against. - @return a collection of SignerInformation objects. - - - Basic generator that just returns a preconstructed attribute table - - - - Carrier for an authenticator control. - - - - - Basic constructor - build from a UTF-8 string representing the token. - - UTF-8 string representing the token. - - - - Basic constructor - build from a string representing the token. - - string representing the token. - - - - Return the type of this control. - - - - - Return the token associated with this control (a UTF8String). - - - - - Create a CertificateRequestMessage from the passed in bytes. - - BER/DER encoding of the CertReqMsg structure. - - - - Return the underlying ASN.1 object defining this CertificateRequestMessage object. - - A CertReqMsg - - - - Return the certificate template contained in this message. - - a CertTemplate structure. - - - - Return whether or not this request has control values associated with it. - - true if there are control values present, false otherwise. - - - - Return whether or not this request has a specific type of control value. - - the type OID for the control value we are checking for. - true if a control value of type is present, false otherwise. - - - - Return a control value of the specified type. - - the type OID for the control value we are checking for. - the control value if present, null otherwise. - - - - Return whether or not this request message has a proof-of-possession field in it. - - true if proof-of-possession is present, false otherwise. - - - - Return the type of the proof-of-possession this request message provides. - - one of: popRaVerified, popSigningKey, popKeyEncipherment, popKeyAgreement - - - - Return whether or not the proof-of-possession (POP) is of the type popSigningKey and - it has a public key MAC associated with it. - - true if POP is popSigningKey and a PKMAC is present, false otherwise. - - - - Return whether or not a signing key proof-of-possession (POP) is valid. - - a provider that can produce content verifiers for the signature contained in this POP. - true if the POP is valid, false otherwise. - if there is a problem in verification or content verifier creation. - if POP not appropriate. - - - - Return the ASN.1 encoding of the certReqMsg we wrap. - - a byte array containing the binary encoding of the certReqMsg. - - - - Create a builder that makes EncryptedValue structures. - - wrapper a wrapper for key used to encrypt the actual data contained in the EncryptedValue. - encryptor an output encryptor to encrypt the actual data contained in the EncryptedValue. - - - - - Create a builder that makes EncryptedValue structures with fixed length blocks padded using the passed in padder. - - a wrapper for key used to encrypt the actual data contained in the EncryptedValue. - encryptor an output encryptor to encrypt the actual data contained in the EncryptedValue. - padder a padder to ensure that the EncryptedValue created will always be a constant length. - - - - - Build an EncryptedValue structure containing the passed in pass phrase. - - a revocation pass phrase. - an EncryptedValue containing the encrypted pass phrase. - - - - - Build an EncryptedValue structure containing the certificate contained in - the passed in holder. - - a holder containing a certificate. - an EncryptedValue containing the encrypted certificate. - on a failure to encrypt the data, or wrap the symmetric key for this value. - - - - - Build an EncryptedValue structure containing the private key contained in - the passed info structure. - - a PKCS#8 private key info structure. - an EncryptedValue containing an EncryptedPrivateKeyInfo structure. - on a failure to encrypt the data, or wrap the symmetric key for this value. - - - - - Generic interface for a CertificateRequestMessage control value. - - - - - Return the type of this control. - - - - - Return the value contained in this control object. - - - - - An encrypted value padder is used to make sure that prior to a value been - encrypted the data is padded to a standard length. - - - - - Return a byte array of padded data. - - the data to be padded. - a padded byte array containing data. - - - - - Return a byte array of with padding removed. - - the data to be padded. - an array containing the original unpadded data. - - - - - Basic constructor - build from an PKIArchiveOptions structure. - - the ASN.1 structure that will underlie this control. - - - - Return the type of this control. - - CRMFObjectIdentifiers.id_regCtrl_pkiArchiveOptions - - - - Return the underlying ASN.1 object. - - a PKIArchiveOptions structure. - - - - Return the archive control type, one of: encryptedPrivKey,keyGenParameters,or archiveRemGenPrivKey. - - the archive control type. - - - - Return whether this control contains enveloped data. - - true if the control contains enveloped data, false otherwise. - - - - Return the enveloped data structure contained in this control. - - a CMSEnvelopedData object. - - - - Basic constructor - specify the contents of the PKIArchiveControl structure. - - the private key to be archived. - the general name to be associated with the private key. - - - - Add a recipient generator to this control. - recipient generator created for a specific recipient. - this builder object. - - - Build the PKIArchiveControl using the passed in encryptor to encrypt its contents. - a suitable content encryptor. - a PKIArchiveControl object. - - - - Default, IterationCount = 1000, OIW=IdSha1, Mac=HmacSHA1 - - - - - Defaults with IPKMacPrimitivesProvider - - - - - - Create. - - The Mac provider - Digest Algorithm Id - Mac Algorithm Id - - - - Create a PKMAC builder enforcing a ceiling on the maximum iteration count. - - supporting calculator - max allowable value for iteration count. - - - Set the salt length in octets. - - @param saltLength length in octets of the salt to be generated. - @return the generator - - - - Set the iteration count. - - the iteration count. - this - if iteration count is less than 100 - - - - Set PbmParameters - - The parameters. - this - - - - The Secure random - - The random. - this - - - - Build an IMacFactory. - - The password. - IMacFactory - - - - Basic constructor - build from a UTF-8 string representing the token. - - UTF-8 string representing the token. - - - - Basic constructor - build from a string representing the token. - - string representing the token. - - - - Return the type of this control. - - CRMFObjectIdentifiers.id_regCtrl_regToken - - - - Return the token associated with this control (a UTF8String). - - a UTF8String. - - - a Diffie-Hellman key exchange engine. -

- note: This uses MTI/A0 key agreement in order to make the key agreement - secure against passive attacks. If you're doing Diffie-Hellman and both - parties have long term public keys you should look at using this. For - further information have a look at RFC 2631.

-

- It's possible to extend this to more than two parties as well, for the moment - that is left as an exercise for the reader.

-
- - calculate our initial message. - - - given a message from a given party and the corresponding public key - calculate the next message in the agreement sequence. In this case - this will represent the shared secret. - - - a Diffie-Hellman key agreement class. -

- note: This is only the basic algorithm, it doesn't take advantage of - long term public keys if they are available. See the DHAgreement class - for a "better" implementation.

-
- - given a short term public key from a given party calculate the next - message in the agreement sequence. - - - Standard Diffie-Hellman groups from various IETF specifications. - - - P1363 7.2.1 ECSVDP-DH - - ECSVDP-DH is Elliptic Curve Secret Value Derivation Primitive, - Diffie-Hellman version. It is based on the work of [DH76], [Mil86], - and [Kob87]. This primitive derives a shared secret value from one - party's private key and another party's public key, where both have - the same set of EC domain parameters. If two parties correctly - execute this primitive, they will produce the same output. This - primitive can be invoked by a scheme to derive a shared secret key; - specifically, it may be used with the schemes ECKAS-DH1 and - DL/ECKAS-DH2. It assumes that the input keys are valid (see also - Section 7.2.2). - - - P1363 7.2.2 ECSVDP-DHC - - ECSVDP-DHC is Elliptic Curve Secret Value Derivation Primitive, - Diffie-Hellman version with cofactor multiplication. It is based on - the work of [DH76], [Mil86], [Kob87], [LMQ98] and [Kal98a]. This - primitive derives a shared secret value from one party's private key - and another party's public key, where both have the same set of EC - domain parameters. If two parties correctly execute this primitive, - they will produce the same output. This primitive can be invoked by a - scheme to derive a shared secret key; specifically, it may be used - with the schemes ECKAS-DH1 and DL/ECKAS-DH2. It does not assume the - validity of the input public key (see also Section 7.2.1). -

- Note: As stated P1363 compatibility mode with ECDH can be preset, and - in this case the implementation doesn't have a ECDH compatibility mode - (if you want that just use ECDHBasicAgreement and note they both implement - BasicAgreement!).

-
- - - A participant in a Password Authenticated Key Exchange by Juggling (J-PAKE) exchange. - - The J-PAKE exchange is defined by Feng Hao and Peter Ryan in the paper - - "Password Authenticated Key Exchange by Juggling, 2008." - - The J-PAKE protocol is symmetric. - There is no notion of a client or server, but rather just two participants. - An instance of JPakeParticipant represents one participant, and - is the primary interface for executing the exchange. - - To execute an exchange, construct a JPakeParticipant on each end, - and call the following 7 methods - (once and only once, in the given order, for each participant, sending messages between them as described): - - CreateRound1PayloadToSend() - and send the payload to the other participant - ValidateRound1PayloadReceived(JPakeRound1Payload) - use the payload received from the other participant - CreateRound2PayloadToSend() - and send the payload to the other participant - ValidateRound2PayloadReceived(JPakeRound2Payload) - use the payload received from the other participant - CalculateKeyingMaterial() - CreateRound3PayloadToSend(BigInteger) - and send the payload to the other participant - ValidateRound3PayloadReceived(JPakeRound3Payload, BigInteger) - use the payload received from the other participant - - Each side should derive a session key from the keying material returned by CalculateKeyingMaterial(). - The caller is responsible for deriving the session key using a secure key derivation function (KDF). - - Round 3 is an optional key confirmation process. - If you do not execute round 3, then there is no assurance that both participants are using the same key. - (i.e. if the participants used different passwords, then their session keys will differ.) - - If the round 3 validation succeeds, then the keys are guaranteed to be the same on both sides. - - The symmetric design can easily support the asymmetric cases when one party initiates the communication. - e.g. Sometimes the round1 payload and round2 payload may be sent in one pass. - Also, in some cases, the key confirmation payload can be sent together with the round2 payload. - These are the trivial techniques to optimize the communication. - - The key confirmation process is implemented as specified in - NIST SP 800-56A Revision 1, - Section 8.2 Unilateral Key Confirmation for Key Agreement Schemes. - - This class is stateful and NOT threadsafe. - Each instance should only be used for ONE complete J-PAKE exchange - (i.e. a new JPakeParticipant should be constructed for each new J-PAKE exchange). - - - - - Convenience constructor for a new JPakeParticipant that uses - the JPakePrimeOrderGroups#NIST_3072 prime order group, - a SHA-256 digest, and a default SecureRandom implementation. - - After construction, the State state will be STATE_INITIALIZED. - - Throws NullReferenceException if any argument is null. Throws - ArgumentException if password is empty. - - Unique identifier of this participant. - The two participants in the exchange must NOT share the same id. - Shared secret. - A defensive copy of this array is made (and cleared once CalculateKeyingMaterial() is called). - Caller should clear the input password as soon as possible. - - - - Convenience constructor for a new JPakeParticipant that uses - a SHA-256 digest, and a default SecureRandom implementation. - - After construction, the State state will be STATE_INITIALIZED. - - Throws NullReferenceException if any argument is null. Throws - ArgumentException if password is empty. - - Unique identifier of this participant. - The two participants in the exchange must NOT share the same id. - Shared secret. - A defensive copy of this array is made (and cleared once CalculateKeyingMaterial() is called). - Caller should clear the input password as soon as possible. - Prime order group. See JPakePrimeOrderGroups for standard groups. - - - - Constructor for a new JPakeParticipant. - - After construction, the State state will be STATE_INITIALIZED. - - Throws NullReferenceException if any argument is null. Throws - ArgumentException if password is empty. - - Unique identifier of this participant. - The two participants in the exchange must NOT share the same id. - Shared secret. - A defensive copy of this array is made (and cleared once CalculateKeyingMaterial() is called). - Caller should clear the input password as soon as possible. - Prime order group. See JPakePrimeOrderGroups for standard groups. - Digest to use during zero knowledge proofs and key confirmation - (SHA-256 or stronger preferred). - Source of secure random data for x1 and x2, and for the zero knowledge proofs. - - - - Gets the current state of this participant. - See the STATE_* constants for possible values. - - - - - Creates and returns the payload to send to the other participant during round 1. - - After execution, the State state} will be STATE_ROUND_1_CREATED}. - - - - - Validates the payload received from the other participant during round 1. - - Must be called prior to CreateRound2PayloadToSend(). - - After execution, the State state will be STATE_ROUND_1_VALIDATED. - - Throws CryptoException if validation fails. Throws InvalidOperationException - if called multiple times. - - - - - Creates and returns the payload to send to the other participant during round 2. - - ValidateRound1PayloadReceived(JPakeRound1Payload) must be called prior to this method. - - After execution, the State state will be STATE_ROUND_2_CREATED. - - Throws InvalidOperationException if called prior to ValidateRound1PayloadReceived(JPakeRound1Payload), or multiple times - - - - - Validates the payload received from the other participant during round 2. - Note that this DOES NOT detect a non-common password. - The only indication of a non-common password is through derivation - of different keys (which can be detected explicitly by executing round 3 and round 4) - - Must be called prior to CalculateKeyingMaterial(). - - After execution, the State state will be STATE_ROUND_2_VALIDATED. - - Throws CryptoException if validation fails. Throws - InvalidOperationException if called prior to ValidateRound1PayloadReceived(JPakeRound1Payload), or multiple times - - - - - Calculates and returns the key material. - A session key must be derived from this key material using a secure key derivation function (KDF). - The KDF used to derive the key is handled externally (i.e. not by JPakeParticipant). - - The keying material will be identical for each participant if and only if - each participant's password is the same. i.e. If the participants do not - share the same password, then each participant will derive a different key. - Therefore, if you immediately start using a key derived from - the keying material, then you must handle detection of incorrect keys. - If you want to handle this detection explicitly, you can optionally perform - rounds 3 and 4. See JPakeParticipant for details on how to execute - rounds 3 and 4. - - The keying material will be in the range [0, p-1]. - - ValidateRound2PayloadReceived(JPakeRound2Payload) must be called prior to this method. - - As a side effect, the internal password array is cleared, since it is no longer needed. - - After execution, the State state will be STATE_KEY_CALCULATED. - - Throws InvalidOperationException if called prior to ValidateRound2PayloadReceived(JPakeRound2Payload), - or if called multiple times. - - - - - Creates and returns the payload to send to the other participant during round 3. - - See JPakeParticipant for more details on round 3. - - After execution, the State state} will be STATE_ROUND_3_CREATED. - Throws InvalidOperationException if called prior to CalculateKeyingMaterial, or multiple - times. - - The keying material as returned from CalculateKeyingMaterial(). - - - - Validates the payload received from the other participant during round 3. - - See JPakeParticipant for more details on round 3. - - After execution, the State state will be STATE_ROUND_3_VALIDATED. - - Throws CryptoException if validation fails. Throws InvalidOperationException if called prior to - CalculateKeyingMaterial or multiple times - - The round 3 payload received from the other participant. - The keying material as returned from CalculateKeyingMaterial(). - - - - A pre-computed prime order group for use during a J-PAKE exchange. - - Typically a Schnorr group is used. In general, J-PAKE can use any prime order group - that is suitable for public key cryptography, including elliptic curve cryptography. - - See JPakePrimeOrderGroups for convenient standard groups. - - NIST publishes - many groups that can be used for the desired level of security. - - - - - Constructs a new JPakePrimeOrderGroup. - - In general, you should use one of the pre-approved groups from - JPakePrimeOrderGroups, rather than manually constructing one. - - The following basic checks are performed: - - p-1 must be evenly divisible by q - g must be in [2, p-1] - g^q mod p must equal 1 - p must be prime (within reasonably certainty) - q must be prime (within reasonably certainty) - - The prime checks are performed using BigInteger#isProbablePrime(int), - and are therefore subject to the same probability guarantees. - - These checks prevent trivial mistakes. - However, due to the small uncertainties if p and q are not prime, - advanced attacks are not prevented. - Use it at your own risk. - - Throws NullReferenceException if any argument is null. Throws - InvalidOperationException is any of the above validations fail. - - - - - Constructor used by the pre-approved groups in JPakePrimeOrderGroups. - These pre-approved groups can avoid the expensive checks. - User-specified groups should not use this constructor. - - - - - Standard pre-computed prime order groups for use by J-PAKE. - (J-PAKE can use pre-computed prime order groups, same as DSA and Diffie-Hellman.) -

- This class contains some convenient constants for use as input for - constructing {@link JPAKEParticipant}s. -

- The prime order groups below are taken from Sun's JDK JavaDoc (docs/guide/security/CryptoSpec.html#AppB), - and from the prime order groups - published by NIST. -

-
- - - From Sun's JDK JavaDoc (docs/guide/security/CryptoSpec.html#AppB) - 1024-bit p, 160-bit q and 1024-bit g for 80-bit security. - - - - - From NIST. - 2048-bit p, 224-bit q and 2048-bit g for 112-bit security. - - - - - From NIST. - 3072-bit p, 256-bit q and 3072-bit g for 128-bit security. - - - - - The payload sent/received during the first round of a J-PAKE exchange. - - Each JPAKEParticipant creates and sends an instance of this payload to - the other. The payload to send should be created via - JPAKEParticipant.CreateRound1PayloadToSend(). - - Each participant must also validate the payload received from the other. - The received payload should be validated via - JPAKEParticipant.ValidateRound1PayloadReceived(JPakeRound1Payload). - - - - - The id of the JPAKEParticipant who created/sent this payload. - - - - - The value of g^x1 - - - - - The value of g^x2 - - - - - The zero knowledge proof for x1. - - This is a two element array, containing {g^v, r} for x1. - - - - - The zero knowledge proof for x2. - - This is a two element array, containing {g^v, r} for x2. - - - - - The payload sent/received during the second round of a J-PAKE exchange. - - Each JPAKEParticipant creates and sends an instance - of this payload to the other JPAKEParticipant. - The payload to send should be created via - JPAKEParticipant#createRound2PayloadToSend() - - Each JPAKEParticipant must also validate the payload - received from the other JPAKEParticipant. - The received payload should be validated via - JPAKEParticipant#validateRound2PayloadReceived(JPakeRound2Payload) - - - - - The id of the JPAKEParticipant who created/sent this payload. - - - - - The value of A, as computed during round 2. - - - - - The zero knowledge proof for x2 * s. - - This is a two element array, containing {g^v, r} for x2 * s. - - - - - The payload sent/received during the optional third round of a J-PAKE exchange, - which is for explicit key confirmation. - - Each JPAKEParticipant creates and sends an instance - of this payload to the other JPAKEParticipant. - The payload to send should be created via - JPAKEParticipant#createRound3PayloadToSend(BigInteger) - - Eeach JPAKEParticipant must also validate the payload - received from the other JPAKEParticipant. - The received payload should be validated via - JPAKEParticipant#validateRound3PayloadReceived(JPakeRound3Payload, BigInteger) - - - - - The id of the {@link JPAKEParticipant} who created/sent this payload. - - - - - The value of MacTag, as computed by round 3. - - See JPAKEUtil#calculateMacTag(string, string, BigInteger, BigInteger, BigInteger, BigInteger, BigInteger, org.bouncycastle.crypto.Digest) - - - - - Primitives needed for a J-PAKE exchange. - - The recommended way to perform a J-PAKE exchange is by using - two JPAKEParticipants. Internally, those participants - call these primitive operations in JPakeUtilities. - - The primitives, however, can be used without a JPAKEParticipant if needed. - - - - - Return a value that can be used as x1 or x3 during round 1. - The returned value is a random value in the range [0, q-1]. - - - - - Return a value that can be used as x2 or x4 during round 1. - The returned value is a random value in the range [1, q-1]. - - - - - Converts the given password to a BigInteger - for use in arithmetic calculations. - - - - - Calculate g^x mod p as done in round 1. - - - - - Calculate ga as done in round 2. - - - - - Calculate x2 * s as done in round 2. - - - - - Calculate A as done in round 2. - - - - - Calculate a zero knowledge proof of x using Schnorr's signature. - The returned array has two elements {g^v, r = v-x*h} for x. - - - - - Validates that g^x4 is not 1. - throws CryptoException if g^x4 is 1 - - - - - Validates that ga is not 1. - - As described by Feng Hao... - Alice could simply check ga != 1 to ensure it is a generator. - In fact, as we will explain in Section 3, (x1 + x3 + x4 ) is random over Zq even in the face of active attacks. - Hence, the probability for ga = 1 is extremely small - on the order of 2^160 for 160-bit q. - - throws CryptoException if ga is 1 - - - - - Validates the zero knowledge proof (generated by - calculateZeroKnowledgeProof(BigInteger, BigInteger, BigInteger, BigInteger, BigInteger, string, Digest, SecureRandom) - is correct. - - throws CryptoException if the zero knowledge proof is not correct - - - - - Calculates the keying material, which can be done after round 2 has completed. - A session key must be derived from this key material using a secure key derivation function (KDF). - The KDF used to derive the key is handled externally (i.e. not by JPAKEParticipant). - - KeyingMaterial = (B/g^{x2*x4*s})^x2 - - - - - Validates that the given participant ids are not equal. - (For the J-PAKE exchange, each participant must use a unique id.) - - Throws CryptoException if the participantId strings are equal. - - - - - Validates that the given participant ids are equal. - This is used to ensure that the payloads received from - each round all come from the same participant. - - - - - Validates that the given object is not null. - throws NullReferenceException if the object is null. - - object in question - name of the object (to be used in exception message) - - - - Calculates the MacTag (to be used for key confirmation), as defined by - NIST SP 800-56A Revision 1, - Section 8.2 Unilateral Key Confirmation for Key Agreement Schemes. - - MacTag = HMAC(MacKey, MacLen, MacData) - MacKey = H(K || "JPAKE_KC") - MacData = "KC_1_U" || participantId || partnerParticipantId || gx1 || gx2 || gx3 || gx4 - - Note that both participants use "KC_1_U" because the sender of the round 3 message - is always the initiator for key confirmation. - - HMAC = {@link HMac} used with the given {@link Digest} - H = The given {@link Digest} - MacLen = length of MacTag - - - - - Calculates the MacKey (i.e. the key to use when calculating the MagTag for key confirmation). - - MacKey = H(K || "JPAKE_KC") - - - - - Validates the MacTag received from the partner participant. - - throws CryptoException if the participantId strings are equal. - - - - Generator for Concatenation Key Derivation Function defined in NIST SP 800-56A, Sect 5.8.1 - - - @param digest the digest to be used as the source of generated bytes - - - return the underlying digest. - - - fill len bytes of the output buffer with bytes generated from - the derivation function. - - @throws DataLengthException if the out buffer is too small. - - - RFC 2631 Diffie-hellman KEK derivation function. - - - X9.63 based key derivation function for ECDH CMS. - - - - SM2 Key Exchange protocol - based on https://tools.ietf.org/html/draft-shen-sm2-ecdsa-02 - - - - Implements the client side SRP-6a protocol. Note that this class is stateful, and therefore NOT threadsafe. - This implementation of SRP is based on the optimized message sequence put forth by Thomas Wu in the paper - "SRP-6: Improvements and Refinements to the Secure Remote Password Protocol, 2002" - - - Initialises the client to begin new authentication attempt - @param N The safe prime associated with the client's verifier - @param g The group parameter associated with the client's verifier - @param digest The digest algorithm associated with the client's verifier - @param random For key generation - - - Generates client's credentials given the client's salt, identity and password - @param salt The salt used in the client's verifier. - @param identity The user's identity (eg. username) - @param password The user's password - @return Client's public value to send to server - - - Generates client's verification message given the server's credentials - @param serverB The server's credentials - @return Client's verification message for the server - @throws CryptoException If server's credentials are invalid - - - Computes the client evidence message M1 using the previously received values. - To be called after calculating the secret S. - @return M1: the client side generated evidence message - @throws CryptoException - - - Authenticates the server evidence message M2 received and saves it only if correct. - @param M2: the server side generated evidence message - @return A boolean indicating if the server message M2 was the expected one. - @throws CryptoException - - - Computes the final session key as a result of the SRP successful mutual authentication - To be called after verifying the server evidence message M2. - @return Key: the mutually authenticated symmetric session key - @throws CryptoException - - - Implements the server side SRP-6a protocol. Note that this class is stateful, and therefore NOT threadsafe. - This implementation of SRP is based on the optimized message sequence put forth by Thomas Wu in the paper - "SRP-6: Improvements and Refinements to the Secure Remote Password Protocol, 2002" - - - Initialises the server to accept a new client authentication attempt - @param N The safe prime associated with the client's verifier - @param g The group parameter associated with the client's verifier - @param v The client's verifier - @param digest The digest algorithm associated with the client's verifier - @param random For key generation - - - Generates the server's credentials that are to be sent to the client. - @return The server's public value to the client - - - Processes the client's credentials. If valid the shared secret is generated and returned. - @param clientA The client's credentials - @return A shared secret BigInteger - @throws CryptoException If client's credentials are invalid - - - Authenticates the received client evidence message M1 and saves it only if correct. - To be called after calculating the secret S. - @param M1: the client side generated evidence message - @return A boolean indicating if the client message M1 was the expected one. - @throws CryptoException - - - Computes the server evidence message M2 using the previously verified values. - To be called after successfully verifying the client evidence message M1. - @return M2: the server side generated evidence message - @throws CryptoException - - - Computes the final session key as a result of the SRP successful mutual authentication - To be called after calculating the server evidence message M2. - @return Key: the mutual authenticated symmetric session key - @throws CryptoException - - - Computes the client evidence message (M1) according to the standard routine: - M1 = H( A | B | S ) - @param digest The Digest used as the hashing function H - @param N Modulus used to get the pad length - @param A The public client value - @param B The public server value - @param S The secret calculated by both sides - @return M1 The calculated client evidence message - - - Computes the server evidence message (M2) according to the standard routine: - M2 = H( A | M1 | S ) - @param digest The Digest used as the hashing function H - @param N Modulus used to get the pad length - @param A The public client value - @param M1 The client evidence message - @param S The secret calculated by both sides - @return M2 The calculated server evidence message - - - Computes the final Key according to the standard routine: Key = H(S) - @param digest The Digest used as the hashing function H - @param N Modulus used to get the pad length - @param S The secret calculated by both sides - @return - - - Generates new SRP verifier for user - - - Initialises generator to create new verifiers - @param N The safe prime to use (see DHParametersGenerator) - @param g The group parameter to use (see DHParametersGenerator) - @param digest The digest to use. The same digest type will need to be used later for the actual authentication - attempt. Also note that the final session key size is dependent on the chosen digest. - - - Creates a new SRP verifier - @param salt The salt to use, generally should be large and random - @param identity The user's identifying information (eg. username) - @param password The user's password - @return A new verifier for use in future SRP authentication - - - a holding class for public/private parameter pairs. - - - basic constructor. - - @param publicParam a public key parameters object. - @param privateParam the corresponding private key parameters. - - - return the public key parameters. - - @return the public key parameters. - - - return the private key parameters. - - @return the private key parameters. - - - The AEAD block ciphers already handle buffering internally, so this class - just takes care of implementing IBufferedCipher methods. - - - initialise the cipher. - - @param forEncryption if true the cipher is initialised for - encryption, if false for decryption. - @param param the key and other data required by the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - return the blocksize for the underlying cipher. - - @return the blocksize for the underlying cipher. - - - return the size of the output buffer required for an update - an input of len bytes. - - @param len the length of the input. - @return the space required to accommodate a call to update - with len bytes of input. - - - return the size of the output buffer required for an update plus a - doFinal with an input of len bytes. - - @param len the length of the input. - @return the space required to accommodate a call to update and doFinal - with len bytes of input. - - - process a single byte, producing an output block if necessary. - - @param in the input byte. - @param out the space for any output that might be produced. - @param outOff the offset from which the output will be copied. - @return the number of output bytes copied to out. - @exception DataLengthException if there isn't enough space in out. - @exception InvalidOperationException if the cipher isn't initialised. - - - process an array of bytes, producing output if necessary. - - @param in the input byte array. - @param inOff the offset at which the input data starts. - @param len the number of bytes to be copied out of the input array. - @param out the space for any output that might be produced. - @param outOff the offset from which the output will be copied. - @return the number of output bytes copied to out. - @exception DataLengthException if there isn't enough space in out. - @exception InvalidOperationException if the cipher isn't initialised. - - - Process the last block in the buffer. - - @param out the array the block currently being held is copied into. - @param outOff the offset at which the copying starts. - @return the number of output bytes copied to out. - @exception DataLengthException if there is insufficient space in out for - the output, or the input is not block size aligned and should be. - @exception InvalidOperationException if the underlying cipher is not - initialised. - @exception InvalidCipherTextException if padding is expected and not found. - @exception DataLengthException if the input is not block size - aligned. - - - Reset the buffer and cipher. After resetting the object is in the same - state as it was after the last init (if there was one). - - - The AEAD ciphers already handle buffering internally, so this class - just takes care of implementing IBufferedCipher methods. - - - initialise the cipher. - - @param forEncryption if true the cipher is initialised for - encryption, if false for decryption. - @param param the key and other data required by the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - return the blocksize for the underlying cipher. - - @return the blocksize for the underlying cipher. - - - return the size of the output buffer required for an update - an input of len bytes. - - @param len the length of the input. - @return the space required to accommodate a call to update - with len bytes of input. - - - return the size of the output buffer required for an update plus a - doFinal with an input of len bytes. - - @param len the length of the input. - @return the space required to accommodate a call to update and doFinal - with len bytes of input. - - - process a single byte, producing an output block if necessary. - - @param in the input byte. - @param out the space for any output that might be produced. - @param outOff the offset from which the output will be copied. - @return the number of output bytes copied to out. - @exception DataLengthException if there isn't enough space in out. - @exception InvalidOperationException if the cipher isn't initialised. - - - process an array of bytes, producing output if necessary. - - @param in the input byte array. - @param inOff the offset at which the input data starts. - @param len the number of bytes to be copied out of the input array. - @param out the space for any output that might be produced. - @param outOff the offset from which the output will be copied. - @return the number of output bytes copied to out. - @exception DataLengthException if there isn't enough space in out. - @exception InvalidOperationException if the cipher isn't initialised. - - - Process the last block in the buffer. - - @param out the array the block currently being held is copied into. - @param outOff the offset at which the copying starts. - @return the number of output bytes copied to out. - @exception DataLengthException if there is insufficient space in out for - the output, or the input is not block size aligned and should be. - @exception InvalidOperationException if the underlying cipher is not - initialised. - @exception InvalidCipherTextException if padding is expected and not found. - @exception DataLengthException if the input is not block size - aligned. - - - Reset the buffer and cipher. After resetting the object is in the same - state as it was after the last init (if there was one). - - - a buffer wrapper for an asymmetric block cipher, allowing input - to be accumulated in a piecemeal fashion until final processing. - - - base constructor. - - @param cipher the cipher this buffering object wraps. - - - return the amount of data sitting in the buffer. - - @return the amount of data sitting in the buffer. - - - initialise the buffer and the underlying cipher. - - @param forEncryption if true the cipher is initialised for - encryption, if false for decryption. - @param param the key and other data required by the cipher. - - - process the contents of the buffer using the underlying - cipher. - - @return the result of the encryption/decryption process on the - buffer. - @exception InvalidCipherTextException if we are given a garbage block. - - - Reset the buffer - - - A wrapper class that allows block ciphers to be used to process data in - a piecemeal fashion. The BufferedBlockCipher outputs a block only when the - buffer is full and more data is being added, or on a doFinal. -

- Note: in the case where the underlying cipher is either a CFB cipher or an - OFB one the last block may not be a multiple of the block size. -

-
- - constructor for subclasses - - - Create a buffered block cipher without padding. - - @param cipher the underlying block cipher this buffering object wraps. - false otherwise. - - - initialise the cipher. - - @param forEncryption if true the cipher is initialised for - encryption, if false for decryption. - @param param the key and other data required by the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - return the blocksize for the underlying cipher. - - @return the blocksize for the underlying cipher. - - - return the size of the output buffer required for an update - an input of len bytes. - - @param len the length of the input. - @return the space required to accommodate a call to update - with len bytes of input. - - - return the size of the output buffer required for an update plus a - doFinal with an input of len bytes. - - @param len the length of the input. - @return the space required to accommodate a call to update and doFinal - with len bytes of input. - - - process a single byte, producing an output block if necessary. - - @param in the input byte. - @param out the space for any output that might be produced. - @param outOff the offset from which the output will be copied. - @return the number of output bytes copied to out. - @exception DataLengthException if there isn't enough space in out. - @exception InvalidOperationException if the cipher isn't initialised. - - - process an array of bytes, producing output if necessary. - - @param in the input byte array. - @param inOff the offset at which the input data starts. - @param len the number of bytes to be copied out of the input array. - @param out the space for any output that might be produced. - @param outOff the offset from which the output will be copied. - @return the number of output bytes copied to out. - @exception DataLengthException if there isn't enough space in out. - @exception InvalidOperationException if the cipher isn't initialised. - - - Process the last block in the buffer. - - @param out the array the block currently being held is copied into. - @param outOff the offset at which the copying starts. - @return the number of output bytes copied to out. - @exception DataLengthException if there is insufficient space in out for - the output, or the input is not block size aligned and should be. - @exception InvalidOperationException if the underlying cipher is not - initialised. - @exception InvalidCipherTextException if padding is expected and not found. - @exception DataLengthException if the input is not block size - aligned. - - - Reset the buffer and cipher. After resetting the object is in the same - state as it was after the last init (if there was one). - - - The base class for symmetric, or secret, cipher key generators. - - - initialise the key generator. - - @param param the parameters to be used for key generation - - - Generate a secret key. - - @return a byte array containing the key value. - - - this exception is thrown if a buffer that is meant to have output - copied into it turns out to be too short, or if we've been given - insufficient input. In general this exception will Get thrown rather - than an ArrayOutOfBounds exception. - - - base constructor. - - - create a DataLengthException with the given message. - - @param message the message to be carried with the exception. - - - - Basic sized constructor - size in bits. - - @param digestSize size of the digest in bits - - - Blake2b for authentication ("Prefix-MAC mode"). - After calling the doFinal() method, the key will - remain to be used for further computations of - this instance. - The key can be overwritten using the clearKey() method. - - @param key A key up to 64 bytes or null - - - Blake2b with key, required digest length (in bytes), salt and personalization. - After calling the doFinal() method, the key, the salt and the personal string - will remain and might be used for further computations with this instance. - The key can be overwritten using the clearKey() method, the salt (pepper) - can be overwritten using the clearSalt() method. - - @param key A key up to 64 bytes or null - @param digestLength from 1 up to 64 bytes - @param salt 16 bytes or null - @param personalization 16 bytes or null - - - update the message digest with a single byte. - - @param b the input byte to be entered. - - - update the message digest with a block of bytes. - - @param message the byte array containing the data. - @param offset the offset into the byte array where the data starts. - @param len the length of the data. - - - close the digest, producing the final digest value. The doFinal - call leaves the digest reset. - Key, salt and personal string remain. - - @param out the array the digest is to be copied into. - @param outOffset the offset into the out array the digest is to start at. - - - Reset the digest back to it's initial state. - The key, the salt and the personal string will - remain for further computations. - - - return the algorithm name - - @return the algorithm name - - - return the size, in bytes, of the digest produced by this message digest. - - @return the size, in bytes, of the digest produced by this message digest. - - - Return the size in bytes of the internal buffer the digest applies it's compression - function to. - - @return byte length of the digests internal buffer. - - - Overwrite the key - if it is no longer used (zeroization) - - - Overwrite the salt (pepper) if it - is secret and no longer used (zeroization) - - - Implementation of the cryptographic hash function BLAKE2s. -

- BLAKE2s offers a built-in keying mechanism to be used directly - for authentication ("Prefix-MAC") rather than a HMAC construction. -

- BLAKE2s offers a built-in support for a salt for randomized hashing - and a personal string for defining a unique hash function for each application. -

- BLAKE2s is optimized for 32-bit platforms and produces digests of any size - between 1 and 32 bytes. - - - BLAKE2s Initialization Vector - - - - Message word permutations - - - - Whenever this buffer overflows, it will be processed in the Compress() - function. For performance issues, long messages will not use this buffer. - - - Position of last inserted byte - - - - Internal state, in the BLAKE2 paper it is called v - - - - State vector, in the BLAKE2 paper it is called h - - - - holds least significant bits of counter - - - - holds most significant bits of counter - - - - finalization flag, for last block: ~0 - - - - BLAKE2s-256 for hashing. - - - BLAKE2s for hashing. - - @param digestBits the desired digest length in bits. Must be a multiple of 8 and less than 256. - - - BLAKE2s for authentication ("Prefix-MAC mode"). -

- After calling the doFinal() method, the key will remain to be used for - further computations of this instance. The key can be overwritten using - the clearKey() method. - - @param key a key up to 32 bytes or null - - - BLAKE2s with key, required digest length, salt and personalization. -

- After calling the doFinal() method, the key, the salt and the personal - string will remain and might be used for further computations with this - instance. The key can be overwritten using the clearKey() method, the - salt (pepper) can be overwritten using the clearSalt() method. - - @param key a key up to 32 bytes or null - @param digestBytes from 1 up to 32 bytes - @param salt 8 bytes or null - @param personalization 8 bytes or null - - - Update the message digest with a single byte. - - @param b the input byte to be entered. - - - Update the message digest with a block of bytes. - - @param message the byte array containing the data. - @param offset the offset into the byte array where the data starts. - @param len the length of the data. - - - Close the digest, producing the final digest value. The doFinal() call - leaves the digest reset. Key, salt and personal string remain. - - @param out the array the digest is to be copied into. - @param outOffset the offset into the out array the digest is to start at. - - - Reset the digest back to its initial state. The key, the salt and the - personal string will remain for further computations. - - - Return the algorithm name. - - @return the algorithm name - - - Return the size in bytes of the digest produced by this message digest. - - @return the size in bytes of the digest produced by this message digest. - - - Return the size in bytes of the internal buffer the digest applies its - compression function to. - - @return byte length of the digest's internal buffer. - - - Overwrite the key if it is no longer used (zeroization). - - - Overwrite the salt (pepper) if it is secret and no longer used - (zeroization). - - -

- Customizable SHAKE function. - -
- - - Base constructor - - bit length of the underlying SHAKE function, 128 or 256. - the function name string, note this is reserved for use by NIST. Avoid using it if not required. - the customization string - available for local use. - - - implementation of Ukrainian DSTU 7564 hash function - - - base implementation of MD4 family style digest as outlined in - "Handbook of Applied Cryptography", pages 344 - 347. - - - implementation of GOST R 34.11-94 - - - Standard constructor - - - Constructor to allow use of a particular sbox with GOST28147 - @see GOST28147Engine#getSBox(String) - - - Copy constructor. This will copy the state of the provided - message digest. - - - reset the chaining variables to the IV values. - - - - Implementation of Keccak based on following KeccakNISTInterface.c from http://keccak.noekeon.org/ - - - Following the naming conventions used in the C source code to enable easy review of the implementation. - - - - Return the size of block that the compression function is applied to in bytes. - - @return internal byte length of a block. - - - Base class for SHA-384 and SHA-512. - - - Constructor for variable length word - - - Copy constructor. We are using copy constructors in place - of the object.Clone() interface as this interface is not - supported by J2ME. - - - adjust the byte counts so that byteCount2 represents the - upper long (less 3 bits) word of the byte count. - - - implementation of MD2 - as outlined in RFC1319 by B.Kaliski from RSA Laboratories April 1992 - - - return the algorithm name - - @return the algorithm name - - - Close the digest, producing the final digest value. The doFinal - call leaves the digest reset. - - @param out the array the digest is to be copied into. - @param outOff the offset into the out array the digest is to start at. - - - reset the digest back to it's initial state. - - - update the message digest with a single byte. - - @param in the input byte to be entered. - - - update the message digest with a block of bytes. - - @param in the byte array containing the data. - @param inOff the offset into the byte array where the data starts. - @param len the length of the data. - - - implementation of MD4 as RFC 1320 by R. Rivest, MIT Laboratory for - Computer Science and RSA Data Security, Inc. -

- NOTE: This algorithm is only included for backwards compatibility - with legacy applications, it's not secure, don't use it for anything new!

-
- - Standard constructor - - - Copy constructor. This will copy the state of the provided - message digest. - - - reset the chaining variables to the IV values. - - - implementation of MD5 as outlined in "Handbook of Applied Cryptography", pages 346 - 347. - - - Copy constructor. This will copy the state of the provided - message digest. - - - reset the chaining variables to the IV values. - - - Wrapper removes exposure to the IMemoable interface on an IDigest implementation. - - - Base constructor. - - @param baseDigest underlying digest to use. - @exception IllegalArgumentException if baseDigest is null - - - - ParallelHash - a hash designed to support the efficient hashing of very long strings, by taking advantage, - of the parallelism available in modern processors with an optional XOF mode. - - From NIST Special Publication 800-185 - SHA-3 Derived Functions:cSHAKE, KMAC, TupleHash and ParallelHash - - - - - Base constructor. - - @param bitLength bit length of the underlying SHAKE function, 128 or 256. - @param S the customization string - available for local use. - @param B the blocksize (in bytes) for hashing. - - - implementation of RipeMD128 - - - Standard constructor - - - Copy constructor. This will copy the state of the provided - message digest. - - - reset the chaining variables to the IV values. - - - implementation of RipeMD see, - http://www.esat.kuleuven.ac.be/~bosselae/ripemd160.html - - - Standard constructor - - - Copy constructor. This will copy the state of the provided - message digest. - - - reset the chaining variables to the IV values. - - - -

Implementation of RipeMD256.

-

Note: this algorithm offers the same level of security as RipeMD128.

-
-
- - Standard constructor - - - Copy constructor. This will copy the state of the provided - message digest. - - - - reset the chaining variables to the IV values. - - - -

Implementation of RipeMD 320.

-

Note: this algorithm offers the same level of security as RipeMD160.

-
-
- - Standard constructor - - - Copy constructor. This will copy the state of the provided - message digest. - - - - reset the chaining variables to the IV values. - - - implementation of SHA-1 as outlined in "Handbook of Applied Cryptography", pages 346 - 349. - - It is interesting to ponder why the, apart from the extra IV, the other difference here from MD5 - is the "endianness" of the word processing! - - - Copy constructor. This will copy the state of the provided - message digest. - - - reset the chaining variables - - - SHA-224 as described in RFC 3874 -
-                    block  word  digest
-            SHA-1   512    32    160
-            SHA-224 512    32    224
-            SHA-256 512    32    256
-            SHA-384 1024   64    384
-            SHA-512 1024   64    512
-            
-
- - Standard constructor - - - Copy constructor. This will copy the state of the provided - message digest. - - - reset the chaining variables - - - Draft FIPS 180-2 implementation of SHA-256. Note: As this is - based on a draft this implementation is subject to change. - -
-                     block  word  digest
-             SHA-1   512    32    160
-             SHA-256 512    32    256
-             SHA-384 1024   64    384
-             SHA-512 1024   64    512
-             
-
- - Copy constructor. This will copy the state of the provided - message digest. - - - reset the chaining variables - - - Draft FIPS 180-2 implementation of SHA-384. Note: As this is - based on a draft this implementation is subject to change. - -
-                     block  word  digest
-             SHA-1   512    32    160
-             SHA-256 512    32    256
-             SHA-384 1024   64    384
-             SHA-512 1024   64    512
-             
-
- - Copy constructor. This will copy the state of the provided - message digest. - - - reset the chaining variables - - - - Implementation of SHA-3 based on following KeccakNISTInterface.c from http://keccak.noekeon.org/ - - - Following the naming conventions used in the C source code to enable easy review of the implementation. - - - - Draft FIPS 180-2 implementation of SHA-512. Note: As this is - based on a draft this implementation is subject to change. - -
-                     block  word  digest
-             SHA-1   512    32    160
-             SHA-256 512    32    256
-             SHA-384 1024   64    384
-             SHA-512 1024   64    512
-             
-
- - Copy constructor. This will copy the state of the provided - message digest. - - - reset the chaining variables - - - FIPS 180-4 implementation of SHA-512/t - - - Standard constructor - - - Copy constructor. This will copy the state of the provided - message digest. - - - reset the chaining variables - - - - Implementation of SHAKE based on following KeccakNISTInterface.c from http://keccak.noekeon.org/ - - - Following the naming conventions used in the C source code to enable easy review of the implementation. - - - - Wrapper class that reduces the output length of a particular digest to - only the first n bytes of the digest function. - - - Base constructor. - - @param baseDigest underlying digest to use. - @param length length in bytes of the output of doFinal. - @exception ArgumentException if baseDigest is null, or length is greater than baseDigest.GetDigestSize(). - - - - Implementation of the Skein parameterised hash function in 256, 512 and 1024 bit block sizes, - based on the Threefish tweakable block cipher. - - - This is the 1.3 version of Skein defined in the Skein hash function submission to the NIST SHA-3 - competition in October 2010. -

- Skein was designed by Niels Ferguson - Stefan Lucks - Bruce Schneier - Doug Whiting - Mihir - Bellare - Tadayoshi Kohno - Jon Callas - Jesse Walker. - - - - - -

- 256 bit block size - Skein-256 - -
- - - 512 bit block size - Skein-512 - - - - - 1024 bit block size - Skein-1024 - - - - - Constructs a Skein digest with an internal state size and output size. - - the internal state size in bits - one of or - . - the output/digest size to produce in bits, which must be an integral number of - bytes. - - - - Optionally initialises the Skein digest with the provided parameters. - - See for details on the parameterisation of the Skein hash function. - the parameters to apply to this engine, or null to use no parameters. - - - - Implementation of the Skein family of parameterised hash functions in 256, 512 and 1024 bit block - sizes, based on the Threefish tweakable block cipher. - - - This is the 1.3 version of Skein defined in the Skein hash function submission to the NIST SHA-3 - competition in October 2010. -

- Skein was designed by Niels Ferguson - Stefan Lucks - Bruce Schneier - Doug Whiting - Mihir - Bellare - Tadayoshi Kohno - Jon Callas - Jesse Walker. -

- This implementation is the basis for and , implementing the - parameter based configuration system that allows Skein to be adapted to multiple applications.
- Initialising the engine with allows standard and arbitrary parameters to - be applied during the Skein hash function. -

- Implemented: -

    -
  • 256, 512 and 1024 bit internal states.
  • -
  • Full 96 bit input length.
  • -
  • Parameters defined in the Skein specification, and arbitrary other pre and post message - parameters.
  • -
  • Arbitrary output size in 1 byte intervals.
  • -
-

- Not implemented: -

    -
  • Sub-byte length input (bit padding).
  • -
  • Tree hashing.
  • -
-
- -
- - - 256 bit block size - Skein-256 - - - - - 512 bit block size - Skein-512 - - - - - 1024 bit block size - Skein-1024 - - - - The parameter type for the Skein key. - - - The parameter type for the Skein configuration block. - - - The parameter type for the message. - - - The parameter type for the output transformation. - - - Precalculated UBI(CFG) states for common state/output combinations without key or other - pre-message params. - - - Point at which position might overflow long, so switch to add with carry logic - - - Bit 127 = final - - - Bit 126 = first - - - UBI uses a 128 bit tweak - - - Whether 64 bit position exceeded - - - Advances the position in the tweak by the specified value. - - - The Unique Block Iteration chaining mode. - - - Buffer for the current block of message data - - - Offset into the current message block - - - Buffer for message words for feedback into encrypted block - - - Underlying Threefish tweakable block cipher - - - Size of the digest output, in bytes - - - The current chaining/state value - - - The initial state value - - - The (optional) key parameter - - - Parameters to apply prior to the message - - - Parameters to apply after the message, but prior to output - - - The current UBI operation - - - Buffer for single byte update method - - - - Constructs a Skein digest with an internal state size and output size. - - the internal state size in bits - one of or - . - the output/digest size to produce in bits, which must be an integral number of - bytes. - - - - Creates a SkeinEngine as an exact copy of an existing instance. - - - - - Initialises the Skein engine with the provided parameters. See for - details on the parameterisation of the Skein hash function. - - the parameters to apply to this engine, or null to use no parameters. - - - Calculate the initial (pre message block) chaining state. - - - - Reset the engine to the initial state (with the key and any pre-message parameters , ready to - accept message input. - - - - - Implementation of Chinese SM3 digest as described at - http://tools.ietf.org/html/draft-shen-sm3-hash-00 - and at .... ( Chinese PDF ) - - - The specification says "process a bit stream", - but this is written to process bytes in blocks of 4, - meaning this will process 32-bit word groups. - But so do also most other digest specifications, - including the SHA-256 which was a origin for - this specification. - - - - - Standard constructor - - - - - Copy constructor. This will copy the state of the provided - message digest. - - - - - reset the chaining variables - - - - implementation of Tiger based on: - - http://www.cs.technion.ac.il/~biham/Reports/Tiger - - - Standard constructor - - - Copy constructor. This will copy the state of the provided - message digest. - - - reset the chaining variables - - - - TupleHash - a hash designed to simply hash a tuple of input strings, any or all of which may be empty strings, - in an unambiguous way with an optional XOF mode. - - From NIST Special Publication 800-185 - SHA-3 Derived Functions:cSHAKE, KMAC, TupleHash and ParallelHash - - - - - Base constructor. - - @param bitLength bit length of the underlying SHAKE function, 128 or 256. - @param S the customization string - available for local use. - - - Implementation of WhirlpoolDigest, based on Java source published by Barreto - and Rijmen. - - - - Copy constructor. This will copy the state of the provided message - digest. - - - Reset the chaining variables - - - return the X9ECParameters object for the named curve represented by - the passed in object identifier. Null if the curve isn't present. - - @param oid an object identifier representing a named curve, if present. - - - return the object identifier signified by the passed in name. Null - if there is no object identifier associated with name. - - @return the object identifier associated with name, if present. - - - return the named curve name represented by the given object identifier. - - - returns an enumeration containing the name strings for curves - contained in this structure. - - - ISO 9796-1 padding. Note in the light of recent results you should - only use this with RSA (rather than the "simpler" Rabin keys) and you - should never use it with anything other than a hash (ie. even if the - message is small don't sign the message, sign it's hash) or some "random" - value. See your favorite search engine for details. - - - return the input block size. The largest message we can process - is (key_size_in_bits + 3)/16, which in our world comes to - key_size_in_bytes / 2. - - - return the maximum possible size for the output. - - - set the number of bits in the next message to be treated as - pad bits. - - - retrieve the number of pad bits in the last decoded message. - - - @exception InvalidCipherTextException if the decrypted block is not a valid ISO 9796 bit string - - - Optimal Asymmetric Encryption Padding (OAEP) - see PKCS 1 V 2. - - - @exception InvalidCipherTextException if the decrypted block turns out to - be badly formatted. - - - mask generator function, as described in PKCS1v2. - - - this does your basic Pkcs 1 v1.5 padding - whether or not you should be using this - depends on your application - see Pkcs1 Version 2 for details. - - - some providers fail to include the leading zero in PKCS1 encoded blocks. If you need to - work with one of these set the system property Org.BouncyCastle.Pkcs1.Strict to false. - - - The same effect can be achieved by setting the static property directly -

- The static property is checked during construction of the encoding object, it is set to - true by default. -

-
- - Basic constructor. - - @param cipher - - - Constructor for decryption with a fixed plaintext length. - - @param cipher The cipher to use for cryptographic operation. - @param pLen Length of the expected plaintext. - - - Constructor for decryption with a fixed plaintext length and a fallback - value that is returned, if the padding is incorrect. - - @param cipher - The cipher to use for cryptographic operation. - @param fallback - The fallback value, we don't to a arraycopy here. - - - Checks if the argument is a correctly PKCS#1.5 encoded Plaintext - for encryption. - - @param encoded The Plaintext. - @param pLen Expected length of the plaintext. - @return Either 0, if the encoding is correct, or -1, if it is incorrect. - - - Decode PKCS#1.5 encoding, and return a random value if the padding is not correct. - - @param in The encrypted block. - @param inOff Offset in the encrypted block. - @param inLen Length of the encrypted block. - @param pLen Length of the desired output. - @return The plaintext without padding, or a random value if the padding was incorrect. - @throws InvalidCipherTextException - - - @exception InvalidCipherTextException if the decrypted block is not in Pkcs1 format. - - - an implementation of the AES (Rijndael), from FIPS-197. -

- For further details see: http://csrc.nist.gov/encryption/aes/. - - This implementation is based on optimizations from Dr. Brian Gladman's paper and C code at - http://fp.gladman.plus.com/cryptography_technology/rijndael/ - - There are three levels of tradeoff of speed vs memory - Because java has no preprocessor, they are written as three separate classes from which to choose - - The fastest uses 8Kbytes of static tables to precompute round calculations, 4 256 word tables for encryption - and 4 for decryption. - - The middle performance version uses only one 256 word table for each, for a total of 2Kbytes, - adding 12 rotate operations per round to compute the values contained in the other tables from - the contents of the first. - - The slowest version uses no static tables at all and computes the values in each round. -

-

- This file contains the middle performance version with 2Kbytes of static tables for round precomputation. -

-
- - Calculate the necessary round keys - The number of calculations depends on key size and block size - AES specified a fixed block size of 128 bits and key sizes 128/192/256 bits - This code is written assuming those are the only possible values - - - default constructor - 128 bit block size. - - - initialise an AES cipher. - - @param forEncryption whether or not we are for encryption. - @param parameters the parameters required to set up the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - an implementation of the AES (Rijndael)), from FIPS-197. -

- For further details see: http://csrc.nist.gov/encryption/aes/. - - This implementation is based on optimizations from Dr. Brian Gladman's paper and C code at - http://fp.gladman.plus.com/cryptography_technology/rijndael/ - - There are three levels of tradeoff of speed vs memory - Because java has no preprocessor), they are written as three separate classes from which to choose - - The fastest uses 8Kbytes of static tables to precompute round calculations), 4 256 word tables for encryption - and 4 for decryption. - - The middle performance version uses only one 256 word table for each), for a total of 2Kbytes), - adding 12 rotate operations per round to compute the values contained in the other tables from - the contents of the first - - The slowest version uses no static tables at all and computes the values in each round -

-

- This file contains the fast version with 8Kbytes of static tables for round precomputation -

- - Unfortunately this class has a few side channel issues. - In an environment where encryption/decryption may be closely observed it should not be used. - -
- - Calculate the necessary round keys - The number of calculations depends on key size and block size - AES specified a fixed block size of 128 bits and key sizes 128/192/256 bits - This code is written assuming those are the only possible values - - - default constructor - 128 bit block size. - - - initialise an AES cipher. - - @param forEncryption whether or not we are for encryption. - @param parameters the parameters required to set up the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - an implementation of the AES (Rijndael), from FIPS-197. -

- For further details see: http://csrc.nist.gov/encryption/aes/. - - This implementation is based on optimizations from Dr. Brian Gladman's paper and C code at - http://fp.gladman.plus.com/cryptography_technology/rijndael/ - - There are three levels of tradeoff of speed vs memory - Because java has no preprocessor, they are written as three separate classes from which to choose - - The fastest uses 8Kbytes of static tables to precompute round calculations, 4 256 word tables for encryption - and 4 for decryption. - - The middle performance version uses only one 256 word table for each, for a total of 2Kbytes, - adding 12 rotate operations per round to compute the values contained in the other tables from - the contents of the first - - The slowest version uses no static tables at all and computes the values - in each round. -

-

- This file contains the slowest performance version with no static tables - for round precomputation, but it has the smallest foot print. -

-
- - Calculate the necessary round keys - The number of calculations depends on key size and block size - AES specified a fixed block size of 128 bits and key sizes 128/192/256 bits - This code is written assuming those are the only possible values - - - default constructor - 128 bit block size. - - - initialise an AES cipher. - - @param forEncryption whether or not we are for encryption. - @param parameters the parameters required to set up the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - - An implementation of the AES Key Wrapper from the NIST Key Wrap Specification. -

- For further details see: http://csrc.nist.gov/encryption/kms/key-wrap.pdf. - - - - RFC 5794. - - ARIA is a 128-bit block cipher with 128-, 192-, and 256-bit keys. - - - A class that provides Blowfish key encryption operations, - such as encoding data and generating keys. - All the algorithms herein are from Applied Cryptography - and implement a simplified cryptography interface. - - - initialise a Blowfish cipher. - - @param forEncryption whether or not we are for encryption. - @param parameters the parameters required to set up the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - apply the encryption cycle to each value pair in the table. - - - Encrypt the given input starting at the given offset and place - the result in the provided buffer starting at the given offset. - The input will be an exact multiple of our blocksize. - - - Decrypt the given input starting at the given offset and place - the result in the provided buffer starting at the given offset. - The input will be an exact multiple of our blocksize. - - - Camellia - based on RFC 3713. - - - Camellia - based on RFC 3713, smaller implementation, about half the size of CamelliaEngine. - - - - An implementation of the Camellia key wrapper based on RFC 3657/RFC 3394. -

- For further details see: http://www.ietf.org/rfc/rfc3657.txt. - - - - A class that provides CAST key encryption operations, - such as encoding data and generating keys. - - All the algorithms herein are from the Internet RFC's - - RFC2144 - Cast5 (64bit block, 40-128bit key) - RFC2612 - CAST6 (128bit block, 128-256bit key) - - and implement a simplified cryptography interface. - - - initialise a CAST cipher. - - @param forEncryption whether or not we are for encryption. - @param parameters the parameters required to set up the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - Encrypt the given input starting at the given offset and place - the result in the provided buffer starting at the given offset. - - @param src The plaintext buffer - @param srcIndex An offset into src - @param dst The ciphertext buffer - @param dstIndex An offset into dst - - - Decrypt the given input starting at the given offset and place - the result in the provided buffer starting at the given offset. - - @param src The plaintext buffer - @param srcIndex An offset into src - @param dst The ciphertext buffer - @param dstIndex An offset into dst - - - The first of the three processing functions for the - encryption and decryption. - - @param D the input to be processed - @param Kmi the mask to be used from Km[n] - @param Kri the rotation value to be used - - - - The second of the three processing functions for the - encryption and decryption. - - @param D the input to be processed - @param Kmi the mask to be used from Km[n] - @param Kri the rotation value to be used - - - - The third of the three processing functions for the - encryption and decryption. - - @param D the input to be processed - @param Kmi the mask to be used from Km[n] - @param Kri the rotation value to be used - - - - Does the 16 rounds to encrypt the block. - - @param L0 the LH-32bits of the plaintext block - @param R0 the RH-32bits of the plaintext block - - - A class that provides CAST6 key encryption operations, - such as encoding data and generating keys. - - All the algorithms herein are from the Internet RFC - - RFC2612 - CAST6 (128bit block, 128-256bit key) - - and implement a simplified cryptography interface. - - - Encrypt the given input starting at the given offset and place - the result in the provided buffer starting at the given offset. - - @param src The plaintext buffer - @param srcIndex An offset into src - @param dst The ciphertext buffer - @param dstIndex An offset into dst - - - Decrypt the given input starting at the given offset and place - the result in the provided buffer starting at the given offset. - - @param src The plaintext buffer - @param srcIndex An offset into src - @param dst The ciphertext buffer - @param dstIndex An offset into dst - - - Does the 12 quad rounds rounds to encrypt the block. - - @param A the 00-31 bits of the plaintext block - @param B the 32-63 bits of the plaintext block - @param C the 64-95 bits of the plaintext block - @param D the 96-127 bits of the plaintext block - @param result the resulting ciphertext - - - Does the 12 quad rounds rounds to decrypt the block. - - @param A the 00-31 bits of the ciphertext block - @param B the 32-63 bits of the ciphertext block - @param C the 64-95 bits of the ciphertext block - @param D the 96-127 bits of the ciphertext block - @param result the resulting plaintext - - -

- Implementation of Daniel J. Bernstein's ChaCha stream cipher. - -
- - - Creates a 20 rounds ChaCha engine. - - - - - Implementation of Daniel J. Bernstein's ChaCha stream cipher. - - - - - Creates a 20 rounds ChaCha engine. - - - - - Creates a ChaCha engine with a specific number of rounds. - - the number of rounds (must be an even number). - - - - ChaCha function. - - The number of ChaCha rounds to execute - The input words. - The ChaCha state to modify. - - - A class that provides a basic DESede (or Triple DES) engine. - - - initialise a DESede cipher. - - @param forEncryption whether or not we are for encryption. - @param parameters the parameters required to set up the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - * Wrap keys according to - * - * draft-ietf-smime-key-wrap-01.txt. - *

- * Note: - *

    - *
  • this is based on a draft, and as such is subject to change - don't use this class for anything requiring long term storage.
  • - *
  • if you are using this to wrap triple-des keys you need to set the - * parity bits on the key and, if it's a two-key triple-des key, pad it - * yourself.
  • - *
- *

-
- - Field engine - - - Field param - - - Field paramPlusIV - - - Field iv - - - Field forWrapping - - - Field IV2 - - - Method init - - @param forWrapping - @param param - - - Method GetAlgorithmName - - @return - - - Method wrap - - @param in - @param inOff - @param inLen - @return - - - Method unwrap - - @param in - @param inOff - @param inLen - @return - @throws InvalidCipherTextException - - - Some key wrap algorithms make use of the Key Checksum defined - in CMS [CMS-Algorithms]. This is used to provide an integrity - check value for the key being wrapped. The algorithm is - - - Compute the 20 octet SHA-1 hash on the key being wrapped. - - Use the first 8 octets of this hash as the checksum value. - - @param key - @return - @throws Exception - @see http://www.w3.org/TR/xmlenc-core/#sec-CMSKeyChecksum - - - @param key - @param checksum - @return - @see http://www.w3.org/TR/xmlenc-core/#sec-CMSKeyChecksum - - - A class that provides a basic DES engine. - - - initialise a DES cipher. - - @param forEncryption whether or not we are for encryption. - @param parameters the parameters required to set up the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - what follows is mainly taken from "Applied Cryptography", by - Bruce Schneier, however it also bears great resemblance to Richard - Outerbridge's D3DES... - - - Generate an integer based working key based on our secret key - and what we processing we are planning to do. - - Acknowledgements for this routine go to James Gillogly and Phil Karn. - (whoever, and wherever they are!). - - - the DES engine. - - - implementation of DSTU 7624 (Kalyna) - - - this does your basic ElGamal algorithm. - - - initialise the ElGamal engine. - - @param forEncryption true if we are encrypting, false otherwise. - @param param the necessary ElGamal key parameters. - - - Return the maximum size for an input block to this engine. - For ElGamal this is always one byte less than the size of P on - encryption, and twice the length as the size of P on decryption. - - @return maximum size for an input block. - - - Return the maximum size for an output block to this engine. - For ElGamal this is always one byte less than the size of P on - decryption, and twice the length as the size of P on encryption. - - @return maximum size for an output block. - - - Process a single block using the basic ElGamal algorithm. - - @param in the input array. - @param inOff the offset into the input buffer where the data starts. - @param length the length of the data to be processed. - @return the result of the ElGamal process. - @exception DataLengthException the input block is too large. - - - implementation of GOST 28147-89 - - - standard constructor. - - - initialise an Gost28147 cipher. - - @param forEncryption whether or not we are for encryption. - @param parameters the parameters required to set up the cipher. - @exception ArgumentException if the parameters argument is inappropriate. - - - Return the S-Box associated with SBoxName - @param sBoxName name of the S-Box - @return byte array representing the S-Box - - - HC-128 is a software-efficient stream cipher created by Hongjun Wu. It - generates keystream from a 128-bit secret key and a 128-bit initialization - vector. -

- http://www.ecrypt.eu.org/stream/p3ciphers/hc/hc128_p3.pdf -

- It is a third phase candidate in the eStream contest, and is patent-free. - No attacks are known as of today (April 2007). See - - http://www.ecrypt.eu.org/stream/hcp3.html -

-
- - Initialise a HC-128 cipher. - - @param forEncryption whether or not we are for encryption. Irrelevant, as - encryption and decryption are the same. - @param params the parameters required to set up the cipher. - @throws ArgumentException if the params argument is - inappropriate (ie. the key is not 128 bit long). - - - HC-256 is a software-efficient stream cipher created by Hongjun Wu. It - generates keystream from a 256-bit secret key and a 256-bit initialization - vector. -

- http://www.ecrypt.eu.org/stream/p3ciphers/hc/hc256_p3.pdf -

- Its brother, HC-128, is a third phase candidate in the eStream contest. - The algorithm is patent-free. No attacks are known as of today (April 2007). - See - - http://www.ecrypt.eu.org/stream/hcp3.html -

-
- - Initialise a HC-256 cipher. - - @param forEncryption whether or not we are for encryption. Irrelevant, as - encryption and decryption are the same. - @param params the parameters required to set up the cipher. - @throws ArgumentException if the params argument is - inappropriate (ie. the key is not 256 bit long). - - - A class that provides a basic International Data Encryption Algorithm (IDEA) engine. -

- This implementation is based on the "HOWTO: INTERNATIONAL DATA ENCRYPTION ALGORITHM" - implementation summary by Fauzan Mirza (F.U.Mirza@sheffield.ac.uk). (barring 1 typo at the - end of the MulInv function!). -

-

- It can be found at ftp://ftp.funet.fi/pub/crypt/cryptography/symmetric/idea/ -

-

- Note: This algorithm was patented in the USA, Japan and Europe. These patents expired in 2011/2012. -

-
- - standard constructor. - - - initialise an IDEA cipher. - - @param forEncryption whether or not we are for encryption. - @param parameters the parameters required to set up the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - return x = x * y where the multiplication is done modulo - 65537 (0x10001) (as defined in the IDEA specification) and - a zero input is taken to be 65536 (0x10000). - - @param x the x value - @param y the y value - @return x = x * y - - - The following function is used to expand the user key to the encryption - subkey. The first 16 bytes are the user key, and the rest of the subkey - is calculated by rotating the previous 16 bytes by 25 bits to the left, - and so on until the subkey is completed. - - - This function computes multiplicative inverse using Euclid's Greatest - Common Divisor algorithm. Zero and one are self inverse. -

- i.e. x * MulInv(x) == 1 (modulo BASE) -

-
- - Return the additive inverse of x. -

- i.e. x + AddInv(x) == 0 -

-
- - The function to invert the encryption subkey to the decryption subkey. - It also involves the multiplicative inverse and the additive inverse functions. - - - support class for constructing intergrated encryption ciphers - for doing basic message exchanges on top of key agreement ciphers - - - set up for use with stream mode, where the key derivation function - is used to provide a stream of bytes to xor with the message. - - @param agree the key agreement used as the basis for the encryption - @param kdf the key derivation function used for byte generation - @param mac the message authentication code generator for the message - - - set up for use in conjunction with a block cipher to handle the - message. - - @param agree the key agreement used as the basis for the encryption - @param kdf the key derivation function used for byte generation - @param mac the message authentication code generator for the message - @param cipher the cipher to used for encrypting the message - - - Initialise the encryptor. - - @param forEncryption whether or not this is encryption/decryption. - @param privParam our private key parameters - @param pubParam the recipient's/sender's public key parameters - @param param encoding and derivation parameters. - - - Implementation of Bob Jenkin's ISAAC (Indirection Shift Accumulate Add and Count). - see: http://www.burtleburtle.net/bob/rand/isaacafa.html - - - initialise an ISAAC cipher. - - @param forEncryption whether or not we are for encryption. - @param params the parameters required to set up the cipher. - @exception ArgumentException if the params argument is - inappropriate. - - - NaccacheStern Engine. For details on this cipher, please see - http://www.gemplus.com/smart/rd/publications/pdf/NS98pkcs.pdf - - - Initializes this algorithm. Must be called before all other Functions. - - @see org.bouncycastle.crypto.AsymmetricBlockCipher#init(bool, - org.bouncycastle.crypto.CipherParameters) - - - Returns the input block size of this algorithm. - - @see org.bouncycastle.crypto.AsymmetricBlockCipher#GetInputBlockSize() - - - Returns the output block size of this algorithm. - - @see org.bouncycastle.crypto.AsymmetricBlockCipher#GetOutputBlockSize() - - - Process a single Block using the Naccache-Stern algorithm. - - @see org.bouncycastle.crypto.AsymmetricBlockCipher#ProcessBlock(byte[], - int, int) - - - Encrypts a BigInteger aka Plaintext with the public key. - - @param plain - The BigInteger to encrypt - @return The byte[] representation of the encrypted BigInteger (i.e. - crypted.toByteArray()) - - - Adds the contents of two encrypted blocks mod sigma - - @param block1 - the first encrypted block - @param block2 - the second encrypted block - @return encrypt((block1 + block2) mod sigma) - @throws InvalidCipherTextException - - - Convenience Method for data exchange with the cipher. - - Determines blocksize and splits data to blocksize. - - @param data the data to be processed - @return the data after it went through the NaccacheSternEngine. - @throws InvalidCipherTextException - - - Computes the integer x that is expressed through the given primes and the - congruences with the chinese remainder theorem (CRT). - - @param congruences - the congruences c_i - @param primes - the primes p_i - @return an integer x for that x % p_i == c_i - - - A Noekeon engine, using direct-key mode. - - - Create an instance of the Noekeon encryption algorithm - and set some defaults - - - initialise - - @param forEncryption whether or not we are for encryption. - @param params the parameters required to set up the cipher. - @exception ArgumentException if the params argument is - inappropriate. - - - The no-op engine that just copies bytes through, irrespective of whether encrypting and decrypting. - Provided for the sake of completeness. - - - an implementation of RC2 as described in RFC 2268 - "A Description of the RC2(r) Encryption Algorithm" R. Rivest. - - - initialise a RC2 cipher. - - @param forEncryption whether or not we are for encryption. - @param parameters the parameters required to set up the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - return the result rotating the 16 bit number in x left by y - - - Wrap keys according to RFC 3217 - RC2 mechanism - - - Field engine - - - Field param - - - Field paramPlusIV - - - Field iv - - - Field forWrapping - - - Field IV2 - - - Method init - - @param forWrapping - @param param - - - Method GetAlgorithmName - - @return - - - Method wrap - - @param in - @param inOff - @param inLen - @return - - - Method unwrap - - @param in - @param inOff - @param inLen - @return - @throws InvalidCipherTextException - - - Some key wrap algorithms make use of the Key Checksum defined - in CMS [CMS-Algorithms]. This is used to provide an integrity - check value for the key being wrapped. The algorithm is - - - Compute the 20 octet SHA-1 hash on the key being wrapped. - - Use the first 8 octets of this hash as the checksum value. - - @param key - @return - @throws Exception - @see http://www.w3.org/TR/xmlenc-core/#sec-CMSKeyChecksum - - - @param key - @param checksum - @return - @see http://www.w3.org/TR/xmlenc-core/#sec-CMSKeyChecksum - - - initialise a RC4 cipher. - - @param forEncryption whether or not we are for encryption. - @param parameters the parameters required to set up the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - The specification for RC5 came from the RC5 Encryption Algorithm - publication in RSA CryptoBytes, Spring of 1995. - http://www.rsasecurity.com/rsalabs/cryptobytes. -

- This implementation has a word size of 32 bits.

-
- - Create an instance of the RC5 encryption algorithm - and set some defaults - - - initialise a RC5-32 cipher. - - @param forEncryption whether or not we are for encryption. - @param parameters the parameters required to set up the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - Re-key the cipher. - - @param key the key to be used - - - Encrypt the given block starting at the given offset and place - the result in the provided buffer starting at the given offset. - - @param in in byte buffer containing data to encrypt - @param inOff offset into src buffer - @param out out buffer where encrypted data is written - @param outOff offset into out buffer - - - Perform a left "spin" of the word. The rotation of the given - word x is rotated left by y bits. - Only the lg(32) low-order bits of y - are used to determine the rotation amount. Here it is - assumed that the wordsize used is a power of 2. - - @param x word to rotate - @param y number of bits to rotate % 32 - - - Perform a right "spin" of the word. The rotation of the given - word x is rotated left by y bits. - Only the lg(32) low-order bits of y - are used to determine the rotation amount. Here it is - assumed that the wordsize used is a power of 2. - - @param x word to rotate - @param y number of bits to rotate % 32 - - - The specification for RC5 came from the RC5 Encryption Algorithm - publication in RSA CryptoBytes, Spring of 1995. - http://www.rsasecurity.com/rsalabs/cryptobytes. -

- This implementation is set to work with a 64 bit word size.

-
- - Create an instance of the RC5 encryption algorithm - and set some defaults - - - initialise a RC5-64 cipher. - - @param forEncryption whether or not we are for encryption. - @param parameters the parameters required to set up the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - Re-key the cipher. - - @param key the key to be used - - - Encrypt the given block starting at the given offset and place - the result in the provided buffer starting at the given offset. - - @param in in byte buffer containing data to encrypt - @param inOff offset into src buffer - @param out out buffer where encrypted data is written - @param outOff offset into out buffer - - - Perform a left "spin" of the word. The rotation of the given - word x is rotated left by y bits. - Only the lg(wordSize) low-order bits of y - are used to determine the rotation amount. Here it is - assumed that the wordsize used is a power of 2. - - @param x word to rotate - @param y number of bits to rotate % wordSize - - - Perform a right "spin" of the word. The rotation of the given - word x is rotated left by y bits. - Only the lg(wordSize) low-order bits of y - are used to determine the rotation amount. Here it is - assumed that the wordsize used is a power of 2. - - @param x word to rotate - @param y number of bits to rotate % wordSize - - - An RC6 engine. - - - Create an instance of the RC6 encryption algorithm - and set some defaults - - - initialise a RC5-32 cipher. - - @param forEncryption whether or not we are for encryption. - @param parameters the parameters required to set up the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - Re-key the cipher. - - @param inKey the key to be used - - - Perform a left "spin" of the word. The rotation of the given - word x is rotated left by y bits. - Only the lg(wordSize) low-order bits of y - are used to determine the rotation amount. Here it is - assumed that the wordsize used is a power of 2. - - @param x word to rotate - @param y number of bits to rotate % wordSize - - - Perform a right "spin" of the word. The rotation of the given - word x is rotated left by y bits. - Only the lg(wordSize) low-order bits of y - are used to determine the rotation amount. Here it is - assumed that the wordsize used is a power of 2. - - @param x word to rotate - @param y number of bits to rotate % wordSize - - - an implementation of the RFC 3211 Key Wrap - Specification. - - - - An implementation of the AES Key Wrapper from the NIST Key Wrap - Specification as described in RFC 3394. -

- For further details see: http://www.ietf.org/rfc/rfc3394.txt - and http://csrc.nist.gov/encryption/kms/key-wrap.pdf. - - - - an implementation of Rijndael, based on the documentation and reference implementation - by Paulo Barreto, Vincent Rijmen, for v2.0 August '99. -

- Note: this implementation is based on information prior to readonly NIST publication. -

-
- - multiply two elements of GF(2^m) - needed for MixColumn and InvMixColumn - - - xor corresponding text input and round key input bytes - - - Row 0 remains unchanged - The other three rows are shifted a variable amount - - - Replace every byte of the input by the byte at that place - in the nonlinear S-box - - - Mix the bytes of every column in a linear way - - - Mix the bytes of every column in a linear way - This is the opposite operation of Mixcolumn - - - Calculate the necessary round keys - The number of calculations depends on keyBits and blockBits - - - default constructor - 128 bit block size. - - - basic constructor - set the cipher up for a given blocksize - - @param blocksize the blocksize in bits, must be 128, 192, or 256. - - - initialise a Rijndael cipher. - - @param forEncryption whether or not we are for encryption. - @param parameters the parameters required to set up the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - this does your basic RSA algorithm with blinding - - - initialise the RSA engine. - - @param forEncryption true if we are encrypting, false otherwise. - @param param the necessary RSA key parameters. - - - Return the maximum size for an input block to this engine. - For RSA this is always one byte less than the key size on - encryption, and the same length as the key size on decryption. - - @return maximum size for an input block. - - - Return the maximum size for an output block to this engine. - For RSA this is always one byte less than the key size on - decryption, and the same length as the key size on encryption. - - @return maximum size for an output block. - - - Process a single block using the basic RSA algorithm. - - @param inBuf the input array. - @param inOff the offset into the input buffer where the data starts. - @param inLen the length of the data to be processed. - @return the result of the RSA process. - @exception DataLengthException the input block is too large. - - - This does your basic RSA Chaum's blinding and unblinding as outlined in - "Handbook of Applied Cryptography", page 475. You need to use this if you are - trying to get another party to generate signatures without them being aware - of the message they are signing. - - - Initialise the blinding engine. - - @param forEncryption true if we are encrypting (blinding), false otherwise. - @param param the necessary RSA key parameters. - - - Return the maximum size for an input block to this engine. - For RSA this is always one byte less than the key size on - encryption, and the same length as the key size on decryption. - - @return maximum size for an input block. - - - Return the maximum size for an output block to this engine. - For RSA this is always one byte less than the key size on - decryption, and the same length as the key size on encryption. - - @return maximum size for an output block. - - - Process a single block using the RSA blinding algorithm. - - @param in the input array. - @param inOff the offset into the input buffer where the data starts. - @param inLen the length of the data to be processed. - @return the result of the RSA process. - @throws DataLengthException the input block is too large. - - - this does your basic RSA algorithm. - - - initialise the RSA engine. - - @param forEncryption true if we are encrypting, false otherwise. - @param param the necessary RSA key parameters. - - - Return the maximum size for an input block to this engine. - For RSA this is always one byte less than the key size on - encryption, and the same length as the key size on decryption. - - @return maximum size for an input block. - - - Return the maximum size for an output block to this engine. - For RSA this is always one byte less than the key size on - decryption, and the same length as the key size on encryption. - - @return maximum size for an output block. - - - this does your basic RSA algorithm. - - - initialise the RSA engine. - - @param forEncryption true if we are encrypting, false otherwise. - @param param the necessary RSA key parameters. - - - Return the maximum size for an input block to this engine. - For RSA this is always one byte less than the key size on - encryption, and the same length as the key size on decryption. - - @return maximum size for an input block. - - - Return the maximum size for an output block to this engine. - For RSA this is always one byte less than the key size on - decryption, and the same length as the key size on encryption. - - @return maximum size for an output block. - - - Process a single block using the basic RSA algorithm. - - @param inBuf the input array. - @param inOff the offset into the input buffer where the data starts. - @param inLen the length of the data to be processed. - @return the result of the RSA process. - @exception DataLengthException the input block is too large. - - - - Implementation of Daniel J. Bernstein's Salsa20 stream cipher, Snuffle 2005 - - - - Constants - - - - Creates a 20 round Salsa20 engine. - - - - - Creates a Salsa20 engine with a specific number of rounds. - - the number of rounds (must be an even number). - - - Implementation of the SEED algorithm as described in RFC 4009 - - - - An implementation of the SEED key wrapper based on RFC 4010/RFC 3394. -

- For further details see: http://www.ietf.org/rfc/rfc4010.txt. - - - - * Serpent is a 128-bit 32-round block cipher with variable key lengths, - * including 128, 192 and 256 bit keys conjectured to be at least as - * secure as three-key triple-DES. - *

- * Serpent was designed by Ross Anderson, Eli Biham and Lars Knudsen as a - * candidate algorithm for the NIST AES Quest. - *

- *

- * For full details see The Serpent home page - *

-
- - Expand a user-supplied key material into a session key. - - @param key The user-key bytes (multiples of 4) to use. - @exception ArgumentException - - - Encrypt one block of plaintext. - - @param input the array containing the input data. - @param inOff offset into the in array the data starts at. - @param output the array the output data will be copied into. - @param outOff the offset into the out array the output will start at. - - - Decrypt one block of ciphertext. - - @param input the array containing the input data. - @param inOff offset into the in array the data starts at. - @param output the array the output data will be copied into. - @param outOff the offset into the out array the output will start at. - - - initialise a Serpent cipher. - - @param encrypting whether or not we are for encryption. - @param params the parameters required to set up the cipher. - @throws IllegalArgumentException if the params argument is - inappropriate. - - - Process one block of input from the array in and write it to - the out array. - - @param in the array containing the input data. - @param inOff offset into the in array the data starts at. - @param out the array the output data will be copied into. - @param outOff the offset into the out array the output will start at. - @return the number of bytes processed and produced. - @throws DataLengthException if there isn't enough data in in, or - space in out. - @throws IllegalStateException if the cipher isn't initialised. - - - InvSO - {13, 3,11, 0,10, 6, 5,12, 1,14, 4, 7,15, 9, 8, 2 } - 15 terms. - - - S1 - {15,12, 2, 7, 9, 0, 5,10, 1,11,14, 8, 6,13, 3, 4 } - 14 terms. - - - InvS1 - { 5, 8, 2,14,15, 6,12, 3,11, 4, 7, 9, 1,13,10, 0 } - 14 steps. - - - S2 - { 8, 6, 7, 9, 3,12,10,15,13, 1,14, 4, 0,11, 5, 2 } - 16 terms. - - - InvS2 - {12, 9,15, 4,11,14, 1, 2, 0, 3, 6,13, 5, 8,10, 7 } - 16 steps. - - - S3 - { 0,15,11, 8,12, 9, 6, 3,13, 1, 2, 4,10, 7, 5,14 } - 16 terms. - - - InvS3 - { 0, 9,10, 7,11,14, 6,13, 3, 5,12, 2, 4, 8,15, 1 } - 15 terms - - - S4 - { 1,15, 8, 3,12, 0,11, 6, 2, 5, 4,10, 9,14, 7,13 } - 15 terms. - - - InvS4 - { 5, 0, 8, 3,10, 9, 7,14, 2,12,11, 6, 4,15,13, 1 } - 15 terms. - - - S5 - {15, 5, 2,11, 4,10, 9,12, 0, 3,14, 8,13, 6, 7, 1 } - 16 terms. - - - InvS5 - { 8,15, 2, 9, 4, 1,13,14,11, 6, 5, 3, 7,12,10, 0 } - 16 terms. - - - S6 - { 7, 2,12, 5, 8, 4, 6,11,14, 9, 1,15,13, 3,10, 0 } - 15 terms. - - - InvS6 - {15,10, 1,13, 5, 3, 6, 0, 4, 9,14, 7, 2,12, 8,11 } - 15 terms. - - - S7 - { 1,13,15, 0,14, 8, 2,11, 7, 4,12,10, 9, 3, 5, 6 } - 16 terms. - - - InvS7 - { 3, 0, 6,13, 9,14,15, 8, 5,12,11, 7,10, 1, 4, 2 } - 17 terms. - - - Apply the linear transformation to the register set. - - - Apply the inverse of the linear transformation to the register set. - - - a class that provides a basic SKIPJACK engine. - - - initialise a SKIPJACK cipher. - - @param forEncryption whether or not we are for encryption. - @param parameters the parameters required to set up the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - The G permutation - - - the inverse of the G permutation. - - - - SM2 public key encryption engine - based on https://tools.ietf.org/html/draft-shen-sm2-ecdsa-02. - - - - SM4 Block Cipher - SM4 is a 128 bit block cipher with a 128 bit key. - - The implementation here is based on the document http://eprint.iacr.org/2008/329.pdf - by Whitfield Diffie and George Ledin, which is a translation of Prof. LU Shu-wang's original standard. - - - - An TEA engine. - - - Create an instance of the TEA encryption algorithm - and set some defaults - - - initialise - - @param forEncryption whether or not we are for encryption. - @param params the parameters required to set up the cipher. - @exception ArgumentException if the params argument is - inappropriate. - - - Re-key the cipher. - - @param key the key to be used - - - - Implementation of the Threefish tweakable large block cipher in 256, 512 and 1024 bit block - sizes. - - - This is the 1.3 version of Threefish defined in the Skein hash function submission to the NIST - SHA-3 competition in October 2010. -

- Threefish was designed by Niels Ferguson - Stefan Lucks - Bruce Schneier - Doug Whiting - Mihir - Bellare - Tadayoshi Kohno - Jon Callas - Jesse Walker. -

- This implementation inlines all round functions, unrolls 8 rounds, and uses 1.2k of static tables - to speed up key schedule injection.
- 2 x block size state is retained by each cipher instance. - - - -

- 256 bit block size - Threefish-256 - -
- - - 512 bit block size - Threefish-512 - - - - - 1024 bit block size - Threefish-1024 - - - - Size of the tweak in bytes (always 128 bit/16 bytes) - - - Rounds in Threefish-256 - - - Rounds in Threefish-512 - - - Rounds in Threefish-1024 - - - Max rounds of any of the variants - - - Key schedule parity constant - - - Block size in bytes - - - Block size in 64 bit words - - - Buffer for byte oriented processBytes to call internal word API - - - Tweak bytes (2 byte t1,t2, calculated t3 and repeat of t1,t2 for modulo free lookup - - - Key schedule words - - - The internal cipher implementation (varies by blocksize) - - - - Constructs a new Threefish cipher, with a specified block size. - - the block size in bits, one of , , - . - - - - Initialise the engine. - - Initialise for encryption if true, for decryption if false. - an instance of or (to - use a 0 tweak) - - - - Initialise the engine, specifying the key and tweak directly. - - the cipher mode. - the words of the key, or null to use the current key. - the 2 word (128 bit) tweak, or null to use the current tweak. - - - - Process a block of data represented as 64 bit words. - - the number of 8 byte words processed (which will be the same as the block size). - a block sized buffer of words to process. - a block sized buffer of words to receive the output of the operation. - if either the input or output is not block sized - if this engine is not initialised - - - - Read a single 64 bit word from input in LSB first order. - - - - - Write a 64 bit word to output in LSB first order. - - - - Rotate left + xor part of the mix operation. - - - Rotate xor + rotate right part of the unmix operation. - - - The extended + repeated tweak words - - - The extended + repeated key words - - - Mix rotation constants defined in Skein 1.3 specification - - - Mix rotation constants defined in Skein 1.3 specification - - - Mix rotation constants defined in Skein 1.3 specification - - - Mix rotation constants defined in Skein 1.3 specification - - - Mix rotation constants defined in Skein 1.3 specification - - - Mix rotation constants defined in Skein 1.3 specification - - - Mix rotation constants defined in Skein 1.3 specification - - - Mix rotation constants defined in Skein 1.3 specification - - - Mix rotation constants defined in Skein 1.3 specification - - - Mix rotation constants defined in Skein 1.3 specification - - - Tnepres is a 128-bit 32-round block cipher with variable key lengths, - including 128, 192 and 256 bit keys conjectured to be at least as - secure as three-key triple-DES. -

- Tnepres is based on Serpent which was designed by Ross Anderson, Eli Biham and Lars Knudsen as a - candidate algorithm for the NIST AES Quest. Unfortunately there was an endianness issue - with test vectors in the AES submission and the resulting confusion lead to the Tnepres cipher - as well, which is a byte swapped version of Serpent. -

-

- For full details see The Serpent home page -

-
- - Expand a user-supplied key material into a session key. - - @param key The user-key bytes (multiples of 4) to use. - @exception ArgumentException - - - Encrypt one block of plaintext. - - @param input the array containing the input data. - @param inOff offset into the in array the data starts at. - @param output the array the output data will be copied into. - @param outOff the offset into the out array the output will start at. - - - Decrypt one block of ciphertext. - - @param input the array containing the input data. - @param inOff offset into the in array the data starts at. - @param output the array the output data will be copied into. - @param outOff the offset into the out array the output will start at. - - - A class that provides Twofish encryption operations. - - This Java implementation is based on the Java reference - implementation provided by Bruce Schneier and developed - by Raif S. Naffah. - - - Define the fixed p0/p1 permutations used in keyed S-box lookup. - By changing the following constant definitions, the S-boxes will - automatically Get changed in the Twofish engine. - - - gSubKeys[] and gSBox[] are eventually used in the - encryption and decryption methods. - - - initialise a Twofish cipher. - - @param forEncryption whether or not we are for encryption. - @param parameters the parameters required to set up the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - Encrypt the given input starting at the given offset and place - the result in the provided buffer starting at the given offset. - The input will be an exact multiple of our blocksize. - - encryptBlock uses the pre-calculated gSBox[] and subKey[] - arrays. - - - Decrypt the given input starting at the given offset and place - the result in the provided buffer starting at the given offset. - The input will be an exact multiple of our blocksize. - - - Use (12, 8) Reed-Solomon code over GF(256) to produce - a key S-box 32-bit entity from 2 key material 32-bit - entities. - - @param k0 first 32-bit entity - @param k1 second 32-bit entity - @return Remainder polynomial Generated using RS code - - - * Reed-Solomon code parameters: (12,8) reversible code: - *

- *

-                    * G(x) = x^4 + (a+1/a)x^3 + ax^2 + (a+1/a)x + 1
-                    * 
- * where a = primitive root of field generator 0x14D - *

-
- - initialise a VMPC cipher. - - @param forEncryption - whether or not we are for encryption. - @param params - the parameters required to set up the cipher. - @exception ArgumentException - if the params argument is inappropriate. - - - - Implementation of Daniel J. Bernstein's XSalsa20 stream cipher - Salsa20 with an extended nonce. - - - XSalsa20 requires a 256 bit key, and a 192 bit nonce. - - - - - XSalsa20 key generation: process 256 bit input key and 128 bits of the input nonce - using a core Salsa20 function without input addition to produce 256 bit working key - and use that with the remaining 64 bits of nonce to initialize a standard Salsa20 engine state. - - - - An XTEA engine. - - - Create an instance of the TEA encryption algorithm - and set some defaults - - - initialise - - @param forEncryption whether or not we are for encryption. - @param params the parameters required to set up the cipher. - @exception ArgumentException if the params argument is - inappropriate. - - - Re-key the cipher. - - @param key the key to be used - - - Base class for format-preserving encryption. - - - - Process length bytes from inBuf, writing the output to outBuf. - - number of bytes output. - input data. - offset in input data to start at. - number of bytes to process. - destination buffer. - offset to start writing at in destination buffer. - - - - Initialize the FPE engine for encryption/decryption. - - number of bytes output. - true if initialising for encryption, false otherwise. - the key and other parameters to use to set the engine up. - - - Basic KDF generator for derived keys and ivs as defined by IEEE P1363a/ISO 18033 -
- This implementation is based on ISO 18033/P1363a. -
- - Construct a KDF Parameters generator. - - @param counterStart value of counter. - @param digest the digest to be used as the source of derived keys. - - - return the underlying digest. - - - fill len bytes of the output buffer with bytes generated from - the derivation function. - - @throws ArgumentException if the size of the request will cause an overflow. - @throws DataLengthException if the out buffer is too small. - - - Core of password hashing scheme Bcrypt, - designed by Niels Provos and David Mazières, - corresponds to the C reference implementation. -

- This implementation does not correspondent to the 1999 published paper - "A Future-Adaptable Password Scheme" of Niels Provos and David Mazières, - see: https://www.usenix.org/legacy/events/usenix99/provos/provos_html/node1.html. - In contrast to the paper, the order of key setup and salt setup is reversed: - state <- ExpandKey(state, 0, key) - state %lt;- ExpandKey(state, 0, salt) - This corresponds to the OpenBSD reference implementation of Bcrypt. -

- Note: - There is no successful cryptanalysis (status 2015), but - the amount of memory and the band width of Bcrypt - may be insufficient to effectively prevent attacks - with custom hardware like FPGAs, ASICs -

- This implementation uses some parts of Bouncy Castle's BlowfishEngine. -

-
- - Derives a raw 192 bit Bcrypt key - - @param cost the cost factor, treated as an exponent of 2 - @param salt a 16 byte salt - @param psw the password - @return a 192 bit key - - - Size of the salt parameter in bytes - - - Minimum value of cost parameter, equal to log2(bytes of salt) - - - Maximum value of cost parameter (31 == 2,147,483,648) - - - Maximum size of password == max (unrestricted) size of Blowfish key - - - Converts a character password to bytes incorporating the required trailing zero byte. - - @param password the password to be encoded. - @return a byte representation of the password in UTF8 + trailing zero. - - - Calculates the bcrypt hash of a password. -

- This implements the raw bcrypt function as defined in the bcrypt specification, not - the crypt encoded version implemented in OpenBSD. -

- @param password the password bytes (up to 72 bytes) to use for this invocation. - @param salt the 128 bit salt to use for this invocation. - @param cost the bcrypt cost parameter. The cost of the bcrypt function grows as - 2^cost. Legal values are 4..31 inclusive. - @return the output of the raw bcrypt operation: a 192 bit (24 byte) hash. -
- - initialise the key generator - if strength is set to zero - the key Generated will be 192 bits in size, otherwise - strength can be 128 or 192 (or 112 or 168 if you don't count - parity bits), depending on whether you wish to do 2-key or 3-key - triple DES. - - @param param the parameters to be used for key generation - - - initialise the key generator - if strength is set to zero - the key generated will be 64 bits in size, otherwise - strength can be 64 or 56 bits (if you don't count the parity bits). - - @param param the parameters to be used for key generation - - - a basic Diffie-Hellman key pair generator. - - This generates keys consistent for use with the basic algorithm for - Diffie-Hellman. - - - a Diffie-Hellman key pair generator. - - This generates keys consistent for use in the MTI/A0 key agreement protocol - as described in "Handbook of Applied Cryptography", Pages 516-519. - - - which Generates the p and g values from the given parameters, - returning the DHParameters object. -

- Note: can take a while...

-
- - a DSA key pair generator. - - This Generates DSA keys in line with the method described - in FIPS 186-3 B.1 FFC Key Pair Generation. - - - Generate suitable parameters for DSA, in line with FIPS 186-2, or FIPS 186-3. - - - Initialise the generator - This form can only be used for older DSA (pre-DSA2) parameters - the size of keys in bits (from 512 up to 1024, and a multiple of 64) - measure of robustness of primes (at least 80 for FIPS 186-2 compliance) - the source of randomness to use - - - Initialise the generator for DSA 2 - You must use this Init method if you need to generate parameters for DSA 2 keys - An instance of DsaParameterGenerationParameters used to configure this generator - - - Generates a set of DsaParameters - Can take a while... - - - generate suitable parameters for DSA, in line with - FIPS 186-3 A.1 Generation of the FFC Primes p and q. - - - Given the domain parameters this routine generates an EC key - pair in accordance with X9.62 section 5.2.1 pages 26, 27. - - - a ElGamal key pair generator. -

- This Generates keys consistent for use with ElGamal as described in - page 164 of "Handbook of Applied Cryptography".

-
- - * which Generates the p and g values from the given parameters, - * returning the ElGamalParameters object. - *

- * Note: can take a while... - *

-
- - a GOST3410 key pair generator. - This generates GOST3410 keys in line with the method described - in GOST R 34.10-94. - - - generate suitable parameters for GOST3410. - - - initialise the key generator. - - @param size size of the key - @param typeProcedure type procedure A,B = 1; A',B' - else - @param random random byte source. - - - Procedure C - procedure generates the a value from the given p,q, - returning the a value. - - - which generates the p , q and a values from the given parameters, - returning the Gost3410Parameters object. - - - HMAC-based Extract-and-Expand Key Derivation Function (HKDF) implemented - according to IETF RFC 5869, May 2010 as specified by H. Krawczyk, IBM - Research & P. Eronen, Nokia. It uses a HMac internally to compute de OKM - (output keying material) and is likely to have better security properties - than KDF's based on just a hash function. - - - Creates a HKDFBytesGenerator based on the given hash function. - - @param hash the digest to be used as the source of generatedBytes bytes - - - Performs the extract part of the key derivation function. - - @param salt the salt to use - @param ikm the input keying material - @return the PRK as KeyParameter - - - Performs the expand part of the key derivation function, using currentT - as input and output buffer. - - @throws DataLengthException if the total number of bytes generated is larger than the one - specified by RFC 5869 (255 * HashLen) - - - KFD2 generator for derived keys and ivs as defined by IEEE P1363a/ISO 18033 -
- This implementation is based on IEEE P1363/ISO 18033. -
- - Construct a KDF1 byte generator. - - @param digest the digest to be used as the source of derived keys. - - - KDF2 generator for derived keys and ivs as defined by IEEE P1363a/ISO 18033 -
- This implementation is based on IEEE P1363/ISO 18033. -
- - Construct a KDF2 bytes generator. Generates key material - according to IEEE P1363 or ISO 18033 depending on the initialisation. - - @param digest the digest to be used as the source of derived keys. - - - Generator for MGF1 as defined in Pkcs 1v2 - - - @param digest the digest to be used as the source of Generated bytes - - - return the underlying digest. - - - int to octet string. - - - fill len bytes of the output buffer with bytes Generated from - the derivation function. - - @throws DataLengthException if the out buffer is too small. - - - Key generation parameters for NaccacheStern cipher. For details on this cipher, please see - - http://www.gemplus.com/smart/rd/publications/pdf/NS98pkcs.pdf - - - Generates a permuted ArrayList from the original one. The original List - is not modified - - @param arr - the ArrayList to be permuted - @param rand - the source of Randomness for permutation - @return a new IList with the permuted elements. - - - Finds the first 'count' primes starting with 3 - - @param count - the number of primes to find - @return a vector containing the found primes as Integer - - - Password hashing scheme BCrypt, - designed by Niels Provos and David Mazières, using the - String format and the Base64 encoding - of the reference implementation on OpenBSD - - - Creates a 60 character Bcrypt String, including - version, cost factor, salt and hash, separated by '$' - - @param version the version, 2y,2b or 2a. (2a is not backwards compatible.) - @param cost the cost factor, treated as an exponent of 2 - @param salt a 16 byte salt - @param password the password - @return a 60 character Bcrypt String - - - Creates a 60 character Bcrypt String, including - version, cost factor, salt and hash, separated by '$' using version - '2y'. - - @param cost the cost factor, treated as an exponent of 2 - @param salt a 16 byte salt - @param password the password - @return a 60 character Bcrypt String - - - Creates a 60 character Bcrypt String, including - version, cost factor, salt and hash, separated by '$' - - @param version the version, may be 2b, 2y or 2a. (2a is not backwards compatible.) - @param cost the cost factor, treated as an exponent of 2 - @param salt a 16 byte salt - @param password the password - @return a 60 character Bcrypt String - - - Checks if a password corresponds to a 60 character Bcrypt String - - @param bcryptString a 60 character Bcrypt String, including - version, cost factor, salt and hash, - separated by '$' - @param password the password as an array of chars - @return true if the password corresponds to the - Bcrypt String, otherwise false - - - - - - Construct a OpenSSL Parameters generator - digest the original MD5. - - - - - - - Construct a OpenSSL Parameters generator - digest as specified. - - the digest to use as the PRF. - - - - Initialise - note the iteration count for this algorithm is fixed at 1. - - @param password password to use. - @param salt salt to use. - - - the derived key function, the ith hash of the password and the salt. - - - Generate a key parameter derived from the password, salt, and iteration - count we are currently initialised with. - - @param keySize the size of the key we want (in bits) - @return a KeyParameter object. - @exception ArgumentException if the key length larger than the base hash size. - - - Generate a key with initialisation vector parameter derived from - the password, salt, and iteration count we are currently initialised - with. - - @param keySize the size of the key we want (in bits) - @param ivSize the size of the iv we want (in bits) - @return a ParametersWithIV object. - @exception ArgumentException if keySize + ivSize is larger than the base hash size. - - - Generate a key parameter for use with a MAC derived from the password, - salt, and iteration count we are currently initialised with. - - @param keySize the size of the key we want (in bits) - @return a KeyParameter object. - @exception ArgumentException if the key length larger than the base hash size. - - - Generator for Pbe derived keys and ivs as defined by Pkcs 12 V1.0. -

- The document this implementation is based on can be found at - - RSA's Pkcs12 Page -

-
- - Construct a Pkcs 12 Parameters generator. - - @param digest the digest to be used as the source of derived keys. - @exception ArgumentException if an unknown digest is passed in. - - - add a + b + 1, returning the result in a. The a value is treated - as a BigInteger of length (b.Length * 8) bits. The result is - modulo 2^b.Length in case of overflow. - - - generation of a derived key ala Pkcs12 V1.0. - - - Generate a key parameter derived from the password, salt, and iteration - count we are currently initialised with. - - @param keySize the size of the key we want (in bits) - @return a KeyParameter object. - - - Generate a key with initialisation vector parameter derived from - the password, salt, and iteration count we are currently initialised - with. - - @param keySize the size of the key we want (in bits) - @param ivSize the size of the iv we want (in bits) - @return a ParametersWithIV object. - - - Generate a key parameter for use with a MAC derived from the password, - salt, and iteration count we are currently initialised with. - - @param keySize the size of the key we want (in bits) - @return a KeyParameter object. - - - Generator for Pbe derived keys and ivs as defined by Pkcs 5 V2.0 Scheme 1. - Note this generator is limited to the size of the hash produced by the - digest used to drive it. -

- The document this implementation is based on can be found at - - RSA's Pkcs5 Page -

-
- - Construct a Pkcs 5 Scheme 1 Parameters generator. - - @param digest the digest to be used as the source of derived keys. - - - the derived key function, the ith hash of the mPassword and the mSalt. - - - Generate a key parameter derived from the mPassword, mSalt, and iteration - count we are currently initialised with. - - @param keySize the size of the key we want (in bits) - @return a KeyParameter object. - @exception ArgumentException if the key length larger than the base hash size. - - - Generate a key with initialisation vector parameter derived from - the mPassword, mSalt, and iteration count we are currently initialised - with. - - @param keySize the size of the key we want (in bits) - @param ivSize the size of the iv we want (in bits) - @return a ParametersWithIV object. - @exception ArgumentException if keySize + ivSize is larger than the base hash size. - - - Generate a key parameter for use with a MAC derived from the mPassword, - mSalt, and iteration count we are currently initialised with. - - @param keySize the size of the key we want (in bits) - @return a KeyParameter object. - @exception ArgumentException if the key length larger than the base hash size. - - - Generator for Pbe derived keys and ivs as defined by Pkcs 5 V2.0 Scheme 2. - This generator uses a SHA-1 HMac as the calculation function. -

- The document this implementation is based on can be found at - - RSA's Pkcs5 Page

-
- - construct a Pkcs5 Scheme 2 Parameters generator. - - - Generate a key parameter derived from the password, salt, and iteration - count we are currently initialised with. - - @param keySize the size of the key we want (in bits) - @return a KeyParameter object. - - - Generate a key with initialisation vector parameter derived from - the password, salt, and iteration count we are currently initialised - with. - - @param keySize the size of the key we want (in bits) - @param ivSize the size of the iv we want (in bits) - @return a ParametersWithIV object. - - - Generate a key parameter for use with a MAC derived from the password, - salt, and iteration count we are currently initialised with. - - @param keySize the size of the key we want (in bits) - @return a KeyParameter object. - - - - Generates keys for the Poly1305 MAC. - - - Poly1305 keys are 256 bit keys consisting of a 128 bit secret key used for the underlying block - cipher followed by a 128 bit {@code r} value used for the polynomial portion of the Mac.
- The {@code r} value has a specific format with some bits required to be cleared, resulting in an - effective 106 bit key.
- A separately generated 256 bit key can be modified to fit the Poly1305 key format by using the - {@link #clamp(byte[])} method to clear the required bits. -
- -
- - - Initialises the key generator. - - - Poly1305 keys are always 256 bits, so the key length in the provided parameters is ignored. - - - - - Generates a 256 bit key in the format required for Poly1305 - e.g. - k[0] ... k[15], r[0] ... r[15] with the required bits in r cleared - as per . - - - - - Modifies an existing 32 byte key value to comply with the requirements of the Poly1305 key by - clearing required bits in the r (second 16 bytes) portion of the key.
- Specifically: -
    -
  • r[3], r[7], r[11], r[15] have top four bits clear (i.e., are {0, 1, . . . , 15})
  • -
  • r[4], r[8], r[12] have bottom two bits clear (i.e., are in {0, 4, 8, . . . , 252})
  • -
-
- a 32 byte key value k[0] ... k[15], r[0] ... r[15] -
- - - Checks a 32 byte key for compliance with the Poly1305 key requirements, e.g. - k[0] ... k[15], r[0] ... r[15] with the required bits in r cleared - as per . - - Key. - if the key is of the wrong length, or has invalid bits set - in the r portion of the key. - - - Generate a random factor suitable for use with RSA blind signatures - as outlined in Chaum's blinding and unblinding as outlined in - "Handbook of Applied Cryptography", page 475. - - - Initialise the factor generator - - @param param the necessary RSA key parameters. - - - Generate a suitable blind factor for the public key the generator was initialised with. - - @return a random blind factor - - - an RSA key pair generator. - - - Choose a random prime value for use with RSA - the bit-length of the returned prime - the RSA public exponent - a prime p, with (p-1) relatively prime to e - - - Implementation of the scrypt a password-based key derivation function. - - Scrypt was created by Colin Percival and is specified in - draft-josefsson-scrypt-kd. - - - - Generate a key using the scrypt key derivation function. - the bytes of the pass phrase. - the salt to use for this invocation. - CPU/Memory cost parameter. Must be larger than 1, a power of 2 and less than - 2^(128 * r / 8). - the block size, must be >= 1. - Parallelization parameter. Must be a positive integer less than or equal to - Int32.MaxValue / (128 * r * 8). - the length of the key to generate. - the generated key. - - - Base interface for mapping from an alphabet to a set of indexes - suitable for use with FPE. - - - - Return the number of characters in the alphabet. - - the radix for the alphabet. - - - - Return the passed in char[] as a byte array of indexes (indexes - can be more than 1 byte) - - an index array. - characters to be mapped. - - - - Return a char[] for this alphabet based on the indexes passed. - - an array of char corresponding to the index values. - input array of indexes. - - - Base interface for a public/private key block cipher. - - - The name of the algorithm this cipher implements. - - - Initialise the cipher. - Initialise for encryption if true, for decryption if false. - The key or other data required by the cipher. - - - The maximum size, in bytes, an input block may be. - - - The maximum size, in bytes, an output block will be. - - - Process a block. - The input buffer. - The offset into inBuf that the input block begins. - The length of the input block. - Input decrypts improperly. - Input is too large for the cipher. - - - interface that a public/private key pair generator should conform to. - - - intialise the key pair generator. - - @param the parameters the key pair is to be initialised with. - - - return an AsymmetricCipherKeyPair containing the Generated keys. - - @return an AsymmetricCipherKeyPair containing the Generated keys. - - - The basic interface that basic Diffie-Hellman implementations - conforms to. - - - initialise the agreement engine. - - - return the field size for the agreement algorithm in bytes. - - - given a public key from a given party calculate the next - message in the agreement sequence. - - - Base interface for a symmetric key block cipher. - - - The name of the algorithm this cipher implements. - - - Initialise the cipher. - Initialise for encryption if true, for decryption if false. - The key or other data required by the cipher. - - - The block size for this cipher, in bytes. - - - Indicates whether this cipher can handle partial blocks. - - - Process a block. - The input buffer. - The offset into inBuf that the input block begins. - The output buffer. - The offset into outBuf to write the output block. - If input block is wrong size, or outBuf too small. - The number of bytes processed and produced. - - - - Reset the cipher to the same state as it was after the last init (if there was one). - - - - - Operators that reduce their input to a single block return an object - of this type. - - - - - Return the final result of the operation. - - A block of bytes, representing the result of an operation. - - - - Store the final result of the operation by copying it into the destination array. - - The number of bytes copied into destination. - The byte array to copy the result into. - The offset into destination to start copying the result at. - - - Block cipher engines are expected to conform to this interface. - - - The name of the algorithm this cipher implements. - - - Initialise the cipher. - If true the cipher is initialised for encryption, - if false for decryption. - The key and other data required by the cipher. - - - - Reset the cipher. After resetting the cipher is in the same state - as it was after the last init (if there was one). - - - - - Base interface for a ciphers that do not require data to be block aligned. - - Note: In cases where the underlying algorithm is block based, these ciphers may add or remove padding as needed. - - - - - - Return the size of the output buffer required for a Write() plus a - close() with the write() being passed inputLen bytes. - - The returned size may be dependent on the initialisation of this cipher - and may not be accurate once subsequent input data is processed as the cipher may - add, add or remove padding, as it sees fit. - - - The space required to accommodate a call to processBytes and doFinal with inputLen bytes of input. - The length of the expected input. - - - - Return the size of the output buffer required for a write() with the write() being - passed inputLen bytes and just updating the cipher output. - - The space required to accommodate a call to processBytes with inputLen bytes of input. - The length of the expected input. - - - - Gets the stream for reading/writing data processed/to be processed. - - The stream associated with this cipher. - - - - Base interface for cipher builders. - - - - - Return the algorithm and parameter details associated with any cipher built. - - - - - Return the maximum output size that a given input will produce. - - the length of the expected input. - The maximum possible output size that can produced for the expected input length. - - - - Build a cipher that operates on the passed in stream. - - The stream to write/read any encrypted/decrypted data. - A cipher based around the given stream. - - - - A cipher builder that can also return the key it was initialized with. - - - - - Return the key we were initialized with. - - - - all parameter classes implement this. - - - - Interface describing a provider of cipher builders for creating decrypting ciphers. - - - - - Return a cipher builder for creating decrypting ciphers. - - The algorithm details/parameters to use to create the final cipher. - A new cipher builder. - - - base interface for general purpose byte derivation functions. - - - return the message digest used as the basis for the function - - - Parameters for key/byte stream derivation classes - - - interface that a message digest conforms to. - - - return the algorithm name - - @return the algorithm name - - - return the size, in bytes, of the digest produced by this message digest. - - @return the size, in bytes, of the digest produced by this message digest. - - - return the size, in bytes, of the internal buffer used by this digest. - - @return the size, in bytes, of the internal buffer used by this digest. - - - update the message digest with a single byte. - - @param inByte the input byte to be entered. - - - update the message digest with a block of bytes. - - @param input the byte array containing the data. - @param inOff the offset into the byte array where the data starts. - @param len the length of the data. - - - Close the digest, producing the final digest value. The doFinal - call leaves the digest reset. - - @param output the array the digest is to be copied into. - @param outOff the offset into the out array the digest is to start at. - - - reset the digest back to it's initial state. - - - - Base interface for operator factories that create stream-based digest calculators. - - - - The algorithm details object for calculators made by this factory. - - - Return the size of the digest associated with this factory. - The length of the digest produced by this calculators from this factory in bytes. - - - - Create a stream calculator for the digest associated with this factory. The stream - calculator is used for the actual operation of entering the data to be digested - and producing the digest block. - - A calculator producing an IBlockResult with the final digest in it. - - - interface for classes implementing the Digital Signature Algorithm - - - initialise the signer for signature generation or signature - verification. - - @param forSigning true if we are generating a signature, false - otherwise. - @param param key parameters for signature generation. - - - sign the passed in message (usually the output of a hash function). - - @param message the message to be signed. - @return two big integers representing the r and s values respectively. - - - verify the message message against the signature values r and s. - - @param message the message that was supposed to have been signed. - @param r the r signature value. - @param s the s signature value. - - - - An "extended" interface for classes implementing DSA-style algorithms, that provides access - to the group order. - - - - The order of the group that the r, s values in signatures belong to. - - - - Base interface describing an entropy source for a DRBG. - - - - - Return whether or not this entropy source is regarded as prediction resistant. - - true if this instance is prediction resistant; otherwise, false. - - - - Return a byte array of entropy. - - The entropy bytes. - - - - Return the number of bits of entropy this source can produce. - - The size, in bits, of the return value of getEntropy. - - - - Base interface describing a provider of entropy sources. - - - - - Return an entropy source providing a block of entropy. - - The size of the block of entropy required. - An entropy source providing bitsRequired blocks of entropy. - - - - Base interface for a key unwrapper. - - - - - The parameter set used to configure this key unwrapper. - - - - - Unwrap the passed in data. - - The array containing the data to be unwrapped. - The offset into cipherText at which the unwrapped data starts. - The length of the data to be unwrapped. - an IBlockResult containing the unwrapped key data. - - - - Base interface for a key wrapper. - - - - - The parameter set used to configure this key wrapper. - - - - - Wrap the passed in key data. - - The key data to be wrapped. - an IBlockResult containing the wrapped key data. - - - The base interface for implementations of message authentication codes (MACs). - - - Initialise the MAC. - - @param param the key and other data required by the MAC. - @exception ArgumentException if the parameters argument is - inappropriate. - - - Return the name of the algorithm the MAC implements. - - @return the name of the algorithm the MAC implements. - - - Return the block size for this MAC (in bytes). - - @return the block size for this MAC in bytes. - - - add a single byte to the mac for processing. - - @param in the byte to be processed. - @exception InvalidOperationException if the MAC is not initialised. - - - @param in the array containing the input. - @param inOff the index in the array the data begins at. - @param len the length of the input starting at inOff. - @exception InvalidOperationException if the MAC is not initialised. - @exception DataLengthException if there isn't enough data in in. - - - Compute the final stage of the MAC writing the output to the out - parameter. -

- doFinal leaves the MAC in the same state it was after the last init. -

- @param out the array the MAC is to be output to. - @param outOff the offset into the out buffer the output is to start at. - @exception DataLengthException if there isn't enough space in out. - @exception InvalidOperationException if the MAC is not initialised. -
- - Reset the MAC. At the end of resetting the MAC should be in the - in the same state it was after the last init (if there was one). - - - The algorithm details object for this calculator. - - - - Create a stream calculator for this signature calculator. The stream - calculator is used for the actual operation of entering the data to be signed - and producing the signature block. - - A calculator producing an IBlockResult with a signature in it. - - - this exception is thrown whenever we find something we don't expect in a - message. - - - base constructor. - - - create a InvalidCipherTextException with the given message. - - @param message the message to be carried with the exception. - - - - Base interface for operators that serve as stream-based signature calculators. - - - - The algorithm details object for this calculator. - - - - Create a stream calculator for this signature calculator. The stream - calculator is used for the actual operation of entering the data to be signed - and producing the signature block. - - A calculator producing an IBlockResult with a signature in it. - - - Return the name of the algorithm the signer implements. - - @return the name of the algorithm the signer implements. - - - Initialise the signer for signing or verification. - - @param forSigning true if for signing, false otherwise - @param param necessary parameters. - - - update the internal digest with the byte b - - - update the internal digest with the byte array in - - - Generate a signature for the message we've been loaded with using - the key we were initialised with. - - - return true if the internal state represents the signature described - in the passed in array. - - - reset the internal state - - - Signer with message recovery. - - - Returns true if the signer has recovered the full message as - part of signature verification. - - @return true if full message recovered. - - - Returns a reference to what message was recovered (if any). - - @return full/partial message, null if nothing. - - - Perform an update with the recovered message before adding any other data. This must - be the first update method called, and calling it will result in the signer assuming - that further calls to update will include message content past what is recoverable. - - @param signature the signature that we are in the process of verifying. - @throws IllegalStateException - - - - Base interface for cryptographic operations such as Hashes, MACs, and Signatures which reduce a stream of data - to a single value. - - - - Return a "sink" stream which only exists to update the implementing object. - A stream to write to in order to update the implementing object. - - - - Return the result of processing the stream. This value is only available once the stream - has been closed. - - The result of processing the stream. - - - The interface stream ciphers conform to. - - - The name of the algorithm this cipher implements. - - - Initialise the cipher. - If true the cipher is initialised for encryption, - if false for decryption. - The key and other data required by the cipher. - - If the parameters argument is inappropriate. - - - - encrypt/decrypt a single byte returning the result. - the byte to be processed. - the result of processing the input byte. - - - - Process a block of bytes from input putting the result into output. - - The input byte array. - - The offset into input where the data to be processed starts. - - The number of bytes to be processed. - The output buffer the processed bytes go into. - - The offset into output the processed data starts at. - - If the output buffer is too small. - - - - Reset the cipher to the same state as it was after the last init (if there was one). - - - - - Operators that reduce their input to the validation of a signature produce this type. - - - - - Return true if the passed in data matches what is expected by the verification result. - - The bytes representing the signature. - true if the signature verifies, false otherwise. - - - - Return true if the length bytes from off in the source array match the signature - expected by the verification result. - - Byte array containing the signature. - The offset into the source array where the signature starts. - The number of bytes in source making up the signature. - true if the signature verifies, false otherwise. - - - - Base interface for operators that serve as stream-based signature verifiers. - - - - The algorithm details object for this verifier. - - - - Create a stream calculator for this verifier. The stream - calculator is used for the actual operation of entering the data to be verified - and producing a result which can be used to verify the original signature. - - A calculator producing an IVerifier which can verify the signature. - - - - Base interface for a provider to support the dynamic creation of signature verifiers. - - - - - Return a signature verfier for signature algorithm described in the passed in algorithm details object. - - The details of the signature algorithm verification is required for. - A new signature verifier. - - - The name of the algorithm this cipher implements. - - - - With FIPS PUB 202 a new kind of message digest was announced which supported extendable output, or variable digest sizes. - This interface provides the extra method required to support variable output on a digest implementation. - - - - - Output the results of the final calculation for this digest to outLen number of bytes. - - output array to write the output bytes to. - offset to start writing the bytes at. - the number of output bytes requested. - the number of bytes written - - - - Start outputting the results of the final calculation for this digest. Unlike DoFinal, this method - will continue producing output until the Xof is explicitly reset, or signals otherwise. - - output array to write the output bytes to. - offset to start writing the bytes at. - the number of output bytes requested. - the number of bytes written - - - The base class for parameters to key generators. - - - initialise the generator with a source of randomness - and a strength (in bits). - - @param random the random byte source. - @param strength the size, in bits, of the keys we want to produce. - - - return the random source associated with this - generator. - - @return the generators random source. - - - return the bit strength for keys produced by this generator, - - @return the strength of the keys this generator produces (in bits). - - - standard CBC Block Cipher MAC - if no padding is specified the default of - pad of zeroes is used. - - - create a standard MAC based on a CBC block cipher. This will produce an - authentication code half the length of the block size of the cipher. - - @param cipher the cipher to be used as the basis of the MAC generation. - - - create a standard MAC based on a CBC block cipher. This will produce an - authentication code half the length of the block size of the cipher. - - @param cipher the cipher to be used as the basis of the MAC generation. - @param padding the padding to be used to complete the last block. - - - create a standard MAC based on a block cipher with the size of the - MAC been given in bits. This class uses CBC mode as the basis for the - MAC generation. -

- Note: the size of the MAC must be at least 24 bits (FIPS Publication 81), - or 16 bits if being used as a data authenticator (FIPS Publication 113), - and in general should be less than the size of the block cipher as it reduces - the chance of an exhaustive attack (see Handbook of Applied Cryptography). -

- @param cipher the cipher to be used as the basis of the MAC generation. - @param macSizeInBits the size of the MAC in bits, must be a multiple of 8. -
- - create a standard MAC based on a block cipher with the size of the - MAC been given in bits. This class uses CBC mode as the basis for the - MAC generation. -

- Note: the size of the MAC must be at least 24 bits (FIPS Publication 81), - or 16 bits if being used as a data authenticator (FIPS Publication 113), - and in general should be less than the size of the block cipher as it reduces - the chance of an exhaustive attack (see Handbook of Applied Cryptography). -

- @param cipher the cipher to be used as the basis of the MAC generation. - @param macSizeInBits the size of the MAC in bits, must be a multiple of 8. - @param padding the padding to be used to complete the last block. -
- - Reset the mac generator. - - - implements a Cipher-FeedBack (CFB) mode on top of a simple cipher. - - - Basic constructor. - - @param cipher the block cipher to be used as the basis of the - feedback mode. - @param blockSize the block size in bits (note: a multiple of 8) - - - Initialise the cipher and, possibly, the initialisation vector (IV). - If an IV isn't passed as part of the parameter, the IV will be all zeros. - An IV which is too short is handled in FIPS compliant fashion. - - @param param the key and other data required by the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - return the algorithm name and mode. - - @return the name of the underlying algorithm followed by "/CFB" - and the block size in bits. - - - return the block size we are operating at. - - @return the block size we are operating at (in bytes). - - - Process one block of input from the array in and write it to - the out array. - - @param in the array containing the input data. - @param inOff offset into the in array the data starts at. - @param out the array the output data will be copied into. - @param outOff the offset into the out array the output will start at. - @exception DataLengthException if there isn't enough data in in, or - space in out. - @exception InvalidOperationException if the cipher isn't initialised. - @return the number of bytes processed and produced. - - - reset the chaining vector back to the IV and reset the underlying - cipher. - - - create a standard MAC based on a CFB block cipher. This will produce an - authentication code half the length of the block size of the cipher, with - the CFB mode set to 8 bits. - - @param cipher the cipher to be used as the basis of the MAC generation. - - - create a standard MAC based on a CFB block cipher. This will produce an - authentication code half the length of the block size of the cipher, with - the CFB mode set to 8 bits. - - @param cipher the cipher to be used as the basis of the MAC generation. - @param padding the padding to be used. - - - create a standard MAC based on a block cipher with the size of the - MAC been given in bits. This class uses CFB mode as the basis for the - MAC generation. -

- Note: the size of the MAC must be at least 24 bits (FIPS Publication 81), - or 16 bits if being used as a data authenticator (FIPS Publication 113), - and in general should be less than the size of the block cipher as it reduces - the chance of an exhaustive attack (see Handbook of Applied Cryptography). -

- @param cipher the cipher to be used as the basis of the MAC generation. - @param cfbBitSize the size of an output block produced by the CFB mode. - @param macSizeInBits the size of the MAC in bits, must be a multiple of 8. -
- - create a standard MAC based on a block cipher with the size of the - MAC been given in bits. This class uses CFB mode as the basis for the - MAC generation. -

- Note: the size of the MAC must be at least 24 bits (FIPS Publication 81), - or 16 bits if being used as a data authenticator (FIPS Publication 113), - and in general should be less than the size of the block cipher as it reduces - the chance of an exhaustive attack (see Handbook of Applied Cryptography). -

- @param cipher the cipher to be used as the basis of the MAC generation. - @param cfbBitSize the size of an output block produced by the CFB mode. - @param macSizeInBits the size of the MAC in bits, must be a multiple of 8. - @param padding a padding to be used. -
- - Reset the mac generator. - - - CMAC - as specified at www.nuee.nagoya-u.ac.jp/labs/tiwata/omac/omac.html -

- CMAC is analogous to OMAC1 - see also en.wikipedia.org/wiki/CMAC -

- CMAC is a NIST recomendation - see - csrc.nist.gov/CryptoToolkit/modes/800-38_Series_Publications/SP800-38B.pdf -

- CMAC/OMAC1 is a blockcipher-based message authentication code designed and - analyzed by Tetsu Iwata and Kaoru Kurosawa. -

- CMAC/OMAC1 is a simple variant of the CBC MAC (Cipher Block Chaining Message - Authentication Code). OMAC stands for One-Key CBC MAC. -

- It supports 128- or 64-bits block ciphers, with any key size, and returns - a MAC with dimension less or equal to the block size of the underlying - cipher. -

-
- - create a standard MAC based on a CBC block cipher (64 or 128 bit block). - This will produce an authentication code the length of the block size - of the cipher. - - @param cipher the cipher to be used as the basis of the MAC generation. - - - create a standard MAC based on a block cipher with the size of the - MAC been given in bits. -

- Note: the size of the MAC must be at least 24 bits (FIPS Publication 81), - or 16 bits if being used as a data authenticator (FIPS Publication 113), - and in general should be less than the size of the block cipher as it reduces - the chance of an exhaustive attack (see Handbook of Applied Cryptography). - - @param cipher the cipher to be used as the basis of the MAC generation. - @param macSizeInBits the size of the MAC in bits, must be a multiple of 8 and @lt;= 128. - - - Reset the mac generator. - - -

- Implementation of DSTU7564 mac mode - -
- - implementation of DSTU 7624 MAC - - - - The GMAC specialisation of Galois/Counter mode (GCM) detailed in NIST Special Publication - 800-38D. - - - GMac is an invocation of the GCM mode where no data is encrypted (i.e. all input data to the Mac - is processed as additional authenticated data with the underlying GCM block cipher). - - - - - Creates a GMAC based on the operation of a block cipher in GCM mode. - - - This will produce an authentication code the length of the block size of the cipher. - - the cipher to be used in GCM mode to generate the MAC. - - - - Creates a GMAC based on the operation of a 128 bit block cipher in GCM mode. - - - This will produce an authentication code the length of the block size of the cipher. - - the cipher to be used in GCM mode to generate the MAC. - the mac size to generate, in bits. Must be a multiple of 8, between 32 and 128 (inclusive). - Sizes less than 96 are not recommended, but are supported for specialized applications. - - - - Initialises the GMAC - requires a - providing a and a nonce. - - - - implementation of GOST 28147-89 MAC - - - HMAC implementation based on RFC2104 - - H(K XOR opad, H(K XOR ipad, text)) - - - Reset the mac generator. - - - DES based CBC Block Cipher MAC according to ISO9797, algorithm 3 (ANSI X9.19 Retail MAC) - - This could as well be derived from CBCBlockCipherMac, but then the property mac in the base - class must be changed to protected - - - create a Retail-MAC based on a CBC block cipher. This will produce an - authentication code of the length of the block size of the cipher. - - @param cipher the cipher to be used as the basis of the MAC generation. This must - be DESEngine. - - - create a Retail-MAC based on a CBC block cipher. This will produce an - authentication code of the length of the block size of the cipher. - - @param cipher the cipher to be used as the basis of the MAC generation. - @param padding the padding to be used to complete the last block. - - - create a Retail-MAC based on a block cipher with the size of the - MAC been given in bits. This class uses single DES CBC mode as the basis for the - MAC generation. -

- Note: the size of the MAC must be at least 24 bits (FIPS Publication 81), - or 16 bits if being used as a data authenticator (FIPS Publication 113), - and in general should be less than the size of the block cipher as it reduces - the chance of an exhaustive attack (see Handbook of Applied Cryptography). -

- @param cipher the cipher to be used as the basis of the MAC generation. - @param macSizeInBits the size of the MAC in bits, must be a multiple of 8. -
- - create a standard MAC based on a block cipher with the size of the - MAC been given in bits. This class uses single DES CBC mode as the basis for the - MAC generation. The final block is decrypted and then encrypted using the - middle and right part of the key. -

- Note: the size of the MAC must be at least 24 bits (FIPS Publication 81), - or 16 bits if being used as a data authenticator (FIPS Publication 113), - and in general should be less than the size of the block cipher as it reduces - the chance of an exhaustive attack (see Handbook of Applied Cryptography). -

- @param cipher the cipher to be used as the basis of the MAC generation. - @param macSizeInBits the size of the MAC in bits, must be a multiple of 8. - @param padding the padding to be used to complete the last block. -
- - Reset the mac generator. - - - - Poly1305 message authentication code, designed by D. J. Bernstein. - - - Poly1305 computes a 128-bit (16 bytes) authenticator, using a 128 bit nonce and a 256 bit key - consisting of a 128 bit key applied to an underlying cipher, and a 128 bit key (with 106 - effective key bits) used in the authenticator. - - The polynomial calculation in this implementation is adapted from the public domain poly1305-donna-unrolled C implementation - by Andrew M (@floodyberry). - - - - - Polynomial key - - - Polynomial key - - - Polynomial key - - - Polynomial key - - - Polynomial key - - - Precomputed 5 * r[1..4] - - - Precomputed 5 * r[1..4] - - - Precomputed 5 * r[1..4] - - - Precomputed 5 * r[1..4] - - - Encrypted nonce - - - Encrypted nonce - - - Encrypted nonce - - - Encrypted nonce - - - Current block of buffered input - - - Current offset in input buffer - - - Polynomial accumulator - - - Polynomial accumulator - - - Polynomial accumulator - - - Polynomial accumulator - - - Polynomial accumulator - - - Constructs a Poly1305 MAC, where the key passed to init() will be used directly. - - - Constructs a Poly1305 MAC, using a 128 bit block cipher. - - - - Initialises the Poly1305 MAC. - - a {@link ParametersWithIV} containing a 128 bit nonce and a {@link KeyParameter} with - a 256 bit key complying to the {@link Poly1305KeyGenerator Poly1305 key format}. - - - - Implementation of SipHash as specified in "SipHash: a fast short-input PRF", by Jean-Philippe - Aumasson and Daniel J. Bernstein (https://131002.net/siphash/siphash.pdf). - - - "SipHash is a family of PRFs SipHash-c-d where the integer parameters c and d are the number of - compression rounds and the number of finalization rounds. A compression round is identical to a - finalization round and this round function is called SipRound. Given a 128-bit key k and a - (possibly empty) byte string m, SipHash-c-d returns a 64-bit value..." - - - - SipHash-2-4 - - - SipHash-c-d - the number of compression rounds - the number of finalization rounds - - - - Implementation of the Skein parameterised MAC function in 256, 512 and 1024 bit block sizes, - based on the Threefish tweakable block cipher. - - - This is the 1.3 version of Skein defined in the Skein hash function submission to the NIST SHA-3 - competition in October 2010. -

- Skein was designed by Niels Ferguson - Stefan Lucks - Bruce Schneier - Doug Whiting - Mihir - Bellare - Tadayoshi Kohno - Jon Callas - Jesse Walker. - - - - - -

- 256 bit block size - Skein-256 - -
- - - 512 bit block size - Skein-512 - - - - - 1024 bit block size - Skein-1024 - - - - - Constructs a Skein MAC with an internal state size and output size. - - the internal state size in bits - one of or - . - the output/MAC size to produce in bits, which must be an integral number of - bytes. - - - - Optionally initialises the Skein digest with the provided parameters. - - See for details on the parameterisation of the Skein hash function. - the parameters to apply to this engine, or null to use no parameters. - - - - This exception is thrown whenever a cipher requires a change of key, iv - or similar after x amount of bytes enciphered - - - - implements Cipher-Block-Chaining (CBC) mode on top of a simple cipher. - - - Basic constructor. - - @param cipher the block cipher to be used as the basis of chaining. - - - return the underlying block cipher that we are wrapping. - - @return the underlying block cipher that we are wrapping. - - - Initialise the cipher and, possibly, the initialisation vector (IV). - If an IV isn't passed as part of the parameter, the IV will be all zeros. - - @param forEncryption if true the cipher is initialised for - encryption, if false for decryption. - @param param the key and other data required by the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - return the algorithm name and mode. - - @return the name of the underlying algorithm followed by "/CBC". - - - return the block size of the underlying cipher. - - @return the block size of the underlying cipher. - - - Process one block of input from the array in and write it to - the out array. - - @param in the array containing the input data. - @param inOff offset into the in array the data starts at. - @param out the array the output data will be copied into. - @param outOff the offset into the out array the output will start at. - @exception DataLengthException if there isn't enough data in in, or - space in out. - @exception InvalidOperationException if the cipher isn't initialised. - @return the number of bytes processed and produced. - - - reset the chaining vector back to the IV and reset the underlying - cipher. - - - Do the appropriate chaining step for CBC mode encryption. - - @param in the array containing the data to be encrypted. - @param inOff offset into the in array the data starts at. - @param out the array the encrypted data will be copied into. - @param outOff the offset into the out array the output will start at. - @exception DataLengthException if there isn't enough data in in, or - space in out. - @exception InvalidOperationException if the cipher isn't initialised. - @return the number of bytes processed and produced. - - - Do the appropriate chaining step for CBC mode decryption. - - @param in the array containing the data to be decrypted. - @param inOff offset into the in array the data starts at. - @param out the array the decrypted data will be copied into. - @param outOff the offset into the out array the output will start at. - @exception DataLengthException if there isn't enough data in in, or - space in out. - @exception InvalidOperationException if the cipher isn't initialised. - @return the number of bytes processed and produced. - - - Implements the Counter with Cipher Block Chaining mode (CCM) detailed in - NIST Special Publication 800-38C. -

- Note: this mode is a packet mode - it needs all the data up front. -

-
- - Basic constructor. - - @param cipher the block cipher to be used. - - - return the underlying block cipher that we are wrapping. - - @return the underlying block cipher that we are wrapping. - - - Returns a byte array containing the mac calculated as part of the - last encrypt or decrypt operation. - - @return the last mac calculated. - - - Process a packet of data for either CCM decryption or encryption. - - @param in data for processing. - @param inOff offset at which data starts in the input array. - @param inLen length of the data in the input array. - @return a byte array containing the processed input.. - @throws IllegalStateException if the cipher is not appropriately set up. - @throws InvalidCipherTextException if the input data is truncated or the mac check fails. - - - Process a packet of data for either CCM decryption or encryption. - - @param in data for processing. - @param inOff offset at which data starts in the input array. - @param inLen length of the data in the input array. - @param output output array. - @param outOff offset into output array to start putting processed bytes. - @return the number of bytes added to output. - @throws IllegalStateException if the cipher is not appropriately set up. - @throws InvalidCipherTextException if the input data is truncated or the mac check fails. - @throws DataLengthException if output buffer too short. - - - implements a Cipher-FeedBack (CFB) mode on top of a simple cipher. - - - Basic constructor. - - @param cipher the block cipher to be used as the basis of the - feedback mode. - @param blockSize the block size in bits (note: a multiple of 8) - - - return the underlying block cipher that we are wrapping. - - @return the underlying block cipher that we are wrapping. - - - Initialise the cipher and, possibly, the initialisation vector (IV). - If an IV isn't passed as part of the parameter, the IV will be all zeros. - An IV which is too short is handled in FIPS compliant fashion. - - @param forEncryption if true the cipher is initialised for - encryption, if false for decryption. - @param param the key and other data required by the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - return the algorithm name and mode. - - @return the name of the underlying algorithm followed by "/CFB" - and the block size in bits. - - - return the block size we are operating at. - - @return the block size we are operating at (in bytes). - - - Process one block of input from the array in and write it to - the out array. - - @param in the array containing the input data. - @param inOff offset into the in array the data starts at. - @param out the array the output data will be copied into. - @param outOff the offset into the out array the output will start at. - @exception DataLengthException if there isn't enough data in in, or - space in out. - @exception InvalidOperationException if the cipher isn't initialised. - @return the number of bytes processed and produced. - - - Do the appropriate processing for CFB mode encryption. - - @param in the array containing the data to be encrypted. - @param inOff offset into the in array the data starts at. - @param out the array the encrypted data will be copied into. - @param outOff the offset into the out array the output will start at. - @exception DataLengthException if there isn't enough data in in, or - space in out. - @exception InvalidOperationException if the cipher isn't initialised. - @return the number of bytes processed and produced. - - - Do the appropriate processing for CFB mode decryption. - - @param in the array containing the data to be decrypted. - @param inOff offset into the in array the data starts at. - @param out the array the encrypted data will be copied into. - @param outOff the offset into the out array the output will start at. - @exception DataLengthException if there isn't enough data in in, or - space in out. - @exception InvalidOperationException if the cipher isn't initialised. - @return the number of bytes processed and produced. - - - reset the chaining vector back to the IV and reset the underlying - cipher. - - - A Cipher Text Stealing (CTS) mode cipher. CTS allows block ciphers to - be used to produce cipher text which is the same outLength as the plain text. - - - Create a buffered block cipher that uses Cipher Text Stealing - - @param cipher the underlying block cipher this buffering object wraps. - - - return the size of the output buffer required for an update of 'length' bytes. - - @param length the outLength of the input. - @return the space required to accommodate a call to update - with length bytes of input. - - - return the size of the output buffer required for an update plus a - doFinal with an input of length bytes. - - @param length the outLength of the input. - @return the space required to accommodate a call to update and doFinal - with length bytes of input. - - - process a single byte, producing an output block if necessary. - - @param in the input byte. - @param out the space for any output that might be produced. - @param outOff the offset from which the output will be copied. - @return the number of output bytes copied to out. - @exception DataLengthException if there isn't enough space in out. - @exception InvalidOperationException if the cipher isn't initialised. - - - process an array of bytes, producing output if necessary. - - @param in the input byte array. - @param inOff the offset at which the input data starts. - @param length the number of bytes to be copied out of the input array. - @param out the space for any output that might be produced. - @param outOff the offset from which the output will be copied. - @return the number of output bytes copied to out. - @exception DataLengthException if there isn't enough space in out. - @exception InvalidOperationException if the cipher isn't initialised. - - - Process the last block in the buffer. - - @param out the array the block currently being held is copied into. - @param outOff the offset at which the copying starts. - @return the number of output bytes copied to out. - @exception DataLengthException if there is insufficient space in out for - the output. - @exception InvalidOperationException if the underlying cipher is not - initialised. - @exception InvalidCipherTextException if cipher text decrypts wrongly (in - case the exception will never Get thrown). - - - A Two-Pass Authenticated-Encryption Scheme Optimized for Simplicity and - Efficiency - by M. Bellare, P. Rogaway, D. Wagner. - - http://www.cs.ucdavis.edu/~rogaway/papers/eax.pdf - - EAX is an AEAD scheme based on CTR and OMAC1/CMAC, that uses a single block - cipher to encrypt and authenticate data. It's on-line (the length of a - message isn't needed to begin processing it), has good performances, it's - simple and provably secure (provided the underlying block cipher is secure). - - Of course, this implementations is NOT thread-safe. - - - Constructor that accepts an instance of a block cipher engine. - - @param cipher the engine to use - - - - Implements the Galois/Counter mode (GCM) detailed in - NIST Special Publication 800-38D. - - - - - MAC sizes from 32 bits to 128 bits (must be a multiple of 8) are supported. The default is 128 bits. - Sizes less than 96 are not recommended, but are supported for specialized applications. - - - - GCM-SIV Mode. -

It should be noted that the specified limit of 236 bytes is not supported. This is because all bytes are - cached in a ByteArrayOutputStream object (which has a limit of a little less than 231 bytes), - and are output on the DoFinal() call (which can only process a maximum of 231 bytes).

-

The practical limit of 231 - 24 bytes is policed, and attempts to breach the limit will be rejected

-

In order to properly support the higher limit, an extended form of ByteArrayOutputStream would be needed - which would use multiple arrays to store the data. In addition, a new doOutput method would be required (similar - to that in XOF digests), which would allow the data to be output over multiple calls. Alternatively an extended - form of ByteArrayInputStream could be used to deliver the data.

-
- - The buffer length. - - - The halfBuffer length. - - - The nonce length. - - - The maximum data length (AEAD/PlainText). Due to implementation constraints this is restricted to the maximum - array length (https://programming.guide/java/array-maximum-length.html) minus the BUFLEN to allow for the MAC - - - The top bit mask. - - - The addition constant. - - - The initialisation flag. - - - The aeadComplete flag. - - - The cipher. - - - The multiplier. - - - The gHash buffer. - - - The reverse buffer. - - - The aeadHasher. - - - The dataHasher. - - - The plainDataStream. - - - The encryptedDataStream (decryption only). - - - Are we encrypting? - - - The initialAEAD. - - - The nonce. - - - The flags. - - - Constructor. - - - Constructor. - @param pCipher the underlying cipher - - - Constructor. - @param pCipher the underlying cipher - @param pMultiplier the multiplier - - - check AEAD status. - @param pLen the aeadLength - - - check status. - @param pLen the dataLength - - - Reset Streams. - - - Obtain buffer length (allowing for null). - @param pBuffer the buffere - @return the length - - - Check buffer. - @param pBuffer the buffer - @param pOffset the offset - @param pLen the length - @param pOutput is this an output buffer? - - - encrypt data stream. - @param pCounter the counter - @param pTarget the target buffer - @param pOffset the target offset - @return the length of data encrypted - - - decrypt data stream. - @throws InvalidCipherTextException on data too short or mac check failed - - - calculate tag. - @return the calculated tag - - - complete polyVAL. - @return the calculated value - - - process lengths. - - - perform the next GHASH step. - @param pNext the next value - - - - xor a full block buffer. - @param pLeft the left operand and result - @param pRight the right operand - - - xor a partial block buffer. - @param pLeft the left operand and result - @param pRight the right operand - @param pOffset the offset in the right operand - @param pLength the length of data in the right operand - - - increment the counter. - @param pCounter the counter to increment - - - multiply by X. - @param pValue the value to adjust - - - Derive Keys. - @param pKey the keyGeneration key - - - Hash Control. - - - Cache. - - - Single byte cache. - - - Count of active bytes in cache. - - - Count of hashed bytes. - - - Obtain the count of bytes hashed. - @return the count - - - Reset the hasher. - - - update hash. - @param pByte the byte - - - update hash. - @param pBuffer the buffer - @param pOffset the offset within the buffer - @param pLen the length of data - - - complete hash. - - - implements the GOST 28147 OFB counter mode (GCTR). - - - Basic constructor. - - @param cipher the block cipher to be used as the basis of the - counter mode (must have a 64 bit block size). - - - return the underlying block cipher that we are wrapping. - - @return the underlying block cipher that we are wrapping. - - - Initialise the cipher and, possibly, the initialisation vector (IV). - If an IV isn't passed as part of the parameter, the IV will be all zeros. - An IV which is too short is handled in FIPS compliant fashion. - - @param encrypting if true the cipher is initialised for - encryption, if false for decryption. - @param parameters the key and other data required by the cipher. - @exception ArgumentException if the parameters argument is inappropriate. - - - return the algorithm name and mode. - - @return the name of the underlying algorithm followed by "/GCTR" - and the block size in bits - - - return the block size we are operating at (in bytes). - - @return the block size we are operating at (in bytes). - - - Process one block of input from the array in and write it to - the out array. - - @param in the array containing the input data. - @param inOff offset into the in array the data starts at. - @param out the array the output data will be copied into. - @param outOff the offset into the out array the output will start at. - @exception DataLengthException if there isn't enough data in in, or - space in out. - @exception InvalidOperationException if the cipher isn't initialised. - @return the number of bytes processed and produced. - - - reset the feedback vector back to the IV and reset the underlying - cipher. - - - An IAeadCipher based on an IBlockCipher. - - - The block size for this cipher, in bytes. - - - The block cipher underlying this algorithm. - - - - A cipher mode that includes authenticated encryption with a streaming mode and optional - associated data. - - - Implementations of this interface may operate in a packet mode (where all input data is - buffered and processed during the call to DoFinal, or in a streaming mode (where output - data is incrementally produced with each call to ProcessByte or ProcessBytes. This is - important to consider during decryption: in a streaming mode, unauthenticated plaintext - data may be output prior to the call to DoFinal that results in an authentication failure. - The higher level protocol utilising this cipher must ensure the plaintext data is handled - appropriately until the end of data is reached and the entire ciphertext is authenticated. - - - - - The name of the algorithm this cipher implements. - - - Initialise the cipher. - Parameter can either be an AeadParameters or a ParametersWithIV object. - Initialise for encryption if true, for decryption if false. - The key or other data required by the cipher. - - - Add a single byte to the associated data check. - If the implementation supports it, this will be an online operation and will not retain the associated data. - The byte to be processed. - - - Add a sequence of bytes to the associated data check. - If the implementation supports it, this will be an online operation and will not retain the associated data. - The input byte array. - The offset into the input array where the data to be processed starts. - The number of bytes to be processed. - - - Encrypt/decrypt a single byte. - - @param input the byte to be processed. - @param outBytes the output buffer the processed byte goes into. - @param outOff the offset into the output byte array the processed data starts at. - @return the number of bytes written to out. - @exception DataLengthException if the output buffer is too small. - - - Process a block of bytes from in putting the result into out. - - @param inBytes the input byte array. - @param inOff the offset into the in array where the data to be processed starts. - @param len the number of bytes to be processed. - @param outBytes the output buffer the processed bytes go into. - @param outOff the offset into the output byte array the processed data starts at. - @return the number of bytes written to out. - @exception DataLengthException if the output buffer is too small. - - - Finish the operation either appending or verifying the MAC at the end of the data. - - @param outBytes space for any resulting output data. - @param outOff offset into out to start copying the data at. - @return number of bytes written into out. - @throws InvalidOperationException if the cipher is in an inappropriate state. - @throws InvalidCipherTextException if the MAC fails to match. - - - Return the value of the MAC associated with the last stream processed. - - @return MAC for plaintext data. - - - Return the size of the output buffer required for a ProcessBytes - an input of len bytes. - - @param len the length of the input. - @return the space required to accommodate a call to ProcessBytes - with len bytes of input. - - - Return the size of the output buffer required for a ProcessBytes plus a - DoFinal with an input of len bytes. - - @param len the length of the input. - @return the space required to accommodate a call to ProcessBytes and DoFinal - with len bytes of input. - - - - Reset the cipher to the same state as it was after the last init (if there was one). - - - - - Base constructor. Nb value is set to 4. - - base cipher to use under CCM. - - - - Constructor allowing Nb configuration. - - Nb is a parameter specified in CCM mode of DSTU7624 standard. - This parameter specifies maximum possible length of input.It should - be calculated as follows: Nb = 1 / 8 * (-3 + log[2]Nmax) + 1, - where Nmax - length of input message in bits.For practical reasons - Nmax usually less than 4Gb, e.g. for Nmax = 2^32 - 1, Nb = 4. - - base cipher to use under CCM. - Nb value to use. - - - Implements a Gamming or Counter (CTR) mode on top of a DSTU 7624 block cipher. - - - Basic constructor. - - @param cipher the block cipher to be used as the basis of the - feedback mode. - - - return the underlying block cipher that we are wrapping. - - @return the underlying block cipher that we are wrapping. - - - Initialise the cipher and, possibly, the initialisation vector (IV). - If an IV isn't passed as part of the parameter, the IV will be all zeros. - An IV which is too short is handled in FIPS compliant fashion. - - @param forEncryption if true the cipher is initialised for - encryption, if false for decryption. - @param param the key and other data required by the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - return the algorithm name and mode. - - @return the name of the underlying algorithm followed by "/KCTR" - and the block size in bits. - - - return the block size we are operating at. - - @return the block size we are operating at (in bytes). - - - Process one block of input from the array in and write it to - the out array. - - @param input the array containing the input data. - @param inOff offset into the in array the data starts at. - @param output the array the output data will be copied into. - @param outOff the offset into the out array the output will start at. - @exception DataLengthException if there isn't enough data in in, or - space in out. - @exception InvalidOperationException if the cipher isn't initialised. - @return the number of bytes processed and produced. - - - reset the chaining vector back to the IV and reset the underlying - cipher. - - - An implementation of RFC 7253 on The OCB - Authenticated-Encryption Algorithm, licensed per: - -

License for - Open-Source Software Implementations of OCB (Jan 9, 2013) - 'License 1'
- Under this license, you are authorized to make, use, and distribute open-source software - implementations of OCB. This license terminates for you if you sue someone over their open-source - software implementation of OCB claiming that you have a patent covering their implementation. -

- This is a non-binding summary of a legal document (the link above). The parameters of the license - are specified in the license document and that document is controlling.

-
- - implements a Output-FeedBack (OFB) mode on top of a simple cipher. - - - Basic constructor. - - @param cipher the block cipher to be used as the basis of the - feedback mode. - @param blockSize the block size in bits (note: a multiple of 8) - - - return the underlying block cipher that we are wrapping. - - @return the underlying block cipher that we are wrapping. - - - Initialise the cipher and, possibly, the initialisation vector (IV). - If an IV isn't passed as part of the parameter, the IV will be all zeros. - An IV which is too short is handled in FIPS compliant fashion. - - @param forEncryption if true the cipher is initialised for - encryption, if false for decryption. - @param param the key and other data required by the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - return the algorithm name and mode. - - @return the name of the underlying algorithm followed by "/OFB" - and the block size in bits - - - return the block size we are operating at (in bytes). - - @return the block size we are operating at (in bytes). - - - Process one block of input from the array in and write it to - the out array. - - @param in the array containing the input data. - @param inOff offset into the in array the data starts at. - @param out the array the output data will be copied into. - @param outOff the offset into the out array the output will start at. - @exception DataLengthException if there isn't enough data in in, or - space in out. - @exception InvalidOperationException if the cipher isn't initialised. - @return the number of bytes processed and produced. - - - reset the feedback vector back to the IV and reset the underlying - cipher. - - - * Implements OpenPGP's rather strange version of Cipher-FeedBack (CFB) mode - * on top of a simple cipher. This class assumes the IV has been prepended - * to the data stream already, and just accomodates the reset after - * (blockSize + 2) bytes have been read. - *

- * For further info see RFC 2440. - *

-
- - Basic constructor. - - @param cipher the block cipher to be used as the basis of the - feedback mode. - - - return the underlying block cipher that we are wrapping. - - @return the underlying block cipher that we are wrapping. - - - return the algorithm name and mode. - - @return the name of the underlying algorithm followed by "/PGPCFB" - and the block size in bits. - - - return the block size we are operating at. - - @return the block size we are operating at (in bytes). - - - Process one block of input from the array in and write it to - the out array. - - @param in the array containing the input data. - @param inOff offset into the in array the data starts at. - @param out the array the output data will be copied into. - @param outOff the offset into the out array the output will start at. - @exception DataLengthException if there isn't enough data in in, or - space in out. - @exception InvalidOperationException if the cipher isn't initialised. - @return the number of bytes processed and produced. - - - reset the chaining vector back to the IV and reset the underlying - cipher. - - - Initialise the cipher and, possibly, the initialisation vector (IV). - If an IV isn't passed as part of the parameter, the IV will be all zeros. - An IV which is too short is handled in FIPS compliant fashion. - - @param forEncryption if true the cipher is initialised for - encryption, if false for decryption. - @param parameters the key and other data required by the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - Encrypt one byte of data according to CFB mode. - @param data the byte to encrypt - @param blockOff offset in the current block - @returns the encrypted byte - - - Do the appropriate processing for CFB IV mode encryption. - - @param in the array containing the data to be encrypted. - @param inOff offset into the in array the data starts at. - @param out the array the encrypted data will be copied into. - @param outOff the offset into the out array the output will start at. - @exception DataLengthException if there isn't enough data in in, or - space in out. - @exception InvalidOperationException if the cipher isn't initialised. - @return the number of bytes processed and produced. - - - Do the appropriate processing for CFB IV mode decryption. - - @param in the array containing the data to be decrypted. - @param inOff offset into the in array the data starts at. - @param out the array the encrypted data will be copied into. - @param outOff the offset into the out array the output will start at. - @exception DataLengthException if there isn't enough data in in, or - space in out. - @exception InvalidOperationException if the cipher isn't initialised. - @return the number of bytes processed and produced. - - - Implements the Segmented Integer Counter (SIC) mode on top of a simple - block cipher. - - - Basic constructor. - - @param c the block cipher to be used. - - - return the underlying block cipher that we are wrapping. - - @return the underlying block cipher that we are wrapping. - - - Return the digest algorithm using one of the standard JCA string - representations rather than the algorithm identifier (if possible). - - - - Calculator factory class for signature generation in ASN.1 based profiles that use an AlgorithmIdentifier to preserve - signature algorithm details. - - - - - Base constructor. - - The name of the signature algorithm to use. - The private key to be used in the signing operation. - - - - Constructor which also specifies a source of randomness to be used if one is required. - - The name of the signature algorithm to use. - The private key to be used in the signing operation. - The source of randomness to be used in signature calculation. - - - - Allows enumeration of the signature names supported by the verifier provider. - - - - - Verifier class for signature verification in ASN.1 based profiles that use an AlgorithmIdentifier to preserve - signature algorithm details. - - - - - Base constructor. - - The name of the signature algorithm to use. - The public key to be used in the verification operation. - - - - Provider class which supports dynamic creation of signature verifiers. - - - - - Base constructor - specify the public key to be used in verification. - - The public key to be used in creating verifiers provided by this object. - - - - Allows enumeration of the signature names supported by the verifier provider. - - - - Block cipher padders are expected to conform to this interface - - - Initialise the padder. - - @param param parameters, if any required. - - - Return the name of the algorithm the cipher implements. - - @return the name of the algorithm the cipher implements. - - - add the pad bytes to the passed in block, returning the - number of bytes added. - - - return the number of pad bytes present in the block. - @exception InvalidCipherTextException if the padding is badly formed - or invalid. - - - A padder that adds ISO10126-2 padding to a block. - - - Initialise the padder. - - @param random a SecureRandom if available. - - - Return the name of the algorithm the cipher implements. - - @return the name of the algorithm the cipher implements. - - - add the pad bytes to the passed in block, returning the - number of bytes added. - - - return the number of pad bytes present in the block. - - - A padder that adds the padding according to the scheme referenced in - ISO 7814-4 - scheme 2 from ISO 9797-1. The first byte is 0x80, rest is 0x00 - - - Initialise the padder. - - @param random - a SecureRandom if available. - - - Return the name of the algorithm the padder implements. - - @return the name of the algorithm the padder implements. - - - add the pad bytes to the passed in block, returning the - number of bytes added. - - - return the number of pad bytes present in the block. - - - A wrapper class that allows block ciphers to be used to process data in - a piecemeal fashion with padding. The PaddedBufferedBlockCipher - outputs a block only when the buffer is full and more data is being added, - or on a doFinal (unless the current block in the buffer is a pad block). - The default padding mechanism used is the one outlined in Pkcs5/Pkcs7. - - - Create a buffered block cipher with the desired padding. - - @param cipher the underlying block cipher this buffering object wraps. - @param padding the padding type. - - - Create a buffered block cipher Pkcs7 padding - - @param cipher the underlying block cipher this buffering object wraps. - - - initialise the cipher. - - @param forEncryption if true the cipher is initialised for - encryption, if false for decryption. - @param param the key and other data required by the cipher. - @exception ArgumentException if the parameters argument is - inappropriate. - - - return the minimum size of the output buffer required for an update - plus a doFinal with an input of len bytes. - - @param len the length of the input. - @return the space required to accommodate a call to update and doFinal - with len bytes of input. - - - return the size of the output buffer required for an update - an input of len bytes. - - @param len the length of the input. - @return the space required to accommodate a call to update - with len bytes of input. - - - process a single byte, producing an output block if necessary. - - @param in the input byte. - @param out the space for any output that might be produced. - @param outOff the offset from which the output will be copied. - @return the number of output bytes copied to out. - @exception DataLengthException if there isn't enough space in out. - @exception InvalidOperationException if the cipher isn't initialised. - - - process an array of bytes, producing output if necessary. - - @param in the input byte array. - @param inOff the offset at which the input data starts. - @param len the number of bytes to be copied out of the input array. - @param out the space for any output that might be produced. - @param outOff the offset from which the output will be copied. - @return the number of output bytes copied to out. - @exception DataLengthException if there isn't enough space in out. - @exception InvalidOperationException if the cipher isn't initialised. - - - Process the last block in the buffer. If the buffer is currently - full and padding needs to be added a call to doFinal will produce - 2 * GetBlockSize() bytes. - - @param out the array the block currently being held is copied into. - @param outOff the offset at which the copying starts. - @return the number of output bytes copied to out. - @exception DataLengthException if there is insufficient space in out for - the output or we are decrypting and the input is not block size aligned. - @exception InvalidOperationException if the underlying cipher is not - initialised. - @exception InvalidCipherTextException if padding is expected and not found. - - - A padder that adds Pkcs7/Pkcs5 padding to a block. - - - Initialise the padder. - - @param random - a SecureRandom if available. - - - Return the name of the algorithm the cipher implements. - - @return the name of the algorithm the cipher implements. - - - add the pad bytes to the passed in block, returning the - number of bytes added. - - - return the number of pad bytes present in the block. - - - A padder that adds Trailing-Bit-Compliment padding to a block. -

- This padding pads the block out compliment of the last bit - of the plain text. -

-
-
- - Return the name of the algorithm the cipher implements. - the name of the algorithm the cipher implements. - - - - Initialise the padder. - - a SecureRandom if available. - - - - add the pad bytes to the passed in block, returning the - number of bytes added. -

- Note: this assumes that the last block of plain text is always - passed to it inside in. i.e. if inOff is zero, indicating the - entire block is to be overwritten with padding the value of in - should be the same as the last block of plain text. -

-
-
- - return the number of pad bytes present in the block. - - - A padder that adds X9.23 padding to a block - if a SecureRandom is - passed in random padding is assumed, otherwise padding with zeros is used. - - - Initialise the padder. - - @param random a SecureRandom if one is available. - - - Return the name of the algorithm the cipher implements. - - @return the name of the algorithm the cipher implements. - - - add the pad bytes to the passed in block, returning the - number of bytes added. - - - return the number of pad bytes present in the block. - - - A padder that adds Null byte padding to a block. - - - Return the name of the algorithm the cipher implements. - - - the name of the algorithm the cipher implements. - - - - Initialise the padder. - - - - a SecureRandom if available. - - - - add the pad bytes to the passed in block, returning the - number of bytes added. - - - - return the number of pad bytes present in the block. - - - Base constructor. - - @param key key to be used by underlying cipher - @param macSize macSize in bits - @param nonce nonce to be used - - - Base constructor. - - @param key key to be used by underlying cipher - @param macSize macSize in bits - @param nonce nonce to be used - @param associatedText associated text, if any - - - Base constructor. - - @param key key to be used by underlying cipher - @param macSize macSize in bits - @param nonce nonce to be used - @param associatedText associated text, if any - - - return true if the passed in key is a DES-EDE weak key. - - @param key bytes making up the key - @param offset offset into the byte array the key starts at - @param length number of bytes making up the key - - - return true if the passed in key is a DES-EDE weak key. - - @param key bytes making up the key - @param offset offset into the byte array the key starts at - - - return true if the passed in key is a real 2/3 part DES-EDE key. - - @param key bytes making up the key - @param offset offset into the byte array the key starts at - - - return true if the passed in key is a real 2 part DES-EDE key. - - @param key bytes making up the key - @param offset offset into the byte array the key starts at - - - return true if the passed in key is a real 3 part DES-EDE key. - - @param key bytes making up the key - @param offset offset into the byte array the key starts at - - - DES has 16 weak keys. This method will check - if the given DES key material is weak or semi-weak. - Key material that is too short is regarded as weak. -

- See "Applied - Cryptography" by Bruce Schneier for more information. -

- @return true if the given DES key material is weak or semi-weak, - false otherwise. -
- - DES Keys use the LSB as the odd parity bit. This can - be used to check for corrupt keys. - - @param bytes the byte array to set the parity on. - - - The minimum bitlength of the private value. - - - The bitlength of the private value. - - - Construct without a usage index, this will do a random construction of G. - - @param L desired length of prime P in bits (the effective key size). - @param N desired length of prime Q in bits. - @param certainty certainty level for prime number generation. - @param random the source of randomness to use. - - - Construct for a specific usage index - this has the effect of using verifiable canonical generation of G. - - @param L desired length of prime P in bits (the effective key size). - @param N desired length of prime Q in bits. - @param certainty certainty level for prime number generation. - @param random the source of randomness to use. - @param usageIndex a valid usage index. - - - return the generator - g - - - return private value limit - l - - - Parameter class for the HkdfBytesGenerator class. - - - Generates parameters for HKDF, specifying both the optional salt and - optional info. Step 1: Extract won't be skipped. - - @param ikm the input keying material or seed - @param salt the salt to use, may be null for a salt for hashLen zeros - @param info the info to use, may be null for an info field of zero bytes - - - Factory method that makes the HKDF skip the extract part of the key - derivation function. - - @param ikm the input keying material or seed, directly used for step 2: - Expand - @param info the info to use, may be null for an info field of zero bytes - @return HKDFParameters that makes the implementation skip step 1 - - - Returns the input keying material or seed. - - @return the keying material - - - Returns if step 1: extract has to be skipped or not - - @return true for skipping, false for no skipping of step 1 - - - Returns the salt, or null if the salt should be generated as a byte array - of HashLen zeros. - - @return the salt, or null - - - Returns the info field, which may be empty (null is converted to empty). - - @return the info field, never null - - - parameters for using an integrated cipher in stream mode. - - - @param derivation the derivation parameter for the KDF function. - @param encoding the encoding parameter for the KDF function. - @param macKeySize the size of the MAC key (in bits). - - - @param derivation the derivation parameter for the KDF function. - @param encoding the encoding parameter for the KDF function. - @param macKeySize the size of the MAC key (in bits). - @param cipherKeySize the size of the associated Cipher key (in bits). - - - parameters for Key derivation functions for ISO-18033 - - - - Base constructor - suffix fixed input data only. - - the KDF seed - fixed input data to follow counter. - length of the counter in bits - - - - Base constructor - prefix and suffix fixed input data. - - the KDF seed - fixed input data to precede counter - fixed input data to follow counter. - length of the counter in bits. - - - parameters for Key derivation functions for IEEE P1363a - - - Parameters for mask derivation functions. - - - Parameters for NaccacheStern public private key generation. For details on - this cipher, please see - - http://www.gemplus.com/smart/rd/publications/pdf/NS98pkcs.pdf - - - Parameters for generating a NaccacheStern KeyPair. - - @param random - The source of randomness - @param strength - The desired strength of the Key in Bits - @param certainty - the probability that the generated primes are not really prime - as integer: 2^(-certainty) is then the probability - @param countSmallPrimes - How many small key factors are desired - - - * Parameters for a NaccacheStern KeyPair. - * - * @param random - * The source of randomness - * @param strength - * The desired strength of the Key in Bits - * @param certainty - * the probability that the generated primes are not really prime - * as integer: 2^(-certainty) is then the probability - * @param cntSmallPrimes - * How many small key factors are desired - * @param debug - * Ignored - - - @return Returns the certainty. - - - @return Returns the countSmallPrimes. - - - Public key parameters for NaccacheStern cipher. For details on this cipher, - please see - - http://www.gemplus.com/smart/rd/publications/pdf/NS98pkcs.pdf - - - @param privateKey - - - @return Returns the g. - - - @return Returns the lowerSigmaBound. - - - @return Returns the n. - - - Private key parameters for NaccacheStern cipher. For details on this cipher, - please see - - http://www.gemplus.com/smart/rd/publications/pdf/NS98pkcs.pdf - - - Constructs a NaccacheSternPrivateKey - - @param g - the public enryption parameter g - @param n - the public modulus n = p*q - @param lowerSigmaBound - the public lower sigma bound up to which data can be encrypted - @param smallPrimes - the small primes, of which sigma is constructed in the right - order - @param phi_n - the private modulus phi(n) = (p-1)(q-1) - - - Cipher parameters with a fixed salt value associated with them. - - - - Parameters for the Skein hash function - a series of byte[] strings identified by integer tags. - - - Parameterised Skein can be used for: -
    -
  • MAC generation, by providing a key.
  • -
  • Randomised hashing, by providing a nonce.
  • -
  • A hash function for digital signatures, associating a - public key with the message digest.
  • -
  • A key derivation function, by providing a - key identifier.
  • -
  • Personalised hashing, by providing a - recommended format or - arbitrary personalisation string.
  • -
-
- - - -
- - - The parameter type for a secret key, supporting MAC or KDF functions: 0 - - - - - The parameter type for the Skein configuration block: 4 - - - - - The parameter type for a personalisation string: 8 - - - - - The parameter type for a public key: 12 - - - - - The parameter type for a key identifier string: 16 - - - - - The parameter type for a nonce: 20 - - - - - The parameter type for the message: 48 - - - - - The parameter type for the output transformation: 63 - - - - - Obtains a map of type (int) to value (byte[]) for the parameters tracked in this object. - - - - - Obtains the value of the key parameter, or null if not - set. - - The key. - - - - Obtains the value of the personalisation parameter, or - null if not set. - - - - - Obtains the value of the public key parameter, or - null if not set. - - - - - Obtains the value of the key identifier parameter, or - null if not set. - - - - - Obtains the value of the nonce parameter, or null if - not set. - - - - - A builder for . - - - - - Sets a parameters to apply to the Skein hash function. - - - Parameter types must be in the range 0,5..62, and cannot use the value 48 - (reserved for message body). -

- Parameters with type < 48 are processed before - the message content, parameters with type > 48 - are processed after the message and prior to output. - - the type of the parameter, in the range 5..62. - the byte sequence of the parameter. - - -

- Sets the parameter. - -
- - - Sets the parameter. - - - - - Implements the recommended personalisation format for Skein defined in Section 4.11 of - the Skein 1.3 specification. - - - The format is YYYYMMDD email@address distinguisher, encoded to a byte - sequence using UTF-8 encoding. - - the date the personalised application of the Skein was defined. - the email address of the creation of the personalised application. - an arbitrary personalisation string distinguishing the application. - - - - Sets the parameter. - - - - - Sets the parameter. - - - - - Sets the parameter. - - - - - Constructs a new instance with the parameters provided to this - builder. - - - - Private parameters for an SM2 key exchange. - The ephemeralPrivateKey is used to calculate the random point used in the algorithm. - - - Public parameters for an SM2 key exchange. - In this case the ephemeralPublicKey provides the random point used in the algorithm. - - - - Parameters for tweakable block ciphers. - - - - - Gets the key. - - the key to use, or null to use the current key. - - - - Gets the tweak value. - - The tweak to use, or null to use the current tweak. - - - super class for all Password Based Encyrption (Pbe) parameter generator classes. - - - base constructor. - - - initialise the Pbe generator. - - @param password the password converted into bytes (see below). - @param salt the salt to be mixed with the password. - @param iterationCount the number of iterations the "mixing" function - is to be applied for. - - - return the password byte array. - - @return the password byte array. - - - return the salt byte array. - - @return the salt byte array. - - - return the iteration count. - - @return the iteration count. - - - Generate derived parameters for a key of length keySize. - - @param keySize the length, in bits, of the key required. - @return a parameters object representing a key. - - - Generate derived parameters for a key of length keySize, and - an initialisation vector (IV) of length ivSize. - - @param keySize the length, in bits, of the key required. - @param ivSize the length, in bits, of the iv required. - @return a parameters object representing a key and an IV. - - - Generate derived parameters for a key of length keySize, specifically - for use with a MAC. - - @param keySize the length, in bits, of the key required. - @return a parameters object representing a key. - - - converts a password to a byte array according to the scheme in - Pkcs5 (ascii, no padding) - - @param password a character array representing the password. - @return a byte array representing the password. - - - converts a password to a byte array according to the scheme in - PKCS5 (UTF-8, no padding) - - @param password a character array representing the password. - @return a byte array representing the password. - - - converts a password to a byte array according to the scheme in - Pkcs12 (unicode, big endian, 2 zero pad bytes at the end). - - @param password a character array representing the password. - @return a byte array representing the password. - - - An EntropySourceProvider where entropy generation is based on a SecureRandom output using SecureRandom.generateSeed(). - - - Create a entropy source provider based on the passed in SecureRandom. - - @param secureRandom the SecureRandom to base EntropySource construction on. - @param isPredictionResistant boolean indicating if the SecureRandom is based on prediction resistant entropy or not (true if it is). - - - Return an entropy source that will create bitsRequired bits of entropy on - each invocation of getEntropy(). - - @param bitsRequired size (in bits) of entropy to be created by the provided source. - @return an EntropySource that generates bitsRequired bits of entropy on each call to its getEntropy() method. - - - - Uses RandomNumberGenerator.Create() to get randomness generator - - - - Random generation based on the digest with counter. Calling AddSeedMaterial will - always increase the entropy of the hash. -

- Internal access to the digest is synchronized so a single one of these can be shared. -

-
- - A SP800-90A CTR DRBG. - - - Construct a SP800-90A CTR DRBG. -

- Minimum entropy requirement is the security strength requested. -

- @param engine underlying block cipher to use to support DRBG - @param keySizeInBits size of the key to use with the block cipher. - @param securityStrength security strength required (in bits) - @param entropySource source of entropy to use for seeding/reseeding. - @param personalizationString personalization string to distinguish this DRBG (may be null). - @param nonce nonce to further distinguish this DRBG (may be null). -
- - Return the block size (in bits) of the DRBG. - - @return the number of bits produced on each internal round of the DRBG. - - - Populate a passed in array with random data. - - @param output output array for generated bits. - @param additionalInput additional input to be added to the DRBG in this step. - @param predictionResistant true if a reseed should be forced, false otherwise. - - @return number of bits generated, -1 if a reseed required. - - - Reseed the DRBG. - - @param additionalInput additional input to be added to the DRBG in this step. - - - Pad out a key for TDEA, setting odd parity for each byte. - - @param keyMaster - @param keyOff - @param tmp - @param tmpOff - - - Used by both Dual EC and Hash. - - - A SP800-90A Hash DRBG. - - - Construct a SP800-90A Hash DRBG. -

- Minimum entropy requirement is the security strength requested. -

- @param digest source digest to use for DRB stream. - @param securityStrength security strength required (in bits) - @param entropySource source of entropy to use for seeding/reseeding. - @param personalizationString personalization string to distinguish this DRBG (may be null). - @param nonce nonce to further distinguish this DRBG (may be null). -
- - Return the block size (in bits) of the DRBG. - - @return the number of bits produced on each internal round of the DRBG. - - - Populate a passed in array with random data. - - @param output output array for generated bits. - @param additionalInput additional input to be added to the DRBG in this step. - @param predictionResistant true if a reseed should be forced, false otherwise. - - @return number of bits generated, -1 if a reseed required. - - - Reseed the DRBG. - - @param additionalInput additional input to be added to the DRBG in this step. - - - A SP800-90A HMAC DRBG. - - - Construct a SP800-90A Hash DRBG. -

- Minimum entropy requirement is the security strength requested. -

- @param hMac Hash MAC to base the DRBG on. - @param securityStrength security strength required (in bits) - @param entropySource source of entropy to use for seeding/reseeding. - @param personalizationString personalization string to distinguish this DRBG (may be null). - @param nonce nonce to further distinguish this DRBG (may be null). -
- - Return the block size (in bits) of the DRBG. - - @return the number of bits produced on each round of the DRBG. - - - Populate a passed in array with random data. - - @param output output array for generated bits. - @param additionalInput additional input to be added to the DRBG in this step. - @param predictionResistant true if a reseed should be forced, false otherwise. - - @return number of bits generated, -1 if a reseed required. - - - Reseed the DRBG. - - @param additionalInput additional input to be added to the DRBG in this step. - - - Interface to SP800-90A deterministic random bit generators. - - - Return the block size of the DRBG. - - @return the block size (in bits) produced by each round of the DRBG. - - - Populate a passed in array with random data. - - @param output output array for generated bits. - @param additionalInput additional input to be added to the DRBG in this step. - @param predictionResistant true if a reseed should be forced, false otherwise. - - @return number of bits generated, -1 if a reseed required. - - - Reseed the DRBG. - - @param additionalInput additional input to be added to the DRBG in this step. - - - Generate numBytes worth of entropy from the passed in entropy source. - - @param entropySource the entropy source to request the data from. - @param numBytes the number of bytes of entropy requested. - @return a byte array populated with the random data. - - - Generic interface for objects generating random bytes. - - - Add more seed material to the generator. - A byte array to be mixed into the generator's state. - - - Add more seed material to the generator. - A long value to be mixed into the generator's state. - - - Fill byte array with random values. - Array to be filled. - - - Fill byte array with random values. - Array to receive bytes. - Index to start filling at. - Length of segment to fill. - - - - Takes bytes generated by an underling RandomGenerator and reverses the order in - each small window (of configurable size). -

- Access to internals is synchronized so a single one of these can be shared. -

-
-
- - Add more seed material to the generator. - A byte array to be mixed into the generator's state. - - - Add more seed material to the generator. - A long value to be mixed into the generator's state. - - - Fill byte array with random values. - Array to be filled. - - - Fill byte array with random values. - Array to receive bytes. - Index to start filling at. - Length of segment to fill. - - - Force a reseed of the DRBG. - optional additional input - - - Builder class for making SecureRandom objects based on SP 800-90A Deterministic Random Bit Generators (DRBG). - - - Basic constructor, creates a builder using an EntropySourceProvider based on the default SecureRandom with - predictionResistant set to false. -

- Any SecureRandom created from a builder constructed like this will make use of input passed to SecureRandom.setSeed() if - the default SecureRandom does for its generateSeed() call. -

-
- - Construct a builder with an EntropySourceProvider based on the passed in SecureRandom and the passed in value - for prediction resistance. -

- Any SecureRandom created from a builder constructed like this will make use of input passed to SecureRandom.setSeed() if - the passed in SecureRandom does for its generateSeed() call. -

- @param entropySource - @param predictionResistant -
- - Create a builder which makes creates the SecureRandom objects from a specified entropy source provider. -

- Note: If this constructor is used any calls to setSeed() in the resulting SecureRandom will be ignored. -

- @param entropySourceProvider a provider of EntropySource objects. -
- - Set the personalization string for DRBG SecureRandoms created by this builder - @param personalizationString the personalisation string for the underlying DRBG. - @return the current builder. - - - Set the security strength required for DRBGs used in building SecureRandom objects. - - @param securityStrength the security strength (in bits) - @return the current builder. - - - Set the amount of entropy bits required for seeding and reseeding DRBGs used in building SecureRandom objects. - - @param entropyBitsRequired the number of bits of entropy to be requested from the entropy source on each seed/reseed. - @return the current builder. - - - Build a SecureRandom based on a SP 800-90A Hash DRBG. - - @param digest digest algorithm to use in the DRBG underneath the SecureRandom. - @param nonce nonce value to use in DRBG construction. - @param predictionResistant specify whether the underlying DRBG in the resulting SecureRandom should reseed on each request for bytes. - @return a SecureRandom supported by a Hash DRBG. - - - Build a SecureRandom based on a SP 800-90A CTR DRBG. - - @param cipher the block cipher to base the DRBG on. - @param keySizeInBits key size in bits to be used with the block cipher. - @param nonce nonce value to use in DRBG construction. - @param predictionResistant specify whether the underlying DRBG in the resulting SecureRandom should reseed on each request for bytes. - @return a SecureRandom supported by a CTR DRBG. - - - Build a SecureRandom based on a SP 800-90A HMAC DRBG. - - @param hMac HMAC algorithm to use in the DRBG underneath the SecureRandom. - @param nonce nonce value to use in DRBG construction. - @param predictionResistant specify whether the underlying DRBG in the resulting SecureRandom should reseed on each request for bytes. - @return a SecureRandom supported by a HMAC DRBG. - - - A thread based seed generator - one source of randomness. -

- Based on an idea from Marcus Lippert. -

-
- - Generate seed bytes. Set fast to false for best quality. -

- If fast is set to true, the code should be round about 8 times faster when - generating a long sequence of random bytes. 20 bytes of random values using - the fast mode take less than half a second on a Nokia e70. If fast is set to false, - it takes round about 2500 ms. -

- @param numBytes the number of bytes to generate - @param fast true if fast mode should be used -
- - - Permutation generated by code: - - // First 1850 fractional digit of Pi number. - byte[] key = new BigInteger("14159265358979323846...5068006422512520511").ToByteArray(); - s = 0; - P = new byte[256]; - for (int i = 0; i < 256; i++) - { - P[i] = (byte) i; - } - for (int m = 0; m < 768; m++) - { - s = P[(s + P[m & 0xff] + key[m % key.length]) & 0xff]; - byte temp = P[m & 0xff]; - P[m & 0xff] = P[s & 0xff]; - P[s & 0xff] = temp; - } - - - - Value generated in the same way as P. - - - - @param engine - @param entropySource - - - Populate a passed in array with random data. - - @param output output array for generated bits. - @param predictionResistant true if a reseed should be forced, false otherwise. - - @return number of bits generated, -1 if a reseed required. - - - Reseed the RNG. - - - Basic constructor, creates a builder using an EntropySourceProvider based on the default SecureRandom with - predictionResistant set to false. -

- Any SecureRandom created from a builder constructed like this will make use of input passed to SecureRandom.setSeed() if - the default SecureRandom does for its generateSeed() call. -

-
- - Construct a builder with an EntropySourceProvider based on the passed in SecureRandom and the passed in value - for prediction resistance. -

- Any SecureRandom created from a builder constructed like this will make use of input passed to SecureRandom.setSeed() if - the passed in SecureRandom does for its generateSeed() call. -

- @param entropySource - @param predictionResistant -
- - Create a builder which makes creates the SecureRandom objects from a specified entropy source provider. -

- Note: If this constructor is used any calls to setSeed() in the resulting SecureRandom will be ignored. -

- @param entropySourceProvider a provider of EntropySource objects. -
- - Construct a X9.31 secure random generator using the passed in engine and key. If predictionResistant is true the - generator will be reseeded on each request. - - @param engine a block cipher to use as the operator. - @param key the block cipher key to initialise engine with. - @param predictionResistant true if engine to be reseeded on each use, false otherwise. - @return a SecureRandom. - - - update the internal digest with the byte b - - - update the internal digest with the byte array in - - - Generate a signature for the message we've been loaded with using - the key we were initialised with. - - - true if the internal state represents the signature described in the passed in array. - - - Reset the internal state - - - The Digital Signature Algorithm - as described in "Handbook of Applied - Cryptography", pages 452 - 453. - - - Default configuration, random K values. - - - Configuration with an alternate, possibly deterministic calculator of K. - - @param kCalculator a K value calculator. - - - Generate a signature for the given message using the key we were - initialised with. For conventional DSA the message should be a SHA-1 - hash of the message of interest. - - @param message the message that will be verified later. - - - return true if the value r and s represent a DSA signature for - the passed in message for standard DSA the message should be a - SHA-1 hash of the real message to be verified. - - - EC-DSA as described in X9.62 - - - Default configuration, random K values. - - - Configuration with an alternate, possibly deterministic calculator of K. - - @param kCalculator a K value calculator. - - - Generate a signature for the given message using the key we were - initialised with. For conventional DSA the message should be a SHA-1 - hash of the message of interest. - - @param message the message that will be verified later. - - - return true if the value r and s represent a DSA signature for - the passed in message (for standard DSA the message should be - a SHA-1 hash of the real message to be verified). - - - GOST R 34.10-2001 Signature Algorithm - - - generate a signature for the given message using the key we were - initialised with. For conventional GOST3410 the message should be a GOST3411 - hash of the message of interest. - - @param message the message that will be verified later. - - - return true if the value r and s represent a GOST3410 signature for - the passed in message (for standard GOST3410 the message should be - a GOST3411 hash of the real message to be verified). - - - EC-NR as described in IEEE 1363-2000 - - - generate a signature for the given message using the key we were - initialised with. Generally, the order of the curve should be at - least as long as the hash of the message of interest, and with - ECNR it *must* be at least as long. - - @param digest the digest to be signed. - @exception DataLengthException if the digest is longer than the key allows - - - return true if the value r and s represent a signature for the - message passed in. Generally, the order of the curve should be at - least as long as the hash of the message of interest, and with - ECNR, it *must* be at least as long. But just in case the signer - applied mod(n) to the longer digest, this implementation will - apply mod(n) during verification. - - @param digest the digest to be verified. - @param r the r value of the signature. - @param s the s value of the signature. - @exception DataLengthException if the digest is longer than the key allows - - - initialise the signer for signing or verification. - - @param forSigning - true if for signing, false otherwise - @param parameters - necessary parameters. - - - update the internal digest with the byte b - - - update the internal digest with the byte array in - - - Generate a signature for the message we've been loaded with using the key - we were initialised with. - - - return true if the internal state represents the signature described in - the passed in array. - - - update the internal digest with the byte b - - - update the internal digest with the byte array in - - - Generate a signature for the message we've been loaded with using - the key we were initialised with. - - - true if the internal state represents the signature described in the passed in array. - - - Reset the internal state - - - Gost R 34.10-94 Signature Algorithm - - - generate a signature for the given message using the key we were - initialised with. For conventional Gost3410 the message should be a Gost3411 - hash of the message of interest. - - @param message the message that will be verified later. - - - return true if the value r and s represent a Gost3410 signature for - the passed in message for standard Gost3410 the message should be a - Gost3411 hash of the real message to be verified. - - - A deterministic K calculator based on the algorithm in section 3.2 of RFC 6979. - - - Base constructor. - - @param digest digest to build the HMAC on. - - - - An interface for different encoding formats for DSA signatures. - - - - Decode the (r, s) pair of a DSA signature. - The order of the group that r, s belong to. - An encoding of the (r, s) pair of a DSA signature. - The (r, s) of a DSA signature, stored in an array of exactly two elements, r followed by s. - - - Encode the (r, s) pair of a DSA signature. - The order of the group that r, s belong to. - The r value of a DSA signature. - The s value of a DSA signature. - An encoding of the DSA signature given by the provided (r, s) pair. - - - Interface define calculators of K values for DSA/ECDSA. - - - Return true if this calculator is deterministic, false otherwise. - - @return true if deterministic, otherwise false. - - - Non-deterministic initialiser. - - @param n the order of the DSA group. - @param random a source of randomness. - - - Deterministic initialiser. - - @param n the order of the DSA group. - @param d the DSA private value. - @param message the message being signed. - - - Return the next valid value of K. - - @return a K value. - - - ISO9796-2 - mechanism using a hash function with recovery (scheme 2 and 3). -

- Note: the usual length for the salt is the length of the hash - function used in bytes.

-
-
- - - Return a reference to the recoveredMessage message. - - The full/partial recoveredMessage message. - - - - - Generate a signer with either implicit or explicit trailers for ISO9796-2, scheme 2 or 3. - - base cipher to use for signature creation/verification - digest to use. - length of salt in bytes. - whether or not the trailer is implicit or gives the hash. - - - Constructor for a signer with an explicit digest trailer. - - - cipher to use. - - digest to sign with. - - length of salt in bytes. - - - - Initialise the signer. - true if for signing, false if for verification. - parameters for signature generation/verification. If the - parameters are for generation they should be a ParametersWithRandom, - a ParametersWithSalt, or just an RsaKeyParameters object. If RsaKeyParameters - are passed in a SecureRandom will be created. - - if wrong parameter type or a fixed - salt is passed in which is the wrong length. - - - - compare two byte arrays - constant time. - - - clear possible sensitive data - - - update the internal digest with the byte b - - - update the internal digest with the byte array in - - - reset the internal state - - - Generate a signature for the loaded message using the key we were - initialised with. - - - - return true if the signature represents a ISO9796-2 signature - for the passed in message. - - - - - Return true if the full message was recoveredMessage. - - true on full message recovery, false otherwise, or if not sure. - - - - int to octet string. - int to octet string. - - - long to octet string. - - - mask generator function, as described in Pkcs1v2. - - - ISO9796-2 - mechanism using a hash function with recovery (scheme 1) - - - - Return a reference to the recoveredMessage message. - - The full/partial recoveredMessage message. - - - - - Generate a signer with either implicit or explicit trailers for ISO9796-2. - - base cipher to use for signature creation/verification - digest to use. - whether or not the trailer is implicit or gives the hash. - - - Constructor for a signer with an explicit digest trailer. - - - cipher to use. - - digest to sign with. - - - - compare two byte arrays - constant time. - - - clear possible sensitive data - - - update the internal digest with the byte b - - - update the internal digest with the byte array in - - - reset the internal state - - - Generate a signature for the loaded message using the key we were - initialised with. - - - - return true if the signature represents a ISO9796-2 signature - for the passed in message. - - - - - Return true if the full message was recoveredMessage. - - true on full message recovery, false otherwise. - - - - RSA-PSS as described in Pkcs# 1 v 2.1. -

- Note: the usual value for the salt length is the number of - bytes in the hash function.

-
-
- - Basic constructor - the asymmetric cipher to use. - the digest to use. - the length of the salt to use (in bytes). - - - Basic constructor - the asymmetric cipher to use. - the digest to use. - the fixed salt to be used. - - - clear possible sensitive data - - - update the internal digest with the byte b - - - update the internal digest with the byte array in - - - reset the internal state - - - Generate a signature for the message we've been loaded with using - the key we were initialised with. - - - - return true if the internal state represents the signature described - in the passed in array. - - - - int to octet string. - - - mask generator function, as described in Pkcs1v2. - - - - Load oid table. - - - - Initialise the signer for signing or verification. - - @param forSigning true if for signing, false otherwise - @param param necessary parameters. - - - update the internal digest with the byte b - - - update the internal digest with the byte array in - - - Generate a signature for the message we've been loaded with using - the key we were initialised with. - - - return true if the internal state represents the signature described - in the passed in array. - - - The SM2 Digital Signature algorithm. - - - X9.31-1998 - signing using a hash. -

- The message digest hash, H, is encapsulated to form a byte string as follows -

-
-            EB = 06 || PS || 0xBA || H || TRAILER
-            
- where PS is a string of bytes all of value 0xBB of length such that |EB|=|n|, and TRAILER is the ISO/IEC 10118 part number† for the digest. The byte string, EB, is converted to an integer value, the message representative, f. -
- - Generate a signer with either implicit or explicit trailers for X9.31. - - @param cipher base cipher to use for signature creation/verification - @param digest digest to use. - @param implicit whether or not the trailer is implicit or gives the hash. - - - Constructor for a signer with an explicit digest trailer. - - @param cipher cipher to use. - @param digest digest to sign with. - - - clear possible sensitive data - - - update the internal digest with the byte b - - - update the internal digest with the byte array in - - - reset the internal state - - - generate a signature for the loaded message using the key we were - initialised with. - - - return true if the signature represents a ISO9796-2 signature - for the passed in message. - - - - A simple block result object which just carries a byte array. - - - - - Base constructor - a wrapper for the passed in byte array. - - The byte array to be wrapped. - - - - Return the number of bytes in the result - - The length of the result in bytes. - - - - Return the final result of the operation. - - A block of bytes, representing the result of an operation. - - - - Store the final result of the operation by copying it into the destination array. - - The number of bytes copied into destination. - The byte array to copy the result into. - The offset into destination to start copying the result at. - - - a wrapper for block ciphers with a single byte block size, so that they - can be treated like stream ciphers. - - - basic constructor. - - @param cipher the block cipher to be wrapped. - @exception ArgumentException if the cipher has a block size other than - one. - - - initialise the underlying cipher. - - @param forEncryption true if we are setting up for encryption, false otherwise. - @param param the necessary parameters for the underlying cipher to be initialised. - - - return the name of the algorithm we are wrapping. - - @return the name of the algorithm we are wrapping. - - - encrypt/decrypt a single byte returning the result. - - @param in the byte to be processed. - @return the result of processing the input byte. - - - process a block of bytes from in putting the result into out. - - @param in the input byte array. - @param inOff the offset into the in array where the data to be processed starts. - @param len the number of bytes to be processed. - @param out the output buffer the processed bytes go into. - @param outOff the offset into the output byte array the processed data stars at. - @exception DataLengthException if the output buffer is too small. - - - reset the underlying cipher. This leaves it in the same state - it was at after the last init (if there was one). - - - - - - - - - - - - - - - - - - - RFC 5246 7.2 - - - - This message notifies the recipient that the sender will not send any more messages on this - connection. Note that as of TLS 1.1, failure to properly close a connection no longer - requires that a session not be resumed. This is a change from TLS 1.0 ("The session becomes - unresumable if any connection is terminated without proper close_notify messages with level - equal to warning.") to conform with widespread implementation practice. - - - An inappropriate message was received. This alert is always fatal and should never be - observed in communication between proper implementations. - - - This alert is returned if a record is received with an incorrect MAC. This alert also MUST be - returned if an alert is sent because a TLSCiphertext decrypted in an invalid way: either it - wasn't an even multiple of the block length, or its padding values, when checked, weren't - correct. This message is always fatal and should never be observed in communication between - proper implementations (except when messages were corrupted in the network). - - - This alert was used in some earlier versions of TLS, and may have permitted certain attacks - against the CBC mode [CBCATT]. It MUST NOT be sent by compliant implementations. - - - A TLSCiphertext record was received that had a length more than 2^14+2048 bytes, or a record - decrypted to a TLSCompressed record with more than 2^14+1024 bytes. This message is always - fatal and should never be observed in communication between proper implementations (except - when messages were corrupted in the network). - - - The decompression function received improper input (e.g., data that would expand to excessive - length). This message is always fatal and should never be observed in communication between - proper implementations. - - - Reception of a handshake_failure alert message indicates that the sender was unable to - negotiate an acceptable set of security parameters given the options available. This is a - fatal error. - - - This alert was used in SSLv3 but not any version of TLS. It MUST NOT be sent by compliant - implementations. - - - A certificate was corrupt, contained signatures that did not verify correctly, etc. - - - A certificate was of an unsupported type. - - - A certificate was revoked by its signer. - - - A certificate has expired or is not currently valid. - - - Some other (unspecified) issue arose in processing the certificate, rendering it - unacceptable. - - - A field in the handshake was out of range or inconsistent with other fields. This message is - always fatal. - - - A valid certificate chain or partial chain was received, but the certificate was not accepted - because the CA certificate could not be located or couldn't be matched with a known, trusted - CA. This message is always fatal. - - - A valid certificate was received, but when access control was applied, the sender decided not - to proceed with negotiation. This message is always fatal. - - - A message could not be decoded because some field was out of the specified range or the - length of the message was incorrect. This message is always fatal and should never be - observed in communication between proper implementations (except when messages were corrupted - in the network). - - - A handshake cryptographic operation failed, including being unable to correctly verify a - signature or validate a Finished message. This message is always fatal. - - - This alert was used in some earlier versions of TLS. It MUST NOT be sent by compliant - implementations. - - - The protocol version the client has attempted to negotiate is recognized but not supported. - (For example, old protocol versions might be avoided for security reasons.) This message is - always fatal. - - - Returned instead of handshake_failure when a negotiation has failed specifically because the - server requires ciphers more secure than those supported by the client. This message is - always fatal. - - - An internal error unrelated to the peer or the correctness of the protocol (such as a memory - allocation failure) makes it impossible to continue. This message is always fatal. - - - This handshake is being canceled for some reason unrelated to a protocol failure. If the user - cancels an operation after the handshake is complete, just closing the connection by sending - a close_notify is more appropriate. This alert should be followed by a close_notify. This - message is generally a warning. - - - Sent by the client in response to a hello request or by the server in response to a client - hello after initial handshaking. Either of these would normally lead to renegotiation; when - that is not appropriate, the recipient should respond with this alert. At that point, the - original requester can decide whether to proceed with the connection. One case where this - would be appropriate is where a server has spawned a process to satisfy a request; the - process might receive security parameters (key length, authentication, etc.) at startup, and - it might be difficult to communicate changes to these parameters after that point. This - message is always a warning. - - - Sent by clients that receive an extended server hello containing an extension that they did - not put in the corresponding client hello. This message is always fatal. - - - This alert is sent by servers who are unable to retrieve a certificate chain from the URL - supplied by the client (see Section 3.3). This message MAY be fatal - for example if client - authentication is required by the server for the handshake to continue and the server is - unable to retrieve the certificate chain, it may send a fatal alert. - - - This alert is sent by servers that receive a server_name extension request, but do not - recognize the server name. This message MAY be fatal. - - - This alert is sent by clients that receive an invalid certificate status response (see - Section 3.6). This message is always fatal. - - - This alert is sent by servers when a certificate hash does not match a client provided - certificate_hash. This message is always fatal. - - - If the server does not recognize the PSK identity, it MAY respond with an - "unknown_psk_identity" alert message. - - - If TLS_FALLBACK_SCSV appears in ClientHello.cipher_suites and the highest protocol version - supported by the server is higher than the version indicated in ClientHello.client_version, - the server MUST respond with a fatal inappropriate_fallback alert [..]. - - - - RFC 5246 7.2 - - - - RFC 2246 - - Note that the values here are implementation-specific and arbitrary. It is recommended not to - depend on the particular values (e.g. serialization). - - - - - A queue for bytes. -

- This file could be more optimized. -

-
-
- - The smallest number which can be written as 2^x which is bigger than i. - - - The initial size for our buffer. - - - The buffer where we store our data. - - - How many bytes at the beginning of the buffer are skipped. - - - How many bytes in the buffer are valid data. - - - Add some data to our buffer. - A byte-array to read data from. - How many bytes to skip at the beginning of the array. - How many bytes to read from the array. - - - The number of bytes which are available in this buffer. - - - Copy some bytes from the beginning of the data to the provided Stream. - The Stream to copy the bytes to. - How many bytes to copy. - If insufficient data is available. - If there is a problem copying the data. - - - Read data from the buffer. - The buffer where the read data will be copied to. - How many bytes to skip at the beginning of buf. - How many bytes to read at all. - How many bytes from our data to skip. - - - Return a MemoryStream over some bytes at the beginning of the data. - How many bytes will be readable. - A MemoryStream over the data. - If insufficient data is available. - - - Remove some bytes from our data from the beginning. - How many bytes to remove. - - - Parsing and encoding of a Certificate struct from RFC 4346. -

-

-             opaque ASN.1Cert<2^24-1>;
-            
-             struct {
-                 ASN.1Cert certificate_list<0..2^24-1>;
-             } Certificate;
-             
- - @see Org.BouncyCastle.Asn1.X509.X509CertificateStructure -
- - The certificates. - - - @return an array of {@link org.bouncycastle.asn1.x509.Certificate} representing a certificate - chain. - - - @return true if this certificate chain contains no certificates, or - false otherwise. - - - Encode this {@link Certificate} to a {@link Stream}. - - @param output the {@link Stream} to encode to. - @throws IOException - - - Parse a {@link Certificate} from a {@link Stream}. - - @param input the {@link Stream} to parse from. - @return a {@link Certificate} object. - @throws IOException - - - Parsing and encoding of a CertificateRequest struct from RFC 4346. -

-

-             struct {
-                 ClientCertificateType certificate_types<1..2^8-1>;
-                 DistinguishedName certificate_authorities<3..2^16-1>
-             } CertificateRequest;
-             
- - @see ClientCertificateType - @see X509Name -
- - @param certificateTypes see {@link ClientCertificateType} for valid constants. - @param certificateAuthorities an {@link IList} of {@link X509Name}. - - - @return an array of certificate types - @see {@link ClientCertificateType} - - - @return an {@link IList} of {@link SignatureAndHashAlgorithm} (or null before TLS 1.2). - - - @return an {@link IList} of {@link X509Name} - - - Encode this {@link CertificateRequest} to a {@link Stream}. - - @param output the {@link Stream} to encode to. - @throws IOException - - - Parse a {@link CertificateRequest} from a {@link Stream}. - - @param context - the {@link TlsContext} of the current connection. - @param input - the {@link Stream} to parse from. - @return a {@link CertificateRequest} object. - @throws IOException - - - Encode this {@link CertificateStatus} to a {@link Stream}. - - @param output - the {@link Stream} to encode to. - @throws IOException - - - Parse a {@link CertificateStatus} from a {@link Stream}. - - @param input - the {@link Stream} to parse from. - @return a {@link CertificateStatus} object. - @throws IOException - - - Encode this {@link CertificateStatusRequest} to a {@link Stream}. - - @param output - the {@link Stream} to encode to. - @throws IOException - - - Parse a {@link CertificateStatusRequest} from a {@link Stream}. - - @param input - the {@link Stream} to parse from. - @return a {@link CertificateStatusRequest} object. - @throws IOException - - - RFC 6091 - - - @param type - see {@link CertChainType} for valid constants. - @param urlAndHashList - a {@link IList} of {@link UrlAndHash}. - - - @return {@link CertChainType} - - - @return an {@link IList} of {@link UrlAndHash} - - - Encode this {@link CertificateUrl} to a {@link Stream}. - - @param output the {@link Stream} to encode to. - @throws IOException - - - Parse a {@link CertificateUrl} from a {@link Stream}. - - @param context - the {@link TlsContext} of the current connection. - @param input - the {@link Stream} to parse from. - @return a {@link CertificateUrl} object. - @throws IOException - - - draft-ietf-tls-chacha20-poly1305-04 - - - - - - - - - - - - - - - - RFC 2246 A.5 - - - - RFC 2246 - - Note that the values here are implementation-specific and arbitrary. It is recommended not to - depend on the particular values (e.g. serialization). - - - - A combined hash, which implements md5(m) || sha1(m). - - - @see org.bouncycastle.crypto.Digest#update(byte[], int, int) - - - @see org.bouncycastle.crypto.Digest#doFinal(byte[], int) - - - @see org.bouncycastle.crypto.Digest#reset() - - - - RFC 2246 6.1 - - - - RFC 2246 - - Note that the values here are implementation-specific and arbitrary. It is recommended not to - depend on the particular values (e.g. serialization). - - - - RFC 2246 6.2.1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Accept various standard DH groups with 'P' at least DefaultMinimumPrimeBits bits. - - - Accept various standard DH groups with 'P' at least the specified number of bits. - - - Accept a custom set of group parameters, subject to a minimum bitlength for 'P'. - An IList of acceptable DHParameters. - The minimum acceptable bitlength of the 'P' parameter. - - - - - - - - - Accept only the group parameters specified in RFC 5054 Appendix A. - - - Specify a custom set of acceptable group parameters. - - @param groups a {@link Vector} of acceptable {@link SRP6GroupParameters} - - - Buffers input until the hash algorithm is determined. - - - @return a {@link SignatureAndHashAlgorithm} (or null before TLS 1.2). - - - Encode this {@link DigitallySigned} to a {@link Stream}. - - @param output - the {@link Stream} to encode to. - @throws IOException - - - Parse a {@link DigitallySigned} from a {@link Stream}. - - @param context - the {@link TlsContext} of the current connection. - @param input - the {@link Stream} to parse from. - @return a {@link DigitallySigned} object. - @throws IOException - - - - - - - - - - - - - - - - - - - - - - - - - - - Check that there are no "extra" messages left in the current inbound flight - - - RFC 4347 4.1.2.5 Anti-replay -

- Support fast rejection of duplicate records by maintaining a sliding receive window - - - Check whether a received record with the given sequence number should be rejected as a duplicate. - - @param seq the 48-bit DTLSPlainText.sequence_number field of a received record. - @return true if the record should be discarded without further processing. - - - Report that a received record with the given sequence number passed authentication checks. - - @param seq the 48-bit DTLSPlainText.sequence_number field of an authenticated record. - - - When a new epoch begins, sequence numbers begin again at 0 - - -

RFC 4492 5.4. (Errata ID: 2389) -
- - - RFC 4492 5.4 - - - - Indicates the elliptic curve domain parameters are conveyed verbosely, and the - underlying finite field is a prime field. - - - Indicates the elliptic curve domain parameters are conveyed verbosely, and the - underlying finite field is a characteristic-2 field. - - - Indicates that a named curve is used. This option SHOULD be used when applicable. - - - - RFC 4492 5.1.2 - - - - RFC 2246 - - Note that the values here are implementation-specific and arbitrary. It is recommended not to - depend on the particular values (e.g. serialization). - - - - RFC 5705 - - - RFC 5246 7.4.1.4.1 - - - Encode this {@link HeartbeatExtension} to a {@link Stream}. - - @param output - the {@link Stream} to encode to. - @throws IOException - - - Parse a {@link HeartbeatExtension} from a {@link Stream}. - - @param input - the {@link Stream} to parse from. - @return a {@link HeartbeatExtension} object. - @throws IOException - - - Encode this {@link HeartbeatMessage} to a {@link Stream}. - - @param output - the {@link Stream} to encode to. - @throws IOException - - - Parse a {@link HeartbeatMessage} from a {@link Stream}. - - @param input - the {@link Stream} to parse from. - @return a {@link HeartbeatMessage} object. - @throws IOException - - - RFC 2246 - - Note that the values here are implementation-specific and arbitrary. It is recommended not to - depend on the particular values (e.g. serialization). - - - - RFC 2246 - - Note that the values here are implementation-specific and arbitrary. It is recommended not to - depend on the particular values (e.g. serialization). - - - - - RFC 4492 5.1.1 - The named curves defined here are those specified in SEC 2 [13]. Note that many of - these curves are also recommended in ANSI X9.62 [7] and FIPS 186-2 [11]. Values 0xFE00 - through 0xFEFF are reserved for private use. Values 0xFF01 and 0xFF02 indicate that the - client supports arbitrary prime and characteristic-2 curves, respectively (the curve - parameters must be encoded explicitly in ECParameters). - - - - Encode this {@link NewSessionTicket} to a {@link Stream}. - - @param output the {@link Stream} to encode to. - @throws IOException - - - Parse a {@link NewSessionTicket} from a {@link Stream}. - - @param input the {@link Stream} to parse from. - @return a {@link NewSessionTicket} object. - @throws IOException - - - RFC 3546 3.6 - - - @param responderIDList - an {@link IList} of {@link ResponderID}, specifying the list of trusted OCSP - responders. An empty list has the special meaning that the responders are - implicitly known to the server - e.g., by prior arrangement. - @param requestExtensions - OCSP request extensions. A null value means that there are no extensions. - - - @return an {@link IList} of {@link ResponderID} - - - @return OCSP request extensions - - - Encode this {@link OcspStatusRequest} to a {@link Stream}. - - @param output - the {@link Stream} to encode to. - @throws IOException - - - Parse a {@link OcspStatusRequest} from a {@link Stream}. - - @param input - the {@link Stream} to parse from. - @return an {@link OcspStatusRequest} object. - @throws IOException - - - RFC 5246 - - Note that the values here are implementation-specific and arbitrary. It is recommended not to - depend on the particular values (e.g. serialization). - - - - - - - An implementation of the TLS 1.0/1.1/1.2 record layer, allowing downgrade to SSLv3. - - - RFC 5246 E.1. "Earlier versions of the TLS specification were not fully clear on what the - record layer version number (TLSPlaintext.version) should contain when sending ClientHello - (i.e., before it is known which version of the protocol will be employed). Thus, TLS servers - compliant with this specification MUST accept any value {03,XX} as the record layer version - number for ClientHello." - - - @return {@link ConnectionEnd} - - - @return {@link CipherSuite} - - - @return {@link CompressionMethod} - - - @return {@link PRFAlgorithm} - - - Encode this {@link ServerName} to a {@link Stream}. - - @param output - the {@link Stream} to encode to. - @throws IOException - - - Parse a {@link ServerName} from a {@link Stream}. - - @param input - the {@link Stream} to parse from. - @return a {@link ServerName} object. - @throws IOException - - - @param serverNameList an {@link IList} of {@link ServerName}. - - - @return an {@link IList} of {@link ServerName}. - - - Encode this {@link ServerNameList} to a {@link Stream}. - - @param output - the {@link Stream} to encode to. - @throws IOException - - - Parse a {@link ServerNameList} from a {@link Stream}. - - @param input - the {@link Stream} to parse from. - @return a {@link ServerNameList} object. - @throws IOException - - - Encode this {@link ServerSRPParams} to an {@link OutputStream}. - - @param output - the {@link OutputStream} to encode to. - @throws IOException - - - Parse a {@link ServerSRPParams} from an {@link InputStream}. - - @param input - the {@link InputStream} to parse from. - @return a {@link ServerSRPParams} object. - @throws IOException - - - RFC 5246 7.4.1.4.1 (in RFC 2246, there were no specific values assigned) - - - RFC 5246 7.4.1.4.1 - - - @param hash {@link HashAlgorithm} - @param signature {@link SignatureAlgorithm} - - - @return {@link HashAlgorithm} - - - @return {@link SignatureAlgorithm} - - - Encode this {@link SignatureAndHashAlgorithm} to a {@link Stream}. - - @param output the {@link Stream} to encode to. - @throws IOException - - - Parse a {@link SignatureAndHashAlgorithm} from a {@link Stream}. - - @param input the {@link Stream} to parse from. - @return a {@link SignatureAndHashAlgorithm} object. - @throws IOException - - - An implementation of {@link TlsSRPIdentityManager} that simulates the existence of "unknown" identities - to obscure the fact that there is no verifier for them. - - - Create a {@link SimulatedTlsSRPIdentityManager} that implements the algorithm from RFC 5054 2.5.1.3 - - @param group the {@link SRP6GroupParameters} defining the group that SRP is operating in - @param seedKey the secret "seed key" referred to in RFC 5054 2.5.1.3 - @return an instance of {@link SimulatedTlsSRPIdentityManager} - - - HMAC implementation based on original internet draft for HMAC (RFC 2104) - - The difference is that padding is concatentated versus XORed with the key - - H(K + opad, H(K + ipad, text)) - - - Base constructor for one of the standard digest algorithms that the byteLength of - the algorithm is know for. Behaviour is undefined for digests other than MD5 or SHA1. - - @param digest the digest. - - - Reset the mac generator. - - - RFC 4680 - - - - - - - - - - - - - - - - - - - - - - Called by the protocol handler to report the server certificate. - - - This method is responsible for certificate verification and validation - - The server received - - - - - Return client credentials in response to server's certificate request - - - A containing server certificate request details - - - A to be used for client authentication - (or null for no client authentication) - - - - - - A generic TLS 1.0-1.2 / SSLv3 block cipher. This can be used for AES or 3DES for example. - - - - - - - - - - - - - - - - - - - - Called at the start of a new TLS session, before any other methods. - - - A - - - - Return the session this client wants to resume, if any. - Note that the peer's certificate chain for the session (if any) may need to be periodically revalidated. - - A representing the resumable session to be used for this connection, - or null to use a new session. - - - - - Return the to use for the TLSPlaintext.version field prior to - receiving the server version. NOTE: This method is not called for DTLS. - - - See RFC 5246 E.1.: "TLS clients that wish to negotiate with older servers MAY send any value - {03,XX} as the record layer version number. Typical values would be {03,00}, the lowest - version number supported by the client, and the value of ClientHello.client_version. No - single value will guarantee interoperability with all old servers, but this is a complex - topic beyond the scope of this document." - - The to use. - - - - Get the list of cipher suites that this client supports. - - - An array of values, each specifying a supported cipher suite. - - - - - Get the list of compression methods that this client supports. - - - An array of values, each specifying a supported compression method. - - - - - Get the (optional) table of client extensions to be included in (extended) client hello. - - - A (Int32 -> byte[]). May be null. - - - - - - - - - Notifies the client of the session_id sent in the ServerHello. - - An array of - - - - Report the cipher suite that was selected by the server. - - - The protocol handler validates this value against the offered cipher suites - - - - A - - - - - Report the compression method that was selected by the server. - - - The protocol handler validates this value against the offered compression methods - - - - A - - - - - Report the extensions from an extended server hello. - - - Will only be called if we returned a non-null result from . - - - A (Int32 -> byte[]) - - - - A list of - - - - - Return an implementation of to negotiate the key exchange - part of the protocol. - - - A - - - - - - Return an implementation of to handle authentication - part of the protocol. - - - - - A list of - - - - RFC 5077 3.3. NewSessionTicket Handshake Message - - This method will be called (only) when a NewSessionTicket handshake message is received. The - ticket is opaque to the client and clients MUST NOT examine the ticket under the assumption - that it complies with e.g. RFC 5077 4. Recommended Ticket Construction. - - The ticket - - - - Constructor for blocking mode. - @param stream The bi-directional stream of data to/from the server - @param secureRandom Random number generator for various cryptographic functions - - - Constructor for blocking mode. - @param input The stream of data from the server - @param output The stream of data to the server - @param secureRandom Random number generator for various cryptographic functions - - - Constructor for non-blocking mode.
-
- When data is received, use {@link #offerInput(java.nio.ByteBuffer)} to - provide the received ciphertext, then use - {@link #readInput(byte[], int, int)} to read the corresponding cleartext.
-
- Similarly, when data needs to be sent, use - {@link #offerOutput(byte[], int, int)} to provide the cleartext, then use - {@link #readOutput(byte[], int, int)} to get the corresponding - ciphertext. - - @param secureRandom - Random number generator for various cryptographic functions -
- - Initiates a TLS handshake in the role of client.
-
- In blocking mode, this will not return until the handshake is complete. - In non-blocking mode, use {@link TlsPeer#NotifyHandshakeComplete()} to - receive a callback when the handshake is complete. - - @param tlsClient The {@link TlsClient} to use for the handshake. - @throws IOException If in blocking mode and handshake was not successful. -
- - - - - Used to get the resumable session, if any, used by this connection. Only available after the - handshake has successfully completed. - - @return A {@link TlsSession} representing the resumable session used by this connection, or - null if no resumable session available. - @see TlsPeer#NotifyHandshakeComplete() - - - Export keying material according to RFC 5705: "Keying Material Exporters for TLS". - - @param asciiLabel indicates which application will use the exported keys. - @param context_value allows the application using the exporter to mix its own data with the TLS PRF for - the exporter output. - @param length the number of bytes to generate - @return a pseudorandom bit string of 'length' bytes generated from the master_secret. - - - (D)TLS DH key exchange. - - - An interface for verifying that Diffie-Hellman parameters are acceptable. - - - Verify that the given DHParameters are acceptable. - The DHParameters to verify. - true if (and only if) the specified parameters are acceptable. - - - (D)TLS ECDHE key exchange (see RFC 4492). - - - (D)TLS ECDH key exchange (see RFC 4492). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A generic interface for key exchange implementations in (D)TLS. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A generic TLS MAC implementation, acting as an HMAC based on some underlying Digest. - - - - Generate a new instance of an TlsMac. - - @param context the TLS client context - @param digest The digest to use. - @param key A byte-array where the key for this MAC is located. - @param keyOff The number of bytes to skip, before the key starts in the buffer. - @param keyLen The length of the key. - - - @return the MAC write secret - - - @return The output length of this MAC. - - - Calculate the MAC for some given data. - - @param type The message type of the message. - @param message A byte-buffer containing the message. - @param offset The number of bytes to skip, before the message starts. - @param length The length of the message. - @return A new byte-buffer containing the MAC value. - - - - This exception will be thrown(only) when the connection is closed by the peer without sending a - close_notify warning alert. - - - If this happens, the TLS protocol cannot rule out truncation of the connection data (potentially - malicious). It may be possible to check for truncation via some property of a higher level protocol - built upon TLS, e.g.the Content-Length header for HTTPS. - - - - - A NULL CipherSuite, with optional MAC. - - - - - - - - - - - - - - - - - Specify the timeout, in milliseconds, to use for the complete handshake process. - - - Negative values are not allowed. A timeout of zero means an infinite timeout (i.e. the - handshake will never time out). NOTE: Currently only respected by DTLS protocols. - - - - - This implementation supports RFC 7627 and will always negotiate the extended_master_secret - extension where possible. - - - When connecting to a peer that does not offer/accept this extension, it is recommended to - abort the handshake. This option is provided for interoperability with legacy peers, - although some TLS features will be disabled in that case (see RFC 7627 5.4). - - - true if the handshake should be aborted when the peer does not negotiate the - extended_master_secret extension, or false to support legacy interoperability. - - - - - draft-mathewson-no-gmtunixtime-00 2. "If existing users of a TLS implementation may rely on - gmt_unix_time containing the current time, we recommend that implementors MAY provide the - ability to set gmt_unix_time as an option only, off by default." - - - true if the current time should be used in the gmt_unix_time field of - Random, or false if gmt_unix_time should contain a cryptographically - random value. - - - - - Report whether the server supports secure renegotiation - - - The protocol handler automatically processes the relevant extensions - - - A , true if the server supports secure renegotiation - - - - - - Return an implementation of to handle record compression. - - A - - - - - Return an implementation of to use for encryption/decryption. - - A - - - - This method will be called when an alert is raised by the protocol. - - - A human-readable message explaining what caused this alert. May be null. - The Exception that caused this alert to be raised. May be null. - - - This method will be called when an alert is received from the remote peer. - - - - - Notifies the peer that the handshake has been successfully completed. - - - - This method is called, when a change cipher spec message is received. - - @throws IOException If the message has an invalid content or the handshake is not in the correct - state. - - - Read data from the network. The method will return immediately, if there is still some data - left in the buffer, or block until some application data has been read from the network. - - @param buf The buffer where the data will be copied to. - @param offset The position where the data will be placed in the buffer. - @param len The maximum number of bytes to read. - @return The number of bytes read. - @throws IOException If something goes wrong during reading data. - - - Send some application data to the remote system. -

- The method will handle fragmentation internally. - - @param buf The buffer with the data. - @param offset The position in the buffer where the data is placed. - @param len The length of the data. - @throws IOException If something goes wrong during sending. - - -

The secure bidirectional stream for this connection - Only allowed in blocking mode. -
- - Should be called in non-blocking mode when the input data reaches EOF. - - - Equivalent to OfferInput(input, 0, input.length) - @see TlsProtocol#OfferInput(byte[], int, int) - @param input The input buffer to offer - @throws IOException If an error occurs while decrypting or processing a record - - - Offer input from an arbitrary source. Only allowed in non-blocking mode.
-
- This method will decrypt and process all records that are fully available. - If only part of a record is available, the buffer will be retained until the - remainder of the record is offered.
-
- If any records containing application data were processed, the decrypted data - can be obtained using {@link #readInput(byte[], int, int)}. If any records - containing protocol data were processed, a response may have been generated. - You should always check to see if there is any available output after calling - this method by calling {@link #getAvailableOutputBytes()}. - @param input The input buffer to offer - @param inputOff The offset within the input buffer that input begins - @param inputLen The number of bytes of input being offered - @throws IOException If an error occurs while decrypting or processing a record -
- - Gets the amount of received application data. A call to {@link #readInput(byte[], int, int)} - is guaranteed to be able to return at least this much data.
-
- Only allowed in non-blocking mode. - @return The number of bytes of available application data -
- - Retrieves received application data. Use {@link #getAvailableInputBytes()} to check - how much application data is currently available. This method functions similarly to - {@link InputStream#read(byte[], int, int)}, except that it never blocks. If no data - is available, nothing will be copied and zero will be returned.
-
- Only allowed in non-blocking mode. - @param buffer The buffer to hold the application data - @param offset The start offset in the buffer at which the data is written - @param length The maximum number of bytes to read - @return The total number of bytes copied to the buffer. May be less than the - length specified if the length was greater than the amount of available data. -
- - Offer output from an arbitrary source. Only allowed in non-blocking mode.
-
- After this method returns, the specified section of the buffer will have been - processed. Use {@link #readOutput(byte[], int, int)} to get the bytes to - transmit to the other peer.
-
- This method must not be called until after the handshake is complete! Attempting - to call it before the handshake is complete will result in an exception. - @param buffer The buffer containing application data to encrypt - @param offset The offset at which to begin reading data - @param length The number of bytes of data to read - @throws IOException If an error occurs encrypting the data, or the handshake is not complete -
- - Gets the amount of encrypted data available to be sent. A call to - {@link #readOutput(byte[], int, int)} is guaranteed to be able to return at - least this much data.
-
- Only allowed in non-blocking mode. - @return The number of bytes of available encrypted data -
- - Retrieves encrypted data to be sent. Use {@link #getAvailableOutputBytes()} to check - how much encrypted data is currently available. This method functions similarly to - {@link InputStream#read(byte[], int, int)}, except that it never blocks. If no data - is available, nothing will be copied and zero will be returned.
-
- Only allowed in non-blocking mode. - @param buffer The buffer to hold the encrypted data - @param offset The start offset in the buffer at which the data is written - @param length The maximum number of bytes to read - @return The total number of bytes copied to the buffer. May be less than the - length specified if the length was greater than the amount of available data. -
- - Closes this connection. - - @throws IOException If something goes wrong during closing. - - - Make sure the InputStream 'buf' now empty. Fail otherwise. - - @param buf The InputStream to check. - @throws IOException If 'buf' is not empty. - - - 'sender' only relevant to SSLv3 - - - Both streams can be the same object - - - (D)TLS PSK key exchange (RFC 4279). - - - (D)TLS and SSLv3 RSA key exchange. - - - - - - - - - - - - - - - - - - A (Int32 -> byte[]). Will never be null. - - - - - - - - - - - - - - Get the (optional) table of server extensions to be included in (extended) server hello. - - - A (Int32 -> byte[]). May be null. - - - - - - A (). May be null. - - - - - - - - - This method will be called (only) if the server included an extension of type - "status_request" with empty "extension_data" in the extended server hello. See RFC 3546 - 3.6. Certificate Status Request. If a non-null is returned, it - is sent to the client as a handshake message of type "certificate_status". - - A to be sent to the client (or null for none). - - - - - - - - - - () - - - - - Called by the protocol handler to report the client certificate, only if GetCertificateRequest - returned non-null. - - Note: this method is responsible for certificate verification and validation. - the effective client certificate (may be an empty chain). - - - - RFC 5077 3.3. NewSessionTicket Handshake Message. - - This method will be called (only) if a NewSessionTicket extension was sent by the server. See - RFC 5077 4. Recommended Ticket Construction for recommended format and protection. - - The ticket) - - - - Constructor for blocking mode. - @param stream The bi-directional stream of data to/from the client - @param output The stream of data to the client - @param secureRandom Random number generator for various cryptographic functions - - - Constructor for blocking mode. - @param input The stream of data from the client - @param output The stream of data to the client - @param secureRandom Random number generator for various cryptographic functions - - - Constructor for non-blocking mode.
-
- When data is received, use {@link #offerInput(java.nio.ByteBuffer)} to - provide the received ciphertext, then use - {@link #readInput(byte[], int, int)} to read the corresponding cleartext.
-
- Similarly, when data needs to be sent, use - {@link #offerOutput(byte[], int, int)} to provide the cleartext, then use - {@link #readOutput(byte[], int, int)} to get the corresponding - ciphertext. - - @param secureRandom - Random number generator for various cryptographic functions -
- - Receives a TLS handshake in the role of server.
-
- In blocking mode, this will not return until the handshake is complete. - In non-blocking mode, use {@link TlsPeer#notifyHandshakeComplete()} to - receive a callback when the handshake is complete. - - @param tlsServer - @throws IOException If in blocking mode and handshake was not successful. -
- - - - - Check whether the given SRP group parameters are acceptable for use. - - @param group the {@link SRP6GroupParameters} to check - @return true if (and only if) the specified group parameters are acceptable - - - Lookup the {@link TlsSRPLoginParameters} corresponding to the specified identity. - - NOTE: To avoid "identity probing", unknown identities SHOULD be handled as recommended in RFC - 5054 2.5.1.3. {@link SimulatedTlsSRPIdentityManager} is provided for this purpose. - - @param identity - the SRP identity sent by the connecting client - @return the {@link TlsSRPLoginParameters} for the specified identity, or else 'simulated' - parameters if the identity is not recognized. A null value is also allowed, but not - recommended. - - - (D)TLS SRP key exchange (RFC 5054). - - - RFC 5764 DTLS Extension to Establish Keys for SRTP. - - - - - - - - - - - - Some helper functions for MicroTLS. - - - Add a 'signature_algorithms' extension to existing extensions. - - @param extensions A {@link Hashtable} to add the extension to. - @param supportedSignatureAlgorithms {@link Vector} containing at least 1 {@link SignatureAndHashAlgorithm}. - @throws IOException - - - Get a 'signature_algorithms' extension from extensions. - - @param extensions A {@link Hashtable} to get the extension from, if it is present. - @return A {@link Vector} containing at least 1 {@link SignatureAndHashAlgorithm}, or null. - @throws IOException - - - Create a 'signature_algorithms' extension value. - - @param supportedSignatureAlgorithms A {@link Vector} containing at least 1 {@link SignatureAndHashAlgorithm}. - @return A byte array suitable for use as an extension value. - @throws IOException - - - Read 'signature_algorithms' extension data. - - @param extensionData The extension data. - @return A {@link Vector} containing at least 1 {@link SignatureAndHashAlgorithm}. - @throws IOException - - - RFC 6066 5. - - - Encode this {@link UrlAndHash} to a {@link Stream}. - - @param output the {@link Stream} to encode to. - @throws IOException - - - Parse a {@link UrlAndHash} from a {@link Stream}. - - @param context - the {@link TlsContext} of the current connection. - @param input - the {@link Stream} to parse from. - @return a {@link UrlAndHash} object. - @throws IOException - - - RFC 4681 - - - RFC 5764 4.1.1 - - - @param protectionProfiles see {@link SrtpProtectionProfile} for valid constants. - @param mki valid lengths from 0 to 255. - - - @return see {@link SrtpProtectionProfile} for valid constants. - - - @return valid lengths from 0 to 255. - - - Create an AlgorithmIdentifier for the passed in encryption algorithm. - - @param encryptionOID OID for the encryption algorithm - @param keySize key size in bits (-1 if unknown) - @param random SecureRandom to use for parameter generation. - @return a full AlgorithmIdentifier including parameters - @throws IllegalArgumentException if encryptionOID cannot be matched - - - A basic alphabet mapper that just creates a mapper based on the - passed in array of characters. - - - Base constructor. - - @param alphabet a string of characters making up the alphabet. - - - Base constructor. - - @param alphabet an array of characters making up the alphabet. - - - Create a key generator for the passed in Object Identifier. - - @param algorithm the Object Identifier indicating the algorithn the generator is for. - @param random a source of random to initialise the generator with. - @return an initialised CipherKeyGenerator. - @throws IllegalArgumentException if the algorithm cannot be identified. - - - Use KeyTransRecipientInfoGenerator - - - return a = a + b - b preserved. - - - unsigned comparison on two arrays - note the arrays may - start with leading zeros. - - - return z = x / y - done in place (z value preserved, x contains the - remainder) - - - return whether or not a BigInteger is probably prime with a - probability of 1 - (1/2)**certainty. -

From Knuth Vol 2, pg 395.

-
- - Calculate the numbers u1, u2, and u3 such that: - - u1 * a + u2 * b = u3 - - where u3 is the greatest common divider of a and b. - a and b using the extended Euclid algorithm (refer p. 323 - of The Art of Computer Programming vol 2, 2nd ed). - This also seems to have the side effect of calculating - some form of multiplicative inverse. - - @param a First number to calculate gcd for - @param b Second number to calculate gcd for - @param u1Out the return object for the u1 value - @return The greatest common divisor of a and b - - - return w with w = x * x - w is assumed to have enough space. - - - return x with x = y * z - x is assumed to have enough space. - - - Calculate mQuote = -m^(-1) mod b with b = 2^32 (32 = word size) - - - Montgomery multiplication: a = x * y * R^(-1) mod m -
- Based algorithm 14.36 of Handbook of Applied Cryptography. -
-
  • m, x, y should have length n
  • -
  • a should have length (n + 1)
  • -
  • b = 2^32, R = b^n
  • -
    - The result is put in x -
    - NOTE: the indices of x, y, m, a different in HAC and in Java -
    - - return x = x % y - done in place (y value preserved) - - - do a left shift - this returns a new array. - - - do a right shift - this does it in place. - - - do a right shift by one - this does it in place. - - - returns x = x - y - we assume x is >= y - - - Class representing a simple version of a big decimal. A - SimpleBigDecimal is basically a - {@link java.math.BigInteger BigInteger} with a few digits on the right of - the decimal point. The number of (binary) digits on the right of the decimal - point is called the scale of the SimpleBigDecimal. - Unlike in {@link java.math.BigDecimal BigDecimal}, the scale is not adjusted - automatically, but must be set manually. All SimpleBigDecimals - taking part in the same arithmetic operation must have equal scale. The - result of a multiplication of two SimpleBigDecimals returns a - SimpleBigDecimal with double scale. - - - Returns a SimpleBigDecimal representing the same numerical - value as value. - @param value The value of the SimpleBigDecimal to be - created. - @param scale The scale of the SimpleBigDecimal to be - created. - @return The such created SimpleBigDecimal. - - - Constructor for SimpleBigDecimal. The value of the - constructed SimpleBigDecimal Equals bigInt / - 2scale. - @param bigInt The bigInt value parameter. - @param scale The scale of the constructed SimpleBigDecimal. - - - Class holding methods for point multiplication based on the window - τ-adic nonadjacent form (WTNAF). The algorithms are based on the - paper "Improved Algorithms for Arithmetic on Anomalous Binary Curves" - by Jerome A. Solinas. The paper first appeared in the Proceedings of - Crypto 1997. - - - The window width of WTNAF. The standard value of 4 is slightly less - than optimal for running time, but keeps space requirements for - precomputation low. For typical curves, a value of 5 or 6 results in - a better running time. When changing this value, the - αu's must be computed differently, see - e.g. "Guide to Elliptic Curve Cryptography", Darrel Hankerson, - Alfred Menezes, Scott Vanstone, Springer-Verlag New York Inc., 2004, - p. 121-122 - - - 24 - - - The αu's for a=0 as an array - of ZTauElements. - - - The αu's for a=0 as an array - of TNAFs. - - - The αu's for a=1 as an array - of ZTauElements. - - - The αu's for a=1 as an array - of TNAFs. - - - Computes the norm of an element λ of - Z[τ]. - @param mu The parameter μ of the elliptic curve. - @param lambda The element λ of - Z[τ]. - @return The norm of λ. - - - Computes the norm of an element λ of - R[τ], where λ = u + vτ - and u and u are real numbers (elements of - R). - @param mu The parameter μ of the elliptic curve. - @param u The real part of the element λ of - R[τ]. - @param v The τ-adic part of the element - λ of R[τ]. - @return The norm of λ. - - - Rounds an element λ of R[τ] - to an element of Z[τ], such that their difference - has minimal norm. λ is given as - λ = λ0 + λ1τ. - @param lambda0 The component λ0. - @param lambda1 The component λ1. - @param mu The parameter μ of the elliptic curve. Must - equal 1 or -1. - @return The rounded element of Z[τ]. - @throws ArgumentException if lambda0 and - lambda1 do not have same scale. - - - Approximate division by n. For an integer - k, the value λ = s k / n is - computed to c bits of accuracy. - @param k The parameter k. - @param s The curve parameter s0 or - s1. - @param vm The Lucas Sequence element Vm. - @param a The parameter a of the elliptic curve. - @param m The bit length of the finite field - Fm. - @param c The number of bits of accuracy, i.e. the scale of the returned - SimpleBigDecimal. - @return The value λ = s k / n computed to - c bits of accuracy. - - - Computes the τ-adic NAF (non-adjacent form) of an - element λ of Z[τ]. - @param mu The parameter μ of the elliptic curve. - @param lambda The element λ of - Z[τ]. - @return The τ-adic NAF of λ. - - - Applies the operation τ() to an - AbstractF2mPoint. - @param p The AbstractF2mPoint to which τ() is applied. - @return τ(p) - - - Returns the parameter μ of the elliptic curve. - @param curve The elliptic curve from which to obtain μ. - The curve must be a Koblitz curve, i.e. a Equals - 0 or 1 and b Equals - 1. - @return μ of the elliptic curve. - @throws ArgumentException if the given ECCurve is not a Koblitz - curve. - - - Calculates the Lucas Sequence elements Uk-1 and - Uk or Vk-1 and - Vk. - @param mu The parameter μ of the elliptic curve. - @param k The index of the second element of the Lucas Sequence to be - returned. - @param doV If set to true, computes Vk-1 and - Vk, otherwise Uk-1 and - Uk. - @return An array with 2 elements, containing Uk-1 - and Uk or Vk-1 - and Vk. - - - Computes the auxiliary value tw. If the width is - 4, then for mu = 1, tw = 6 and for - mu = -1, tw = 10 - @param mu The parameter μ of the elliptic curve. - @param w The window width of the WTNAF. - @return the auxiliary value tw - - - Computes the auxiliary values s0 and - s1 used for partial modular reduction. - @param curve The elliptic curve for which to compute - s0 and s1. - @throws ArgumentException if curve is not a - Koblitz curve (Anomalous Binary Curve, ABC). - - - Partial modular reduction modulo - (τm - 1)/(τ - 1). - @param k The integer to be reduced. - @param m The bitlength of the underlying finite field. - @param a The parameter a of the elliptic curve. - @param s The auxiliary values s0 and - s1. - @param mu The parameter μ of the elliptic curve. - @param c The precision (number of bits of accuracy) of the partial - modular reduction. - @return ρ := k partmod (τm - 1)/(τ - 1) - - - Multiplies a {@link org.bouncycastle.math.ec.AbstractF2mPoint AbstractF2mPoint} - by a BigInteger using the reduced τ-adic - NAF (RTNAF) method. - @param p The AbstractF2mPoint to Multiply. - @param k The BigInteger by which to Multiply p. - @return k * p - - - Multiplies a {@link org.bouncycastle.math.ec.AbstractF2mPoint AbstractF2mPoint} - by an element λ of Z[τ] - using the τ-adic NAF (TNAF) method. - @param p The AbstractF2mPoint to Multiply. - @param lambda The element λ of - Z[τ]. - @return λ * p - - - Multiplies a {@link org.bouncycastle.math.ec.AbstractF2mPoint AbstractF2mPoint} - by an element λ of Z[τ] - using the τ-adic NAF (TNAF) method, given the TNAF - of λ. - @param p The AbstractF2mPoint to Multiply. - @param u The the TNAF of λ.. - @return λ * p - - - Computes the [τ]-adic window NAF of an element - λ of Z[τ]. - @param mu The parameter μ of the elliptic curve. - @param lambda The element λ of - Z[τ] of which to compute the - [τ]-adic NAF. - @param width The window width of the resulting WNAF. - @param pow2w 2width. - @param tw The auxiliary value tw. - @param alpha The αu's for the window width. - @return The [τ]-adic window NAF of - λ. - - - Does the precomputation for WTNAF multiplication. - @param p The ECPoint for which to do the precomputation. - @param a The parameter a of the elliptic curve. - @return The precomputation array for p. - - - Class representing an element of Z[τ]. Let - λ be an element of Z[τ]. Then - λ is given as λ = u + vτ. The - components u and v may be used directly, there - are no accessor methods. - Immutable class. - - - The "real" part of λ. - - - The "τ-adic" part of λ. - - - Constructor for an element λ of - Z[τ]. - @param u The "real" part of λ. - @param v The "τ-adic" part of - λ. - - - return a sqrt root - the routine verifies that the calculation returns the right value - if - none exists it returns null. - - - Create a point which encodes with point compression. - - @param curve the curve to use - @param x affine x co-ordinate - @param y affine y co-ordinate - - @deprecated Use ECCurve.CreatePoint to construct points - - - Create a point that encodes with or without point compresion. - - @param curve the curve to use - @param x affine x co-ordinate - @param y affine y co-ordinate - @param withCompression if true encode with point compression - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - return a sqrt root - the routine verifies that the calculation returns the right value - if - none exists it returns null. - - - Create a point which encodes with point compression. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - - @deprecated Use ECCurve.createPoint to construct points - - - Create a point that encodes with or without point compresion. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - @param withCompression - if true encode with point compression - - @deprecated per-point compression property will be removed, refer - {@link #getEncoded(bool)} - - - return a sqrt root - the routine verifies that the calculation returns the right value - if - none exists it returns null. - - - Create a point which encodes with point compression. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - - @deprecated Use ECCurve.createPoint to construct points - - - Create a point that encodes with or without point compresion. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - @param withCompression - if true encode with point compression - - @deprecated per-point compression property will be removed, refer - {@link #getEncoded(boolean)} - - - Create a point which encodes with point compression. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - - @deprecated Use ECCurve.CreatePoint to construct points - - - Create a point that encodes with or without point compresion. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - @param withCompression - if true encode with point compression - - @deprecated per-point compression property will be removed, refer - {@link #getEncoded(bool)} - - - return a sqrt root - the routine verifies that the calculation returns the right value - if - none exists it returns null. - - - Create a point which encodes with point compression. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - - @deprecated Use ECCurve.CreatePoint to construct points - - - Create a point that encodes with or without point compresion. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - @param withCompression - if true encode with point compression - - @deprecated per-point compression property will be removed, refer - {@link #getEncoded(bool)} - - - return a sqrt root - the routine verifies that the calculation returns the right value - if - none exists it returns null. - - - Create a point which encodes with point compression. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - - @deprecated Use ECCurve.CreatePoint to construct points - - - Create a point that encodes with or without point compresion. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - @param withCompression - if true encode with point compression - - @deprecated per-point compression property will be removed, refer - {@link #getEncoded(bool)} - - - return a sqrt root - the routine verifies that the calculation returns the right value - if - none exists it returns null. - - - Create a point which encodes with point compression. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - - @deprecated Use ECCurve.createPoint to construct points - - - Create a point that encodes with or without point compresion. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - @param withCompression - if true encode with point compression - - @deprecated per-point compression property will be removed, refer - {@link #getEncoded(bool)} - - - return a sqrt root - the routine verifies that the calculation returns the right value - if - none exists it returns null. - - - Create a point which encodes with point compression. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - - @deprecated Use ECCurve.createPoint to construct points - - - Create a point that encodes with or without point compresion. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - @param withCompression - if true encode with point compression - - @deprecated per-point compression property will be removed, refer - {@link #getEncoded(bool)} - - - return a sqrt root - the routine verifies that the calculation returns the right value - if - none exists it returns null. - - - Create a point which encodes with point compression. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - - @deprecated Use ECCurve.createPoint to construct points - - - Create a point that encodes with or without point compresion. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - @param withCompression - if true encode with point compression - - @deprecated per-point compression property will be removed, refer - {@link #getEncoded(bool)} - - - return a sqrt root - the routine verifies that the calculation returns the right value - if - none exists it returns null. - - - Create a point which encodes with point compression. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - - @deprecated Use ECCurve.createPoint to construct points - - - Create a point that encodes with or without point compresion. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - @param withCompression - if true encode with point compression - - @deprecated per-point compression property will be removed, refer - {@link #getEncoded(bool)} - - - return a sqrt root - the routine verifies that the calculation returns the right value - if - none exists it returns null. - - - Create a point which encodes with point compression. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - - @deprecated Use ECCurve.createPoint to construct points - - - Create a point that encodes with or without point compresion. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - @param withCompression - if true encode with point compression - - @deprecated per-point compression property will be removed, refer - {@link #getEncoded(bool)} - - - return a sqrt root - the routine verifies that the calculation returns the right value - if - none exists it returns null. - - - Create a point which encodes with point compression. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - - @deprecated Use ECCurve.createPoint to construct points - - - Create a point that encodes with or without point compresion. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - @param withCompression - if true encode with point compression - - @deprecated per-point compression property will be removed, refer - {@link #getEncoded(bool)} - - - return a sqrt root - the routine verifies that the calculation returns the right value - if - none exists it returns null. - - - Create a point which encodes with point compression. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - - @deprecated Use ECCurve.createPoint to construct points - - - Create a point that encodes with or without point compresion. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - @param withCompression - if true encode with point compression - - @deprecated per-point compression property will be removed, refer - {@link #getEncoded(bool)} - - - return a sqrt root - the routine verifies that the calculation returns the right value - if - none exists it returns null. - - - Create a point which encodes with point compression. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - - @deprecated Use ECCurve.createPoint to construct points - - - Create a point that encodes with or without point compresion. - - @param curve - the curve to use - @param x - affine x co-ordinate - @param y - affine y co-ordinate - @param withCompression - if true encode with point compression - - @deprecated per-point compression property will be removed, refer - {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - @deprecated Use ECCurve.createPoint to construct points - - - @deprecated per-point compression property will be removed, refer {@link #getEncoded(bool)} - - - Simple shift-and-add multiplication. Serves as reference implementation to verify (possibly - faster) implementations, and for very small scalars. CAUTION: This implementation is NOT - constant-time in any way. It is only intended to be used for diagnostics. - - @param p - The point to multiply. - @param k - The multiplier. - @return The result of the point multiplication kP. - - - Base class for an elliptic curve. - - - Compute a PreCompInfo for a point on this curve, under a given name. Used by - ECMultipliers to save the precomputation for this ECPoint for use - by subsequent multiplication. - - @param point - The ECPoint to store precomputations for. - @param name - A String used to index precomputations of different types. - @param callback - Called to calculate the PreCompInfo. - - - Normalization ensures that any projective coordinate is 1, and therefore that the x, y - coordinates reflect those of the equivalent point in an affine coordinate system. Where more - than one point is to be normalized, this method will generally be more efficient than - normalizing each point separately. - - @param points - An array of points that will be updated in place with their normalized versions, - where necessary - - - Normalization ensures that any projective coordinate is 1, and therefore that the x, y - coordinates reflect those of the equivalent point in an affine coordinate system. Where more - than one point is to be normalized, this method will generally be more efficient than - normalizing each point separately. An (optional) z-scaling factor can be applied; effectively - each z coordinate is scaled by this value prior to normalization (but only one - actual multiplication is needed). - - @param points - An array of points that will be updated in place with their normalized versions, - where necessary - @param off - The start of the range of points to normalize - @param len - The length of the range of points to normalize - @param iso - The (optional) z-scaling factor - can be null - - - Create a cache-safe lookup table for the specified sequence of points. All the points MUST - belong to this ECCurve instance, and MUST already be normalized. - - - Sets the default ECMultiplier, unless already set. - - We avoid locking for performance reasons, so there is no uniqueness guarantee. - - - Decode a point on this curve from its ASN.1 encoding. The different - encodings are taken account of, including point compression for - Fp (X9.62 s 4.2.1 pg 17). - @return The decoded point. - - - Elliptic curve over Fp - - - The auxiliary values s0 and - s1 used for partial modular reduction for - Koblitz curves. - - - Solves a quadratic equation z2 + z = beta(X9.62 - D.1.6) The other solution is z + 1. - - @param beta - The value to solve the quadratic equation for. - @return the solution for z2 + z = beta or - null if no solution exists. - - - @return the auxiliary values s0 and - s1 used for partial modular reduction for - Koblitz curves. - - - Returns true if this is a Koblitz curve (ABC curve). - @return true if this is a Koblitz curve (ABC curve), false otherwise - - - Elliptic curves over F2m. The Weierstrass equation is given by - y2 + xy = x3 + ax2 + b. - - - The exponent m of F2m. - - - TPB: The integer k where xm + - xk + 1 represents the reduction polynomial - f(z).
    - PPB: The integer k1 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z).
    -
    - - TPB: Always set to 0
    - PPB: The integer k2 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z).
    -
    - - TPB: Always set to 0
    - PPB: The integer k3 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z).
    -
    - - The point at infinity on this curve. - - - Constructor for Trinomial Polynomial Basis (TPB). - @param m The exponent m of - F2m. - @param k The integer k where xm + - xk + 1 represents the reduction - polynomial f(z). - @param a The coefficient a in the Weierstrass equation - for non-supersingular elliptic curves over - F2m. - @param b The coefficient b in the Weierstrass equation - for non-supersingular elliptic curves over - F2m. - - - Constructor for Trinomial Polynomial Basis (TPB). - @param m The exponent m of - F2m. - @param k The integer k where xm + - xk + 1 represents the reduction - polynomial f(z). - @param a The coefficient a in the Weierstrass equation - for non-supersingular elliptic curves over - F2m. - @param b The coefficient b in the Weierstrass equation - for non-supersingular elliptic curves over - F2m. - @param order The order of the main subgroup of the elliptic curve. - @param cofactor The cofactor of the elliptic curve, i.e. - #Ea(F2m) = h * n. - - - Constructor for Pentanomial Polynomial Basis (PPB). - @param m The exponent m of - F2m. - @param k1 The integer k1 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z). - @param k2 The integer k2 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z). - @param k3 The integer k3 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z). - @param a The coefficient a in the Weierstrass equation - for non-supersingular elliptic curves over - F2m. - @param b The coefficient b in the Weierstrass equation - for non-supersingular elliptic curves over - F2m. - - - Constructor for Pentanomial Polynomial Basis (PPB). - @param m The exponent m of - F2m. - @param k1 The integer k1 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z). - @param k2 The integer k2 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z). - @param k3 The integer k3 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z). - @param a The coefficient a in the Weierstrass equation - for non-supersingular elliptic curves over - F2m. - @param b The coefficient b in the Weierstrass equation - for non-supersingular elliptic curves over - F2m. - @param order The order of the main subgroup of the elliptic curve. - @param cofactor The cofactor of the elliptic curve, i.e. - #Ea(F2m) = h * n. - - - Return true if curve uses a Trinomial basis. - - @return true if curve Trinomial, false otherwise. - - - return the field name for this field. - - @return the string "Fp". - - - return a sqrt root - the routine verifies that the calculation - returns the right value - if none exists it returns null. - - - Class representing the Elements of the finite field - F2m in polynomial basis (PB) - representation. Both trinomial (Tpb) and pentanomial (Ppb) polynomial - basis representations are supported. Gaussian normal basis (GNB) - representation is not supported. - - - Indicates gaussian normal basis representation (GNB). Number chosen - according to X9.62. GNB is not implemented at present. - - - Indicates trinomial basis representation (Tpb). Number chosen - according to X9.62. - - - Indicates pentanomial basis representation (Ppb). Number chosen - according to X9.62. - - - Tpb or Ppb. - - - The exponent m of F2m. - - - The LongArray holding the bits. - - - Constructor for Ppb. - @param m The exponent m of - F2m. - @param k1 The integer k1 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z). - @param k2 The integer k2 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z). - @param k3 The integer k3 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z). - @param x The BigInteger representing the value of the field element. - - - Constructor for Tpb. - @param m The exponent m of - F2m. - @param k The integer k where xm + - xk + 1 represents the reduction - polynomial f(z). - @param x The BigInteger representing the value of the field element. - - - Checks, if the ECFieldElements a and b - are elements of the same field F2m - (having the same representation). - @param a field element. - @param b field element to be compared. - @throws ArgumentException if a and b - are not elements of the same field - F2m (having the same - representation). - - - @return the representation of the field - F2m, either of - {@link F2mFieldElement.Tpb} (trinomial - basis representation) or - {@link F2mFieldElement.Ppb} (pentanomial - basis representation). - - - @return the degree m of the reduction polynomial - f(z). - - - @return Tpb: The integer k where xm + - xk + 1 represents the reduction polynomial - f(z).
    - Ppb: The integer k1 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z).
    -
    - - @return Tpb: Always returns 0
    - Ppb: The integer k2 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z).
    -
    - - @return Tpb: Always set to 0
    - Ppb: The integer k3 where xm + - xk3 + xk2 + xk1 + 1 - represents the reduction polynomial f(z).
    -
    - - base class for points on elliptic curves. - - - Returns the affine x-coordinate after checking that this point is normalized. - - @return The affine x-coordinate of this point - @throws IllegalStateException if the point is not normalized - - - Returns the affine y-coordinate after checking that this point is normalized - - @return The affine y-coordinate of this point - @throws IllegalStateException if the point is not normalized - - - Returns the x-coordinate. - - Caution: depending on the curve's coordinate system, this may not be the same value as in an - affine coordinate system; use Normalize() to get a point where the coordinates have their - affine values, or use AffineXCoord if you expect the point to already have been normalized. - - @return the x-coordinate of this point - - - Returns the y-coordinate. - - Caution: depending on the curve's coordinate system, this may not be the same value as in an - affine coordinate system; use Normalize() to get a point where the coordinates have their - affine values, or use AffineYCoord if you expect the point to already have been normalized. - - @return the y-coordinate of this point - - - Normalization ensures that any projective coordinate is 1, and therefore that the x, y - coordinates reflect those of the equivalent point in an affine coordinate system. - - @return a new ECPoint instance representing the same point, but with normalized coordinates - - - return the field element encoded with point compression. (S 4.3.6) - - - Multiplies this ECPoint by the given number. - @param k The multiplicator. - @return k * this. - - - Elliptic curve points over Fp - - - Create a point which encodes without point compression. - - @param curve the curve to use - @param x affine x co-ordinate - @param y affine y co-ordinate - - - Create a point that encodes with or without point compression. - - @param curve the curve to use - @param x affine x co-ordinate - @param y affine y co-ordinate - @param withCompression if true encode with point compression - - - Elliptic curve points over F2m - - - @param curve base curve - @param x x point - @param y y point - - - @param curve base curve - @param x x point - @param y y point - @param withCompression true if encode with point compression. - - - Joye's double-add algorithm. - - - Interface for classes encapsulating a point multiplication algorithm - for ECPoints. - - - Multiplies the ECPoint p by k, i.e. - p is added k times to itself. - @param p The ECPoint to be multiplied. - @param k The factor by which p is multiplied. - @return p multiplied by k. - - - Class holding precomputation data for fixed-point multiplications. - - - Lookup table for the precomputed ECPoints used for a fixed point multiplication. - - - The width used for the precomputation. If a larger width precomputation - is already available this may be larger than was requested, so calling - code should refer to the actual width. - - - Class implementing the NAF (Non-Adjacent Form) multiplication algorithm (right-to-left) using - mixed coordinates. - - - By default, addition will be done in Jacobian coordinates, and doubling will be done in - Modified Jacobian coordinates (independent of the original coordinate system of each point). - - - Montgomery ladder. - - - Class implementing the NAF (Non-Adjacent Form) multiplication algorithm (left-to-right). - - - Class implementing the NAF (Non-Adjacent Form) multiplication algorithm (right-to-left). - - - Interface for classes storing precomputation data for multiplication - algorithms. Used as a Memento (see GOF patterns) for - WNafMultiplier. - - - Class implementing the WNAF (Window Non-Adjacent Form) multiplication - algorithm. - - - Multiplies this by an integer k using the - Window NAF method. - @param k The integer by which this is multiplied. - @return A new ECPoint which equals this - multiplied by k. - - - Class holding precomputation data for the WNAF (Window Non-Adjacent Form) - algorithm. - - - Array holding the precomputed ECPoints used for a Window - NAF multiplication. - - - Array holding the negations of the precomputed ECPoints used - for a Window NAF multiplication. - - - Holds an ECPoint representing Twice(this). Used for the - Window NAF multiplication to create or extend the precomputed values. - - - Computes the Window NAF (non-adjacent Form) of an integer. - @param width The width w of the Window NAF. The width is - defined as the minimal number w, such that for any - w consecutive digits in the resulting representation, at - most one is non-zero. - @param k The integer of which the Window NAF is computed. - @return The Window NAF of the given width, such that the following holds: - k = &sum;i=0l-1 ki2i - , where the ki denote the elements of the - returned byte[]. - - - Determine window width to use for a scalar multiplication of the given size. - - @param bits the bit-length of the scalar to multiply by - @return the window size to use - - - Determine window width to use for a scalar multiplication of the given size. - - @param bits the bit-length of the scalar to multiply by - @param maxWidth the maximum window width to return - @return the window size to use - - - Determine window width to use for a scalar multiplication of the given size. - - @param bits the bit-length of the scalar to multiply by - @param windowSizeCutoffs a monotonically increasing list of bit sizes at which to increment the window width - @return the window size to use - - - Determine window width to use for a scalar multiplication of the given size. - - @param bits the bit-length of the scalar to multiply by - @param windowSizeCutoffs a monotonically increasing list of bit sizes at which to increment the window width - @param maxWidth the maximum window width to return - @return the window size to use - - - Class implementing the WTNAF (Window - τ-adic Non-Adjacent Form) algorithm. - - - Multiplies a {@link org.bouncycastle.math.ec.AbstractF2mPoint AbstractF2mPoint} - by k using the reduced τ-adic NAF (RTNAF) - method. - @param p The AbstractF2mPoint to multiply. - @param k The integer by which to multiply k. - @return p multiplied by k. - - - Multiplies a {@link org.bouncycastle.math.ec.AbstractF2mPoint AbstractF2mPoint} - by an element λ of Z[τ] using - the τ-adic NAF (TNAF) method. - @param p The AbstractF2mPoint to multiply. - @param lambda The element λ of - Z[τ] of which to compute the - [τ]-adic NAF. - @return p multiplied by λ. - - - Multiplies a {@link org.bouncycastle.math.ec.AbstractF2mPoint AbstractF2mPoint} - by an element λ of Z[τ] - using the window τ-adic NAF (TNAF) method, given the - WTNAF of λ. - @param p The AbstractF2mPoint to multiply. - @param u The the WTNAF of λ.. - @return λ * p - - - Class holding precomputation data for the WTNAF (Window - τ-adic Non-Adjacent Form) algorithm. - - - Array holding the precomputed AbstractF2mPoints used for the - WTNAF multiplication in - {@link org.bouncycastle.math.ec.multiplier.WTauNafMultiplier.multiply() - WTauNafMultiplier.multiply()}. - - - 'Zeroless' Signed Digit Left-to-Right. - - - 'Zeroless' Signed Digit Right-to-Left. - - - Utility methods for generating primes and testing for primality. - - - Used to return the output from the - {@linkplain Primes#enhancedMRProbablePrimeTest(BigInteger, SecureRandom, int) Enhanced - Miller-Rabin Probabilistic Primality Test} - - - Used to return the output from the {@linkplain Primes#generateSTRandomPrime(Digest, int, byte[]) Shawe-Taylor Random_Prime Routine} - - - FIPS 186-4 C.6 Shawe-Taylor Random_Prime Routine - - Construct a provable prime number using a hash function. - - @param hash - the {@link Digest} instance to use (as "Hash()"). Cannot be null. - @param length - the length (in bits) of the prime to be generated. Must be at least 2. - @param inputSeed - the seed to be used for the generation of the requested prime. Cannot be null or - empty. - @return an {@link STOutput} instance containing the requested prime. - - - FIPS 186-4 C.3.2 Enhanced Miller-Rabin Probabilistic Primality Test - - Run several iterations of the Miller-Rabin algorithm with randomly-chosen bases. This is an - alternative to {@link #isMRProbablePrime(BigInteger, SecureRandom, int)} that provides more - information about a composite candidate, which may be useful when generating or validating - RSA moduli. - - @param candidate - the {@link BigInteger} instance to test for primality. - @param random - the source of randomness to use to choose bases. - @param iterations - the number of randomly-chosen bases to perform the test for. - @return an {@link MROutput} instance that can be further queried for details. - - - A fast check for small divisors, up to some implementation-specific limit. - - @param candidate - the {@link BigInteger} instance to test for division by small factors. - - @return true if the candidate is found to have any small factors, - false otherwise. - - - FIPS 186-4 C.3.1 Miller-Rabin Probabilistic Primality Test - - Run several iterations of the Miller-Rabin algorithm with randomly-chosen bases. - - @param candidate - the {@link BigInteger} instance to test for primality. - @param random - the source of randomness to use to choose bases. - @param iterations - the number of randomly-chosen bases to perform the test for. - @return false if any witness to compositeness is found amongst the chosen bases - (so candidate is definitely NOT prime), or else true - (indicating primality with some probability dependent on the number of iterations - that were performed). - - - FIPS 186-4 C.3.1 Miller-Rabin Probabilistic Primality Test (to a fixed base). - - Run a single iteration of the Miller-Rabin algorithm against the specified base. - - @param candidate - the {@link BigInteger} instance to test for primality. - @param baseValue - the base value to use for this iteration. - @return false if the specified base is a witness to compositeness (so - candidate is definitely NOT prime), or else true. - - - - - BasicOcspResponse ::= SEQUENCE { - tbsResponseData ResponseData, - signatureAlgorithm AlgorithmIdentifier, - signature BIT STRING, - certs [0] EXPLICIT SEQUENCE OF Certificate OPTIONAL - } - - - - - The DER encoding of the tbsResponseData field. - In the event of an encoding error. - - - The certificates, if any, associated with the response. - In the event of an encoding error. - - - - Verify the signature against the tbsResponseData object we contain. - - - - The ASN.1 encoded representation of this object. - - - Generator for basic OCSP response objects. - - - basic constructor - - - construct with the responderID to be the SHA-1 keyHash of the passed in public key. - - - Add a response for a particular Certificate ID. - - @param certID certificate ID details - @param certStatus status of the certificate - null if okay - - - Add a response for a particular Certificate ID. - - @param certID certificate ID details - @param certStatus status of the certificate - null if okay - @param singleExtensions optional extensions - - - Add a response for a particular Certificate ID. - - @param certID certificate ID details - @param nextUpdate date when next update should be requested - @param certStatus status of the certificate - null if okay - @param singleExtensions optional extensions - - - Add a response for a particular Certificate ID. - - @param certID certificate ID details - @param thisUpdate date this response was valid on - @param nextUpdate date when next update should be requested - @param certStatus status of the certificate - null if okay - @param singleExtensions optional extensions - - - Set the extensions for the response. - - @param responseExtensions the extension object to carry. - - - - Generate the signed response using the passed in signature calculator. - - Implementation of signing calculator factory. - The certificate chain associated with the response signer. - "produced at" date. - - - - Return an IEnumerable of the signature names supported by the generator. - - @return an IEnumerable containing recognised names. - - - create from an issuer certificate and the serial number of the - certificate it signed. - @exception OcspException if any problems occur creating the id fields. - - - return the serial number for the certificate associated - with this request. - - - Create a new CertificateID for a new serial number derived from a previous one - calculated for the same CA certificate. - - @param original the previously calculated CertificateID for the CA. - @param newSerialNumber the serial number for the new certificate of interest. - - @return a new CertificateID for newSerialNumber - - -
    -             OcspRequest     ::=     SEQUENCE {
    -                   tbsRequest                  TBSRequest,
    -                   optionalSignature   [0]     EXPLICIT Signature OPTIONAL }
    -            
    -               TBSRequest      ::=     SEQUENCE {
    -                   version             [0]     EXPLICIT Version DEFAULT v1,
    -                   requestorName       [1]     EXPLICIT GeneralName OPTIONAL,
    -                   requestList                 SEQUENCE OF Request,
    -                   requestExtensions   [2]     EXPLICIT Extensions OPTIONAL }
    -            
    -               Signature       ::=     SEQUENCE {
    -                   signatureAlgorithm      AlgorithmIdentifier,
    -                   signature               BIT STRING,
    -                   certs               [0] EXPLICIT SEQUENCE OF Certificate OPTIONAL}
    -            
    -               Version         ::=             INTEGER  {  v1(0) }
    -            
    -               Request         ::=     SEQUENCE {
    -                   reqCert                     CertID,
    -                   singleRequestExtensions     [0] EXPLICIT Extensions OPTIONAL }
    -            
    -               CertID          ::=     SEQUENCE {
    -                   hashAlgorithm       AlgorithmIdentifier,
    -                   issuerNameHash      OCTET STRING, -- Hash of Issuer's DN
    -                   issuerKeyHash       OCTET STRING, -- Hash of Issuers public key
    -                   serialNumber        CertificateSerialNumber }
    -             
    -
    - - Return the DER encoding of the tbsRequest field. - @return DER encoding of tbsRequest - @throws OcspException in the event of an encoding error. - - - return the object identifier representing the signature algorithm - - - If the request is signed return a possibly empty CertStore containing the certificates in the - request. If the request is not signed the method returns null. - - @return null if not signed, a CertStore otherwise - @throws OcspException - - - Return whether or not this request is signed. - - @return true if signed false otherwise. - - - Verify the signature against the TBSRequest object we contain. - - - return the ASN.1 encoded representation of this object. - - - Add a request for the given CertificateID. - - @param certId certificate ID of interest - - - Add a request with extensions - - @param certId certificate ID of interest - @param singleRequestExtensions the extensions to attach to the request - - - Set the requestor name to the passed in X509Principal - - @param requestorName a X509Principal representing the requestor name. - - - Generate an unsigned request - - @return the OcspReq - @throws OcspException - - - Return an IEnumerable of the signature names supported by the generator. - - @return an IEnumerable containing recognised names. - - - return the ASN.1 encoded representation of this object. - - - base generator for an OCSP response - at the moment this only supports the - generation of responses containing BasicOCSP responses. - - - note 4 is not used. - - - Carrier for a ResponderID. - - - wrapper for the RevokedInfo object - - - return the revocation reason. Note: this field is optional, test for it - with hasRevocationReason() first. - @exception InvalidOperationException if a reason is asked for and none is avaliable - - - Return the status object for the response - null indicates good. - - @return the status object for the response, null if it is good. - - - return the NextUpdate value - note: this is an optional field so may - be returned as null. - - @return nextUpdate, or null if not present. - - - wrapper for the UnknownInfo object - - - - Utility class for creating IBasicAgreement objects from their names/Oids - - - - - Cipher Utility class contains methods that can not be specifically grouped into other classes. - - - - - Returns a ObjectIdentifier for a give encoding. - - A string representation of the encoding. - A DerObjectIdentifier, null if the Oid is not available. - - - - Utility class for creating IDigest objects from their names/Oids - - - - - Returns a ObjectIdentifier for a given digest mechanism. - - A string representation of the digest meanism. - A DerObjectIdentifier, null if the Oid is not available. - - - - A class containing methods to interface the BouncyCastle world to the .NET Crypto world. - - - - - Create an System.Security.Cryptography.X509Certificate from an X509Certificate Structure. - - - A System.Security.Cryptography.X509Certificate. - - - - Utility class for creating HMac object from their names/Oids - - - - - - - - - - Returns a ObjectIdentifier for a give encoding. - - A string representation of the encoding. - A DerObjectIdentifier, null if the Oid is not available. - - - - Create and auto-seed an instance based on the given algorithm. - - Equivalent to GetInstance(algorithm, true) - e.g. "SHA256PRNG" - - - - Create an instance based on the given algorithm, with optional auto-seeding - - e.g. "SHA256PRNG" - If true, the instance will be auto-seeded. - - - - To replicate existing predictable output, replace with GetInstance("SHA1PRNG", false), followed by SetSeed(seed) - - - - Use the specified instance of IRandomGenerator as random source. - - This constructor performs no seeding of either the IRandomGenerator or the - constructed SecureRandom. It is the responsibility of the client to provide - proper seed material as necessary/appropriate for the given IRandomGenerator - implementation. - - The source to generate all random bytes from. - - - base constructor. - - - create a SecurityUtilityException with the given message. - - @param message the message to be carried with the exception. - - - - Signer Utility class contains methods that can not be specifically grouped into other classes. - - - - - Returns an ObjectIdentifier for a given encoding. - - A string representation of the encoding. - A DerObjectIdentifier, null if the OID is not available. - - - - Utility class for creating IWrapper objects from their names/Oids - - - - PEM generator for the original set of PEM objects used in Open SSL. - - - Class for reading OpenSSL PEM encoded streams containing - X509 certificates, PKCS8 encoded keys and PKCS7 objects. -

    - In the case of PKCS7 objects the reader will return a CMS ContentInfo object. Keys and - Certificates will be returned using the appropriate java.security type.

    -
    - - Create a new PemReader - - @param reader the Reader - - - Create a new PemReader with a password finder - - @param reader the Reader - @param pFinder the password finder - - - Reads in a X509Certificate. - - @return the X509Certificate - @throws IOException if an I/O error occured - - - Reads in a X509CRL. - - @return the X509Certificate - @throws IOException if an I/O error occured - - - Reads in a PKCS10 certification request. - - @return the certificate request. - @throws IOException if an I/O error occured - - - Reads in a X509 Attribute Certificate. - - @return the X509 Attribute Certificate - @throws IOException if an I/O error occured - - - Reads in a PKCS7 object. This returns a ContentInfo object suitable for use with the CMS - API. - - @return the X509Certificate - @throws IOException if an I/O error occured - - - Read a Key Pair - - - General purpose writer for OpenSSL PEM objects. - - - The TextWriter object to write the output to. - - - Constructor for an unencrypted private key PEM object. - - @param key private key to be encoded. - - - Constructor for an encrypted private key PEM object. - - @param key private key to be encoded - @param algorithm encryption algorithm to use - @param provider provider to use - @throws NoSuchAlgorithmException if algorithm/mode cannot be found - - - - A class for verifying and creating Pkcs10 Certification requests. - - - CertificationRequest ::= Sequence { - certificationRequestInfo CertificationRequestInfo, - signatureAlgorithm AlgorithmIdentifier{{ SignatureAlgorithms }}, - signature BIT STRING - } - - CertificationRequestInfo ::= Sequence { - version Integer { v1(0) } (v1,...), - subject Name, - subjectPKInfo SubjectPublicKeyInfo{{ PKInfoAlgorithms }}, - attributes [0] Attributes{{ CRIAttributes }} - } - - Attributes { ATTRIBUTE:IOSet } ::= Set OF Attr{{ IOSet }} - - Attr { ATTRIBUTE:IOSet } ::= Sequence { - type ATTRIBUTE.&id({IOSet}), - values Set SIZE(1..MAX) OF ATTRIBUTE.&Type({IOSet}{\@type}) - } - - see - - - - Instantiate a Pkcs10CertificationRequest object with the necessary credentials. - - Name of Sig Alg. - X509Name of subject eg OU="My unit." O="My Organisatioin" C="au" - Public Key to be included in cert reqest. - ASN1Set of Attributes. - Matching Private key for nominated (above) public key to be used to sign the request. - - - - Instantiate a Pkcs10CertificationRequest object with the necessary credentials. - - The factory for signature calculators to sign the PKCS#10 request with. - X509Name of subject eg OU="My unit." O="My Organisatioin" C="au" - Public Key to be included in cert reqest. - ASN1Set of Attributes. - Ignored. - - - - Instantiate a Pkcs10CertificationRequest object with the necessary credentials. - - The factory for signature calculators to sign the PKCS#10 request with. - X509Name of subject eg OU="My unit." O="My Organisatioin" C="au" - Public Key to be included in cert reqest. - ASN1Set of Attributes. - - - - Get the public key. - - The public key. - - - - Verify Pkcs10 Cert Request is valid. - - true = valid. - - - - Returns X509Extensions if the Extensions Request attribute can be found and returns the extensions block. - - X509Extensions block or null if one cannot be found. - - - - A class for creating and verifying Pkcs10 Certification requests (this is an extension on ). - The requests are made using delay signing. This is useful for situations where - the private key is in another environment and not directly accessible (e.g. HSM) - So the first step creates the request, then the signing is done outside this - object and the signature is then used to complete the request. - - - CertificationRequest ::= Sequence { - certificationRequestInfo CertificationRequestInfo, - signatureAlgorithm AlgorithmIdentifier{{ SignatureAlgorithms }}, - signature BIT STRING - } - - CertificationRequestInfo ::= Sequence { - version Integer { v1(0) } (v1,...), - subject Name, - subjectPKInfo SubjectPublicKeyInfo{{ PKInfoAlgorithms }}, - attributes [0] Attributes{{ CRIAttributes }} - } - - Attributes { ATTRIBUTE:IOSet } ::= Set OF Attr{{ IOSet }} - - Attr { ATTRIBUTE:IOSet } ::= Sequence { - type ATTRIBUTE.&id({IOSet}), - values Set SIZE(1..MAX) OF ATTRIBUTE.&Type({IOSet}{\@type}) - } - - see - - - - Instantiate a Pkcs10CertificationRequest object with the necessary credentials. - - Name of Sig Alg. - X509Name of subject eg OU="My unit." O="My Organisatioin" C="au" - Public Key to be included in cert reqest. - ASN1Set of Attributes. - - After the object is constructed use the and finally the - SignRequest methods to finalize the request. - - - - simply return the cert entry for the private key - - - Utility class for reencoding PKCS#12 files to definite length. - - - Just re-encode the outer layer of the PKCS#12 file to definite length encoding. - - @param berPKCS12File - original PKCS#12 file - @return a byte array representing the DER encoding of the PFX structure - @throws IOException - - - Re-encode the PKCS#12 structure to definite length encoding at the inner layer - as well, recomputing the MAC accordingly. - - @param berPKCS12File - original PKCS12 file. - @param provider - provider to use for MAC calculation. - @return a byte array representing the DER encoding of the PFX structure. - @throws IOException on parsing, encoding errors. - - - - A holding class for a PKCS#8 encrypted private key info object that allows for its decryption. - - - - - Base constructor from a PKCS#8 EncryptedPrivateKeyInfo object. - - A PKCS#8 EncryptedPrivateKeyInfo object. - - - - Base constructor from a BER encoding of a PKCS#8 EncryptedPrivateKeyInfo object. - - A BER encoding of a PKCS#8 EncryptedPrivateKeyInfo objects. - - - - Returns the underlying ASN.1 structure inside this object. - - Return the EncryptedPrivateKeyInfo structure in this object. - - - - Returns a copy of the encrypted data in this structure. - - Return a copy of the encrypted data in this object. - - - - Return a binary ASN.1 encoding of the EncryptedPrivateKeyInfo structure in this object. - - A byte array containing the encoded object. - - - - Get a decryptor from the passed in provider and decrypt the encrypted private key info, returning the result. - - A provider to query for decryptors for the object. - The decrypted private key info structure. - - - - Create the encrypted private key info using the passed in encryptor. - - The encryptor to use. - An encrypted private key info containing the original private key info. - - - - Base exception for PKCS related issues. - - - - - Base exception for parsing related issues in the PKCS namespace. - - - - Create a PrivateKeyInfo representation of a private key with attributes. - - @param privateKey the key to be encoded into the info object. - @param attributes the set of attributes to be included. - @return the appropriate PrivateKeyInfo - @throws java.io.IOException on an error encoding the key - - - - Returns the revocationDate. - - - - - Returns the certStatus. - - - - Returns an immutable Set of X.509 attribute certificate - extensions that this PkixAttrCertChecker supports or - null if no extensions are supported. -

    - Each element of the set is a String representing the - Object Identifier (OID) of the X.509 extension that is supported. -

    -

    - All X.509 attribute certificate extensions that a - PkixAttrCertChecker might possibly be able to process - should be included in the set. -

    - - @return an immutable Set of X.509 extension OIDs (in - String format) supported by this - PkixAttrCertChecker, or null if no - extensions are supported -
    - - Performs checks on the specified attribute certificate. Every handled - extension is rmeoved from the unresolvedCritExts - collection. - - @param attrCert The attribute certificate to be checked. - @param certPath The certificate path which belongs to the attribute - certificate issuer public key certificate. - @param holderCertPath The certificate path which belongs to the holder - certificate. - @param unresolvedCritExts a Collection of OID strings - representing the current set of unresolved critical extensions - @throws CertPathValidatorException if the specified attribute certificate - does not pass the check. - - - Returns a clone of this object. - - @return a copy of this PkixAttrCertChecker - - - Build and validate a CertPath using the given parameter. - - @param params PKIXBuilderParameters object containing all information to - build the CertPath - - - CertPathValidatorSpi implementation for X.509 Attribute Certificates la RFC 3281. - - @see org.bouncycastle.x509.ExtendedPkixParameters - - - Validates an attribute certificate with the given certificate path. - -

    - params must be an instance of - ExtendedPkixParameters. -

    - The target constraints in the params must be an - X509AttrCertStoreSelector with at least the attribute - certificate criterion set. Obey that also target informations may be - necessary to correctly validate this attribute certificate. -

    - The attribute certificate issuer must be added to the trusted attribute - issuers with {@link ExtendedPkixParameters#setTrustedACIssuers(Set)}. -

    - @param certPath The certificate path which belongs to the attribute - certificate issuer public key certificate. - @param params The PKIX parameters. - @return A PKIXCertPathValidatorResult of the result of - validating the certPath. - @throws InvalidAlgorithmParameterException if params is - inappropriate for this validator. - @throws CertPathValidatorException if the verification fails. -
    - - - Summary description for PkixBuilderParameters. - - - - Returns an instance of PkixBuilderParameters. -

    - This method can be used to get a copy from other - PKIXBuilderParameters, PKIXParameters, - and ExtendedPKIXParameters instances. -

    - - @param pkixParams The PKIX parameters to create a copy of. - @return An PkixBuilderParameters instance. -
    - - - Excluded certificates are not used for building a certification path. - - the excluded certificates. - - - - Sets the excluded certificates which are not used for building a - certification path. If the ISet is null an - empty set is assumed. - - - The given set is cloned to protect it against subsequent modifications. - - The excluded certificates to set. - - - Can alse handle ExtendedPKIXBuilderParameters and - PKIXBuilderParameters. - - @param params Parameters to set. - @see org.bouncycastle.x509.ExtendedPKIXParameters#setParams(java.security.cert.PKIXParameters) - - - Makes a copy of this PKIXParameters object. Changes to the - copy will not affect the original and vice versa. - - @return a copy of this PKIXParameters object - - - An immutable sequence of certificates (a certification path).
    -
    - This is an abstract class that defines the methods common to all CertPaths. - Subclasses can handle different kinds of certificates (X.509, PGP, etc.).
    -
    - All CertPath objects have a type, a list of Certificates, and one or more - supported encodings. Because the CertPath class is immutable, a CertPath - cannot change in any externally visible way after being constructed. This - stipulation applies to all public fields and methods of this class and any - added or overridden by subclasses.
    -
    - The type is a string that identifies the type of Certificates in the - certification path. For each certificate cert in a certification path - certPath, cert.getType().equals(certPath.getType()) must be true.
    -
    - The list of Certificates is an ordered List of zero or more Certificates. - This List and all of the Certificates contained in it must be immutable.
    -
    - Each CertPath object must support one or more encodings so that the object - can be translated into a byte array for storage or transmission to other - parties. Preferably, these encodings should be well-documented standards - (such as PKCS#7). One of the encodings supported by a CertPath is considered - the default encoding. This encoding is used if no encoding is explicitly - requested (for the {@link #getEncoded()} method, for instance).
    -
    - All CertPath objects are also Serializable. CertPath objects are resolved - into an alternate {@link CertPathRep} object during serialization. This - allows a CertPath object to be serialized into an equivalent representation - regardless of its underlying implementation.
    -
    - CertPath objects can be created with a CertificateFactory or they can be - returned by other classes, such as a CertPathBuilder.
    -
    - By convention, X.509 CertPaths (consisting of X509Certificates), are ordered - starting with the target certificate and ending with a certificate issued by - the trust anchor. That is, the issuer of one certificate is the subject of - the following one. The certificate representing the - {@link TrustAnchor TrustAnchor} should not be included in the certification - path. Unvalidated X.509 CertPaths may not follow these conventions. PKIX - CertPathValidators will detect any departure from these conventions that - cause the certification path to be invalid and throw a - CertPathValidatorException.
    -
    - Concurrent Access
    -
    - All CertPath objects must be thread-safe. That is, multiple threads may - concurrently invoke the methods defined in this class on a single CertPath - object (or more than one) with no ill effects. This is also true for the List - returned by CertPath.getCertificates.
    -
    - Requiring CertPath objects to be immutable and thread-safe allows them to be - passed around to various pieces of code without worrying about coordinating - access. Providing this thread-safety is generally not difficult, since the - CertPath and List objects in question are immutable. - - @see CertificateFactory - @see CertPathBuilder - - CertPath implementation for X.509 certificates. - -
    - - @param certs - - - Creates a CertPath of the specified type. - This constructor is protected because most users should use - a CertificateFactory to create CertPaths. - @param type the standard name of the type of Certificatesin this path - - - - Creates a CertPath of the specified type. - This constructor is protected because most users should use - a CertificateFactory to create CertPaths. - - @param type the standard name of the type of Certificatesin this path - - - - Returns an iteration of the encodings supported by this - certification path, with the default encoding - first. Attempts to modify the returned Iterator via its - remove method result in an UnsupportedOperationException. - - @return an Iterator over the names of the supported encodings (as Strings) - - - - Compares this certification path for equality with the specified object. - Two CertPaths are equal if and only if their types are equal and their - certificate Lists (and by implication the Certificates in those Lists) - are equal. A CertPath is never equal to an object that is not a CertPath.
    -
    - This algorithm is implemented by this method. If it is overridden, the - behavior specified here must be maintained. - - @param other - the object to test for equality with this certification path - - @return true if the specified object is equal to this certification path, - false otherwise - - @see Object#hashCode() Object.hashCode() -
    - - Returns the encoded form of this certification path, using - the default encoding. - - @return the encoded bytes - @exception CertificateEncodingException if an encoding error occurs - - - - Returns the encoded form of this certification path, using - the specified encoding. - - @param encoding the name of the encoding to use - @return the encoded bytes - @exception CertificateEncodingException if an encoding error - occurs or the encoding requested is not supported - - - - - Returns the list of certificates in this certification - path. - - - - Return a DERObject containing the encoded certificate. - - @param cert the X509Certificate object to be encoded - - @return the DERObject - - - - Implements the PKIX CertPathBuilding algorithm for BouncyCastle. - - @see CertPathBuilderSpi - - - Build and validate a CertPath using the given parameter. - - @param params PKIXBuilderParameters object containing all information to - build the CertPath - - - - Summary description for PkixCertPathBuilderException. - - - - - Summary description for PkixCertPathBuilderResult. - - - - * Initializes the internal state of this PKIXCertPathChecker. - *

    - * The forward flag specifies the order that certificates - * will be passed to the {@link #check check} method (forward or reverse). A - * PKIXCertPathChecker must support reverse checking - * and may support forward checking. - *

    - * - * @param forward - * the order that certificates are presented to the - * check method. If true, - * certificates are presented from target to most-trusted CA - * (forward); if false, from most-trusted CA to - * target (reverse). - * @exception CertPathValidatorException - * if this PKIXCertPathChecker is unable to - * check certificates in the specified order; it should never - * be thrown if the forward flag is false since reverse - * checking must be supported -
    - - Indicates if forward checking is supported. Forward checking refers to - the ability of the PKIXCertPathChecker to perform its - checks when certificates are presented to the check method - in the forward direction (from target to most-trusted CA). - - @return true if forward checking is supported, - false otherwise - - - * Returns an immutable Set of X.509 certificate extensions - * that this PKIXCertPathChecker supports (i.e. recognizes, - * is able to process), or null if no extensions are - * supported. - *

    - * Each element of the set is a String representing the - * Object Identifier (OID) of the X.509 extension that is supported. The OID - * is represented by a set of nonnegative integers separated by periods. - *

    - * All X.509 certificate extensions that a PKIXCertPathChecker - * might possibly be able to process should be included in the set. - *

    - * - * @return an immutable Set of X.509 extension OIDs (in - * String format) supported by this - * PKIXCertPathChecker, or null if no - * extensions are supported -
    - - Performs the check(s) on the specified certificate using its internal - state and removes any critical extensions that it processes from the - specified collection of OID strings that represent the unresolved - critical extensions. The certificates are presented in the order - specified by the init method. - - @param cert - the Certificate to be checked - @param unresolvedCritExts - a Collection of OID strings representing the - current set of unresolved critical extensions - @exception CertPathValidatorException - if the specified certificate does not pass the check - - - Returns a clone of this object. Calls the Object.clone() - method. All subclasses which maintain state must support and override - this method, if necessary. - - @return a copy of this PKIXCertPathChecker - - - The Service Provider Interface (SPI) - for the {@link CertPathValidator CertPathValidator} class. All - CertPathValidator implementations must include a class (the - SPI class) that extends this class (CertPathValidatorSpi) - and implements all of its methods. In general, instances of this class - should only be accessed through the CertPathValidator class. - For details, see the Java Cryptography Architecture.
    -
    - Concurrent Access
    -
    - Instances of this class need not be protected against concurrent - access from multiple threads. Threads that need to access a single - CertPathValidatorSpi instance concurrently should synchronize - amongst themselves and provide the necessary locking before calling the - wrapping CertPathValidator object.
    -
    - However, implementations of CertPathValidatorSpi may still - encounter concurrency issues, since multiple threads each - manipulating a different CertPathValidatorSpi instance need not - synchronize. - - CertPathValidatorSpi implementation for X.509 Certificate validation a la RFC - 3280. - -
    - - An exception indicating one of a variety of problems encountered when - validating a certification path.
    -
    - A CertPathValidatorException provides support for wrapping - exceptions. The {@link #getCause getCause} method returns the throwable, - if any, that caused this exception to be thrown.
    -
    - A CertPathValidatorException may also include the - certification path that was being validated when the exception was thrown - and the index of the certificate in the certification path that caused the - exception to be thrown. Use the {@link #getCertPath getCertPath} and - {@link #getIndex getIndex} methods to retrieve this information.
    -
    - Concurrent Access
    -
    - Unless otherwise specified, the methods defined in this class are not - thread-safe. Multiple threads that need to access a single - object concurrently should synchronize amongst themselves and - provide the necessary locking. Multiple threads each manipulating - separate objects need not synchronize. - - @see CertPathValidator - -
    - - - Creates a PkixCertPathValidatorException with the given detail - message. A detail message is a String that describes this - particular exception. - - the detail message - - - - Creates a PkixCertPathValidatorException with the specified - detail message and cause. - - the detail message - the cause (which is saved for later retrieval by the - {@link #getCause getCause()} method). (A null - value is permitted, and indicates that the cause is - nonexistent or unknown.) - - - - Creates a PkixCertPathValidatorException with the specified - detail message, cause, certification path, and index. - - the detail message (or null if none) - the cause (or null if none) - the certification path that was in the process of being - validated when the error was encountered - the index of the certificate in the certification path that * - - - - Returns the detail message for this CertPathValidatorException. - - the detail message, or null if neither the message nor cause were specified - - - Returns the certification path that was being validated when the - exception was thrown. - - @return the CertPath that was being validated when the - exception was thrown (or null if not specified) - - - Returns the index of the certificate in the certification path that - caused the exception to be thrown. Note that the list of certificates in - a CertPath is zero based. If no index has been set, -1 is - returned. - - @return the index that has been set, or -1 if none has been set - - - - Summary description for PkixCertPathValidatorResult. - - - - - Summary description for PkixCertPathValidatorUtilities. - - - - - key usage bits - - - - - Search the given Set of TrustAnchor's for one that is the - issuer of the given X509 certificate. - - the X509 certificate - a Set of TrustAnchor's - the TrustAnchor object if found or - null if not. - - @exception - - - - Returns the issuer of an attribute certificate or certificate. - - The attribute certificate or certificate. - The issuer as X500Principal. - - - Return the next working key inheriting DSA parameters if necessary. -

    - This methods inherits DSA parameters from the indexed certificate or - previous certificates in the certificate chain to the returned - PublicKey. The list is searched upwards, meaning the end - certificate is at position 0 and previous certificates are following. -

    -

    - If the indexed certificate does not contain a DSA key this method simply - returns the public key. If the DSA key already contains DSA parameters - the key is also only returned. -

    - - @param certs The certification path. - @param index The index of the certificate which contains the public key - which should be extended with DSA parameters. - @return The public key of the certificate in list position - index extended with DSA parameters if applicable. - @throws Exception if DSA parameters cannot be inherited. -
    - - - Return a Collection of all certificates or attribute certificates found - in the X509Store's that are matching the certSelect criteriums. - - a {@link Selector} object that will be used to select - the certificates - a List containing only X509Store objects. These - are used to search for certificates. - a Collection of all found or - objects. - May be empty but never null. - - - - Add the CRL issuers from the cRLIssuer field of the distribution point or - from the certificate if not given to the issuer criterion of the - selector. -

    - The issuerPrincipals are a collection with a single - X500Principal for X509Certificates. For - {@link X509AttributeCertificate}s the issuer may contain more than one - X500Principal. -

    - - @param dp The distribution point. - @param issuerPrincipals The issuers of the certificate or attribute - certificate which contains the distribution point. - @param selector The CRL selector. - @param pkixParams The PKIX parameters containing the cert stores. - @throws Exception if an exception occurs while processing. - @throws ClassCastException if issuerPrincipals does not - contain only X500Principals. -
    - - Fetches complete CRLs according to RFC 3280. - - @param dp The distribution point for which the complete CRL - @param cert The X509Certificate or - {@link org.bouncycastle.x509.X509AttributeCertificate} for - which the CRL should be searched. - @param currentDate The date for which the delta CRLs must be valid. - @param paramsPKIX The extended PKIX parameters. - @return A Set of X509CRLs with complete - CRLs. - @throws Exception if an exception occurs while picking the CRLs - or no CRLs are found. - - - Fetches delta CRLs according to RFC 3280 section 5.2.4. - - @param currentDate The date for which the delta CRLs must be valid. - @param paramsPKIX The extended PKIX parameters. - @param completeCRL The complete CRL the delta CRL is for. - @return A Set of X509CRLs with delta CRLs. - @throws Exception if an exception occurs while picking the delta - CRLs. - - - Find the issuer certificates of a given certificate. - - @param cert - The certificate for which an issuer should be found. - @param pkixParams - @return A Collection object containing the issuer - X509Certificates. Never null. - - @exception Exception - if an error occurs. - - - - Extract the value of the given extension, if it exists. - - The extension object. - The object identifier to obtain. - Asn1Object - if the extension cannot be read. - - - - crl checking - Return a Collection of all CRLs found in the X509Store's that are - matching the crlSelect criteriums. - - a {@link X509CRLStoreSelector} object that will be used - to select the CRLs - a List containing only {@link org.bouncycastle.x509.X509Store - X509Store} objects. These are used to search for CRLs - a Collection of all found {@link X509CRL X509CRL} objects. May be - empty but never null. - - - - Returns the intersection of the permitted IP ranges in - permitted with ip. - - @param permitted A Set of permitted IP addresses with - their subnet mask as byte arrays. - @param ips The IP address with its subnet mask. - @return The Set of permitted IP ranges intersected with - ip. - - - Returns the union of the excluded IP ranges in excluded - with ip. - - @param excluded A Set of excluded IP addresses with their - subnet mask as byte arrays. - @param ip The IP address with its subnet mask. - @return The Set of excluded IP ranges unified with - ip as byte arrays. - - - Calculates the union if two IP ranges. - - @param ipWithSubmask1 The first IP address with its subnet mask. - @param ipWithSubmask2 The second IP address with its subnet mask. - @return A Set with the union of both addresses. - - - Calculates the interesction if two IP ranges. - - @param ipWithSubmask1 The first IP address with its subnet mask. - @param ipWithSubmask2 The second IP address with its subnet mask. - @return A Set with the single IP address with its subnet - mask as a byte array or an empty Set. - - - Concatenates the IP address with its subnet mask. - - @param ip The IP address. - @param subnetMask Its subnet mask. - @return The concatenated IP address with its subnet mask. - - - Splits the IP addresses and their subnet mask. - - @param ipWithSubmask1 The first IP address with the subnet mask. - @param ipWithSubmask2 The second IP address with the subnet mask. - @return An array with two elements. Each element contains the IP address - and the subnet mask in this order. - - - Based on the two IP addresses and their subnet masks the IP range is - computed for each IP address - subnet mask pair and returned as the - minimum IP address and the maximum address of the range. - - @param ip1 The first IP address. - @param subnetmask1 The subnet mask of the first IP address. - @param ip2 The second IP address. - @param subnetmask2 The subnet mask of the second IP address. - @return A array with two elements. The first/second element contains the - min and max IP address of the first/second IP address and its - subnet mask. - - - Checks if the IP address ip is constrained by - constraint. - - @param constraint The constraint. This is an IP address concatenated with - its subnetmask. - @param ip The IP address. - @return true if constrained, false - otherwise. - - - Checks if the IP ip is included in the permitted ISet - permitted. - - @param permitted A Set of permitted IP addresses with - their subnet mask as byte arrays. - @param ip The IP address. - @throws PkixNameConstraintValidatorException - if the IP is not permitted. - - - Checks if the IP ip is included in the excluded ISet - excluded. - - @param excluded A Set of excluded IP addresses with their - subnet mask as byte arrays. - @param ip The IP address. - @throws PkixNameConstraintValidatorException - if the IP is excluded. - - - The common part of email1 and email2 is - added to the union union. If email1 and - email2 have nothing in common they are added both. - - @param email1 Email address constraint 1. - @param email2 Email address constraint 2. - @param union The union. - - - The most restricting part from email1 and - email2 is added to the intersection intersect. - - @param email1 Email address constraint 1. - @param email2 Email address constraint 2. - @param intersect The intersection. - - - Checks if the given GeneralName is in the permitted ISet. - - @param name The GeneralName - @throws PkixNameConstraintValidatorException - If the name - - - Check if the given GeneralName is contained in the excluded ISet. - - @param name The GeneralName. - @throws PkixNameConstraintValidatorException - If the name is - excluded. - - - Updates the permitted ISet of these name constraints with the intersection - with the given subtree. - - @param permitted The permitted subtrees - - - Adds a subtree to the excluded ISet of these name constraints. - - @param subtree A subtree with an excluded GeneralName. - - - Returns the maximum IP address. - - @param ip1 The first IP address. - @param ip2 The second IP address. - @return The maximum IP address. - - - Returns the minimum IP address. - - @param ip1 The first IP address. - @param ip2 The second IP address. - @return The minimum IP address. - - - Compares IP address ip1 with ip2. If ip1 - is equal to ip2 0 is returned. If ip1 is bigger 1 is returned, -1 - otherwise. - - @param ip1 The first IP address. - @param ip2 The second IP address. - @return 0 if ip1 is equal to ip2, 1 if ip1 is bigger, -1 otherwise. - - - Returns the logical OR of the IP addresses ip1 and - ip2. - - @param ip1 The first IP address. - @param ip2 The second IP address. - @return The OR of ip1 and ip2. - - - Stringifies an IPv4 or v6 address with subnet mask. - - @param ip The IP with subnet mask. - @return The stringified IP address. - - - - Summary description for PkixParameters. - - - - This is the default PKIX validity model. Actually there are two variants - of this: The PKIX model and the modified PKIX model. The PKIX model - verifies that all involved certificates must have been valid at the - current time. The modified PKIX model verifies that all involved - certificates were valid at the signing time. Both are indirectly choosen - with the {@link PKIXParameters#setDate(java.util.Date)} method, so this - methods sets the Date when all certificates must have been - valid. - - - This model uses the following validity model. Each certificate must have - been valid at the moment where is was used. That means the end - certificate must have been valid at the time the signature was done. The - CA certificate which signed the end certificate must have been valid, - when the end certificate was signed. The CA (or Root CA) certificate must - have been valid, when the CA certificate was signed and so on. So the - {@link PKIXParameters#setDate(java.util.Date)} method sets the time, when - the end certificate must have been valid.

    It is used e.g. - in the German signature law. - - - Creates an instance of PKIXParameters with the specified Set of - most-trusted CAs. Each element of the set is a TrustAnchor.
    -
    - Note that the Set is copied to protect against subsequent modifications. - - @param trustAnchors - a Set of TrustAnchors - - @exception InvalidAlgorithmParameterException - if the specified Set is empty - (trustAnchors.isEmpty() == true) - @exception NullPointerException - if the specified Set is null - @exception ClassCastException - if any of the elements in the Set are not of type - java.security.cert.TrustAnchor -
    - - Returns the required constraints on the target certificate. The - constraints are returned as an instance of CertSelector. If - null, no constraints are defined.
    -
    - Note that the CertSelector returned is cloned to protect against - subsequent modifications. - - @return a CertSelector specifying the constraints on the target - certificate (or null) - - @see #setTargetCertConstraints(CertSelector) -
    - - Sets the required constraints on the target certificate. The constraints - are specified as an instance of CertSelector. If null, no constraints are - defined.
    -
    - Note that the CertSelector specified is cloned to protect against - subsequent modifications. - - @param selector - a CertSelector specifying the constraints on the target - certificate (or null) - - @see #getTargetCertConstraints() -
    - - Returns an immutable Set of initial policy identifiers (OID strings), - indicating that any one of these policies would be acceptable to the - certificate user for the purposes of certification path processing. The - default return value is an empty Set, which is - interpreted as meaning that any policy would be acceptable. - - @return an immutable Set of initial policy OIDs in String - format, or an empty Set (implying any policy is - acceptable). Never returns null. - - @see #setInitialPolicies(java.util.Set) - - - Sets the Set of initial policy identifiers (OID strings), - indicating that any one of these policies would be acceptable to the - certificate user for the purposes of certification path processing. By - default, any policy is acceptable (i.e. all policies), so a user that - wants to allow any policy as acceptable does not need to call this - method, or can call it with an empty Set (or - null).
    -
    - Note that the Set is copied to protect against subsequent modifications.
    -
    - - @param initialPolicies - a Set of initial policy OIDs in String format (or - null) - - @exception ClassCastException - if any of the elements in the set are not of type String - - @see #getInitialPolicies() -
    - - Sets a List of additional certification path checkers. If - the specified List contains an object that is not a PKIXCertPathChecker, - it is ignored.
    -
    - Each PKIXCertPathChecker specified implements additional - checks on a certificate. Typically, these are checks to process and - verify private extensions contained in certificates. Each - PKIXCertPathChecker should be instantiated with any - initialization parameters needed to execute the check.
    -
    - This method allows sophisticated applications to extend a PKIX - CertPathValidator or CertPathBuilder. Each - of the specified PKIXCertPathCheckers will be called, in turn, by a PKIX - CertPathValidator or CertPathBuilder for - each certificate processed or validated.
    -
    - Regardless of whether these additional PKIXCertPathCheckers are set, a - PKIX CertPathValidator or CertPathBuilder - must perform all of the required PKIX checks on each certificate. The one - exception to this rule is if the RevocationEnabled flag is set to false - (see the {@link #setRevocationEnabled(boolean) setRevocationEnabled} - method).
    -
    - Note that the List supplied here is copied and each PKIXCertPathChecker - in the list is cloned to protect against subsequent modifications. - - @param checkers - a List of PKIXCertPathCheckers. May be null, in which case no - additional checkers will be used. - @exception ClassCastException - if any of the elements in the list are not of type - java.security.cert.PKIXCertPathChecker - @see #getCertPathCheckers() -
    - - Returns the List of certification path checkers. Each PKIXCertPathChecker - in the returned IList is cloned to protect against subsequent modifications. - - @return an immutable List of PKIXCertPathCheckers (may be empty, but not - null) - - @see #setCertPathCheckers(java.util.List) - - - Adds a PKIXCertPathChecker to the list of certification - path checkers. See the {@link #setCertPathCheckers setCertPathCheckers} - method for more details. -

    - Note that the PKIXCertPathChecker is cloned to protect - against subsequent modifications.

    - - @param checker a PKIXCertPathChecker to add to the list of - checks. If null, the checker is ignored (not added to list). -
    - - Method to support Clone() under J2ME. - super.Clone() does not exist and fields are not copied. - - @param params Parameters to set. If this are - ExtendedPkixParameters they are copied to. - - - Whether delta CRLs should be used for checking the revocation status. - Defaults to false. - - - The validity model. - @see #CHAIN_VALIDITY_MODEL - @see #PKIX_VALIDITY_MODEL - - - Sets the Bouncy Castle Stores for finding CRLs, certificates, attribute - certificates or cross certificates. -

    - The IList is cloned. -

    - - @param stores A list of stores to use. - @see #getStores - @throws ClassCastException if an element of stores is not - a {@link Store}. -
    - - Adds a Bouncy Castle {@link Store} to find CRLs, certificates, attribute - certificates or cross certificates. -

    - This method should be used to add local stores, like collection based - X.509 stores, if available. Local stores should be considered first, - before trying to use additional (remote) locations, because they do not - need possible additional network traffic. -

    - If store is null it is ignored. -

    - - @param store The store to add. - @see #getStores -
    - - Adds an additional Bouncy Castle {@link Store} to find CRLs, certificates, - attribute certificates or cross certificates. -

    - You should not use this method. This method is used for adding additional - X.509 stores, which are used to add (remote) locations, e.g. LDAP, found - during X.509 object processing, e.g. in certificates or CRLs. This method - is used in PKIX certification path processing. -

    - If store is null it is ignored. -

    - - @param store The store to add. - @see #getStores() -
    - - Returns an IList of additional Bouncy Castle - Stores used for finding CRLs, certificates, attribute - certificates or cross certificates. - - @return an immutable IList of additional Bouncy Castle - Stores. Never null. - - @see #addAddionalStore(Store) - - - Returns an IList of Bouncy Castle - Stores used for finding CRLs, certificates, attribute - certificates or cross certificates. - - @return an immutable IList of Bouncy Castle - Stores. Never null. - - @see #setStores(IList) - - - Returns if additional {@link X509Store}s for locations like LDAP found - in certificates or CRLs should be used. - - @return Returns true if additional stores are used. - - - Sets if additional {@link X509Store}s for locations like LDAP found in - certificates or CRLs should be used. - - @param enabled true if additional stores are used. - - - Returns the required constraints on the target certificate or attribute - certificate. The constraints are returned as an instance of - IX509Selector. If null, no constraints are - defined. - -

    - The target certificate in a PKIX path may be a certificate or an - attribute certificate. -

    - Note that the IX509Selector returned is cloned to protect - against subsequent modifications. -

    - @return a IX509Selector specifying the constraints on the - target certificate or attribute certificate (or null) - @see #setTargetConstraints - @see X509CertStoreSelector - @see X509AttributeCertStoreSelector -
    - - Sets the required constraints on the target certificate or attribute - certificate. The constraints are specified as an instance of - IX509Selector. If null, no constraints are - defined. -

    - The target certificate in a PKIX path may be a certificate or an - attribute certificate. -

    - Note that the IX509Selector specified is cloned to protect - against subsequent modifications. -

    - - @param selector a IX509Selector specifying the constraints on - the target certificate or attribute certificate (or - null) - @see #getTargetConstraints - @see X509CertStoreSelector - @see X509AttributeCertStoreSelector -
    - - Returns the trusted attribute certificate issuers. If attribute - certificates is verified the trusted AC issuers must be set. -

    - The returned ISet consists of TrustAnchors. -

    - The returned ISet is immutable. Never null -

    - - @return Returns an immutable set of the trusted AC issuers. -
    - - Sets the trusted attribute certificate issuers. If attribute certificates - is verified the trusted AC issuers must be set. -

    - The trustedACIssuers must be a ISet of - TrustAnchor -

    - The given set is cloned. -

    - - @param trustedACIssuers The trusted AC issuers to set. Is never - null. - @throws ClassCastException if an element of stores is not - a TrustAnchor. -
    - - Returns the necessary attributes which must be contained in an attribute - certificate. -

    - The returned ISet is immutable and contains - Strings with the OIDs. -

    - - @return Returns the necessary AC attributes. -
    - - Sets the necessary which must be contained in an attribute certificate. -

    - The ISet must contain Strings with the - OIDs. -

    - The set is cloned. -

    - - @param necessaryACAttributes The necessary AC attributes to set. - @throws ClassCastException if an element of - necessaryACAttributes is not a - String. -
    - - Returns the attribute certificates which are not allowed. -

    - The returned ISet is immutable and contains - Strings with the OIDs. -

    - - @return Returns the prohibited AC attributes. Is never null. -
    - - Sets the attribute certificates which are not allowed. -

    - The ISet must contain Strings with the - OIDs. -

    - The set is cloned. -

    - - @param prohibitedACAttributes The prohibited AC attributes to set. - @throws ClassCastException if an element of - prohibitedACAttributes is not a - String. -
    - - Returns the attribute certificate checker. The returned set contains - {@link PKIXAttrCertChecker}s and is immutable. - - @return Returns the attribute certificate checker. Is never - null. - - - Sets the attribute certificate checkers. -

    - All elements in the ISet must a {@link PKIXAttrCertChecker}. -

    -

    - The given set is cloned. -

    - - @param attrCertCheckers The attribute certificate checkers to set. Is - never null. - @throws ClassCastException if an element of attrCertCheckers - is not a PKIXAttrCertChecker. -
    - - - Summary description for PkixPolicyNode. - - - - Constructors - - - - This class helps to handle CRL revocation reasons mask. Each CRL handles a - certain set of revocation reasons. - - - - - Constructs are reason mask with the reasons. - - The reasons. - - - - A reason mask with no reason. - - - - - A mask with all revocation reasons. - - - - Adds all reasons from the reasons mask to this mask. - - @param mask The reasons mask to add. - - - - Returns true if this reasons mask contains all possible - reasons. - - true if this reasons mask contains all possible reasons. - - - - - Intersects this mask with the given reasons mask. - - mask The mask to intersect with. - The intersection of this and teh given mask. - - - - Returns true if the passed reasons mask has new reasons. - - The reasons mask which should be tested for new reasons. - true if the passed reasons mask has new reasons. - - - - Returns the reasons in this mask. - - - - If the complete CRL includes an issuing distribution point (IDP) CRL - extension check the following: -

    - (i) If the distribution point name is present in the IDP CRL extension - and the distribution field is present in the DP, then verify that one of - the names in the IDP matches one of the names in the DP. If the - distribution point name is present in the IDP CRL extension and the - distribution field is omitted from the DP, then verify that one of the - names in the IDP matches one of the names in the cRLIssuer field of the - DP. -

    -

    - (ii) If the onlyContainsUserCerts boolean is asserted in the IDP CRL - extension, verify that the certificate does not include the basic - constraints extension with the cA boolean asserted. -

    -

    - (iii) If the onlyContainsCACerts boolean is asserted in the IDP CRL - extension, verify that the certificate includes the basic constraints - extension with the cA boolean asserted. -

    -

    - (iv) Verify that the onlyContainsAttributeCerts boolean is not asserted. -

    - - @param dp The distribution point. - @param cert The certificate. - @param crl The CRL. - @throws AnnotatedException if one of the conditions is not met or an error occurs. -
    - - If the DP includes cRLIssuer, then verify that the issuer field in the - complete CRL matches cRLIssuer in the DP and that the complete CRL - contains an - g distribution point extension with the indirectCRL - boolean asserted. Otherwise, verify that the CRL issuer matches the - certificate issuer. - - @param dp The distribution point. - @param cert The certificate ot attribute certificate. - @param crl The CRL for cert. - @throws AnnotatedException if one of the above conditions does not apply or an error - occurs. - - - Obtain and validate the certification path for the complete CRL issuer. - If a key usage extension is present in the CRL issuer's certificate, - verify that the cRLSign bit is set. - - @param crl CRL which contains revocation information for the certificate - cert. - @param cert The attribute certificate or certificate to check if it is - revoked. - @param defaultCRLSignCert The issuer certificate of the certificate cert. - @param defaultCRLSignKey The public key of the issuer certificate - defaultCRLSignCert. - @param paramsPKIX paramsPKIX PKIX parameters. - @param certPathCerts The certificates on the certification path. - @return A Set with all keys of possible CRL issuer - certificates. - @throws AnnotatedException if the CRL is not valid or the status cannot be checked or - some error occurs. - - - Checks a distribution point for revocation information for the - certificate cert. - - @param dp The distribution point to consider. - @param paramsPKIX PKIX parameters. - @param cert Certificate to check if it is revoked. - @param validDate The date when the certificate revocation status should be - checked. - @param defaultCRLSignCert The issuer certificate of the certificate cert. - @param defaultCRLSignKey The public key of the issuer certificate - defaultCRLSignCert. - @param certStatus The current certificate revocation status. - @param reasonMask The reasons mask which is already checked. - @param certPathCerts The certificates of the certification path. - @throws AnnotatedException if the certificate is revoked or the status cannot be checked - or some error occurs. - - - Checks a certificate if it is revoked. - - @param paramsPKIX PKIX parameters. - @param cert Certificate to check if it is revoked. - @param validDate The date when the certificate revocation status should be - checked. - @param sign The issuer certificate of the certificate cert. - @param workingPublicKey The public key of the issuer certificate sign. - @param certPathCerts The certificates of the certification path. - @throws AnnotatedException if the certificate is revoked or the status cannot be checked - or some error occurs. - - - If use-deltas is set, verify the issuer and scope of the delta CRL. - - @param deltaCRL The delta CRL. - @param completeCRL The complete CRL. - @param pkixParams The PKIX paramaters. - @throws AnnotatedException if an exception occurs. - - - Checks if an attribute certificate is revoked. - - @param attrCert Attribute certificate to check if it is revoked. - @param paramsPKIX PKIX parameters. - @param issuerCert The issuer certificate of the attribute certificate - attrCert. - @param validDate The date when the certificate revocation status should - be checked. - @param certPathCerts The certificates of the certification path to be - checked. - - @throws CertPathValidatorException if the certificate is revoked or the - status cannot be checked or some error occurs. - - - Searches for a holder public key certificate and verifies its - certification path. - - @param attrCert the attribute certificate. - @param pkixParams The PKIX parameters. - @return The certificate path of the holder certificate. - @throws Exception if -
      -
    • no public key certificate can be found although holder - information is given by an entity name or a base certificate - ID
    • -
    • support classes cannot be created
    • -
    • no certification path for the public key certificate can - be built
    • -
    -
    - - - Checks a distribution point for revocation information for the - certificate attrCert. - - @param dp The distribution point to consider. - @param attrCert The attribute certificate which should be checked. - @param paramsPKIX PKIX parameters. - @param validDate The date when the certificate revocation status should - be checked. - @param issuerCert Certificate to check if it is revoked. - @param reasonMask The reasons mask which is already checked. - @param certPathCerts The certificates of the certification path to be - checked. - @throws Exception if the certificate is revoked or the status - cannot be checked or some error occurs. - - - - A trust anchor or most-trusted Certification Authority (CA). - - This class represents a "most-trusted CA", which is used as a trust anchor - for validating X.509 certification paths. A most-trusted CA includes the - public key of the CA, the CA's name, and any constraints upon the set of - paths which may be validated using this key. These parameters can be - specified in the form of a trusted X509Certificate or as individual - parameters. - - - - - Creates an instance of TrustAnchor with the specified X509Certificate and - optional name constraints, which are intended to be used as additional - constraints when validating an X.509 certification path. - The name constraints are specified as a byte array. This byte array - should contain the DER encoded form of the name constraints, as they - would appear in the NameConstraints structure defined in RFC 2459 and - X.509. The ASN.1 definition of this structure appears below. - -
    -            	NameConstraints ::= SEQUENCE {
    -            		permittedSubtrees       [0]     GeneralSubtrees OPTIONAL,
    -            		excludedSubtrees        [1]     GeneralSubtrees OPTIONAL }
    -            	   
    -             GeneralSubtrees ::= SEQUENCE SIZE (1..MAX) OF GeneralSubtree
    -             
    -            		GeneralSubtree ::= SEQUENCE {
    -            		base                    GeneralName,
    -            		minimum         [0]     BaseDistance DEFAULT 0,
    -            		maximum         [1]     BaseDistance OPTIONAL }
    -            		
    -            		BaseDistance ::= INTEGER (0..MAX)
    -            
    -            		GeneralName ::= CHOICE {
    -            		otherName                       [0]     OtherName,
    -            		rfc822Name                      [1]     IA5String,
    -            		dNSName                         [2]     IA5String,
    -            		x400Address                     [3]     ORAddress,
    -            		directoryName                   [4]     Name,
    -            		ediPartyName                    [5]     EDIPartyName,
    -            		uniformResourceIdentifier       [6]     IA5String,
    -            		iPAddress                       [7]     OCTET STRING,
    -            		registeredID                    [8]     OBJECT IDENTIFIER}
    -            	
    - - Note that the name constraints byte array supplied is cloned to protect - against subsequent modifications. -
    - a trusted X509Certificate - a byte array containing the ASN.1 DER encoding of a - NameConstraints extension to be used for checking name - constraints. Only the value of the extension is included, not - the OID or criticality flag. Specify null to omit the - parameter. - if the specified X509Certificate is null -
    - - - Creates an instance of TrustAnchor where the - most-trusted CA is specified as an X500Principal and public key. - - -

    - Name constraints are an optional parameter, and are intended to be used - as additional constraints when validating an X.509 certification path. -

    - The name constraints are specified as a byte array. This byte array - contains the DER encoded form of the name constraints, as they - would appear in the NameConstraints structure defined in RFC 2459 - and X.509. The ASN.1 notation for this structure is supplied in the - documentation for the other constructors. -

    - Note that the name constraints byte array supplied here is cloned to - protect against subsequent modifications. -

    -
    - the name of the most-trusted CA as X509Name - the public key of the most-trusted CA - - a byte array containing the ASN.1 DER encoding of a NameConstraints extension to - be used for checking name constraints. Only the value of the extension is included, - not the OID or criticality flag. Specify null to omit the parameter. - - - if caPrincipal or pubKey is null - -
    - - - Creates an instance of TrustAnchor where the most-trusted - CA is specified as a distinguished name and public key. Name constraints - are an optional parameter, and are intended to be used as additional - constraints when validating an X.509 certification path. -
    - The name constraints are specified as a byte array. This byte array - contains the DER encoded form of the name constraints, as they would - appear in the NameConstraints structure defined in RFC 2459 and X.509. -
    - the X.500 distinguished name of the most-trusted CA in RFC - 2253 string format - the public key of the most-trusted CA - a byte array containing the ASN.1 DER encoding of a - NameConstraints extension to be used for checking name - constraints. Only the value of the extension is included, not - the OID or criticality flag. Specify null to omit the - parameter. - throws NullPointerException, IllegalArgumentException -
    - - - Returns the most-trusted CA certificate. - - - - - Returns the name of the most-trusted CA as an X509Name. - - - - - Returns the name of the most-trusted CA in RFC 2253 string format. - - - - - Returns the public key of the most-trusted CA. - - - - - Decode the name constraints and clone them if not null. - - - - - Returns a formatted string describing the TrustAnchor. - - a formatted string describing the TrustAnchor - - - Base class for a TLS client. - - - - - - - - - - - - - - - an of (or null). - - - The default implementation calls this to determine which named - groups to include in the supported_groups extension for the ClientHello. - The named group roles for which there should - be at least one supported group. By default this is inferred from the offered cipher suites and signature - algorithms. - an of . See for group constants. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Base class for supporting a TLS key exchange implementation. - - - Base class for supporting a TLS key exchange factory implementation. - - - Base class for a TLS client or server. - - - Get the values that are supported by this peer. - - WARNING: Mixing DTLS and TLS versions in the returned array is currently NOT supported. Use a separate - (sub-)class for each case. - - an array of supported values. - - - - - - - - - - - - - - - - - - Base class for a TLS server. - - - - - - RFC 5246 7.2. - - - This message notifies the recipient that the sender will not send any more messages on this - connection. - - Note that as of TLS 1.1, failure to properly close a connection no longer requires that a session not be - resumed. This is a change from TLS 1.0 ("The session becomes unresumable if any connection is terminated - without proper close_notify messages with level equal to warning.") to conform with widespread - implementation practice. - - - - An inappropriate message was received. - - This alert is always fatal and should never be observed in communication between proper implementations. - - - - This alert is returned if a record is received with an incorrect MAC. - - This alert also MUST be returned if an alert is sent because a TLSCiphertext decrypted in an invalid way: - either it wasn't an even multiple of the block length, or its padding values, when checked, weren't - correct. This message is always fatal and should never be observed in communication between proper - implementations (except when messages were corrupted in the network). - - - - - This alert was used in some earlier versions of TLS, and may have permitted certain attacks against the CBC - mode [CBCATT]. It MUST NOT be sent by compliant implementations. - - - - A TLSCiphertext record was received that had a length more than 2^14+2048 bytes, or a record - decrypted to a TLSCompressed record with more than 2^14+1024 bytes. - - This message is always fatal and should never be observed in communication between proper implementations - (except when messages were corrupted in the network). - - - - The decompression function received improper input (e.g., data that would expand to excessive - length). - - This message is always fatal and should never be observed in communication between proper implementations. - - - - Reception of a handshake_failure alert message indicates that the sender was unable to negotiate - an acceptable set of security parameters given the options available. - - This is a fatal error. - - - - - This alert was used in SSLv3 but not any version of TLS. It MUST NOT be sent by compliant implementations. - - - - A certificate was corrupt, contained signatures that did not verify correctly, etc. - - - A certificate was of an unsupported type. - - - A certificate was revoked by its signer. - - - A certificate has expired or is not currently valid. - - - Some other (unspecified) issue arose in processing the certificate, rendering it unacceptable. - - - - A field in the handshake was out of range or inconsistent with other fields. - - This message is always fatal. - - - - A valid certificate chain or partial chain was received, but the certificate was not accepted - because the CA certificate could not be located or couldn't be matched with a known, trusted CA. - - This message is always fatal. - - - - A valid certificate was received, but when access control was applied, the sender decided not to - proceed with negotiation. - - This message is always fatal. - - - - A message could not be decoded because some field was out of the specified range or the length of - the message was incorrect. - - This message is always fatal and should never be observed in communication between proper - implementations (except when messages were corrupted in the network). - - - - A handshake cryptographic operation failed, including being unable to correctly verify a signature - or validate a Finished message. - - This message is always fatal. - - - - - This alert was used in some earlier versions of TLS. It MUST NOT be sent by compliant implementations. - - - - The protocol version the client has attempted to negotiate is recognized but not supported. - - - (For example, old protocol versions might be avoided for security reasons.) This message is always fatal. - - - - Returned instead of handshake_failure when a negotiation has failed specifically because the - server requires ciphers more secure than those supported by the client. - - This message is always fatal. - - - - An internal error unrelated to the peer or the correctness of the protocol (such as a memory - allocation failure) makes it impossible to continue. - - This message is always fatal. - - - - This handshake is being canceled for some reason unrelated to a protocol failure. - - If the user cancels an operation after the handshake is complete, just closing the connection by sending a - close_notify is more appropriate. This alert should be followed by a close_notify. This message is - generally a warning. - - - - Sent by the client in response to a hello request or by the server in response to a client hello - after initial handshaking. - - Either of these would normally lead to renegotiation; when that is not appropriate, the recipient should - respond with this alert. At that point, the original requester can decide whether to proceed with the - connection. One case where this would be appropriate is where a server has spawned a process to satisfy a - request; the process might receive security parameters (key length, authentication, etc.) at startup, and - it might be difficult to communicate changes to these parameters after that point. This message is always a - warning. - - - - Sent by clients that receive an extended server hello containing an extension that they did not - put in the corresponding client hello. - - This message is always fatal. - - - - This alert is sent by servers who are unable to retrieve a certificate chain from the URL supplied - by the client(see Section 3.3). - - This message MAY be fatal - for example if client authentication is required by the server for the - handshake to continue and the server is unable to retrieve the certificate chain, it may send a fatal - alert. - - - - This alert is sent by servers that receive a server_name extension request, but do not recognize - the server name. - - This message MAY be fatal. - - - - This alert is sent by clients that receive an invalid certificate status response (see Section 3.6 - ). - - This message is always fatal. - - - - This alert is sent by servers when a certificate hash does not match a client provided - certificate_hash. - - This message is always fatal. - - - - If the server does not recognize the PSK identity, it MAY respond with an "unknown_psk_identity" - alert message. - - - In the event that the server supports no protocols that the client advertises, then the server - SHALL respond with a fatal "no_application_protocol" alert. - - - If TLS_FALLBACK_SCSV appears in ClientHello.cipher_suites and the highest protocol version - supported by the server is higher than the version indicated in ClientHello.client_version, the server MUST - respond with a fatal inappropriate_fallback alert[..]. - - - Sent by endpoints that receive a handshake message not containing an extension that is mandatory - to send for the offered TLS version or other negotiated parameters. - - - Sent by servers when a client certificate is desired but none was provided by the client. - - - - RFC 5246 7.2 - - - A basic PSK Identity holder. - - - A basic SRP Identity holder. - - - A queue for bytes. This file could be more optimized. - - - The smallest number which can be written as 2^x which is bigger than i. - - - The buffer where we store our data. - - - How many bytes at the beginning of the buffer are skipped. - - - How many bytes in the buffer are valid data. - - - Add some data to our buffer. - A byte-array to read data from. - How many bytes to skip at the beginning of the array. - How many bytes to read from the array. - - - The number of bytes which are available in this buffer. - - - Copy some bytes from the beginning of the data to the provided . - The to copy the bytes to. - How many bytes to copy. - - - Read data from the buffer. - The buffer where the read data will be copied to. - How many bytes to skip at the beginning of buf. - How many bytes to read at all. - How many bytes from our data to skip. - - - Return a over some bytes at the beginning of the data. - - How many bytes will be readable. - A over the data. - - - Remove some bytes from our data from the beginning. - How many bytes to remove. - - - Remove data from the buffer. - The buffer where the removed data will be copied to. - How many bytes to skip at the beginning of buf. - How many bytes to read at all. - How many bytes from our data to skip. - - - OutputStream based on a ByteQueue implementation. - - - Implementation of the RFC 3546 3.3. CertChainType. - - - Parsing and encoding of a Certificate struct from RFC 4346. - -
    -            opaque ASN.1Cert<2^24-1>;
    -            struct {
    -              ASN.1Cert certificate_list<0..2^24-1>;
    -            } Certificate;
    -            
    -
    -
    - - an array of representing a certificate chain. - - - true if this certificate chain contains no certificates, or false otherwise. - - - - Encode this to a , and optionally calculate the - "end point hash" (per RFC 5929's tls-server-end-point binding). - the of the current connection. - the to encode to. - the to write the "end point hash" to (or null). - - - - - Parse a from a . - the to apply during parsing. - the of the current connection. - the to parse from. - the to write the "end point hash" to (or null). - - a object. - - - - Parsing and encoding of a CertificateRequest struct from RFC 4346. - -
    -            struct {
    -              ClientCertificateType certificate_types<1..2^8-1>;
    -              DistinguishedName certificate_authorities<3..2^16-1>;
    -            } CertificateRequest;
    -            
    - Updated for RFC 5246: -
    -            struct {
    -              ClientCertificateType certificate_types <1..2 ^ 8 - 1>;
    -              SignatureAndHashAlgorithm supported_signature_algorithms <2 ^ 16 - 1>;
    -              DistinguishedName certificate_authorities <0..2 ^ 16 - 1>;
    -            } CertificateRequest;
    -            
    - Revised for RFC 8446: -
    -            struct {
    -              opaque certificate_request_context <0..2 ^ 8 - 1>;
    -              Extension extensions <2..2 ^ 16 - 1>;
    -            } CertificateRequest;
    -            
    -
    - - -
    - - - - - see for valid constants. - - an of . - - - - - - an array of certificate types - - - - an of (or null before TLS 1.2). - - - - an optional of . May be non-null from - TLS 1.3 onwards. - - - an of . - - - Encode this to a . - the of the current connection. - the to encode to. - - - - Parse a from a - the of the current connection. - the to parse from. - a object. - - - - an of (possibly null) . - - - Encode this to a . - the to encode to. - - - - Parse a from a . - the of the current connection. - the to parse from. - a object. - - - - - - - Implementation of the RFC 3546 3.6. CertificateStatusRequest. - - - Encode this to a . - the to encode to. - - - - Parse a from a . - the to parse from. - a object. - - - - Implementation of the RFC 6961 2.2. CertificateStatusRequestItemV2. - - - Encode this to a . - the to encode to. - - - - Parse a from a . - the to parse from. - a object. - - - - RFC 6091 - - - RFC 3546 3.3 - - - see for valid constants. - an of . - - - - - - an of . - - - Encode this to a . - the to encode to. - - - - Parse a from a . - the of the current connection. - the to parse from. - a object. - - - - RFC 5056 - - Note that the values here are implementation-specific and arbitrary. It is recommended not to depend on the - particular values (e.g.serialization). - - - - RFC 2246 A.5 - - - RFC 2246 - - Note that the values here are implementation-specific and arbitrary. It is recommended not to depend on the - particular values (e.g. serialization). - - - - Encode this to a . - the of the current connection. - the to encode to. - - - - Parse a from a . - the to parse from. - for DTLS this should be non-null; the input is copied to this - , minus the cookie field. - a object. - - - - - - - A combined hash, which implements md5(m) || sha1(m). - - - RFC 2246 6.1 - - - RFC 2246 - - Note that the values here are implementation-specific and arbitrary. It is recommended not to depend on the - particular values(e.g.serialization). - - - - RFC 2246 6.2.1 - - - Carrier class for Diffie-Hellman group parameters. - - - Base constructor with the prime factor of (p - 1). - the prime modulus. - specifies the prime factor of (p - 1). - the base generator. - - - - Standard Diffie-Hellman groups from various IETF specifications. - - - Base class for a TlsCrypto implementation that provides some needed methods from elsewhere in the impl - package. - - - Base class for a TlsSecret implementation which captures common code and fields. - - - Base constructor. - the byte[] making up the secret value. - - - - - - Credentialed class generating agreed secrets from a peer's public key for our end of the TLS connection - using the BC light-weight API. - - - Credentialed class decrypting RSA encrypted secrets sent from a peer for our end of the TLS connection - using the BC light-weight API. - - - Credentialed class for generating signatures based on the use of primitives from the BC light-weight API. - - - HMAC implementation based on original internet draft for HMAC (RFC 2104). - - The difference is that padding is concatenated versus XORed with the key, e.g: - H(K + opad, H(K + ipad, text)) - - - - Base constructor for one of the standard digest algorithms for which the byteLength is known. - - - Behaviour is undefined for digests other than MD5 or SHA1. - - the digest. - - - Reset the mac generator. - - - Implementation class for a single X.509 certificate based on the BC light-weight API. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Class for providing cryptographic services for TLS based on implementations in the BC light-weight API. -

    - This class provides default implementations for everything. If you need to customise it, extend the class - and override the appropriate methods. -

    -
    - - Support class for ephemeral Diffie-Hellman using the BC light-weight library. - - - - - - - - - - - - BC light-weight support class for Diffie-Hellman key pair generation and key agreement over a - specified Diffie-Hellman configuration. - - - - - - - - - - - - - - - Implementation class for generation of the raw DSA signature type using the BC light-weight API. - - - - Implementation class for the verification of the raw DSA signature type using the BC light-weight API. - - - - BC light-weight base class for the signers implementing the two DSA style algorithms from FIPS PUB - 186-4: DSA and ECDSA. - - - BC light-weight base class for the verifiers supporting the two DSA style algorithms from FIPS PUB - 186-4: DSA and ECDSA. - - - Support class for ephemeral Elliptic Curve Diffie-Hellman using the BC light-weight library. - - - EC domain class for generating key pairs and performing key agreement. - - - Implementation class for generation of ECDSA signatures in TLS 1.3+ using the BC light-weight API. - - - - Implementation class for verification of ECDSA signatures in TLS 1.3+ using the BC light-weight API. - - - - Implementation class for generation of the raw ECDSA signature type using the BC light-weight API. - - - - Implementation class for the verification of the raw ECDSA signature type using the BC light-weight - API. - - - Operator supporting the generation of RSASSA-PSS signatures using the BC light-weight API. - - - Operator supporting the verification of RSASSA-PSS signatures using the BC light-weight API. - - - Operator supporting the generation of RSASSA-PKCS1-v1_5 signatures using the BC light-weight API. - - - - Operator supporting the verification of RSASSA-PKCS1-v1_5 signatures using the BC light-weight API. - - - - BC light-weight support class for handling TLS secrets and deriving key material and other secrets - from them. - - - Support class for X25519 using the BC light-weight library. - - - Support class for X448 using the BC light-weight library. - - - A generic TLS 1.2 AEAD cipher. - - - - - - Base interface for services supporting AEAD encryption/decryption. - - - Set the key to be used by the AEAD cipher implementation supporting this service. - array holding the AEAD cipher key. - offset into the array the key starts at. - length of the key in the array. - - - - Initialise the parameters for the AEAD operator. - the nonce. - MAC size in bytes. - any additional data to be included in the MAC calculation. - if the parameters are inappropriate. - - - Return the maximum size of the output for input of inputLength bytes. - the length (in bytes) of the proposed input. - the maximum size of the output. - - - Perform the cipher encryption/decryption returning the output in output. - - Note: we have to use DoFinal() here as it is the only way to guarantee output from the underlying cipher. - - array holding input data to the cipher. - offset into input array data starts at. - length of the input data in the array. - array to hold the cipher output. - offset into output array to start saving output. - the amount of data written to output. - in case of failure. - - - A generic TLS 1.0-1.2 block cipher. This can be used for AES or 3DES for example. - - - - - - Interface for block cipher services. - - - Set the key to be used by the block cipher implementation supporting this service. - array holding the block cipher key. - offset into the array the key starts at. - length of the key in the array. - - - - Initialise the parameters for operator. - array holding the initialization vector (IV). - offset into the array the IV starts at. - length of the IV in the array. - if the parameters are inappropriate. - - - Perform the cipher encryption/decryption returning the output in output. - - Note: we have to use DoFinal() here as it is the only way to guarantee output from the underlying cipher. - - array holding input data to the cipher. - offset into input array data starts at. - length of the input data in the array. - array to hold the cipher output. - offset into output array to start saving output. - the amount of data written to output. - in case of failure. - - - Return the blocksize (in bytes) of the underlying block cipher. - the cipher's blocksize. - - - Useful utility methods. - - - The NULL cipher. - - - - - - A generic TLS MAC implementation, acting as an HMAC based on some underlying Digest. - - - Generate a new instance of a TlsMac. - the TLS client context specific crypto parameters. - The MAC to use. - - - Base interface for a generic TLS MAC implementation for use with a bulk cipher. - - - Return the output length (in bytes) of this MAC. - The output length of this MAC. - - - Calculate the MAC for some given data. - The sequence number of the record. - The content type of the message. - A byte array containing the message. - The number of bytes to skip, before the message starts. - The length of the message. - A new byte array containing the MAC value. - - - Constant time calculation of the MAC for some given data with a given expected length. - The sequence number of the record. - The content type of the message. - A byte array containing the message. - The number of bytes to skip, before the message starts. - The length of the message. - The expected length of the full message. - Random data for padding out the MAC calculation if required. - A new byte array containing the MAC value. - - - Carrier class for SRP-6 group parameters. - - - Base constructor. - the n value. - the g value. - - - A selection of standard groups for SRP-6. - - - Base interface for ephemeral key agreement calculator. - - - Generate an ephemeral key pair, returning the encoding of the public key. - a byte encoding of the public key. - - - - Pass in the public key for the peer to the agreement calculator. - a byte encoding of the peer public key. - - - - Calculate the agreed secret based on the calculator's current state. - the calculated secret. - - - - Interface providing the functional representation of a single X.509 certificate. - - - Return an encryptor based on the public key in this certificate. - - a based on this certificate's public key. - - - - - - - - - - - - - - - - - - the OID of this certificate's 'signatureAlgorithm', as a string. - - - - - - - - - - - true if (and only if) this certificate can be used to verify the given signature algorithm. - - - - - - - - - - - - Base interface for a TLS bulk cipher. - - - Return the maximum input size for a ciphertext given a maximum output size for the plaintext of - plaintextLimit bytes. - the maximum output size for the plaintext. - the maximum input size of the ciphertext for plaintextlimit bytes of output. - - - Return the maximum output size for a ciphertext given an actual input plaintext size of - plaintextLength bytes and a maximum input plaintext size of plaintextLimit bytes. - the actual input size for the plaintext. - the maximum input size for the plaintext. - the maximum output size of the ciphertext for plaintextlimit bytes of input. - - - Return the maximum size for the plaintext given ciphertextlimit bytes of ciphertext. - the maximum number of bytes of ciphertext. - the maximum size of the plaintext for ciphertextlimit bytes of input. - - - Encode the passed in plaintext using the current bulk cipher. - sequence number of the message represented by plaintext. - content type of the message represented by plaintext. - used for the record. - extra bytes to allocate at start of returned byte array. - array holding input plaintext to the cipher. - offset into input array the plaintext starts at. - length of the plaintext in the array. - A containing the result of encoding (after 'headerAllocation' unused - bytes). - - - - Decode the passed in ciphertext using the current bulk cipher. - sequence number of the message represented by ciphertext. - content type used in the record for this message. - used for the record. - array holding input ciphertext to the cipher. - offset into input array the ciphertext starts at. - length of the ciphertext in the array. - A containing the result of decoding. - - - - - - - - - - Service and object creation interface for the primitive types and services that are associated with - cryptography in the API. - - - Return true if this TlsCrypto can perform raw signatures and verifications for all supported - algorithms. - true if this instance can perform raw signatures and verifications for all supported algorithms, - false otherwise. - - - Return true if this TlsCrypto can support DH key agreement. - true if this instance can support DH key agreement, false otherwise. - - - Return true if this TlsCrypto can support ECDH key agreement. - true if this instance can support ECDH key agreement, false otherwise. - - - Return true if this TlsCrypto can support the passed in block/stream encryption algorithm. - - the algorithm of interest. - true if encryptionAlgorithm is supported, false otherwise. - - - Return true if this TlsCrypto can support the passed in hash algorithm. - the algorithm of interest. - true if cryptoHashAlgorithm is supported, false otherwise. - - - Return true if this TlsCrypto can support the passed in signature algorithm (not necessarily in - combination with EVERY hash algorithm). - the algorithm of interest. - true if cryptoSignatureAlgorithm is supported, false otherwise. - - - Return true if this TlsCrypto can support the passed in MAC algorithm. - the algorithm of interest. - true if macAlgorithm is supported, false otherwise. - - - Return true if this TlsCrypto supports the passed in named group - value. - true if this instance supports the passed in named group value. - - - - Return true if this TlsCrypto can support RSA encryption/decryption. - true if this instance can support RSA encryption/decryption, false otherwise. - - - Return true if this TlsCrypto can support the passed in signature algorithm (not necessarily in - combination with EVERY hash algorithm). - true if signatureAlgorithm is supported, false otherwise. - - - Return true if this TlsCrypto can support the passed in signature algorithm. - the algorithm of interest. - true if sigAndHashAlgorithm is supported, false otherwise. - - - Return true if this TlsCrypto can support the passed in signature scheme. - the scheme of interest. - true if signatureScheme is supported, false otherwise. - - - Return true if this TlsCrypto can support SRP authentication. - true if this instance can support SRP authentication, false otherwise. - - - Create a TlsSecret object based on provided data. - the data to base the TlsSecret on. - a TlsSecret based on the provided data. - - - Create a TlsSecret object containing a randomly-generated RSA PreMasterSecret - the client version to place in the first 2 bytes - a TlsSecret containing the PreMasterSecret. - - - Return the primary (safest) SecureRandom for this crypto. - a SecureRandom suitable for key generation. - - - Create a TlsCertificate from an ASN.1 binary encoding of an X.509 certificate. - DER/BER encoding of the certificate of interest. - a TlsCertificate. - if there is an issue on decoding or constructing the certificate. - - - Create a cipher for the specified encryption and MAC algorithms. - - See enumeration classes , for appropriate - argument values. - - context specific parameters. - the encryption algorithm to be employed by the cipher. - the MAC algorithm to be employed by the cipher. - a implementing the encryption and MAC algorithms. - - - - Create a domain object supporting the domain parameters described in dhConfig. - the config describing the DH parameters to use. - a TlsDHDomain supporting the parameters in dhConfig. - - - Create a domain object supporting the domain parameters described in ecConfig. - the config describing the EC parameters to use. - a TlsECDomain supporting the parameters in ecConfig. - - - Adopt the passed in secret, creating a new copy of it. - the secret to make a copy of. - a TlsSecret based on the original secret. - - - Create a suitable hash for the hash algorithm identifier passed in. - - See enumeration class for appropriate argument values. - - the hash algorithm the hash needs to implement. - a . - - - Create a suitable HMAC for the MAC algorithm identifier passed in. - - See enumeration class for appropriate argument values. - - the MAC algorithm the HMAC needs to match. - a . - - - Create a suitable HMAC using the hash algorithm identifier passed in. - - See enumeration class for appropriate argument values. - - the hash algorithm the HMAC should use. - a . - - - Create a nonce generator. - - Each call should construct a new generator, and the generator should be returned from this call only after - automatically seeding from this 's entropy source, and from the provided additional - seed material. The output of each returned generator must be completely independent of the others. - - context-specific seed material - a . - - - Create an SRP-6 client. - client config. - an initialised SRP6 client object. - - - Create an SRP-6 server. - server config. - the SRP6 verifier value. - an initialised SRP6 server object. - - - Create an SRP-6 verifier generator. - generator config. - an initialized SRP6 verifier generator. - - - Setup an initial "secret" for a chain of HKDF calls (RFC 5869), containing a string of HashLen - zeroes. - the hash algorithm to instantiate HMAC with. See - for values. - - - Basic exception class for crypto services to pass back a cause. - - - Carrier class for context-related parameters needed for creating secrets and ciphers. - - - Base constructor. - the context for this parameters object. - - - - - - Basic config for Diffie-Hellman. - - - Domain interface to service factory for creating Diffie-Hellman operators. - - - Return an agreement operator suitable for ephemeral Diffie-Hellman. - a key agreement operator. - - - Carrier class for Elliptic Curve parameter configuration. - - - Return the group used. - the named group used. - - - Domain interface to service factory for creating Elliptic-Curve (EC) based operators. - - - Return an agreement operator suitable for ephemeral EC Diffie-Hellman. - a key agreement operator. - - - Base interface for an encryptor. - - - Encrypt data from the passed in input array. - byte array containing the input data. - offset into input where the data starts. - the length of the data to encrypt. - the encrypted data. - - - - Interface for message digest, or hash, services. - - - Update the hash with the passed in input. - input array containing the data. - offset into the input array the input starts at. - the length of the input data. - - - Return calculated hash for any input passed in. - the hash value. - - - Return a clone of this hash object representing its current state. - a clone of the current hash. - - - Reset the hash underlying this service. - - - Interface for MAC services based on HMAC. - - - Return the internal block size for the message digest underlying this HMAC service. - the internal block size for the digest (in bytes). - - - Interface for MAC services. - - - Set the key to be used by the MAC implementation supporting this service. - array holding the MAC key. - offset into the array the key starts at. - length of the key in the array. - - - Update the MAC with the passed in input. - input array containing the data. - offset into the input array the input starts at. - the length of the input data. - - - Return calculated MAC for any input passed in. - the MAC value. - - - Write the calculated MAC to an output buffer. - output array to write the MAC to. - offset into the output array to write the MAC to. - - - Return the length of the MAC generated by this service. - the MAC length. - - - Reset the MAC underlying this service. - - - Generate a nonce byte[] string. - the length, in bytes, of the nonce to generate. - the nonce value. - - - The cipher for TLS_NULL_WITH_NULL_NULL. - - - Interface supporting the generation of key material and other SSL/TLS secret values from PRFs. - - - - Calculate an HMAC with this secret's data as the key. - the hash algorithm to instantiate HMAC with. See - for values. - array containing the input data. - offset into the input array the input starts at. - the length of the input data. - - - Return a new secret based on applying a PRF to this one. - PRF algorithm to use. - the label details. - the seed details. - the size (in bytes) of the secret to generate. - the new secret. - - - Destroy the internal state of the secret. - - After this call, any attempt to use the will result in an - being thrown. - - - - Return an encrypted copy of the data this secret is based on. - the encryptor to use for protecting the internal data. - an encrypted copy of this secret's internal data. - - - - Return the internal data from this secret. - - The does not keep a copy of the data. After this call, any attempt to use the - will result in an being thrown. - - the secret's internal data. - - - RFC 5869 HKDF-Expand function, with this secret's data as the pseudo-random key ('prk'). - the hash algorithm to instantiate HMAC with. See - for values. - optional context and application specific information (can be zero-length). - length of output keying material in octets. - output keying material (of 'length' octets). - - - RFC 5869 HKDF-Extract function, with this secret's data as the 'salt'. - - The does not keep a copy of the data. After this call, any attempt to use - the will result in an being thrown. - - the hash algorithm to instantiate HMAC with. See - for values. - input keying material. - a pseudo-random key (of HashLen octets). - - - Base interface for a TLS signer that works on raw message digests. - - - Generate an encoded signature based on the passed in hash. - the signature algorithm to use. - the hash calculated for the signature. - an encoded signature. - in case of an exception processing the hash. - - - - - - Basic interface for an SRP-6 client implementation. - - - Generates the secret S given the server's credentials - The server's credentials - Client's verification message for the server - If server's credentials are invalid - - - Generates client's credentials given the client's salt, identity and password - The salt used in the client's verifier. - The user's identity (eg. username) - The user's password - Client's public value to send to server - - - Basic interface for an SRP-6 server implementation. - - - Generates the server's credentials that are to be sent to the client. - The server's public value to the client - - - Processes the client's credentials. If valid the shared secret is generated and returned. - - The client's credentials. - A shared secret . - If client's credentials are invalid. - - - Base interface for a generator for SRP-6 verifiers. - - - Creates a new SRP-6 verifier value. - The salt to use, generally should be large and random - The user's identifying information (eg. username) - The user's password - A new verifier for use in future SRP authentication - - - Basic config for SRP. - - - Return the (N, g) values used in SRP-6. - (N, g) as a BigInteger array (N=[0], g=[1]). - - - Set the (N, g) values used for SRP-6. - (N, g) as a BigInteger array (N=[0], g=[1]). - - - - - - - - - - - - - - - Base interface for a TLS verifier that works with signatures and either raw message digests, or entire - messages. - - - - - - Return true if the passed in signature and hash represent a real signature. - the signature object containing the signature to be verified. - the hash calculated for the signature. - true if signature verifies, false otherwise. - in case of an exception verifying signature. - - - - - - - - - - - - - - - Base interface for an object sending and receiving DTLS data. - - - Container class for generating signatures that carries the signature type, parameters, public key - certificate and public key's associated signer object. - - - Accept named groups and various standard DH groups with 'P' at least - bits. - - - Accept named groups and various standard DH groups with 'P' at least the specified number of bits. - - the minimum bitlength of 'P'. - - - Accept named groups and a custom set of group parameters, subject to a minimum bitlength for 'P'. - - a list of acceptable s. - the minimum bitlength of 'P'. - - - - - - - - - - - - - - - Accept only the group parameters specified in RFC 5054 Appendix A. - - - Specify a custom set of acceptable group parameters. - an of acceptable . - - - Buffers input until the hash algorithm is determined. - - - - - - - - - a (or null before TLS 1.2). - - - Encode this to a . - the to encode to. - - - - Parse a from a . - the of the current connection. - the to parse from. - a object. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Check that there are no "extra" messages left in the current inbound flight - - - - - - - - - - - - - - - - - - - - - RFC 4347 4.1.2.5 Anti-replay -

    - Support fast rejection of duplicate records by maintaining a sliding receive window -

    -
    - - Check whether a received record with the given sequence number should be rejected as a duplicate. - - the 48-bit DTLSPlainText.sequence_number field of a received record. - true if the record should be discarded without further processing. - - - Report that a received record with the given sequence number passed authentication checks. - - the 48-bit DTLSPlainText.sequence_number field of an authenticated record. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - RFC 4492 5.4 - - - Indicates the elliptic curve domain parameters are conveyed verbosely, and the - underlying finite field is a prime field. - - - Indicates the elliptic curve domain parameters are conveyed verbosely, and the - underlying finite field is a characteristic-2 field. - - - Indicates that a named curve is used. This option SHOULD be used when applicable. - - - RFC 4492 5.1.2 - - - RFC 2246 - - Note that the values here are implementation-specific and arbitrary. It is recommended not to depend on the - particular values (e.g. serialization). - - - - RFC 5705 - - - - - - - - - - - - - - - RFC 5246 7.4.1.4.1 - - - Encode this to a . - the to encode to. - - - - Parse a from a . - the to parse from. - a object. - - - - Encode this to a . - the to encode to. - - - - Parse a from a . - the to parse from. - a object. - - - - RFC 6520 3. - - - RFC 6066 - - - RFC 2246 - - Note that the values here are implementation-specific and arbitrary. It is recommended not to depend on the - particular values (e.g. serialization). - - - - - - - - - - - Encode this to a . - the to encode to. - - - - Parse a from a . - the to parse from. - a object. - - - - RFC 8446 4.6.3 - - - RFC 2246 - - Note that the values here are implementation-specific and arbitrary. It is recommended not to depend on the - particular values (e.g. serialization). - - - - RFC 7919 - - - - Note that the values here are implementation-specific and arbitrary. It is recommended not to depend on the - particular values (e.g. serialization). - - - - Encode this to a . - the to encode to. - - - - Parse a from a . - the to parse from. - a object. - - - - RFC 3546 3.6 - - - an of , specifying the list of - trusted OCSP responders. An empty list has the special meaning that the responders are implicitly known to - the server - e.g., by prior arrangement. - OCSP request extensions. A null value means that there are no extensions. - - - - an of . - - - OCSP request extensions. - - - Encode this to a . - the to encode to. - - - - Parse an from a . - the to parse from. - an object. - - - - - - - - - - - - - - - - RFC 5246 - - Note that the values here are implementation-specific and arbitrary. It is recommended not to depend on the - particular values (e.g. serialization). - - - - RFC 7301 Represents a protocol name for use with ALPN. - - - Encode this to a . - the to encode to. - - - - Parse a from a . - the to parse from. - a object. - - - - - - - - - - An implementation of the TLS 1.0/1.1/1.2 record layer. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Encode this to a . - the of the current connection. - the to encode to. - - - - Parse a from a . - the to parse from. - a object. - - - - RFC 6066 3. Server Name Indication - - Current implementation uses this guidance: "For backward compatibility, all future data structures associated - with new NameTypes MUST begin with a 16-bit length field. TLS MAY treat provided server names as opaque data - and pass the names and types to the application.". RFC 6066 specifies ASCII encoding for host_name (possibly - using A-labels for IDNs), but note that the previous version (RFC 4366) specified UTF-8 encoding (see RFC 6066 - Appendix A). For maximum compatibility, it is recommended that client code tolerate receiving UTF-8 from the - peer, but only generate ASCII itself. - - - - Encode this to a . - the to encode to. - - - - Parse a from a . - the to parse from. - a object. - - - - an of . - - - an of . - - - Encode this to a . - the to encode to . - - - - Parse a from a . - the to parse from. - a object. - - - - Encode this to a . - the to encode to. - - - - Parse a from a . - the to parse from. - a object. - - - - - - - - - - RFC 5246 7.4.1.4.1 (in RFC 2246, there were no specific values assigned) - - - RFC 5246 7.4.1.4.1 - - - - - - - - - - - - - Encode this to a . - the to encode to. - - - - Parse a from a . - the to parse from. - a object. - - - - For TLS 1.3+ usage, some signature schemes are constrained to use a particular - ({@link NamedGroup}. Not relevant for TLS 1.2 and below. - - - An implementation of that simulates the existence of "unknown" - identities to obscure the fact that there is no verifier for them. - - - Create a that implements the algorithm from RFC 5054 - 2.5.1.3. - - the defining the group that SRP is operating in. - the secret "seed key" referred to in RFC 5054 2.5.1.3. - an instance of . - - - - - - - - - - - - - - - - - - - - - - - - - RFC 4680 - - - Base interface to provide TLS authentication credentials. - - - Called by the protocol handler to report the server certificate. - - Note: this method is responsible for certificate verification and validation. - - the server certificate received. - - - - Return client credentials in response to server's certificate request. - - The returned value may be null, or else it MUST implement exactly one of - , , or - , depending on the key exchange that was negotiated and the details of - the . - - details of the certificate request. - a object or null for no client authentication. - - - - Return the session this client wants to resume, if any. - - Note that the peer's certificate chain for the session (if any) may need to be periodically revalidated. - - A representing the resumable session to be used for this connection, or - null to use a new session. - - - - Return the external PSKs to offer in the ClientHello. - This will only be called when TLS 1.3 or higher is amongst the offered protocol versions. - an of instances, or null if none should be - offered. - - - (Int32 -> byte[]) - - - - If this client is offering TLS 1.3 or higher, this method may be called to determine for which - groups a key share should be included in the initial ClientHello. - - Groups that were not included in the supported_groups extension (by will - be ignored. The protocol will then add a suitable key_share extension to the ClientHello extensions. - - an of named group values, possibly empty or null. - - - - - - - Notifies the client of the session that will be offered in ClientHello for resumption, if any. - - - This will be either the session returned from {@link #getSessionToResume()} or null if that session was - unusable. NOTE: the actual negotiated session_id is notified by . - - The representing the resumable session to be offered for - this connection, or null if there is none. - - - - Notifies the client of the session_id sent in the ServerHello. - - - - - - - - The protocol implementation validates that any server extensions received correspond to client - extensions sent. - - If further processing of the server extensions is needed, it can be done in this callback. NOTE: This is - not called for session resumption handshakes. - - (Int32 -> byte[]) - - - - (SupplementalDataEntry) - - - - - - - - - - - - - - - - - - - (SupplementalDataEntry) - - - - RFC 5077 3.3. NewSessionTicket Handshake Message - - This method will be called (only) when a NewSessionTicket handshake message is received. The ticket is - opaque to the client and clients MUST NOT examine the ticket under the assumption that it complies with e.g. - RFC 5077 4. "Recommended Ticket Construction". - - The ticket. - - - - Marker interface to distinguish a TLS client context. - - - Constructor for non-blocking mode. - - When data is received, use to provide the received ciphertext, - then use to read the corresponding cleartext.

    - Similarly, when data needs to be sent, use - to provide the cleartext, then use to get the - corresponding ciphertext. -
    -
    - - Constructor for blocking mode. - The of data to/from the server. - - - Constructor for blocking mode. - The of data from the server. - The of data to the server. - - - Initiates a TLS handshake in the role of client. - - In blocking mode, this will not return until the handshake is complete. In non-blocking mode, use - to receive a callback when the handshake is complete. - - The to use for the handshake. - If in blocking mode and handshake was not successful. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Base interface for a TLS context implementation. - - - Return true if this context is for a server, false otherwise. - true for a server based context, false for a client based one. - - - Used to get the resumable session, if any, used by this connection. - - Only available after the handshake has successfully completed. - - A representing the resumable session used by this connection, or null if - no resumable session available. - - - - Used to get the session information for this connection. - - Only available after the handshake has successfully completed. Use - to find out if the session is resumable. - - A representing the session used by this connection. - - - - Export the value of the specified channel binding. - - Only available after the handshake has successfully completed. - - A constant specifying the channel binding to - export. - A copy of the channel binding data as a byte[], or null if the binding could not be - determined. - - - Export (early data) keying material according to RFC 5705: "Keying Material Exporters for TLS", as - updated for TLS 1.3 (RFC 8446). - - NOTE: for use in settings where an exporter is needed for 0-RTT data. - - indicates which application will use the exported keys. - allows the application using the exporter to mix its own data with the TLS PRF - for the exporter output. - the number of bytes to generate. - a pseudorandom bit string of 'length' bytes generated from the (exporter_)master_secret. - - - Export keying material according to RFC 5705: "Keying Material Exporters for TLS", as updated for - TLS 1.3 (RFC 8446) when negotiated. - indicates which application will use the exported keys. - allows the application using the exporter to mix its own data with the TLS PRF - for the exporter output. - the number of bytes to generate. - a pseudorandom bit string of 'length' bytes generated from the (exporter_)master_secret. - - - Support interface for generating a secret based on the credentials sent by a TLS peer. - - - Calculate an agreed secret based on our credentials and the public key credentials of our peer. - - public key certificate of our TLS peer. - the agreed secret. - in case of an exception on generation of the secret. - - - Base interface for a class that decrypts TLS secrets. - - - Decrypt the passed in cipher text using the parameters available. - the parameters to use for the decryption. - the cipher text containing the secret. - a TLS secret. - on a parsing or decryption error. - - - Support interface for generating a signature based on our private credentials. - - - Generate a signature against the passed in hash. - a message digest calculated across the message the signature is to apply to. - an encoded signature. - if the hash cannot be processed, or there is an issue with the private - credentials. - - - Return the algorithm IDs for the signature algorithm and the associated hash it uses. - the full algorithm details for the signature. - - - - - - Base interface for interfaces/classes carrying TLS credentials. - - - Return the certificate structure representing our identity. - our certificate structure. - - - (D)TLS DH_anon key exchange. - - - Interface for verifying explicit Diffie-Hellman group parameters. - - - Check whether the given DH group is acceptable for use. - the to check. - true if (and only if) the specified group is acceptable. - - - (D)TLS DH key exchange. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - (D)TLS ECDH_anon key exchange (see RFC 4492). - - - (D)TLS ECDHE key exchange (see RFC 4492). - - - (D)TLS ECDH key exchange (see RFC 4492). - - - (Int32 -> byte[]) - an of . - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - an of . - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - an of . - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - an of . - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Base interface for an object that can calculate a handshake hash. - - - - - - A generic interface for key exchange implementations in (D)TLS. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Interface for a key exchange factory offering a variety of specific algorithms. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - This exception will be thrown (only) when the connection is closed by the peer without sending a - close_notify warning alert. - - If this happens, the TLS protocol cannot rule out truncation of the connection data (potentially - malicious). It may be possible to check for truncation via some property of a higher level protocol - built upon TLS, e.g.the Content-Length header for HTTPS. - - - - Object Identifiers associated with TLS extensions. - - - RFC 7633 - - - Base interface for a (D)TLS endpoint. - - - - - - Notifies the peer that a new handshake is about to begin. - - - - Specify the timeout, in milliseconds, to use for the complete handshake process. - - NOTE: Currently only respected by DTLS protocols. Negative values are not allowed. A timeout of zero means - an infinite timeout (i.e.the handshake will never time out). - - the handshake timeout, in milliseconds. - - - - This option is provided as a last resort for interoperability with TLS peers that fail to correctly send a - close_notify alert at end of stream. Implementations SHOULD return true; caution is advised if returning - false without a full understanding of the implications. - - - - This implementation supports RFC 7627 and will always negotiate the extended_master_secret - extension where possible. When connecting to a peer that does not offer/accept this extension, it is - recommended to abort the handshake.This option is provided for interoperability with legacy peers, although - some TLS features will be disabled in that case (see RFC 7627 5.4). - - true if the handshake should be aborted when the peer does not negotiate the - extended_master_secret extension, or false to support legacy interoperability. - - - See RFC 5246 6.2.3.2. Controls whether block cipher encryption may randomly add extra padding - beyond the minimum. - - Note that in configurations where this is known to be potential security risk this setting will be ignored - (and extended padding disabled). Extra padding is always supported when decrypting received records. - - true if random extra padding should be added during block cipher encryption, or - false to always use the minimum amount of required padding. - - - draft-mathewson-no-gmtunixtime-00 2. "If existing users of a TLS implementation may rely on - gmt_unix_time containing the current time, we recommend that implementors MAY provide the ability to set - gmt_unix_time as an option only, off by default.". - - NOTE: For a server that has negotiated TLS 1.3 (or later), or a client that has offered TLS 1.3 (or later), - this is not called and gmt_unix_time is not used. - - true if the current time should be used in the gmt_unix_time field of Random, or - false if gmt_unix_time should contain a cryptographically random value. - - - RFC 5746 3.4/3.6. In case this is false, peers may want to terminate the handshake instead of - continuing; see Section 4.1/4.3 for discussion. - - NOTE: TLS 1.3 forbids renegotiation, so this is never called when TLS 1.3 (or later) was negotiated. - - - - - - - - This method will be called when an alert is raised by the protocol. - - - A human-readable message explaining what caused this alert. May be null. - The that caused this alert to be raised. May be null. - - - This method will be called when an alert is received from the remote peer. - - - - - Notifies the peer that the handshake has been successfully completed. - - - - Return a instance that will control the generation of heartbeats - locally (if permitted by the remote peer), or null to not generate heartbeats. Heartbeats are described in - RFC 6520. - an instance of . - - - - Return the heartbeat mode applicable to the remote peer. Heartbeats are described in RFC 6520. - - - See enumeration class for appropriate return values. - - the value. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - This method is called, when a change cipher spec message is received. - If the message has an invalid content or the handshake is not in the correct - state. - - - Read data from the network. - - The method will return immediately, if there is still some data left in the buffer, or block until some - application data has been read from the network. - - The buffer where the data will be copied to. - The position where the data will be placed in the buffer. - The maximum number of bytes to read. - The number of bytes read. - If something goes wrong during reading data. - - - - - - - - - - - - - - - Write some application data. - - Fragmentation is handled internally. Usable in both blocking/non-blocking modes.

    - In blocking mode, the output will be automatically sent via the underlying transport. In non-blocking mode, - call to get the output bytes to send to the peer.

    - This method must not be called until after the initial handshake is complete. Attempting to call it earlier - will result in an . -
    - The buffer containing application data to send. - The offset at which the application data begins - The number of bytes of application data. - If called before the initial handshake has completed. - - If connection is already closed, or for encryption or transport errors. - -
    - - - - - The secure bidirectional stream for this connection - Only allowed in blocking mode. - - - Should be called in non-blocking mode when the input data reaches EOF. - - - - - - - - - - Equivalent to OfferInput(input, 0, input.Length). - The input buffer to offer. - - - - - Offer input from an arbitrary source. - Only allowed in non-blocking mode.

    - This method will decrypt and process all records that are fully available. If only part of a record is - available, the buffer will be retained until the remainder of the record is offered.

    - If any records containing application data were processed, the decrypted data can be obtained using - . If any records containing protocol data were processed, a - response may have been generated. You should always check to see if there is any available output after - calling this method by calling . -
    - The input buffer to offer. - The offset within the input buffer that input begins. - The number of bytes of input being offered. - If an error occurs while decrypting or processing a record. -
    - - Gets the amount of received application data. - A call to is guaranteed to be able to return at least - this much data.

    - Only allowed in non-blocking mode. -
    - The number of bytes of available application data. -
    - - Retrieves received application data. - - Use to check how much application data is currently available. This - method functions similarly to , except that it never blocks. If - no data is available, nothing will be copied and zero will be returned.

    - Only allowed in non-blocking mode. -
    - The buffer to hold the application data. - The start offset in the buffer at which the data is written. - The maximum number of bytes to read. - The total number of bytes copied to the buffer. May be less than the length specified if the - length was greater than the amount of available data. -
    - - Gets the amount of encrypted data available to be sent. - - A call to is guaranteed to be able to return at least this much - data. Only allowed in non-blocking mode. - - The number of bytes of available encrypted data. - - - Retrieves encrypted data to be sent. - - Use to check how much encrypted data is currently available. This - method functions similarly to , except that it never blocks. If - no data is available, nothing will be copied and zero will be returned. Only allowed in non-blocking mode. - - The buffer to hold the encrypted data. - The start offset in the buffer at which the data is written. - The maximum number of bytes to read. - The total number of bytes copied to the buffer. May be less than the length specified if the - length was greater than the amount of available data. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Make sure the 'buf' is now empty. Fail otherwise. - The to check. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Processor interface for a PSK identity. - - - Base interface for an object that can process a PSK identity. - - - (D)TLS PSK key exchange (RFC 4279). - - - (D)TLS RSA key exchange. - - - Interface describing a TLS server endpoint. - - - Return the specified session, if available. - - Note that the peer's certificate chain for the session (if any) may need to be periodically revalidated. - - the ID of the session to resume. - A with the specified session ID, or null. - - - - Return the external PSK to select from the ClientHello. - - WARNING: EXPERIMENTAL FEATURE, UNSTABLE API - Note that this will only be called when TLS 1.3 or higher is amongst the offered protocol versions, and one - or more PSKs are actually offered. - - an of instances. - The corresponding to the selected identity, or null to not select - any. - - - - - - - - - - - - (Int32 -> byte[]) - - - - - - - - - - - - - (Int32 -> byte[]) - - - - (Int32 -> byte[]) - - - - (SupplementalDataEntry) - - - - Return server credentials to use. - - The returned value may be null, or else it MUST implement exactly one of - , , or - , depending on the key exchange that was negotiated. - - a object or null for anonymous key exchanges. - - - - - This method will be called (only) if the server included an extension of type "status_request" with empty - "extension_data" in the extended server hello. See RFC 3546 3.6. Certificate Status Request. If a - non-null is returned, it is sent to the client as a handshake message of - type "certificate_status". - - A to be sent to the client (or null for none). - - - - - - - - - - - - - - - - - - - (SupplementalDataEntry) - - - - Called by the protocol handler to report the client certificate, only if - returned non-null. - - Note: this method is responsible for certificate verification and validation. - - the effective client certificate (may be an empty chain). - - - - RFC 5077 3.3. NewSessionTicket Handshake Message. - - This method will be called (only) if a NewSessionTicket extension was sent by the server. See RFC 5077 - 4. Recommended Ticket Construction for recommended format and protection. - - The ticket. - - - - Server certificate carrier interface. - - - Marker interface to distinguish a TLS server context. - - - Constructor for non-blocking mode. - - When data is received, use to provide the received ciphertext, - then use to read the corresponding cleartext.

    - Similarly, when data needs to be sent, use - to provide the cleartext, then use to get the - corresponding ciphertext. -
    -
    - - Constructor for blocking mode. - The of data to/from the server. - - - Constructor for blocking mode. - The of data from the server. - The of data to the server. - - - Receives a TLS handshake in the role of server. - - In blocking mode, this will not return until the handshake is complete. In non-blocking mode, use - to receive a callback when the handshake is complete. - - The to use for the handshake. - If in blocking mode and handshake was not successful. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Base interface for a carrier object for a TLS session. - - - Interface for verifying SRP config needs to conform to. - - - Check whether the given SRP configuration is acceptable for use. - the to check. - true if (and only if) the specified configuration is acceptable. - - - Processor interface for an SRP identity. - - - Base interface for an object that can return login parameters from an SRP identity. - - - Lookup the corresponding to the specified identity. - - NOTE: To avoid "identity probing", unknown identities SHOULD be handled as recommended in RFC 5054 2.5.1.3. - is provided for this purpose. - - the SRP identity sent by the connecting client. - the for the specified identity, or else 'simulated' parameters - if the identity is not recognized. A null value is also allowed, but not recommended. - - - (D)TLS SRP key exchange (RFC 5054). - - - - - - - - - - - - - - - - - - - - - RFC 5764 DTLS Extension to Establish Keys for SRTP. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Whether a server can select the specified cipher suite given the available signature algorithms - for ServerKeyExchange. - - - - - - - - - - - - - - - - - - - - - Check the signature algorithm for certificates in the peer's CertPath as specified in RFC 5246 - 7.4.2, 7.4.4, 7.4.6 and similar rules for earlier TLS versions. - - The supplied CertPath should include the trust anchor (its signature algorithm isn't checked, but in the - general case checking a certificate requires the issuer certificate). - - if any certificate in the CertPath (excepting the trust anchor) has a - signature algorithm that is not one of the locally supported signature algorithms. - - - - - - - - - - - - - - - Generate a pre_master_secret and send it encrypted to the server. - - - - - - - - - - - - - - - - Encode this to a . - the to encode to. - - - - Parse a from a . - the to parse from. - a object. - - - - RFC 6066 5. - - - Encode this to a . - the to encode to. - - - - Parse a from a . - the of the current connection. - the to parse from. - a object. - - - - RFC 4681 - - - RFC 5764 4.1.1 - - - see for valid constants. - valid lengths from 0 to 255. - - - see for valid constants. - - - valid lengths from 0 to 255. - - - Base class for an RFC 3161 Time Stamp Request. - - - Create a TimeStampRequest from the past in byte array. - - @param req byte array containing the request. - @throws IOException if the request is malformed. - - - Create a TimeStampRequest from the past in input stream. - - @param in input stream containing the request. - @throws IOException if the request is malformed. - - - Validate the timestamp request, checking the digest to see if it is of an - accepted type and whether it is of the correct length for the algorithm specified. - - @param algorithms a set of string OIDS giving accepted algorithms. - @param policies if non-null a set of policies we are willing to sign under. - @param extensions if non-null a set of extensions we are willing to accept. - @throws TspException if the request is invalid, or processing fails. - - - return the ASN.1 encoded representation of this object. - - - Generator for RFC 3161 Time Stamp Request objects. - - - add a given extension field for the standard extensions tag (tag 3) - @throws IOException - - - add a given extension field for the standard extensions tag - The value parameter becomes the contents of the octet string associated - with the extension. - - - add a given extension field for the standard extensions tag (tag 3) - @throws IOException - - - add a given extension field for the standard extensions tag - The value parameter becomes the contents of the octet string associated - with the extension. - - - Base class for an RFC 3161 Time Stamp Response object. - - - Create a TimeStampResponse from a byte array containing an ASN.1 encoding. - - @param resp the byte array containing the encoded response. - @throws TspException if the response is malformed. - @throws IOException if the byte array doesn't represent an ASN.1 encoding. - - - Create a TimeStampResponse from an input stream containing an ASN.1 encoding. - - @param input the input stream containing the encoded response. - @throws TspException if the response is malformed. - @throws IOException if the stream doesn't represent an ASN.1 encoding. - - - Check this response against to see if it a well formed response for - the passed in request. Validation will include checking the time stamp - token if the response status is GRANTED or GRANTED_WITH_MODS. - - @param request the request to be checked against - @throws TspException if the request can not match this response. - - - return the ASN.1 encoded representation of this object. - - - Generator for RFC 3161 Time Stamp Responses. - - - Return an appropriate TimeStampResponse. -

    - If genTime is null a timeNotAvailable error response will be returned. - - @param request the request this response is for. - @param serialNumber serial number for the response token. - @param genTime generation time for the response token. - @param provider provider to use for signature calculation. - @return - @throws NoSuchAlgorithmException - @throws NoSuchProviderException - @throws TSPException -

    -
    - - Generate a TimeStampResponse with chosen status and FailInfoField. - - @param status the PKIStatus to set. - @param failInfoField the FailInfoField to set. - @param statusString an optional string describing the failure. - @return a TimeStampResponse with a failInfoField and optional statusString - @throws TSPException in case the response could not be created - - - Validate the time stamp token. -

    - To be valid the token must be signed by the passed in certificate and - the certificate must be the one referred to by the SigningCertificate - attribute included in the hashed attributes of the token. The - certificate must also have the ExtendedKeyUsageExtension with only - KeyPurposeID.IdKPTimeStamping and have been valid at the time the - timestamp was created. -

    -

    - A successful call to validate means all the above are true. -

    -
    - - Return the underlying CmsSignedData object. - - @return the underlying CMS structure. - - - Return a ASN.1 encoded byte stream representing the encoded object. - - @throws IOException if encoding fails. - - - return the ASN.1 encoded representation of this object using the specified encoding. - - @param encoding the ASN.1 encoding format to use ("BER" or "DER"). - - - basic creation - only the default attributes will be included here. - - - create with a signer with extra signed/unsigned attributes. - - - @return the nonce value, null if there isn't one. - - - Recognised hash algorithms for the time stamp protocol. - - - Fetches the signature time-stamp attributes from a SignerInformation object. - Checks that the MessageImprint for each time-stamp matches the signature field. - (see RFC 3161 Appendix A). - - @param signerInfo a SignerInformation to search for time-stamps - @return a collection of TimeStampToken objects - @throws TSPValidationException - - - Validate the passed in certificate as being of the correct type to be used - for time stamping. To be valid it must have an ExtendedKeyUsage extension - which has a key purpose identifier of id-kp-timeStamping. - - @param cert the certificate of interest. - @throws TspValidationException if the certicate fails on one of the check points. - - - - Return the digest algorithm using one of the standard JCA string - representations rather than the algorithm identifier (if possible). - - - - Exception thrown if a TSP request or response fails to validate. -

    - If a failure code is associated with the exception it can be retrieved using - the getFailureCode() method.

    -
    - - Return the failure code associated with this exception - if one is set. - - @return the failure code if set, -1 otherwise. - - - General array utilities. - - - - Are two arrays equal. - - Left side. - Right side. - True if equal. - - - - A constant time equals comparison - does not terminate early if - test will fail. - - first array - second array - true if arrays equal, false otherwise. - - - Make a copy of a range of bytes from the passed in data array. The range can - extend beyond the end of the input array, in which case the return array will - be padded with zeroes. - - @param data the array from which the data is to be copied. - @param from the start index at which the copying should take place. - @param to the final index of the range (exclusive). - - @return a new byte array containing the range given. - - - BigInteger utilities. - - - Return the passed in value as an unsigned byte array. - - @param value the value to be converted. - @return a byte array without a leading zero byte if present in the signed encoding. - - - Return the passed in value as an unsigned byte array of the specified length, padded with - leading zeros as necessary. - @param length the fixed length of the result. - @param n the value to be converted. - @return a byte array padded to a fixed length with leading zeros. - - - Write the passed in value as unsigned bytes to the specified buffer range, padded with - leading zeros as necessary. - - @param value - the value to be converted. - @param buf - the buffer to which the value is written. - @param off - the start offset in array buf at which the data is written. - @param len - the fixed length of data written (possibly padded with leading zeros). - - - - Creates a Random BigInteger from the secure random of a given bit length. - - - - - - - Return a random BigInteger not less than 'min' and not greater than 'max' - - @param min the least value that may be generated - @param max the greatest value that may be generated - @param random the source of randomness - @return a random BigInteger value in the range [min,max] - - - - Return the number of milliseconds since the Unix epoch (1 Jan., 1970 UTC) for a given DateTime value. - - A UTC DateTime value not before epoch. - Number of whole milliseconds after epoch. - 'dateTime' is before epoch. - - - - Create a DateTime value from the number of milliseconds since the Unix epoch (1 Jan., 1970 UTC). - - Number of milliseconds since the epoch. - A UTC DateTime value - - - - Return the current number of milliseconds since the Unix epoch (1 Jan., 1970 UTC). - - - - encode the input data producing a base 64 encoded byte array. - - @return a byte array containing the base 64 encoded data. - - - encode the input data producing a base 64 encoded byte array. - - @return a byte array containing the base 64 encoded data. - - - Encode the byte data to base 64 writing it to the given output stream. - - @return the number of bytes produced. - - - Encode the byte data to base 64 writing it to the given output stream. - - @return the number of bytes produced. - - - decode the base 64 encoded input data. It is assumed the input data is valid. - - @return a byte array representing the decoded data. - - - decode the base 64 encoded string data - whitespace will be ignored. - - @return a byte array representing the decoded data. - - - decode the base 64 encoded string data writing it to the given output stream, - whitespace characters will be ignored. - - @return the number of bytes produced. - - - encode the input data producing a base 64 output stream. - - @return the number of bytes produced. - - - decode the base 64 encoded byte data writing it to the given output stream, - whitespace characters will be ignored. - - @return the number of bytes produced. - - - decode the base 64 encoded string data writing it to the given output stream, - whitespace characters will be ignored. - - @return the number of bytes produced. - - - - A buffering class to allow translation from one format to another to - be done in discrete chunks. - - - - - Create a buffered Decoder. - - The translater to use. - The size of the buffer. - - - - Process one byte of data. - - Data in. - Byte array for the output. - The offset in the output byte array to start writing from. - The amount of output bytes. - - - - Process data from a byte array. - - The input data. - Start position within input data array. - Amount of data to process from input data array. - Array to store output. - Position in output array to start writing from. - The amount of output bytes. - - - - A class that allows encoding of data using a specific encoder to be processed in chunks. - - - - - Create. - - The translator to use. - Size of the chunks. - - - - Process one byte of data. - - The byte. - An array to store output in. - Offset within output array to start writing from. - - - - - Process data from a byte array. - - Input data Byte array containing data to be processed. - Start position within input data array. - Amount of input data to be processed. - Output data array. - Offset within output data array to start writing to. - The amount of data written. - - - - Class to decode and encode Hex. - - - - encode the input data producing a Hex encoded byte array. - - @return a byte array containing the Hex encoded data. - - - encode the input data producing a Hex encoded byte array. - - @return a byte array containing the Hex encoded data. - - - Hex encode the byte data writing it to the given output stream. - - @return the number of bytes produced. - - - Hex encode the byte data writing it to the given output stream. - - @return the number of bytes produced. - - - decode the Hex encoded input data. It is assumed the input data is valid. - - @return a byte array representing the decoded data. - - - decode the Hex encoded string data - whitespace will be ignored. - - @return a byte array representing the decoded data. - - - decode the Hex encoded string data writing it to the given output stream, - whitespace characters will be ignored. - - @return the number of bytes produced. - - - Decode the hexadecimal-encoded string strictly i.e. any non-hexadecimal characters will be - considered an error. - - @return a byte array representing the decoded data. - - - Decode the hexadecimal-encoded string strictly i.e. any non-hexadecimal characters will be - considered an error. - - @return a byte array representing the decoded data. - - - encode the input data producing a Hex output stream. - - @return the number of bytes produced. - - - decode the Hex encoded byte data writing it to the given output stream, - whitespace characters will be ignored. - - @return the number of bytes produced. - - - decode the Hex encoded string data writing it to the given output stream, - whitespace characters will be ignored. - - @return the number of bytes produced. - - - - A hex translator. - - - - - Return encoded block size. - - 2 - - - - Encode some data. - - Input data array. - Start position within input data array. - The amount of data to process. - The output data array. - The offset within the output data array to start writing from. - Amount of data encoded. - - - - Returns the decoded block size. - - 1 - - - - Decode data from a byte array. - - The input data array. - Start position within input data array. - The amounty of data to process. - The output data array. - The position within the output data array to start writing from. - The amount of data written. - - - Encode and decode byte arrays (typically from binary to 7-bit ASCII - encodings). - - - - Translator interface. - - - - Convert binary data to and from UrlBase64 encoding. This is identical to - Base64 encoding, except that the padding character is "." and the other - non-alphanumeric characters are "-" and "_" instead of "+" and "/". -

    - The purpose of UrlBase64 encoding is to provide a compact encoding of binary - data that is safe for use as an URL parameter. Base64 encoding does not - produce encoded values that are safe for use in URLs, since "/" can be - interpreted as a path delimiter; "+" is the encoded form of a space; and - "=" is used to separate a name from the corresponding value in an URL - parameter. -

    -
    - - Encode the input data producing a URL safe base 64 encoded byte array. - - @return a byte array containing the URL safe base 64 encoded data. - - - Encode the byte data writing it to the given output stream. - - @return the number of bytes produced. - - - Decode the URL safe base 64 encoded input data - white space will be ignored. - - @return a byte array representing the decoded data. - - - decode the URL safe base 64 encoded byte data writing it to the given output stream, - whitespace characters will be ignored. - - @return the number of bytes produced. - - - decode the URL safe base 64 encoded string data - whitespace will be ignored. - - @return a byte array representing the decoded data. - - - Decode the URL safe base 64 encoded string data writing it to the given output stream, - whitespace characters will be ignored. - - @return the number of bytes produced. - - - Convert binary data to and from UrlBase64 encoding. This is identical to - Base64 encoding, except that the padding character is "." and the other - non-alphanumeric characters are "-" and "_" instead of "+" and "/". -

    - The purpose of UrlBase64 encoding is to provide a compact encoding of binary - data that is safe for use as an URL parameter. Base64 encoding does not - produce encoded values that are safe for use in URLs, since "/" can be - interpreted as a path delimiter; "+" is the encoded form of a space; and - "=" is used to separate a name from the corresponding value in an URL - parameter. -

    -
    - - - Produce a copy of this object with its configuration and in its current state. - - - The returned object may be used simply to store the state, or may be used as a similar object - starting from the copied state. - - - - - Restore a copied object state into this object. - - - Implementations of this method should try to avoid or minimise memory allocation to perform the reset. - - an object originally {@link #copy() copied} from an object of the same type as this instance. - if the provided object is not of the correct type. - if the other parameter is in some other way invalid. - - - - A - - - - - - A - - - A - - - - - - A - - - - - - Seek ':" up to the limit. - - - - - - - Consume the dashes - - - - - - Skip white space leave char in stream. - - - - - Read forward consuming the expected string. - - expected string - false if not consumed - - - - Consume until dash. - - true if stream end not met - - - A generic PEM writer, based on RFC 1421 - - - Base constructor. - - @param out output stream to use. - - - Return the number of bytes or characters required to contain the - passed in object if it is PEM encoded. - - @param obj pem object to be output - @return an estimate of the number of bytes - - - Write the full contents of inStr to the destination stream outStr. - Source stream. - Destination stream. - In case of IO failure. - - - Write the full contents of inStr to the destination stream outStr. - Source stream. - Destination stream. - The size of temporary buffer to use. - In case of IO failure. - - - - Pipe all bytes from inStr to outStr, throwing StreamFlowException if greater - than limit bytes in inStr. - - - A - - - A - - - A - - The number of bytes actually transferred, if not greater than limit - - - - - - - - - - Exception to be thrown on a failure to reset an object implementing Memoable. -

    - The exception extends InvalidCastException to enable users to have a single handling case, - only introducing specific handling of this one if required. -

    -
    - - Basic Constructor. - - @param msg message to be associated with this exception. - - - Validate the given IPv4 or IPv6 address. - - @param address the IP address as a string. - - @return true if a valid address, false otherwise - - - Validate the given IPv4 or IPv6 address and netmask. - - @param address the IP address as a string. - - @return true if a valid address with netmask, false otherwise - - - Validate the given IPv4 address. - - @param address the IP address as a string. - - @return true if a valid IPv4 address, false otherwise - - - Validate the given IPv6 address. - - @param address the IP address as a string. - - @return true if a valid IPv4 address, false otherwise - - - General string utilities. - - - - Summary description for DeflaterOutputStream. - - - - - Summary description for DeflaterOutputStream. - - - - - The Holder object. -
    -            Holder ::= SEQUENCE {
    -            	baseCertificateID   [0] IssuerSerial OPTIONAL,
    -            		-- the issuer and serial number of
    -            		-- the holder's Public Key Certificate
    -            	entityName          [1] GeneralNames OPTIONAL,
    -            		-- the name of the claimant or role
    -            	objectDigestInfo    [2] ObjectDigestInfo OPTIONAL
    -            		-- used to directly authenticate the holder,
    -            		-- for example, an executable
    -            }
    -            
    -
    -
    - - Constructs a holder for v2 attribute certificates with a hash value for - some type of object. -

    - digestedObjectType can be one of the following: -

      -
    • 0 - publicKey - A hash of the public key of the holder must be - passed.
    • -
    • 1 - publicKeyCert - A hash of the public key certificate of the - holder must be passed.
    • -
    • 2 - otherObjectDigest - A hash of some other object type must be - passed. otherObjectTypeID must not be empty.
    • -
    -

    -

    This cannot be used if a v1 attribute certificate is used.

    - - @param digestedObjectType The digest object type. - @param digestAlgorithm The algorithm identifier for the hash. - @param otherObjectTypeID The object type ID if - digestedObjectType is - otherObjectDigest. - @param objectDigest The hash value. -
    - - Returns the digest object type if an object digest info is used. -

    -

      -
    • 0 - publicKey - A hash of the public key of the holder must be - passed.
    • -
    • 1 - publicKeyCert - A hash of the public key certificate of the - holder must be passed.
    • -
    • 2 - otherObjectDigest - A hash of some other object type must be - passed. otherObjectTypeID must not be empty.
    • -
    -

    - - @return The digest object type or -1 if no object digest info is set. -
    - - Returns the other object type ID if an object digest info is used. - - @return The other object type ID or null if no object - digest info is set. - - - Returns the hash if an object digest info is used. - - @return The hash or null if no object digest info is set. - - - Returns the digest algorithm ID if an object digest info is used. - - @return The digest algorithm ID or null if no object - digest info is set. - - - Return any principal objects inside the attribute certificate holder entity names field. - - @return an array of IPrincipal objects (usually X509Name), null if no entity names field is set. - - - Return the principals associated with the issuer attached to this holder - - @return an array of principals, null if no BaseCertificateID is set. - - - Return the serial number associated with the issuer attached to this holder. - - @return the certificate serial number, null if no BaseCertificateID is set. - - - Carrying class for an attribute certificate issuer. - - - Set the issuer directly with the ASN.1 structure. - - @param issuer The issuer - - - Return any principal objects inside the attribute certificate issuer object. - An array of IPrincipal objects (usually X509Principal). - - - A high level authority key identifier. - - - Constructor which will take the byte[] returned from getExtensionValue() - - @param encodedValue a DER octet encoded string with the extension structure in it. - @throws IOException on parsing errors. - - - Create an AuthorityKeyIdentifier using the passed in certificate's public - key, issuer and serial number. - - @param certificate the certificate providing the information. - @throws CertificateParsingException if there is a problem processing the certificate - - - Create an AuthorityKeyIdentifier using just the hash of the - public key. - - @param pubKey the key to generate the hash from. - @throws InvalidKeyException if there is a problem using the key. - - - A high level subject key identifier. - - - Constructor which will take the byte[] returned from getExtensionValue() - - @param encodedValue a DER octet encoded string with the extension structure in it. - @throws IOException on parsing errors. - - - Interface for an X.509 Attribute Certificate. - - - The version number for the certificate. - - - The serial number for the certificate. - - - The UTC DateTime before which the certificate is not valid. - - - The UTC DateTime after which the certificate is not valid. - - - The holder of the certificate. - - - The issuer details for the certificate. - - - Return the attributes contained in the attribute block in the certificate. - An array of attributes. - - - Return the attributes with the same type as the passed in oid. - The object identifier we wish to match. - An array of matched attributes, null if there is no match. - - - Return an ASN.1 encoded byte array representing the attribute certificate. - An ASN.1 encoded byte array. - If the certificate cannot be encoded. - - - - Get all critical extension values, by oid - - IDictionary with string (OID) keys and Asn1OctetString values - - - - Get all non-critical extension values, by oid - - IDictionary with string (OID) keys and Asn1OctetString values - - - - A utility class that will extract X509Principal objects from X.509 certificates. -

    - Use this in preference to trying to recreate a principal from a string, not all - DNs are what they should be, so it's best to leave them encoded where they - can be.

    -
    -
    - - Return the issuer of the given cert as an X509Principal. - - - Return the subject of the given cert as an X509Principal. - - - Return the issuer of the given CRL as an X509Principal. - - - This class is an Selector like implementation to select - attribute certificates from a given set of criteria. - - @see org.bouncycastle.x509.X509AttributeCertificate - @see org.bouncycastle.x509.X509Store - - - - Decides if the given attribute certificate should be selected. - - The attribute certificate to be checked. - true if the object matches this selector. - - - The attribute certificate which must be matched. - If null is given, any will do. - - - The criteria for validity - If null is given any will do. - - - The holder. - If null is given any will do. - - - The issuer. - If null is given any will do. - - - The serial number. - If null is given any will do. - - - Adds a target name criterion for the attribute certificate to the target - information extension criteria. The X509AttributeCertificate - must contain at least one of the specified target names. -

    - Each attribute certificate may contain a target information extension - limiting the servers where this attribute certificate can be used. If - this extension is not present, the attribute certificate is not targeted - and may be accepted by any server. -

    - - @param name The name as a GeneralName (not null) -
    - - Adds a target name criterion for the attribute certificate to the target - information extension criteria. The X509AttributeCertificate - must contain at least one of the specified target names. -

    - Each attribute certificate may contain a target information extension - limiting the servers where this attribute certificate can be used. If - this extension is not present, the attribute certificate is not targeted - and may be accepted by any server. -

    - - @param name a byte array containing the name in ASN.1 DER encoded form of a GeneralName - @throws IOException if a parsing error occurs. -
    - - Adds a collection with target names criteria. If null is - given any will do. -

    - The collection consists of either GeneralName objects or byte[] arrays representing - DER encoded GeneralName structures. -

    - - @param names A collection of target names. - @throws IOException if a parsing error occurs. - @see #AddTargetName(byte[]) - @see #AddTargetName(GeneralName) -
    - - Gets the target names. The collection consists of Lists - made up of an Integer in the first entry and a DER encoded - byte array or a String in the second entry. -

    The returned collection is immutable.

    - - @return The collection of target names - @see #setTargetNames(Collection) -
    - - Adds a target group criterion for the attribute certificate to the target - information extension criteria. The X509AttributeCertificate - must contain at least one of the specified target groups. -

    - Each attribute certificate may contain a target information extension - limiting the servers where this attribute certificate can be used. If - this extension is not present, the attribute certificate is not targeted - and may be accepted by any server. -

    - - @param group The group as GeneralName form (not null) -
    - - Adds a target group criterion for the attribute certificate to the target - information extension criteria. The X509AttributeCertificate - must contain at least one of the specified target groups. -

    - Each attribute certificate may contain a target information extension - limiting the servers where this attribute certificate can be used. If - this extension is not present, the attribute certificate is not targeted - and may be accepted by any server. -

    - - @param name a byte array containing the group in ASN.1 DER encoded form of a GeneralName - @throws IOException if a parsing error occurs. -
    - - Adds a collection with target groups criteria. If null is - given any will do. -

    - The collection consists of GeneralName objects or byte[] - representing DER encoded GeneralNames. -

    - - @param names A collection of target groups. - @throws IOException if a parsing error occurs. - @see #AddTargetGroup(byte[]) - @see #AddTargetGroup(GeneralName) -
    - - Gets the target groups. The collection consists of Lists - made up of an Integer in the first entry and a DER encoded - byte array or a String in the second entry. -

    The returned collection is immutable.

    - - @return The collection of target groups. - @see #setTargetGroups(Collection) -
    - - - This class is an IX509Selector implementation to select - certificate pairs, which are e.g. used for cross certificates. The set of - criteria is given from two X509CertStoreSelector objects, - each of which, if present, must match the respective component of a pair. - - - - The certificate pair which is used for testing on equality. - - - The certificate selector for the forward part. - - - The certificate selector for the reverse part. - - - - Decides if the given certificate pair should be selected. If - obj is not a X509CertificatePair, this method - returns false. - - The X509CertificatePair to be tested. - true if the object matches this selector. - - - - An ISet of DerObjectIdentifier objects. - - - - A simple collection backed store. - - - Basic constructor. - - @param collection - initial contents for the store, this is copied. - - - Return the matches in the collection for the passed in selector. - - @param selector the selector to match against. - @return a possibly empty collection of matching objects. - - - This class contains a collection for collection based X509Stores. - - - - Constructor. -

    - The collection is copied. -

    -
    - The collection containing X.509 object types. - If collection is null. -
    - - Returns a copy of the ICollection. - - - Returns a formatted string describing the parameters. - - - - An ICollection of X509Name objects - - - - The attribute certificate being checked. This is not a criterion. - Rather, it is optional information that may help a {@link X509Store} find - CRLs that would be relevant when checking revocation for the specified - attribute certificate. If null is specified, then no such - optional information is provided. - - @param attrCert the IX509AttributeCertificate being checked (or - null) - @see #getAttrCertificateChecking() - - - If true only complete CRLs are returned. Defaults to - false. - - @return true if only complete CRLs are returned. - - - Returns if this selector must match CRLs with the delta CRL indicator - extension set. Defaults to false. - - @return Returns true if only CRLs with the delta CRL - indicator extension are selected. - - - The issuing distribution point. -

    - The issuing distribution point extension is a CRL extension which - identifies the scope and the distribution point of a CRL. The scope - contains among others information about revocation reasons contained in - the CRL. Delta CRLs and complete CRLs must have matching issuing - distribution points.

    -

    - The byte array is cloned to protect against subsequent modifications.

    -

    - You must also enable or disable this criteria with - {@link #setIssuingDistributionPointEnabled(bool)}.

    - - @param issuingDistributionPoint The issuing distribution point to set. - This is the DER encoded OCTET STRING extension value. - @see #getIssuingDistributionPoint() -
    - - Whether the issuing distribution point criteria should be applied. - Defaults to false. -

    - You may also set the issuing distribution point criteria if not a missing - issuing distribution point should be assumed.

    - - @return Returns if the issuing distribution point check is enabled. -
    - - The maximum base CRL number. Defaults to null. - - @return Returns the maximum base CRL number. - @see #setMaxBaseCRLNumber(BigInteger) - - - - A factory to produce Public Key Info Objects. - - - - - Create a Subject Public Key Info object for a given public key. - - One of ElGammalPublicKeyParameters, DSAPublicKeyParameter, DHPublicKeyParameters, RsaKeyParameters or ECPublicKeyParameters - A subject public key info object. - Throw exception if object provided is not one of the above. - - - - Create loading data from byte array. - - - - - - Create loading data from byte array. - - - - - Generates a certificate object and initializes it with the data - read from the input stream inStream. - - - Returns a (possibly empty) collection view of the certificates - read from the given input stream inStream. - - - Class for carrying the values in an X.509 Attribute. - - - @param at an object representing an attribute. - - - Create an X.509 Attribute with the type given by the passed in oid and - the value represented by an ASN.1 Set containing value. - - @param oid type of the attribute - @param value value object to go into the atribute's value set. - - - Create an X.59 Attribute with the type given by the passed in oid and the - value represented by an ASN.1 Set containing the objects in value. - - @param oid type of the attribute - @param value vector of values to go in the attribute's value set. - - - - An Object representing an X509 Certificate. - Has static methods for loading Certificates encoded in many forms that return X509Certificate Objects. - - - - - Return true if the current time is within the start and end times nominated on the certificate. - - true id certificate is valid for the current time. - - - - Return true if the nominated time is within the start and end times nominated on the certificate. - - The time to test validity against. - True if certificate is valid for nominated time. - - - - Checks if the current date is within certificate's validity period. - - - - - Checks if the given date is within certificate's validity period. - - if the certificate is expired by given date - if the certificate is not yet valid on given date - - - - Return the certificate's version. - - An integer whose value Equals the version of the cerficate. - - - - Return a BigInteger containing the serial number. - - The Serial number. - - - - Get the Issuer Distinguished Name. (Who signed the certificate.) - - And X509Object containing name and value pairs. - - - - Get the subject of this certificate. - - An X509Name object containing name and value pairs. - - - - The time that this certificate is valid from. - - A DateTime object representing that time in the local time zone. - - - - The time that this certificate is valid up to. - - A DateTime object representing that time in the local time zone. - - - - Return the Der encoded TbsCertificate data. - This is the certificate component less the signature. - To Get the whole certificate call the GetEncoded() member. - - A byte array containing the Der encoded Certificate component. - - - - The signature. - - A byte array containg the signature of the certificate. - - - - A meaningful version of the Signature Algorithm. (EG SHA1WITHRSA) - - A sting representing the signature algorithm. - - - - Get the Signature Algorithms Object ID. - - A string containg a '.' separated object id. - - - - Get the signature algorithms parameters. (EG DSA Parameters) - - A byte array containing the Der encoded version of the parameters or null if there are none. - - - - Get the issuers UID. - - A DerBitString. - - - - Get the subjects UID. - - A DerBitString. - - - - Get a key usage guidlines. - - - - - Get the public key of the subject of the certificate. - - The public key parameters. - - - - Return the DER encoding of this certificate. - - A byte array containing the DER encoding of this certificate. - If there is an error encoding the certificate. - - - - Verify the certificate's signature using the nominated public key. - - An appropriate public key parameter object, RsaPublicKeyParameters, DsaPublicKeyParameters or ECDsaPublicKeyParameters - True if the signature is valid. - If key submitted is not of the above nominated types. - - - - Verify the certificate's signature using a verifier created using the passed in verifier provider. - - An appropriate provider for verifying the certificate's signature. - True if the signature is valid. - If verifier provider is not appropriate or the certificate algorithm is invalid. - - - - This class contains a cross certificate pair. Cross certificates pairs may - contain two cross signed certificates from two CAs. A certificate from the - other CA to this CA is contained in the forward certificate, the certificate - from this CA to the other CA is contained in the reverse certificate. - - - - Constructor - Certificate from the other CA to this CA. - Certificate from this CA to the other CA. - - - Constructor from a ASN.1 CertificatePair structure. - The CertificatePair ASN.1 object. - - - Returns the certificate from the other CA to this CA. - - - Returns the certificate from this CA to the other CA. - - - class for dealing with X509 certificates. -

    - At the moment this will deal with "-----BEGIN CERTIFICATE-----" to "-----END CERTIFICATE-----" - base 64 encoded certs, as well as the BER binaries of certificates and some classes of PKCS#7 - objects.

    -
    - - - Create loading data from byte array. - - - - - - Create loading data from byte array. - - - - - Generates a certificate object and initializes it with the data - read from the input stream inStream. - - - Returns a (possibly empty) collection view of the certificates - read from the given input stream inStream. - - - - Create loading data from byte array. - - - - - - Create loading data from byte array. - - - - - The following extensions are listed in RFC 2459 as relevant to CRLs - - Authority Key Identifier - Issuer Alternative Name - CRL Number - Delta CRL Indicator (critical) - Issuing Distribution Point (critical) - - - - Verify the CRL's signature using a verifier created using the passed in verifier provider. - - An appropriate provider for verifying the CRL's signature. - True if the signature is valid. - If verifier provider is not appropriate or the CRL algorithm is invalid. - - - - Return the DER encoding of this CRL. - - A byte array containing the DER encoding of this CRL. - If there is an error encoding the CRL. - - - Returns a string representation of this CRL. - - @return a string representation of this CRL. - - - Checks whether the given certificate is on this CRL. - - @param cert the certificate to check for. - @return true if the given certificate is on this CRL, - false otherwise. - - - The following extensions are listed in RFC 2459 as relevant to CRL Entries - - ReasonCode Hode Instruction Code Invalidity Date Certificate Issuer - (critical) - - - Constructor for CRLEntries of indirect CRLs. If isIndirect - is false {@link #getCertificateIssuer()} will always - return null, previousCertificateIssuer is - ignored. If this isIndirect is specified and this CrlEntry - has no certificate issuer CRL entry extension - previousCertificateIssuer is returned by - {@link #getCertificateIssuer()}. - - @param c - TbsCertificateList.CrlEntry object. - @param isIndirect - true if the corresponding CRL is a indirect - CRL. - @param previousCertificateIssuer - Certificate issuer of the previous CrlEntry. - - - - Create loading data from byte array. - - - - - - Create loading data from byte array. - - - - - Generates a certificate revocation list (CRL) object and initializes - it with the data read from the input stream inStream. - - - Returns a (possibly empty) collection view of the CRLs read from - the given input stream inStream. - - The inStream may contain a sequence of DER-encoded CRLs, or - a PKCS#7 CRL set. This is a PKCS#7 SignedData object, with the - only significant field being crls. In particular the signature - and the contents are ignored. - - - - Get non critical extensions. - - A set of non critical extension oids. - - - - Get any critical extensions. - - A sorted list of critical entension. - - - - Get the value of a given extension. - - The object ID of the extension. - An Asn1OctetString object if that extension is found or null if not. - - - A holding class for constructing an X509 Key Usage extension. - -
    -                id-ce-keyUsage OBJECT IDENTIFIER ::=  { id-ce 15 }
    -            
    -                KeyUsage ::= BIT STRING {
    -                     digitalSignature        (0),
    -                     nonRepudiation          (1),
    -                     keyEncipherment         (2),
    -                     dataEncipherment        (3),
    -                     keyAgreement            (4),
    -                     keyCertSign             (5),
    -                     cRLSign                 (6),
    -                     encipherOnly            (7),
    -                     decipherOnly            (8) }
    -             
    -
    - - Basic constructor. - - @param usage - the bitwise OR of the Key Usage flags giving the - allowed uses for the key. - e.g. (X509KeyUsage.keyEncipherment | X509KeyUsage.dataEncipherment) - - - Return the digest algorithm using one of the standard JCA string - representations rather than the algorithm identifier (if possible). - - - - Class to Generate X509V1 Certificates. - - - - - Default Constructor. - - - - - Reset the generator. - - - - - Set the certificate's serial number. - - Make serial numbers long, if you have no serial number policy make sure the number is at least 16 bytes of secure random data. - You will be surprised how ugly a serial number collision can get. - The serial number. - - - - Set the issuer distinguished name. - The issuer is the entity whose private key is used to sign the certificate. - - The issuers DN. - - - - Set the date that this certificate is to be valid from. - - - - - - Set the date after which this certificate will no longer be valid. - - - - - - Set the subject distinguished name. - The subject describes the entity associated with the public key. - - - - - - Set the public key that this certificate identifies. - - - - - - Set the signature algorithm that will be used to sign this certificate. - This can be either a name or an OID, names are treated as case insensitive. - - string representation of the algorithm name - - - - Generate a new X509Certificate. - - The private key of the issuer used to sign this certificate. - An X509Certificate. - - - - Generate a new X509Certificate specifying a SecureRandom instance that you would like to use. - - The private key of the issuer used to sign this certificate. - The Secure Random you want to use. - An X509Certificate. - - - - Generate a new X509Certificate using the passed in SignatureCalculator. - - A signature calculator factory with the necessary algorithm details. - An X509Certificate. - - - - Allows enumeration of the signature names supported by the generator. - - - - An implementation of a version 2 X.509 Attribute Certificate. - - - - Verify the certificate's signature using a verifier created using the passed in verifier provider. - - An appropriate provider for verifying the certificate's signature. - True if the signature is valid. - If verifier provider is not appropriate or the certificate algorithm is invalid. - - - Class to produce an X.509 Version 2 AttributeCertificate. - - - Reset the generator - - - Set the Holder of this Attribute Certificate. - - - Set the issuer. - - - Set the serial number for the certificate. - - - - Set the signature algorithm. This can be either a name or an OID, names - are treated as case insensitive. - - The algorithm name. - - - Add an attribute. - - - Add a given extension field for the standard extensions tag. - - - - Add a given extension field for the standard extensions tag. - The value parameter becomes the contents of the octet string associated - with the extension. - - - - - Generate an X509 certificate, based on the current issuer and subject. - - - - - Generate an X509 certificate, based on the current issuer and subject, - using the supplied source of randomness, if required. - - - - - Generate a new X.509 Attribute Certificate using the passed in SignatureCalculator. - - A signature calculator factory with the necessary algorithm details. - An IX509AttributeCertificate. - - - - Allows enumeration of the signature names supported by the generator. - - - - class to produce an X.509 Version 2 CRL. - - - reset the generator - - - Set the issuer distinguished name - the issuer is the entity whose private key is used to sign the - certificate. - - - Reason being as indicated by CrlReason, i.e. CrlReason.KeyCompromise - or 0 if CrlReason is not to be used - - - - Add a CRL entry with an Invalidity Date extension as well as a CrlReason extension. - Reason being as indicated by CrlReason, i.e. CrlReason.KeyCompromise - or 0 if CrlReason is not to be used - - - - Add a CRL entry with extensions. - - - - Add the CRLEntry objects contained in a previous CRL. - - @param other the X509Crl to source the other entries from. - - - - Set the signature algorithm that will be used to sign this CRL. - - - - - add a given extension field for the standard extensions tag (tag 0) - - - add a given extension field for the standard extensions tag (tag 0) - - - add a given extension field for the standard extensions tag (tag 0) - - - add a given extension field for the standard extensions tag (tag 0) - - - - Generate an X.509 CRL, based on the current issuer and subject. - - The private key of the issuer that is signing this certificate. - An X509Crl. - - - - Generate an X.509 CRL, based on the current issuer and subject using the specified secure random. - - The private key of the issuer that is signing this certificate. - Your Secure Random instance. - An X509Crl. - - - - Generate a new X509Crl using the passed in SignatureCalculator. - - A signature calculator factory with the necessary algorithm details. - An X509Crl. - - - - Allows enumeration of the signature names supported by the generator. - - - - - A class to Generate Version 3 X509Certificates. - - - - - Reset the Generator. - - - - - Set the certificate's serial number. - - Make serial numbers long, if you have no serial number policy make sure the number is at least 16 bytes of secure random data. - You will be surprised how ugly a serial number collision can Get. - The serial number. - - - - Set the distinguished name of the issuer. - The issuer is the entity which is signing the certificate. - - The issuer's DN. - - - - Set the date that this certificate is to be valid from. - - - - - - Set the date after which this certificate will no longer be valid. - - - - - - Set the DN of the entity that this certificate is about. - - - - - - Set the public key that this certificate identifies. - - - - - - Set the signature algorithm that will be used to sign this certificate. - - - - - - Set the subject unique ID - note: it is very rare that it is correct to do this. - - - - - - Set the issuer unique ID - note: it is very rare that it is correct to do this. - - - - - - Add a given extension field for the standard extensions tag (tag 3). - - string containing a dotted decimal Object Identifier. - Is it critical. - The value. - - - - Add an extension to this certificate. - - Its Object Identifier. - Is it critical. - The value. - - - - Add an extension using a string with a dotted decimal OID. - - string containing a dotted decimal Object Identifier. - Is it critical. - byte[] containing the value of this extension. - - - - Add an extension to this certificate. - - Its Object Identifier. - Is it critical. - byte[] containing the value of this extension. - - - - Add a given extension field for the standard extensions tag (tag 3), - copying the extension value from another certificate. - - - - add a given extension field for the standard extensions tag (tag 3) - copying the extension value from another certificate. - @throws CertificateParsingException if the extension cannot be extracted. - - - - Generate an X509Certificate. - - The private key of the issuer that is signing this certificate. - An X509Certificate. - - - - Generate an X509Certificate using your own SecureRandom. - - The private key of the issuer that is signing this certificate. - You Secure Random instance. - An X509Certificate. - - - - Generate a new X509Certificate using the passed in SignatureCalculator. - - A signature calculator factory with the necessary algorithm details. - An X509Certificate. - - - - Allows enumeration of the signature names supported by the generator. - - - - Base class for both the compress and decompress classes. - Holds common arrays, and static data. - - @author
    Keiron Liddle - - - An input stream that decompresses from the BZip2 format (with the file - header chars) to be read as any other stream. - - @author Keiron Liddle - - NB: note this class has been modified to read the leading BZ from the - start of the BZIP2 stream to make it compatible with other PGP programs. - - - An output stream that compresses into the BZip2 format (with the file - header chars) into another stream. - - @author Keiron Liddle - - TODO: Update to BZip2 1.0.1 - NB: note this class has been modified to add a leading BZ to the - start of the BZIP2 stream to make it compatible with other PGP programs. - - - - modified by Oliver Merkel, 010128 - - - - A simple class the hold and calculate the CRC for sanity checking - of the data. - - @author Keiron Liddle - - - - Return a salted hash based on PBKDF2 for the UTF-8 encoding of the argument text. - - Provided key text - Base64 encoded string representing the salt - - -
    -
    diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DataGravity.CSharp.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DataGravity.CSharp.dll deleted file mode 100644 index 23eb9a4..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DataGravity.CSharp.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DataHub.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DataHub.dll deleted file mode 100644 index fb65f04..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DataHub.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DataHub.dll.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/DataHub.dll.config deleted file mode 100644 index 172d3b8..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/DataHub.dll.config +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Charts.v23.1.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Charts.v23.1.Core.dll deleted file mode 100644 index 8bc46f6..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Charts.v23.1.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Charts.v23.2.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Charts.v23.2.Core.dll deleted file mode 100644 index 9d22845..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Charts.v23.2.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Data.Desktop.v23.1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Data.Desktop.v23.1.dll deleted file mode 100644 index 6101de2..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Data.Desktop.v23.1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Data.Desktop.v23.2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Data.Desktop.v23.2.dll deleted file mode 100644 index 7ab2f8d..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Data.Desktop.v23.2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Data.v23.1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Data.v23.1.dll deleted file mode 100644 index 4ff992b..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Data.v23.1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Data.v23.2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Data.v23.2.dll deleted file mode 100644 index 26c3d88..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Data.v23.2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.DataVisualization.v23.1.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.DataVisualization.v23.1.Core.dll deleted file mode 100644 index 7c21f66..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.DataVisualization.v23.1.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.DataVisualization.v23.2.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.DataVisualization.v23.2.Core.dll deleted file mode 100644 index 717f195..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.DataVisualization.v23.2.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Diagram.v23.1.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Diagram.v23.1.Core.dll deleted file mode 100644 index 24fcde8..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Diagram.v23.1.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Diagram.v23.2.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Diagram.v23.2.Core.dll deleted file mode 100644 index f1cbac6..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Diagram.v23.2.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Drawing.v23.1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Drawing.v23.1.dll deleted file mode 100644 index f79caad..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Drawing.v23.1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Drawing.v23.2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Drawing.v23.2.dll deleted file mode 100644 index 1c1700e..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Drawing.v23.2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Images.v23.1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Images.v23.1.dll deleted file mode 100644 index d91e175..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Images.v23.1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Images.v23.2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Images.v23.2.dll deleted file mode 100644 index 7e5c7af..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Images.v23.2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Mvvm.v23.1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Mvvm.v23.1.dll deleted file mode 100644 index c07d703..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Mvvm.v23.1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Mvvm.v23.2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Mvvm.v23.2.dll deleted file mode 100644 index cefe8ca..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Mvvm.v23.2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Office.v23.1.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Office.v23.1.Core.dll deleted file mode 100644 index ae8b9e9..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Office.v23.1.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Office.v23.2.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Office.v23.2.Core.dll deleted file mode 100644 index 8a42609..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Office.v23.2.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Pdf.v23.1.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Pdf.v23.1.Core.dll deleted file mode 100644 index bd0953a..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Pdf.v23.1.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Pdf.v23.1.Drawing.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Pdf.v23.1.Drawing.dll deleted file mode 100644 index 87f0c65..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Pdf.v23.1.Drawing.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Pdf.v23.2.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Pdf.v23.2.Core.dll deleted file mode 100644 index f9b4a8f..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Pdf.v23.2.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Pdf.v23.2.Drawing.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Pdf.v23.2.Drawing.dll deleted file mode 100644 index 86a6f78..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Pdf.v23.2.Drawing.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Printing.v23.1.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Printing.v23.1.Core.dll deleted file mode 100644 index 52d1ff0..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Printing.v23.1.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Printing.v23.2.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Printing.v23.2.Core.dll deleted file mode 100644 index 1895d8f..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Printing.v23.2.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.RichEdit.v23.1.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.RichEdit.v23.1.Core.dll deleted file mode 100644 index 7c92432..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.RichEdit.v23.1.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.RichEdit.v23.2.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.RichEdit.v23.2.Core.dll deleted file mode 100644 index 4772968..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.RichEdit.v23.2.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Charts.v23.1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Charts.v23.1.dll deleted file mode 100644 index 51d6188..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Charts.v23.1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Charts.v23.2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Charts.v23.2.dll deleted file mode 100644 index 0d04198..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Charts.v23.2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Core.v23.1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Core.v23.1.dll deleted file mode 100644 index 4db0111..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Core.v23.1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Core.v23.2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Core.v23.2.dll deleted file mode 100644 index dcee05e..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Core.v23.2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Diagram.v23.1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Diagram.v23.1.dll deleted file mode 100644 index cc05f4b..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Diagram.v23.1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Diagram.v23.2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Diagram.v23.2.dll deleted file mode 100644 index 029366b..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Diagram.v23.2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Docking.v23.1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Docking.v23.1.dll deleted file mode 100644 index 016e1d6..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Docking.v23.1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Docking.v23.2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Docking.v23.2.dll deleted file mode 100644 index f05e8ea..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Docking.v23.2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.DocumentViewer.v23.1.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.DocumentViewer.v23.1.Core.dll deleted file mode 100644 index f3512d9..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.DocumentViewer.v23.1.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.DocumentViewer.v23.2.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.DocumentViewer.v23.2.Core.dll deleted file mode 100644 index 0b46b8b..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.DocumentViewer.v23.2.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Grid.v23.1.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Grid.v23.1.Core.dll deleted file mode 100644 index 7e8d15c..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Grid.v23.1.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Grid.v23.1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Grid.v23.1.dll deleted file mode 100644 index 6d7b56c..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Grid.v23.1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Grid.v23.2.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Grid.v23.2.Core.dll deleted file mode 100644 index 91f727e..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Grid.v23.2.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Grid.v23.2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Grid.v23.2.dll deleted file mode 100644 index 81f7eb2..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Grid.v23.2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Layout.v23.1.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Layout.v23.1.Core.dll deleted file mode 100644 index d836bf8..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Layout.v23.1.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Layout.v23.2.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Layout.v23.2.Core.dll deleted file mode 100644 index d42dd9d..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Layout.v23.2.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.LayoutControl.v23.1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.LayoutControl.v23.1.dll deleted file mode 100644 index 07dcc12..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.LayoutControl.v23.1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.LayoutControl.v23.2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.LayoutControl.v23.2.dll deleted file mode 100644 index 946fc3a..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.LayoutControl.v23.2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Printing.v23.1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Printing.v23.1.dll deleted file mode 100644 index a5e9456..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Printing.v23.1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Printing.v23.2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Printing.v23.2.dll deleted file mode 100644 index 8416404..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Printing.v23.2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.PropertyGrid.v23.1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.PropertyGrid.v23.1.dll deleted file mode 100644 index 93dd9d3..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.PropertyGrid.v23.1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.PropertyGrid.v23.2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.PropertyGrid.v23.2.dll deleted file mode 100644 index b3c9ef9..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.PropertyGrid.v23.2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Ribbon.v23.1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Ribbon.v23.1.dll deleted file mode 100644 index f1681e4..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Ribbon.v23.1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Ribbon.v23.2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Ribbon.v23.2.dll deleted file mode 100644 index 0aca4ef..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Ribbon.v23.2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Themes.Office2019Colorful.v23.1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Themes.Office2019Colorful.v23.1.dll deleted file mode 100644 index 5479c35..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Themes.Office2019Colorful.v23.1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Themes.Office2019Colorful.v23.2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Themes.Office2019Colorful.v23.2.dll deleted file mode 100644 index 5127c33..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Themes.Office2019Colorful.v23.2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Themes.VS2019Dark.v23.1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Themes.VS2019Dark.v23.1.dll deleted file mode 100644 index c2b0b7d..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Themes.VS2019Dark.v23.1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Themes.VS2019Dark.v23.2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Themes.VS2019Dark.v23.2.dll deleted file mode 100644 index 4cf6b8b..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.Themes.VS2019Dark.v23.2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.ThemesLW.v23.2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.ThemesLW.v23.2.dll deleted file mode 100644 index 07becbd..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DevExpress.Xpf.ThemesLW.v23.2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/DnsClient.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/DnsClient.dll deleted file mode 100644 index 323f3e4..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/DnsClient.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/EGrabber.NETFramework.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/EGrabber.NETFramework.dll deleted file mode 100644 index 6607ce3..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/EGrabber.NETFramework.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/EGrabber.NETFramework.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/EGrabber.NETFramework.xml deleted file mode 100644 index b5f13a3..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/EGrabber.NETFramework.xml +++ /dev/null @@ -1,7433 +0,0 @@ - - - - EGrabber.NETFramework - - - - - Helper functions to build Euresys GenApi actions - - - - - Create an action to declare a virtual user feature of type Integer on a GenApi Module - - - - Example: create a virtual user feature size of type Integer on the Device module - - grabber.Device.Set(Action.DeclareInteger, "size"); - grabber.Device.Set("$size", 1024); - grabber.RunScript(pathToScriptUsingTheUserFeaturesize); - long size = grabber.Device.Get<long>("$size"); - - - A declared virtual user feature is used as a GenApi feature by prefixing its name with a dollar sign ($) - - See also - - - - - - - - - - - Create an action to declare a virtual user feature of type Float on a GenApi Module - - - See also - - - - - - - - - - Create an action to declare a virtual user feature of type String on a GenApi Module - - - See also - - - - - - - - - - Create an action to undeclare (delete) a virtual user feature on a GenApi Module - - - - Example: delete a virtual user feature size on the Device module - - grabber.Device.Set(Action.Undeclare, "size"); - - - See also - - - - - - - - - - Buffer object encapsulating a GenTL buffer - - - - - Create a Buffer object encapsulating the next delivered GenTL buffer - - The grabber managing the underlying GenTL buffer - Timeout value - - If there is no new buffer event when called, the method waits for at most the specified - - Either the timeout expires and a is thrown - Or GenTL buffer is delivered and a Buffer object is created - - - - - - Create a Buffer object encapsulating the next delivered GenTL buffer - - The grabber managing the underlying GenTL buffer - Timeout value in milliseconds - - If there is no new buffer event when called, the method waits for at most the specified - - Either the timeout expires and a is thrown - Or GenTL buffer is delivered and a Buffer object is created - - - - - - Create a Buffer object encapsulating the GenTL buffer specified in a - - The grabber managing the underlying GenTL buffer - New buffer data - - A new buffer data can be obtained from - - - - The argument of a callback registered with , where T is - - - - - - - Release the resources associated with the object - - - - - Push the GenTL buffer back to the data stream input fifo - - - - - Convert a buffer - - Output pixel format - Convert output configuration - Convert output operation - Quality for jpeg format, from 1 (lowest) to 100 (highest), 0 selects the default encoder quality value - Converted buffer - - - - Convert a buffer to a specified output buffer - - Output pixel format - Output buffer pointer - Output buffer size - Convert output configuration - Convert output operation - Quality for jpeg format, from 1 (lowest) to 100 (highest), 0 selects the default encoder quality value - Converted data size - - - - Convert a buffer - - Output pixel format - Convert output configuration - Convert output operation - Quality for jpeg format, from 1 (lowest) to 100 (highest), 0 selects the default encoder quality value - Region of interest to be converted - Converted buffer - - - - Convert a buffer to a specified output buffer - - Output pixel format - Output buffer pointer - Output buffer size - Convert output configuration - Convert output operation - Quality for jpeg format, from 1 (lowest) to 100 (highest), 0 selects the default encoder quality value - Region of interest to be converted - Converted data size - - - - Save the buffer content to disk - - - Path to the file or path pattern - - path of the new image file, the file extension determines the file format - - path pattern where a group of characters N is replaced by the value of index: - - if index is 5, N becomes 5 - if index is 9, NN becomes 09 - if index is 10, NN becomes 10 - - - - - - Control pattern substitution - - if index >= 0, enable pattern substitution with given index value - if index < 0, disable pattern substitution - - - - Notes: - - The parent directory must exist - Buffer information (address, width, height, format) are automatically queried - No buffer conversion will be applied before writing the image file, please use Buffer.Convert[To] if needed - - - - - - Save the buffer content to disk - - - Path to the file or path pattern - - path of the new image file, the file extension determines the file format - - path pattern where a group of characters N is replaced by the value of index: - - if index is 5, N becomes 5 - if index is 9, NN becomes 09 - if index is 10, NN becomes 10 - - - - - - Control pattern substitution - - if index >= 0, enable pattern substitution with given index value - if index < 0, disable pattern substitution - - - Image saving parameters - - Notes: - - The parent directory must exist - Buffer information (address, width, height, format) are automatically queried - No buffer conversion will be applied before writing the image file, please use Buffer.Convert[To] if needed - - - - - - Get buffer information - - Type of the return value - Buffer info command - Buffer information - - - - - - Please note that - - and are closely related - Wrong combinations of and will lead to or exceptions - Using an unsupported type will throw an - - - - - - Get useful buffer information - - Buffer information - - - - Get the user object provided when the GenTL buffer was announced (if any) - - - - - Get the base address of the buffer memory (cf. ) - - - - - Converted buffer returned by Buffer.Convert - - - - - Release the resources associated with the object - - - - - Finalize method releasing unmanaged resources - - - - - Convert a buffer - - Output pixel format - Convert output configuration - Convert output operation - Quality for jpeg format, from 1 (lowest) to 100 (highest), 0 selects the default encoder quality value - Converted buffer - - - - Convert a buffer to a specified output buffer - - Output pixel format - Output buffer pointer - Output buffer size - Convert output configuration - Convert output operation - Quality for jpeg format, from 1 (lowest) to 100 (highest), 0 selects the default encoder quality value - Converted data size - - - - Convert a buffer - - Output pixel format - Convert output configuration - Convert output operation - Quality for jpeg format, from 1 (lowest) to 100 (highest), 0 selects the default encoder quality value - Region of interest to be converted - Converted buffer - - - - Convert a buffer to a specified output buffer - - Output pixel format - Output buffer pointer - Output buffer size - Convert output configuration - Convert output operation - Quality for jpeg format, from 1 (lowest) to 100 (highest), 0 selects the default encoder quality value - Region of interest to be converted - Converted data size - - - - Save the buffer content to disk - - - Path to the file or path pattern - - path of the new image file, the file extension determines the file format - - path pattern where a group of characters N is replaced by the value of index: - - if index is 5, N becomes 5 - if index is 9, NN becomes 09 - if index is 10, NN becomes 10 - - - - - - Control pattern substitution - - if index >= 0, enable pattern substitution with given index value - if index < 0, disable pattern substitution - - - - Notes: - - The parent directory must exist - Buffer information (address, width, height, format) are automatically queried - - - - - - Save the buffer content to disk - - - Path to the file or path pattern - - path of the new image file, the file extension determines the file format - - path pattern where a group of characters N is replaced by the value of index: - - if index is 5, N becomes 5 - if index is 9, NN becomes 09 - if index is 10, NN becomes 10 - - - - - - Control pattern substitution - - if index >= 0, enable pattern substitution with given index value - if index < 0, disable pattern substitution - - - Image saving parameters - - Notes: - - The parent directory must exist - Buffer information (address, width, height, format) are automatically queried - - - - - - Get useful buffer information - - Buffer information - - - - Size of the buffer in bytes - - - - - Image width in pixels - - - - - Image height in pixels - - - - - Line pitch in bytes - - - - - Buffer address - - - - - Buffer pixel format - - - - - Range of buffer indexes returned by the EGrabber methods announcing buffers - - - - - Create an empty range of buffer indexes - - - - - Create a range of buffer indexes - - Index of the first buffer in range - Index of the end of the range, the end is not included in the range - Flag is true to indicate buffers have been (or will be) queued in the reverse order - - - - Create a range of buffer indexes - - Index of the first buffer in range - Index of the end of the range, the end is not included in the range - - - - Create a range of buffer indexes - - Range to clone - - - - Convert a Zero-based index in the range to an absolute buffer index - - Zero-based index of a buffer in the range - Absolute buffer index - - - - Size of the range (count) - - - - - Index of the first buffer of the range - - - - - Index of the end of the range, the end is not included in the range - - - - - Flag is true if the buffers have been (or will be) queued in the reverse order - - - - - Release the resources associated with the object - - - - - Useful buffer information - - - - - Base address of the buffer memory - - - - - Size of the buffer in bytes - - - - - Line pitch - - - - - Width of the data in the buffer in number of pixels - - - - - Number of delivered lines in the buffer - - - - - Pixelformat of the data - - - - - Number of bits per pixel - - - - - collection enumerator - - - - - Build an enumerator for the collection - - Strongly typed enumerator - - - - Build an enumerator for the collection - - Non-generic enumerator - Non-generic version of - - - - CIC event data - - - - In order to get CIC events, the CIC event data type needs to be enabled by calling with the event type - CIC event data can be received as event callback argument or using - - - - - - Event timestamp - - - - - Custom event data identifier - - - - - Value of EventNotificationContext1 for this event (latched at the time the event occurred) - - - - - Value of EventNotificationContext2 for this event (latched at the time the event occurred) - - - - - Value of EventNotificationContext3 for this event (latched at the time the event occurred) - - - - - Helpers to get the paths of different producers (CTI) - - - - - Return the path of the Coaxlink producer - - - - Example: initialize a GenTL instance with the Coaxlink producer - - var gentl = new EGenTL(CtiPath.Coaxlink); - - - See also - - - - - Return the path of the Grablink producer - - - - Example: initialize a GenTL instance with the Grablink producer - - var gentl = new EGenTL(CtiPath.Grablink); - - - See also - - - - - Return the path of the Gigelink producer - - - - Example: initialize a GenTL instance with the Gigelink producer - - var gentl = new EGenTL(CtiPath.Gigelink); - - - See also - - - - - Return the path of the default producer - - - - The default producer is derived from the environment variable EURESYS_DEFAULT_GENTL_PRODUCER - See also - - - - - - CoaXPress device event data - - - - In order to get CoaXPress device events, the CoaXPress device event data type needs to be enabled by calling with the event type - CoaXPress device event data can be received as event callback argument or using - - - - - - Event timestamp - - - - - Custom event data identifier - - - - - Value of EventNotificationContext1 for this event (latched at the time the event occurred) - - - - - Value of EventNotificationContext2 for this event (latched at the time the event occurred) - - - - - Value of EventNotificationContext3 for this event (latched at the time the event occurred) - - - - - CoaXPress event data on the Interface module - - - - In order to get CoaXPress events of the Interface module, the CoaXPress event data type needs to be enabled by calling with the event type - CoaXPress event data can be received as event callback argument or using - - - - - Event timestamp - - - - - Custom event data identifier - - - - - Value of EventNotificationContext1 for this event (latched at the time the event occurred) - - - - - Value of EventNotificationContext2 for this event (latched at the time the event occurred) - - - - - Value of EventNotificationContext3 for this event (latched at the time the event occurred) - - - - - Data stream event data - - - - In order to get data stream events, the data stream event data type needs to be enabled by calling with the event type - Data stream event data can be received as event callback argument or using - - - - - - Event timestamp - - - - - Custom event data identifier - - - - - Value of EventNotificationContext1 for this event (latched at the time the event occurred) - - - - - Value of EventNotificationContext2 for this event (latched at the time the event occurred) - - - - - Value of EventNotificationContext3 for this event (latched at the time the event occurred) - - - - - Device error event data - - - - In order to get device error events, the device error event data type needs to be enabled by calling with the event type - Device error event data can be received as event callback argument or using - - - - - - Event timestamp - - - - - Custom event data identifier - - - - - Value of EventNotificationContext1 for this event (latched at the time the event occurred) - - - - - Value of EventNotificationContext2 for this event (latched at the time the event occurred) - - - - - Value of EventNotificationContext3 for this event (latched at the time the event occurred) - - - - - Diagnostic utilities - - - - - Check that all boxes have been correctly released - - When there are unreleased boxes - - - - An EGenTL object is a wrapper around EGenTL C++ API - - - - - Create an EGenTL object and initialize the EGenTL library - - - The default producer is used - - - - - Create an EGenTL object and initialize the EGenTL library - - Path of the producer to use - - See also - - - - - Return the number of bytes per pixel for the specified pixel format - - Pixel format (PFNC 32-bit or 16-bit namespaces) - Size in bytes - - - - Return the number of bytes per pixel for the specified pixel format - - Pixel format numerical value (PFNC 32-bit or 16-bit namespaces) - Size in bytes - - - - Return the number of bits per pixel for the specified pixel format - - Pixel format (PFNC 32-bit or 16-bit namespaces) - Size in bits - - - - Return the number of bits per pixel for the specified pixel format - - Pixel format numerical value (PFNC 32-bit or 16-bit namespaces) - Size in bits - - - - Convert a pixel format numerical value into the pixel format name - - Pixel format numerical value (PFNC 32-bit or 16-bit namespaces) - Pixel format name - - - - Preallocate buffers in the pool to improve conversion performance - - The size of the buffers to preallocate in the converter pool - The number of buffers to preallocate - - - This function improves the performance of subsequent image conversions that need one or more buffers of size - Warning: a conversion requiring a buffer of a different size (for which there is no preallocated or unused buffer in the pool) - will automatically allocate a new buffer prior to applying the conversion - - - - - - Reclaim unused buffers managed by the converter to free memory - - - - - Get System module information - - Type of the return value - TL info command - TL information - - - - - - Please note that - - and are closely related - Wrong combinations of and will lead to or exceptions - Using an unsupported type will throw an - - - - - - Convert a pixel format name into the PFNC 32-bit numerical value - - Pixel format (PFNC 32-bit or 16-bit namespaces) - Pixel format numerical value - - - - Convert an image - - Input image details - Output image details - - - - Convert a region of interest - - Input image details - Output image details - Region of interest - - - - Save an image to disk - - Input image details - - Path to file or path pattern - - path of the new image file, the file extension determines the file format - - path pattern where a group characters N is replaced by the value of index: - - if index is 5, N becomes 5 - if index is 9, NN becomes 09 - if index is 10, NN becomes 10 - - - - - - Control pattern substitution - - if index >= 0, enable pattern substitution with given index value - if index < 0, disable pattern substitution - - - - Note: the parent directory must exist - - - - - Save an image to disk - - Input image details - - Path to file or path pattern - - path of the new image file, the file extension determines the file format - - path pattern where a group characters N is replaced by the value of index: - - if index is 5, N becomes 5 - if index is 9, NN becomes 09 - if index is 10, NN becomes 10 - - - - - - Control pattern substitution - - if index >= 0, enable pattern substitution with given index value - if index < 0, disable pattern substitution - - - Image saving parameters - - Note: the parent directory must exist - - - - - Release the resources associated with the object - - - - - Region of interest (ROI) details for image conversion (optional) - - - - - Width of ROI in pixels (default=0 selects buffer parameter width) - - - - - Height of ROI in pixels (default=0 selects buffer parameter height) - - - - - X offset (in pixels) in the input buffer - - - - - Y offset (in pixels) in the input buffer - - - - - X offset (in pixels) in the output buffer - - - - - Y offset (in pixels) in the output buffer - - - - - Image Save to Disk parameters (optional) - - - - - Convert configuration - - - - - Quality for jpeg format, from 1 (lowest) to 100 (highest), 0 selects the default encoder quality value - - - - - An EGrabber object encapsulates a set of related GenTL modules - (an interface, a device, a data stream, a remote device, and a number of buffers) - - An InterfaceModule that represents global (shared) frame - grabber settings and features. This includes digital I/O control, PCIe and firmware status... - A DeviceModule (or local device, as opposed to remote device) that contains the frame grabber settings and features relating to the camera - This consists mainly of camera and illumination control features: strobes, triggers... - StreamModule that handles image buffers - A RemoteModule that is the CoaXPress camera - A number of buffers - - - - Note: EGrabber is only available as CallbackOnDemand model - - - - - Create an EGrabber object from GenTL module indexes - - Create a grabber from GenTL module indexes - Index of the InterfaceModule to use - Index of the DeviceModule to use - Index of the StreamModule to use - How the device is to be opened - Whether the remote device is required to create the grabber - - Note: the created EGrabber object is based on the CallbackOnDemand model - - - - - Create an EGrabber object from a discovered grabber - - Create a grabber from a discovered grabber (see ) - How the device is to be opened - Whether the remote device is required to create the grabber - - Example: create a grabber using the discovery - - - var gentl = new EGenTL(); - var discovery = new EGrabberDiscovery(gentl) - discovery.Discover(); - var grabber = new EGrabber(discovery.EGrabbers[0]); - - - Note: the created EGrabber object is based on the CallbackOnDemand model - - - - - Create an EGrabber object from a discovered camera - - Create a grabber from a discovered camera - How the device is to be opened - - Example: create a grabber using the discovery - - - var gentl = new EGenTL(); - var discovery = new EGrabberDiscovery(gentl) - discovery.Discover(); - var grabber = new EGrabber(discovery.Cameras[0]); - - - Note: the created EGrabber object is based on the CallbackOnDemand model - - - - - Finalize method releasing unmanaged resources - - - - - Return a string that represents the current grabber - - A string that represents the current grabber - - - - Shutdown the grabber and release the associated resources - - - - - Reallocate the buffers - - - Performs the following operations: - - revoke current buffers, if any - allocate buffers (if is zero, the size is determined automatically) - announce the new buffers to the data stream - queue the new buffers to the data stream input fifo - - - Number of buffers to allocate - Size of a buffer; when 0, the size is determined automatically - Range of announced buffer indexes - - - - Announce and queue a memory buffer object - - Object describing the memory buffer to announce and queue - Range of announced buffer indexes - - The object can be one of the following types: - - (memory allocated by the GenTL producer) - (memory allocated by the user) - (UserMemory split into an array of contiguous buffers) - (bus addressable memory) - (NVIDIA Device memory) - - - - - - Allocate, announce and queue one or more buffer objects - - Object describing the memory buffer to allocate, announce and queue - Number of buffers to allocate, announce and queue - Range of announced buffer indexes - - - - Announce and queue (in a reverse order) an array of contiguous buffer objects defined by a - - Object describing the memory array to announce and queue - Announce and queue the buffers in reverse (true) order or not (false) - Range of announced buffer indexes - - - - Move buffers from/to specific data stream buffer queues - - Flush operation - - - - Reset and queue a range of announced buffers - - - Performs the following operations: - - discard pending buffers (if any) - queue the buffers of the given range to the data stream input fifo - - Note: the data stream must be idle when calling this method - - Range of buffer indexes to queue to the data stream input fifo - When null, all the buffers are queued to the data stream input fifo in the initial order - (i.e. the order in which they were announced with ReallocBuffers or AnnounceAndQueue) - - - - - Queue a range of announced buffers - - Range of buffer indexes to queue - - - - Revoke a range of announced buffers - - - Note: Revoke does not invalidate other buffer indexes - - Range of buffer indexes to revoke - - - - Start acquisitions - - - Start performs the following operations: - - start the data stream for buffers - if is true, start the remote device by executing AcquisitionStart - for Coaxlink and Grablink Duo, start the Camera and Illumination Controller by executing ActivateCic - - Notes: - - The data stream must be idle when calling this function - When buffers have been filled, the data stream - automatically goes idle, but the remote device is not stopped - If is true, AcquisitionStop will be - executed in a subsequent call to Stop (or ultimately by ) - By default NewBufferData event will be enabled, unless explicitly disabled beforehand - - - The number of buffers to fill - Defines whether or not to start and stop the remote device by - automatically executing AcquisitionStart and AcquisitionStop commands - - - - - Stop acquisitions - - - Stop performs the following operations: - - for Coaxlink and Grablink Duo, stop the Camera and Illumination Controller by executing DeactivateCic - stop the remote device (unless Start was called with controlRemoteDevice = false - stop the data stream - - This function will block until the data stream is idle - - - - - Get the width (in pixels) of images produced by the grabber - - - - - Get the height (in lines) of images produced by the grabber - - - - - Get the payload size of images produced by the grabber - - - - - Get the pixel format of images produced by the grabber - - - Both the camera and the data stream influence this - - - - - Get information of buffer at index - - Type of the return value - Index of the buffer to query (cf. ) - Buffer info command - Buffer information - - - - - - Please note that - - and are closely related - Wrong combinations of and will lead to or exceptions - Using an unsupported type will throw an - - - - - - Get handle details of buffer at index - - Index of the buffer to query (cf. ) - New buffer data exposing both data stream and buffer handles - - - - Run a Euresys GenApi script - - Euresys GenApi script to run - This can be either a location (path) or some actual script statements - - - Interactions with the script are possible via the user interface callback - - - - - Interrupt the execution of a running Euresys GenApi script - - Identifier of the script to interrupt. It is returned by the user - interface callback with operation "scriptid" and parameter name "id" - - - Please note that this function cannot be called from the user interface callback - - - - - Output text to Memento with specified verbosity and user kind - - String to output - - One of the following values: - - - - - - - - - - - User kind identifier, from 0 to 15 - - 0 to output trace under the Kind "User0" - 1 to output trace under the Kind "User1" - ... - 10 (0xA) to output trace under the Kind "UserA" - 11 (0xB) to output trace under the Kind "UserB" - 12 (0xC) to output trace under the Kind "UserC" - 13 (0xD) to output trace under the Kind "UserD" - 14 (0xE) to output trace under the Kind "UserE" - 15 (0xF) to output trace under the Kind "UserF" - - - - - - Inject a user analyzer event UP into the memento logging system - - - - UP has a "+1" semantic on the user wave form of the analyzer event specified by id - The id values from 0 to 15 are mapped onto "UserWave0" to "UserWaveF" - - The display name of these 15 user analyzer events can be changed in the Analyzer Configurator - panel of the Memento application using the Alias property found in the Advanced tab of - the Analyzer Configurator panel - - User analyzer event identifier, from 0 to 15, mapped onto "UserWave0" to "UserWaveF" - User kind identifier, from 0 to 15, mapped onto "User0" to "UserF" - - - - Inject a user analyzer event DOWN into the memento logging system - - - - DOWN has a "-1" semantic on the user wave form of the analyzer event specified by id - The id values from 0 to 15 are mapped onto "UserWave0" to "UserWaveF" - - The display name of these 15 user analyzer events can be changed in the Analyzer Configurator - panel of the Memento application using the Alias property found in the Advanced tab of - the Analyzer Configurator panel - - User analyzer event identifier, from 0 to 15, mapped onto "UserWave0" to "UserWaveF" - User kind identifier, from 0 to 15, mapped onto "User0" to "UserF" - - - - Inject a user analyzer event RESET into the memento logging system - - - - RESET has a "reset to 0" semantic on the user wave form of the analyzer event specified by id - The id values from 0 to 15 are mapped onto "UserWave0" to "UserWaveF" - - The display name of these 15 user analyzer events can be changed in the Analyzer Configurator - panel of the Memento application using the Alias property found in the Advanced tab of - the Analyzer Configurator panel - - User analyzer event identifier, from 0 to 15, mapped onto "UserWave0" to "UserWaveF" - User kind identifier, from 0 to 15, mapped onto "User0" to "UserF" - - - - Inject a user analyzer event VALUE into the memento logging system - - - - VALUE has a "set to value" semantic on the user wave form of the analyzer event specified by id - The id values from 0 to 15 are mapped onto "UserWave0" to "UserWaveF" - - The display name of these 15 user analyzer events can be changed in the Analyzer Configurator - panel of the Memento application using the Alias property found in the Advanced tab of - the Analyzer Configurator panel - - User analyzer event identifier, from 0 to 15, mapped onto "UserWave0" to "UserWaveF" - Value of the analyzer event - User kind identifier, from 0 to 15, mapped onto "User0" to "UserF" - - - - Inject a user analyzer event NOVALUE into the memento logging system - - - - NOVALUE has a "disable value" semantic on the user wave form of the analyzer event specified by id - The id values from 0 to 15 are mapped onto "UserWave0" to "UserWaveF" - - The display name of these 15 user analyzer events can be changed in the Analyzer Configurator - panel of the Memento application using the Alias property found in the Advanced tab of - the Analyzer Configurator panel - - User analyzer event identifier, from 0 to 15, mapped onto "UserWave0" to "UserWaveF" - User kind identifier, from 0 to 15, mapped onto "User0" to "UserF" - - - - Wait for a new buffer and return a NewBufferData object (to be given to or ) - - Timeout in milliseconds - New buffer data - - If no new buffer event is available before the timeout expires, a (GC_ERR_TIMEOUT>) exception is thrown - - - - - Cancel a waiting pop - - - - Any waiting pop will be aborted by throwing a (GC_ERR_ABORT) exception - CancelPop is equivalent to CancelEvent(EventType.NewBufferData) - - - - - - Enable event handling for the specified events - - Event(s) to enable - - - - Disable event handling for the specified events - - Event(s) to disable - - - - Flush the event queue for the specified events - - Event(s) to flush - - - - Wait for at most an event and invoke its corresponding event callback - - Event type(s) to wait for and deliver via a callback - Timeout in milliseconds - Number of pending events (in the event queues identified by ) - - If no event is available before the timeout expires, a (GC_ERR_TIMEOUT>) exception is thrown - - - - - Process events asynchronously (by calling repeatedly ProcessEvent in a dedicated task) - - Event type(s) to process - Cancellation token to stop the event processing task - Work item - - - Example: to cancel the task - - var task = grabber.ProcessEventsAsync(EventType.All, tokenSource.Token); - ... - // stop the task - tokenSource.Cancel(); - task.Wait(); - - - - - - - Cancel any waiting function on some event types - - Event type(s) to cancel - - Waiting functions are for example - - - - - - Some or constructors - - - - - - Get the number of pending events in the different queues - - Event type(s) to query - The number of pending events in the different queues identified by - - - - Register a callback for the specified event type - - Type of event - Method to invoke or null to unregister any previously registered method - - Supported event types are: - - - - - - - - - - - Using an unsupported event type will throw an - - - - - Return result of PopOneOf - - - - - Event data - - - Can be one of the following objects: - - - - - - - - - - - - - - - Number of pending events in the requested event type(s) - - - - - Return the oldest event from a series of requested events as well as the number of pending events - - Type of event(s) to request - Timeout in milliseconds - Event data and the number of pending events of the requested type(s) - - Notes: - - Requested events must be enabled - If no new buffer event is available before the timeout expires, a (GC_ERR_TIMEOUT>) exception is thrown - - - - - - Grabber index of the last event received on the current thread - - - - - Get an indication about the need to reconfigure internal resources like the DMA - - - In this case the already announced buffers need to be revoked and announced again - otherwise some changes in the stream configuration like StripeArrangement - would not be taken into account - - - - - Get an indication about the need to reallocate buffers because the payload size or the alignment changed - - - In this case the already announced buffers need to be revoked and reallocated - - - - - Access the GenICam interface of a specific underlying grabber - - - This is useful when the EGrabber instance is managing a camera - composed by several remote devices and a remote device needs - to be queried or configured independently - - - An object that needs to be indexed (by the index of an underlying grabber) - to get access to an instance wrapping the requested grabber - - - - - The EGenTL instance of the grabber object - - - - - The system module associated with the grabber (if any) - - - - - The stream module associated with the grabber (if any) - - - - - The device module associated with the grabber (if any) - - - - - The remote module associated with the grabber (if any) - - - - - The interface module associated with the grabber (if any) - - - - - Type of events - - - - - New buffer event - - - - - IO toolbox event - - - - - CIC event - - - - - Data stream event - - - - - CoaXPress interface event - - - - - Device error event - - - - - CoaXPress device event - - - - - Remote device event - - - - - All available events - - - - - Any of the available events - - - - - Discovered camera information (cf. ) - - - Results of the , can be passed to to create a grabber object - - - - - Create an enumerator - - - - - Return the number of underlying grabbers composing this camera - - - - - Indexer accessing the of an underlying grabber composing this camera - - Zero-based grabber index - Grabber information - - - - Release the resources associated with the object - - - - - Euresys EGrabber and camera discovery - - - Discover available grabbers and cameras in the system - - - - - Create an EGrabberDiscovery object - - EGenTL instance - - Please note that it's not recommended to create more than one EGrabberDiscovery - object for the same system (EGenTL object) - - - - - Perform the discovery - - Enable or disable the camera-oriented discovery in addition to the grabber-oriented discovery - (default is true) - - - The camera-oriented discovery (i.e. the default behavior of discover) - takes more time to complete because it inspects all the grabbers of - the system to present a list of available cameras; A multi-bank camera - that exposes several CoaXPress devices (each device providing a part - of the acquired images) can be detected by the camera-oriented - discovery as a single camera; indeed the discovery is able to - identify which devices go together and how to reorder them so the - master device is always in the first position - - - - - Return information to create an object from a discovered grabber - - Index of the grabber, must be smaller than - EGrabberInfo, information to create an object from the discovered grabber - - - Example: create a grabber object for the first discovered grabber - - var gentl = new EGenTL(); - var discovery = new EGrabberDiscovery(gentl) - discovery.Discover(); - var grabber = new EGrabber(discovery.GetGrabber(0)); - - - Note: the returned value reflects the result of the last grabber-oriented discovery (performed by ) - - - - - Return the result of the last grabber-oriented discovery as a collection - - - - Example: create a grabber object for the first discovered grabber - - var gentl = new EGenTL(); - var discovery = new EGrabberDiscovery(gentl) - discovery.Discover(); - var grabber = new EGrabber(discovery.EGrabbers[0]); - - - Note: the returned collection reflects the result of the last grabber-oriented discovery (performed by ) - - - - - Get the number of discovered grabbers - > - - - - Return information to create an object from a discovered camera - - Index of the camera, must be smaller than - Optional index of the data stream to select (default = 0) - EGrabberCameraInfo, information to create an object from the discovered camera - - - Example: create a grabber object for the first discovered camera - - var gentl = new EGenTL(); - var discovery = new EGrabberDiscovery(gentl) - discovery.Discover(); - var grabber = new EGrabber(discovery.GetCamera(0)); - - - Note: the returned value reflects the result of the last camera-oriented discovery (performed by ) - - - - - Return information to create an object from a discovered camera identified by user-defined name - - User-defined name of the camera - Optional index of the data stream to select (default = 0) - EGrabberCameraInfo, information to create an object from the discovered camera - - Note: the returned value reflects the result of the last camera-oriented discovery (performed by ) - - - - - Return the result of the last camera-oriented discovery as a collection - - - - Example: create a grabber object for the first discovered camera - - var gentl = new EGenTL(); - var discovery = new EGrabberDiscovery(gentl) - discovery.Discover(); - var grabber = new EGrabber(discovery.Cameras[0]); - - - Note: the returned collection reflects the result of the last camera-oriented discovery (performed by ) - - - - - Get the number of discovered cameras - - - - - Return information about an interface found in the system by the last discovery - - Index of the interface, must be smaller than - EGrabberInfo, information to create a partial object - - Note: the returned value reflects the result of the last discovery (performed by ) - - - - - Get the number of interfaces found in the system by the last discovery - - - - - Return information about a device found in an interface by the last discovery - - Index of the interface, must be smaller than - Index of the device, must be smaller than - EGrabberInfo, information to create a partial object - - Note: the returned value reflects the result of the last discovery (performed by ) - - - - - Get the number of devices found in an interface by the last discovery - - Index of the interface, must be smaller than - Number of devices found in the specified interface - - - - Return information about a stream found in a device by the last discovery - - Index of the interface, must be smaller than - Index of the device, must be smaller than - Index of the stream, must be smaller than - EGrabberInfo, information to create an object - - Note: the returned value reflects the result of the last discovery (performed by ) - - - - - Get the number of streams found in a device by the last discovery - - Index of the interface, must be smaller than - Index of the device, must be smaller than - Number of streams found in the specified device - - - - The EGenTL instance used by the discovery object - > - - - - Release the resources associated with the object - - - - - An object that encapsulates a set of related GenTL modules - (an interface, a device, a data stream, a remote device) - - An InterfaceModule that represents global (shared) frame - grabber settings and features. This includes digital I/O control, PCIe and firmware status... - A DeviceModule (or local device, as opposed to remote device) that contains the frame grabber settings and features relating to the camera - This consists mainly of camera and illumination control features: strobes, triggers... - StreamModule that handles image buffers - A RemoteModule that is the CoaXPress camera - - - - - - Run a Euresys GenApi script - - Euresys GenApi script to run - This can be either a location (path) or some actual script statements - - - Interactions with the script are possible via the user interface callback - - - - - Return a string that represents the current grabber - - A string that represents the current grabber - - - - The system module - - - - - The interface module - - - - - The device module - - - - - The remote module - - - - - The stream module - - - - - An intermediate array of objects returned by - - - - - Indexer - - Index of the grabber to access - The requested grabber object - - - - Discovered grabber information (cf. ) - - - Results of the , can be passed to to create a grabber object - - - - - Interface index of the grabber - - - - - Device index of the grabber - - - - - Stream index of the grabber - - - - - Interface identifier of the grabber - - - - - Device identifier of the grabber - - - - - Stream identifier of the grabber - - - - - Vendor name of the device associated with the grabber (cf. ) - - - - - Device model name of the device associated with the grabber (cf. ) - - - - - Device description of the device associated with the grabber - - - - - Stream description of the stream associated with the grabber - - - - - User identifier of the device associated with the grabber (cf. ) - - - - - Indicate whether a remote device is associated with the grabber - - - - - Indicate whether the device associated with the grabber is read-only - - - - - TL Type (cf. ) - - - - - Firmware status of the grabber device (when applicable, e.g. Coaxlink or Grablink Duo) - - - - - Fan status of the grabber device (when applicable, e.g. Coaxlink or Grablink Duo) - - - - - License status of the grabber device (when applicable, e.g. Gigelink) - - - - - object associated with the grabber - - - - - Release the resources associated with the object - - - - - EGrabber library error - - - This error is not thrown under normal conditions - It may occur when an unexpected internal error occurs or when a library function returns an unknown error code - - - - - Internal library error code - - - - - CTI library loading error - - - - - Path to the CTI library that could not be loaded - - - - - Missing GenTL symbol error - - - - - Path to the GenTL library - - - - - Missing symbol - - - - - Unexpected data type error - - - This error occurs when an info command value type does not match the destination type T for the various GetInfo<T> methods - - - - - Actual data type of the queried info command - - - - - Unexpected data size error - - - This error occurs when an info command value size does not match the size of the destination type T for the various GetInfo<T> methods - - - - - Expected data size (size of the destination type) - - - - - Actual data size of the queried info command - - - - - Client error - - - This error generally occurs because of an error in the client code, please check the description for further details - - - - - GenTL error - - - - - GenTL error code - - - - - GenTL error description - - - - - GenApi error - - - A specialization of that provides GenApi error details - - - - - GenApi error code - - - - - Additional error data - - - - - Thread error - - - - - Internal error - - - This error is not thrown under normal conditions - It may occur when an unexpected internal state is detected inside the underlying EGrabber C++ classes - - - - - Operation not allowed error - - - This error indicates an operation is currently not allowed - - - - - Runtime error - - - This error occurs when the underlying EGrabber C++ code throws a std::runtime_error exception - - - - - Logic error - - - This error occurs when the underlying EGrabber C++ code throws a std::logic_error exception - - - - - Standard exception - - - This error occurs when the underlying EGrabber C++ code throws a std::exception - - - - - collection - - - - - Number of grabbers in the collection - - - - - Indexer - - Zero-based index of the grabber in the collection, must be smaller than - Grabber information - - - - Collection of EGrabberCameraInfo - - - - - Number of cameras in the collection - - - - - Indexer - - Zero-based index of the camera in the collection, must be smaller than - Camera information - - - - Indexer - - Zero-based index of the camera in the collection, must be smaller than - Zero-based index of the stream - Camera information - - - - Indexer - - User-defined name of the camera - Camera information - - - - Indexer - - User-defined name of the camera - Zero-based index of the stream - Camera information - - - - collection enumerator - - - - - Build an enumerator for the collection - - Strongly typed enumerator - - - - Build an enumerator for the collection - - Non-generic enumerator - Non-generic version of - - - - Input details for image conversion - - - - - Create an input object for - - Input buffer width in pixels - Input buffer height in pixels - Input pixel format - Input buffer address - Input buffer size - Input line pitch - - - - Input buffer width in pixels - - - - - Input buffer height in pixels - - - - - Address of input buffer - - - - - Input pixel format - - - - . - Input buffer size (optional) - - - - - Input line pitch (optional, mandatory for packed formats) - - - - - Output details for image conversion - - - - - Create an output object for - - Output buffer width in pixels - Output buffer height in pixels - Output pixel format - Output buffer address - Output buffer size - Convert configuration - Convert operation - Output quality if relevant - - JPEG encoding quality from 1 (lowest) to 100 (highest), 0 selects the default encoder quality value - - - - - - Output buffer width in pixels - - - - - Output buffer height in pixels - - - - - Output buffer address (or address of new image id if config is IMAGE_CONVERT_OUTPUT_CONFIG_IMAGE_ID - - - - - Output pixel format - - - - - Convert configuration - - - - - Convert operation - - - - - Jpeg encoding quality form 1 (lowest) to 100 (highest), 0 selects the default encoder quality - - - - - Maximum data size - - - - - Converted data size (size of the converted data that was written to the buffer) - - - The value is only available after the conversion was done - - - - - Special type to query info command details without getting the data - - - - - Data size (bytes) of the queried info command - - - - - Data type of the queried info command - - - - - IO toolbox event data - - - - In order to get IO toolbox events, the IO toolbox event data type needs to be enabled by calling with the event type - IO toolbox event data can be received as event callback argument or using - - - - - - Event timestamp - - - - - Custom event data identifier - - - - - Value of EventNotificationContext1 for this event (latched at the time the event occurred) - - - - - Value of EventNotificationContext2 for this event (latched at the time the event occurred) - - - - - Value of EventNotificationContext3 for this event (latched at the time the event occurred) - - - - - Base class of the various memory objects describing a buffer to announce and queue - - - - - Memory allocated by the GenTL producer - - - - - Create a GenTLMemory object describing a memory buffer to allocate, announce and queue - - Size of the memory buffer to create. When 0, a suitable size is evaluated - Optional user data (available in ) - - - - Size of the memory buffer in bytes - - - - - Optional user data (available in ) - - - - - Bus addressable memory - - - - - Create a BusMemory object describing a Bus addressable memory buffer to announce and queue - - Bus buffer address on the PCIe bus - Size of the buffer allocated by the user - Optional user data (available in ) - - - - Bus buffer address on the PCIe bus - - - - - Size of the buffer allocated by the user - - - - - Optional user data (available in ) - - - - - NVIDIA Device memory to be translated to bus addressable memory - - - - - Create a NvidiaRdmaMemory object describing an NVIDIA Device memory buffer to announce and queue - - NVIDIA Device memory buffer address - Size of the buffer allocated by the user - Optional user data (available in ) - - - - NVIDIA Device memory buffer address - - - - - Size of the buffer allocated by the user - - - - - Optional user data (available in ) - - - - - Memory allocated by the user - - - - - Create a UserMemory object describing a user allocated memory buffer to announce and queue - - User-provided mutable buffer of bytes - Optional user data (available in ) - - - - Create a UserMemory object describing a user allocated memory buffer to announce and queue - - User-provided mutable Stream object - Optional user data (available in ) - - - - User provided array of bytes (if any) - - - - - User provided Stream object (if any) - - - - - Optional user data (available in ) - - - - - Unmanaged memory address - - - - - Buffer size in bytes - - - - - UserMemory split into an array of contiguous buffers - - - - - Create an UserMemoryArray object describing a user allocated memory buffer to announce and queue as an array of contiguous buffers - - Memory allocated by the user to split into an array of contiguous buffers - Size of buffers - - Notes: - - - Announcing and queuing a UserMemoryArray results in announcing and queuing multiple buffers - - - Depending on the size of the user memory and the requested buffer size, - the size of the last buffer of the array can be smaller than , - therefore we recommend to make sure that is a multiple of - - - - - - - Memory allocated by the user to split into an array of contiguous buffers - - - - - Size of buffers (except for the last buffer if the is not a multiple of ) - - - - - GenICam GenTL port base class - - - - - Read bytes from the port at the given - - Byte address to read from - Number of bytes to read - Received data - - - - Write to the port at the given - - Byte address to write to - Input buffer containing the data to write - - - - Read bytes as null-terminated string from the port at the given - - Byte address to read from - Number of bytes to read - Received string - - - - Read a single value from the port at the given - - The type of the value to read - Byte address to read from - Received value - - The type determines the number of bytes (Marshal.SizeOf<T>()) to read from the port - - - - - Write a single value to the port at the given - - The type of the value to write - Byte address to write to - Value to write as a sequence of bytes - - The type determines the number of bytes (Marshal.SizeOf<T>()) to write to the port - - - - - Get the value of a GenApi feature - - Type of the value to return - Name of feature to read - Feature value - - The type determines the GenICam feature interface to use to get the value: - - IInteger interface is used for bool, byte, sbyte, short, ushort, int, uint, long, ulong - IFloat interface is used for float, double - IString interface is used for string, string[] - IRegister interface is used for byte[] - - - - - - Get the value of a GenApi register feature - - Name of feature to read - Number of bytes to read from the register feature - Feature value - - - - Set the value of a GenApi feature - - Type of the value to set - Name of feature to modify - Value to write - - The type determines the GenICam feature interface to use to set the value: - - IInteger interface is used for bool, byte, sbyte, short, ushort, int, uint, long, ulong - IFloat interface is used for float, double - IString interface is used for string - IRegister interface is used for byte[] - - - - - - Set the value of GenApi register feature - - Name of feature to modify - Byte array to write to the register feature - - - - Execute a GenApi command feature - - Name of feature to execute - - - - Attach a GenApi event - - GenApi event identifier - Data associated to the event - - - - Invalidate the cache of a GenApi feature (and its dependencies) - - Name of the feature to invalidate - - This only invalidates the cache (the feature itself will not be changed) - - - - - Get the list of attributes exposed by the GenApi Module - - - - - Get the list of available features exposed by the GenApi Module - - - - - Get the list of all features exposed by the GenApi Module - - - - - Get the list of features exposed by the GenApi Module - - - - If true: the query will be configured to only include features available at "query" time - If false: the query will be configured to include all the exposed features - - - A list of features - - - - Get the list of features of a category exposed by the GenApi Module - - Name of the category - - - If true: the query will be configured to only include features of the category available at "query" time - If false: the query will be configured to include all the exposed features of the category - - - A list of features - - - - Get the list of available categories exposed by the GenApi Module - - - - - Get the list of all categories exposed by the GenApi Module - - - - - Get the list of categories exposed by the GenApi Module - - - - If true: the query will be configured to only include categories available at "query" time - If false: the query will be configured to include all the exposed categories - - - A list of categories - - - - Get the list of categories of a category exposed by the GenApi Module - - Name of the category - - - If true: the query will be configured to only include categories of the category available at "query" time - If false: the query will be configured to include all the exposed categories of the category - - - A list of categories - - - - Get the list of entries of a GenApi enumeration - - Name of enumeration feature to query - - - If true: the query will be configured to only include enumeration entries available at "query" time - If false: the query will be configured to include all enumeration entries of the given feature - - - A list of enumeration entries - - - - Check if a feature is available - - Name of the feature to query - - - - - Check if a feature is readable - - Name of the feature to query - - - - - Check if a feature is writeable - - Name of the feature to query - - - - - Check if a feature is implemented - - Name of the feature to query - - - - - Check if a feature is a command - - Name of the feature to query - - - - - Check if the execution of a command is done - - Name of the command to query - - - - - Get the list of interfaces of a feature - - Name of the command to query - A list of GenICam interfaces - - Possible return values are: - - IInteger - IFloat - IString - IEnumeration - IBoolean - ICommand - IPort - IRegister - - - - - - Get the XML source of a feature - - Name of the feature to query - An XML string - - - - Get the register description document of the GenApi Module - - - - - Get XML information of a feature node - - Name of the feature to query - Name of the XML child to query - A string - - - - Get the list of declared virtual user features on the GenApi Module - - - - - Declare a virtual user feature of type Integer - - Name of the virtual feature to declare - - - - Declare a virtual user feature of type Float - - Name of the virtual feature to declare - - - - Declare a virtual user feature of type String - - Name of the virtual feature to declare - - - - Undeclare (delete) a virtual user feature - - Name of the virtual feature to delete - - - - GenTL module base class - - Module info command type - - - - Get GenTL module information - - Type of the return value - Module info command - Module information - - - - - - Please note that - - and are closely related - Wrong combinations of and will lead to or exceptions - Using an unsupported type will throw an - - - - - - System module - - - - - Interface module - - - - - Device module - - - - - Stream module - - - - - Remote module - - - - - New buffer event data - - - - The new buffer event data type is automatically enabled when calling unless the event has been explicitely enabled or disabled - The new buffer event data type can be explicitely enabled by calling with the event type - New buffer event data can be received as event callback argument or using (or ) - - - - - - Data stream handle associated to buffer - - - - - Buffer handle - - - - - Optional user data object (if provided when announced) - - - - - Timestamp associated to new buffer event - - - - - Helper functions to build Euresys GenApi queries - - - - - Create a query to get the list of attributes exposed by a GenApi Module - - - - - Create a query to get the list of features exposed by a GenApi Module - - - - If true: the query will be configured to only include features available at "query" time - If false: the query will be configured to include all the exposed features - - - A query - - - - Create a query to get the list of features of a category exposed by a GenApi Module - - Name of the category - - - If true: the query will be configured to only include features of the category available at "query" time - If false: the query will be configured to include all the exposed features of the category - - - A query - - - - Create a query to get the list of categories exposed by a GenApi Module - - - - If true: the query will be configured to only include categories available at "query" time - If false: the query will be configured to include all the exposed categories - - - A query - - - - Create a query to get the list of categories of a category exposed by a GenApi Module - - Name of the category - - - If true: the query will be configured to only include categories of the category available at "query" time - If false: the query will be configured to include all the exposed categories of the category - - - A query - - - - Create a query to get the list of entries of a GenApi enumeration - - Name of enumeration feature to query - - - If true: the query will be configured to only include enumeration entries available at "query" time - If false: the query will be configured to include all enumeration entries of the given feature - - - A query - - - - Create a query to check if a feature is available - - Name of the feature to query - A query - - - - Create a query to check if a feature is readable - - Name of the feature to query - A query - - - - Create a query to check if a feature is writeable - - Name of the feature to query - A query - - - - Create a query to check if a feature is implemented - - Name of the feature to query - A query - - - - Create a query to check if a feature is a command - - Name of the feature to query - A query - - - - Create a query to check if execution of a command is done - - Name of the feature to query - A query - - - - Create a query to get the list of interfaces of a feature - - Name of the feature to query - A query - - - - Create a query to get the XML source of a feature - - Name of the feature to query - A query - - - - Create a query to get the register description document of a GenApi Module - - A query - - - - Create a query to get XML information of a feature node - - Name of the feature to query - Name of the XML child to query - A query - - - - Create a query to get the list of declared virtual user features - - - - - Remote device event data - - - - In order to get remote device events, the remote device event data type needs to be enabled by calling with the event type - Remote device event data can be received as event callback argument or using - - The remote device event is configured by default to deliver GenICam remote device events, which can be attached to the GenApi remote module with , for example - - - grabber.Remote.AttachEvent(data.EventId, data.Data) - - - Note: in order to get other remote device events (CoaXPress or device-specific events), the Device module feature RemoteDeviceEventEnable must be configured - - - - - Event timestamp - - - - - Event namespace - - - - - EventID of GenApi event - - - - - Size of addressable data - - - - - Addressable data through the GenApi event port - - - - - ScopedBuffer object encapsulating a GenTL buffer that is automatically pushed when disposed - - - This object is designed to be declared in a using statement - - - using (var buffer = new ScopedBuffer(grabber)) { ... } - - When the control leaves the block of the using statement, the GenTL buffer associated to the ScopedBuffer instance is automatically pushed to the back of the data stream input fifo - - - - - - IDisposable.Dispose - - The buffer is pushed back to the data stream input fifo - - - - Create a ScopedBuffer object encapsulating the next delivered GenTL buffer - - The grabber managing the underlying GenTL buffer - Timeout value in milliseconds - - If there is no new buffer event when called, the method waits for at most the specified - - Either the timeout expires and a is thrown - Or GenTL buffer is delivered and a ScopedBuffer object is created - - - - - - Create a ScopedBuffer object encapsulating the next delivered GenTL buffer - - The grabber managing the underlying GenTL buffer - Timeout value in milliseconds - - If there is no new buffer event when called, the method waits for at most the specified - - Either the timeout expires and a is thrown - Or GenTL buffer is delivered and a ScopedBuffer object is created - - - - - - Create a ScopedBuffer object from a object - - Buffer to scope - - - - Create a ScopedBuffer object encapsulating the GenTL buffer specified in a - - The grabber managing the underlying GenTL buffer - New buffer data - - A new buffer data can be obtained from - - - - The argument of a callback registered with , where T is - - - - - - - Get buffer information - - Type of the return value - Buffer info command - Buffer information - - - - - - Please note that - - and are closely related - Wrong combinations of and will lead to or exceptions - Using an unsupported type will throw an - - - - - - Get useful buffer information - - Buffer information - - - - Convert a buffer - - Output pixel format - Convert output configuration - Convert output operation - Quality for jpeg format, from 1 (lowest) to 100 (highest), 0 selects the default encoder quality value - Converted buffer - - - - Convert a buffer to a specified output buffer - - Output pixel format - Output buffer pointer - Output buffer size - Convert output configuration - Convert output operation - Quality for jpeg format, from 1 (lowest) to 100 (highest), 0 selects the default encoder quality value - Converted data size - - - - Convert a buffer - - Output pixel format - Convert output configuration - Convert output operation - Quality for jpeg format, from 1 (lowest) to 100 (highest), 0 selects the default encoder quality value - Region of interest to be converted - Converted buffer - - - - Convert a buffer to a specified output buffer - - Output pixel format - Output buffer pointer - Output buffer size - Convert output configuration - Convert output operation - Quality for jpeg format, from 1 (lowest) to 100 (highest), 0 selects the default encoder quality value - Region of interest to be converted - Converted data size - - - - Save the buffer content to disk - - - Path to the file or path pattern - - path of the new image file, the file extension determines the file format - - path pattern where a group of characters N is replaced by the value of index: - - if index is 5, N becomes 5 - if index is 9, NN becomes 09 - if index is 10, NN becomes 10 - - - - - - Control pattern substitution - - if index >= 0, enable pattern substitution with given index value - if index < 0, disable pattern substitution - - - - Notes: - - The parent directory must exist - Buffer information (address, width, height, format) are automatically queried - No buffer conversion will be applied before writing the image file, please use Buffer.Convert[To] if needed - - - - - - Save the buffer content to disk - - - Path to the file or path pattern - - path of the new image file, the file extension determines the file format - - path pattern where a group of characters N is replaced by the value of index: - - if index is 5, N becomes 5 - if index is 9, NN becomes 09 - if index is 10, NN becomes 10 - - - - - - Control pattern substitution - - if index >= 0, enable pattern substitution with given index value - if index < 0, disable pattern substitution - - - Image saving parameters - - Notes: - - The parent directory must exist - Buffer information (address, width, height, format) are automatically queried - No buffer conversion will be applied before writing the image file, please use Buffer.Convert[To] if needed - - - - - - Get the user object provided when the GenTL buffer was announced (if any) - - - - - Get the base address of the buffer memory (cf. ) - - - - Constants - - - Event data numid custom base - - - Image save to disk default quality - - - Memento verbosity critical - - - Memento verbosity error - - - Memento verbosity warning - - - Memento verbosity notice - - - Memento verbosity info - - - Memento verbosity debug - - - Memento verbosity verbose - - - Gentl infinite - - - This enumeration defines GenTL standard and Euresys custom errors () - - - No Error - - - Unspecified runtime error - - - Module or resource is not initialized - - - Requested operation is not implemented - - - Requested resource is already in use - - - Requested operation is not allowed - - - Given handle does not support the operation - - - ID could not be connected to a resource - - - The function has no data to work on - - - One of the parameters given was not valid - - - Communication error has occurred - - - Timeout expired before the operation could be completed - - - An operation has been aborted before it could be completed - - - The GenTL Consumer has not announced enough buffers - - - Resource or information is not available - - - A given address is out of range or invalid - - - A provided buffer is too small to receive the expected amount of data - - - A provided index referencing a Producer internal object is out of bounds - - - An error occurred parsing a buffer containing chunk data - - - A register write function was trying to write an invalid value - - - A requested resource is exhausted - - - The system ran out of memory - - - Requested operation cannot be performed (module or resource is busy) - - - Custom id - - - Different handles to the same object were found - - - Handles associated to a closed object were found - - - No handle associated to an opened object was found - - - A lock issue has been detected - - - Some silent errors occurred - - - Library path cannot be retrieved - - - Failed to access the driver - - - A driver error has occurred - - - Buffer revoke error (No longer used) - - - Caught a C++ std::exception - - - An alignment error occurred while accessing a module port - - - A wait operation failed unexpectedly - - - A wait operation has been interrupted - - - Cannot create notification object - - - Cannot access notification object state - - - An external module could not be loaded - - - A required symbol was not found - - - A string is too long - - - Data type mismatch - - - Too many GenApi contexts - - - Key doesn't match programmed OEM safety key - - - GEV Driver could not communicate with the camera - - - A GenApi feature could not be found - - - A buffer address does not match any announced buffer address - - - An internal assertion failed - - - Subnet mismatch, invalid IP address and the like - - - Unexpected values in connection data - - - Remote device requires a protocol version that is not supported - - - Connection doesn't have the expected state at the time of the call - - - The underlying NetworkDirect adapter was removed from the system - - - The specified buffer length exceeds the capabilities of the underlying NetworkDirect hardware - - - The remote system refused the connection request - - - The remote system aborted the connection - - - The local system terminated the connection - - - A GenApi error has occurred - - - An error occurred while processing an image - - - An error occurred in the License Manager - - - No license was found - - - A CL error occurred - - - Custom ioctl base - - - Driver could not write to PCI configuration space of device - - - Driver could not read from PCI configuration space of device - - - Driver could not find a DMA engine - - - Driver has no IRQ handler - - - Driver could not register notification object while creating the data stream - - - Custom ioctl ds get info failed - - - Driver could not open DataStream module - - - Driver could not start the acquisition engine - - - Custom ioctl ds stop failed - - - Custom ioctl dev get info failed - - - Driver error while getting remote device URL information - - - Driver could not not write to remote device CoaXPress register - - - Driver could not not read remote device CoaXPress register - - - Custom ioctl cxp master connection not found - - - Custom ioctl cxp host library cmd failed - - - Driver was not able to announce a buffer - - - Driver could not stop the acquisition engine in a timely fashion - - - Driver I2C error - - - Driver detected a flash bank select inconsistency - - - Driver could not read from onboard memory - - - Driver could not write to onboard memory - - - Driver could not write Flat Field Correction coefficient data - - - Driver could not register serial notification object - - - Custom gev base - - - Custom os rdma base - - - Defines the data type possible for the various Info functions - - - Unknown data type - - - NULL-terminated C string (ASCII encoded) - - - Concatenated INFO_DATATYPE_STRING list. End of list is signaled with an additional NULL - - - Signed 16 bit integer - - - Unsigned 16 bit integer - - - Signed 32 bit integer - - - Unsigned 32 bit integer - - - Signed 64 bit integer - - - Unsigned 64 bit integer - - - Signed 64 bit floating point number - - - Pointer type (void*). Size is platform dependent (32 bit on 32 bit platforms) - - - Boolean value occupying 8 bit. 0 for false and anything for true - - - Platform dependent unsigned integer (32 bit on 32 bit platforms) - - - Like a INFO_DATATYPE_STRING but with arbitrary data and no NULL termination - - - Platform dependent signed integer (32 bit on 32 bit platforms). GenTL v1.3 - - - Starting value for custom IDs - - - Defines char encoding schemes used by the producer, GenTL v1.4 - - - Tl char encoding ascii - - - Tl char encoding utf8 - - - System module information commands for the EGrabber.System.GetInfo<T>() and functions - - - STRING Transport layer ID - - - STRING Transport layer vendor name - - - STRING Transport layer model name - - - STRING Transport layer version - - - STRING Transport layer technology that is supported - - - STRING File name including extension of the library - - - STRING Full path including file name and extension of the library - - - STRING User readable name of the device. If this is not defined in the device this should be VENDOR MODEL (ID) - - - INT32 Reporting the char encoding used by this Producer, GenTL v1.4 - - - UINT32 Major number of the GenTL spec this producer complies with, GenTL v1.5 - - - UINT32 Minor number of the GenTL spec this producer complies with, GenTL v1.5 - - - Starting value for custom IDs - - - This enumeration defines commands to retrieve information with the EGrabber.Interface.GetInfo<T>() function from the Interface module - - - STRING Unique ID of the interface - - - STRING User readable name of the interface - - - STRING Transport layer technology that is supported - - - Starting value for GenTL Producer custom IDs - - - This enumeration defines GenTL standard and Euresys custom flags of how a device is to be opened with the constructor - - - Not used in a command. Can be used to initialize a variable to query that information - - - This either means that the device is not open because it was not opened before or the access to it was denied - - - Open the device read only. All Port functions can only read from the device - - - Open the device in a way that other hosts/processes can have read only access to the device. Device access level is read/write for this process - - - Open the device in a way that only this host/process can have access to the device. Device access level is read/write for this process - - - Starting value for GenTL Producer custom IDs - - - Open both the device and child data stream read only - - - Open the device for serial communication - - - This enumeration defines values for the accessibility of the device, see - - - The device accessibility is not known - - - The device is available for read/write access - - - The device is available for read only access - - - The device is not accessible - - - The device has already been opened by another process/host. GenTL v1.5 - - - The device has already been opened by this process. GenTL v1.5 - - - The device has already been opened by this process. GenTL v1.5 - - - Starting value for custom IDs - - - This enumeration defines GenTL standard and Euresys custom commands to retrieve information with the EGrabber.Device.GetInfo<T>() function - - - STRING Unique ID of the device - - - STRING Device vendor name - - - STRING Device model name - - - STRING Transport layer technology that is supported - - - STRING String containing a display name for the device ( including a unique id ) - - - INT32 Gets the access mode the GenTL Producer has on the opened device. ( enumeration value) - - - STRING String containing the user defined name, GenTL v1.4 - - - STRING String containing the device's serial number, GenTL v1.4 - - - STRING String containing the device version, GenTL v1.4 - - - UINT64 Tick-frequency of the time stamp clock, GenTL v1.4 - - - Starting value for GenTL Producer custom IDs - - - STRING Description of the device - - - This enumeration defines special stop flags for the acquisition engine - - - Stop the acquisition engine when the currently running tasks like filling a buffer are completed (default behavior) - - - Stop the acquisition engine immediately and leave buffers currently being filled in the Input Buffer Pool - - - Starting value for GenTL Producer custom IDs - - - This enumeration defines GenTL standard and Euresys custom flags for how the acquisition engine must be started - - - Default behavior - - - Starting value for GenTL Producer custom IDs - - - Start the data stream but leave the CIC sequencer idle - - - This enumeration commands from which to which queue/pool buffers are flushed with the function - - - Flushes the input pool to the output queue and if necessary adds entries in the New Buffer event data queue - - - Discards all buffers in the output queue and if necessary remove the entries from the event data queue - - - Puts all buffers in the input pool. Even those in the output queue and discard entries in the event data queue - - - Puts all buffers that are not in the input pool or the output queue in the input pool - - - Discards all buffers in the input pool and output queue - - - Starting value for GenTL Producer custom IDs - - - This enumeration defines GenTL standard and Euresys custom commands to retrieve information with the EGrabber.Stream.GetInfo<T>() function - - - STRING Unique ID of the data stream - - - UINT64 Number of delivered buffers since last acquisition start - - - UINT64 Number of lost buffers due to queue underrun - - - SIZET Number of announced buffers - - - SIZET Number of buffers in the input pool - - - SIZET Number of buffers in the output queue - - - UINT64 Number of buffers started in the acquisition engine - - - SIZET Size of the expected data in bytes - - - BOOL8 Flag indicating whether the acquisition engine is started or not - - - BOOL8 Flag that indicated that this data stream defines a payload size independent from the remote device - - - STRING Transport layer technology that is supported - - - SIZET Max number of chunks in a buffer, if known. GenTL v1.3 - - - SIZET Min number of buffers to announce before acq can start, if known. GenTL v1.3 - - - SIZET Buffer alignment in bytes. GenTL v1.3 - - - Starting value for GenTL Producer custom IDs - - - STRING Description of the stream - - - BOOL8 Flag to indicate that internal resources (like the DMA) need to be reconfigured and thus buffers need to be revoked and announced again - - - BOOL8 Flag to indicate that buffers need to be revoked and reallocated again because the payload size or alignment constraints have changed - - - This enumeration defines GenTL standard and Euresys custom commands to retrieve information with the function on a buffer - - - PTR Base address of the buffer memory - - - SIZET Size of the buffer in bytes - - - PTR Private data pointer of the GenTL Consumer - - - UINT64 Timestamp the buffer was acquired - - - BOOL8 Flag to indicate that the buffer contains new data since the last call - - - BOOL8 Flag to indicate if the buffer is in the input pool or output queue - - - BOOL8 Flag to indicate that the buffer is currently being filled with data - - - BOOL8 Flag to indicate that a buffer was filled but an error occurred during that process - - - STRING Transport layer technology that is supported - - - SIZET Number of bytes written into the buffer last time it has been filled. This value is reset to 0 when the buffer is placed into the Input Buffer Pool - - - SIZET GenTL v1.2 - - - SIZET GenTL v1.2 - - - SIZET GenTL v1.2 - - - SIZET GenTL v1.2 - - - SIZET GenTL v1.2 - - - SIZET GenTL v1.2 - - - UINT64 GenTL v1.2 - - - BOOL8 GenTL v1.2 - - - SIZET GenTL v1.2 - - - SIZET GenTL v1.2 - - - UINT64 GenTL v1.2 - - - UINT64 GenTL v1.2 - - - SIZET GenTL v1.2 - - - SIZET GenTL v1.2 - - - UINT64 GenTL v1.2 - - - STRING GenTL v1.2 - - - INT32 GenTL v1.4 - - - SIZET GenTL v1.4 - - - UINT64 GenTL v1.4 - - - BOOL8 GenTL v1.4 - - - BOOL8 GenTL v1.4 - - - Starting value for GenTL Producer custom IDs - - - BOOL8 Flag to indicate that the buffer is the first of a scan - - - BOOL8 Flag to indicate that the buffer is the last of a scan - - - UINT64 Timestamp of the new buffer event - - - UINT16 Stream ID (word 3 in the CoaXPress rectangular image header) - - - UINT16 Tap geometry (words 23-24 in the CoaXPress rectangular image header) - - - UINT16 Image flags (word 25 in the CoaXPress rectangular image header) - - - SIZET Line pitch (or 1 for buffers containing JPEG data) - - - SIZET Value of data stream LineWidth when the buffer was announced - - - SIZET Value of data stream LinePitch when the buffer was announced - - - SIZET Value of data stream StripeHeight when the buffer was announced - - - SIZET Value of data stream StripePitch when the buffer was announced - - - UINT64 Value of data stream StripeArrangement when the buffer was announced - - - UINT32 CustomLogic Status associated to the buffer - - - SIZET Value of data stream StripeOffset when the buffer was announced - - - SIZET Value of data stream BlockHeight when the buffer was announced - - - SIZET Number of LLE extracted lines per acquired image - - - SIZET Alignment of buffer allocated by DSAllocAndAnnounceBuffer - - - SIZET Size of each buffer part - - - SIZET Maximum number of parts in the buffer (value of data stream BufferPartCount when the buffer was announced) - - - SIZET Number of parts available in the buffer - - - BUFFER Array of 64-bit unsigned integers containing the timestamps of each buffer part - - - UINT32 32-bit inserted buffer metadata at offset 0 - - - UINT32 32-bit inserted buffer metadata at offset 1 - - - UINT32 32-bit inserted buffer metadata at offset 2 - - - UINT32 32-bit inserted buffer metadata at offset 3 - - - BOOL8 Flag to indicate that the buffer has inserted buffer metadata - - - BOOL8 Flag to indicate that the buffer has inserted line metadata - - - PTR Base address of the inserted line metadata - - - UINT16 Content ID of the 32-bit inserted metadata at offset 0 - - - UINT16 Content ID of the 32-bit inserted metadata at offset 1 - - - UINT16 Content ID of the 32-bit inserted metadata at offset 2 - - - UINT16 Content ID of the 32-bit inserted metadata at offset 3 - - - This enumeration defines commands to retrieve information about individual data parts in a multi-part buffer. Introduced in GenTL v1.5 - - - PTR Base address of the buffer part memory - - - SIZET Size of the buffer part in bytes - - - SIZET Type of the data in given part (PARTDATATYPE_ID enumeration value) - - - UINT64 Format of individual items (such as pixels) in the buffer part - - - UINT64 Allows interpretation of BUFFER_PART_INFO_DATA_FORMAT ( enumeration value) - - - SIZET Width of data in the buffer part in pixels - - - SIZET Expected height of data in the buffer part in pixels - - - SIZET Horizontal offset of data in the buffer part in pixels - - - SIZET Vertical offset of data in the buffer part in pixels - - - SIZET Horizontal padding of data in the buffer part in pixels - - - UINT64 Identifier allowing to group data parts belonging to the same source - - - SIZET Height of the data currently in the buffer part in pixels - - - Starting value for GenTL Producer custom IDs - - - Enumeration of TLType dependent payload types. Introduced in GenTL v1.2 - - - Payload type unknown - - - Payload type image - - - Payload type raw data - - - Payload type file - - - Payload type chunk data - - - Payload type jpeg - - - Payload type jpeg2000 - - - Payload type h264 - - - Payload type chunk only - - - Payload type device specific - - - Payload type multi part - - - Starting value for GenTL Producer custom IDs - - - Enumeration of TLType dependent pixel format namespaces introduced GenTL v1.2 - - - Pixelformat namespace unknown - - - Pixelformat namespace gev - - - Pixelformat namespace iidc - - - Pixelformat namespace pfnc 16bit - - - Pixelformat namespace pfnc 32bit - - - Starting value for GenTL Producer custom IDs - - - Enumeration of pixel endianness values. Introduced in GenTL v1.4 - - - Unknown pixel endianness. GenTL v1.4 - - - Little endian pixel data. GenTL v1.4 - - - Big endian pixel data. GenTL v1.4 - - - Enumeration describing which data type is present in given buffer part. Introduced in GenTL v1.5 - - - Unknown data type - - - Color or monochrome 2D image - - - Single color plane of a planar 2D image consisting of 2 planes - - - Single color plane of a planar 2D image consisting of 3 planes - - - Single color plane of a planar 2D image consisting of 4 planes - - - 3D image (pixel coordinates) - - - Single plane of a planar 3D image consisting of 2 planes - - - Single plane of a planar 3D image consisting of 3 planes - - - Single plane of a planar 3D image consisting of 4 planes - - - Confidence of the individual pixel values - - - Starting value for GenTL Producer custom IDs - - - This enumeration defines commands to retrieve information on a module or remote device handle - - - STRING Unique ID of the port - - - STRING Port vendor name - - - STRING Port model name - - - STRING Transport layer technology that is supported - - - STRING GenTL Module the port refers to - - - BOOL8 Flag indicating that the port data is little endian - - - BOOL8 Flag indicating that the port data is big endian - - - BOOL8 Port has read access - - - BOOL8 Port has write access - - - BOOL8 Port is not accessible - - - BOOL8 Port is not implemented - - - STRING Version of the port - - - STRING Name of the port as referenced in the XML description - - - Starting value for GenTL Producer custom IDs - - - This enumeration defines enum values returned by the URL_INFO_SCHEME command. introduced in GenTL v1.5 - - - The XML can be read from the local register map - - - The XML can be downloaded from a http server - - - The XML can be read from the local hard drive - - - Starting value for custom scheme locations - - - This enumeration defines commands to retrieve URL information on a module or remote device handle. Introduced in GenTL v1.1 - - - STRING URL as defined in chapter 4.1.2 GenTL v1.1 - - - INT32 Major version of the schema this URL refers to. GenTL v1.1 - - - INT32 Minor version of the schema this URL refers to. GenTL v1.1 - - - INT32 Major version of the XML-file this URL refers to. GenTL v1.1 - - - INT32 Minor version of the XML-file this URL refers to. GenTL v1.1 - - - INT32 Subminor version of the XML-file this URL refers to. GenTL v1.1 - - - BUFFER 160-bit SHA1 Hash code of XML-file. GenTL v1.4 - - - UINT64 Register address in the device's register map. GenTL v1.5 - - - UINT64 File size in bytes. GenTL v1.5 - - - INT32 Scheme of the URL as defined in URL_SCHEME_IDS. GenTL v1.5 - - - STRING File name if the scheme of the URL is file. GenTL v1.5 - - - Starting value for GenTL Producer custom IDs - - - This enumeration defines GenTL standard and Euresys custom events - - - Notification on module errors - - - Notification on newly filled buffers - - - Notification if a feature was changed by the GenTL Producer library and thus needs to be invalidated in the GenICam GenApi instance using the module - - - Notification if the GenTL Producer library wants to manually set a feature in the GenICam GenApi instance using the module - - - Notification if the GenTL Producer wants to inform the GenICam GenApi instance of the remote device that a GenApi compatible event was fired - - - Notification if the GenTL Producer wants to inform the GenICam GenApi instance of the module that a GenApi compatible event was fired. GenTL v1.4 - - - Starting value for GenTL Producer custom IDs - - - Notification of IO Toolbox events (on Interface module) - - - Notification of CIC events (on Device module) - - - Notification of data stream events (on DataStream module) - - - Notification of CoaXPress events (on Interface module) - - - Notification of device error events (on Device module) - - - Notification of CoaXPress device events (on Device module) - - - Event info command - - - INT32 The event type of the event handle (EVENT_TYPE enum value) - - - SIZET Number of events in the event data queue - - - UINT64 Number of events that were fired since the creation of the module - - - SIZET Max size of data carried with an event in bytes. GenTL v1.2 - - - SIZET Max size of data provided through EventGetDataInfo in bytes. GenTL v1.2 - - - Starting value for GenTL Producer custom IDs - - - This enumeration defines GenTL standard and Euresys custom commands to retrieve event information - - - Event specific Unique Event ID (String or Number) - - - Event specific Data - - - UINT64 Numeric representation of the unique Event ID, GenTL v1.3 - - - Starting value for GenTL Producer custom IDs - - - UINT64 Timestamp of the event - - - UINT32 Value of EventNotificationContext1 for this event (latched at the time the event occurred) - - - UINT32 Value of EventNotificationContext2 for this event (latched at the time the event occurred) - - - UINT32 Value of EventNotificationContext3 for this event (latched at the time the event occurred) - - - This enumeration defines how to interpret the for Euresys custom events - - - Event data numid custom base - - - Line Input Tool 1 - - - Line Input Tool 2 - - - Line Input Tool 3 - - - Line Input Tool 4 - - - Line Input Tool 5 - - - Line Input Tool 6 - - - Line Input Tool 7 - - - Line Input Tool 8 - - - Quadrature Decoder Tool 1 - - - Quadrature Decoder Tool 1 Changed Direction - - - Quadrature Decoder Tool 2 - - - Quadrature Decoder Tool 2 Changed Direction - - - Quadrature Decoder Tool 3 - - - Quadrature Decoder Tool 3 Changed Direction - - - Quadrature Decoder Tool 4 - - - Quadrature Decoder Tool 4 Changed Direction - - - Divider Tool 1 - - - Divider Tool 2 - - - Divider Tool 3 - - - Divider Tool 4 - - - Multiplier/Divider Tool 1 - - - Multiplier/Divider Tool 2 - - - Multiplier/Divider Tool 3 - - - Multiplier/Divider Tool 4 - - - Delay Tool 1 Output 1 - - - Delay Tool 1 Output 2 - - - Delay Tool 2 Output 1 - - - Delay Tool 2 Output 2 - - - Delay Tool 3 Output 1 - - - Delay Tool 3 Output 2 - - - Delay Tool 4 Output 1 - - - Delay Tool 4 Output 2 - - - User Event 1 - - - User Event 2 - - - User Event 3 - - - User Event 4 - - - C2C-Link Synchronization Tool 1 - - - C2C-Link Synchronization Tool 2 - - - C2C-Link Synchronization Tool 3 - - - Event Input Tool 1 - - - Event Input Tool 2 - - - Device Link Trigger Tool 1 - - - Device Link Trigger Tool 2 - - - Device Link Trigger Tool 3 - - - Device Link Trigger Tool 4 - - - Device Link Trigger Tool 5 - - - Device Link Trigger Tool 6 - - - Device Link Trigger Tool 7 - - - Device Link Trigger Tool 8 - - - Device Link Trigger Tool 9 - - - Device Link Trigger Tool 10 - - - Device Link Trigger Tool 11 - - - Device Link Trigger Tool 12 - - - Device Link Trigger Tool 13 - - - Device Link Trigger Tool 14 - - - Device Link Trigger Tool 15 - - - Device Link Trigger Tool 16 - - - Detected CRC error on CXP connector A - - - Detected CRC error on CXP connector B - - - Detected CRC error on CXP connector C - - - Detected CRC error on CXP connector D - - - Detected CRC error on CXP connector E - - - Detected CRC error on CXP connector F - - - Detected CRC error on CXP connector G - - - Detected CRC error on CXP connector H - - - Low level connection lock achieved on CXP connector A - - - Low level connection lock achieved on CXP connector B - - - Low level connection lock achieved on CXP connector C - - - Low level connection lock achieved on CXP connector D - - - Low level connection lock achieved on CXP connector E - - - Low level connection lock achieved on CXP connector F - - - Low level connection lock achieved on CXP connector G - - - Low level connection lock achieved on CXP connector H - - - Low level connection lock lost on CXP connector A - - - Low level connection lock lost on CXP connector B - - - Low level connection lock lost on CXP connector C - - - Low level connection lock lost on CXP connector D - - - Low level connection lock lost on CXP connector E - - - Low level connection lock lost on CXP connector F - - - Low level connection lock lost on CXP connector G - - - Low level connection lock lost on CXP connector H - - - CoaXPress link configuration done for Device 0 - - - CoaXPress link configuration done for Device 1 - - - CoaXPress link configuration done for Device 2 - - - CoaXPress link configuration done for Device 3 - - - CoaXPress link configuration done for Device 4 - - - CoaXPress link configuration done for Device 5 - - - CoaXPress link configuration done for Device 6 - - - CoaXPress link configuration done for Device 7 - - - Device 0 disconnected - - - Device 1 disconnected - - - Device 2 disconnected - - - Device 3 disconnected - - - Device 4 disconnected - - - Device 5 disconnected - - - Device 6 disconnected - - - Device 7 disconnected - - - CoaXPress link configuration in progress for Device 0 - - - CoaXPress link configuration in progress for Device 1 - - - CoaXPress link configuration in progress for Device 2 - - - CoaXPress link configuration in progress for Device 3 - - - CoaXPress link configuration in progress for Device 4 - - - CoaXPress link configuration in progress for Device 5 - - - CoaXPress link configuration in progress for Device 6 - - - CoaXPress link configuration in progress for Device 7 - - - Start of camera trigger - - - End of camera trigger - - - Start of light strobe - - - End of light strobe - - - CIC is ready for next camera cycle - - - Ignored CIC trigger because CIC is not ready for next camera cycle - - - Delayed CIC trigger until CIC is ready for next camera cycle - - - Received acknowledgement for previous CXP trigger message - - - Resent CXP trigger message (acknowledgement to previous CXP trigger message not received) - - - CIC trigger - - - LinkTrigger<N> received from CoaXPress device - - - Starts acquiring data of a new image frame (area-scan only) - - - Stops acquiring data of an image frame (area-scan only) - - - Starts acquiring data of a new image scan (line-scan only ) - - - Stops acquiring data of an image scan (line-scan only) - - - Dropped image frame data (area-scan only) - - - Dropped image scan data (line-scan only) - - - Trigger to camera readout timeout - - - Camera readout timeout - - - Broken frame due to frame store overflow (area-scan only) - - - Frames never received. Cause unknown - - - Frames never sent by the camera - - - Frames delivered while there are still missing packets - - - Fatal error that terminated acquisition - - - Stream packet size error - - - Stream packet FIFO overflow - - - New trigger sent to remote device even though readout of previous frame has not started yet - - - Trigger ignored because ACK to previous trigger has not been received yet - - - Trigger packet resend not successful - - - Input stream FIFO half full - - - Input stream FIFO full - - - Image header error - - - MIG AXI write error - - - MIG AXI read error - - - Received a CXP packet with unexpected tag - - - Start of scan skipped (caused by internal exception: frame store almost full) - - - End of scan (caused by internal exception: frame store almost full) - - - External trigger requests too close together - - - Stream packet arbiter error - - - Value of EventSpecific for is a bitfield that can be interpreted according to the following definitions. Undocumented bits must be ignored - - - Cf. EVENT_SPECIFIC_CIC_DISCARDED_CIC_TRIGGER_FRAME_STORE_FULL - - - Cause: frame store is full - - - Cause: camera cycle not complete - - - Cause: maximum number of pending triggers already reached - - - Cause: data stream is not active - - - Value of EventSpecific for is a bitfield that can be interpreted according to the following definitions. Undocumented bits must be ignored - - - Cf. EVENT_SPECIFIC_CIC_PENDING_CIC_TRIGGER_FRAME_STORE_FULL - - - Cause: frame store is full - - - Cause: camera cycle not complete - - - Value of EventSpecific for is a bitfield that can be interpreted according to the following definitions. Undocumented bits must be ignored - - - Cause: software trigger - - - Cause: hardware trigger - - - Cause: DSStartAcquisition or end of previous scan - - - Value of EventSpecific for is a bitfield that can be interpreted according to the following definitions. Undocumented bits must be ignored - - - Cause: software trigger - - - Cause: hardware trigger - - - Cause: reached scan length - - - Cause: DSStopAcquisition - - - Cf. EVENT_SPECIFIC_DATASTREAM_END_OF_SCAN_FRAME_STORE_ALMOST_FULL - - - Cause: internal exception (frame store almost full) - - - Value of EventSpecific for is a bitfield that can be interpreted according to the following definitions. Undocumented bits must be ignored - - - Cf. EVENT_SPECIFIC_DATASTREAM_REJECTED_FRAME_FRAME_STORE_FULL - - - Cause: frame store is full - - - Cause: data stream is not active - - - Cause: frame store underwent overflow - - - Namespace of remote device events (EVENT_REMOTE_DEVICE) - - - Event custom remote device namespace genicam - - - Event custom remote device namespace coaxpress - - - Event custom remote device namespace device specific - - - This enumeration defines Euresys custom type of announced memory - - - Bus address is already mapped and translated - - - Default host memory - - - Device memory allocated for RDMA on a NVIDIA card - - - Euresys Image low-level C API - - - output pixels points to a ImageId - - - disable CPU optimizations such as SSSE3 - - - select bayer decoding method 1 (3x3 interpolation, a.k.a. legacy method) - - - select bayer decoding method 2 (3x3 median-based interpolation, a.k.a. advanced method) - - - select bayer decoding method 3 (5x5 gradient-based interpolation) - - - select bayer decoding method 5 (2x2 average-based interpolation) - - - Image convert output config default - - - Image convert output config bayer advanced - - - Image convert output operation - - - default conversion output mode - - - apply 1X2YE line reordering operation - - - Image convert input extra - - - extra[0] optional pointer to input buffer size (size_t) - - - extra[1] optional pointer to input line pitch, mandatory for packed formats (size_t) - - - extra[2] reserved for future use, precondition: must be 0 - - - extra[3] reserved for future use, precondition: must be 0 - - - Genapi error code - - - No error - - - An unknown error occurred - - - <node> not found - - - <node> has no <interface> interface - - - <node> is read-only - - - <node> is write-only - - - <node> is not available - - - <node> is not implemented - - - <node> is locked - - - XML element <element> not found (<node>) - - - XML attribute <attribute> not found (<node>) - - - Port <port> not found (<node>) - - - Port <port> error (<node>: <message>) - - - Register too small (<node>) - - - Register length mismatch (<node>) - - - Invalid XML - - - Register description not found - - - Node type <nodeType> not implemented (<node>) - - - XML element <element> not supported (<node>) - - - Entry <enumEntry> not found (<node>) - - - Invalid boolean value <value> (<node>) - - - Invalid enumeration integer value <value> (<node>) - - - Invalid enumeration value <value> (<node>) - - - Entry <value> is not available (<node>) - - - Invalid node name (<name>) - - - Invalid selector (<node>) - - - Unknown property <property> (<node>) - - - Property <property> not defined (<node>) - - - Error while evaluating <node> (<message>) - - - Could not parse <value> (<node>) - - - Unknown value <value> while parsing <name> (<node>) - - - Cannot coerce <node> to integer - - - Cannot coerce <node> to float - - - Cannot coerce <node> to string - - - Cannot coerce <node> to boolean - - - Cannot coerce <node> to command - - - Cannot coerce <node> to enumeration - - - Cannot coerce <node> from integer - - - Cannot coerce <node> from float - - - Cannot coerce <node> from string - - - Cannot coerce <node> from boolean - - - Cannot coerce <node> from command - - - Cannot coerce <node> from enumeration - - - An unknown error occurred (<node>) - - - Invalid match syntax (<node>) - - - Invalid argument (<node>) - - - Unknown configuration (<name>) - - - Bad configuration type (<name>) - - - <node> cannot be smaller than <value> - - - <node> cannot be greater than <value> - - - <node> has invalid increment value <value> - - - <node> cannot be smaller than <value> - - - <node> cannot be greater than <value> - - - <node> not in line with increment value <value> - - - Variable already exists (<variable>) - - - Invalid variable name (<variable>) - - - Overflow in float-to-integer conversion of <value> (<node>) - - - An internal exception occurred (<message>) - - - An internal exception occurred (<node>: <message>) - - - <message> (<node>) - - - Maximum recursion depth exceeded - - - Genapi error parameter type - - - Genapi error parameter type string - - - Genapi error parameter type integer - - - Genapi error parameter type float - - - Genapi ui callback ret code - - - The host (user) completed the current UI operation successfully - - - The host (user) canceled the current UI operation - - - The UI operation is not implemented by the host - - - The host operation failed and the script should terminate - - - - A Recorder object that encapsulates a recorder handle - (cf. RECORDER_HANDLE of the C/C++ interface) - and exposes higher level recorder functions; the destructor takes care of - closing the recorder when the object goes out of scope - - - - - Finalizer - - - - - Close the recorder using the given close mode - - Recorder close mode - - - - Close the recorder using the mode defined when the recorder was created - - - - - Set a recorder object parameter string value - - The identifier of the parameter to set - The new string value of the parameter - - - - Get a recorder object parameter string value - - The identifier of the parameter to get - The parameter value - - - - Set a recorder object parameter integer value - - The identifier of the parameter to set - The new integer value of the parameter - - - - Get a recorder object parameter integer value - - The identifier of the parameter to get - The current integer value of the parameter - - - - Set a recorder object parameter value - - The parameter value type - - if T is an integer type or the bool type: the value will be converted to a long and the parameter will be set - if T is the string type: the string parameter value will be set - - - The identifier of the parameter to set - The new value of the parameter - - Using an unsupported type will throw an - - - - - Get a recorder object parameter value - - The return value type - - if T is an integer type or the bool type: the long parameter value will be queried and converted to the return type - if T is the string type: the string parameter value will be queried and returned - - - The identifier of the parameter to get - The current value of the parameter - - Using an unsupported type will throw an - - - - - Read the record at the current RECORD_INDEX position from a recorder container opened in read mode - - - The function reads the buffer info and data of the record at the position defined by the parameter RECORD_INDEX - - When buffer is null: the recorder index is not changed - When buffer is not null: the recorder index is automatically set to the next record after a successful read - - - Optional output buffer where record buffer data will be written - Size of output buffer - Record buffer info - - - When buffer is null: record buffer size (cf. ) - When buffer is not null: size of read data - - - - - - Read the record at the current RECORD_INDEX position from a recorder container opened in read mode - - Note: the recorder index is automatically set to the next record after a successful read - Record buffer info - Record buffer data - - - - Read metadata of the record at the current RECORD_INDEX position from a recorder container opened in read mode - - Note: the recorder index is NOT automatically set to the next record after a successful read. - Record buffer metadata - - - - Write buffer info and data to a recorder container opened in write or append mode - - - Note: the buffer info and data are written to the container at the current - RECORD_INDEX position; - the recorder index is automatically incremented by one after a write and the - RECORD_COUNT is also adapted accordingly - - The buffer info to write to the container - The buffer data to write to the container - - - - Write buffer info and data to a recorder container opened in write or append mode - - - Note: the buffer info and data are written to the container at the current - RECORD_INDEX position; - the recorder index is automatically incremented by one after a write and the - RECORD_COUNT is also adapted accordingly - - The buffer info to write to the container - The buffer data to write to the container; if the - length is smaller than .size, an - will be thrown - - - - - Write an EGrabber buffer to a recorder container opened in write or append mode - - - The buffer info and data are written to the container at the current - RECORD_INDEX position; - the recorder index is automatically incremented by one after a write and the - RECORD_COUNT is also adapted accordingly - - The buffer to write to the container (info commands will be queried to prepare the RecorderBufferInfo entry and to get the data pointer) - Optional user data (that will be set to RecorderBufferInfo.userdata) - Optional UTC timestamp (that will be set to RecorderBufferInfo.utc) - - if 0, read will return buffer timestamp converted to UTC using the synchronized timestamps of the buffer chapter - if not 0, read will return the written value - - - The buffer info written to the container - - - - Write an EGrabber scoped buffer to a recorder container opened in write or append mode - - - The buffer info and data are written to the container at the current - RECORD_INDEX position; - the recorder index is automatically incremented by one after a write and the - RECORD_COUNT is also adapted accordingly - - The buffer to write to the container (info commands will be queried to prepare the RecorderBufferInfo entry and to get the data pointer) - Optional user data (that will be set to RecorderBufferInfo.userdata) - Optional UTC timestamp (that will be set to RecorderBufferInfo.utc) - - if 0, read will return buffer timestamp converted to UTC using the synchronized timestamps of the buffer chapter - if not 0, read will return the written value - - - The buffer info written to the container - - - - Export a range of recorded images to files. The container must be opened in read mode - - - Export starts at the current RECORD_INDEX - in the container and goes on until records have been exported or the - end of the container is reached, the RECORD_INDEX - is updated accordingly.
    - The destination can be either an actual path or a - template path containing place holder characters (please see the parameter description for details).
    - The output file format is automatically derived from the file extenion, which - can be - - .tiff or .tif for the TIFF file format - .mkv for the Matroska MKV file format (using the V_UNCOMPRESSED codec) - - If the path does not have an extension, an exception is thrown.

    - For TIFF files:
    - If is greater than 1 and path does not contain any @ pattern, - we add .@n before the file extension;
    - If a record contains more than one part and the path does not contain the @p pattern, - we add .@p before the file extension.

    - For MKV files:
    - The export operation creates one MKV file per chapter; if the export operation spans - several chapters, we add @.n automatically before the file extension.
    - The image width, height and pixel format must be constant for the entire file. - The first exported image is used to define these values.
    - A subsequent image with a different format will be simply skipped and the returned count will not be updated.
    - Timestamps increase monotonically; when a backward discontinuity is detected (i.e. the - relative time from the beginning of the file of the image to be
    - written is less than the relative time of the latest image written), a new time reference is taken.

    - Records containing Bayer formats are converted using the decoding method defined by the - parameter BAYER_DECODING_METHOD.

    - - The following example will output 10 files (image0.tif, ..., image9.tif) if the container contains - at least 10 records (one part per record) from the current index: - - recorder.Export("image@n.tif", 10); - - -
    - The path template of the exported files. It can contain decorations starting with the character @, used as a place holders with the following meanings: - - @i for the index relative to the first record in the container - (number of digits used is defined by the number of records in the container) - @n for the index relative to the current record written - (number of digits used is defined by the count parameter) - @p for the part index relative to the record - (number of digits used is defined by the buffer part count of the record) - @t for the timestamp value in of the exported record - @c for the chapter index - @C for the chapter name - @@ for the literal @ - - All other @ patterns are invalid and will raise an InvalidArgument exception. - - The number of records to export - - The pixel format of the exported file; or 0 to disable image conversions and keep the original pixel format. - The allowed values depend on the file type - - TIFF file format: Mono8, Mono16, RGB8, RGB16 - MKV file format: Mono8, RGB8 - - - The number of exported records. - Most of the times, a record contains one image (one buffer part) so the number of exported - images matches the number of exported records; but, if a record contains more than one part, - each part is exported as a separate image so the number of exported images will be greater - than the returned value. - - -
    - - - Export a range of recorded images to files with progress information. The container must be opened in read mode - - - Please refer to the documentation of the method Export for the details. - - The path template of the exported files - The number of records to export - The pixel format of the exported file - The progress callback that is called before exporting each buffer to inform about the progress - - if the callback returns true, the export continues with the next buffer; - if the callback returns false, the export stops and raises the Aborted exception - - Please note that the return value of the callback in the C++ API is an integer (the export continues as long as the callback - returns 0); In the .NET API, using a bool with the value true is more conventional to report a success or - to continue an operation. - - progress context passed to progress callback - The number of exported records - - - - Start a new chapter. The container must be in write mode. - - - A chapter helps grouping recordings and provides a synchronization point between system and UTC timestamps.

    - A chapter is automatically created if needed on the first write after opening the container if - this function has not been called.
    - The name of the automatically created chapter is Chapter<xx> - where <xx> is the index of the new chapter.

    - It is allowed to call this method at any time to signal a time discontinuity or start a new group - of recordings.
    - The newly created chapter becomes the current chapter and the RECORDER_CHAPTER_XXXX parameters - are updated accordingly.

    - When a chapter is created, a synchronized pair of system/UTC timestamps is captured and stored - in the storage as
    - CHAPTER_TIMESTAMP and CHAPTER_UTC; - the system time timestamp is expressed in nanoseconds since the computer booted.

    - When reading back from a container, the pair of synchronized timestamps of the corresponding chapter - is used internally
    to compute the value of the (non-zero) utc field of a record - from the value of the (system) timestamp field. -
    - Optional name of the new chapter. The name must comply with the following rules: - - It must match the regular expression [A-Za-z_][-A-Za-z0-9_ ]* - Its length cannot exceed 255 characters - It must be unique within the container - It cannot be like a default chapter name (i.e. Chapter[0-9]+) unless it matches - the default name it would get automatically - - - Optional chapter user information -
    - - - Close the recorder if needed - - - - - The container format version (cf. DATABASE_VERSION) - - - - - Buffer information for read and write operations - - - - - buffer size (in bytes) - - - - - buffer pitch in bytes (size of a line including padding) - - - - - buffer width (number of pixels in a line) - - - - - delivered height (e.g. BUFFER_INFO_DELIVERED_IMAGEHEIGHT) - - - - - buffer pixel format (GenICam PFNC 32-bit value) - - - - - fixed maximum number of parts in the buffer - - - - - buffer timestamp, expressed in nanoseconds since the computer booted (e.g. BUFFER_INFO_TIMESTAMP_NS) - - - - - any buffer specific user data - - - - - UTC timestamp (if 0 when written, read will return buffer timestamp converted to UTC using the synchronized timestamps of the buffer chapter) - - - - - chapter index; Chapter0 always exists for legacy recordings (set by the library) - - - - - size of each buffer part (if 0 when written, read will return (size / partCount) - - - - - The recorder library cannot be loaded due to a missing dependency - - - - - RecorderError base - - - - - Get the error status code (cf. ) - - - - - The recorder library is not initialized - - - - - An unknown error has occurred - - - - - The recorder parameter is unknown - - - - - The recorder parameter type is invalid - - - - - The recorder parameter value is invalid - - - - - The destination buffer is too small - - - - - The recorder parameter is read-only - - - - - A system error has occurred - - - - - The specified container path is invalid - - - - - The container data file is full - - - - - The operation is not allowed by the recorder open mode - - - - - The RECORD_INDEX value is out of range - - - - - The internal meta-data of the current record is invalid (partial read) - - - - - The internal meta-data size of the container is invalid (partial read or invalid meta-data file size) - - - - - The given container is not supported by the recorder library - - - - - The internal meta-data header of the container is invalid - - - - - Some data was not completely written to disk (partial write) - - - - - The record handle is invalid - - - - - The resource is already in use - - - - - There is no more record to read in the container - - - - - The path does not contain a container and read-only access is required - - - - - A given argument is invalid - - - - - An error occurred in the license manager, please contact Euresys support - - - - - There is no valid license for this library, please contact Euresys support - - - - - An image conversion error has occurred - - - - - The image format is not supported by the export file - - - - - The current operation has been aborted by the user - - - - - A read operation returned an invalid size (partial read or invalid data file size) - - - - - The chapter name has an invalid character - - - - - The chapter name conflicts with a reserved name - - - - - The chapter name is already used - - - - - The chapter name is too long - - - - - A Recorder library object that loads and unloads the Recorder Library - - - - - Initialize the recorder library - - - - - Finalizer - - - - - Close the recorder library - - - - - Create a Recorder object - - path to the recorder container to open - the operation mode of the recorder - specifies how the recorder container is closed - - if mode is TRIM, the recorder container is reduced to the smallest size that fits the container contents - if mode is KEEP, the recorder container size is unchanged - if the flag DONT_TRIM_CHAPTERS is added to the mode, the trailing chapters will be kept even if they are empty; - by default, trailing empty chapters are removed - - - The created object - - - - EGrabber Recorder error codes - - - - - The operation completed successfully - - - - - The recorder library is not initialized - - - - - An unknown error has occurred - - - - - The recorder parameter is unknown - - - - - The recorder parameter type is invalid - - - - - The recorder parameter value is invalid - - - - - The destination buffer is too small - - - - - The recorder parameter is read-only - - - - - A system error has occurred - - - - - The specified container path is invalid - - - - - The container data file is full - - - - - The operation is not allowed by the recorder open mode - - - - - The RECORD_INDEX value is out of range - - - - - The internal meta-data of the current record is invalid (partial read) - - - - - The internal meta-data size of the container is invalid (partial read or invalid meta-data file size) - - - - - The given container is not supported by the recorder library - - - - - The internal meta-data header of the container is invalid - - - - - Some data was not completely written to disk (partial write) - - - - - The record handle is invalid - - - - - The resource is already in use - - - - - There is no more record to read in the container - - - - - The path does not contain a container and read only access is required - - - - - A given argument is invalid - - - - - An error occurred in the license manager, please contact Euresys support - - - - - There is no valid license for this library, please contact Euresys support - - - - - An image conversion error has occurred - - - - - The image format is not supported by the export file - - - - - The current operation has been aborted by the user - - - - - A read operation returned an invalid size (partial read or invalid data file size) - - - - - The chapter name has an invalid character - - - - - The chapter name conflicts with a reserved name - - - - - The chapter name is already used - - - - - The chapter name is too long - - - - - EGrabber Recorder parameters - - - - - Recorder library version - - - - - Recorder container size - - - - - Current recorder index position - - - - - Number of records in the recorder container - - - - - Space left on the same disk as the recorder container - - - - - Buffer alignment recommended for best write performance on recorder storage disk, changing the value should be done with extreme caution (set 0 for default value) - - - - - Format version of recorder container - - - - - Space left in the recorder container - - - - - Number of chapters in the container (read only) - - - - - Chapter selector - - - - - Index of record in the current chapter - - - - - Number of records in the current chapter (read only) - - - - - Chapter UTC time (UTC value of synchronized pair of timestamps for the current chapter, cf. RecorderStartChapter) (read only) - - - - - Chapter timestamp (system value of synchronized pair of timestamps for the current chapter, cf. Recorder.StartChapter) (read only) - - - - - Chapter name - - - - - Chapter user info - - - - - Decoding method to use when Bayer format is converted (default is METHOD_1) - - - - - Recorder library license status, cf. - - - - - Number of retries for partial I/O operations (read/write) before raising invalid data length errors (default is 1) - - - - - EGrabber Recorder open modes (cf. RecorderLibrary.OpenRecorder) - - - - - Open a new or an existing (to overwrite) recorder in write mode (record index set to 0) - - - - - Open an existing recorder in read mode (record index set to 0) - - - - - Open an existing recorder in append mode (record index set to record count) - - - - - EGrabber Recorder close modes (cf. Recorder.Close, RecorderLibrary.OpenRecorder) - - - - - Trim the recorder container size when closing the recorder - - - - - Keep the current recorder container size when closing the recorder - - - - - Keep the trailing chapters even if they are empty (can be combined with trim or keep) - - - - - EGrabber Recorder progress callback states - - - - - An operation is starting, index and count are not set - - - - - An operation is ongoing, index and count are set according to the current progress - - - - - An operation is ending (successfully or not), index and count are not set - - - - - EGrabber Recorder Bayer decoding methods - - - - - Bayer decoding disabled, content is interpreted as Mono - - - - - Bayer decoding method 1 (3x3 interpolation, a.k.a. legacy method) - - - - - Bayer decoding method 2 (3x3 median-based interpolation, a.k.a. advanced method) - - - - - Bayer decoding method 3 (5x5 gradient-based interpolation) - - - - - Bayer decoding method 5 (2x2 average-based interpolation) - - - - GenICam PFNC 32-bit values (including Euresys Custom values) - - - Monochrome 1-bit packed - - - Monochrome 2-bit packed - - - Monochrome 4-bit packed - - - Monochrome 8-bit - - - Monochrome 8-bit signed - - - Monochrome 10-bit unpacked - - - Monochrome 10-bit packed - - - Monochrome 12-bit unpacked - - - Monochrome 12-bit packed - - - Monochrome 14-bit unpacked - - - Monochrome 14-bit packed - - - Monochrome 16-bit - - - Monochrome 32-bit - - - Bayer Blue-Green 4-bit packed - - - Bayer Blue-Green 8-bit - - - Bayer Blue-Green 10-bit unpacked - - - Bayer Blue-Green 10-bit packed - - - Bayer Blue-Green 12-bit unpacked - - - Bayer Blue-Green 12-bit packed - - - Bayer Blue-Green 14-bit - - - Bayer Blue-Green 14-bit packed - - - Bayer Blue-Green 16-bit - - - Bayer Green-Blue 4-bit packed - - - Bayer Green-Blue 8-bit - - - Bayer Green-Blue 10-bit unpacked - - - Bayer Green-Blue 10-bit packed - - - Bayer Green-Blue 12-bit unpacked - - - Bayer Green-Blue 12-bit packed - - - Bayer Green-Blue 14-bit - - - Bayer Green-Blue 14-bit packed - - - Bayer Green-Blue 16-bit - - - Bayer Green-Red 4-bit packed - - - Bayer Green-Red 8-bit - - - Bayer Green-Red 10-bit unpacked - - - Bayer Green-Red 10-bit packed - - - Bayer Green-Red 12-bit unpacked - - - Bayer Green-Red 12-bit packed - - - Bayer Green-Red 14-bit - - - Bayer Green-Red 14-bit packed - - - Bayer Green-Red 16-bit - - - Bayer Red-Green 4-bit packed - - - Bayer Red-Green 8-bit - - - Bayer Red-Green 10-bit unpacked - - - Bayer Red-Green 10-bit packed - - - Bayer Red-Green 12-bit unpacked - - - Bayer Red-Green 12-bit packed - - - Bayer Red-Green 14-bit - - - Bayer Red-Green 14-bit packed - - - Bayer Red-Green 16-bit - - - Red-Green-Blue-alpha 8-bit - - - Red-Green-Blue-alpha 10-bit unpacked - - - Red-Green-Blue-alpha 10-bit packed - - - Red-Green-Blue-alpha 12-bit unpacked - - - Red-Green-Blue-alpha 12-bit packed - - - Red-Green-Blue-alpha 14-bit unpacked - - - Red-Green-Blue-alpha 16-bit - - - Red-Green-Blue 8-bit - - - Red-Green-Blue 8-bit planar - - - Red-Green-Blue 10-bit unpacked - - - Red-Green-Blue 10-bit unpacked planar - - - Red-Green-Blue 10-bit packed - - - Red-Green-Blue 10-bit packed into 32-bit - - - Red-Green-Blue 12-bit unpacked - - - Red-Green-Blue 12-bit unpacked planar - - - Red-Green-Blue 12-bit packed - - - Red-Green-Blue 14-bit unpacked - - - Red-Green-Blue 16-bit - - - Red-Green-Blue 16-bit planar - - - Red-Green-Blue 5/6/5-bit packed - - - Blue-Green-Red-alpha 8-bit - - - Blue-Green-Red-alpha 10-bit unpacked - - - Blue-Green-Red-alpha 10-bit packed - - - Blue-Green-Red-alpha 12-bit unpacked - - - Blue-Green-Red-alpha 12-bit packed - - - Blue-Green-Red-alpha 14-bit unpacked - - - Blue-Green-Red-alpha 16-bit - - - Blue-Green-Red 8-bit - - - Blue-Green-Red 10-bit unpacked - - - Blue-Green-Red 10-bit packed - - - Blue-Green-Red 12-bit unpacked - - - Blue-Green-Red 12-bit packed - - - Blue-Green-Red 14-bit unpacked - - - Blue-Green-Red 16-bit - - - Blue-Green-Red 5/6/5-bit packed - - - Red 8-bit - - - Red 10-bit - - - Red 12-bit - - - Red 16-bit - - - Green 8-bit - - - Green 10-bit - - - Green 12-bit - - - Green 16-bit - - - Blue 8-bit - - - Blue 10-bit - - - Blue 12-bit - - - Blue 16-bit - - - 3D coordinate A-B-C 8-bit - - - 3D coordinate A-B-C 8-bit planar - - - 3D coordinate A-B-C 10-bit packed - - - 3D coordinate A-B-C 10-bit packed planar - - - 3D coordinate A-B-C 12-bit packed - - - 3D coordinate A-B-C 12-bit packed planar - - - 3D coordinate A-B-C 16-bit - - - 3D coordinate A-B-C 16-bit planar - - - 3D coordinate A-B-C 32-bit floating point - - - 3D coordinate A-B-C 32-bit floating point planar - - - 3D coordinate A-C 8-bit - - - 3D coordinate A-C 8-bit planar - - - 3D coordinate A-C 10-bit packed - - - 3D coordinate A-C 10-bit packed planar - - - 3D coordinate A-C 12-bit packed - - - 3D coordinate A-C 12-bit packed planar - - - 3D coordinate A-C 16-bit - - - 3D coordinate A-C 16-bit planar - - - 3D coordinate A-C 32-bit floating point - - - 3D coordinate A-C 32-bit floating point planar - - - 3D coordinate A 8-bit - - - 3D coordinate A 10-bit packed - - - 3D coordinate A 12-bit packed - - - 3D coordinate A 16-bit - - - 3D coordinate A 32-bit floating point - - - 3D coordinate B 8-bit - - - 3D coordinate B 10-bit packed - - - 3D coordinate B 12-bit packed - - - 3D coordinate B 16-bit - - - 3D coordinate B 32-bit floating point - - - 3D coordinate C 8-bit - - - 3D coordinate C 10-bit packed - - - 3D coordinate C 12-bit packed - - - 3D coordinate C 16-bit - - - 3D coordinate C 32-bit floating point - - - Confidence 1-bit unpacked - - - Confidence 1-bit packed - - - Confidence 8-bit - - - Confidence 16-bit - - - Confidence 32-bit floating point - - - Bi-color Blue/Green - Red/Green 8-bit - - - Bi-color Blue/Green - Red/Green 10-bit unpacked - - - Bi-color Blue/Green - Red/Green 10-bit packed - - - Bi-color Blue/Green - Red/Green 12-bit unpacked - - - Bi-color Blue/Green - Red/Green 12-bit packed - - - Bi-color Red/Green - Blue/Green 8-bit - - - Bi-color Red/Green - Blue/Green 10-bit unpacked - - - Bi-color Red/Green - Blue/Green 10-bit packed - - - Bi-color Red/Green - Blue/Green 12-bit unpacked - - - Bi-color Red/Green - Blue/Green 12-bit packed - - - Sparse Color Filter #1 White-Blue-White-Green 8-bit - - - Sparse Color Filter #1 White-Blue-White-Green 10-bit unpacked - - - Sparse Color Filter #1 White-Blue-White-Green 10-bit packed - - - Sparse Color Filter #1 White-Blue-White-Green 12-bit unpacked - - - Sparse Color Filter #1 White-Blue-White-Green 12-bit packed - - - Sparse Color Filter #1 White-Blue-White-Green 14-bit unpacked - - - Sparse Color Filter #1 White-Blue-White-Green 16-bit unpacked - - - Sparse Color Filter #1 White-Green-White-Blue 8-bit - - - Sparse Color Filter #1 White-Green-White-Blue 10-bit unpacked - - - Sparse Color Filter #1 White-Green-White-Blue 10-bit packed - - - Sparse Color Filter #1 White-Green-White-Blue 12-bit unpacked - - - Sparse Color Filter #1 White-Green-White-Blue 12-bit packed - - - Sparse Color Filter #1 White-Green-White-Blue 14-bit unpacked - - - Sparse Color Filter #1 White-Green-White-Blue 16-bit - - - Sparse Color Filter #1 White-Green-White-Red 8-bit - - - Sparse Color Filter #1 White-Green-White-Red 10-bit unpacked - - - Sparse Color Filter #1 White-Green-White-Red 10-bit packed - - - Sparse Color Filter #1 White-Green-White-Red 12-bit unpacked - - - Sparse Color Filter #1 White-Green-White-Red 12-bit packed - - - Sparse Color Filter #1 White-Green-White-Red 14-bit unpacked - - - Sparse Color Filter #1 White-Green-White-Red 16-bit - - - Sparse Color Filter #1 White-Red-White-Green 8-bit - - - Sparse Color Filter #1 White-Red-White-Green 10-bit unpacked - - - Sparse Color Filter #1 White-Red-White-Green 10-bit packed - - - Sparse Color Filter #1 White-Red-White-Green 12-bit unpacked - - - Sparse Color Filter #1 White-Red-White-Green 12-bit packed - - - Sparse Color Filter #1 White-Red-White-Green 14-bit unpacked - - - Sparse Color Filter #1 White-Red-White-Green 16-bit - - - YCbCr 4:4:4 8-bit - - - YCbCr 4:4:4 8-bit - - - YCbCr 4:4:4 10-bit unpacked - - - YCbCr 4:4:4 10-bit packed - - - YCbCr 4:4:4 12-bit unpacked - - - YCbCr 4:4:4 12-bit packed - - - YCbCr 4:1:1 8-bit - - - YCbCr 4:1:1 8-bit - - - YCbCr 4:2:0 8-bit YY/CbCr Semiplanar - - - YCbCr 4:2:0 8-bit YY/CrCb Semiplanar - - - YCbCr 4:2:2 8-bit - - - YCbCr 4:2:2 8-bit - - - YCbCr 4:2:2 8-bit YY/CbCr Semiplanar - - - YCbCr 4:2:2 8-bit YY/CrCb Semiplanar - - - YCbCr 4:2:2 10-bit unpacked - - - YCbCr 4:2:2 10-bit unpacked - - - YCbCr 4:2:2 10-bit packed - - - YCbCr 4:2:2 10-bit packed - - - YCbCr 4:2:2 12-bit unpacked - - - YCbCr 4:2:2 12-bit unpacked - - - YCbCr 4:2:2 12-bit packed - - - YCbCr 4:2:2 12-bit packed - - - YCbCr 4:4:4 8-bit BT.601 - - - YCbCr 4:4:4 10-bit unpacked BT.601 - - - YCbCr 4:4:4 10-bit packed BT.601 - - - YCbCr 4:4:4 12-bit unpacked BT.601 - - - YCbCr 4:4:4 12-bit packed BT.601 - - - YCbCr 4:1:1 8-bit BT.601 - - - YCbCr 4:2:2 8-bit BT.601 - - - YCbCr 4:2:2 8-bit BT.601 - - - YCbCr 4:2:2 10-bit unpacked BT.601 - - - YCbCr 4:2:2 10-bit unpacked BT.601 - - - YCbCr 4:2:2 10-bit packed BT.601 - - - YCbCr 4:2:2 10-bit packed BT.601 - - - YCbCr 4:2:2 12-bit unpacked BT.601 - - - YCbCr 4:2:2 12-bit unpacked BT.601 - - - YCbCr 4:2:2 12-bit packed BT.601 - - - YCbCr 4:2:2 12-bit packed BT.601 - - - YCbCr 4:4:4 8-bit BT.709 - - - YCbCr 4:4:4 10-bit unpacked BT.709 - - - YCbCr 4:4:4 10-bit packed BT.709 - - - YCbCr 4:4:4 12-bit unpacked BT.709 - - - YCbCr 4:4:4 12-bit packed BT.709 - - - YCbCr 4:1:1 8-bit BT.709 - - - YCbCr 4:2:2 8-bit BT.709 - - - YCbCr 4:2:2 8-bit BT.709 - - - YCbCr 4:2:2 10-bit unpacked BT.709 - - - YCbCr 4:2:2 10-bit unpacked BT.709 - - - YCbCr 4:2:2 10-bit packed BT.709 - - - YCbCr 4:2:2 10-bit packed BT.709 - - - YCbCr 4:2:2 12-bit unpacked BT.709 - - - YCbCr 4:2:2 12-bit unpacked BT.709 - - - YCbCr 4:2:2 12-bit packed BT.709 - - - YCbCr 4:2:2 12-bit packed BT.709 - - - YCbCr 4:4:4 8-bit BT.2020 - - - YCbCr 4:4:4 10-bit unpacked BT.2020 - - - YCbCr 4:4:4 10-bit packed BT.2020 - - - YCbCr 4:4:4 12-bit unpacked BT.2020 - - - YCbCr 4:4:4 12-bit packed BT.2020 - - - YCbCr 4:1:1 8-bit BT.2020 - - - YCbCr 4:2:2 8-bit BT.2020 - - - YCbCr 4:2:2 8-bit BT.2020 - - - YCbCr 4:2:2 10-bit unpacked BT.2020 - - - YCbCr 4:2:2 10-bit unpacked BT.2020 - - - YCbCr 4:2:2 10-bit packed BT.2020 - - - YCbCr 4:2:2 10-bit packed BT.2020 - - - YCbCr 4:2:2 12-bit unpacked BT.2020 - - - YCbCr 4:2:2 12-bit unpacked BT.2020 - - - YCbCr 4:2:2 12-bit packed BT.2020 - - - YCbCr 4:2:2 12-bit packed BT.2020 - - - YUV 4:4:4 8-bit - - - YUV 4:1:1 8-bit - - - YUV 4:2:2 8-bit - - - YUV 4:2:2 8-bit - - - Bayer Green-Red 14-bit unpacked - - - Bayer Red-Green 14-bit unpacked - - - Bayer Green-Blue 14-bit unpacked - - - Bayer Blue-Green 14-bit unpacked - - - Red-Green-Blue 8-bit unpacked aligned to 32-bit - - - Blue-Green-Red 8-bit unpacked aligned to 32-bit - - - JPEG file interchange format - - - YUV 422 8 bit (Deprecated, use YUV422_8_UYVY) - - - CoaXPress PixelF 16-bit values - - - Bayer Blue-Green 8-bit - - - Bayer Blue-Green 10-bit msb packed - - - Bayer Blue-Green 12-bit msb packed - - - Bayer Blue-Green 14-bit msb packed - - - Bayer Blue-Green 16-bit - - - Bayer Green-Blue 8-bit - - - Bayer Green-Blue 10-bit msb packed - - - Bayer Green-Blue 12-bit msb packed - - - Bayer Green-Blue 14-bit msb packed - - - Bayer Green-Blue 16-bit - - - Bayer Green-Red 8-bit - - - Bayer Green-Red 10-bit msb packed - - - Bayer Green-Red 12-bit msb packed - - - Bayer Green-Red 14-bit msb packed - - - Bayer Green-Red 16-bit - - - Bayer Red-Green 8-bit - - - Bayer Red-Green 10-bit msb packed - - - Bayer Red-Green 12-bit msb packed - - - Bayer Red-Green 14-bit msb packed - - - Bayer Red-Green 16-bit - - - Monochrome 8-bit - - - Monochrome 10-bit msb packed - - - Monochrome 12-bit msb packed - - - Monochrome 14-bit msb packed - - - Monochrome 16-bit - - - Red-Green-Blue 8-bit - - - Red-Green-Blue 10-bit msb packed - - - Red-Green-Blue 12-bit msb packed - - - Red-Green-Blue 14-bit msb packed - - - Red-Green-Blue 16-bit - - - Red-Green-Blue-alpha 8-bit - - - Red-Green-Blue-alpha 10-bit msb packed - - - Red-Green-Blue-alpha 12-bit msb packed - - - Red-Green-Blue-alpha 14-bit msb packed - - - Red-Green-Blue-alpha 16-bit - - - YCbCr 4:1:1 8-bit BT.601 - - - YCbCr 4:1:1 10-bit msb packed BT.601 - - - YCbCr 4:1:1 12-bit msb packed BT.601 - - - YCbCr 4:1:1 14-bit msb packed BT.601 - - - YCbCr 4:1:1 16-bit BT.601 - - - YCbCr 4:2:2 8-bit BT.601 - - - YCbCr 4:2:2 10-bit msb packed BT.601 - - - YCbCr 4:2:2 12-bit msb packed BT.601 - - - YCbCr 4:2:2 14-bit msb packed BT.601 - - - YCbCr 4:2:2 16-bit BT.601 - - - YCbCr 4:4:4 8-bit BT.601 - - - YCbCr 4:4:4 10-bit msb packed BT.601 - - - YCbCr 4:4:4 12-bit msb packed BT.601 - - - YCbCr 4:4:4 14-bit msb packed BT.601 - - - YCbCr 4:4:4 16-bit BT.601 - - - YCbCr 4:1:1 8-bit BT.709 - - - YCbCr 4:1:1 10-bit msb packed BT.709 - - - YCbCr 4:1:1 12-bit msb packed BT.709 - - - YCbCr 4:1:1 14-bit msb packed BT.709 - - - YCbCr 4:1:1 16-bit BT.709 - - - YCbCr 4:2:2 8-bit BT.709 - - - YCbCr 4:2:2 10-bit msb packed BT.709 - - - YCbCr 4:2:2 12-bit msb packed BT.709 - - - YCbCr 4:2:2 14-bit msb packed BT.709 - - - YCbCr 4:2:2 16-bit BT.709 - - - YCbCr 4:4:4 8-bit BT.709 - - - YCbCr 4:4:4 10-bit msb packed BT.709 - - - YCbCr 4:4:4 12-bit msb packed BT.709 - - - YCbCr 4:4:4 14-bit msb packed BT.709 - - - YCbCr 4:4:4 16-bit BT.709 - - - YUV 4:1:1 8-bit - - - YUV 4:1:1 10-bit msb packed - - - YUV 4:1:1 12-bit msb packed - - - YUV 4:1:1 14-bit msb packed - - - YUV 4:1:1 16-bit - - - YUV 4:2:2 8-bit - - - YUV 4:2:2 10-bit msb packed - - - YUV 4:2:2 12-bit msb packed - - - YUV 4:2:2 14-bit msb packed - - - YUV 4:2:2 16-bit - - - YUV 4:4:4 8-bit - - - YUV 4:4:4 10-bit msb packed - - - YUV 4:4:4 12-bit msb packed - - - YUV 4:4:4 14-bit msb packed - - - YUV 4:4:4 16-bit - -
    -
    diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/EzBasicAxl.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/EzBasicAxl.dll deleted file mode 100644 index 700a482..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/EzBasicAxl.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/GrabberIF.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/GrabberIF.dll deleted file mode 100644 index dd769d9..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/GrabberIF.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/GrabberIFCli.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/GrabberIFCli.dll deleted file mode 100644 index 50847cd..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/GrabberIFCli.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/acyclic.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/acyclic.exe deleted file mode 100644 index fbfb438..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/acyclic.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/bcomps.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/bcomps.exe deleted file mode 100644 index 1baaaed..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/bcomps.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/cairo.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/cairo.dll deleted file mode 100644 index 9338a00..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/cairo.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/ccomps.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/ccomps.exe deleted file mode 100644 index ab3a50d..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/ccomps.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/cdt.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/cdt.dll deleted file mode 100644 index 355adf8..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/cdt.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/cgraph.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/cgraph.dll deleted file mode 100644 index b236582..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/cgraph.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/circo.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/circo.exe deleted file mode 100644 index 99c2706..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/circo.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/concrt140.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/concrt140.dll deleted file mode 100644 index 16e776f..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/concrt140.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/config6 b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/config6 deleted file mode 100644 index 8aee69f..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/config6 +++ /dev/null @@ -1,226 +0,0 @@ -# This file was generated by "dot -c" at time of install. - -# You may temporarily disable a plugin by removing or commenting out -# a line in this file, or you can modify its "quality" value to affect -# default plugin selection. - -# Manual edits to this file **will be lost** on upgrade. - -gvplugin_core.dll core { - device { - dot:dot 1 - gv:dot 1 - canon:dot 1 - plain:dot 1 - plain-ext:dot 1 - xdot:xdot 1 - xdot1.2:xdot 1 - xdot1.4:xdot 1 - } - device { - fig:fig 1 - } - device { - ismap:map 1 - cmap:map 1 - imap:map 1 - cmapx:map 1 - imap_np:map 1 - cmapx_np:map 1 - } - device { - mp:mp -1 - } - device { - ps:ps 1 - ps2:ps 1 - eps:ps 1 - } - device { - svg:svg 1 - } - device { - json:json 1 - json0:json 1 - dot_json:json 1 - xdot_json:json 1 - } - device { - tk:tk 1 - } - device { - vml:vml 1 - } - device { - pic:pic -1 - } - device { - pov:pov 1 - } - render { - dot 1 - xdot 1 - } - render { - fig 1 - } - render { - map 1 - } - render { - mp -1 - } - render { - ps 1 - } - render { - svg 1 - } - render { - json 1 - json0 1 - dot_json 1 - xdot_json 1 - } - render { - tk 1 - } - render { - vml 1 - } - render { - pic -1 - } - render { - pov 1 - } - loadimage { - png:svg 1 - gif:svg 1 - jpeg:svg 1 - jpe:svg 1 - jpg:svg 1 - png:fig 1 - gif:fig 1 - jpeg:fig 1 - jpe:fig 1 - jpg:fig 1 -#FAILS png:vrml 1 -#FAILS gif:vrml 1 -#FAILS jpeg:vrml 1 -#FAILS jpe:vrml 1 -#FAILS jpg:vrml 1 - eps:ps 1 - ps:ps 1 - (lib):ps 1 - png:map 1 - gif:map 1 - jpeg:map 1 - jpe:map 1 - jpg:map 1 - ps:map 1 - eps:map 1 - svg:map 1 - png:dot 1 - gif:dot 1 - jpeg:dot 1 - jpe:dot 1 - jpg:dot 1 - ps:dot 1 - eps:dot 1 - svg:dot 1 - png:xdot 1 - gif:xdot 1 - jpeg:xdot 1 - jpe:xdot 1 - jpg:xdot 1 - ps:xdot 1 - eps:xdot 1 - svg:xdot 1 - svg:svg 1 - png:vml 1 - gif:vml 1 - jpeg:vml 1 - jpe:vml 1 - jpg:vml 1 - gif:tk 1 - } -} -gvplugin_dot_layout.dll dot_layout { - layout { - dot 0 - } -} -gvplugin_gdiplus.dll gdiplus { - render { - gdiplus 1 - } - textlayout { - textlayout 8 - } - loadimage { - bmp:gdiplus 8 - gif:gdiplus 8 - jpe:gdiplus 8 - jpeg:gdiplus 8 - jpg:gdiplus 8 - png:gdiplus 8 - } - device { - metafile:gdiplus 8 - bmp:gdiplus 8 - emf:gdiplus 8 - emfplus:gdiplus 8 - gif:gdiplus 8 - jpe:gdiplus 8 - jpeg:gdiplus 8 - jpg:gdiplus 8 - png:gdiplus 8 - tif:gdiplus 8 - tiff:gdiplus 8 - } - device { - bmp:cairo 8 - gif:cairo 8 - jpe:cairo 8 - jpeg:cairo 8 - jpg:cairo 8 - png:cairo 8 - tif:cairo 8 - tiff:cairo 8 - } -} -gvplugin_neato_layout.dll neato_layout { - layout { - neato 0 - fdp 0 - sfdp 0 - twopi 0 - circo 0 - patchwork 0 - osage 0 - nop 0 - nop1 0 - nop2 0 - } -} -gvplugin_pango.dll cairo { - render { - cairo 10 - } - textlayout { - textlayout 10 - } - loadimage { - png:cairo 1 -#FAILS png:lasi 2 - png:ps 2 - } - device { - png:cairo 10 - ps:cairo -10 - eps:cairo -10 - pdf:cairo 10 - svg:cairo -10 - } -} diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/dijkstra.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/dijkstra.exe deleted file mode 100644 index cf207d9..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/dijkstra.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/dot.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/dot.exe deleted file mode 100644 index 99c2706..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/dot.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/expat.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/expat.dll deleted file mode 100644 index 089a762..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/expat.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/fdp.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/fdp.exe deleted file mode 100644 index 99c2706..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/fdp.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/fontconfig.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/fontconfig.dll deleted file mode 100644 index 5a09015..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/fontconfig.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gc.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gc.exe deleted file mode 100644 index f39334d..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gc.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/getopt.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/getopt.dll deleted file mode 100644 index de07efc..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/getopt.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/glib-2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/glib-2.dll deleted file mode 100644 index c2da930..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/glib-2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gml2gv.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gml2gv.exe deleted file mode 100644 index 481ccb4..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gml2gv.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gobject-2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gobject-2.dll deleted file mode 100644 index 8baef60..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gobject-2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/graphml2gv.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/graphml2gv.exe deleted file mode 100644 index 2add605..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/graphml2gv.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gv2gml.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gv2gml.exe deleted file mode 100644 index 481ccb4..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gv2gml.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvc.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvc.dll deleted file mode 100644 index cee0fd3..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvc.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvcolor.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvcolor.exe deleted file mode 100644 index c80498b..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvcolor.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvgen.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvgen.exe deleted file mode 100644 index f2ea36a..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvgen.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvpack.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvpack.exe deleted file mode 100644 index 3d0f0b0..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvpack.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvplugin_core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvplugin_core.dll deleted file mode 100644 index 49ddb4e..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvplugin_core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvplugin_dot_layout.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvplugin_dot_layout.dll deleted file mode 100644 index b4b2613..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvplugin_dot_layout.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvplugin_gdiplus.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvplugin_gdiplus.dll deleted file mode 100644 index bddb342..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvplugin_gdiplus.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvplugin_neato_layout.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvplugin_neato_layout.dll deleted file mode 100644 index 4039884..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvplugin_neato_layout.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvplugin_pango.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvplugin_pango.dll deleted file mode 100644 index 9570425..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gvplugin_pango.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gxl2gv.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gxl2gv.exe deleted file mode 100644 index ce4f23e..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/gxl2gv.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/libharfbuzz-0.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/libharfbuzz-0.dll deleted file mode 100644 index 6bfbca3..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/libharfbuzz-0.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/mm2gv.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/mm2gv.exe deleted file mode 100644 index 1c2cd07..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/mm2gv.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/msvcp140.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/msvcp140.dll deleted file mode 100644 index a002f3f..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/msvcp140.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/msvcp140_1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/msvcp140_1.dll deleted file mode 100644 index 8ec882a..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/msvcp140_1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/msvcp140_2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/msvcp140_2.dll deleted file mode 100644 index a8db64c..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/msvcp140_2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/msvcp140_codecvt_ids.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/msvcp140_codecvt_ids.dll deleted file mode 100644 index 3527e4a..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/msvcp140_codecvt_ids.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/neato.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/neato.exe deleted file mode 100644 index 99c2706..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/neato.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/nop.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/nop.exe deleted file mode 100644 index 18302d1..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/nop.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/osage.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/osage.exe deleted file mode 100644 index 99c2706..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/osage.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pango-1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pango-1.dll deleted file mode 100644 index f9e729b..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pango-1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pangocairo-1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pangocairo-1.dll deleted file mode 100644 index 346d175..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pangocairo-1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pangoft2-1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pangoft2-1.dll deleted file mode 100644 index cda28ff..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pangoft2-1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pangowin32-1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pangowin32-1.dll deleted file mode 100644 index fd861ea..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pangowin32-1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/patchwork.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/patchwork.exe deleted file mode 100644 index 99c2706..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/patchwork.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pathplan.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pathplan.dll deleted file mode 100644 index 8a8d105..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pathplan.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pixman-1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pixman-1.dll deleted file mode 100644 index 2c43f45..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/pixman-1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/sccmap.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/sccmap.exe deleted file mode 100644 index 3029f7c..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/sccmap.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/sfdp.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/sfdp.exe deleted file mode 100644 index 99c2706..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/sfdp.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/tred.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/tred.exe deleted file mode 100644 index d64352a..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/tred.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/twopi.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/twopi.exe deleted file mode 100644 index 99c2706..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/twopi.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/unflatten.exe b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/unflatten.exe deleted file mode 100644 index 44dc1fc..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/unflatten.exe and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/vcruntime140.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/vcruntime140.dll deleted file mode 100644 index 28edd31..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/vcruntime140.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/vcruntime140_1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/vcruntime140_1.dll deleted file mode 100644 index df28946..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/vcruntime140_1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/xdot.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/xdot.dll deleted file mode 100644 index 5b82000..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Graphviz/xdot.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/HarfBuzzSharp.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/HarfBuzzSharp.dll deleted file mode 100644 index 12e0921..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/HarfBuzzSharp.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/HarfBuzzSharp.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/HarfBuzzSharp.xml deleted file mode 100644 index 652dd4e..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/HarfBuzzSharp.xml +++ /dev/null @@ -1,3734 +0,0 @@ - - - HarfBuzzSharp - - - - Represents a blob of data in memory. - - - - The data to wrap. - The length of the data being wrapped. - The memory mode to use. - Creates a new instance, wrapping the specified data. - If there was a problem creating the blob, or if the data length was zero, then an empty blob will be created. - - - The data to wrap. - The length of the data being wrapped. - The memory mode to use. - The delegate to invoke when the data is not needed anymore. - Creates a new instance, wrapping the specified data. - If there was a problem creating the blob, or if the data length was zero, then an empty blob will be created. - - - The data to wrap. - The length of the data being wrapped. - The memory mode to use. - The user data to pass to the release delegate. - The delegate to invoke when the data is not needed anymore. - Creates a new instance, wrapping the specified data. - If there was a problem creating the blob, or if the data length was zero, then an empty blob will be created. - - - Returns a span that wraps the data. - Returns the span that wraps the data. - If the data is released, then the span becomes invalid. - - - Returns a stream that wraps the data. - Returns the stream that wraps the data. - If the data is released, then the stream becomes invalid. - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Releases the unmanaged resources used. - - - - Gets a reference to the empty instance. - - - - - Gets the number of faces in this blob. - - - - - The path to the file to load. - Creates a new instance from the contents of the file. - Returns the new instance. - - - - The stream to use. - Creates a new instance from the contents of the stream. - Returns the new instance. - - - - Gets the value indicating whether the blob is immutable. - - - - - Gets the length of blob data in bytes. - - - - - Makes the blob immutable. - - - - The user data passed to . - The delegate that will be invoked when a blob is ready to be discarded. - - - - Represents a text buffer in memory. - - - - Creates a new with default values. - - - - To be added. - To be added. - To be added. - To be added. - - - The Unicode code point. - The cluster value of the code point. - Appends a character with the Unicode value and gives it the initial cluster value. - This function does not check the validity of the codepoint. - - - To be added. - To be added. - To be added. - - - The span of Unicode code points to append. - Appends characters from the span to the buffer. - This function does not check the validity of the characters. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The array of UTF-8 character bytes to append. - Appends the specified text bytes to the buffer. - - - - To be added. - To be added. - To be added. - - - The array of UTF-8 characters to append. - Appends the specified text to the buffer. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Clears the buffer's contents. - This operation preserves the Unicode functions and replacement code point. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Get or sets the text flow direction of the buffer. - - No shaping can happen without setting the direction, or invoking . - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Releases the unmanaged resources used. - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Gets the buffer glyph information array. - - The information is valid as long as buffer contents are not modified. - - - Gets the buffer glyph position array. - - The positions are valid as long as buffer contents are not modified. - - - Sets the unset buffer segment properties based on the buffer's Unicode contents. - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Gets or sets the size of the buffer. - - If the new length is greater that the current length, more memory will be allocated. If the new length is less than the current length, the extra items will be cleared. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - The various levels of buffer clustering. - - - - Don't group cluster values. - - - Default cluster level (). - - - Cluster values grouped into monotone order. - - - Cluster values grouped by graphemes into monotone order. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The various types of buffer contents. - - - - The buffer contains output glyphs (after shaping). - - - Initial value for new buffer. - - - The buffer contains input characters (before shaping). - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - Various text directions that can be set via . - - - - Text is set vertically from bottom to top. - - - Initial, unset direction. - - - Text is set horizontally from left to right. - - - Text is set horizontally from right to left. - - - Text is set vertically from top to bottom. - - - Represents a typeface. - - - - The delegate to retrieve the table data. - Creates a new instance, using the delegate to assemble the data. - - - - The typeface data. - The zero-based face index in a collection. - Creates a new instance, using the specified typeface blob. - - - - The typeface data. - The zero-based face index in a collection. - Creates a new instance, using the specified typeface blob. - - - - To be added. - To be added. - To be added. - To be added. - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Releases the unmanaged resources used. - - - - Gets a reference to the empty instance. - - - - - To be added. - To be added. - To be added. - - - Gets or sets the zero-based face index in a collection. - - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Gets or sets the units per EM. - - - - - Various font features and variations. - - - - The tag to use. - Creates a new instance with the specified tag. - - - - The tag to use. - The value to use. - Creates a new instance with the specified tag. - - - - The tag to use. - The value to use. - The start value. - The end value. - Creates a new instance with the specified tag. - - - - Gets or sets the end. - - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The feature string to parse. - Parses a feature string. - Returns the new feature. - - - - Gets or sets the start. - - - - - Gets or sets the tag. - - - - - Returns the string representation of the feature. - Returns the string representation of the feature. - - - - The feature string to parse. - The feature. - Tries to parse the feature string. - Returns true on success, otherwise false. - - - - Gets or sets the value. - - - - - Represents a specific font face. - - - - The face to use. - Creates a new using a specific font face. - - - - To be added. - To be added. - To be added. - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Releases the unmanaged resources used. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The scale along the x-axis. - The scale along the y-axis. - Retrieves the font scale. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Sets the font functions to that of OpenType. - - - - The scale along the x-axis. - The scale along the y-axis. - Sets the font scale. - - - - The buffer to shape. - The features to control the shaping process. - Shapes the specified buffer using the current font. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The font. - The additional data passed to when the functions were set. - The font extents. - The delegate that is invoked when or is invoked. - Return true if the has extents, otherwise false. - - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The font. - The additional data passed to when the functions were set. - The glyph. - The delegate that is invoked when or is invoked. - Return the advance amount. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - Represents the various glyph flags of a . - - - - All the currently defined flags. - - - If input text is broken at the beginning of the cluster this glyph is part of, then both sides need to be re-shaped, as the result might be different. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - Represents a glyph and its relation to the input text. - - - - Gets or sets the index of the character in the original text. - - - - - Gets or sets the Unicode code point (or the glyph index after shaping). - - This represents either a Unicode code point (before shaping) or a glyph index (after shaping). - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Gets the for this instance. - - - - - Gets or sets the glyph mask. - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - Represents the position of a glyph, relative to the current point. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets or sets how much the line advances after drawing this glyph when setting text in horizontal direction. - - - - - Gets or sets how much the glyph moves horizontally before drawing it. - - This should not affect how much the line advances. - - - Gets or sets how much the line advances after drawing this glyph when setting text in vertical direction. - - - - - Gets or sets how much the glyph moves horizontally before drawing it. - - This should not affect how much the line advances. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Various memory modes for - In no case shall the HarfBuzz client modify memory that is passed to HarfBuzz in a blob. If there is any such possibility, should be used such that HarfBuzz makes a copy immediately. - - - HarfBuzz makes a copy immediately. - - - Default mode indicating that the memory won't be changed. - - - The font file was mmap()ed, but should still be used. - - - Indicates that the data was copied solely for the purpose of passing to HarfBuzz. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Represents a native object. - - - - Releases all resources used by this . - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Releases the unmanaged resources used. - - - - Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. - - - - Gets or sets the handle to the underlying native object. - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - To be added. - - - To be added. - - - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - The delegate that will be invoked when a resource is ready to be discarded. - - - - Represents a particular Unicode script. - - - - The Adlam (Adlm) script typically used with text in the Fulah (ff) language originating from Guinea. - - - - The Ahom (Ahom) script typically used with text in the Ahom (aho) language originating from India. - - - - The Anatolian Hieroglyphs (Hluw) script typically used with text in the Hieroglyphic Luwian (hlu) language originating from Turkey. - - - - The Arabic (Arab) script typically used with text in the Arabic (ar) language originating from Saudi Arabia. - - - - The Armenian (Armn) script typically used with text in the Armenian (hy) language originating from Armenia. - - - - The Avestan (Avst) script typically used with text in the Avestan (ae) language originating from Iran. - - - - The Balinese (Bali) script typically used with text in the Balinese (ban) language originating from Indonesia. - - - - The Bamum (Bamu) script typically used with text in the Bamun (bax) language originating from Cameroon. - - - - The Bassa Vah (Bass) script typically used with text in the Bassa (bsq) language originating from Liberia. - - - - The Batak (Batk) script typically used with text in the Batak Toba (bbc) language originating from Indonesia. - - - - The Bengali (Beng) script typically used with text in the Bengali (bn) language originating from Bangladesh. - - - - The Bhaiksuki (Bhks) script typically used with text in the Sanskrit (sa) language originating from India. - - - - The Bopomofo (Bopo) script typically used with text in the Chinese (zh) language originating from China. - - - - The Brahmi (Brah) script typically used with text in the Ardhamāgadhī Prākrit (pka) language originating from India. - - - - The Braille (Brai) script typically used with text in the Braille language originating from France. - - - - The Buginese (Bugi) script typically used with text in the Buginese (bug) language originating from Indonesia. - - - - The Buhid (Buhd) script typically used with text in the Buhid (bku) language originating from Philippines. - - - - The Unified Canadian Aboriginal Syllabics (Cans) script typically used with text in the Cree (cr) language originating from Canada. - - - - The Carian (Cari) script typically used with text in the Carian (xcr) language originating from Turkey. - - - - The Caucasian Albanian (Aghb) script typically used with text in the Lezgian (lez) language originating from Russia. - - - - The Chakma (Cakm) script typically used with text in the Chakma (ccp) language originating from Bangladesh. - - - - The Cham (Cham) script typically used with text in the Eastern Cham (cjm) language originating from Vietnam. - - - - The Cherokee (Cher) script typically used with text in the Cherokee (chr) language originating from United States. - - - - The Common (Zyyy) script used to indicate an undetermined script. - - - - The Coptic (Copt) script typically used with text in the Coptic (cop) language originating from Egypt. - - - - The Cuneiform (Xsux) script typically used with text in the Akkadian (akk) language originating from Iraq. - - - - The Cypriot (Cprt) script typically used with text in the Ancient Greek (grc) language originating from Cyprus. - - - - The Cyrillic (Cyrl) script typically used with text in the Russian (ru) language originating from Bulgaria. - - - - The Deseret (Dsrt) script typically used with text in the English (en) language originating from United States. - - - - The Devanagari (Deva) script typically used with text in the Hindi (hi) language originating from India. - - - - The Dogra (Dogr) script typically used with text in the Dogri (doi) language originating from India. - - - - The Duployan (Dupl) script typically used with text in the French (fr) language originating from France. - - - - The Egyptian Hieroglyphs (Egyp) script typically used with text in the Ancient Egyptian (egy) language originating from Egypt. - - - - The Elbasan (Elba) script typically used with text in the Albanian (sq) language originating from Albania. - - - - An object to compare to this instance. - Returns a value indicating whether this instance and a specified object represent the same value. - Returns true if the other value is equal to this instance, otherwise false. - - - - An object to compare to this instance. - Returns a value indicating whether this instance and a specified object represent the same value. - Returns true if the other value is equal to this instance, otherwise false. - - - - The Ethiopic (Ethi) script typically used with text in the Amharic (am) language originating from Ethiopia. - - - - The Georgian (Geor) script typically used with text in the Georgian (ka) language originating from Georgia. - - - - Returns the hash code for this instance. - Returns the hash code for this instance. - - - - The Glagolitic (Glag) script typically used with text in the Church Slavic (cu) language originating from Bulgaria. - - - - The Gothic (Goth) script typically used with text in the Gothic (got) language originating from Ukraine. - - - - The Grantha (Gran) script typically used with text in the Sanskrit (sa) language originating from India. - - - - The Greek (Grek) script typically used with text in the Greek (el) language originating from Greece. - - - - The Gujarati (Gujr) script typically used with text in the Gujarati (gu) language originating from India. - - - - The Gunjala Gondi (Gong) script typically used with text in the Adilabad Gondi (wsg) language originating from India. - - - - The Gurmukhi (Guru) script typically used with text in the Punjabi (pa) language originating from India. - - - - The Han (Hani) script typically used with text in the Chinese (zh) language originating from China. - - - - The Hangul (Hang) script typically used with text in the Korean (ko) language originating from Republic of Korea. - - - - The Hanifi Rohingya (Rohg) script typically used with text in the Rohingya (rhg) language originating from Myanmar. - - - - The Hanunoo (Hano) script typically used with text in the Hanunoo (hnn) language originating from Philippines. - - - - The Hatran (Hatr) script typically used with text in the Uncoded Languages (mis) language originating from Iraq. - - - - The Hebrew (Hebr) script typically used with text in the Hebrew (he) language originating from Israel. - - - - The Hiragana (Hira) script typically used with text in the Japanese (ja) language originating from Japan. - - - - Gets the horizontal direction of this script. - - - - - The Imperial Aramaic (Armi) script typically used with text in the Aramaic (arc) language originating from Iran. - - - - The Inherited (Zinh) script used to indicate an inherited script. - - - - The Inscriptional Pahlavi (Phli) script typically used with text in the Pahlavi (pal) language originating from Iran. - - - - The Inscriptional Parthian (Prti) script typically used with text in the Parthian (xpr) language originating from Iran. - - - - The script used to indicate an invalid or no script. - - - - The Javanese (Java) script typically used with text in the Javanese (jv) language originating from Indonesia. - - - - The Kaithi (Kthi) script typically used with text in the Bhojpuri (bho) language originating from India. - - - - The Kannada (Knda) script typically used with text in the Kannada (kn) language originating from India. - - - - The Katakana (Kana) script typically used with text in the Japanese (ja) language originating from Japan. - - - - The Kayah Li (Kali) script typically used with text in the Eastern Kayah (eky) language originating from Myanmar. - - - - The Kharoshthi (Khar) script typically used with text in the Gandhari (pra) language originating from Pakistan. - - - - The Khmer (Khmr) script typically used with text in the Khmer (km) language originating from Cambodia. - - - - The Khojki (Khoj) script typically used with text in the Sindhi (sd) language originating from India. - - - - The Khudawadi (Sind) script typically used with text in the Sindhi (sd) language originating from India. - - - - The Lao (Laoo) script typically used with text in the Lao (lo) language originating from Laos. - - - - The Latin (Latn) script typically used with text in the English (en) language originating from Italy. - - - - The Lepcha (Lepc) script typically used with text in the Lepcha (lep) language originating from India. - - - - The Limbu (Limb) script typically used with text in the Limbu (lif) language originating from India. - - - - The Linear A (Lina) script typically used with text in the Linear A (lab) language originating from Greece. - - - - The Linear B (Linb) script typically used with text in the Ancient Greek (grc) language originating from Greece. - - - - The Lisu (Lisu) script typically used with text in the Lisu (lis) language originating from China. - - - - The Lycian (Lyci) script typically used with text in the Lycian (xlc) language originating from Turkey. - - - - The Lydian (Lydi) script typically used with text in the Lydian (xld) language originating from Turkey. - - - - The Mahajani (Mahj) script typically used with text in the Hindi (hi) language originating from India. - - - - The Makasar (Maka) script typically used with text in the Makasar (mak) language originating from Indonesia. - - - - The Malayalam (Mlym) script typically used with text in the Malayalam (ml) language originating from India. - - - - The Mandaic (Mand) script typically used with text in the Classical Mandaic (myz) language originating from Iran. - - - - The Manichaean (Mani) script typically used with text in the Manichaean Middle Persian (xmn) language originating from China. - - - - The Marchen (Marc) script typically used with text in the Tibetan (bo) language originating from China. - - - - The Masaram Gondi (Gonm) script typically used with text in the Aheri Gondi (esg) language originating from India. - - - - The dummy script used to prevent undefined behavior. - - - - The dummy script used to prevent undefined behavior. - - - - The Medefaidrin (Medf) script typically used with text in the Medefaidrin (mis) language originating from Nigeria. - - - - The Meetei Mayek (Mtei) script typically used with text in the Manipuri (mni) language originating from India. - - - - The Mende Kikakui (Mend) script typically used with text in the Mende (men) language originating from Sierra Leone. - - - - The Meroitic Cursive (Merc) script typically used with text in the Meroitic (xmr) language originating from Sudan. - - - - The Meroitic Hieroglyphs (Mero) script typically used with text in the Meroitic (xmr) language originating from Sudan. - - - - The Miao (Plrd) script typically used with text in the Large Flowery Miao (hmd) language originating from China. - - - - The Modi (Modi) script typically used with text in the Marathi (mr) language originating from India. - - - - The Mongolian (Mong) script typically used with text in the Mongolian (mn) language originating from Mongolia. - - - - The Mro (Mroo) script typically used with text in the Mru (mro) language originating from Bangladesh. - - - - The Multani (Mult) script typically used with text in the Seraiki (skr) language originating from Pakistan. - - - - The Myanmar (Mymr) script typically used with text in the Burmese (my) language originating from Myanmar. - - - - The Nabataean (Nbat) script typically used with text in the Official Aramaic (700-300 BCE) (arc) language originating from Jordan. - - - - The Newa (Newa) script typically used with text in the Newari (new) language originating from Nepal. - - - - The New Tai Lue (Talu) script typically used with text in the Lü (khb) language originating from China. - - - - The Nko (Nkoo) script typically used with text in the Manding (man) language originating from Guinea. - - - - The Nushu (Nshu) script typically used with text in the Chinese language family (zhx) language originating from China. - - - - The Ogham (Ogam) script typically used with text in the Old Irish (sga) language originating from Ireland. - - - - The Ol Chiki (Olck) script typically used with text in the Santali (sat) language originating from India. - - - - The Old Hungarian (Hung) script typically used with text in the Hungarian (hu) language originating from Hungary. - - - - The Old Italic (Ital) script typically used with text in the Etruscan (ett) language originating from Italy. - - - - The Old North Arabian (Narb) script typically used with text in the Ancient North Arabian (xna) language originating from Saudi Arabia. - - - - The Old Permic (Perm) script typically used with text in the Komi (kv) language originating from Russia. - - - - The Old Persian (Xpeo) script typically used with text in the Old Persian (peo) language originating from Iran. - - - - The Old Sogdian (Sogo) script typically used with text in the Sogdian (sog) language originating from Uzbekistan. - - - - The Old South Arabian (Sarb) script typically used with text in the Sabaean (xsa) language originating from Yemen. - - - - The Old Turkic (Orkh) script typically used with text in the Old Turkish (otk) language originating from Mongolia. - - - - The script to be converted into a tag. - Defines an implicit conversion of a to a tag. - Returns the tag that corresponds to the script. - - - - The tag to be converted into a script. - Defines an implicit conversion of a tag to a . - Returns the script that corresponds to the tag. - - - - The Oriya (Orya) script typically used with text in the Oriya (or) language originating from India. - - - - The Osage (Osge) script typically used with text in the Osage (osa) language originating from United States. - - - - The Osmanya (Osma) script typically used with text in the Somali (so) language originating from Somalia. - - - - The Pahawh Hmong (Hmng) script typically used with text in the Hmong Njua (hnj) language originating from Laos. - - - - The Palmyrene (Palm) script typically used with text in the Official Aramaic (700-300 BCE) (arc) language originating from Syria. - - - - The ISO 15924 script tag to parse. - Parses the ISO 15924 script tag into the corresponding . - Returns the that corresponds the script tag that was parsed. - - - - The Pau Cin Hau (Pauc) script typically used with text in the Tedim Chin (ctd) language originating from Myanmar. - - - - The Phags Pa (Phag) script typically used with text in the Literary Chinese (lzh) language originating from China. - - - - The Phoenician (Phnx) script typically used with text in the Phoenician (phn) language originating from Lebanon. - - - - The Psalter Pahlavi (Phlp) script typically used with text in the Pahlavi (pal) language originating from China. - - - - The Rejang (Rjng) script typically used with text in the Rejang (rej) language originating from Indonesia. - - - - The Runic (Runr) script typically used with text in the Old Norse (non) language originating from Sweden. - - - - The Samaritan (Samr) script typically used with text in the Samaritan Hebrew (smp) language originating from Israel. - - - - The Saurashtra (Saur) script typically used with text in the Saurashtra (saz) language originating from India. - - - - The Sharada (Shrd) script typically used with text in the Sanskrit (sa) language originating from India. - - - - The Shavian (Shaw) script typically used with text in the English (en) language originating from United Kingdom. - - - - The Siddham (Sidd) script typically used with text in the Sanskrit (sa) language originating from India. - - - - The Sign Writing (Sgnw) script typically used with text in the American Sign Language (ase) language originating from United States. - - - - The Sinhala (Sinh) script typically used with text in the Sinhala (si) language originating from Sri Lanka. - - - - The Sogdian (Sogd) script typically used with text in the Sogdian (sog) language originating from Uzbekistan. - - - - The Sora Sompeng (Sora) script typically used with text in the Sora (srb) language originating from India. - - - - The Soyombo (Soyo) script typically used with text in the Classical Mongolian (cmg) language originating from Mongolia. - - - - The Sundanese (Sund) script typically used with text in the Sundanese (su) language originating from Indonesia. - - - - The Syloti Nagri (Sylo) script typically used with text in the Sylheti (syl) language originating from Bangladesh. - - - - The Syriac (Syrc) script typically used with text in the Syriac (syr) language originating from Syria. - - - - The Tagalog (Tglg) script typically used with text in the Filipino (fil) language originating from Philippines. - - - - The Tagbanwa (Tagb) script typically used with text in the Tagbanwa (tbw) language originating from Philippines. - - - - The Tai Le (Tale) script typically used with text in the Tai Nüa (tdd) language originating from China. - - - - The Tai Tham (Lana) script typically used with text in the Northern Thai (nod) language originating from Thailand. - - - - The Tai Viet (Tavt) script typically used with text in the Tai Dam (blt) language originating from Vietnam. - - - - The Takri (Takr) script typically used with text in the Dogri (doi) language originating from India. - - - - The Tamil (Taml) script typically used with text in the Tamil (ta) language originating from India. - - - - The Tangut (Tang) script typically used with text in the Tangut (txg) language originating from China. - - - - The Telugu (Telu) script typically used with text in the Telugu (te) language originating from India. - - - - The Thaana (Thaa) script typically used with text in the Divehi (dv) language originating from Maldives. - - - - The Thai (Thai) script typically used with text in the Thai (th) language originating from Thailand. - - - - The Tibetan (Tibt) script typically used with text in the Tibetan (bo) language originating from China. - - - - The Tifinagh (Tfng) script typically used with text in the Standard Moroccan Tamazight (zgh) language originating from Morocco. - - - - The Tirhuta (Tirh) script typically used with text in the Maithili (mai) language originating from India. - - - - Returns a string representation of the value of this instance of the . - Returns a string representation. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The Ugaritic (Ugar) script typically used with text in the Ugaritic (uga) language originating from Syria. - - - - The Unknown (Zzzz) script used to indicate an uncoded script. - - - - The Vai (Vaii) script typically used with text in the Vai (vai) language originating from Liberia. - - - - The Warang Citi (Wara) script typically used with text in the Ho (hoc) language originating from India. - - - - The Yi (Yiii) script typically used with text in the Sichuan Yi (ii) language originating from China. - - - - The Zanabazar Square (Zanb) script typically used with text in the Classical Mongolian (cmg) language originating from Mongolia. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The various flags that control what glyph information are serialized by . - - - - Serialize glyph names, clusters and position information. - - - Serialize glyph extents. - - - Serialize glyph flags. - - - Do not serialize glyph advances (glyph offsets will reflect absolute glyph positions). - - - Do not serialize glyph clusters. - - - Do not serialize glyph names. - - - Do not serialize glyph position information. - - - The various serialization and de-serialization formats. - - - - The format is invalid. - - - A machine-readable JSON format. - - - A human-readable, plain text format. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - The ISO 15924 tag to parse. - Parses the ISO 15924 tag into the corresponding . - Returns the that corresponds the tag that was parsed. - - - - Returns a string representation of the value of this instance of the . - Returns a string representation. - - - - To be added. - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Releases the unmanaged resources used. - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticCleanLaser/Aurora.exe.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticCleanLaser/Aurora.exe.config deleted file mode 100644 index 66a4163..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticCleanLaser/Aurora.exe.config +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticCleanLaser/hislog.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticCleanLaser/hislog.config deleted file mode 100644 index fa5ddfa..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticCleanLaser/hislog.config +++ /dev/null @@ -1,49 +0,0 @@ -{ - "LogConfigs": [ - { - "logger_name": "Aurora", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "D:\\ILSOSConfig\\_log", - "log_save_level": 0, - "log_file_prefix": "Aurora", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - }, - { - "logger_name": "process", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "_process", - "log_save_level": 0, - "log_file_prefix": "process", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - }, - { - "logger_name": "vision", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "_vision", - "log_save_level": 0, - "log_file_prefix": "vision", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - } - ] -} \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticGun/Aurora.exe.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticGun/Aurora.exe.config deleted file mode 100644 index 787b88f..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticGun/Aurora.exe.config +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticGun/hislog.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticGun/hislog.config deleted file mode 100644 index 688d672..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticGun/hislog.config +++ /dev/null @@ -1,79 +0,0 @@ -{ - "LogConfigs": [ - { - "logger_name": "Aurora", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "D:\\ILSOSConfig\\_log", - "log_save_level": 0, - "log_file_prefix": "Aurora", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - }, - { - "logger_name": "process", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "_process", - "log_save_level": 0, - "log_file_prefix": "process", - "log_file_size": 5, - "log_file_keepdays": 0, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - }, - { - "logger_name": "vision", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "_vision", - "log_save_level": 0, - "log_file_prefix": "vision", - "log_file_size": 5, - "log_file_keepdays": 0, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - }, - { - "logger_name": "StageB", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "D:\\ILSOSConfig\\_log\\StageB", - "log_save_level": 0, - "log_file_prefix": "StageB", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - }, - { - "logger_name": "StageA", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "D:\\ILSOSConfig\\_log\\StageA", - "log_save_level": 0, - "log_file_prefix": "StageA", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - } - ] -} \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_PTOP.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_PTOP.dll deleted file mode 100644 index fea39c2..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_PTOP.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_PTOP.dll.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_PTOP.dll.config deleted file mode 100644 index 33c5377..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_PTOP.dll.config +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_PTOP/Aurora.exe.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_PTOP/Aurora.exe.config deleted file mode 100644 index ccbce02..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_PTOP/Aurora.exe.config +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_PTOP/hislog.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_PTOP/hislog.config deleted file mode 100644 index fa5ddfa..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_PTOP/hislog.config +++ /dev/null @@ -1,49 +0,0 @@ -{ - "LogConfigs": [ - { - "logger_name": "Aurora", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "D:\\ILSOSConfig\\_log", - "log_save_level": 0, - "log_file_prefix": "Aurora", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - }, - { - "logger_name": "process", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "_process", - "log_save_level": 0, - "log_file_prefix": "process", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - }, - { - "logger_name": "vision", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "_vision", - "log_save_level": 0, - "log_file_prefix": "vision", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - } - ] -} \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_TDC/Aurora.exe.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_TDC/Aurora.exe.config deleted file mode 100644 index 53e06df..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_TDC/Aurora.exe.config +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_TDC/hislog.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_TDC/hislog.config deleted file mode 100644 index fa5ddfa..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticRD_TDC/hislog.config +++ /dev/null @@ -1,49 +0,0 @@ -{ - "LogConfigs": [ - { - "logger_name": "Aurora", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "D:\\ILSOSConfig\\_log", - "log_save_level": 0, - "log_file_prefix": "Aurora", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - }, - { - "logger_name": "process", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "_process", - "log_save_level": 0, - "log_file_prefix": "process", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - }, - { - "logger_name": "vision", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "_vision", - "log_save_level": 0, - "log_file_prefix": "vision", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - } - ] -} \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticScanner/Aurora.exe.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticScanner/Aurora.exe.config deleted file mode 100644 index 219d924..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticScanner/Aurora.exe.config +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticScanner/hislog.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticScanner/hislog.config deleted file mode 100644 index fa5ddfa..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/ILSOS_PrismaticScanner/hislog.config +++ /dev/null @@ -1,49 +0,0 @@ -{ - "LogConfigs": [ - { - "logger_name": "Aurora", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "D:\\ILSOSConfig\\_log", - "log_save_level": 0, - "log_file_prefix": "Aurora", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - }, - { - "logger_name": "process", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "_process", - "log_save_level": 0, - "log_file_prefix": "process", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - }, - { - "logger_name": "vision", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "_vision", - "log_save_level": 0, - "log_file_prefix": "vision", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - } - ] -} \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Interop.ActUtlType64Lib.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Interop.ActUtlType64Lib.dll deleted file mode 100644 index f108901..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Interop.ActUtlType64Lib.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/IxMilia.Dxf.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/IxMilia.Dxf.dll deleted file mode 100644 index 770ae0f..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/IxMilia.Dxf.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/IxMilia.Dxf.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/IxMilia.Dxf.xml deleted file mode 100644 index 1463100..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/IxMilia.Dxf.xml +++ /dev/null @@ -1,2884 +0,0 @@ - - - - IxMilia.Dxf - - - - - Test-only constructor. - - - - - Internal for specific cases where the type isn't known. - - - - - Gets the thumbnail bitmap. - - Raw bytes that should serialize to a .BMP file. - - - - Sets the bitmap thumbnail. - - Raw data of the thumbnail image. Should be a 256-color bitmap, 180 pixels wide, any height. - - - - Raw data of the thumbnail image. Should be a 256-color bitmap, 180 pixels wide, any height. - - - - - A non-zero value indicates 1/100th of a mm. - - - - - When the line weight type is , the property represents the width of the line in 1/100th mm increments. - - - - - Test-only shortcut. - - - - - Test-only helper. - - - - - Internal to make testing easier. - - - - - - DxfAngularTwoLineDimension class - - - - - DxfArc class - - - - - Arc start angle in degrees - - - - - Arc end angle in degrees - - - - - DxfAttribute class - - - - - DxfAttributeDefinition class - - - - - DxfDimensionBase class - - - - - DxfAlignedDimension class - - - - - DxfRotatedDimension class - - - - - Values specific to the CLO software. - - - - - Baseline polyline not editable by CLO. - - - - - Internal line in CLO. - - - - - Outline pattern in CLO. - - - - - DxfEntity class - - - - - Gets a point corresponding to a specified angle of the given circle. - - The angle in degrees. - - - - Gets a point corresponding to a specified angle of the given ellipse. - - The angle in radians. - - - - DxfEntitySection class - - - - - DxfHatch class - - - - - Reserved for future use. - - - - - Only used by dialog code. - - - - - Unknown usage. - - - - - Rotation angle for gradients in radians. - - - - - Unknown usage. - - - - - Range is [0.0, 1.0]. - - - - - Reserved for future use. - - - - - Unknown usage. - - - - - DxfHelix class - - - - - DxfImage class - - - - The path to the image. - The bottom left corner of the location to display the image in the drawing. - The width of the image in pixels. - The height of the image in pixels. - The display size of the image in drawing units. - - - - The location of the bottom-left corner of the image - - - - - Image size in pixels - - - - - DxfInsert class - - - - - DxfLeader class - - - - - Creates a new leader entity with the specified vertices. NOTE, at least 2 vertices must be specified. - - - The vertices to add. - - - - DxfLwPolyline class - - - - - Creates a new LW polyline entity with the specified vertices. NOTE, at least 2 vertices must be specified. - - - The vertices to add. - - - - Converts DxfLwPolyline into a collection of DxfArc and DxfLine entities - - - - - DxfMLine class - - - - - DxfMText class - - - - - DxfOle2Frame class - - - - - DxfOleFrame class - - - - - DxfPolyline class - - - - - Creates a new polyline entity with the specified vertices. NOTE, at least 2 vertices must be specified. - - - The vertices to add. - - - - Creates a new polyline entity with the specified vertices. NOTE, at least 2 vertices must be specified. - - - The vertices to add. - The end sequence entity. - - - - Converts DxfPolyline into a collection of DxfArc and DxfLine entities - - - - - CLO-specific value, not normally used. - - - - - DxfProxyEntity class - - - - - DxfSpline class - - - - - DxfUnderlay class - - - - - DxfVertex class - - - - - DxfWipeout class - - - - The path to the image. - The bottom left corner of the location to display the image in the drawing. - The width of the image in pixels. - The height of the image in pixels. - The display size of the image in drawing units. - - - - Dxf3DFace class - - - - - Dxf3DSolid class - - - - - DxfAngularThreePointDimension class - - - - - DxfArcAlignedText class - - - - - DxfBody class - - - - - DxfCircle class - - - - - DxfDgnUnderlay class - - - - - DxfDiameterDimension class - - - - - DxfDwfUnderlay class - - - - - DxfEllipse class - - - - - Ellipse start angle in radians - - - - - Ellipse end angle in radians - - - - - DxfLight class - - - - - DxfLine class - - - - - DxfModelPoint class - - - - - DxfOrdinateDimension class - - - - - DxfPdfUnderlay class - - - - - DxfRadialDimension class - - - - - DxfRay class - - - - - DxfRegion class - - - - - DxfRText class - - - - - DxfSeqend class - - - - - DxfShape class - - - - - DxfSolid class - - - - - DxfText class - - - - - DxfTolerance class - - - - - DxfTrace class - - - - - DxfXLine class - - - - - DxfAcadProxyObject class - - - - - DxfDataTable class - - - - - DxfDictionary class - - - - - DxfDictionaryVariable class - - - - - DxfDictionaryWithDefault class - - - - - DxfDimensionAssociativity class - - - - - DxfField class - - - - - DxfGeoData class - - - - - DxfGroup class - - - - - DxfIdBuffer class - - - - - DxfImageDefinition class - - - - - Image width in pixels. - - - - - Image height in pixels. - - - - - Default size of one pixel. - - - - - Default size of one pixel. - - - - - DxfImageDefinitionReactor class - - - - - DxfLayerFilter class - - - - - DxfLayerIndex class - - - - - DxfLayout class - - - - - DxfLightList class - - - - - DxfMaterial class - - - - - DxfMentalRayRenderSettings class - - - - - DxfMLeaderStyle class - - - - - DxfMLineStyle class - - - - - DxfNavisWorksModelDefinition class - - - - - DxfObject class - - - - - DxfObjectPointer class - - - - - DxfPlaceHolder class - - - - - DxfPlotSettings class - - - - - DxfRapidRenderSettings class - - - - - DxfRapidRTRenderEnvironment class - - - - - Rotation angle in degrees. - - - - - DxfRasterVariables class - - - - - DxfRenderEnvironment class - - - - - DxfRenderGlobal class - - - - - DxfSectionManager class - - - - - DxfSectionSettings class - - - - - DxfSortentsTable class - - - - - DxfSpatialFilter class - - - - - DxfSpatialIndex class - - - - - DxfSunStudy class - - - - - DxfTableStyle class - - - - - DxfUnderlayDefinition class - - - - - DxfVbaProject class - - - - - DxfVisualStyle class - - - - - DxfWipeoutVariables class - - - - - DxfXRecordObject class - - - - - The $ACADVER header variable. The AutoCAD drawing database version number. - - - - - The $ACADMAINTVER header variable. Maintenance version number (should be ignored). Minimum AutoCAD version: R14. Maximum AutoCAD version: R2013. - - - - - The $DWGCODEPAGE header variable. Drawing code page; set to the system code page when a new drawing is created, but not otherwise maintained by AutoCAD. Minimum AutoCAD version: R13. - - - - - The $LASTSAVEDBY header variable. Name of the last user to modify the file. Minimum AutoCAD version: R2004. - - - - - The $REQUIREDVERSIONS header variable. Unknown. Minimum AutoCAD version: R2013. - - - - - The $INSBASE header variable. Insertion base set by BASE command (in WCS). - - - - - The $EXTMIN header variable. X, Y, and Z drawing extents lower-left corner (in WCS). - - - - - The $EXTMAX header variable. X, Y, and Z drawing extents upper-right corner (in WCS). - - - - - The $LIMMIN header variable. XY drawing limits lower-left corner (in WCS). - - - - - The $LIMMAX header variable. XY drawing limits upper-right corner (in WCS). - - - - - The $ORTHOMODE header variable. Ortho mode on. - - - - - The $REGENMODE header variable. REGENAUTO mode on. - - - - - The $FILLMODE header variable. Fill mode on. - - - - - The $QTEXTMODE header variable. Quick text mode on. - - - - - The $MIRRTEXT header variable. Mirror text. - - - - - The $DRAGMODE header variable. Controls the way dragged objects are displayed. Maximum AutoCAD version: R14. - - - - - The $LTSCALE header variable. Global line type scale. - - - - - The $OSMODE header variable. Running object snap modes. Maximum AutoCAD version: R14. - - - - - The $ATTMODE header variable. Attribute visibility. - - - - - The $TEXTSIZE header variable. Default text height. - - - - - The $TRACEWID header variable. Default trace width. - - - - - The $TEXTSTYLE header variable. Current text style name. - - - - - The $CLAYER header variable. Current layer name. - - - - - The $CELTYPE header variable. Entity line type name, or BYBLOCK or BYLAYER. - - - - - The $CECOLOR header variable. Current entity color. - - - - - The $CELTSCALE header variable. Current entity line type scale. Minimum AutoCAD version: R13. - - - - - The $DELOBJ header variable. Controls object deletion. Minimum AutoCAD version: R13. Maximum AutoCAD version: R14. - - - - - The $DISPSILH header variable. Controls the display of silhouette curves of body objects in wireframe mode. Minimum AutoCAD version: R13. - - - - - The $DRAGVS header variable. Hard-pointer ID to visual style when creating 3D solid primitives. Minimum AutoCAD version: R2007. - - - - - The $DIMSCALE header variable. Overall dimensioning scale factor. - - - - - The $DIMASZ header variable. Dimensioning arrow size. - - - - - The $DIMEXO header variable. Extension line offset. - - - - - The $DIMDLI header variable. Dimension line increment. - - - - - The $DIMRND header variable. Rounding value for dimension distances. - - - - - The $DIMDLE header variable. Dimension line extension. - - - - - The $DIMEXE header variable. Extension line extension. - - - - - The $DIMTP header variable. Plus tolerance. - - - - - The $DIMTM header variable. Minus tolerance. - - - - - The $DIMTXT header variable. Dimensioning text height. - - - - - The $DIMCEN header variable. Size of center mark/lines. - - - - - The $DIMTSZ header variable. Dimensioning tick size. - - - - - The $DIMTOL header variable. Dimension tolerances generated. - - - - - The $DIMLIM header variable. Dimension limits generated. - - - - - The $DIMTIH header variable. Text inside horizontal. - - - - - The $DIMTOH header variable. Text outside horizontal. - - - - - The $DIMSE1 header variable. Suppression of first extension line. Minimum AutoCAD version: R12. - - - - - The $DIMSE2 header variable. Suppression of second extension line. Minimum AutoCAD version: R12. - - - - - The $DIMTAD header variable. Text above dimension line. - - - - - The $DIMZIN header variable. Controls suppression of zeros for primary unit values. - - - - - The $DIMBLK header variable. Arrow block name. - - - - - The $DIMASO header variable. Controls associative dimensioning. - - - - - The $DIMSHO header variable. Recompute dimensions while dragging. - - - - - The $DIMPOST header variable. General dimensioning suffix. - - - - - The $DIMAPOST header variable. Alternate dimensioning suffix. - - - - - The $DIMALT header variable. Alternate unit dimensioning performed. - - - - - The $DIMALTD header variable. Alternate unit decimal places. - - - - - The $DIMALTF header variable. Alternate unit scale factor. - - - - - The $DIMLFAC header variable. Linear measurements scale factor. - - - - - The $DIMTOFL header variable. If text is outside extensions, force line extensions between extensions. - - - - - The $DIMTVP header variable. Text vertical position. - - - - - The $DIMTIX header variable. Force text inside extensions. - - - - - The $DIMSOXD header variable. Suppress outside-extensions dimension lines. - - - - - The $DIMSAH header variable. Use separate arrow blocks. - - - - - The $DIMBLK1 header variable. First arrow block name. - - - - - The $DIMBLK2 header variable. Second arrow block name. - - - - - The $DIMSTYLE header variable. Dimension style name. - - - - - The $DIMCLRD header variable. Dimension line color. Minimum AutoCAD version: R11. - - - - - The $DIMCLRE header variable. Dimension extension line color. Minimum AutoCAD version: R11. - - - - - The $DIMCLRT header variable. Dimension text color. Minimum AutoCAD version: R11. - - - - - The $DIMTFAC header variable. Dimension tolerance display factor. Minimum AutoCAD version: R12. - - - - - The $DIMGAP header variable. Dimension line gap. Minimum AutoCAD version: R11. - - - - - The $DIMJUST header variable. Horizontal dimension text position. Minimum AutoCAD version: R13. - - - - - The $DIMTOLJ header variable. Vertical justification for tolerance values. Minimum AutoCAD version: R13. - - - - - The $DIMTZIN header variable. Controls suppression of zeros for tolerance values. Minimum AutoCAD version: R13. - - - - - The $DIMALTZ header variable. Controls suppression of zeros for alternate unit dimension values. Minimum AutoCAD version: R13. - - - - - The $DIMALTTZ header variable. Controls suppression of zeros for alternate tolerance values. Minimum AutoCAD version: R13. - - - - - The $DIMFIT header variable. Placement of text and arrowheads. Minimum AutoCAD version: R13. Maximum AutoCAD version: R14. - - - - - The $DIMUPT header variable. Cursor functionality for user-positioned text. Minimum AutoCAD version: R13. - - - - - The $DIMUNIT header variable. Units format for all dimension style family members except angular. Minimum AutoCAD version: R13. Maximum AutoCAD version: R14. - - - - - The $DIMDEC header variable. Number of decimal places for the tolerance values of a primary units dimension. Minimum AutoCAD version: R13. - - - - - The $DIMTDEC header variable. Number of decimal places to display the tolerance values. Minimum AutoCAD version: R13. - - - - - The $DIMALTU header variable. Units format for alternate units of all dimension style family members except angular. Minimum AutoCAD version: R13. - - - - - The $DIMALTTD header variable. Number of decimal places for tolerance values of an alternate units dimension. Minimum AutoCAD version: R13. - - - - - The $DIMTXSTY header variable. Dimension text style. Minimum AutoCAD version: R13. - - - - - The $DIMAUNIT header variable. Angle format for angular dimensions. Minimum AutoCAD version: R13. - - - - - The $DIMADEC header variable. Number of precision places displayed in angular dimensions. Minimum AutoCAD version: R2000. - - - - - The $DIMALTRND header variable. Determines rounding of alternate units. Minimum AutoCAD version: R2000. - - - - - The $DIMAZIN header variable. Controls suppression of zeros for angular dimensions. Minimum AutoCAD version: R2000. - - - - - The $DIMDSEP header variable. Single-character decimal separator used when creating dimensions whose unit format is decimal. Minimum AutoCAD version: R2000. - - - - - The $DIMFRAC header variable. Sets the fraction format when DIMLUNIT is set to Architectural or Fractional. Minimum AutoCAD version: R2000. - - - - - The $DIMLDRBLK header variable. Arrow block name for leaders. Minimum AutoCAD version: R2000. - - - - - The $DIMLUNIT header variable. Sets units for all dimension types except angular. Minimum AutoCAD version: R2000. - - - - - The $DIMLWD header variable. Dimension line lineweight. Minimum AutoCAD version: R2000. - - - - - The $DIMLWE header variable. Extension line lineweight. Minimum AutoCAD version: R2000. - - - - - The $DIMTMOVE header variable. Dimension text movement rules. Minimum AutoCAD version: R2000. - - - - - The $DIMFXL header variable. Sets the total length of the extension lines starting from the dimension line toward the dimension origin. Minimum AutoCAD version: R2007. - - - - - The $DIMFXLON header variable. Controls whether extension lines are set to a fixed length. Minimum AutoCAD version: R2007. - - - - - The $DIMJOGANG header variable. Determines the angle of the transverse segment of the dimension line in a jogged radius dimension. Minimum AutoCAD version: R2007. - - - - - The $DIMTFILL header variable. Controls the background of dimension text. Minimum AutoCAD version: R2007. - - - - - The $DIMTFILLCLR header variable. Sets the color for the text background in dimensions. Minimum AutoCAD version: R2007. - - - - - The $DIMARCSYM header variable. Controls the display of the arc symbol in an arc length dimension. Minimum AutoCAD version: R2007. - - - - - The $DIMLTYPE header variable. Sets the line type of the dimension line. Minimum AutoCAD version: R2007. - - - - - The $DIMLTEX1 header variable. Sets the line type of the first extension line. Minimum AutoCAD version: R2007. - - - - - The $DIMLTEX2 header variable. Sets the line type of the second extension line. Minimum AutoCAD version: R2007. - - - - - The $DIMTXTDIRECTION header variable. Specifies the reading direction of the dimension text. Minimum AutoCAD version: R2010. - - - - - The $LUNITS header variable. Units format for coordinates and distances. - - - - - The $LUPREC header variable. Units precision for coordinates and distances. - - - - - The $SKETCHINC header variable. Sketch record increment. - - - - - The $FILLETRAD header variable. Fillet radius. - - - - - The $AUNITS header variable. Units format for angles. - - - - - The $AUPREC header variable. Units precision for angles. - - - - - The $MENU header variable. Name of menu file. - - - - - The $ELEVATION header variable. Current elevation set by ELEV command. - - - - - The $PELEVATION header variable. Current paper space elevation. Minimum AutoCAD version: R11. - - - - - The $THICKNESS header variable. Current thickness set by ELEV command. - - - - - The $LIMCHECK header variable. Limits checking. - - - - - The $BLIPMODE header variable. Display blips for click locations. Maximum AutoCAD version: R14. - - - - - The $CHAMFERA header variable. First chamfer distance. - - - - - The $CHAMFERB header variable. Second chamfer distance. - - - - - The $CHAMFERC header variable. Chamfer length. Minimum AutoCAD version: R14. - - - - - The $CHAMFERD header variable. Chamfer angle. Minimum AutoCAD version: R14. - - - - - The $SKPOLY header variable. Controls polyline sketch mode. - - - - - The $TDCREATE header variable. Local date/time of drawing creation. - - - - - The $TDUCREATE header variable. Universal date/time the drawing was created. Minimum AutoCAD version: R2000. - - - - - The $TDUPDATE header variable. Local date/time of last drawing update. - - - - - The $TDUUPDATE header variable. Universal date/time of the last update/save. Minimum AutoCAD version: R2000. - - - - - The $TDINDWG header variable. Cumulative editing time for this drawing. - - - - - The $TDUSRTIMER header variable. User-elapsed timer. - - - - - The $USRTIMER header variable. User timer on. - - - - - The $ANGBASE header variable. Angle 0 direction. - - - - - The $ANGDIR header variable. Angle directions. - - - - - The $PDMODE header variable. Point display mode. - - - - - The $PDSIZE header variable. Point display size. - - - - - The $PLINEWID header variable. Default polyline width. - - - - - The $COORDS header variable. Controls the display of coordinates. Maximum AutoCAD version: R14. - - - - - The $SPLFRAME header variable. Controls the display of helixes and smoothed mesh objects. Maximum AutoCAD version: R2013. - - - - - The $SPLINETYPE header variable. Spline curve type for PEDIT Spline. - - - - - The $SPLINESEGS header variable. Number of line segments per spline hatch. - - - - - The $ATTDIA header variable. Controls whether the INSERT command uses a dialog box for attribute value entry. Maximum AutoCAD version: R14. - - - - - The $ATTREQ header variable. Controls whether INSERT uses default attribute settings during insertion of blocks. Maximum AutoCAD version: R14. - - - - - The $HANDLING header variable. Handles available. Maximum AutoCAD version: R12. - - - - - The $HANDSEED header variable. Next available handle. - - - - - The $SURFTAB1 header variable. Number of mesh tabulations in first direction. - - - - - The $SURFTAB2 header variable. Number of mesh tabulations in second direction. - - - - - The $SURFTYPE header variable. Surface type for PEDIT Smooth. - - - - - The $SURFU header variable. Surface density (for PEDIT Smooth) in M direction. - - - - - The $SURFV header variable. Surface density (for PEDIT Smooth) in N direction. - - - - - The $UCSBASE header variable. Name of the UCS that defines the origin and orientation of orthographic UCS settings. Minimum AutoCAD version: R2000. - - - - - The $UCSNAME header variable. Name of current UCS. - - - - - The $UCSORG header variable. Origin of current UCS (in WCS). - - - - - The $UCSXDIR header variable. Direction of the current UCS X axis (in WCS). - - - - - The $UCSYDIR header variable. Direction of the current UCS Y axis (in WCS). - - - - - The $UCSORTHOREF header variable. If model space UCS is orthographic (UCSORTHOVIEW not equal to 0), this is the name of the UCS that the orthographic UCS is relative to. If blank, UCS is relative to WORLD. Minimum AutoCAD version: R2000. - - - - - The $UCSORTHOVIEW header variable. Orthographic view type of model space UCS. Minimum AutoCAD version: R2000. - - - - - The $UCSORGTOP header variable. Point which becomes the new UCS origin after changing model space UCS to TOP when UCSBASE is set to WORLD. Minimum AutoCAD version: R2000. - - - - - The $UCSORGBOTTOM header variable. Point which becomes the new UCS origin after changing model space UCS to BOTTOM when UCSBASE is set to WORLD. Minimum AutoCAD version: R2000. - - - - - The $UCSORGLEFT header variable. Point which becomes the new UCS origin after changing model space UCS to LEFT when UCSBASE is set to WORLD. Minimum AutoCAD version: R2000. - - - - - The $UCSORGRIGHT header variable. Point which becomes the new UCS origin after changing model space UCS to RIGHT when UCSBASE is set to WORLD. Minimum AutoCAD version: R2000. - - - - - The $UCSORGFRONT header variable. Point which becomes the new UCS origin after changing model space UCS to FRONT when UCSBASE is set to WORLD. Minimum AutoCAD version: R2000. - - - - - The $UCSORGBACK header variable. Point which becomes the new UCS origin after changing model space UCS to BACK when UCSBASE is set to WORLD. Minimum AutoCAD version: R2000. - - - - - The $PUCSBASE header variable. Name of the UCS that defines the origin and orientation of orthographics UCS settings (paper space only). Minimum AutoCAD version: R2000. - - - - - The $PUCSNAME header variable. Current paper space UCS name. Minimum AutoCAD version: R11. - - - - - The $PUCSORG header variable. Current paper space UCS origin. Minimum AutoCAD version: R11. - - - - - The $PUCSXDIR header variable. Current paper space UCS X axis. Minimum AutoCAD version: R11. - - - - - The $PUCSYDIR header variable. Current paper space UCS Y axis. Minimum AutoCAD version: R11. - - - - - The $PUCSORTHOREF header variable. If paper space UCS is orthographic (PUCSORTHOVIEW not equal to 0), this is the name of the UCS that the orthographic UCS is relative to. If blank, UCS is relative to WORLD. Minimum AutoCAD version: R2000. - - - - - The $PUCSORTHOVIEW header variable. Orthographic view type of paper space UCS. Minimum AutoCAD version: R2000. - - - - - The $PUCSORGTOP header variable. Point which becomes the new UCS origin after changing paper space UCS to TOP when PUCSBASE is set to WORLD. Minimum AutoCAD version: R2000. - - - - - The $PUCSORGBOTTOM header variable. Point which becomes the new UCS origin after changing paper space UCS to BOTTOM when PUCSBASE is set to WORLD. Minimum AutoCAD version: R2000. - - - - - The $PUCSORGLEFT header variable. Point which becomes the new UCS origin after changing paper space UCS to LEFT when PUCSBASE is set to WORLD. Minimum AutoCAD version: R2000. - - - - - The $PUCSORGRIGHT header variable. Point which becomes the new UCS origin after changing paper space UCS to RIGHT when PUCSBASE is set to WORLD. Minimum AutoCAD version: R2000. - - - - - The $PUCSORGFRONT header variable. Point which becomes the new UCS origin after changing paper space UCS to FRONT when PUCSBASE is set to WORLD. Minimum AutoCAD version: R2000. - - - - - The $PUCSORGBACK header variable. Point which becomes the new UCS origin after changing paper space UCS to BACK when PUCSBASE is set to WORLD. Minimum AutoCAD version: R2000. - - - - - The $USERI1 header variable. Integer variable intended for use by third-party developers. - - - - - The $USERI2 header variable. Integer variable intended for use by third-party developers. - - - - - The $USERI3 header variable. Integer variable intended for use by third-party developers. - - - - - The $USERI4 header variable. Integer variable intended for use by third-party developers. - - - - - The $USERI5 header variable. Integer variable intended for use by third-party developers. - - - - - The $USERR1 header variable. Real variable indented for use by third-party developers. - - - - - The $USERR2 header variable. Real variable indented for use by third-party developers. - - - - - The $USERR3 header variable. Real variable indented for use by third-party developers. - - - - - The $USERR4 header variable. Real variable indented for use by third-party developers. - - - - - The $USERR5 header variable. Real variable indented for use by third-party developers. - - - - - The $WORLDVIEW header variable. Set UCS to WCS during DVIEW/VPOINT. - - - - - The $SHADEDGE header variable. Controls shading of faces. Minimum AutoCAD version: R11. - - - - - The $SHADEDIF header variable. Percent ambient/diffuse light; range 1-100. Minimum AutoCAD version: R11. - - - - - The $TILEMODE header variable. Use previous release compatibility mode. Minimum AutoCAD version: R11. - - - - - The $MAXACTVP header variable. Sets the maximum number of viewports to be regenerated. Minimum AutoCAD version: R11. - - - - - The $PINSBASE header variable. Paper space insertion base point. Minimum AutoCAD version: R14. - - - - - The $PLIMCHECK header variable. Limits checking in paper space. Minimum AutoCAD version: R11. - - - - - The $PEXTMIN header variable. Minimum X, Y, and Z extents for paper space. Minimum AutoCAD version: R11. - - - - - The $PEXTMAX header variable. Maximum X, Y, and Z extents for paper space. Minimum AutoCAD version: R11. - - - - - The $PLIMMIN header variable. Minimum X and Y limits in paper space. Minimum AutoCAD version: R11. - - - - - The $PLIMMAX header variable. Maximum X and Y limits in paper space. Minimum AutoCAD version: R11. - - - - - The $UNITMODE header variable. Display fractions, feet-and-inches, and surveyor's angles in input format. Minimum AutoCAD version: R11. - - - - - The $VISRETAIN header variable. Retain xref-dependent visibility settings. Minimum AutoCAD version: R12. - - - - - The $PLINEGEN header variable. Governs the generation of line type patterns around the vertices of a 2D polyline. Minimum AutoCAD version: R11. - - - - - The $PSLTSCALE header variable. Controls paper space line type scaling. Minimum AutoCAD version: R11. - - - - - The $TREEDEPTH header variable. Specifies the maximum depth of the spatial index. Minimum AutoCAD version: R14. - - - - - The $PICKSTYLE header variable. Controls the group selection and associative hatch selection. Minimum AutoCAD version: R13. Maximum AutoCAD version: R14. - - - - - The $CMLSTYLE header variable. Current multiline style name. Minimum AutoCAD version: R13. Maximum AutoCAD version: R13. - - - - - The $CMLJUST header variable. Current multiline justification. Minimum AutoCAD version: R13. - - - - - The $CMLSCALE header variable. Current multiline scale. Minimum AutoCAD version: R13. - - - - - The $PROXYGRAPHICS header variable. Controls the saving of proxy object images. Minimum AutoCAD version: R14. - - - - - The $MEASUREMENT header variable. Sets drawing units. Minimum AutoCAD version: R14. - - - - - The $CELWEIGHT header variable. Lineweight of new objects. Minimum AutoCAD version: R2000. - - - - - The $ENDCAPS header variable. Lineweight endcaps setting for new objects. Minimum AutoCAD version: R2000. - - - - - The $JOINSTYLE header variable. Lineweight join setting for new objects. Minimum AutoCAD version: R2000. - - - - - The $LWDISPLAY header variable. Controls the display of lineweights on the Model or Layout tab. Minimum AutoCAD version: R2000. - - - - - The $INSUNITS header variable. Default drawing units for AutoCAD DesignCenter blocks. Minimum AutoCAD version: R2000. - - - - - The $HYPERLINKBASE header variable. Path for all relative hyperlinks in the drawing. If null, the drawing path is used. Minimum AutoCAD version: R2000. - - - - - The $STYLESHEET header variable. Path to the stylesheet for the drawing. Minimum AutoCAD version: R2000. - - - - - The $XEDIT header variable. Controls whether the current drawing can be edited in-place when being referenced by another drawing. Minimum AutoCAD version: R2000. - - - - - The $CEPSNID header variable. PlotStyle handle of new objects. Minimum AutoCAD version: R2000. - - - - - The $CEPSNTYPE header variable. Plot style of new objects. Minimum AutoCAD version: R2000. - - - - - The $PSTYLEMODE header variable. Indicates whether the current drawing is in a Color-Dependent or Named Plot Style mode. Minimum AutoCAD version: R2000. - - - - - The $FINGERPRINTGUID header variable. Set at creation time, uniquely identifies a particular drawing. Minimum AutoCAD version: R2000. - - - - - The $VERSIONGUID header variable. Uniquely identifies a particular version of a drawing. Updated when the drawing is modified. Minimum AutoCAD version: R2000. - - - - - The $EXTNAMES header variable. Controls symbol table naming. Minimum AutoCAD version: R2000. - - - - - The $PSVPSCALE header variable. View scale factor for new viewports. Minimum AutoCAD version: R2000. - - - - - The $OLESTARTUP header variable. Controls whether the source application of an embedded OLE object loads when plotting. Minimum AutoCAD version: R2000. - - - - - The $SORTENTS header variable. Controls the object sorting methods; accessible from the Options dialog box User Preferences tab. Minimum AutoCAD version: R2004. - - - - - The $INDEXCTL header variable. Controls whether layer and spatial indexes are created and saved in drawing files. Minimum AutoCAD version: R2004. - - - - - The $HIDETEXT header variable. Ignore text objects. Minimum AutoCAD version: R2004. - - - - - The $XCLIPFRAME header variable. Controls the visibility of xref clipping boundaries. Minimum AutoCAD version: R2004. Maximum AutoCAD version: R2007. - - - - - The $HALOGAP header variable. Specifies a gap to be displayed where an object is hidden by another object; the value is specified as a percent of one unit and is independent of the zoom level. A haloed line is shortened at the point where it is hidden when HIDE or the Hidden option of SHADEMODE is used. Minimum AutoCAD version: R2004. - - - - - The $OBSCOLOR header variable. Specifies the color of obscured lines. An obscured line is a hidden line made visible by changing its color and line type and is visible only when the HIDE or SHADEMODE command is used. The OBSCUREDCOLOR setting is visible only if the OBSCUREDLTYPE is turned ON by setting it to a value other than 0. Minimum AutoCAD version: R2004. - - - - - The $OBSLTYPE header variable. Specifies the line type of obscured lines. Obscured line types are independent of zoom level, unlike regular AutoCAD line types. Value 0 turns off display of obscured lines and is the default. Minimum AutoCAD version: R2004. - - - - - The $INTERSECTIONDISPLAY header variable. Specifies the display of intersection polylines. Minimum AutoCAD version: R2004. - - - - - The $INTERSECTIONCOLOR header variable. Specifies the entity color of intersection polylines. Minimum AutoCAD version: R2004. - - - - - The $DIMASSOC header variable. Controls the associativity of dimension objects. Minimum AutoCAD version: R2004. - - - - - The $PROJECTNAME header variable. Assigns a project name to the current drawing. Used when an external reference or image is not found on its original path. The project name points to a section in the registry that can contain one or more search paths for each project name defined. Project names and their search directories are created from the Files tab of the Options dialog box. Minimum AutoCAD version: R2004. - - - - - The $CAMERADISPLAY header variable. Turns the display of camera objects on or off. Minimum AutoCAD version: R2007. - - - - - The $LENSLENGTH header variable. Stores the length of the lens in millimeters used in perspective viewing. Minimum AutoCAD version: R2007. - - - - - The $CAMERAHEIGHT header variable. Specifies the default height for new camera objects. Minimum AutoCAD version: R2007. - - - - - The $STEPSPERSEC header variable. Specifies the number of steps taken per second when you are in walk or fly mode. Minimum AutoCAD version: R2007. - - - - - The $STEPSIZE header variable. Specifies the size of each step when in walk or fly mode, in drawing units. Minimum AutoCAD version: R2007. - - - - - The $3DDWFPREC header variable. Controls the precision of 3D DWF or 3D DWFx publishing. Minimum AutoCAD version: R2007. - - - - - The $PSOLWIDTH header variable. Controls the default width for a swept solid object created with the POLYSOLID command. Minimum AutoCAD version: R2007. - - - - - The $PSOLHEIGHT header variable. Controls the default height for a swept solid object created with the POLYSOLID command. Minimum AutoCAD version: R2007. - - - - - The $LOFTANG1 header variable. Sets the draft angle through the first cross section in a loft operation. Minimum AutoCAD version: R2007. - - - - - The $LOFTANG2 header variable. Sets the draft angle through the second cross section in a loft operation. Minimum AutoCAD version: R2007. - - - - - The $LOFTMAG1 header variable. Sets the magnitude of the draft angle through the first cross section in a loft operation. Minimum AutoCAD version: R2007. - - - - - The $LOFTMAG2 header variable. Sets the magnitude of the draft angle through the second cross section in a loft operation. Minimum AutoCAD version: R2007. - - - - - The $LOFTPARAM header variable. Controls the shape of lofted solids and surfaces. Minimum AutoCAD version: R2007. - - - - - The $LOFTNORMALS header variable. Controls the normals of a lofted object where it passes through cross sections. Minimum AutoCAD version: R2007. - - - - - The $LATITUDE header variable. The latitude of the geographic location assigned to the drawing. Minimum AutoCAD version: R2007. - - - - - The $LONGITUDE header variable. The longitude of the geographic location assigned to the drawing. Minimum AutoCAD version: R2007. - - - - - The $NORTHDIRECTION header variable. Specifies the angle between the Y axis of WCS and the grid north. Minimum AutoCAD version: R2007. - - - - - The $TIMEZONE header variable. Sets the time zone for the sun in the drawing. Minimum AutoCAD version: R2007. - - - - - The $LIGHTGLYPHDISPLAY header variable. Turns on and off the display of light glyphs. Minimum AutoCAD version: R2007. - - - - - The $TILEMODELIGHTSYNCH header variable. Unknown. Minimum AutoCAD version: R2007. - - - - - The $CMATERIAL header variable. Sets the material of new objects. Minimum AutoCAD version: R2007. - - - - - The $SOLIDHIST header variable. Controls whether new composite solids retain a history of their original components. Minimum AutoCAD version: R2007. - - - - - The $SHOWHIST header variable. Controls the Show History property for solids in a drawing. Minimum AutoCAD version: R2007. - - - - - The $DWFFRAME header variable. Determines whether DWF or DWFx underlay frames are visible or plotted in the current drawing. Minimum AutoCAD version: R2007. - - - - - The $DGNFRAME header variable. Determines whether DGN underlay frames are visible or plotted in the current drawing. Minimum AutoCAD version: R2007. - - - - - The $REALWORLDSCALE header variable. Drawing is scaled to the real world. Minimum AutoCAD version: R2007. - - - - - The $INTERFERECOLOR header variable. Represents the ACI color index of the "interference objects" created during the interfere command. Minimum AutoCAD version: R2007. - - - - - The $INTERFEREOBJVS header variable. Hard-pointer ID to the visual stype for interference objects. Minimum AutoCAD version: R2007. - - - - - The $INTERFEREVPVS header variable. Hard-pointer ID to the visual styoe for the viewport during interference checking. Minimum AutoCAD version: R2007. - - - - - The $CSHADOW header variable. Shadow mode for a 3D object. Minimum AutoCAD version: R2007. - - - - - The $SHADOWPLANELOCATION header variable. Location of the ground shadow plane. This is a Z axis ordinate. Minimum AutoCAD version: R2007. - - - - - The $AXISMODE header variable. Axis on. Maximum AutoCAD version: R10. - - - - - The $AXISUNIT header variable. Axis X and Y tick spacing. Maximum AutoCAD version: R10. - - - - - The $FASTZOOM header variable. Fast zoom enabled. Maximum AutoCAD version: R10. - - - - - The $GRIDMODE header variable. Grid mode on. Maximum AutoCAD version: R10. - - - - - The $GRIDUNIT header variable. Grid X and Y spacing. Maximum AutoCAD version: R10. - - - - - The $SNAPANG header variable. Snap grid rotation angle. Maximum AutoCAD version: R10. - - - - - The $SNAPBASE header variable. Snap/grid/base point (in UCS). Maximum AutoCAD version: R10. - - - - - The $SNAPISOPAIR header variable. Isometric plane. Maximum AutoCAD version: R10. - - - - - The $SNAPMODE header variable. Snap mode on. Maximum AutoCAD version: R10. - - - - - The $SNAPSTYLE header variable. Snap style. Maximum AutoCAD version: R10. - - - - - The $SNAPUNIT header variable. Snap grid X and Y spacing. Maximum AutoCAD version: R10. - - - - - The $VIEWCTR header variable. XY center of current view on screen. Maximum AutoCAD version: R10. - - - - - The $VIEWDIR header variable. Viewing direction (direction from target in WCS). Maximum AutoCAD version: R10. - - - - - The $VIEWSIZE header variable. Height of view. Maximum AutoCAD version: R10. - - - - - Snap to line segment endpoints. Maximum AutoCAD version: R14. - - - - - Snap to line segment midpoints. Maximum AutoCAD version: R14. - - - - - Snap to circle and arc center points. Maximum AutoCAD version: R14. - - - - - Snap to nodes. Maximum AutoCAD version: R14. - - - - - Snap to circle quadrants. Maximum AutoCAD version: R14. - - - - - Snap to segment intersections. Maximum AutoCAD version: R14. - - - - - Snap to block insertion points. Maximum AutoCAD version: R14. - - - - - Snap to perpendicular points. Maximum AutoCAD version: R14. - - - - - Snap to tangent points. Maximum AutoCAD version: R14. - - - - - Snap to nearest object points. Maximum AutoCAD version: R14. - - - - - Snap to apparent intersection points. Maximum AutoCAD version: R14. - - - - - Snap to extension points. Maximum AutoCAD version: R14. - - - - - Snap to parallel points. Maximum AutoCAD version: R14. - - - - - Sorts for object selection. Minimum AutoCAD version: R2004. - - - - - Sorts for object snap. Minimum AutoCAD version: R2004. - - - - - Sorts for redraws. Minimum AutoCAD version: R2004. - - - - - Sorts for MSLIDE command slide creation. Minimum AutoCAD version: R2004. - - - - - Sorts for REGEN commands. Minimum AutoCAD version: R2004. - - - - - Sorts for plotting. Minimum AutoCAD version: R2004. - - - - - Sorts for PostScript output. Minimum AutoCAD version: R2004. - - - - - No twist (minimizes the twist between cross sections). Minimum AutoCAD version: R2007. - - - - - Align direction (aligns the start to end direction of each cross section curve). Minimum AutoCAD version: R2007. - - - - - Simplify (produces simple solids and surfaces, such as a cylinder or plane, instead of spline solids and surfaces). Minimum AutoCAD version: R2007. - - - - - Close (closes the surface or solid between the first and the last cross sections). Minimum AutoCAD version: R2007. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2000. - - - - - Corresponds to header variable DIMPOST. - - - - - Corresponds to header variable DIMAPOST. - - - - - Obsolete. Corresponds to header variable DIMBLK. Maximum drawing version R14. - - - - - Obsolete. Corresponds to header variable DIMBLK1. Maximum drawing version R14. - - - - - Obsolete. Corresponds to header variable DIMBLK2. Maximum drawing version R14. - - - - - Corresponds to header variable DIMSCALE. - - - - - Corresponds to header variable DIMASZ. - - - - - Corresponds to header variable DIMEXO. - - - - - Corresponds to header variable DIMDLI. - - - - - Corresponds to header variable DIMEXE. - - - - - Corresponds to header variable DIMRND. - - - - - Corresponds to header variable DIMDLE. - - - - - Corresponds to header variable DIMTP. - - - - - Corresponds to header variable DIMTM. - - - - - Corresponds to header variable DIMTOL. - - - - - Corresponds to header variable DIMLIM. - - - - - Corresponds to header variable DIMTIH. - - - - - Corresponds to header variable DIMTOH. - - - - - Corresponds to header variable DIMSE1. - - - - - Corresponds to header variable DIMSE2. - - - - - Corresponds to header variable DIMTAD. - - - - - Corresponds to header variable DIMZIN. - - - - - Corresponds to header variable DIMAZIN. Minimum drawing version R2000. - - - - - Corresponds to header variable DIMTXT. - - - - - Corresponds to header variable DIMCEN. - - - - - Corresponds to header variable DIMTSZ. - - - - - Corresponds to header variable DIMALTF. - - - - - Corresponds to header variable DIMLFAC. - - - - - Corresponds to header variable DIMTVP. - - - - - Corresponds to header variable DIMTFAC. - - - - - Corresponds to header variable DIMGAP. - - - - - Corresponds to header variable DIMALTRND. Minimum drawing version R2000. - - - - - Corresponds to header variable DIMALT. - - - - - Corresponds to header variable DIMALTD. - - - - - Corresponds to header variable DIMTOFL. - - - - - Corresponds to header variable DIMSAH. - - - - - Corresponds to header variable DIMTIX. - - - - - Corresponds to header variable DIMSOXD. - - - - - Corresponds to header variable DIMCLRD. - - - - - Corresponds to header variable DIMCLRE. - - - - - Corresponds to header variable DIMCLRT. - - - - - Corresponds to header variable DIMADEC. Minimum drawing version R2000. - - - - - Obsolete. Use and instead. Corresponds to header variable DIMUNIT. Minimum drawing version R13. - - - - - Corresponds to header variable DIMDEC. Minimum drawing version R13. - - - - - Corresponds to header variable DIMTDEC. Minimum drawing version R13. - - - - - Corresponds to header variable DIMALTU. Minimum drawing version R13. - - - - - Corresponds to header variable DIMALTTD. Minimum drawing version R13. - - - - - Corresponds to header variable DIMAUNIT. Minimum drawing version R13. - - - - - Corresponds to header variable DIMFRAC. Minimum drawing version R2000. - - - - - Corresponds to header variable DIMLUNIT. Minimum drawing version R2000. - - - - - Corresponds to header variable DIMDSEP. Minimum drawing version R2000. - - - - - Corresponds to header variable DIMTMOVE. Minimum drawing version R2000. - - - - - Corresponds to header variable DIMJUST. Minimum drawing version R13. - - - - - Corresponds to header variable DIMTOLJ. Minimum drawing version R13. - - - - - Corresponds to header variable DIMTZIN. Minimum drawing version R13. - - - - - Corresponds to header variable DIMALTZ. Minimum drawing version R13. - - - - - Corresponds to header variable DIMALTTZ. Minimum drawing version R13. - - - - - Obsolete. Use and instead. Corresponds to header variable DIMFIT. Minimum drawing version R13. - - - - - Corresponds to header variable DIMUPT. Minimum drawing version R13. - - - - - Corresponds to header variable DIMTXSTY. Minimum drawing version R13. - - - - - Corresponds to header variable DIMLDRBLK. Minimum drawing version R2000. - - - - - Corresponds to header variable DIMLWD. Minimum drawing version R2000. - - - - - Corresponds to header variable DIMLWE. Minimum drawing version R2000. - - - - Generates of the difference between the styles. Result may be . - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2010. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2010. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Maximum drawing version R2004. - - - - - Maximum drawing version R2004. - - - - - Maximum drawing version R2004. - - - - - Maximum drawing version R2004. - - - - - Maximum drawing version R2004. - - - - - Maximum drawing version R2004. - - - - - Maximum drawing version R2004. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. Maximum drawing version R2004. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2000. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2007. - - - - - Minimum drawing version R2007. - - - - - Added in R2017. - - - - - Added in R2017. - - - - - Added in R2017. - - - - - Added in R2017. - - - - - Added in R2017. - - - - - Added in R2017. - - - - - Added in R2017. - - - - - Added in R2017. - - - - - Added in R2017. - - - - - Added in R2017. - - - - - Added in R2017. - - - - - The rotation angle in radians. - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/LASA.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/LASA.dll deleted file mode 100644 index 3d99295..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/LASA.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/LASA.dll.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/LASA.dll.config deleted file mode 100644 index 17ce5a6..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/LASA.dll.config +++ /dev/null @@ -1,198 +0,0 @@ - - - - -
    - - -
    - - - - - - - - - D:\EqpData\LASA.eqpdata\Language\Language.csv - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 0.001 - - - 100 - - - 0 - - - D:\EqpData\LASA.eqpdata\Scanner\ScannerParam.json - - - D:\EqpData\LASA.eqpdata - - - 151 - - - 255 - - - 0 - - - 5 - - - 0.01 - - - 19200 - - - 120 - - - 6 - - - 20 - - - 1000 - - - 128 - - - 3 - - - 12 - - - 300 - - - 1280 - - - 2560 - - - 2 - - - 3000 - - - 2 - - - D:\EqpData\LASA.eqpdata\Recipe\ModelListParam.xml - - - D:\EqpData\LASA.eqpdata\DB\LASA.sdf - - - D:\EqpData\LASA.eqpdata\Motion\Position - - - D:\EqpData\LASA.eqpdata\Motion - - - D:\EqpData\LASA.eqpdata\Parameter\LasaParam.lsp - - - D:\EqpData\LASA.eqpdata\Vision\Recipe\ApaParamters.lsv - - - D:\EqpData\LASA.eqpdata\Vision\Triangulation - - - D:\EqpData\LASA.eqpdata\ImageLog\Triangulation - - - D:\EqpData\LASA.eqpdata\Scanner\Record - - - 10000 - - - - - - RTC6 - - - D:\EqpData\LASA.eqpdata\Recipe\DependantListParam.xml - - - 256 - - - 1280 - - - D:\EqpData\LASA.eqpdata\ErrorTable\ErrorTable.csv - - - D:\EqpData\LASA.eqpdata\Laser\PowerProfile.xml - - - 2000 - - - D:\EqpData\LASA.eqpdata\DistanceSensor\Record - - - D:\EqpData\LASA.eqpdata\Log\LASER - - - 120 - - - 1 - - - 200 - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Light/LightControlCCS_Library/x64-Debug/LightControlCCS_Library.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Light/LightControlCCS_Library/x64-Debug/LightControlCCS_Library.dll deleted file mode 100644 index 9aa9be4..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Light/LightControlCCS_Library/x64-Debug/LightControlCCS_Library.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Light/LightControlCCS_Library/x64-Debug/LightControlCCS_Library.dll.metagen b/Machines/_out_prismatic_rd_ptop/x64-Debug/Light/LightControlCCS_Library/x64-Debug/LightControlCCS_Library.dll.metagen deleted file mode 100644 index 7bb4ee8..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/Light/LightControlCCS_Library/x64-Debug/LightControlCCS_Library.dll.metagen +++ /dev/null @@ -1,368 +0,0 @@ -ImageRuntimeVersion: v4.0.30319 -Assembly LightControlCCS_Library, Version=1.0.*, Culture=고정 언어(고정 국가): - hash=SHA1, flags=PublicKey -Assembly mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089: - hash=None, flags=None -Assembly System.Data, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089: - hash=None, flags=None -Assembly System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089: - hash=None, flags=None -Assembly System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a: - hash=None, flags=None -Assembly System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089: - hash=None, flags=None -Assembly System.Xml, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089: - hash=None, flags=None -Class LightControlCCS_Library.ClsData: AutoLayout, AnsiClass, Class, Public, BeforeFieldInit - Void .ctor(): PrivateScope, Public, HideBySig, SpecialName, RTSpecialName - Properties: - Int32 unit 'get set' : - Int32 commandmodeselectindex 'get set' : - Int32 communicationSetting 'get set' : - OnOffType powerOnOff8 'get set' : - OnOffType powerOnOff7 'get set' : - OnOffType powerOnOff6 'get set' : - OnOffType powerOnOff5 'get set' : - OnOffType powerOnOff4 'get set' : - OnOffType powerOnOff3 'get set' : - OnOffType powerOnOff2 'get set' : - OnOffType powerOnOff 'get set' : - Int32 lightMode8 'get set' : - Int32 lightMode7 'get set' : - Int32 lightMode6 'get set' : - Int32 lightMode5 'get set' : - Int32 lightMode4 'get set' : - Int32 lightMode3 'get set' : - Int32 lightMode2 'get set' : - Int32 lightMode 'get set' : - Int32 dimmer8 'get set' : - Int32 dimmer7 'get set' : - Int32 dimmer6 'get set' : - Int32 dimmer5 'get set' : - Int32 dimmer4 'get set' : - Int32 dimmer3 'get set' : - Int32 dimmer2 'get set' : - Int32 dimmer 'get set' : - Int32 channel 'get set' : - Int32 mode 'get set' : - System.Drawing.Rectangle CommunicationSettingDisplay 'get set' : - System.Drawing.Rectangle MultiCommandDisplay 'get set' : - System.Drawing.Rectangle ManagementMainDisplay 'get set' : - System.String csvFilePath 'get set' : - Boolean sessionKeepOpen 'get set' : - Int32 countSelect 'get set' : - Boolean countUnlimited 'get set' : - dataActiveType dataActiveSet 'get set' : - Int32 dataActiveLine 'get set' : - Int32 interval 'get set' : - Int32 returnPortNo 'get set' : - System.String returnIpAddress 'get set' : - System.String defaultGateway 'get set' : - System.String subNetMask 'get set' : - Int32 receivePortNo 'get set' : - System.String ipAddressSet 'get set' : - Int32 idSetting 'get set' : - Int32 comPort 'get set' : - Int32 portNo 'get set' : - System.String terminalIp 'get set' : - System.String ipAddress 'get set' : - ProtcolType protcol 'get set' : - Boolean sumCheckEnable 'get set' : - Int32 powerSeries 'get set' : - Methods: - get_powerSeries(): PrivateScope, Public, HideBySig, SpecialName - set_powerSeries(Int32): PrivateScope, Public, HideBySig, SpecialName - get_sumCheckEnable(): PrivateScope, Public, HideBySig, SpecialName - set_sumCheckEnable(Boolean(HasFieldMarshal)): PrivateScope, Public, HideBySig, SpecialName - get_protcol(): PrivateScope, Public, HideBySig, SpecialName - set_protcol(ProtcolType): PrivateScope, Public, HideBySig, SpecialName - get_ipAddress(): PrivateScope, Public, HideBySig, SpecialName - set_ipAddress(String): PrivateScope, Public, HideBySig, SpecialName - get_terminalIp(): PrivateScope, Public, HideBySig, SpecialName - set_terminalIp(String): PrivateScope, Public, HideBySig, SpecialName - get_portNo(): PrivateScope, Public, HideBySig, SpecialName - set_portNo(Int32): PrivateScope, Public, HideBySig, SpecialName - get_comPort(): PrivateScope, Public, HideBySig, SpecialName - set_comPort(Int32): PrivateScope, Public, HideBySig, SpecialName - get_idSetting(): PrivateScope, Public, HideBySig, SpecialName - set_idSetting(Int32): PrivateScope, Public, HideBySig, SpecialName - get_ipAddressSet(): PrivateScope, Public, HideBySig, SpecialName - set_ipAddressSet(String): PrivateScope, Public, HideBySig, SpecialName - get_receivePortNo(): PrivateScope, Public, HideBySig, SpecialName - set_receivePortNo(Int32): PrivateScope, Public, HideBySig, SpecialName - get_subNetMask(): PrivateScope, Public, HideBySig, SpecialName - set_subNetMask(String): PrivateScope, Public, HideBySig, SpecialName - get_defaultGateway(): PrivateScope, Public, HideBySig, SpecialName - set_defaultGateway(String): PrivateScope, Public, HideBySig, SpecialName - get_returnIpAddress(): PrivateScope, Public, HideBySig, SpecialName - set_returnIpAddress(String): PrivateScope, Public, HideBySig, SpecialName - get_returnPortNo(): PrivateScope, Public, HideBySig, SpecialName - set_returnPortNo(Int32): PrivateScope, Public, HideBySig, SpecialName - get_interval(): PrivateScope, Public, HideBySig, SpecialName - set_interval(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dataActiveLine(): PrivateScope, Public, HideBySig, SpecialName - set_dataActiveLine(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dataActiveSet(): PrivateScope, Public, HideBySig, SpecialName - set_dataActiveSet(dataActiveType): PrivateScope, Public, HideBySig, SpecialName - get_countUnlimited(): PrivateScope, Public, HideBySig, SpecialName - set_countUnlimited(Boolean(HasFieldMarshal)): PrivateScope, Public, HideBySig, SpecialName - get_countSelect(): PrivateScope, Public, HideBySig, SpecialName - set_countSelect(Int32): PrivateScope, Public, HideBySig, SpecialName - get_sessionKeepOpen(): PrivateScope, Public, HideBySig, SpecialName - set_sessionKeepOpen(Boolean(HasFieldMarshal)): PrivateScope, Public, HideBySig, SpecialName - get_csvFilePath(): PrivateScope, Public, HideBySig, SpecialName - set_csvFilePath(String): PrivateScope, Public, HideBySig, SpecialName - get_ManagementMainDisplay(): PrivateScope, Public, HideBySig, SpecialName - set_ManagementMainDisplay(Rectangle): PrivateScope, Public, HideBySig, SpecialName - get_MultiCommandDisplay(): PrivateScope, Public, HideBySig, SpecialName - set_MultiCommandDisplay(Rectangle): PrivateScope, Public, HideBySig, SpecialName - get_CommunicationSettingDisplay(): PrivateScope, Public, HideBySig, SpecialName - set_CommunicationSettingDisplay(Rectangle): PrivateScope, Public, HideBySig, SpecialName - get_mode(): PrivateScope, Public, HideBySig, SpecialName - set_mode(Int32): PrivateScope, Public, HideBySig, SpecialName - get_channel(): PrivateScope, Public, HideBySig, SpecialName - set_channel(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dimmer(): PrivateScope, Public, HideBySig, SpecialName - set_dimmer(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dimmer2(): PrivateScope, Public, HideBySig, SpecialName - set_dimmer2(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dimmer3(): PrivateScope, Public, HideBySig, SpecialName - set_dimmer3(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dimmer4(): PrivateScope, Public, HideBySig, SpecialName - set_dimmer4(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dimmer5(): PrivateScope, Public, HideBySig, SpecialName - set_dimmer5(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dimmer6(): PrivateScope, Public, HideBySig, SpecialName - set_dimmer6(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dimmer7(): PrivateScope, Public, HideBySig, SpecialName - set_dimmer7(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dimmer8(): PrivateScope, Public, HideBySig, SpecialName - set_dimmer8(Int32): PrivateScope, Public, HideBySig, SpecialName - get_lightMode(): PrivateScope, Public, HideBySig, SpecialName - set_lightMode(Int32): PrivateScope, Public, HideBySig, SpecialName - get_lightMode2(): PrivateScope, Public, HideBySig, SpecialName - set_lightMode2(Int32): PrivateScope, Public, HideBySig, SpecialName - get_lightMode3(): PrivateScope, Public, HideBySig, SpecialName - set_lightMode3(Int32): PrivateScope, Public, HideBySig, SpecialName - get_lightMode4(): PrivateScope, Public, HideBySig, SpecialName - set_lightMode4(Int32): PrivateScope, Public, HideBySig, SpecialName - get_lightMode5(): PrivateScope, Public, HideBySig, SpecialName - set_lightMode5(Int32): PrivateScope, Public, HideBySig, SpecialName - get_lightMode6(): PrivateScope, Public, HideBySig, SpecialName - set_lightMode6(Int32): PrivateScope, Public, HideBySig, SpecialName - get_lightMode7(): PrivateScope, Public, HideBySig, SpecialName - set_lightMode7(Int32): PrivateScope, Public, HideBySig, SpecialName - get_lightMode8(): PrivateScope, Public, HideBySig, SpecialName - set_lightMode8(Int32): PrivateScope, Public, HideBySig, SpecialName - get_powerOnOff(): PrivateScope, Public, HideBySig, SpecialName - set_powerOnOff(OnOffType): PrivateScope, Public, HideBySig, SpecialName - get_powerOnOff2(): PrivateScope, Public, HideBySig, SpecialName - set_powerOnOff2(OnOffType): PrivateScope, Public, HideBySig, SpecialName - get_powerOnOff3(): PrivateScope, Public, HideBySig, SpecialName - set_powerOnOff3(OnOffType): PrivateScope, Public, HideBySig, SpecialName - get_powerOnOff4(): PrivateScope, Public, HideBySig, SpecialName - set_powerOnOff4(OnOffType): PrivateScope, Public, HideBySig, SpecialName - get_powerOnOff5(): PrivateScope, Public, HideBySig, SpecialName - set_powerOnOff5(OnOffType): PrivateScope, Public, HideBySig, SpecialName - get_powerOnOff6(): PrivateScope, Public, HideBySig, SpecialName - set_powerOnOff6(OnOffType): PrivateScope, Public, HideBySig, SpecialName - get_powerOnOff7(): PrivateScope, Public, HideBySig, SpecialName - set_powerOnOff7(OnOffType): PrivateScope, Public, HideBySig, SpecialName - get_powerOnOff8(): PrivateScope, Public, HideBySig, SpecialName - set_powerOnOff8(OnOffType): PrivateScope, Public, HideBySig, SpecialName - get_communicationSetting(): PrivateScope, Public, HideBySig, SpecialName - set_communicationSetting(Int32): PrivateScope, Public, HideBySig, SpecialName - get_commandmodeselectindex(): PrivateScope, Public, HideBySig, SpecialName - set_commandmodeselectindex(Int32): PrivateScope, Public, HideBySig, SpecialName - get_unit(): PrivateScope, Public, HideBySig, SpecialName - set_unit(Int32): PrivateScope, Public, HideBySig, SpecialName - Init(): PrivateScope, Public, HideBySig - MakeSendCommand(String&, String&): PrivateScope, Public, HideBySig - MakeSendCommandPSB3_PSCC_PD3(String&, String&): PrivateScope, Public, HideBySig - MakeSendCommandPFBR(String&, String&): PrivateScope, Public, HideBySig - AnalyzeSendCommand(String, ValueType&, String&, ProtcolType): PrivateScope, Public, HideBySig - CheckReceiveCommand(String&, String&, ValueType CmdSetting IsBoxed, Enum ProtcolType IsBoxed, String&): PrivateScope, Public, HideBySig - CheckReceiveCommand_settingcheck(String&, String, Enum ProtcolType IsBoxed): PrivateScope, Public, HideBySig - CheckReceiveCommand_PFBR(String&, String&, ValueType CmdSetting IsBoxed, Enum ProtcolType IsBoxed, String&): PrivateScope, Public, HideBySig - CheckReceiveCommand_PSB3_PSCC_PD3(String&, String&, ValueType CmdSetting IsBoxed, Enum ProtcolType IsBoxed, String&): PrivateScope, Public, HideBySig - MakeSendCommandComSet(String&, String&): PrivateScope, Public, HideBySig - CheckReceiveCommandComSet(String&, String&): PrivateScope, Public, HideBySig -Struct LightControlCCS_Library.ClsData+PowerType: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - PowerType PowerSeriesPD3 = 0 : Public, Static, Literal, HasDefault - PowerType PowerSeriesPSB3 = 1 : Public, Static, Literal, HasDefault - PowerType PowerSeriesPSCC = 2 : Public, Static, Literal, HasDefault - PowerType PowerSeriesPFBR = 3 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+ProtcolType: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - ProtcolType ProtcolTcpIp = 0 : Public, Static, Literal, HasDefault - ProtcolType ProtcolUdpIp = 1 : Public, Static, Literal, HasDefault - ProtcolType ProtcolEia485 = 2 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+ModeType: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - ModeType ModeDimmer = 0 : Public, Static, Literal, HasDefault - ModeType ModeLight = 1 : Public, Static, Literal, HasDefault - ModeType ModePowerOnOff = 2 : Public, Static, Literal, HasDefault - ModeType ModeCheckSettingStatus = 3 : Public, Static, Literal, HasDefault - ModeType ModeCheckOverCurrent = 4 : Public, Static, Literal, HasDefault - ModeType ModeInitAllChannel = 5 : Public, Static, Literal, HasDefault - ModeType ModeKnobStatus = 6 : Public, Static, Literal, HasDefault - ModeType ModeCommandStatus = 7 : Public, Static, Literal, HasDefault - ModeType ModeVersionCheck = 8 : Public, Static, Literal, HasDefault - ModeType ModeStatusCheck = 9 : Public, Static, Literal, HasDefault - ModeType ModeErrorReset = 10 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+ChannelType: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - ChannelType Ch1 = 0 : Public, Static, Literal, HasDefault - ChannelType Ch2 = 1 : Public, Static, Literal, HasDefault - ChannelType Ch3 = 2 : Public, Static, Literal, HasDefault - ChannelType Ch4 = 3 : Public, Static, Literal, HasDefault - ChannelType Ch5 = 4 : Public, Static, Literal, HasDefault - ChannelType Ch6 = 5 : Public, Static, Literal, HasDefault - ChannelType Ch7 = 6 : Public, Static, Literal, HasDefault - ChannelType Ch8 = 7 : Public, Static, Literal, HasDefault - ChannelType ChAll = 8 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+LightType: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - LightType Always = 0 : Public, Static, Literal, HasDefault - LightType _40us = 1 : Public, Static, Literal, HasDefault - LightType _80us = 2 : Public, Static, Literal, HasDefault - LightType _120us = 3 : Public, Static, Literal, HasDefault - LightType _200us = 4 : Public, Static, Literal, HasDefault - LightType _600us = 5 : Public, Static, Literal, HasDefault - LightType _1ms = 6 : Public, Static, Literal, HasDefault - LightType _4ms = 7 : Public, Static, Literal, HasDefault - LightType _10ms = 8 : Public, Static, Literal, HasDefault - LightType _20ms = 9 : Public, Static, Literal, HasDefault - LightType _40ms = 10 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+OnOffType: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - OnOffType TypeOn = 1 : Public, Static, Literal, HasDefault - OnOffType TypeOff = 0 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+UnitChoice: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - UnitChoice _10bit = 0 : Public, Static, Literal, HasDefault - UnitChoice _8bit = 1 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+ErrorCode: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - ErrorCode NoError = 0 : Public, Static, Literal, HasDefault - ErrorCode InvalidChDimmer = 1 : Public, Static, Literal, HasDefault - ErrorCode InvalidChFlash = 2 : Public, Static, Literal, HasDefault - ErrorCode InvalidChCheckStatus = 3 : Public, Static, Literal, HasDefault - ErrorCode InvalidRcvLength = 4 : Public, Static, Literal, HasDefault - ErrorCode InvalidRcvCommand = 5 : Public, Static, Literal, HasDefault - ErrorCode InvalidRcvChecksum = 6 : Public, Static, Literal, HasDefault - ErrorCode InvalidRcvOutRange = 7 : Public, Static, Literal, HasDefault - ErrorCode Timeout = 8 : Public, Static, Literal, HasDefault - ErrorCode NoData = 9 : Public, Static, Literal, HasDefault - ErrorCode InvalidSndCommand = 10 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+dataActiveType: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - dataActiveType TypeOverWrite = 0 : Public, Static, Literal, HasDefault - dataActiveType TypeInsert = 1 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+CommunicationSettingType: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - CommunicationSettingType IpAddress = 0 : Public, Static, Literal, HasDefault - CommunicationSettingType SubnetMask = 1 : Public, Static, Literal, HasDefault - CommunicationSettingType ReceivePort = 2 : Public, Static, Literal, HasDefault - CommunicationSettingType DefaultGatWay = 3 : Public, Static, Literal, HasDefault - CommunicationSettingType ReturnAddress = 4 : Public, Static, Literal, HasDefault - CommunicationSettingType ReturnPort = 5 : Public, Static, Literal, HasDefault - CommunicationSettingType IpSubnetGateWay = 6 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+CmdSetting: AutoLayout, AnsiClass, Class, NestedPublic, SequentialLayout, Sealed, BeforeFieldInit - :System.ValueType - Fields: - Int32 mode : Public - Int32 channel : Public - Int32 dimmer : Public - Int32 lightMode : Public - OnOffType powerOnOff : Public - Methods: - initSetting(): PrivateScope, Public, HideBySig -Struct LightControlCCS_Library.ClsData+SessionSetting: AutoLayout, AnsiClass, Class, NestedPublic, SequentialLayout, Sealed, BeforeFieldInit - :System.ValueType - Fields: - Int32 lineno : Public - ProtcolType protcol : Public - System.String ip_id : Public - System.String rcvport_comport : Public - System.String sndcommand : Public - System.String comment : Public - Int32 interval : Public - System.String datetimedata : Public - System.String rcvcommand : Public - System.String commandresult : Public - Methods: - initSetting(): PrivateScope, Public, HideBySig -Class LightControlCCS_Library.ClsAbstractCom: AutoLayout, AnsiClass, Class, Public, Abstract, BeforeFieldInit - Void .ctor(): PrivateScope, Public, HideBySig, SpecialName, RTSpecialName - Fields: - System.String Ip_Id : Public - Methods: - Open(): PrivateScope, Public, Virtual, HideBySig, VtableLayoutMask, Abstract - Close(): PrivateScope, Public, Virtual, HideBySig, VtableLayoutMask, Abstract - Send(String): PrivateScope, Public, Virtual, HideBySig, VtableLayoutMask, Abstract - ReceiveStart(MyThreadCallback): PrivateScope, Public, Virtual, HideBySig, VtableLayoutMask, Abstract - Abort(): PrivateScope, Public, Virtual, HideBySig, VtableLayoutMask, Abstract - SetEnableMsgbox(Boolean(HasFieldMarshal)): PrivateScope, Public, HideBySig -Class LightControlCCS_Library.ClsAbstractCom+MyThreadCallback: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.MulticastDelegate - Void .ctor(System.Object, IntPtr): PrivateScope, Public, SpecialName, RTSpecialName - Methods: - Invoke(Enum ErrorCode IsBoxed, String): PrivateScope, Public, Final, Virtual, VtableLayoutMask - BeginInvoke(Enum ErrorCode IsBoxed, String, AsyncCallback, Object): PrivateScope, Public, Final, Virtual, VtableLayoutMask - EndInvoke(IAsyncResult): PrivateScope, Public, Final, Virtual, VtableLayoutMask -Class LightControlCCS_Library.ClsUtility: AutoLayout, AnsiClass, Class, Public, BeforeFieldInit - Void .ctor(): PrivateScope, Public, HideBySig, SpecialName, RTSpecialName - Methods: - GetIpAddress(): PrivateScope, Public, Static, HideBySig - ShapeIpAddress(String): PrivateScope, Public, Static, HideBySig -Class LightControlCCS_Library.ClsTcpIpComTh: AutoLayout, AnsiClass, Class, Public, BeforeFieldInit - :LightControlCCS_Library.ClsAbstractCom - Void .ctor(System.String, Int32): PrivateScope, Public, HideBySig, SpecialName, RTSpecialName - Fields: - MyThreadCallback callbackDelegate : Public - Methods: - Open(): PrivateScope, Public, Virtual, HideBySig - Close(): PrivateScope, Public, Virtual, HideBySig - Send(String): PrivateScope, Public, Virtual, HideBySig - ReceiveStart(MyThreadCallback): PrivateScope, Public, Virtual, HideBySig - Abort(): PrivateScope, Public, Virtual, HideBySig -Class LightControlCCS_Library.ManagementMain: AutoLayout, AnsiClass, Class, Public, BeforeFieldInit - Void .ctor(): PrivateScope, Public, HideBySig, SpecialName, RTSpecialName - Interfaces: - System.IDisposable - Methods: - GetNowSetting(): PrivateScope, Public, HideBySig - Connect(String, Int32): PrivateScope, Public, HideBySig - DisConnect(): PrivateScope, Public, HideBySig - SetValue(Int32, Int32): PrivateScope, Public, HideBySig - GetReceiveResult(Enum ErrorCode IsBoxed, String): PrivateScope, Public, HideBySig - Dispose(): PrivateScope, Public, Final, Virtual, HideBySig -Class LightControlCCS_Library.ManagementMain+AddMessageDelegate: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.MulticastDelegate - Void .ctor(System.Object, IntPtr): PrivateScope, Public, SpecialName, RTSpecialName - Methods: - Invoke(String, String): PrivateScope, Public, Final, Virtual, VtableLayoutMask - BeginInvoke(String, String, AsyncCallback, Object): PrivateScope, Public, Final, Virtual, VtableLayoutMask - EndInvoke(IAsyncResult): PrivateScope, Public, Final, Virtual, VtableLayoutMask diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Light/LightControlCCS_Library/x64-Release/LightControlCCS_Library.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Light/LightControlCCS_Library/x64-Release/LightControlCCS_Library.dll deleted file mode 100644 index 86a2d53..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Light/LightControlCCS_Library/x64-Release/LightControlCCS_Library.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Light/LightControlCCS_Library/x64-Release/LightControlCCS_Library.dll.metagen b/Machines/_out_prismatic_rd_ptop/x64-Debug/Light/LightControlCCS_Library/x64-Release/LightControlCCS_Library.dll.metagen deleted file mode 100644 index 7bb4ee8..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/Light/LightControlCCS_Library/x64-Release/LightControlCCS_Library.dll.metagen +++ /dev/null @@ -1,368 +0,0 @@ -ImageRuntimeVersion: v4.0.30319 -Assembly LightControlCCS_Library, Version=1.0.*, Culture=고정 언어(고정 국가): - hash=SHA1, flags=PublicKey -Assembly mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089: - hash=None, flags=None -Assembly System.Data, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089: - hash=None, flags=None -Assembly System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089: - hash=None, flags=None -Assembly System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a: - hash=None, flags=None -Assembly System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089: - hash=None, flags=None -Assembly System.Xml, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089: - hash=None, flags=None -Class LightControlCCS_Library.ClsData: AutoLayout, AnsiClass, Class, Public, BeforeFieldInit - Void .ctor(): PrivateScope, Public, HideBySig, SpecialName, RTSpecialName - Properties: - Int32 unit 'get set' : - Int32 commandmodeselectindex 'get set' : - Int32 communicationSetting 'get set' : - OnOffType powerOnOff8 'get set' : - OnOffType powerOnOff7 'get set' : - OnOffType powerOnOff6 'get set' : - OnOffType powerOnOff5 'get set' : - OnOffType powerOnOff4 'get set' : - OnOffType powerOnOff3 'get set' : - OnOffType powerOnOff2 'get set' : - OnOffType powerOnOff 'get set' : - Int32 lightMode8 'get set' : - Int32 lightMode7 'get set' : - Int32 lightMode6 'get set' : - Int32 lightMode5 'get set' : - Int32 lightMode4 'get set' : - Int32 lightMode3 'get set' : - Int32 lightMode2 'get set' : - Int32 lightMode 'get set' : - Int32 dimmer8 'get set' : - Int32 dimmer7 'get set' : - Int32 dimmer6 'get set' : - Int32 dimmer5 'get set' : - Int32 dimmer4 'get set' : - Int32 dimmer3 'get set' : - Int32 dimmer2 'get set' : - Int32 dimmer 'get set' : - Int32 channel 'get set' : - Int32 mode 'get set' : - System.Drawing.Rectangle CommunicationSettingDisplay 'get set' : - System.Drawing.Rectangle MultiCommandDisplay 'get set' : - System.Drawing.Rectangle ManagementMainDisplay 'get set' : - System.String csvFilePath 'get set' : - Boolean sessionKeepOpen 'get set' : - Int32 countSelect 'get set' : - Boolean countUnlimited 'get set' : - dataActiveType dataActiveSet 'get set' : - Int32 dataActiveLine 'get set' : - Int32 interval 'get set' : - Int32 returnPortNo 'get set' : - System.String returnIpAddress 'get set' : - System.String defaultGateway 'get set' : - System.String subNetMask 'get set' : - Int32 receivePortNo 'get set' : - System.String ipAddressSet 'get set' : - Int32 idSetting 'get set' : - Int32 comPort 'get set' : - Int32 portNo 'get set' : - System.String terminalIp 'get set' : - System.String ipAddress 'get set' : - ProtcolType protcol 'get set' : - Boolean sumCheckEnable 'get set' : - Int32 powerSeries 'get set' : - Methods: - get_powerSeries(): PrivateScope, Public, HideBySig, SpecialName - set_powerSeries(Int32): PrivateScope, Public, HideBySig, SpecialName - get_sumCheckEnable(): PrivateScope, Public, HideBySig, SpecialName - set_sumCheckEnable(Boolean(HasFieldMarshal)): PrivateScope, Public, HideBySig, SpecialName - get_protcol(): PrivateScope, Public, HideBySig, SpecialName - set_protcol(ProtcolType): PrivateScope, Public, HideBySig, SpecialName - get_ipAddress(): PrivateScope, Public, HideBySig, SpecialName - set_ipAddress(String): PrivateScope, Public, HideBySig, SpecialName - get_terminalIp(): PrivateScope, Public, HideBySig, SpecialName - set_terminalIp(String): PrivateScope, Public, HideBySig, SpecialName - get_portNo(): PrivateScope, Public, HideBySig, SpecialName - set_portNo(Int32): PrivateScope, Public, HideBySig, SpecialName - get_comPort(): PrivateScope, Public, HideBySig, SpecialName - set_comPort(Int32): PrivateScope, Public, HideBySig, SpecialName - get_idSetting(): PrivateScope, Public, HideBySig, SpecialName - set_idSetting(Int32): PrivateScope, Public, HideBySig, SpecialName - get_ipAddressSet(): PrivateScope, Public, HideBySig, SpecialName - set_ipAddressSet(String): PrivateScope, Public, HideBySig, SpecialName - get_receivePortNo(): PrivateScope, Public, HideBySig, SpecialName - set_receivePortNo(Int32): PrivateScope, Public, HideBySig, SpecialName - get_subNetMask(): PrivateScope, Public, HideBySig, SpecialName - set_subNetMask(String): PrivateScope, Public, HideBySig, SpecialName - get_defaultGateway(): PrivateScope, Public, HideBySig, SpecialName - set_defaultGateway(String): PrivateScope, Public, HideBySig, SpecialName - get_returnIpAddress(): PrivateScope, Public, HideBySig, SpecialName - set_returnIpAddress(String): PrivateScope, Public, HideBySig, SpecialName - get_returnPortNo(): PrivateScope, Public, HideBySig, SpecialName - set_returnPortNo(Int32): PrivateScope, Public, HideBySig, SpecialName - get_interval(): PrivateScope, Public, HideBySig, SpecialName - set_interval(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dataActiveLine(): PrivateScope, Public, HideBySig, SpecialName - set_dataActiveLine(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dataActiveSet(): PrivateScope, Public, HideBySig, SpecialName - set_dataActiveSet(dataActiveType): PrivateScope, Public, HideBySig, SpecialName - get_countUnlimited(): PrivateScope, Public, HideBySig, SpecialName - set_countUnlimited(Boolean(HasFieldMarshal)): PrivateScope, Public, HideBySig, SpecialName - get_countSelect(): PrivateScope, Public, HideBySig, SpecialName - set_countSelect(Int32): PrivateScope, Public, HideBySig, SpecialName - get_sessionKeepOpen(): PrivateScope, Public, HideBySig, SpecialName - set_sessionKeepOpen(Boolean(HasFieldMarshal)): PrivateScope, Public, HideBySig, SpecialName - get_csvFilePath(): PrivateScope, Public, HideBySig, SpecialName - set_csvFilePath(String): PrivateScope, Public, HideBySig, SpecialName - get_ManagementMainDisplay(): PrivateScope, Public, HideBySig, SpecialName - set_ManagementMainDisplay(Rectangle): PrivateScope, Public, HideBySig, SpecialName - get_MultiCommandDisplay(): PrivateScope, Public, HideBySig, SpecialName - set_MultiCommandDisplay(Rectangle): PrivateScope, Public, HideBySig, SpecialName - get_CommunicationSettingDisplay(): PrivateScope, Public, HideBySig, SpecialName - set_CommunicationSettingDisplay(Rectangle): PrivateScope, Public, HideBySig, SpecialName - get_mode(): PrivateScope, Public, HideBySig, SpecialName - set_mode(Int32): PrivateScope, Public, HideBySig, SpecialName - get_channel(): PrivateScope, Public, HideBySig, SpecialName - set_channel(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dimmer(): PrivateScope, Public, HideBySig, SpecialName - set_dimmer(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dimmer2(): PrivateScope, Public, HideBySig, SpecialName - set_dimmer2(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dimmer3(): PrivateScope, Public, HideBySig, SpecialName - set_dimmer3(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dimmer4(): PrivateScope, Public, HideBySig, SpecialName - set_dimmer4(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dimmer5(): PrivateScope, Public, HideBySig, SpecialName - set_dimmer5(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dimmer6(): PrivateScope, Public, HideBySig, SpecialName - set_dimmer6(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dimmer7(): PrivateScope, Public, HideBySig, SpecialName - set_dimmer7(Int32): PrivateScope, Public, HideBySig, SpecialName - get_dimmer8(): PrivateScope, Public, HideBySig, SpecialName - set_dimmer8(Int32): PrivateScope, Public, HideBySig, SpecialName - get_lightMode(): PrivateScope, Public, HideBySig, SpecialName - set_lightMode(Int32): PrivateScope, Public, HideBySig, SpecialName - get_lightMode2(): PrivateScope, Public, HideBySig, SpecialName - set_lightMode2(Int32): PrivateScope, Public, HideBySig, SpecialName - get_lightMode3(): PrivateScope, Public, HideBySig, SpecialName - set_lightMode3(Int32): PrivateScope, Public, HideBySig, SpecialName - get_lightMode4(): PrivateScope, Public, HideBySig, SpecialName - set_lightMode4(Int32): PrivateScope, Public, HideBySig, SpecialName - get_lightMode5(): PrivateScope, Public, HideBySig, SpecialName - set_lightMode5(Int32): PrivateScope, Public, HideBySig, SpecialName - get_lightMode6(): PrivateScope, Public, HideBySig, SpecialName - set_lightMode6(Int32): PrivateScope, Public, HideBySig, SpecialName - get_lightMode7(): PrivateScope, Public, HideBySig, SpecialName - set_lightMode7(Int32): PrivateScope, Public, HideBySig, SpecialName - get_lightMode8(): PrivateScope, Public, HideBySig, SpecialName - set_lightMode8(Int32): PrivateScope, Public, HideBySig, SpecialName - get_powerOnOff(): PrivateScope, Public, HideBySig, SpecialName - set_powerOnOff(OnOffType): PrivateScope, Public, HideBySig, SpecialName - get_powerOnOff2(): PrivateScope, Public, HideBySig, SpecialName - set_powerOnOff2(OnOffType): PrivateScope, Public, HideBySig, SpecialName - get_powerOnOff3(): PrivateScope, Public, HideBySig, SpecialName - set_powerOnOff3(OnOffType): PrivateScope, Public, HideBySig, SpecialName - get_powerOnOff4(): PrivateScope, Public, HideBySig, SpecialName - set_powerOnOff4(OnOffType): PrivateScope, Public, HideBySig, SpecialName - get_powerOnOff5(): PrivateScope, Public, HideBySig, SpecialName - set_powerOnOff5(OnOffType): PrivateScope, Public, HideBySig, SpecialName - get_powerOnOff6(): PrivateScope, Public, HideBySig, SpecialName - set_powerOnOff6(OnOffType): PrivateScope, Public, HideBySig, SpecialName - get_powerOnOff7(): PrivateScope, Public, HideBySig, SpecialName - set_powerOnOff7(OnOffType): PrivateScope, Public, HideBySig, SpecialName - get_powerOnOff8(): PrivateScope, Public, HideBySig, SpecialName - set_powerOnOff8(OnOffType): PrivateScope, Public, HideBySig, SpecialName - get_communicationSetting(): PrivateScope, Public, HideBySig, SpecialName - set_communicationSetting(Int32): PrivateScope, Public, HideBySig, SpecialName - get_commandmodeselectindex(): PrivateScope, Public, HideBySig, SpecialName - set_commandmodeselectindex(Int32): PrivateScope, Public, HideBySig, SpecialName - get_unit(): PrivateScope, Public, HideBySig, SpecialName - set_unit(Int32): PrivateScope, Public, HideBySig, SpecialName - Init(): PrivateScope, Public, HideBySig - MakeSendCommand(String&, String&): PrivateScope, Public, HideBySig - MakeSendCommandPSB3_PSCC_PD3(String&, String&): PrivateScope, Public, HideBySig - MakeSendCommandPFBR(String&, String&): PrivateScope, Public, HideBySig - AnalyzeSendCommand(String, ValueType&, String&, ProtcolType): PrivateScope, Public, HideBySig - CheckReceiveCommand(String&, String&, ValueType CmdSetting IsBoxed, Enum ProtcolType IsBoxed, String&): PrivateScope, Public, HideBySig - CheckReceiveCommand_settingcheck(String&, String, Enum ProtcolType IsBoxed): PrivateScope, Public, HideBySig - CheckReceiveCommand_PFBR(String&, String&, ValueType CmdSetting IsBoxed, Enum ProtcolType IsBoxed, String&): PrivateScope, Public, HideBySig - CheckReceiveCommand_PSB3_PSCC_PD3(String&, String&, ValueType CmdSetting IsBoxed, Enum ProtcolType IsBoxed, String&): PrivateScope, Public, HideBySig - MakeSendCommandComSet(String&, String&): PrivateScope, Public, HideBySig - CheckReceiveCommandComSet(String&, String&): PrivateScope, Public, HideBySig -Struct LightControlCCS_Library.ClsData+PowerType: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - PowerType PowerSeriesPD3 = 0 : Public, Static, Literal, HasDefault - PowerType PowerSeriesPSB3 = 1 : Public, Static, Literal, HasDefault - PowerType PowerSeriesPSCC = 2 : Public, Static, Literal, HasDefault - PowerType PowerSeriesPFBR = 3 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+ProtcolType: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - ProtcolType ProtcolTcpIp = 0 : Public, Static, Literal, HasDefault - ProtcolType ProtcolUdpIp = 1 : Public, Static, Literal, HasDefault - ProtcolType ProtcolEia485 = 2 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+ModeType: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - ModeType ModeDimmer = 0 : Public, Static, Literal, HasDefault - ModeType ModeLight = 1 : Public, Static, Literal, HasDefault - ModeType ModePowerOnOff = 2 : Public, Static, Literal, HasDefault - ModeType ModeCheckSettingStatus = 3 : Public, Static, Literal, HasDefault - ModeType ModeCheckOverCurrent = 4 : Public, Static, Literal, HasDefault - ModeType ModeInitAllChannel = 5 : Public, Static, Literal, HasDefault - ModeType ModeKnobStatus = 6 : Public, Static, Literal, HasDefault - ModeType ModeCommandStatus = 7 : Public, Static, Literal, HasDefault - ModeType ModeVersionCheck = 8 : Public, Static, Literal, HasDefault - ModeType ModeStatusCheck = 9 : Public, Static, Literal, HasDefault - ModeType ModeErrorReset = 10 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+ChannelType: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - ChannelType Ch1 = 0 : Public, Static, Literal, HasDefault - ChannelType Ch2 = 1 : Public, Static, Literal, HasDefault - ChannelType Ch3 = 2 : Public, Static, Literal, HasDefault - ChannelType Ch4 = 3 : Public, Static, Literal, HasDefault - ChannelType Ch5 = 4 : Public, Static, Literal, HasDefault - ChannelType Ch6 = 5 : Public, Static, Literal, HasDefault - ChannelType Ch7 = 6 : Public, Static, Literal, HasDefault - ChannelType Ch8 = 7 : Public, Static, Literal, HasDefault - ChannelType ChAll = 8 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+LightType: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - LightType Always = 0 : Public, Static, Literal, HasDefault - LightType _40us = 1 : Public, Static, Literal, HasDefault - LightType _80us = 2 : Public, Static, Literal, HasDefault - LightType _120us = 3 : Public, Static, Literal, HasDefault - LightType _200us = 4 : Public, Static, Literal, HasDefault - LightType _600us = 5 : Public, Static, Literal, HasDefault - LightType _1ms = 6 : Public, Static, Literal, HasDefault - LightType _4ms = 7 : Public, Static, Literal, HasDefault - LightType _10ms = 8 : Public, Static, Literal, HasDefault - LightType _20ms = 9 : Public, Static, Literal, HasDefault - LightType _40ms = 10 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+OnOffType: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - OnOffType TypeOn = 1 : Public, Static, Literal, HasDefault - OnOffType TypeOff = 0 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+UnitChoice: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - UnitChoice _10bit = 0 : Public, Static, Literal, HasDefault - UnitChoice _8bit = 1 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+ErrorCode: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - ErrorCode NoError = 0 : Public, Static, Literal, HasDefault - ErrorCode InvalidChDimmer = 1 : Public, Static, Literal, HasDefault - ErrorCode InvalidChFlash = 2 : Public, Static, Literal, HasDefault - ErrorCode InvalidChCheckStatus = 3 : Public, Static, Literal, HasDefault - ErrorCode InvalidRcvLength = 4 : Public, Static, Literal, HasDefault - ErrorCode InvalidRcvCommand = 5 : Public, Static, Literal, HasDefault - ErrorCode InvalidRcvChecksum = 6 : Public, Static, Literal, HasDefault - ErrorCode InvalidRcvOutRange = 7 : Public, Static, Literal, HasDefault - ErrorCode Timeout = 8 : Public, Static, Literal, HasDefault - ErrorCode NoData = 9 : Public, Static, Literal, HasDefault - ErrorCode InvalidSndCommand = 10 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+dataActiveType: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - dataActiveType TypeOverWrite = 0 : Public, Static, Literal, HasDefault - dataActiveType TypeInsert = 1 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+CommunicationSettingType: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.Enum - Fields: - Int32 value__ : Public, SpecialName, RTSpecialName - CommunicationSettingType IpAddress = 0 : Public, Static, Literal, HasDefault - CommunicationSettingType SubnetMask = 1 : Public, Static, Literal, HasDefault - CommunicationSettingType ReceivePort = 2 : Public, Static, Literal, HasDefault - CommunicationSettingType DefaultGatWay = 3 : Public, Static, Literal, HasDefault - CommunicationSettingType ReturnAddress = 4 : Public, Static, Literal, HasDefault - CommunicationSettingType ReturnPort = 5 : Public, Static, Literal, HasDefault - CommunicationSettingType IpSubnetGateWay = 6 : Public, Static, Literal, HasDefault -Struct LightControlCCS_Library.ClsData+CmdSetting: AutoLayout, AnsiClass, Class, NestedPublic, SequentialLayout, Sealed, BeforeFieldInit - :System.ValueType - Fields: - Int32 mode : Public - Int32 channel : Public - Int32 dimmer : Public - Int32 lightMode : Public - OnOffType powerOnOff : Public - Methods: - initSetting(): PrivateScope, Public, HideBySig -Struct LightControlCCS_Library.ClsData+SessionSetting: AutoLayout, AnsiClass, Class, NestedPublic, SequentialLayout, Sealed, BeforeFieldInit - :System.ValueType - Fields: - Int32 lineno : Public - ProtcolType protcol : Public - System.String ip_id : Public - System.String rcvport_comport : Public - System.String sndcommand : Public - System.String comment : Public - Int32 interval : Public - System.String datetimedata : Public - System.String rcvcommand : Public - System.String commandresult : Public - Methods: - initSetting(): PrivateScope, Public, HideBySig -Class LightControlCCS_Library.ClsAbstractCom: AutoLayout, AnsiClass, Class, Public, Abstract, BeforeFieldInit - Void .ctor(): PrivateScope, Public, HideBySig, SpecialName, RTSpecialName - Fields: - System.String Ip_Id : Public - Methods: - Open(): PrivateScope, Public, Virtual, HideBySig, VtableLayoutMask, Abstract - Close(): PrivateScope, Public, Virtual, HideBySig, VtableLayoutMask, Abstract - Send(String): PrivateScope, Public, Virtual, HideBySig, VtableLayoutMask, Abstract - ReceiveStart(MyThreadCallback): PrivateScope, Public, Virtual, HideBySig, VtableLayoutMask, Abstract - Abort(): PrivateScope, Public, Virtual, HideBySig, VtableLayoutMask, Abstract - SetEnableMsgbox(Boolean(HasFieldMarshal)): PrivateScope, Public, HideBySig -Class LightControlCCS_Library.ClsAbstractCom+MyThreadCallback: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.MulticastDelegate - Void .ctor(System.Object, IntPtr): PrivateScope, Public, SpecialName, RTSpecialName - Methods: - Invoke(Enum ErrorCode IsBoxed, String): PrivateScope, Public, Final, Virtual, VtableLayoutMask - BeginInvoke(Enum ErrorCode IsBoxed, String, AsyncCallback, Object): PrivateScope, Public, Final, Virtual, VtableLayoutMask - EndInvoke(IAsyncResult): PrivateScope, Public, Final, Virtual, VtableLayoutMask -Class LightControlCCS_Library.ClsUtility: AutoLayout, AnsiClass, Class, Public, BeforeFieldInit - Void .ctor(): PrivateScope, Public, HideBySig, SpecialName, RTSpecialName - Methods: - GetIpAddress(): PrivateScope, Public, Static, HideBySig - ShapeIpAddress(String): PrivateScope, Public, Static, HideBySig -Class LightControlCCS_Library.ClsTcpIpComTh: AutoLayout, AnsiClass, Class, Public, BeforeFieldInit - :LightControlCCS_Library.ClsAbstractCom - Void .ctor(System.String, Int32): PrivateScope, Public, HideBySig, SpecialName, RTSpecialName - Fields: - MyThreadCallback callbackDelegate : Public - Methods: - Open(): PrivateScope, Public, Virtual, HideBySig - Close(): PrivateScope, Public, Virtual, HideBySig - Send(String): PrivateScope, Public, Virtual, HideBySig - ReceiveStart(MyThreadCallback): PrivateScope, Public, Virtual, HideBySig - Abort(): PrivateScope, Public, Virtual, HideBySig -Class LightControlCCS_Library.ManagementMain: AutoLayout, AnsiClass, Class, Public, BeforeFieldInit - Void .ctor(): PrivateScope, Public, HideBySig, SpecialName, RTSpecialName - Interfaces: - System.IDisposable - Methods: - GetNowSetting(): PrivateScope, Public, HideBySig - Connect(String, Int32): PrivateScope, Public, HideBySig - DisConnect(): PrivateScope, Public, HideBySig - SetValue(Int32, Int32): PrivateScope, Public, HideBySig - GetReceiveResult(Enum ErrorCode IsBoxed, String): PrivateScope, Public, HideBySig - Dispose(): PrivateScope, Public, Final, Virtual, HideBySig -Class LightControlCCS_Library.ManagementMain+AddMessageDelegate: AutoLayout, AnsiClass, Class, NestedPublic, Sealed, BeforeFieldInit - :System.MulticastDelegate - Void .ctor(System.Object, IntPtr): PrivateScope, Public, SpecialName, RTSpecialName - Methods: - Invoke(String, String): PrivateScope, Public, Final, Virtual, VtableLayoutMask - BeginInvoke(String, String, AsyncCallback, Object): PrivateScope, Public, Final, Virtual, VtableLayoutMask - EndInvoke(IAsyncResult): PrivateScope, Public, Final, Virtual, VtableLayoutMask diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/LightControlCCS_Library.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/LightControlCCS_Library.dll deleted file mode 100644 index 9aa9be4..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/LightControlCCS_Library.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveCharts.Wpf.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveCharts.Wpf.dll deleted file mode 100644 index 86d4419..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveCharts.Wpf.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveCharts.Wpf.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveCharts.Wpf.xml deleted file mode 100644 index 724c91f..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveCharts.Wpf.xml +++ /dev/null @@ -1,4226 +0,0 @@ - - - - LiveCharts.Wpf - - - - - The gauge chart is useful to display progress or completion. - - - - - Initializes a new instance of the class. - - - - - The wedge property - - - - - The ticks step property - - - - - The labels step property - - - - - From value property - - - - - To value property - - - - - The sections property - - - - - The value property - - - - - The label formatter property - - - - - The disablea animations property - - - - - The animations speed property - - - - - The ticks foreground property - - - - - The sections inner radius property - - - - - The needle fill property - - - - - The labels effect property - - - - - The ticks stroke thickness property - - - - - Gets or sets the opening angle in the gauge - - - - - Gets or sets the separation between every tick - - - - - Gets or sets the separation between every label - - - - - Gets or sets the minimum value of the gauge - - - - - Gets or sets the maximum value of the gauge - - - - - Gets or sets a collection of sections - - - - - Gets or sets the current gauge value - - - - - Gets or sets the label formatter - - - - - Gets or sets whether the chart is animated - - - - - Gets or sets the animations speed - - - - - Gets or sets the ticks foreground - - - - - Gets or sets the inner radius of all the sections in the chart, the unit of this property is percentage, goes from 0 to 1 - - - - - Gets o sets the needle fill - - - - - Gets or sets the labels effect. - - - The labels effect. - - - - - Gets or sets the ticks stroke thickness. - - - The ticks stroke thickness. - - - - - - - - - - - From value property - - - - - To value property - - - - - The fill property - - - - - Gets or sets from value. - - - From value. - - - - - Gets or sets to value. - - - To value. - - - - - Gets or sets the fill. - - - The fill. - - - - - - - - - - - - - - - - - - - - Creates the specified type. - - - - - - - - - - - Gets the point foreground. - - - The point foreground. - - - - - - - - - - - - - - - - - - - An Axis of a chart - - - - - Initializes a new instance of Axis class - - - - - The range changed command property - - - - - The preview range changed command property - - - - - The labels property - - - - - The sections property - - - - - The label formatter property - - - - - The separator property - - - - - The show labels property - - - - - The maximum value property - - - - - The minimum value property - - - - - The maximum range property - - - - - The minimum range property - - - - - The title property - - - - - The position property - - - - - The is merged property - - - - - The disable animations property - - - - - The font family property - - - - - The font size property - - - - - The font weight property - - - - - The font style property - - - - - The font stretch property - - - - - The foreground property - - - - - The labels rotation property - - - - - The bar unit property - - - - - The unit property - - - - - The axis orientation property - - - - - Cleans this instance. - - - - - Renders the separator. - - The model. - The chart. - - - - Updates the title. - - The chart. - The rotation angle. - - - - - Sets the title top. - - The value. - - - - Sets the title left. - - The value. - - - - Gets the title left. - - - - - - Gets the tile top. - - - - - - Gets the size of the label. - - - - - - Ases the core element. - - The chart. - The source. - - - - - Sets the range. - - The minimum. - The maximum. - - - - Updates the chart. - - if set to true [animate]. - if set to true [update now]. - - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Occurs when an axis range changes by an user action (zooming or panning) - - - - - Gets or sets the command to execute when an axis range changes by an user action (zooming or panning) - - - The range changed command. - - - - - Occurs before an axis range changes by an user action (zooming or panning) - - - - - Gets or sets the command to execute before an axis range changes by an user action (zooming or panning) - - - The preview range changed command. - - - - - Gets the Model of the axis, the model is used a DTO to communicate with the core of the library. - - - - - Gets previous Min Value - - - - - Gets previous Max Value - - - - - Gets or sets axis labels, labels property stores the array to map for each index and value, for example if axis value is 0 then label will be labels[0], when value 1 then labels[1], value 2 then labels[2], ..., value n labels[n], use this property instead of a formatter when there is no conversion between value and label for example names, if you are plotting sales vs salesman name. - - - - - Gets or sets the axis sectionsCollection, a section is useful to highlight ranges or values in a chart. - - - - - Gets or sets the function to convert a value to label, for example when you need to display your chart as currency ($1.00) or as degrees (10°), if Labels property is not null then formatter is ignored, and label will be pulled from Labels prop. - - - - - Get or sets configuration for parallel lines to axis. - - - - - Gets or sets if labels are shown in the axis. - - - - - Gets or sets axis max value, set it to double.NaN to make this property Auto, default value is double.NaN - - - - - Gets or sets axis min value, set it to double.NaN to make this property Auto, default value is double.NaN - - - - - Gets the actual minimum value. - - - The actual minimum value. - - - - - Gets the actual maximum value. - - - The actual maximum value. - - - - - Gets or sets the max range this axis can display, useful to limit user zooming. - - - - - Gets or sets the min range this axis can display, useful to limit user zooming. - - - - - Gets or sets axis title, the title will be displayed only if this property is not null, default is null. - - - - - Gets or sets the axis position, default is Axis.Position.LeftBottom, when the axis is at Y and Position is LeftBottom, then axis will be placed at left, RightTop position will place it at Right, when the axis is at X and position LeftBottom, the axis will be placed at bottom, if position is RightTop then it will be placed at top. - - - - - Gets or sets if the axis labels should me placed inside the chart, this is useful to save some space. - - - - - Gets or sets if the axis is animated. - - - - - Gets or sets labels font family, font to use for any label in this axis - - - - - Gets or sets labels font size - - - - - Gets or sets labels font weight - - - - - Gets or sets labels font style - - - - - Gets or sets labels font stretch - - - - - Gets or sets labels text color. - - - - - Gets or sets the labels rotation in the axis, the angle starts as a horizontal line, you can use any angle in degrees, even negatives. - - - - - Gets or sets the bar's series unit width (rows and columns), this property specifies the value in the chart that any bar should take as width. - - - - - Gets or sets the axis unit, setting this property to your actual scale unit (seconds, minutes or any other scale) helps you to fix possible visual issues. - - - The unit. - - - - - Gets or sets the element orientation ind the axis - - - - - - - - - - - - - - - - - - - - Gets or sets labels font weight - - - - - Gets or sets labels text color. - - - - - Initializes a new instance of the class. - - - - - The initial date time property - - - - - The period property - - - - - Maps as core element. - - The chart. - The source. - - - - - Gets or sets the Initial Date Time. - - - - - Gets or sets the period that represents every unit in the axis. - - - - - Defines a condition that decides the fill and stroke to use in a CandleStick series - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The condition. - The stroke. - The fill. - - - - Gets or sets the condition, if the condition returns true, the point will use the defined Stroke/Fill properties in the FinancialColoringRule object - - - The condition. - - - - - Gets or sets the stroke to use when the condition returns true. - - - The stroke. - - - - - Gets or sets the fill to use when the condition returns true. - - - The fill. - - - - - - - - - - - Gets or sets the series. - - - The series. - - - - - - - - - - - Gets or sets the data. - - - The data. - - - - - Gets or sets the selection mode. - - - The selection mode. - - - - - An Logarithmic Axis of a chart - - - - - - Ases the core element. - - The chart. - The source. - - - - - The base property - - - - - Gets or sets the base. - - - The base. - - - - - The Bubble series, draws scatter series, only using X and Y properties or bubble series, if you also use the weight property, this series should be used in a cartesian chart. - - - - - Base WPF and WinForms series, this class is abstract - - - - - Initializes a new Instance of Series - - - - - Initializes a new Instance of series, with a given configuration - - - - - - The values property - - - - - The title property - - - - - The stroke property - - - - - The stroke thickness property - - - - - The fill property - - - - - The data labels property - - - - - The labels template property - - - - - The font family property - - - - - The font size property - - - - - The font weight property - - - - - The font style property - - - - - The font stretch property - - - - - The foreground property - - - - - The stroke dash array property - - - - - The point geometry property - - - - - The scales x at property - - - - - The scales y at property - - - - - The label point property - - - - - The configuration property - - - - - Gets the view of a given point - - - - - - - - This method runs when the update starts - - - - - Erases series - - - - - This method runs when the update finishes - - - - - Initializes the series colors if they are not set - - - - - Defines special elements to draw according to the series type - - - - - Places specializes items - - - - - Gets the label point formatter. - - - - - - Calls the chart updater. - - if set to true [animate]. - - - - - Gets a value indicating whether this instance is first draw. - - - true if this instance is first draw; otherwise, false. - - - - - THe Model is set by every series type, it is the motor of the series, it is the communication with the core of the library - - - - - Gets the Actual values in the series, active or visible series only - - - - - Gets whether the series is visible - - - - - Gets the current chart points in the series - - - - - Gets or sets chart values. - - - - - Gets or sets series title - - - - - Gets or sets series stroke, if this property is null then a SolidColorBrush will be assigned according to series position in collection and Chart.Colors property - - - - - Gets or sets the series stroke thickness. - - - - - Gets or sets series fill color, if this property is null then a SolidColorBrush will be assigned according to series position in collection and Chart.Colors property, also Fill property has a default opacity according to chart type. - - - - - Gets or sets if series should include a label over each data point. - - - - - Gets or sets the labels template. - - - The labels template. - - - - - Gets or sets labels font family - - - - - Gets or sets labels font size - - - - - Gets or sets labels font weight - - - - - Gets or sets labels font style - - - - - Gets or sets labels font stretch - - - - - Gets or sets labels text color. - - - - - Gets or sets the stroke dash array of a series, sue this property to draw dashed strokes - - - - - Gets or sets the point geometry, this shape will be drawn in the Tooltip, Legend, and if line series in every point also. - - - - - Gets or sets the axis where series is scaled at, the axis must exist in the collection - - - - - Gets or sets the axis where series is scaled at, the axis must exist in the collection - - - - - Gets or sets the label formatter for the data label and tooltip, this property is set by default according to the series - - - - - Gets or sets series mapper, if this property is set then the library will ignore the SeriesCollection mapper and global mappers. - - - - - Initializes a new instance of BubbleSeries class - - - - - Initializes a new instance of BubbleSeries class using a given mapper - - - - - - The maximum point shape diameter property - - - - - The minimum point shape diameter property - - - - - Gets the point diameter. - - - - - - Gets the view of a given point - - - - - - - - Gets or sets the max shape diameter, the points using the max weight in the series will have this radius. - - - - - Gets or sets the min shape diameter, the points using the min weight in the series will have this radius. - - - - - DefaultGeoMapTooltip - - - - - Initializes a new instance of the class. - - - - - The corner radius property - - - - - The label formatter property - - - - - The geo data property - - - - - InitializeComponent - - - - - Gets or sets the corner radius. - - - The corner radius. - - - - - Gets or sets the label formatter. - - - The label formatter. - - - - - Gets or sets the geo data. - - - The geo data. - - - - - - - - - - Gets or sets the name. - - - The name. - - - - - Gets or sets the value. - - - The value. - - - - - - - - - - - Converts source values to a value for the binding target. The data binding engine calls this method when it propagates the values from source bindings to the binding target. - - The array of values that the source bindings in the produces. The value indicates that the source binding has no value to provide for conversion. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value.If the method returns null, the valid null value is used.A return value of . indicates that the converter did not produce a value, and that the binding will use the if it is available, or else will use the default value.A return value of . indicates that the binding does not transfer the value or use the or the default value. - - - - - Converts a binding target value to the source binding values. - - The value that the binding target produces. - The array of types to convert to. The array length indicates the number and types of values that are suggested for the method to return. - The converter parameter to use. - The culture to use in the converter. - - An array of values that have been converted from the target value back to the source values. - - - - - - Contains an already defined collection of geometries, useful to set the Series.PointGeomety property - - - - - Returns a null geometry - - - - - Returns a circle geometry - - - - - Returns a square geometry - - - - - Returns a diamond geometry - - - - - Returns a triangle geometry - - - - - Returns a cross geometry - - - - - Interaction logic for HeatColorRange.xaml - - - HeatColorRange - - - - - Initializes a new instance of the class. - - - - - Updates the fill. - - The stops. - - - - Sets the maximum. - - The value. - - - - - Sets the minimum. - - The value. - - - - - InitializeComponent - - - - - The Candle series defines a financial series, add this series to a cartesian chart - - - - - Initializes a new instance of OhclSeries class - - - - - Initializes a new instance of OhclSeries class with a given mapper - - - - - - The maximum column width property - - - - - The increase brush property - - - - - The decrease brush property - - - - - The coloring rules property - - - - - This method runs when the update starts - - - - - Gets the point view. - - The point. - The label. - - - - - Gets or sets the maximum with of a point, a point will be capped to this width. - - - - - Gets or sets the brush of the point when close value is grater than open value - - - - - Gets or sets the brush of the point when close value is less than open value - - - - - Gets or sets the coloring rules, the coloring rules allows you to customize Stroke and Fill properties according to your needs, the first rule in this collection that returns true, will decide the Stroke/Fill of every point. If this property is not null (default is null), CandleSeries Fill/Stroke will be based on DecreaseBrush and IncreaseBrush properties. - - - The coloring rules. - - - - - The SectionsCollection class holds a collection of Axis.Sections - - - - - Initializes a new instance of SectionsCollection instance - - - - - Stores a collection of axis. - - - - - Initializes a new instance of AxisCollection class - - - - - Gets the chart that owns the series. - - - The chart. - - - - - An Axis section highlights values or ranges in a chart. - - - - - Initializes a new instance of AxisSection class - - - - - The label property - - - - - From value property - - - - - To value property - - - - - The value property - - - - - The section width property - - - - - The section offset property - - - - - The stroke property - - - - - The fill property - - - - - The stroke thickness property - - - - - The stroke dash array property - - - - - The draggable property - - - - - The disable animations property - - - - - The data label property - - - - - The data label brush property - - - - - Draws the or move. - - The source. - The axis. - - - - Removes this instance. - - - - - Ases the core element. - - The axis. - The source. - - - - - Gets or sets the model. - - - The model. - - - - - Gets or sets the name, the title of the section, a visual element will be added to the chart if this property is not null. - - - - - Gets or sets the value where the section starts - - - - - Gets or sets the value where the section ends - - - - - Gets or sets the value where the section is drawn - - - - - Gets or sets the section width - - - - - Gets or sets the section offset. - - - The section offset. - - - - - Gets o sets the section stroke, the stroke brush will be used to draw the border of the section - - - - - Gets or sets the section fill brush. - - - - - Gets or sets the stroke thickness. - - - - - Gets or sets the stroke dash array collection, use this property to create dashed stroke sections - - - - - Gets or sets if a user can drag the section - - - - - Gets or sets a value indicating whether the section is animated - - - true if [disable animations]; otherwise, false. - - - - - Gets or sets a value indicating whether the section should display a label that displays its current value. - - - true if [data label]; otherwise, false. - - - - - Gets or sets the data label brush. - - - The label brush. - - - - - The gauge chart is useful to display progress or completion. - - - - - - Initializes a new instance of the class. - - - - - The gauge active fill property - - - - - The labels visibility property - - - - - The gauge render transform property - - - - - The uses360 mode property - - - - - From property - - - - - To property - - - - - The value property - - - - - The inner radius property - - - - - The stroke property - - - - - The stroke thickness property - - - - - To color property - - - - - From color property - - - - - The gauge background property - - - - - The animations speed property - - - - - The disablea animations property - - - - - The label formatter property - - - - - The high font size property - - - - - Gets or sets the gauge active fill, if this property is set, From/to color properties interpolation will be ignored - - - The gauge active fill. - - - - - Gets or sets the labels visibility. - - - The labels visibility. - - - - - Gets or sets the gauge render transform. - - - The gauge render transform. - - - - - Gets or sets whether the gauge uses 360 mode, 360 mode will plot a full circle instead of a semi circle - - - - - Gets or sets the value where the gauge starts - - - - - Gets or sets the value where the gauge ends - - - - - Gets or sets the current value of the gauge - - - - - Gets o sets inner radius - - - - - Gets or sets stroke, the stroke is the brush used to draw the gauge border. - - - - - Gets or sets stroke brush thickness - - - - - Gets or sets the color when the current value equals to min value, any value between min and max will use an interpolated color. - - - - - Gets or sets the color when the current value equals to max value, any value between min and max will use an interpolated color. - - - - - Gets or sets the gauge background - - - - - G3ts or sets the gauge animations speed - - - - - Gets or sets whether the chart is animated - - - - - Gets or sets the label formatter, a label formatter takes a double value, and return a string, e.g. val => val.ToString("C"); - - - - - Gets o sets the label size, if this value is null then it will be automatically calculated, default is null. - - - - - The pie chart compares mainly the distribution of the data according to different series. - - - - - Base chart class - - - - - Chart core model, the model calculates the chart. - - - - - Initializes a new instance of Chart class - - - - - The data click command property - - - - - The data hover command property - - - - - The updater tick command property - - - - - The series colors property - - - - - The axis y property - - - - - The axis x property - - - - - The chart legend property - - - - - The zoom property - - - - - The pan property - - - - - The legend location property - - - - - The series property - - - - - The animations speed property - - - - - The disable animations property - - - - - The data tooltip property - - - - - The hoverable property - - - - - The scroll mode property - - - - - The scroll horizontal from property - - - - - The scroll horizontal to property - - - - - The scroll vertical from property - - - - - The scroll vertical to property - - - - - The scroll bar fill property - - - - - The zooming speed property - - - - - The updater state property - - - - - Sets the draw margin top. - - The value. - - - - Sets the draw margin left. - - The value. - - - - Sets the height of the draw margin. - - The value. - - - - Sets the width of the draw margin. - - The value. - - - - Adds to view. - - The element. - - - - Adds to draw margin. - - The element. - - - - Removes from view. - - The element. - - - - Removes from draw margin. - - The element. - - - - Ensures the element belongs to current view. - - The element. - - - - Ensures the element belongs to current draw margin. - - The element. - - - - Shows the legend. - - At. - - - - Hides the legend. - - - - - Forces the chart to update - - Indicates whether the update should restart the view, animations will run again if true. - Force the updater to run when called, without waiting for the next updater step. - - - - Maps the x axes. - - The chart. - - - - - Maps the y axes. - - The chart. - - - - - Gets the default color of the next. - - - - - - The tooltip timeout property - - - - - Loads the legend. - - - The current legend is not valid, ensure it implements IChartLegend - - - - Hides the tooltip. - - - - - Gets the tooltip position. - - The sender point. - - - - - Calls the chart updater - - if true, the series view will be removed and added again, this restarts animations also. - forces the updater to run as this function is called. - - - - - The DataClick event is fired when a user click any data point - - - - - The DataHover event is fired when a user hovers over any data point - - - - - This event is fired every time the chart updates. - - - - - Gets or sets the data click command. - - - The data click command. - - - - - Gets or sets the data hover command. - - - The data hover command. - - - - - Gets or sets the updater tick command. - - - The updater tick command. - - - - - Gets or sets the chart current canvas - - - - - Gets or sets whether charts must randomize the starting default series color. - - - - - This property need to be true when unit testing - - - - - Gets or sets the application level default series color list - - - - - Gets or sets - - - - - Gets or sets vertical axis - - - - - Gets or sets horizontal axis - - - - - Gets or sets the control to use as chart legend for this chart. - - - - - Gets or sets chart zoom behavior - - - - - Gets or sets the chart pan, default is Unset, which bases the behavior according to Zoom property - - - The pan. - - - - - Gets or sets where legend is located - - - - - Gets or sets chart series collection to plot. - - - - - Gets or sets the default animation speed for this chart, you can override this speed for each element (series and axes) - - - - - Gets or sets if the chart is animated or not. - - - - - Gets or sets the chart data tooltip. - - - - - gets or sets whether chart should react when a user moves the mouse over a data point. - - - - - Gets or sets chart scroll mode - - - - - Gets or sets the scrolling horizontal start value - - - - - Gets or sets the scrolling horizontal end value - - - - - Gets or sets the scrolling vertical start value - - - - - Gets or sets the scrolling vertical end value - - - - - Gets or sets the scroll bar fill brush - - - - - Gets or sets zooming speed, goes from 0.95 (slow) to 0.1 (fast), default is 0.8, it means the current axis range percentage that will be draw in the next zooming step - - - - - Gets or sets chart's updater state - - - - - Gets the chart model, the model is who calculates everything, is the engine of the chart - - - - - Gets whether the chart has an active tooltip. - - - - - Gets whether the chart has a DataClick event attacked. - - - - - Gets whether the chart has a DataHover event attached - - - - - Gets whether the chart is already loaded in the view. - - - - - Gets whether the control is in design mode - - - - - Gets the visible series in the chart - - - - - Gets or sets the time a tooltip takes to hide when the user leaves the data point. - - - - - Initializes a new instance of PieChart class - - - - - The inner radius property - - - - - The starting rotation angle property - - - - - The hover push out property - - - - - Gets the tooltip position. - - The sender point. - - - - - Gets or sets the pie inner radius, increasing this property will result in a doughnut chart. - - - - - Gets or sets the starting rotation angle in degrees. - - - - - Gets or sets the units that a slice is pushed out when a user moves the mouse over data point. - - - - - - - - - - - Initializes a new instance of the class. - - The model. - - - - Updates the label. - - The text. - The axis. - The source. - - - - - Clears the specified chart. - - The chart. - - - - Places the specified chart. - - The chart. - The axis. - The direction. - Index of the axis. - To label. - To line. - The tab. - - - - Removes the specified chart. - - The chart. - - - - Moves the specified chart. - - The chart. - The axis. - The direction. - Index of the axis. - To label. - To line. - The tab. - - - - Fades the in. - - The axis. - The chart. - - - - Fades the out and remove. - - The chart. - - - - Gets the label model. - - - The label model. - - - - - Gets the model. - - - The model. - - - - - - - - - - - Returns whether this converter can convert an object of the given type to the type of this converter, using the specified context. - - An that provides a format context. - A that represents the type you want to convert from. - - true if this converter can perform the conversion; otherwise, false. - - - - - Converts the given object to the type of this converter, using the specified context and culture information. - - An that provides a format context. - The to use as the current culture. - The to convert. - - An that represents the converted value. - - - - - - - - - - - Returns whether this converter can convert an object of the given type to the type of this converter, using the specified context. - - An that provides a format context. - A that represents the type you want to convert from. - - true if this converter can perform the conversion; otherwise, false. - - - - - Converts the given object to the type of this converter, using the specified context and culture information. - - An that provides a format context. - The to use as the current culture. - The to convert. - - An that represents the converted value. - - - - - The default legend control, by default a new instance of this control is created for every chart that requires a legend. - - - DefaultLegend - - - - - Initializes a new instance of DefaultLegend class - - - - - The orientation property - - - - - The internal orientation property - - - - - The bullet size property - - - - - Called when [property changed]. - - Name of the property. - - - - InitializeComponent - - - - - Property changed event - - - - - Gets the series displayed in the legend. - - - - - Gets or sets the orientation of the legend, default is null, if null LiveCharts will decide which orientation to use, based on the Chart.Legend location property. - - - - - Gets or sets the internal orientation. - - - The internal orientation. - - - - - Gets or sets the bullet size, the bullet size modifies the drawn shape size. - - - - - - - - - - - Converts source values to a value for the binding target. The data binding engine calls this method when it propagates the values from source bindings to the binding target. - - The array of values that the source bindings in the produces. The value indicates that the source binding has no value to provide for conversion. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value.If the method returns null, the valid null value is used.A return value of . indicates that the converter did not produce a value, and that the binding will use the if it is available, or else will use the default value.A return value of . indicates that the binding does not transfer the value or use the or the default value. - - - - - Converts a binding target value to the source binding values. - - The value that the binding target produces. - The array of types to convert to. The array length indicates the number and types of values that are suggested for the method to return. - The converter parameter to use. - The culture to use in the converter. - - An array of values that have been converted from the target value back to the source values. - - - - - - The Default Tooltip control, by default any chart that requires a tooltip will create a new instance of this class. - - - DefaultTooltip - - - - - Initializes a new instance of DefaultTooltip class - - - - - Initializes the class. - - - - - The show title property - - - - - The show series property - - - - - The corner radius property - - - - - The selection mode property - - - - - The bullet size property - - - - - The is wrapped property - - - - - Called when [property changed]. - - Name of the property. - - - - InitializeComponent - - - - - Gets or sets a value indicating whether the tooltip should show the shared coordinate value in the current tooltip data. - - - true if [show title]; otherwise, false. - - - - - Gets or sets a value indicating whether should show series name and color. - - - true if [show series]; otherwise, false. - - - - - Gets or sets the corner radius of the tooltip - - - - - Gets or sets the tooltip selection mode, default is null, if this property is null LiveCharts will decide the selection mode based on the series (that fired the tooltip) preferred section mode - - - - - Gets or sets the bullet size, the bullet size modifies the drawn shape size. - - - - - Gets or sets whether the tooltip is shared in the current view, this property is useful to control - the z index of a tooltip according to a set of controls in a container. - - - - - Gets or sets the data. - - - The data. - - - - - Occurs when [property changed]. - - - - - - - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - - - - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - - - - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - A converted value. If the method returns null, the valid null value is used. - - - - - - - - - - - - Converts source values to a value for the binding target. The data binding engine calls this method when it propagates the values from source bindings to the binding target. - - The array of values that the source bindings in the produces. The value indicates that the source binding has no value to provide for conversion. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value.If the method returns null, the valid null value is used.A return value of . indicates that the converter did not produce a value, and that the binding will use the if it is available, or else will use the default value.A return value of . indicates that the binding does not transfer the value or use the or the default value. - - - - - Converts a binding target value to the source binding values. - - The value that the binding target produces. - The array of types to convert to. The array length indicates the number and types of values that are suggested for the method to return. - The converter parameter to use. - The culture to use in the converter. - - An array of values that have been converted from the target value back to the source values. - - - - - - Contains information about data in a tooltip - - - - - The current X formatter - - - - - The current Y formatter - - - - - Shared coordinate value between points - - - - - Gets or sets the series that fired the tooltip. - - - The sender series. - - - - - Current selection mode - - - - - collection of points - - - - - Point Data - - - - - Gets info about the series that owns the point, like stroke and stroke thickness - - - - - Gets the ChartPoint instance - - - - - Series Data - - - - - Series Title - - - - - Series stroke - - - - - Series Stroke thickness - - - - - Series Fill - - - - - Series point Geometry - - - - - - - - - - - The radius property - - - - - The push out property - - - - - The inner radius property - - - - - The wedge angle property - - - - - The rotation angle property - - - - - The centre x property - - - - - The centre y property - - - - - The percentage property - - - - - The piece value property - - - - - Draws the pie piece - - - - - The radius of this pie piece - - - - - The distance to 'push' this pie piece out from the centre. - - - - - The inner radius of this pie piece - - - - - The wedge angle of this pie piece in degrees - - - - - The rotation, in degrees, from the Y axis vector of this pie piece. - - - - - The X coordinate of centre of the circle from which this pie piece is cut. - - - - - The Y coordinate of centre of the circle from which this pie piece is cut. - - - - - The percentage of a full pie that this piece occupies. - - - - - The value that this pie piece represents. - - - - - Gets a value that represents the of the . - - - - - - - - - - Converts a coordinate from the polar coordinate system to the cartesian coordinate system. - - - - - - - - Use a HeatSeries in a cartesian chart to draw heat maps. - - - - - Initializes a new instance of HeatSeries class - - - - - Initializes a new instance of HeatSries class, using a given mapper - - - - - - The draws heat range property - - - - - The gradient stop collection property - - - - - Gets the view of a given point - - - - - - - - Erases series - - - - - - Defines special elements to draw according to the series type - - - - - Places specializes items - - - - - Initializes the series colors if they are not set - - - - - Gets or sets whether the series should draw the heat range control, it is the vertical frame to the right that displays the heat gradient. - - - - - Gets or sets the gradient stop collection, use every gradient offset and color properties to define your gradient. - - - - - Gets the gradient stops, this property is normally used internally to communicate with the core of the library. - - - - - The pie series should be added only in a pie chart. - - - - - Initializes a new instance of PieSeries class - - - - - Initializes a new instance of PieSeries class with a given mapper. - - - - - - The push out property - - - - - The label position property - - - - - Gets the view of a given point - - - - - - - - Gets or sets the slice push out, this property highlights the slice - - - - - Gets or sets the label position. - - - The label position. - - - - - The OHCL series defines a financial series, add this series to a cartesian chart - - - - - Initializes a new instance of OhclSeries class - - - - - Initializes a new instance of OhclSeries class with a given mapper - - - - - - The maximum column width property - - - - - The increase brush property - - - - - The decrease brush property - - - - - This method runs when the update starts - - - - - Gets the point view. - - The point. - The label. - - - - - Gets or sets the maximum with of a point, a point will be capped to this width. - - - - - Gets or sets the brush of the point when close value is grater than open value - - - - - Gets or sets the brush of the point when close value is less than open value - - - - - The stacked area compares trends and percentage, add this series to a cartesian chart - - - - - - - The line series displays trends between points, you must add this series to a cartesian chart. - - - - - Initializes a new instance of LineSeries class - - - - - Initializes a new instance of LineSeries class with a given mapper - - - - - - The point geometry size property - - - - - The point foreground property - - - - - The line smoothness property - - - - - The area limit property - - - - - This method runs when the update starts - - - - - Gets the view of a given point - - - - - - - - This method runs when the update finishes - - - - - Erases series - - - - - - Gets the point diameter. - - - - - - Starts the segment. - - At index. - The location. - - - - Ends the segment. - - At index. - The location. - - - - Gets or sets the figure. - - - The figure. - - - - - Gets or sets a value indicating whether this instance is path initialized. - - - true if this instance is path initialized; otherwise, false. - - - - - Gets or sets the active splitters. - - - The active splitters. - - - - - Gets or sets the splitters collector. - - - The splitters collector. - - - - - Gets or sets a value indicating whether this instance is new. - - - true if this instance is new; otherwise, false. - - - - - Gets or sets the point geometry size, increasing this property will make the series points bigger - - - - - Gets or sets the point shape foreground. - - - - - Gets or sets line smoothness, this property goes from 0 to 1, use 0 to draw straight lines, 1 really curved lines. - - - - - Gets or sets the limit where the fill area changes orientation - - - - - Initializes a new instance of StackedAreaSeries class - - - - - Initializes a new instance of StackedAreaSeries class, with a given mapper - - - - - The stack mode property - - - - - This method runs when the update starts - - - - - Gets or sets the series stacked mode, values or percentage - - - - - The stacked row series compares the proportion of every series in a point - - - - - Initializes a new instance of StackedRow series class - - - - - Initializes a new instance of StackedRow series class, with a given mapper - - - - - The maximum row height property - - - - - The row padding property - - - - - The stack mode property - - - - - The labels position property - - - - - Gets the view of a given point - - - - - - - - Gets or sets the maximum height of row, any row height will be capped at this value. - - - - - Gets or sets the padding between each row in the series. - - - - - Gets or sets the stacked mode, values or percentage. - - - - - Gets or sets where the label is placed - - - - - The stacked column series compares the proportion of every series in a point - - - - - Initializes a new instance of StackedColumnSeries class - - - - - Initializes a new instance of StackedColumnSeries class, with a given mapper - - - - - The maximum column width property - - - - - The column padding property - - - - - The stack mode property - - - - - The labels position property - - - - - Gets the view of a given point - - - - - - - - Gets or sets the maximum width of a column, any column will be capped at this value - - - - - Gets or sets the padding between every column in this series - - - - - Gets or sets stacked mode, values or percentage - - - - - Gets or sets where the label is placed - - - - - The Row series plots horizontal bars in a cartesian chart - - - - - Initializes a new instance of RowSeries class - - - - - Initializes a new instance of RowSeries class with a given mapper - - - - - - The maximum row heigth property - - - - - The row padding property - - - - - The labels position property - - - - - The shares position property - - - - - Gets the point view. - - The point. - The label. - - - - - Gets or sets the maximum row height, the height of a column will be capped at this value - - - - - Gets or sets the padding between rows in this series - - - - - Gets or sets where the label is placed - - - - - Gets or sets a value indicating whether this row shares space with all the row series in the same position - - - true if [shares position]; otherwise, false. - - - - - Use the column series to plot horizontal bars in a cartesian chart - - - - - Initializes a new instance of ColumnSeries class - - - - - Initializes a new instance of ColumnSeries class, using a given mapper - - - - - The maximum column width property - - - - - The column padding property - - - - - The labels position property - - - - - The shares position property - - - - - Gets the view of a given point - - - - - - - - Gets or sets the MaxColumnWidht in pixels, the column width will be capped at this value. - - - - - Gets or sets the padding between the columns in the series. - - - - - Gets or sets where the label is placed - - - - - Gets or sets a value indicating whether this column shares space with all the column series in the same position - - - - - The Step line series. - - - - - Initializes a new instance of BubbleSeries class - - - - - Initializes a new instance of BubbleSeries class using a given mapper - - - - - - The point geometry size property - - - - - The point foreround property - - - - - The alternative stroke property - - - - - The inverted mode property - - - - - Gets the view of a given point - - - - - - - - Initializes the series colors if they are not set - - - - - Gets the point diameter. - - - - - - Gets or sets the point geometry size, increasing this property will make the series points bigger - - - - - Gets or sets the point shape foreground. - - - - - Gets or sets the alternative stroke. - - - The alternative stroke. - - - - - Gets or sets a value indicating whether the series should be drawn using the inverted mode. - - - true if [inverted mode]; otherwise, false. - - - - - Compares trend and proportion, this series must be added in a cartesian chart. - - - - - The vertical line series is useful to compare trends, this is the inverted version of the LineSeries, this series must be added in a cartesian chart. - - - - - Initializes an new instance of VerticalLineSeries class - - - - - Initializes an new instance of VerticalLineSeries class, with a given mapper - - - - - This method runs when the update starts - - - - - Gets the view of a given point - - - - - - - - Starts the segment. - - At index. - The location. - - - - Ends the segment. - - At index. - The location. - - - - Initializes a new instance of VerticalStackedAreaSeries class - - - - - Initializes a new instance of VerticalStackedAreaSeries class, with a given mapper - - - - - The stack mode property - - - - - This method runs when the update starts - - - - - Gets or sets the series stack mode, values or percentage - - - - - Contains a collection of already defined axes. - - - - - Returns default axis - - - - - Return an axis without separators at all - - - - - Returns an axis that only displays a line for zero - - - - - Gets the clean separator. - - - The clean separator. - - - - - A tooltip element data transfer object - - - - - Gets or sets the series. - - - The series. - - - - - Gets or sets the index. - - - The index. - - - - - Gets or sets the stroke. - - - The stroke. - - - - - Gets or sets the fill. - - - The fill. - - - - - Gets or sets the point. - - - The point. - - - - - Gets or sets the value. - - - The value. - - - - - The Cartesian chart can plot any series with x and y coordinates - - - - - Initializes a new instance of CartesianChart class - - - - - The visual elements property - - - - - Gets or sets the collection of visual elements in the chart, a visual element display another UiElement in the chart. - - - - - - - - - - Converts a point at screen to chart values scale - - Target chart - point in screen - axis x index - axis y index - - - - - Converts a chart values pair to pixels - - Target chart - point in screen - axis x index - axis y index - - - - - Converts a ChartPoint to Point - - point to convert - - - - - Converts a CorePoint to Point - - point to convert - - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Defines an Axis.Separator, this class customizes the separator of an axis. - - - - - Initializes a new instance of Separator class - - - - - The stroke property - - - - - The stroke thickness property - - - - - The stroke dash array property - - - - - The step property - - - - - The actual step property - - - - - The axis orientation property - - - - - Ases the core element. - - The axis. - The source. - - - - - Gets the chart the own the separator - - - - - Gets or sets separators color - - - - - Gets or sets separators thickness - - - - - Gets or sets the stroke dash array for the current separator. - - - - - Gets or sets separators step, this means the value between each line, default is null, when null this value is calculated automatically. - - - - - Gets the actual step. - - - The actual step. - - - - - Gets or sets the element orientation ind the axis - - - - - Defines a visual element, a visual element is a UI element that is placed and scaled in the chart. - - - - - The x property - - - - - The y property - - - - - Adds the or move. - - The chart. - - - - - - Removes the specified chart. - - The chart. - - - - Gets or sets the user interface element. - - - - - Gets or sets the index of the axis in X that owns the element, the axis position must exist. - - - - - Gets or sets the index of the axis in Y that owns the element, the axis position must exist. - - - - - Gets or sets the X value of the UiElement - - - - - Gets or sets the Y value of the UiElement - - - - - - - - - - - Initializes a new instance of the class. - - - - - The language pack property - - - - - The default land fill property - - - - - The land stroke thickness property - - - - - The land stroke property - - - - - The disable animations property - - - - - The animations speed property - - - - - The hoverable property - - - - - The heat map property - - - - - The gradient stop collection property - - - - - The source property - - - - - The enable zooming and panning property - - - - - Restarts the current map view - - - - - Sets a heat map value with a given key, then updates every land heat color - - key - new value - - - - Occurs when [land click]. - - - - - Gets or sets the language dictionary - - - - - Gets or sets default land fill - - - - - Gets or sets every land stroke thickness property - - - - - Gets or sets every land stroke - - - - - Gets or sets whether the chart is animated - - - - - Gets or sets animations speed - - - - - Gets or sets whether the chart reacts when a user moves the mouse over a land - - - - - Gets or sets the current heat map - - - - - Gets or sets the gradient stop collection, use every gradient offset and color properties to define your gradient. - - - - - Gets or sets the map source - - - - - Gets or sets whether the map allows zooming and panning - - - - - - - - - - - Converts source values to a value for the binding target. The data binding engine calls this method when it propagates the values from source bindings to the binding target. - - The array of values that the source bindings in the produces. The value indicates that the source binding has no value to provide for conversion. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - A converted value.If the method returns null, the valid null value is used.A return value of . indicates that the converter did not produce a value, and that the binding will use the if it is available, or else will use the default value.A return value of . indicates that the binding does not transfer the value or use the or the default value. - - - - - Converts a binding target value to the source binding values. - - The value that the binding target produces. - The array of types to convert to. The array length indicates the number and types of values that are suggested for the method to return. - The converter parameter to use. - The culture to use in the converter. - - An array of values that have been converted from the target value back to the source values. - - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveCharts.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveCharts.dll deleted file mode 100644 index 66f4661..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveCharts.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveCharts.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveCharts.xml deleted file mode 100644 index 0388349..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveCharts.xml +++ /dev/null @@ -1,5496 +0,0 @@ - - - - LiveCharts - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - Gets the formatter. - - - - - - Clears the separators. - - - - - Initializes the garbage collector. - - - - - Gets or sets the chart. - - - The chart. - - - - - Gets or sets the view. - - - The view. - - - - - Gets or sets the labels. - - - The labels. - - - - - Gets or sets the sections. - - - The sections. - - - - - Gets or sets the label formatter. - - - The label formatter. - - - - - Gets or sets the stroke thickness. - - - The stroke thickness. - - - - - Gets or sets a value indicating whether [show labels]. - - - true if [show labels]; otherwise, false. - - - - - Gets or sets the maximum value. - - - The maximum value. - - - - - Gets or sets the minimum value. - - - The minimum value. - - - - - Gets or sets the title. - - - The title. - - - - - Gets or sets a value indicating whether [disable animations]. - - - true if [disable animations]; otherwise, false. - - - - - Gets or sets the position. - - - The position. - - - - - Gets or sets a value indicating whether this instance is merged. - - - true if this instance is merged; otherwise, false. - - - - - Gets a value indicating whether [evaluates unit width]. - - - true if [evaluates unit width]; otherwise, false. - - - - - Gets the current separators. - - - The current separators. - - - - - Gets or sets the separator. - - - The separator. - - - - - Gets the s. - - - The s. - - - - - Cartesian Axis orientation - - - - - Unknown orientation - - - - - Horizontal (X) - - - - - Vertical (Y) - - - - - Axis position - - - - - Left for Y axis, Bottom for X axis - - - - - Right for Y axis, Top for X axis - - - - - - - - - - Initializes a new instance of the class. - - The view. - The chart. - - - - Gets or sets the view. - - - The view. - - - - - Gets or sets the source. - - - The source. - - - - - Gets or sets the index of the axis. - - - The index of the axis. - - - - - Gets or sets the chart. - - - The chart. - - - - - - - - - - - - - - - Determines whether a dateTime is a header - - - - - Gets or sets a function to determine whether a dateTime is a separator - - - - - Gets or sets a function to format the label for the axis - - - - - Gets the minimum reserved space for separators - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Describes where a label should be placed - - - - - Places a label at the top of a bar - - - - - Places a labels inside the bar - - - - - Places a labels in a parallel orientation to the bar height. - - - - - Places a labels in a perpendicular orientation to the bar height. - - - - - Contains useful methods to apply to a chart - - - - - Converts from chart values to chart control size. - - value to scale - axis orientation to scale value at - chart model to scale value at - axis index in collection of chart.axis - - - - - Converts from chart values to chart control size. - - value to scale - axis orientation to scale value at - chart model to scale value at - axis model instance - - - - - Converts from chart control size to chart values. - - value to scale - axis orientation to scale value at - chart model to scale value at - axis index in collection of chart.axis - - - - - Converts from chart values to chart draw margin size. - - value to scale - axis orientation - chart model to scale the value at - axis instance to scale the value at - - - - - Converts from chart values to chart draw margin size. - - value to scale - axis orientation - chart model to scale the value at - axis instance to scale the value at - - - - - Converts from chart values to chart draw margin size. - - point to scale - axis orientation - axis instance to scale the value at - chart model to scale the value at - - - - - Gets the width of a unit in the chart - - axis orientation - chart model to get the scale at - axis index in the axes collection - - - - - Gets the width of a unit in the chart - - axis orientation - chart model to get the scale at - axis instance - - - - - Returns data in the chart according to: - - point that was hovered - chart model to get the data from - selection mode - - - - - Global LiveCharts configuration - - - - - Saves a type mapper globally. - - Type to configure - mapper - mapper orientation - - - - Gets the configuration of a given type and orientation - - type to look for - orientation to look for - - - - - Defines a point in the chart - - - - - Gets the X point value - - - - - Gets the Y point value - - - - - Gets the Gantt x start value - - - - - Gets the Gantt y start value - - - - - Gets the Weight of the point - - - - - Gets where the stacked value started from - - - - - Gets where the stacked value finishes - - - - - Get the total sum of the stacked elements - - - - - Get the participation of the point in the stacked elements - - - - - gets the stacked participation of a point - - - - - Gets the Open value of the point - - - - - Gets the High value of the point - - - - - Gets the Low value of the point - - - - - Gets the Close value of the point - - - - - Gets the Radius of a point - - - - - Gets the angle of a point - - - - - Gets the Fill brush of this point, this property overrides series Fill property - - - - - Gets the Stroke brush of this point, this property overrides series Stroke property - - - - - Gets the coordinate where the value is placed at chart - - - - - Gets the index of this point in the chart - - - - - Gets the object where the chart pulled the point - - - - - Gets or sets the view of this chart point - - - - - Gets the series where the point belongs to - - - - - Gets the chart view. - - - The chart view. - - - - - Chart Model - - - - - - - - - - Initializes a new instance of the class. - - The view. - The updater. - - - - Initializes the class. - - - - - Prepares the axes. - - - - - Runs the specialized chart components. - - - - - Calculates the components and margin. - - - - - Places the legend. - - The draw margin. - - - - - - Zooms the in. - - The pivot. - - - - Zooms the out. - - The pivot. - - - - Clears the zoom. - - - - - Drags the specified delta. - - The delta. - - - - Stacks the points. - - The stackables. - The stack at. - Index of the stack. - The mode. - - - - Gets or sets the configurations. - - - The configurations. - - - - - Gets or sets a value indicating whether [series initialized]. - - - true if [series initialized]; otherwise, false. - - - - - Gets or sets a value indicating whether [are components loaded]. - - - true if [are components loaded]; otherwise, false. - - - - - Gets or sets the view. - - - The view. - - - - - Gets or sets the updater. - - - The updater. - - - - - Gets or sets the size of the control. - - - The size of the control. - - - - - Gets or sets the draw margin. - - - The draw margin. - - - - - Gets or sets a value indicating whether this instance has unitary points. - - - true if this instance has unitary points; otherwise, false. - - - - - Gets a value indicating whether [requires hover shape]. - - - true if [requires hover shape]; otherwise, false. - - - - - Gets or sets the axis x. - - - The axis x. - - - - - Gets or sets the axis y. - - - The axis y. - - - - - Gets or sets the x limit. - - - The x limit. - - - - - Gets or sets the y limit. - - - The y limit. - - - - - Gets or sets the w limit. - - - The w limit. - - - - - Gets or sets the index of the current color. - - - The index of the current color. - - - - - Gets or sets the pan origin. - - - The pan origin. - - - - - Initializes Chart model - - The view. - The updater. - - - - Prepares Chart Axes - - - - - Runs the specialized chart components. - - - - - Draws the or update sections. - - - - - - - - - - - Initializes a new instance of the class. - - The view. - The updater. - - - - Prepares the axes. - - There is a invalid series in the series collection, " + - "verify that all the series implement IPieSeries. - - - - - - - - - Runs the specified restart view. - - if set to true [restart view]. - if set to true [update now]. - - - - - Updates the frequency. - - The freq. - - - - - Updates the specified restarts animations. - - if set to true [restarts animations]. - - - - - Gets or sets the chart. - - - The chart. - - - - - Gets or sets a value indicating whether this instance is updating. - - - true if this instance is updating; otherwise, false. - - - - - Gets or sets a value indicating whether [restart view requested]. - - - true if [restart view requested]; otherwise, false. - - - - - Creates a collection of chart values - - Type to plot, notice you could need to configure the type. - - - - A collection that notifies every time a value is added or removed - - - - - - - - - - - - Adds the range. - - The items. - - - - Inserts the range. - - The index. - The collection. - - - - Occurs when [noisy collection changed]. - - - - - Initializes a new instance of NoisyCollection class - - - - - Initializes a new instance of NoisyCollection class with a given collection - - given collection - - - - Initializes a new instance of NoisiCollection class with a given capacity - - given capacity - - - - Enumerates the collection - - collection enumeration - - - - Enumerates the collection - - collection enumeration - - - - Adds an object to the collection, and notifies the change - - item to add - number of items in the collection - - - - Add an item to the collection, and notifies the change - - number of items in the collection - - - - Adds many items to the collection, and notifies the change - - collection to add - - - - Adds many items to the collection, and notifies the change - - collection to add - - - - Insert an item in a specific index, then notifies the change - - index to insert at - item to insert - - - - Insert an item in a specific index, then notifies the change - - index to insert at - item to insert - - - - Insert a range of values, starting in a specific index, then notifies the change - - index to start at - collection to insert - - - - Insert a range of values, starting in a specific index, then notifies the change - - index to start at - collection to insert - - - - Removes an item from a collection, then notifies the change - - item to remove - - - - Remove an item from a collection, then notifies the change - - item to remove - number of items in the collection - - - - Removes an item at a specific index, then notifies the change - - index to remove at - - - - Removes an item at a specific index, then notifies the change - - index to remove at - - - - Removes an item at a specific index, then notifies the change - - index to remove at - - - - Removes all the items from the collection, then notifies the change - - - - - Removes all the items from the collection, then notifies the change - - - - - Removes all the items from the collection, then notifies the change - - - - - Evaluates whether an item is in this collection - - object to look for - evaluation - - - - Evaluates whether an item is in this collection - - item to look for - evaluation - - - - Copies the collection to another array - - backup array - array index - - - - Copies the collection to another array - - backup array - array index - - - - Returns the index of an item in the collection - - item to look for - - - - - Returns the index of an item in the collection - - item to look for - - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Occurs when [collection reset]. - - - - - Occurs when [noisy collection changed]. - - - - - Occurs when [noisy collection changed]. - - - - - Occurs when the collection changes. - - - - - Occurs when a property value changes. - - - - - Occurs when a property value changes. - - - - - Gets or sets an item from/in a specific index - - index to get/set - - - - - Gets or sets an item from/in a specific index - - index to get/set - - - - - Gets the number of items in the array - - items count - - - - Gets whether the collection is read only - - result - - - - Gets the number of items in the array - - result - - - - Gets whether the collection is synchronized - - result - - - - Gets the collections's sync root - - - - - Gets whether the collection is fixed - - - - - - - - - - - Forces values to calculate max, min and index data. - - - - - Gets the current chart points in the view, the view is required as an argument, because an instance of IChartValues could hold many ISeriesView instances. - - The series view - - - - - Initializes the garbage collector - - - - - Removes all unnecessary points from the view - - - - - Gets series that owns the values - - - - - Initializes a new instance of chart values - - - - - Initializes a new instance of chart values, with a given collection - - - - - Evaluates the limits in the chart values - - - - - Gets the current chart points in the view, the view is required as an argument, because an instance of IChartValues could hold many ISeriesView instances. - - The series view - - - - - Initializes the garbage collector - - - - - Collects the unnecessary values - - - - - Gets series that owns the values - - - - - - - Mapper to configure X and Y points - - Type to configure - - - - - - - - - - Evaluates the specified key. - - The key. - The value. - The point. - - - - Sets values for a specific point - - Point to set - - - - - - Sets the X mapper - - function that pulls X coordinate - current mapper instance - - - - Sets the X mapper - - function that pulls X coordinate, with value and index as parameters - current mapper instance - - - - Sets the Y mapper - - function that pulls Y coordinate - current mapper instance - - - - Sets the Y mapper - - function that pulls Y coordinate, with value and index as parameters - current mapper instance - - - - Sets the Stroke of the point - - - - - - - Sets the Stroke of the point - - - - - - - Sets the Fill of the point - - - - - - - Sets the Fill of the point - - - - - - - Mapper to configure financial points - - type to configure - - - - Sets values for a specific point - - Point to set - - - - - - Maps X value - - function that pulls X coordinate - current mapper instance - - - - Maps X value - - function that pulls X coordinate, with value and index as parameters - current mapper instance - - - - Maps Y value - - function that pulls Y coordinate - current mapper instance - - - - Maps Y value - - function that pulls Y coordinate, with value and index as parameters - current mapper instance - - - - Maps Open value - - function that pulls open value - current mapper instance - - - - Maps Open value - - function that pulls open value, value and index as parameters - current mapper instance - - - - Maps High value - - function that pulls High value - current mapper instance - - - - Maps High value - - function that pulls High value - current mapper instance - - - - Maps Close value - - function that pulls close value - current mapper instance - - - - Maps Close value - - function that pulls close value, value and index as parameters - current mapper instance - - - - Maps Low value - - function that pulls low value - current mapper instance - - - - Maps Low value - - function that pulls low value, index and value as parameters - current mapper instance - - - - Mapper to configure X and Y points - - Type to configure - - - - Sets values for a specific point - - Point to set - - - - - - Sets the X mapper - - function that pulls X coordinate - current mapper instance - - - - Sets the X mapper - - function that pulls X coordinate, with value and index as parameters - current mapper instance - - - - Sets the XStart mapper - - function that pulls X coordinate - current mapper instance - - - - Sets the XStart mapper - - function that pulls X coordinate, with value and index as parameters - current mapper instance - - - - Sets the Y mapper - - function that pulls Y coordinate - current mapper instance - - - - Sets the Y mapper - - function that pulls Y coordinate, with value and index as parameters - current mapper instance - - - - Sets the YStart mapper - - function that pulls Y coordinate - current mapper instance - - - - Sets the YStart mapper - - function that pulls Y coordinate, with value and index as parameters - current mapper instance - - - - Sets the Stroke of the point - - - - - - - Sets the Stroke of the point - - - - - - - Sets the Fill of the point - - - - - - - Sets the Fill of the point - - - - - - - Gets the already built point mappers - - - - - Gets a mapper to configure X, Y points - - Type to map - A new cartesian mapper instance - - - - Gets a mapper to configure financial points - - type to map - a new financial mapper instance - - - - Gets a mapper to configure X, Y and Weight points - - type to map - a new weighted mapper instance - - - - Gets a Gantt Mapper - - type to amp - a new polar mapper insance - - - - Gets a mapper to configure Radius and Angle - - type to amp - a new polar mapper insance - - - - PGets a mapper to configure a pie chart - - - - - - - Mapper to configure X and Y points - - Type to configure - - - - Sets values for a specific point - - Point to set - - - - - - Sets the Y mapper - - function that pulls Y coordinate - current mapper instance - - - - Sets the Y mapper - - function that pulls Y coordinate, with value and index as parameters - current mapper instance - - - - Sets the Stroke of the point - - - - - - - Sets the Stroke of the point - - - - - - - Sets the Fill of the point - - - - - - - Sets the Fill of the point - - - - - - - Mapper to configure polar series - - - - - - Sets values for a specific point - - Point to set - - - - - - Maps X value - - function that pulls the radius value - current mapper instance - - - - Maps X value - - function that pulls the radius value, value and index as parameters - current mapper instance - - - - Maps Y value - - function that pulls the angle value - current mapper instance - - - - Maps Y value - - function that pulls the angle value, value and index as parameters - current mapper instance - - - - Sets the Stroke of the point - - - - - - - Sets the Stroke of the point - - - - - - - Sets the Fill of the point - - - - - - - Sets the Fill of the point - - - - - - - Mapper to configure Bubble points - - type to configure - - - - Sets values for a specific point - - Point to set - - - - - - Sets the X mapper - - function that pulls the X coordinate - current mapper instance - - - - Sets the X mapper - - function that pulls the X coordinate, value and index as parameters - current mapper instance - - - - Sets the Y mapper - - function that pulls the Y coordinate - current mapper instance - - - - Sets the Y mapper - - function that pulls the Y coordinate, value and index as parameters - current mapper instance - - - - Sets Weight mapper - - function that pulls the point's weight - current mapper instance - - - - Sets Weight mapper - - function that pulls the point's weight, value and index as parameters - current mapper instance - - - - Sets the Stroke of the point - - - - - - - Sets the Stroke of the point - - - - - - - Sets the Fill of the point - - - - - - - Sets the Fill of the point - - - - - - - Describes a data label view model - - - - - Gets or sets the formatted text of the current point - - - The formatted text. - - - - - Gets the instance of the current point. - - - The instance. - - - - - - - - - - Provides an axis that displays separators based upon configured windows - - - - - - - - - - - - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - - - - - - - - - - - - - - - - - - - Determines whether a dateTime is a header - - - - - Gets or sets a function to determine whether a dateTime is a separator - - - - - Gets or sets a function to format the label for the axis - - - - - - - - - - - - - - - Updates the title. - - The chart. - The rotation angle. - - - - - Sets the title top. - - The value. - - - - Sets the title left. - - The value. - - - - Gets the title left. - - - - - - Gets the tile top. - - - - - - Gets the size of the label. - - - - - - Ases the core element. - - The chart. - The source. - - - - - Renders the separator. - - The model. - The chart. - - - - Cleans this instance. - - - - - Sets the range. - - The minimum. - The maximum. - - - - Gets or sets the model. - - - The model. - - - - - Gets or sets a value indicating whether [disable animations]. - - - true if [disable animations]; otherwise, false. - - - - - Gets or sets a value indicating whether [show labels]. - - - true if [show labels]; otherwise, false. - - - - - Gets or sets the maximum value. - - - The maximum value. - - - - - Gets or sets the minimum value. - - - The minimum value. - - - - - Gets or sets the minimum range. - - - The minimum range. - - - - - Gets or sets the maximum range. - - - The maximum range. - - - - - Gets or sets the labels rotation. - - - The labels rotation. - - - - - Gets or sets a value indicating whether this instance is merged. - - - true if this instance is merged; otherwise, false. - - - - - Gets or sets the bar unit. - - - The bar unit. - - - - - Gets or sets the bar unit. - - - The bar unit. - - - - - Gets the previous maximum value. - - - The previous maximum value. - - - - - Gets the previous minimum value. - - - The previous minimum value. - - - - - Gets the axis orientation. - - - The axis orientation. - - - - - Defines a financial coloring rule delegate - - The current point - The previous point - - - - - - - - - Gets preconfigured windows that can be used to build a datetime window axis - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets or sets a value indicating whether this instance is new. - - - true if this instance is new; otherwise, false. - - - - - Gets or sets the state. - - - The state. - - - - - Gets or sets the index of the garbage collector. - - - The index of the garbage collector. - - - - - Gets or sets the key. - - - The key. - - - - - Gets or sets the value. - - - The value. - - - - - Gets or sets the view. - - - The view. - - - - - Gets or sets a value indicating whether this separator is a header separator - - - - - An already configured chart point with a date time and a double properties, this class notifies the chart to update every time a property changes - - - - - Initializes a new instance of DateTimePoint class - - - - - Initializes a new instance of DateTimePoint class, giving date time and value - - - - - - - Called when [property changed]. - - Name of the property. - - - - DateTime Property - - - - - The Value property - - - - - Occurs when a property value changes. - - - - - Defines a Gantt point in a cartesian chart - - - - - Initializes a new instance of GanttPoint class. - - - - - Initializes a new instance of GanttPoint class with given start and end points. - - - - - Called when [property changed]. - - Name of the property. - - - - Gets or sets point start - - - - - Gets or sets point end - - - - - Occurs when a property value changes. - - - - - An already configured weighted chart point, this class notifies the chart to update every time a property changes - - - - - An already configured weighted chart point, this class notifies the chart to update every time a property changes - - - - - Creates a new instance of BubblePoint class - - - - - Create a new instance of BubblePoint class, giving x and y coordinates - - - - - - - Creates a new instance of BubblePoint class, giving x, y and weight - - - - - - - - Called when [property changed]. - - Name of the property. - - - - X coordinate in the chart - - - - - Y coordinate in the chart - - - - - Point's weight - - - - - Occurs when a property value changes. - - - - - Initializes a new instance of HeatPoint class - - - - - _initializes a new instance of HeatPoint class, giving x, y and weight - - - - - - - - An already configured chart point, this class notifies a chart to update every time a property changes - - - - - Initializes a new instance of ObservablePoint class - - - - - Initializes a new instance of ObservablePoint class giving the x and y coordinates - - - - - - - Called when [property changed]. - - Name of the property. - - - - X coordinate - - - - - Y coordinate - - - - - Occurs when a property value changes. - - - - - An already configured chart point, this class notifies the chart to update every time the value property changes - - - - - Initializes a new instance of ObservableValue class - - - - - Initializes a new instance of ObservableValue class with a given value - - - - - - Called when [property changed]. - - Name of the property. - - - - Value in he chart - - - - - Occurs when a property value changes. - - - - - An already configured chart point, this class notifies the chart to update every time a property changes - - - - - Initializes a new instance of OhclPoint class - - - - - Initializes a new instance o OhclPointc class, giving open, high, low and close values - - - - - - - - - Called when [property changed]. - - Name of the property. - - - - The open value i the chart - - - - - The high value in the chart - - - - - The low value in the chart - - - - - The close value in the chart - - - - - Occurs when a property value changes. - - - - - An already configured chart point, this class notifies the chart to update every time a property changes - - - - - Initializes a new instance of PolarPoint class - - - - - Initializes a new instance of PolarPoint class, giving angle and radius - - - - - - - Called when [property changed]. - - Name of the property. - - - - The radius of the point - - - - - The angle of the point - - - - - Occurs when a property value changes. - - - - - - - - - - Draws the or move. - - The source. - The axis. - - - - Removes this instance. - - - - - Ases the core element. - - The axis. - The source. - - - - - Gets or sets the model. - - - The model. - - - - - Gets or sets the value. - - - The value. - - - - - Gets or sets the width of the section. - - - The width of the section. - - - - - Gets or sets the section offset. - - - The section offset. - - - - - Gets or sets a value indicating whether this is draggable. - - - true if draggable; otherwise, false. - - - - - Gets or sets a value indicating whether the section is animated - - - true if [disable animations]; otherwise, false. - - - - - Gets or sets a value indicating whether the section should display a label that displays its current value. - - - true if [data label]; otherwise, false. - - - - - - - - - - - - - - - - Sets the draw margin top. - - The value. - - - - Sets the draw margin left. - - The value. - - - - Sets the height of the draw margin. - - The value. - - - - Sets the width of the draw margin. - - The value. - - - - Adds to view. - - The element. - - - - Adds to draw margin. - - The element. - - - - Removes from view. - - The element. - - - - Removes from draw margin. - - The element. - - - - Ensures the element belongs to current view. - - The element. - - - - Ensures the element belongs to current draw margin. - - The element. - - - - Hides the tooltip. - - - - - Shows the legend. - - At. - - - - Hides the legend. - - - - - Loads the legend. - - - - - - Maps the x axes. - - The chart. - - - - - Maps the y axes. - - The chart. - - - - - Gets the model. - - - The model. - - - - - Occurs when [data click]. - - - - - Occurs when [data hover] - - - - - Gets or sets the series. - - - The series. - - - - - Gets the actual series. - - - The actual series. - - - - - Gets or sets the tooltip timeout. - - - The tooltip timeout. - - - - - Gets or sets the zoom. - - - The zoom. - - - - - Gets or sets the zoom. - - - The zoom. - - - - - Gets or sets the zooming speed. - - - The zooming speed. - - - - - Gets or sets the legend location. - - - The legend location. - - - - - Gets or sets a value indicating whether [disable animations]. - - - true if [disable animations]; otherwise, false. - - - - - Gets or sets the animations speed. - - - The animations speed. - - - - - Gets or sets the state of the updater. - - - The state of the updater. - - - - - Gets a value indicating whether this instance has tooltip. - - - true if this instance has tooltip; otherwise, false. - - - - - Gets a value indicating whether this instance has data click event attached. - - - true if this instance has data click event attached; otherwise, false. - - - - - Gets a value indicating whether this instance has data hover event attached. - - - true if this instance has data hover event attached; otherwise, false. - - - - - Gets a value indicating whether this is hoverable. - - - true if hoverable; otherwise, false. - - - - - Gets a value indicating whether this instance is control loaded. - - - true if this instance is control loaded; otherwise, false. - - - - - Gets a value indicating whether this instance is in design mode. - - - true if this instance is in design mode; otherwise, false. - - - - - Gets or sets the visual elements. - - - The visual elements. - - - - - - - - - - Adds the or move. - - The chart. - - - - Removes the specified chart. - - The chart. - - - - Gets or sets the x. - - - The x. - - - - - Gets or sets the y. - - - The y. - - - - - Gets or sets the axis x. - - - The axis x. - - - - - Gets or sets the axis y. - - - The axis y. - - - - - - - - - - The datetime used for the first point to calculate relative date values - - - - - Gets or sets the period used by the series in this axis - - - - - - - - - - - Gets or sets the base. - - - The base. - - - - - - - - - - - Gets or sets the inner radius. - - - The inner radius. - - - - - Gets or sets the starting rotation angle. - - - The starting rotation angle. - - - - - Gets or sets the hover push out. - - - The hover push out. - - - - - - - - - - Updates the label. - - The text. - The axis. - The source. - - - - - Clears the specified chart. - - The chart. - - - - Places the specified chart. - - The chart. - The axis. - The direction. - Index of the axis. - To label. - To line. - The tab. - - - - Removes the specified chart. - - The chart. - - - - Moves the specified chart. - - The chart. - The axis. - The direction. - Index of the axis. - To label. - To line. - The tab. - - - - Fades the in. - - The axis. - The chart. - - - - Fades the out and remove. - - The chart. - - - - Gets the model. - - - The model. - - - - - Gets the label model. - - - The label model. - - - - - - - - - - Ases the core element. - - The axis. - The source. - - - - - Gets or sets a value indicating whether this instance is enabled. - - - true if this instance is enabled; otherwise, false. - - - - - Gets or sets separator step, this means the value between each line, use double.NaN for auto. - - - - - Gets the axis orientation. - - - The axis orientation. - - - - - - - - - - - - - - - - Draws the or move. - - The previous drawn. - The current. - The index. - The chart. - - - - Removes from view. - - The chart. - - - - Called when [hover]. - - The point. - - - - Called when [hover leave]. - - The point. - - - - Gets a value indicating whether this instance is new. - - - true if this instance is new; otherwise, false. - - - - - Gets the valid area. - - - The valid area. - - - - - Gets or sets the data. - - - The data. - - - - - - - - - - - Gets or sets the color components. - - - The color components. - - - - - Gets or sets the width. - - - The width. - - - - - Gets or sets the height. - - - The height. - - - - - - - - - - - Gets or sets the open. - - - The open. - - - - - Gets or sets the high. - - - The high. - - - - - Gets or sets the close. - - - The close. - - - - - Gets or sets the low. - - - The low. - - - - - Gets or sets the width. - - - The width. - - - - - Gets or sets the left. - - - The left. - - - - - Gets or sets the start reference. - - - The start reference. - - - - - - - - - - - Gets or sets the rotation. - - - The rotation. - - - - - Gets or sets the wedge. - - - The wedge. - - - - - Gets or sets the inner radius. - - - The inner radius. - - - - - Gets or sets the radius. - - - The radius. - - - - - - - - - - - Gets or sets the data. - - - The data. - - - - - Gets or sets the zero reference. - - - The zero reference. - - - - - - - - - - - Gets or sets the diameter. - - - The diameter. - - - - - - - - - - - Gets or sets the delta x. - - - The delta x. - - - - - Gets or sets the delta y. - - - The delta y. - - - - - - - - - - Gets the minimum x. - - The axis. - - - - - Gets the maximum x. - - The axis. - - - - - Gets the minimum y. - - The axis. - - - - - Gets the maximum y. - - The axis. - - - - - Gets the view. - - - The view. - - - - - - - - - - - - - - - - Gets the point view. - - The point. - The label. - - - - - Called when [series update start]. - - - - - Erases the specified remove from view. - - if set to true [remove from view]. - - - - Called when [series updated finish]. - - - - - Initializes the colors. - - - - - Draws the specialized elements. - - - - - Places the specialized elements. - - - - - Gets the label point formatter. - - - - - - Gets or sets the model. - - - The model. - - - - - Gets or sets the values. - - - The values. - - - - - Gets a value indicating whether [data labels]. - - - true if [data labels]; otherwise, false. - - - - - Gets or sets the scales x at. - - - The scales x at. - - - - - Gets or sets the scales y at. - - - The scales y at. - - - - - Gets or sets the configuration. - - - The configuration. - - - - - Gets a value indicating whether this instance is series visible. - - - true if this instance is series visible; otherwise, false. - - - - - Gets or sets the label point. - - - The label point. - - - - - Gets the actual values. - - - The actual values. - - - - - Gets the title. - - - The title. - - - - - Gets a value indicating whether this instance is first draw. - - - true if this instance is first draw; otherwise, false. - - - - - Gets or sets the maximum width of the column. - - - The maximum width of the column. - - - - - Gets or sets the column padding. - - - The column padding. - - - - - Gets or sets a value indicating whether [shares position]. - - - true if [shares position]; otherwise, false. - - - - - - - - - - - Gets or sets the maximum width of the column. - - - The maximum width of the column. - - - - - - - - - - - Gets the stops. - - - The stops. - - - - - Gets a value indicating whether [draws heat range]. - - - true if [draws heat range]; otherwise, false. - - - - - - - - - - - Starts the segment. - - At index. - The location. - - - - Ends the segment. - - At index. - The location. - - - - Gets or sets the line smoothness. - - - The line smoothness. - - - - - Gets or sets the area limit. - - - The area limit. - - - - - - - - - - Gets the view. - - - The view. - - - - - - - - - - - Gets or sets the push out. - - - The push out. - - - - - - - - - - Gets the point diameter. - - - - - - - - - - - - Gets or sets the maximum row heigth. - - - The maximum row heigth. - - - - - Gets or sets the row padding. - - - The row padding. - - - - - Gets or sets a value indicating whether [shares position]. - - - true if [shares position]; otherwise, false. - - - - - - - - - - - Gets or sets the maximum point shape diameter. - - - The maximum point shape diameter. - - - - - Gets or sets the minimum point shape diameter. - - - The minimum point shape diameter. - - - - - - - - - - - - - - - - - Gets or sets the stack mode. - - - The stack mode. - - - - - - - - - - - - Gets or sets the maximum width of the column. - - - The maximum width of the column. - - - - - Gets or sets the column padding. - - - The column padding. - - - - - - - - - - - - Gets or sets the maximum height of the row. - - - The maximum height of the row. - - - - - Gets or sets the row padding. - - - The row padding. - - - - - - - - - - - - - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The point. - - - - Gets or sets the point1. - - - The point1. - - - - - Gets or sets the point2. - - - The point2. - - - - - Gets or sets the point3. - - - The point3. - - - - - Gets or sets the start point. - - - The start point. - - - - - Defines a portable color - - - - - Initializes a new instance of CoreColor - - alpha component - red component - green component - blue component - - - - Alpha component - - - - - Red component - - - - - Green component - - - - - Red component - - - - - Portable color gradient stop - - - - - Offset, goes from 0 to 1 - - - - - Color at Offset - - - - - Defines a portable limit - - - - - Initializes a new instance of CoreLimit - - minimum value - maximum value - - - - Gets or sets the maximum value - - - - - Gets or sets the minimum value - - - - - Gets the range between max and min values - - - - - Defines a portable margin - - - - - Distance to top - - - - - Distance to bottom - - - - - Distance to left - - - - - Distance to right - - - - - Size width - - - - - Size height - - - - - - - - - - Initializes a new instance of CorePoint - - x coordinate - y coordinate - - - - Initializes a new instance of CorePoint - - source pont - - - - Sums every property between 2 given points - - point 1 - point 2 - - - - - Subtracts every property between 2 given points - - point 1 - point 2 - - - - - X coordinate - - - - - Y coordinate - - - - - - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The left. - The top. - The width. - The height. - - - - Occurs when [set top]. - - - - - Occurs when [set left]. - - - - - Occurs when [set width]. - - - - - Occurs when [set height]. - - - - - Gets or sets the left. - - - The left. - - - - - Gets or sets the top. - - - The top. - - - - - Gets or sets the width. - - - The width. - - - - - Gets or sets the height. - - - The height. - - - - - - - - - - Initializes a new instance of the struct. - - The width. - The heigth. - - - - Gets or sets the width. - - - The width. - - - - - Gets or sets the height. - - - The height. - - - - - - - - - - Initializes a new instance of the struct. - - The angle. - The w. - The h. - The axis. - The source. - - - - Gets the offset by source. - - The source. - - - - - Gets or sets the label angle. - - - The label angle. - - - - - Gets or sets the w from w. - - - The w from w. - - - - - Gets or sets the w from h. - - - The w from h. - - - - - Gets or sets the h from w. - - - The h from w. - - - - - Gets or sets the h from h. - - - The h from h. - - - - - Gets or sets the top. - - - The top. - - - - - Gets or sets the bottom. - - - The bottom. - - - - - Gets or sets the left. - - - The left. - - - - - Gets or sets the right. - - - The right. - - - - - Gets or sets the x offset. - - - The x offset. - - - - - Gets or sets the y offset. - - - The y offset. - - - - - Gets the width of the taken. - - - The width of the taken. - - - - - Gets the height of the taken. - - - The height of the taken. - - - - - Gets the actual width. - - - The actual width. - - - - - Gets the actual height. - - - The actual height. - - - - - - - - - - Gets or sets the points. - - - The points. - - - - - Gets or sets the shares. - - - The shares. - - - - - Gets or sets the x formatter. - - - The x formatter. - - - - - Gets or sets the y formatter. - - - The y formatter. - - - - - - - The sender. - The chart point. - - - - - - - - - - - - - The sender. - - - - - - The instance containing the event data. - - - - - - The instance containing the event data. - - - - - - - - - - - - - - - Gets the min limit difference compared with previous state - - - - - Gets the max limit difference compared with previous state - - - - - Gets the current axis range - - - - - Gets the axis that fired the change - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The instance containing the event data. - - - - Gets or sets a value indicating whether the axis change was canceled by the user. - - - true if cancel; otherwise, false. - - - - - Gets the preview minimum value. - - - The preview minimum value. - - - - - Gets the preview maximum value. - - - The preview maximum value. - - - - - LiveCharts extensions methods - - - - - Executes an Action in every item of a collection - - type to iterate with - collection to iterate - action to execute - - - - Splits a collection of points every double.Nan - - collection to split - collection of collections - - - - Return the inverse axis orientation - - current orientation - inverted axis orientation - - - - Converts any collection to chart values - - type to convert - values to convert - a new ChartValues instance containing the passed collection - - - - Converts an enumeration of series to a SeriesCollection instance. - - The series. - - - - - Gets the closest chart point with a given value. - - The target series. - The value. - the axis orientation - - - - - - - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message that describes the error. - - - - Initializes a new instance of the class. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. - - - - Initializes a new instance of the class. - - The format. - The inner exception. - The arguments. - - - - - - - The old items. - The new items. - - - - Defines the interval on which earch of the charts bars is based - - - - - - - - - - Occurs when [point changed]. - - - - - Charts legend locations - - - - - Disables legend - - - - - PLaces legend at top - - - - - Places legend at bottom - - - - - Places legend at left - - - - - Places legend at right - - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - - - - - - Gets or sets the width of the desired. - - - The width of the desired. - - - - - Gets or sets the height of the desired. - - - The height of the desired. - - - - - Gets or sets the data. - - - The data. - - - - - - - - - - Gets or sets the identifier. - - - The identifier. - - - - - Gets or sets the name. - - - The name. - - - - - Gets or sets the data. - - - The data. - - - - - Gets or sets the shape. - - - The shape. - - - - - Gets or sets the LVC map. - - - The LVC map. - - - - - Chart Panning Options - - - - - By default chart Panning is Unset, this means it will be based the Chart Zooming selection - - - - - Not panning allowed - - - - - Panning only in the X axis - - - - - Panning only in the Y axis - - - - - Panning in both X and Y axes - - - - - Describes where a label should be placed - - - - - Places the label inside the pie slice - - - - - Places the label outside the pie slice - - - - - - - - - - Initializes a new instance of the class. - - - - - Gets the x limit. - - - The x limit. - - - - - Gets the y limit. - - - The y limit. - - - - - Gets the w limit. - - - The w limit. - - - - - Gets the gci. - - - The gci. - - - - - Gets or sets the indexed. - - - The indexed. - - - - - Gets or sets the referenced. - - - The referenced. - - - - - Gets or sets a chart scroll mode - - - - - Disables Chart Scroll bars - - - - - Enables scroll mode at the X axis - - - - - Enables scroll mode at the Y axis - - - - - Enables scroll mode in both, X and Y axis - - - - - Separator current state - - - - - Remove the separator from the chart - - - - - Kepp the separator in the chart - - - - - no animated add - - - - - - - - - - Initializes a new instance of the class. - - The axis. - - - - Gets or sets the axis. - - - The axis. - - - - - Gets or sets if separators are enabled (will be drawn) - - - - - Gets or sets sepator step, this means the value between each line, use null for auto. - - - - - Gets or sets the source. - - - The source. - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - Updates this instance. - - - - - Gets or sets the view. - - - The view. - - - - - Gets or sets the chart. - - - The chart. - - - - - Gets or sets the series collection. - - - The series collection. - - - - - Gets or sets the series orientation. - - - The series orientation. - - - - - Gets or sets the title. - - - The title. - - - - - Gets the preferred selection mode. - - - The preferred selection mode. - - - - - Gets the current x axis. - - - The current x axis. - - - - - Gets the current y axis. - - - The current y axis. - - - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - Updates this instance. - - - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - Updates this instance. - - - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - Updates this instance. - - There is no a valid gradient to create a heat series. - - - - Gets the minimum x. - - The axis. - - - - - Gets the maximum x. - - The axis. - - - - - Gets the minimum y. - - The axis. - - - - - Gets the maximum y. - - The axis. - - - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - Updates this instance. - - - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - Updates this instance. - - - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - Updates this instance. - - - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - Updates this instance. - - - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - Updates this instance. - - - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - Updates this instance. - - - - - Gets the stacked point. - - The chart point. - - - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - Updates this instance. - - - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - Updates this instance. - - - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - Updates this instance. - - - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - - - - - - - Initializes a new instance of the class. - - The view. - - - - Gets the stacked point. - - The chart point. - - - - - Stores a collection of series to plot, this collection notifies the changes every time you add/remove any series. - - - - - Initializes a new instance of the SeriesCollection class - - - - - Initializes a new instance of the SeriesCollection class, with a given mapper - - - - - Gets or sets the current series index, this index is used to pull out the automatic color of any series - - - - - Gets the chart that owns the collection - - - - - Gets or sets then mapper in the collection, this mapper will be used in any series inside the collection, if null then LiveCharts will try to get the value from the global configuration. - - - - - The series orientation - - - - - Both, horizontal and vertical orientation - - - - - Horizontal orientation - - - - - Vertical orientation - - - - - Stacked mode, for stacked series - - - - - Stacks the values, eg: if values are 1,2,3 the stacked total is 6 - - - - - Stacks percentage, eg: if values are 1,2,3, they are actually being stacked as (1/6), (2/6), (3/6) [value/totalSum] - - - - - Tooltip selection modes - - - - - LiveCharts will decide the selection mode based on the series (that fired the tooltip) preferred section mode - - - - - Gets only the hovered point - - - - - Gets all the points that shares the value X in the chart - - - - - Gets all the points that shares the value Y in the chart - - - - - Gets all the points that shares the value X in the hovered series - - - - - Gets all the points that shares the value Y in the hovered series - - - - - Defines chart updater state - - - - - Indicates that the updater is running and listening for changes. - - - - - Indicated that the updater is paused, it won't update. - - - - - Defines a collection of items to be added in a cartesian chart - - - - - Initializes a new instance of VisualElementsCollection - - - - - Gets or sets the chart. - - - The chart. - - - - - Chart zooming options - - - - - Disables zooming - - - - - Zoom only at X axis - - - - - Zoom only at Y axis - - - - - Zooms in both, X and Y axes - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.SkiaSharpView.WPF.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.SkiaSharpView.WPF.dll deleted file mode 100644 index 22498fb..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.SkiaSharpView.WPF.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.SkiaSharpView.WPF.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.SkiaSharpView.WPF.xml deleted file mode 100644 index 64f7f52..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.SkiaSharpView.WPF.xml +++ /dev/null @@ -1,723 +0,0 @@ - - - - LiveChartsCore.SkiaSharpView.WPF - - - - - - - - Initializes a new instance of the class. - - - - - The series property - - - - - The x axes property - - - - - The y axes property - - - - - The sections property - - - - - The zoom mode property - - - - - The zoom mode property - - - - - The zooming speed property - - - - - The tool tip finding strategy property - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes the core. - - canvas not found - - - - - - - - - - The core - - - - - The canvas - - - - - The legend - - - - - The tool tip - - - - - Initializes a new instance of the class. - - Default colors are not valid - - - - The sync context property. - - - - - The sync context property. - - - - - The draw margin property - - - - - The animations speed property - - - - - The easing function property - - - - - The legend position property - - - - - The legend background property - - - - - The legend text paint property - - - - - The legend text size property - - - - - The tool tip position property - - - - - The tool tip background property - - - - - The tool tip text paint property - - - - - The tool tip text size property - - - - - The update started command. - - - - - The pointer down command. - - - - - The pointer up command. - - - - - The pointer move command. - - - - - The double click command. - - - - - The data pointer down command. - - - - - The chart point pointer down command. - - - - - The visual elements pointer down command. - - - - - The visual elements property - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets or sets a command to execute when the chart update started. - - - - - Gets or sets a command to execute when the pointer goes down on the chart. - - - - - Gets or sets a command to execute when the pointer goes up on the chart. - - - - - Gets or sets a command to execute when the pointer moves over the chart. - - - - - Gets or sets a command to execute when a double click happens on a chart. - - - - - Gets or sets a command to execute when the pointer goes down on a data or data points. - - - - - Gets or sets a command to execute when the pointer goes down on a chart point. - - - - - Gets or sets a command to execute when the pointer goes down on a visual element. - - - - - - - - Called when the template is applied. - - - - - - - - - - - Initializes the core. - - - - - - Called when a dependency property changes. - - The o. - The instance containing the event data. - - - - - Sets the local value of a dependency property, specified by its dependency property identifier. - If the object has not yet finished initializing, does so without changing its value source. - - The identifier of the dependency property to set. - The new local value. - - - - Called before the chart is unloaded. - - - - - Defines a geographic map. - - - - - - Initializes a new instance of the class. - - - - - The active map property - - - - - The sync context property. - - - - - The view command property. - - - - - The map projection property - - - - - The series property - - - - - The stroke property - - - - - The fill property - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Called when the template is applied. - - - - - Defines the motion canvas control for WPF, . - - - - - - The skia element - - - - - Initializes a new instance of the class. - - - - - The paint tasks property - - - - - Gets or sets the paint tasks. - - - The paint tasks. - - - - - Gets or sets the frames per second. - - - The frames per second. - - - - - Gets the canvas core. - - - The canvas core. - - - - - Called when the template is applied. - - - - - - - - - - - Initializes a new instance of the class. - - - - - The series property - - - - - The isClockwise property - - - - - The initial rotation property - - - - - The maximum angle property - - - - - The total property - - - - - The start property - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes the core. - - canvas not found - - - - - - - - - - Initializes a new instance of the class. - - - - - The fit to bounds property. - - - - - The total angle property. - - - - - The inner radius property. - - - - - The initial rotation property. - - - - - The series property. - - - - - The x axes property. - - - - - The y axes property - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes the core. - - canvas not found - - - - - - - A helper class to get the screen resolution. - - - - - Gets or sets the horizontal dpi. - - - - - Initializes a new instance of the class. - - The horizontal resolution. - The vertical resolution. - - - - Gets or sets the vertical dpi. - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.SkiaSharpView.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.SkiaSharpView.dll deleted file mode 100644 index 877b505..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.SkiaSharpView.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.SkiaSharpView.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.SkiaSharpView.xml deleted file mode 100644 index 782f3b3..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.SkiaSharpView.xml +++ /dev/null @@ -1,3292 +0,0 @@ - - - - LiveChartsCore.SkiaSharpView - - - - - - - - Defines a box serries series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - - - Defines a box serries series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - - - Defines a box serries series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - The type of the data label of every point. - - - - - Defines a candlesticks series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - - - Defines a candlesticks series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - - - Defines a candlesticks series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - The type of the data label of every point. - - - - - Defines a column series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - - - Defines a column series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - - - Defines a column series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - The type of the data label of every point. - - - - - Defines a DateTime axis. - - - - - Initializes a new instance of the class. - - The unit of the axis (hours, days, months, years). - The labels formatter. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Defines a box geometry. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - - - - - - - Defines a candlestick geometry. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - - - - Defines a circle geometry. - - - - - - Initializes a new instance of the class. - - - - - - - - Defines a rectangle geometry with a specified color. - - - - - - Initializes a new instance of the class. - - - - - - - - - - - Defines an area drawn using cubic beziers. - - - - - - - - - - - - - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - - - - - - - Gets or sets the matrix transform. - - - The transform. - - - - - - - - - - - - - - - - - Draws the geometry in the user interface. - - The context. - - - - Called when the geometry is drawn. - - The context. - The paint. - - - - Measures the geometry. - - The drawable task. - the size of the geometry. - - - - Called when the geometry is measured. - - The paint task. - the size of the geometry - - - - Defines a heat lane. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The name/ - The value. - - - - Called when a property changes. - - - - - Gets or sets the land name. - - - - - - - - Called when a property changes. - - - - - - Defines a path geometry with a specified color. - - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color of the fill. - - - The color of the fill. - - - - - - - - - - - - - - The commands - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes a new instance of the class. - - - - - Gets or sets the vertical align. - - - The vertical align. - - - - - Gets or sets the horizontal align. - - - The horizontal align. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Defines an oval geometry. - - - - - - Initializes a new instance of the class. - - - - - - - - Defines a pop-up geometry. - - - - - Gets or sets the wedge size. - - - - - Gets or sets the wedge thickness, it controls the width of the wedge, - the value is normalized, where 1 means the size, default is 2. - - - - - Gets or sets the border radius. - - - - - Gets or sets the placement. - - - - - Defines a rectangle geometry. - - - - - - Initializes a new instance of the class. - - - - - - - - Defines a rounded rectangle geometry. - - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - The width - - - - - The height - - - - - The match dimensions - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - Defines a square geometry. - - - - - - Initializes a new instance of the class. - - - - - - - - Defines an area drawin using bezier segments. - - - - - - - - - - - - - - Defines a geometry that is buil from a svg path. - - - - - - Inieializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The SVG path. - - - - Initializes a new instance of the class, - when is null, The path will be obtained from the function. - - The path source. - - - - Svg paths are cached in this dictionary to prevent parsing multiple times the same path, - when you use the class, keep in mind that the parsed paths are living in - memory, this has no secondary effects in most of the cases, but if you are parsing a lot of paths - (maybe over 500) then you must consider cleaning the cache when you no longer need a path. - - - - - Gets or sets the path. - - - - - Gets or sets whether the path should be fitted to the size of the geometry. - - - - - - - - - - - Draws the given path to the canvas. - - The context. - The path. - The paint - - - - Defines an area geometry. - - The type of the segment. - - - - Initializes a new instance of the class. - - - - - Gets the commands in the vector. - - - - - - - - - - - - - - - - - Called when the area begins the draw. - - The context. - The path. - The segment. - - - - Called to close the area. - - The context. - The path. - The segment. - - - - Called to draw the segment. - - The context. - The path. - The segment. - - - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - - - - Defines a skia sharp drawing context. - - - - - - Initializes a new instance of the class. - - The motion canvas. - The information. - The surface. - The canvas. - Indicates whether the canvas is cleared on frame draw. - - - - Initializes a new instance of the class. - - The motion canvas. - The information. - The surface. - The canvas. - The background. - Indicates whether the canvas is cleared on frame draw. - - - - Gets or sets the motion canvas. - - - The motion canvas. - - - - - Gets or sets the information. - - - The information. - - - - - Gets or sets the surface. - - - The surface. - - - - - Gets or sets the canvas. - - - The canvas. - - - - - Gets or sets the paint task. - - - The paint task. - - - - - Gets or sets the paint. - - - The paint. - - - - - Gets or sets the background. - - - - - - - - Defines a visual frame in the draw margin of the chart. - - - - - Initializes a new instance of the class. - - The value. - The builder. - - - - Gets or sets the value. - - - - - Gets or sets the series builder. - - - - - Gets a value indicating whether this instance is specific to the fill series. - - - - - Gets a constant value that represents the background series. - - - - - The gauge generator class. - - - - - Builds a solid Gauge, it generates a series collectio of - , these series - are ready to be plotted in a pie chart, and will render the gauge, this reuses all the power and - functionality of the class. - - The items. - A series collection of pie seires. - - - - Builds an angular Gauge, it generates a series collectio of - , these series - are ready to be plotted in a pie chart, and will render the gauge, this reuses all the power and - functionality of the class. - - The items. - A series collection of pie seires. - - - - Defines a gauge item. - - - - - Initializes a new instance of the class. - - The value. - The builder. - - - - Initializes a new instance of the class. - - The value. - The builder. - - - - Defines the gauge options. - - - - - Not a gauge. - - - - - A solid gauge. - - - - - An angular gauge. - - - - - Defines the pie chart esxtensions. - - - - - Converts an IEnumerable to an ObservableCollection of pie series. - - The type of the model. - The data source. - An optional builder. - Defines whether the series are treaded as gauge. - - - - - Converts an IEnumerable to an ObservableCollection of pie series. - - The type of the model. - The type of the visual. - The data source. - An optional builder. - Defines whether the series are treaded as gauge. - - - - - Converts an IEnumerable to an ObservableCollection of pie series. - - The type of the model. - The type of the visual. - The type of the label. - The data source. - An optional builder. - Defines whether the series are treaded as gauge. - - - - - Converts an IEnumerable to an ObservableCollection of pie series. - - The type of the model. - The type of the series. - The data source. - An optional builder. - Defines whether the series are treaded as gauge. - - - - - Defines a helper class to build gauges. - - - - - Gets or sets the inner radius, setting this property to null will let the theme decide the value, default is null. - - - The inner radius. - - - - - Sets the inner radius, setting this property to null will let the theme decide the value, default is null. - - the value. - - - - - Gets or sets the offset radius, the separation between each gauge if multiple gauges are nested, - setting this property to null will let the theme decide the value, default is null. - - - The value. - - - - - Sets the offset radius, the separation between each gauge if multiple gauges are nested, - setting this property to null will let the theme decide the value, default is null. - - the value. - - - - - Gets or sets the maximum width of the radial column, setting this property to null will let the theme decide the value, default is null. - - - The maximum width of the radial column. - - - - - Sets the maximum width of the radial column, setting this property to null will let the theme decide the value, default is null. - - the value. - - - - Gets or sets the corner radius, setting this property to null will let the theme decide the value, default is null. - - - The corner radius. - - - - - Sets the corner radius, setting this property to null will let the theme decide the value, default is null. - - the value. - - - - Gets or sets the radial alignment, setting this property to null will let the theme decide the value, default is null. - - - The inner radius. - - - - - Sets the radial alignment, setting this property to null will let the theme decide the value, default is null. - - the value. - - - - Gets or sets the background inner radius, setting this property to null will let the theme decide the value, default is null. - - - The background inner radius. - - - - - Sets the background inner radius, setting this property to null will let the theme decide the value, default is null. - - the value. - - - - Gets or sets the background offset radius, the separation between each gauge if multiple gauges are nested, - setting this property to null will let the theme decide the value, default is null. - - - The background relative inner radius. - - - - - Sets the background offset radius, the separation between each gauge if multiple gauges are nested, - setting this property to null will let the theme decide the value, default is null. - - the value. - - - - Gets or sets the width of the background maximum radial column, setting this property to null will let the theme - decide the value, default is null. - - - The width of the background maximum radial column. - - - - - Sets the width of the background maximum radial column, setting this property to null will let the theme - decide the value, default is null. - - the value. - - - - Gets or sets the background corner radius, setting this property to null will let the theme decide the value, default is null. - - - The background corner radius. - - - - - Sets the background corner radius, setting this property to null will let the theme decide the value, default is null. - - the value. - - - - Gets or sets the background. - - - The background. - - - - - Sets the background. - - the value. - - - - Gets or sets the size of the labels, setting this property to null will let the theme decide the value, default is null. - - - The size of the labels. - - - - - Sets the size of the labels, setting this property to null will let the theme decide the value, default is null. - - the value. - - - - Gets or sets the labels position, setting this property to null will let the theme decide the value, default is null. - - - The labels position. - - - - - Sets the labels position, setting this property to null will let the theme decide the value, default is null. - - the value. - - - - Gets or sets the label formatter. - - - The label formatter. - - - - - Sets the labels position, setting this property to null will let the theme decide the value, default is null. - - the value. - - - - Adds the value. - - The value. - The series name. - The series paint. - The labels paint. - - - - - Adds the value. - - The value. - The series name. - Color of the series. - Color of the labels. - - - - - Adds the value. - - The value. - The series name. - Color of the series. - Color of the labels. - - - - - Adds the value. - - The value. - - - - - Adds the value. - - The value. - - - - - Adds the value. - - The value. - The series name. - - - - - Adds the value. - - The value. - The series name. - - - - - Builds the series. - - - - - - Applies the styles the specified series. - - The series. - - - - - Applies the styles to fill series. - - The series. - - - - - Applies the styles to series. - - The series. - - - - - . - - - - Initializes a new instance of the class from the given core map. - - - - - Initializes a new instance of the class from the given core map. - - - - - . - - - . - - - . - - - . - - - . - - - - - - - Initializes a new instance of the class. - - - - - Defines a heat series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - - - Defines a heat series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - - - Defines a heat series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - The type of the data label of every point. - - - - - Initializes a new instance of the class. - - - - - Defines a line series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - - - Defines a line series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - - - Defines a line series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - The type of the data label of every point. - - - - - Defines the default LiveCharts-SkiaSharp settings - - - - - Gets or sets an SKTypeface instance to use globally on any paint that does not specify any. - - - - - Configures LiveCharts using the default settings for SkiaSharp. - - The settings. - The settings. - - - - Adds SkiaSharp as the library backend. - - The settings. - - - - - Registers a global SKTypeface instance to use on any that does not specify a typeface. - - - - - - - - Converts a to a instance. - - The color. - The alpha overrides. - - - - - Creates a new color based on the - - The color. - The opacity from 0 to 255. - - - - - Converts a to a intance. - - The color - - - - - Gets the key. - - - - - Matches - - - - - - - Converts an IEnumerable to an ObservableCollection of pie series. - - The type. - The data source. - An optional builder. - - - - - Calculates the distance in pixels from the target to the given location in the UI. - - The target. - The location. - The distance in pixels. - - - - Defines a logarithmic axis. - - - - - Initializes a new instance of the class. - - The log base. - - - - Defines a map builder. - - - - - - - - - - - - - - Disposes the map factory. - - - - - Defines a motion property to handle the type. - - - - - Initializes a new instance of the class. - - The property name. - - - - Initializes a new instance of the class. - - The property name. - The initial matrix. - - - - - - - Creates a stroke dash effect. - - - - - - Initializes a new instance of the class. - - - - - Creates a new object that is a copy of the current instance. - - - A new object that is a copy of this instance. - - - - - - Creates the path effect. - - The drawing context. - - - - A wrapper object for skia sharp path effects. - - - - - - Gets or sets the sk path effect. - - - The sk path effect. - - - - - Creates a new object that is a copy of the current instance. - - - A new object that is a copy of this instance. - - - - - Creates the path effect. - - The drawing context. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - - Creates a blur image filter. - - - - - - Initializes a new instance of the class. - - The sigma x. - The sigma y. - The input. - The crop rect. - - - - Clones this instance. - - - - - - - Creates the filter. - - The drawing context. - - - - - Creates a drop shadow image filter. - - - - - - Initializes a new instance of the class. - - The dx. - The dy. - The sigma x. - The sigma y. - The color. - The input. - The crop rect. - - - - Clones this instance. - - - - - - - Creates the image filter. - - The drawing context. - - - - A wrapper object for skia sharp image filters. - - - - - - Gets or sets the sk image filter. - - - The sk image filter. - - - - - Creates the image filter. - - The drawing context. - - - - Clones this instance. - - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Merges multiple image filters. - - - - - - Initializes a new instance of the class. - - The image filters. - The crop rect. - - - - Clones this instance. - - - - - - - Creates the image filter. - - The drawing context. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Defines a set of geometries that will be painted using a linear gradient shader. - - - - - - Default start point. - - - - - Default end point. - - - - - Initializes a new instance of the class. - - The gradient stops. - - The start point, both X and Y in the range of 0 to 1, where 0 is the start of the axis and 1 the end. - - - The end point, both X and Y in the range of 0 to 1, where 0 is the start of the axis and 1 the end. - - - An array of integers in the range of 0 to 1. - These integers indicate the relative positions of the colors, You can set that argument to null to equally - space the colors, default is null. - - - The shader tile mode, default is . - - - - - Initializes a new instance of the class. - - The gradient stops. - - - - Initializes a new instance of the class. - - The start color. - The end color. - - The start point, both X and Y in the range of 0 to 1, where 0 is the start of the axis and 1 the end. - - - The end point, both X and Y in the range of 0 to 1, where 0 is the start of the axis and 1 the end. - - - - - Initializes a new instance of the class. - - The start. - The end. - - - - - - - - - - - - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The color. - - - - - - - - - - Gets or sets the style. - - - The style. - - - - - - - - - - - - - - Gets or sets the font style. - - - - - Gets or sets the SKTypeface, if null, LiveCharts will build one based on the - and properties. Default is null. - - - - - Gets a value indication whether the paint has a custom font. - - - - - Gets or sets a value indicating whether this instance is antialias. - - - true if this instance is antialias; otherwise, false. - - - - - Gets or sets the stroke cap. - - - The stroke cap. - - - - - Gets or sets the stroke join. - - - The stroke join. - - - - - Gets or sets the stroke miter. - - - The stroke miter. - - - - - Gets or sets the color. - - - The color. - - - - - Gets or sets a value indicating whether this instance is paused. - - - true if this instance is paused; otherwise, false. - - - - - Gets or sets the path effect. - - - The path effect. - - - - - Gets or sets the image filer. - - - The image filer. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Gets a from the property. - - - - - - - - - Defines a set of geometries that will be painted using a radial gradient shader. - - - - - - Initializes a new instance of the class. - - The gradient stops. - - The center point of the gradient, both X and Y in the range of 0 to 1, where 0 is the start of the axis and 1 the end, - default is (0.5, 0.5). - - - The radius, in the range of 0 to 1, where 1 is the minimum of both Width and Height of the chart, default is 0.5. - - - An array of integers in the range of 0 to 1. - These integers indicate the relative positions of the colors, You can set that argument to null to equally - space the colors, default is null. - - - The shader tile mode, default is . - - - - - Initializes a new instance of the class. - - Color of the center. - Color of the outer. - - - - - - - - - - - - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Defines a set of geometries that will be painted using a solid color. - - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The color. - - - - Initializes a new instance of the class. - - The color. - Width of the stroke. - - - - - - - - - - - - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Defines a pie series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - Defines a pie series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - Defines a pie series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - The type of the data label of every point. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - Defines a polar line series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - - - Defines a polar line series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - - - Defines a polar line series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - The type of the data label of every point. - - - - - Defines a rectangular section in a Cartesian chart. - - - - - Defines a row series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - data label of every point. - - - - Defines a row series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - - - Defines a row series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - The type of the data label of every point. - - - - - Defines a scatter series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - - - Defines a scatter series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - - - Defines a scatter series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - The type of the data label of every point. - - - - - A chart that is able to generate images or draw to a given canvas. - - - - - Initializes a new instance of the class. - - - - - - - - - - - Gets or sets the background. - - - The background. - - - - - Gets or sets the height. - - - The height. - - - - - Gets or sets the width. - - - The width. - - - - - Gets the current . - - - - - - Saves the image to the specified path. - - The stream. - The format. - The quality, an integer from 0 to 100. - - - - - Saves the image to the specified path. - - The path. - The format. - The quality, an integer from 0 to 100. - - - - - Draws the image to the specified canvas. - - The canvas - Indicates whether the canvas should be cleared when the draw starts, default is false. - - - - Draws the chart to the specified canvas. - - The canvas. - The surface. - [probably an obsolete param] Indicates whether the canvas should be cleared when the draw starts, default is false. - - - - - In-memory chart that is able to generate a chart images. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The view. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Defines the default legend for a chart. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the legend font paint. - - - - - Gets or sets the fonts size. - - - - - - - - - - - Defines the default tooltip. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the legend font paint. - - - - - Gets or sets the background paint. - - - - - Gets or sets the fonts size. - - - - - - - - - - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The map view. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - In-memory chart that is able to generate a chart images. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The view. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - In-memory chart that is able to generate a chart images. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The view. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Defines a stacked area series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - - - Defines a stacked area series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - - - Defines a stacked area series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - The type of the data label of every point. - - - - - Defines a stacked column series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - - - Defines a stacked column series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - - - Defines a stacked column series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - The type of the data label of every point. - - - - - Defines a stacked row series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - - - Defines a stacked row series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - - - Defines a stacked row series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - The type of the data label of every point. - - - - - Defines a stacked area series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - - - Defines a stacked area series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - - - Defines a stacked area series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - The type of the data label of every point. - - - - - Defines a stepline series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - - - Defines a stepline series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - - - Defines a stepline series in the user interface. - - - The type of the points, you can use any type, the library already knows how to handle the most common numeric types, - to use a custom type, you must register the type globally - () - or at the series level - (). - - - The type of the geometry of every point of the series. - - - The type of the data label of every point. - - - - - Defines the light theme extensions. - - - - - Adds the light theme. - - The settings. - the additional styles. - The current LiveCharts settings. - - - - Adds the dark theme. - - The settings. - The additional styles. - - - - - Defines a TimeSpan axis. - - - - - Initializes a new instance of the class. - - The unit of the axis (hours, days, months, years). - The labels formatter. - - - - Defines the angulaar ticks visual. - - - - - - - - - - - - - - - - - Defines a visual element in a chart that draws a svg geometry in the user interface. - - - - - Gets or sets the SVG path. - - - - - - - - - - - Defines the visual elements extensions class. - - - - - Creates a relative panel control from a given sketch. - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.dll deleted file mode 100644 index d3fe809..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.xml deleted file mode 100644 index 66bb3fc..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/LiveChartsCore.xml +++ /dev/null @@ -1,13680 +0,0 @@ - - - - LiveChartsCore - - - - - Defines an Axis in a Cartesian chart. - - The type of the drawing context. - The type of the text geometry. - The type of the line geometry. - - - - The active separators - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Deletes the specified chart. - - The chart. - - - - - - - - Called when [paint changed]. - - Name of the property. - - - - - Gets the paint tasks. - - - - - - Defines a bar series point. - - The type of the model. - The type of the visual. - The type of the label. - The type of the drawing context. - - - - - - Initializes a new instance of the class. - - The properties. - - - - - - - - - - - - - - - - - - - - - - - - - - - - A mesure helper class. - - - - - Initializes a new instance of the measue helper class. - - The scaler. - The chart. - The series. - The axis. - The pivot. - The min pivot allowed. - The max pivot allowed. - Indicates whether the series is stacked or not. - Indicates whether the serie is row or not. - - - - helper units. - - - - - helper units. - - - - - helper units. - - - - - helper units. - - - - - helper units. - - - - - - - - - - - Defines a candle sticks series. - - The type of the model. - The type of the visual. - The type of the label. - The type of the miniature geometry, used in tool tips and legends. - The type of the drawing context. - - - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Called when [paint changed]. - - Name of the property. - - - - - A mesure helper class. - - - - - Initializes a new instance of the measue helper class. - - The scaler. - The chart. - The series. - The axis. - The pivot. - The min pivot allowed. - The max pivot allowed. - - - - helper units. - - - - - helper units. - - - - - helper units. - - - - - helper units. - - - - - helper units. - - - - - Defines a Cartesian chart. - - The type of the drawing context. - - - - - Initializes a new instance of the class. - - The view. - The default platform configuration. - The canvas. - The zooming section. - - - - Gets the x axes. - - - The x axes. - - - - - Gets the y axes. - - - The y axes. - - - - - Gets the sections. - - - The sections. - - - - - - - - - - - Gets or sets a value indicating whether this instance is zooming or panning. - - - true if this instance is zooming or panning; otherwise, false. - - - - - Gets the view. - - - The view. - - - - - Finds the points near to the specified location. - - The pointer position. - - - - - Scales the specified point to the UI. - - The point. - Index of the x axis. - Index of the y axis. - - - - - Zooms to the specified pivot. - - The pivot. - The direction. - The scale factor. - - - - - - Pans with the specified delta. - - The delta. - Indicates whether the pointer is down. - - - - - Measures this chart. - - - - - - - - - Defines a Cartesian series. - - The type of the model. - The type of the visual. - The type of the label. - The type of the drawing context. - - - - - - - Initializes a new instance of the class. - - The series properties. - - - - - - - - - - - - - - - - Gets or sets the tool tip label formatter for the X axis, this function will build the label when a point in this series - is shown inside a tool tip. - - - The tool tip label formatter. - - - - - Gets or sets the tool tip label formatter for the Y axis, this function will build the label when a point in this series - is shown inside a tool tip. - - - The tool tip label formatter. - - - - - - - - - - - - - - - - - Gets the clip rectangle for the series. - - The cartesian chart. - - - - - Gets the geometry size to calculate the series bounds. - - The geometry requested size. - - - - Gets the requested secondary offset [normalized as proportion of the axis' unit width]. - - The offset. - - - - Gets the requested secondary offset [normalized as proportion of the axis' unit width]. - - The offset - - - - Deletes the series from the user interface. - - - - - - - Softs the delete point. - - The point. - The primary scale. - The secondary scale. - - - - - Gets the label position. - - The x. - The y. - The width. - The height. - Size of the label. - The position. - The series properties. - if set to true [is greater than pivot]. - The draw margin location. - the draw margin size - - - - - Defines a chart, - - The type of the drawing context. - - - - - Initializes a new instance of the class. - - The canvas. - The default platform configuration. - The chart view. - - - - - - - - - - - - - Gets the tool tip meta data. - - - - - Gets the bounds of the chart. - - - - - Gets the measure work. - - - The measure work. - - - - - Gets or sets the theme identifier. - - - The theme identifier. - - - - - Gets whether the control is loaded. - - - - - Gets the canvas. - - - The canvas. - - - - - Gets the visible series. - - - The drawable series. - - - - - Gets the series. - - - The drawable series. - - - - - Gets the view. - - - The view. - - - - - The series context - - - - - Gets the size of the control. - - - The size of the control. - - - - - Gets the draw margin location. - - - The draw margin location. - - - - - Gets the size of the draw margin. - - - The size of the draw margin. - - - - - Gets the legend position. - - - The legend position. - - - - - Gets the legend. - - - The legend. - - - - - Gets the tooltip position. - - - The tooltip position. - - - - - Gets the tooltip finding strategy. - - - The tooltip finding strategy. - - - - - Gets the tooltip. - - - The tooltip. - - - - - Gets the animations speed. - - - The animations speed. - - - - - Gets the easing function. - - - The easing function. - - - - - Gets the visual elements. - - - The visual elements. - - - - - - - - Finds the points near to the specified point. - - The pointer position. - - - - - Loads the control resources. - - - - - Unloads the control. - - - - - Measures this chart. - - - - - - Sets the draw margin. - - Size of the control. - The margin. - - - - - Saves the previous size of the chart. - - - - - Invokes the event. - - - - - - Invokes the on update started. - - - - - - Invokes the on update finished. - - - - - - Returns a value indicating if the control size changed. - - - - - - Called when the updated the throttler is unlocked. - - - - - - Updates the bounds tracker. - - - - - Initializes the visuals collector. - - - - - Adds a visual element to the chart. - - - - - Removes a visual element from the chart. - - - - - Gets the legend position. - - The position of the legend. - - - - Collects and deletes from the UI the unused visuals. - - - - - Draws the legend and appends the size of the legend to the current margin calculation. - - The top margin. - The bottom margin. - The left margin. - The right margin. - - - - Draws the current tool tip, requires canvas invalidation after this call. - - - - - Defines a chart data series. - - The type of the model. - The type of the visual. - The type of the label. - The type of the drawing context. - - - - - - Initializes a new instance of the class. - - The properties. - - - - - - - - - - - - - - - - - - - Defines a column series. - - The type of the model. - The type of the visual. - the type of the label. - The type of the drawing context. - The type of the error geometry. - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Defines some conditional drawing extensions, things will draw according to this conditions... - - - - - Executes the given action when a point is measured, this metod just subscribes to the - event, but with a simple syntax. - - TThe type of the model. - The type of the visual. - The type of the label. - The type of the drawing context. - The target series. - The action to execute. - The series. - - The action is subscribed to the event. - - - - - Returns a for the given paint. - - The type of the model. - The type of the visual. - The type of the label. - The type of the drawing context. - The series. - The paint. - - - - - Defines a instance. - - - - - Initializes a new builder for the given paint. - - The series. - The paint. - - - - Applies the paint when the given condition is true. - - - - - - Un-subscribes the generated event handlers from the target series. - - - - - Defines a point for box plots. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The max. - The third quartile. - The first quartile. - The min. - The median. - - - - Gets or sets the high. - - - The high. - - - - - Gets or sets the max quiadrile value. - - - The open. - - - - - Gets or sets the min quadrile value. - - - The close. - - - - - Gets or sets the min value. - - - The low. - - - - - Gets or sets the median value. - - - The low. - - - - - - - - - - - Occurs when a property value changes. - - - - - - Called when a property changed. - - Name of the property. - - - - Called when the coordinate changed. - - - - - Defines a date time point for the Cartesian coordinate system that implements . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The date time. - The value. - - - - Gets or sets the date time. - - - The date time. - - - - - Gets or sets the value. - - - The value. - - - - - - - - - - - Occurs when a property value changes. - - - - - - Called when a property changed. - - Name of the property. - - - - Defines an error point that uses DateTine in the X axis to create error series. - - - - - Initializes a new instance of the class. - - The DateTime coordinate. - The Y coordinate. - The left error. - The right error. - The top error. - The bottom error. - - - - Initializes a new instance of the class. - - The dateTime coordinate. - The Y coordinate. - The error in X. - The error in Y. - - - - Gets or sets the X coordinate. - - - The high. - - - - - Gets or sets the Y coordinate. - - - The high. - - - - - Gets or sets the left error in X. - - - The open. - - - - - Gets or sets the right error in x. - - - The close. - - - - - Gets or sets the top error in Y. - - - The open. - - - - - Gets or sets the bottom error in Y. - - - The close. - - - - - - - - - - - Occurs when a property value changes. - - - - - - Called when a property changed. - - Name of the property. - - - - Defines an error point to create error series. - - - - - Initializes a new instance of the class. - - The X coordinate. - The Y coordinate. - The left error. - The right error. - The top error. - The bottom error. - - - - Initializes a new instance of the class. - - The X coordinate. - The Y coordinate. - The error in X. - The error in Y. - - - - Gets or sets the X coordinate. - - - The high. - - - - - Gets or sets the Y coordinate. - - - The high. - - - - - Gets or sets the left error in X. - - - The open. - - - - - Gets or sets the right error in x. - - - The close. - - - - - Gets or sets the top error in Y. - - - The open. - - - - - Gets or sets the bottom error in Y. - - - The close. - - - - - - - - - - - Occurs when a property value changes. - - - - - - Called when a property changed. - - Name of the property. - - - - Defines an error value to create error series. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The Y coordinate. - The top error. - The bottom error. - - - - Initializes a new instance of the class. - - The Y coordinate. - The error in Y. - - - - Gets or sets the high. - - - The high. - - - - - Gets or sets the open. - - - The open. - - - - - Gets or sets the close. - - - The close. - - - - - - - - - - - Occurs when a property value changes. - - - - - - Called when a property changed. - - Name of the property. - - - - Called when the coordinate changed. - - - - - Defines a point with financial data. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The date. - The high. - The open. - The close. - The low. - - - - Gets or sets the date. - - - The date. - - - - - Gets or sets the high. - - - The high. - - - - - Gets or sets the open. - - - The open. - - - - - Gets or sets the close. - - - The close. - - - - - Gets or sets the low. - - - The low. - - - - - - - - - - - Occurs when a property value changes. - - - - - - Called when a property changed. - - Name of the property. - - - - Defines a point with financial data, this point does not use in the X axis, instead it uses the position - of the point the array as the X coordinate,the dates must be specified in the - property. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The high. - The open. - The close. - The low. - - - - Gets or sets the high. - - - The high. - - - - - Gets or sets the open. - - - The open. - - - - - Gets or sets the close. - - - The close. - - - - - Gets or sets the low. - - - The low. - - - - - - - - - - - Occurs when a property value changes. - - - - - - Called when a property changed. - - Name of the property. - - - - Called when the coordinate changed. - - - - - Defines the class, a helper class to map any object that does not implements , - when you need a better performance you should implement in your DTOs, the default objects in the library - already implement . - - - - - - - - - - - Defines a point for the Cartesian coordinate system that implements . - - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The x coordinate. - The y coordinate. - - - - Gets or sets the x coordinate. - - - The x. - - - - - Gets or sets the y coordinate. - - - The y. - - - - - - - - - - - Occurs when a property value changes. - - - - - - Called when a property changes. - - Name of the property. - - - - Defines a point for the polar coordinate system that implements . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The angle. - The radius. - - - - Gets or sets the angle. - - - - - Gets or sets the Radius. - - - - - - - - - - - Called when a property changes. - - - - - Raises the property changed event. - - - - - Defines an object that notifies when the value property changes. - - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The value. - - - - Gets or sets the value. - - - The value. - - - - - - - - - - - Occurs when a property value changes. - - - - - - Called when am property changed. - - Name of the property. - - - - Called when the coordinate changed. - - - - - Defines a time span point for the Cartesian coordinate system that implements . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The date time. - The value. - - - - Gets or sets the time span. - - - The date time. - - - - - Gets or sets the value. - - - The value. - - - - - - - - - - - Occurs when a property value changes. - - - - - - Called when a property changed. - - Name of the property. - - - - Defines a point with a weighted coordinate. - - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The x. - The y. - The weight. - - - - Gets or sets the x. - - - The x. - - - - - Gets or sets the y. - - - The y. - - - - - Gets or sets the weight. - - - The weight. - - - - - Occurs when a property value changes. - - - - - - - - - - - - Called when a property changed. - - Name of the property. - - - - Defines the drawing alignment. - - - - - Aligns to the start - - - - - Aligns to the end - - - - - Aligns to the middle - - - - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - - - - - - - Registers a motion property. - - The type of the property. - The transition. - - - - - Defines an animation. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The easing function. - The duration. - - - - Initializes a new instance of the class. - - The easing function. - The duration. - The repeat times. - - - - Initializes a new instance of the class. - - The easing function. - The duration. - The repeat times. - - - - Initializes a new instance of the class. - - The animation. - - - - Gets or sets the easing function. - - - - - Gets or sets the duration of the transition in Milliseconds. - - - - - Gets or sets how many times the animation needs to repeat before it is completed, - use int.MaxValue to repeat it indefinitely number of times. - - - - - Defines a line bezier visual point. - - The type of the drawing context. - The type of the visual. - The type of the error geometry. - - - - Gets or sets the y error geometry. - - - - - Gets or sets the x error geometry. - - - - - Defines a line bezier visual point. - - The type of the drawing context. - The type of the visual. - - - - Gets the geometry. - - - The geometry. - - - - - Gets the bezier. - - - The bezier. - - - - - Gets or sets the path. - - - The path. - - - - - Gets or sets the stroke path. - - - The stroke path. - - - - - Defines orientation. - - - - - The horizontal orientation. - - - - - The vertical orientation. - - - - - Defines a context that is able to draw 2D shapes in the user interface. - - - - - Called when the frame starts. - - - - - Called when the frame ends. - - - - - Defines an error visual. - - The type of the error geometry. - - - - Gets or sets the y error geometry. - - - - - Gets or sets the x error geometry. - - - - - Defines an animated object, the properties of this object move according to the easing and speed when a change occurs. - - - - - Gets or sets a value indicating whether this instance is completed. - - - true if this instance is completed; otherwise, false. - - - - - Gets or sets the current time. - - - The current time. - - - - - Gets or sets a value indicating whether the element is removed when all the transitions complete. - - - true if remove on completed; otherwise, false. - - - - - Gets the motion properties. - - - - - Sets a property transition for the specified property or properties. - - The animation. - Name of the property, use null to set all the animatable properties. - - - - Removes a property or properties transitions. - - Name of the property, null to remove them all. - - - - Completes the property or properties transitions. - - Name of the property, null to select them all. - - - - Defines an arc geometry. - - The type of the drawing context. - - - - - Gets or sets the center x. - - - The center x. - - - - - Gets or sets the center y. - - - The center y. - - - - - Gets or sets the width. - - - The width. - - - - - Gets or sets the height. - - - The height. - - - - - Gets or sets the start angle in degrees. - - - The start angle. - - - - - Gets or sets the sweep angle in degrees. - - - The sweep angle. - - - - - Defines a box geometry. - - The type of the drawing context. - - - - - Gets or sets the width. - - - The width. - - - - - Gets or sets the third quadrile. - - - The third quadrile. - - - - - Gets or sets the first quadrile. - - - The first quadrile. - - - - - Gets or sets the min. - - - The min. - - - - - Gets or sets the median. - - - The median. - - - - - Defines a colored geometry in the user interface, a geometry with a Color property. - - The type of the drawing context. - - - - - Gets or sets the color. - - - - - Defiens a bezier command. - - - - - - Gets or sets the x0. - - - The x0. - - - - - Gets or sets the y0. - - - The y0. - - - - - Gets or sets the x1. - - - The x1. - - - - - Gets or sets the y1. - - - The y1. - - - - - Gets or sets the x2. - - - The x2. - - - - - Gets or sets the y2. - - - The y2. - - - - - Defines a doughnut geometry. - - The type of the drawing context. - - - - - Gets or sets the center x. - - - The center x. - - - - - Gets or sets the center y. - - - The center y. - - - - - Gets or sets the width. - - - The width. - - - - - Gets or sets the height. - - - The height. - - - - - Gets or sets the start angle in degrees. - - - The start angle. - - - - - Gets or sets the sweep angle in degrees. - - - The sweep angle. - - - - - Gets or sets the push out. - - - The push out. - - - - - Gets or sets the inner radius. - - - The inner radius. - - - - - Gets or sets the corner radius. - - - The corner radius. - - - - - Gets or sets a value indicating whether the direction of the corner radius is inverted. - - - true if the direction is inverted; otherwise, false. - - - - - Defines a drawable object, an object that can be represented in the user interface. - - The type of the drawing context. - - - - - Draws the instance in the user interface with for the specified context. - - The context. - - - - Defines a financial geometry. - - The type of the drawing context. - - - - - Gets or sets the width. - - - The width. - - - - - Gets or sets the open. - - - The open. - - - - - Gets or sets the close. - - - The close. - - - - - Gets or sets the low. - - - The low. - - - - - Defines a geometry in the user interface. - - The type of the drawing context. - - - - - Gets or sets the parent shape, if any the X and Y properties will be relative to the parent. - - - - - Gets or sets the transform origin. - - - - - Gets or sets the translate transform. - - - The translate in coordinates. - - - - - Gets or sets the rotation transform in degrees. - - - The rotation in degrees. - - - - - Gets or sets the scale transform. - - - The scale to use on the X and Y axis. - - - - - Gets or sets the skew transform. - - - The skew factor to use in the X and Y axis, both axes go from 0 to 1, where 0 is nothing and 1 - the length of the shape in the specified axis. - - - - - Gets or sets the x coordinate. - When the parent is null the coordinates are relative to the canvas. - When the parent is not null - the setter coordinates are relative to the parent - but - the getter is relative to the canvas. - - - The x coordinate. - - - - - Gets or sets the y coordinate. - When the parent is null the coordinates are relative to the canvas. - When the parent is not null - the setter coordinates are relative to the parent - but - the getter is relative to the canvas. - - - The y coordinate. - - - - - Measures the specified drawable task. - - The drawable task. - - - - - Defines a label geometry in the user interface. - - The type of the drawing context. - - - - - Gets or sets the padding. - - - The padding. - - - - - Gets or sets the line height [in times the text height]. - - - The padding. - - - - - Gets or sets the vertical align. - - - The vertical align. - - - - - Gets or sets the horizontal align. - - - The horizontal align. - - - - - Gets or sets the text. - - - The text. - - - - - Gets or sets the size of the text. - - - The size of the text. - - - - - Gets or sets the maximum width. - - - - - Gets or sets the background color. - - - - - Defines a line geometry in the user interface. - - The type of the drawing context. - - - - - Gets or sets the x1. - - - The x1. - - - - - Gets or sets the y1. - - - The y1. - - - - - Defines a line path segment. - - The type of the path. - - - - - Gets or sets the x. - - - The x. - - - - - Gets or sets the y. - - - The y. - - - - - Defines the move to path comamnd. - - The type of the path. - - - - - Gets or sets the x. - - - The x. - - - - - Gets or sets the y. - - - The y. - - - - - Defines a needle geometry in the user interface. - - The type of the drawing context. - - - - - Gets or sets the radius. - - - - - Defines a set of geometries that will be drawn according to this instance specifications. - - The type of the drawing context. - - - - Gets or sets a value indicating whether this instance is stroke. - - - true if this instance is stroke; otherwise, false. - - - - - Gets or sets a value indicating whether this instance is fill. - - - true if this instance is fill; otherwise, false. - - - - - Gets or sets the font family. - - - - - Gets or sets the index of the z. - - - The index of the z. - - - - - Gets or sets the stroke thickness. - - - The stroke thickness. - - - - - Gets or sets a value indicating whether this instance is paused. - - - true if this instance is paused; otherwise, false. - - - - - Gets or sets the clip rectangle. - - - The canvas. - The clip rectangle. - - - - - Gets or sets the clip rectangle. - - The canvas. - - The clip rectangle. - - - - - Initializes the task. - - The context. - - - - Gets the geometries. - - - The canvas. - - - - Sets the geometries. - - The canvas. - The geometries. - - - - Adds the geometry to paint task. - - The canvas. - The geometry. - - - - Removes the geometry from pain task. - - The canvas. - The geometry. - - - - Removes all geometry from paint task. - - The canvas. - - - - Releases the canvas resources. - - The canvas. - - - - Sets the opacity according to the given geometry. - - The context. - The geometry. - - - - Resets the opacity. - - The context. - The geometry. - - - - Clones the task. - - - - - - Defines a paintable object, an object that has can have its own paint definition. - - The type of the drawing context. - - - - - Gets or sets the stroke paint. - - - - - Gets or sets the fill paint. - - - - - Gets or sets the opacity. - - - The opacity. - - - - - Defines a path command. - - The type of the path context. - - - - - Gets or sets the segment id. - - - - - Executes the command in the path. - - The path. - The current time. - The path geometry. - - - - Defines a path geometry in the user interface. - - The type of the drawing context. - The type of the path. - - - - - Gets or sets a value indicating whether the path is closed. - - - true if this instance is closed; otherwise, false. - - - - - Gets the first linked node. - - - - - Gets the last linked node. - - - - - Gets current commands count. - - - - - Adds a path command at the end. - - The command. - The linked node. - - - - Adds a path command at the beginning. - - The command. - The linked node. - - - - Adds a command after the given liked node. - - The linked node. - - The linked node. - - - - Adds a path command before the given linked node. - - The linked node. - - The linked node. - - - - Removes a path command. - - The command. - - - - Removes the specified node. - - The node. - - - - Determines whether the specified command is contained in the current path. - - The command. - - true if the specified command contains command; otherwise, false. - - - - - Clears the commands. - - - - - Defines a geometry in the user interface with rounded corners. - - The type of the drawing context. - - - - - Gets or sets the border radius. - - - - - Defines a sized geometry in the user interface, a geometry with Height and Width properties. - - The type of the drawing context. - - - - - Gets or sets the width. - - - The width. - - - - - Gets or sets the height. - - - The height. - - - - - Defines a sized and solid color geometry. - - - - - Gets or sets the color. - - - - - Defiens a stepline segment. - - The type of the path context. - - - - - Gets or sets the X0 value. - - - - - Gets or sets the Y0 value. - - - - - Gets or sets the X1 value. - - - - - Gets or sets the Y1 value. - - - - - Defines a geometry that is built using from a svg path. - - - - - Gets or sets the svg path. - - - - - Defines an area geometry. - - - - - - - Gets or sets the commands. - - - - - Defines the closing method. - - - - - Gets or sets the pivot. - - - - - Defines a key frame. - - - - - The time, from 0 to 1. - - - - - The value from 0 to 1. - - - - - EasingFunction. - - - - - Defines a color. - - - - - Initializes a new instance of the struct. - - The red component from 0 to 255. - The green component from 0 to 255. - The blue component from 0 to 255. - The alpha channel component from 0 to 255. - - - - Initializes a new instance of the struct. - - The red component from 0 to 255. - The green component from 0 to 255. - The blue component from 0 to 255. - - - - Gets an empty color. - - - - - Gets or sets the red component. - - - - - Gets or sets the green component. - - - - - Gets or sets the blue component. - - - - - Gets or sets the alpha component. - - - - - Gets or sets whether this color is empty. - - - - - Determines whether the instance is equals to the given instance. - - The instance to compare to. - The comparision result. - - - - Gets the object hash code. - - - - - - Compares two instances. - - - - - - - - Compares two instances. - - - - - - - - Creates a new instance of the class with the given components. - - The red component from 0 to 255. - The green component from 0 to 255. - The blue component from 0 to 255. - - - - - Creates a new instance of the class with the given components. - - The alpha channel component from 0 to 255. - The red component from 0 to 255. - The green component from 0 to 255. - The blue component from 0 to 255. - - - - - Creates a new instance of the class with the given components. - - The alpha channel component from 0 to 255. - The red color. - - - - - Defines a point. - - - - - Initializes a new instance of the struct. - - The x coordinate. - The y coordinate. - - - - Initializes a new instance of the struct. - - The x coordinate. - The y coordinate. - - - - Gets or sets the X coordinate. - - - - - Gets or sets the Y coordinate. - - - - - Determines whether the instance is equals to the given instance. - - The instance to compare to. - The comparision result. - - - - Gets the object hash code. - - - - - - Compares two instances. - - - - - - - - Compares two instances. - - - - - - - - Defines a point with double precision. - - - - - Initializes a new instance of the struct. - - The x coordinate. - The y coordinate. - - - - Initializes a new instance of the struct. - - The point coordinate. - - - - Gets or sets the X coordinate. - - - - - Gets or sets the Y coordinate. - - - - - Determines whether the instance is equals to the given instance. - - The instance to compare to. - The comparision result. - - - - Gets the object hash code. - - - - - - Compares two instances. - - - - - - - - Compares two instances. - - - - - - - - Defines a rectangle. - - - - - Initializes a new instance of the struct. - - - - - - - Gets an empty rectangle instance. - - - - - Gets or sets the location. - - - - - Gets the X location coordinate. - - - - - Gets the Y location coordinate. - - - - - Gets or sets the size. - - - - - Gets the width. - - - - - Gets the height. - - - - - Gets or sets whether the instance is empty. - - - - - Determines whether the instance is equals to the given instance. - - The instance to compare to. - The comparision result. - - - - Gets the object hash code. - - - - - - Compares 2 instances. - - - - - - - - Compares 2 instances. - - - - - - - - Defines a size. - - - - - Initializes a new instance of the struct. - - The width. - The height. - - - - Gets or sets the width. - - - - - Gets or sets the height. - - - - - Determines whether the instance is equals to the given instance. - - The instance to compare to. - The comparision result. - - - - Gets the object hash code. - - - - - - Compares two instances. - - - - - - - - Compares two instances. - - - - - - - - Defines the padding measure helped class,. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The padding. - - - - Initializes a new instance of the class. - - The x. - The y. - - - - Initializes a new instance of the class. - - The left. - The top. - The right. - The bottom. - - - - Gets or sets the left. - - - The left. - - - - - Gets or sets the right. - - - The right. - - - - - Gets or sets the top. - - - The top. - - - - - Gets or sets the bottom. - - - The bottom. - - - - - Defines a cubic bezier segment. - - - - - Initializes a new instance of the class. - - - - - - - - - - - Gets or sets the middle point in the Y axis. - - - - - Gets or sets the middle point in the Y axis. - - - - - - - - - - - - - - - - - Defines a path segment that is part of a sequence. - - - - - Gets or sets the segment id, a unique and consecutive integer. - - - - - Gets the start point in the X axis. - - - - - Gets the end point in the X axis. - - - - - Gets the start point in the Y axis. - - - - - Gets the end point in the Y axis. - - - - - Copies the segment to the end of the given segment. - - The segment. - - - - Defines a line segment. - - - - - Initializes a new insance of the class. - - - - - - - - - - - - - - - - - - - - - - - Defines a step line segment. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - - - - Defines a stepline visual point. - - The type of the drawing context. - The type of the visual. - - - - Gets the geometry. - - - The geometry. - - - - - Gets the stepline. - - - The stepline. - - - - - Gets or sets the path. - - - The path. - - - - - Gets or sets the stroke path. - - - The stroke path. - - - - - A collections of SVG paths. - - - - - A diamond. - - - - - A gem. - - - - - A star. - - - - - A heart. - - - - - A pin. - - - - - A square. - - - - - A circle. - - - - - A pentagon. - - - - - A cross mark. - - - - - A check mark. - - - - - Defines methods to close a vector. - - - - - Indicates that the vector is not closed. - - - - - Indicates that the vector is closed to the pivot value. - - - - - Indicates that the vector is closed to the start point. - - - - - Defines a draw margin frame visual in a chart. - - The type of the drawing context. - - - - Gets or sets the stroke. - - - The stroke. - - - - - Gets or sets the fill. - - - The fill. - - - - - Gets the paint tasks. - - - - - - Called when the fill changes. - - - - - - Defines a draw margin frame visual in a chart. - - The type of the sized geometry. - The type of the drawing context. - - - - Measures the specified chart. - - The chart. - - - - A set of predefined easing functions. - - - - - Gets the back in. - - - The back in. - - - - - Gets the back out. - - - The back out. - - - - - Gets the back in out. - - - The back in out. - - - - - Gets the bounce in. - - - The bounce in. - - - - - Gets the bounce out. - - - The bounce out. - - - - - Gets the bounce in out. - - - The bounce in out. - - - - - Gets the circle in. - - - The circle in. - - - - - Gets the circle out. - - - The circle out. - - - - - Gets the circle in out. - - - The circle in out. - - - - - Gets the cubic in. - - - The cubic in. - - - - - Gets the cubic out. - - - The cubic out. - - - - - Gets the cubic in out. - - - The cubic in out. - - - - - Gets the ease. - - - The ease. - - - - - Gets the ease in. - - - The ease in. - - - - - Gets the ease out. - - - The ease out. - - - - - Gets the ease in out. - - - The ease in out. - - - - - Gets the elastic in. - - - The elastic in. - - - - - Gets the elastic out. - - - The elastic out. - - - - - Gets the elastic in out. - - - The elastic in out. - - - - - Gets the exponential in. - - - The exponential in. - - - - - Gets the exponential out. - - - The exponential out. - - - - - Gets the exponential in out. - - - The exponential in out. - - - - - Gets the lineal. - - - The lineal. - - - - - Gets the polinominal in. - - - The polinominal in. - - - - - Gets the polinominal out. - - - The polinominal out. - - - - - Gets the polinominal in out. - - - The polinominal in out. - - - - - Gets the quadratic in. - - - The quadratic in. - - - - - Gets the quadratic out. - - - The quadratic out. - - - - - Gets the quadratic in out. - - - The quadratic in out. - - - - - Gets the sin in. - - - The sin in. - - - - - Gets the sin out. - - - The sin out. - - - - - Gets the sin in out. - - - The sin in out. - - - - - Gets a fuction based on the given collection. - - - - - Gets the build custom back in. - - - The build custom back in. - - - - - Gets the build custom back out. - - - The build custom back out. - - - - - Gets the build custom back in out. - - - The build custom back in out. - - - - - Gets the build custom elastic in. - - - The build custom elastic in. - - - - - Gets the build custom elastic out. - - - The build custom elastic out. - - - - - Gets the build custom elastic in out. - - - The build custom elastic in out. - - - - - Gets the build custom polinominal in. - - - The build custom polinominal in. - - - - - Gets the build custom polinominal out. - - - The build custom polinominal out. - - - - - Gets the build custom polinominal in out. - - - The build custom polinominal in out. - - - - - Gets the build cubic bezier. - - - The build cubic bezier. - - - - - Defines the BackEasingFunction - - - - - The in easing - - The t. - The s. - - - - - the out easing - - The t. - The s. - - - - - the in out easing - - The t. - The s. - - - - - Defines the BounceEasingFunction - - - - - the in easing. - - The t. - - - - - the out easing. - - The t. - - - - - the in out easing. - - The t. - - - - - Defines the CircleEasingFunction - - - - - the ease in. - - The t. - - - - - the ease out. - - The t. - - - - - the ease in out - - The t. - - - - - Defines the CubicBezierEasingFunction. - - - - - Builds a bezier easing function. - - The m x1. - The m y1. - The m x2. - The m y2. - - Bezier x values must be in [0, 1] range - - - - Defines the CubicEasingFunction - - - - - The ease in. - - The t. - - - - - The ease out. - - The t. - - - - - The ease in out. - - The t. - - - - - Defines the ElasticEasingFunction. - - - - - The ease in. - - The t. - a. - The p. - - - - - The ease out. - - The t. - a. - The p. - - - - - The ease in out. - - The t. - a. - The p. - - - - - Defines the ExponentialEasingFunction. - - - - - The ease in. - - The t. - - - - - The ease out. - - The t. - - - - - The ease in out. - - The t. - - - - - Defines the PolinominalEasingFunction. - - - - - The ease in. - - The t. - The e. - - - - - The ease out. - - The t. - The e. - - - - - The ease in out. - - The t. - The e. - - - - - Defines a candle sticks series. - - The type of the model. - The type of the visual. - The type of the label. - The type of the miniature geometry, used in tool tips and legends. - The type of the drawing context. - - - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets the paint tasks. - - - - - - - - - - - - - Called when [paint changed]. - - Name of the property. - - - - - - - - Defines a geo map chart. - - - - - - Initializes a new instance of the class. - - - - - - Gets the chart view. - - - - - - - - - - - Queues a measure request to update the chart. - - - - - - Unload the map resources. - - - - - Called to measure the chart. - - The update task. - - - - Measures the chart. - - - - - Projects latitude and longitude coordinates in a control coordinates. - - - - - - Initializes a new instance of the class. - - Width of the map. - Height of the map. - The offset x. - The offset y. - - - - Gets the preferred ratio. - - - The preferred ratio. - - - - - - - - Defines a geographic map for LiveCharts controls. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class, with the given layer. - - The path to the GeoJson file for the layer. - The layer name. - - - - Initializes a new instance of the class, with the given layer. - - The stream reader instance of the GeoJson file for the layer. - The layer name. - - - - Gets the map layers dictionary. - - - - - Finds a land by short name. - - The short name. - The layer name. - The land, null if not found. - - - - Adds a layer to the map from a directory. - - The path to the GeoJson file for the layer. - The layer name. - The stroke. - The fill. - The added layer. - - - - Adds a layer to the map from a directory. - - The path to the GeoJson file for the layer. - The layer name. - The added layer. - - - - Adds a layer to the map from a stream reader. - - The path to the stream reader. - The layer name. - The stroke. - The fill. - The added layer. - - - - Adds a layer to the map from a stream reader. - - The path to the stream reader. - The layer name. - The added layer. - - - - Adds a layer to the map from a directory asynchronously. - - The path to the GeoJson file for the layer. - The layer name. - The stroke. - The fill. - The added layer as await-able task. - - - - Adds a layer to the map from a directory asynchronously. - - The path to the GeoJson file for the layer. - The layer name. - The added layer as await-able task. - - - - Adds a layer to the map from a stream reader asynchronously. - - The path to the stream reader. - The layer name. - The stroke. - The fill. - The added layer as await-able task. - - - - Adds a layer to the map from a stream reader asynchronously. - - The path to the stream reader. - The layer name. - The added layer as await-able task. - - - - Disposes the map. - - - - - Defines geo json features - - - - - Gets or sets the type. - - - The type. - - - - - Gets or sets the properties. - - - The properties. - - - - - Gets or sets the geometry. - - - The geometry. - - - - - Defines a map using the GeoJson format. - - - - - Gets or sets the type. - - - The type. - - - - - Gets or sets the features. - - - The features. - - - - - Defines a geographic map. - - - - - Gets or sets the active map. - - - - - Gets the motion canvas. - - - - - Gets the control width. - - - - - Gets the control height. - - - - - Gets or sets the stroke. - - - - - Gets or sets the fill. - - - - - Gets or sets whether the chart auto-updates are enabled. - - - - - Gets or sets the projection. - - - - - Gets whether the control is in designer mode. - - - - - Gets or sets the Synchronization Context, use this property to - use an external object to handle multi threading synchronization. - - - - - Gets or sets the view command. - - - - - Invokes an action in the UI thread. - - - - - - Gets or sets the series. - - - - - Defines a geographical data series. - - - - - Gets or sets a value to indecate whether the series is visible. - - - - - Defines a geographical data series. - - - - - Draw the series. - - The map context. - - - - Deltes the series. - - The map context. - - - - Defines a heat land shape. - - - - - Gets or sets the color of the fill. - - - The color of the fill. - - - - - Defines a map factory. - - - - - Updates the lands. - - - - - - Move the map to the specified view. - - The sender. - The command. - - - - Pans the map. - - The sender. - The delta. - - - - Defines a weighted map shape. - - - - - Gets or sets the name of the land. - - - - - Gets or sets the value. - - - - - Defines the land data class. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the maximum bounds. - - - The maximum bounds. - - - - - Gets or sets the minimum bounds. - - - The minimum bounds. - - - - - Gets the bounds hypotenuse. - - - - - Gets or sets the land data. - - - - - Gets or sets the shape. - - - - - Defines the data of a lane in a map. - - - - - Initializes a new instance of the class. - - The short name. - The name. - The set of. - - - - Gets the short name. - - - - - Gets the name. - - - - - Gets or sets the set of reference. - - - - - Gets the HSize. - - - - - Gets the HCenter. - - - - - Gets or sets the maximum bounds. - - - The maximum bounds. - - - - - Gets or sets the minimum bounds. - - - The minimum bounds. - - - - - Gets or sets the data. - - - - - Defines a map context. - - - - - - Initializes a new instance of class. - - - - - Gets the core map. - - - - - Gets the map file. - - - - - Gets the map projector. - - - - - Gets the map view. - - - - - Defines a map layer. - - - - - Initializes a new from the given . - - The layer name. - The stroke. - The fill. - - - - Gets or sets the name. - - - The name. - - - - - Gets or sets the layer process index. - - - - - Gets or sets a value indicating whether this layer is visible. - - - - - Gets or sets the stroke. - - - - - Gets or sets the fill. - - - - - Gets or sets the X bounds. - - - - - Gets or sets the Y bounds. - - - - - Gets the lands. - - - - - Gets or sets the land condition, it must return true if the land is required. - - - - - Adds a GeoJson file to the layer. - - - - - - Map projections. - - - - - The default projection, it only translates longitude and latitude coordinates to - UI coordinates starting at 0, 0 (up-left corner) - - - - - The Mercator projections, it is a popular projection used by many map engines like - Google maps or Bing maps. - - - - - The map projector class. - - - - - Gets the map width. - - - - - Gets the map height. - - - - - Gets the x offset width. - - - - - Gets the y offset. - - - - - Projects the given point. - - The point. - - - - - Defines the maps - - - - - Gets the world map. - - The map. - Map not found - - - - Gets a map from a specified path. - - The path. - The map. - - - - Gets a map from a specified stream. - - The stream. - The map. - - - - Builds a projector with the given parameters. - - The projection. - Size of the map. - - - - - Defines the map shape context class. - - - - - Initializes a new instance of the class. - - The chart. - The heat paint. - The heat stops. - The bounds. - - - - Gets the chart. - - - - - Gets the heat paint. - - - - - Gets the heat stops. - - - - - Gets the bounds dictionary. - - - - - Projects latitude and longitude coordinates using the Mercator projection. - - - - - - Initializes a new instance of the class. - - Width of the map. - Height of the map. - The offset x. - The offset y. - - - - Gets the preferred ratio. - - - The preferred ratio. - - - - - - - - The multi-polygon feature class. - - - - - Gets or sets the type. - - - The type. - - - - - Gets or sets the coordinates. - - - The coordinates. - - - - - Defines the - - - - - Initializes a new instance of the command. - - The pivot. - The direction. - - - - Gets the pivot. - - - - - Gets the direction. - - - - - Defines common heat functions. - - - - - Builds the color stops. - - The heat map. - The color stops. - - - At least 2 colors are required in a heat map. - or - At least 2 colors are required in a heat map. - - - - - Interpolates the color. - - The weight. - The weight bounds. - The heat map. - The heat stops. - - - - - Defines the heat land series class. - - - - - - Initializes a new instance of the class. - - - - - Called when a property changes. - - - - - Gets or sets the name. - - - - - Gets or sets the heat map. - - - - - Gets or sets the color stops. - - - - - Gets or sets the lands. - - - - - - - - - - - - - - Initializes the series. - - - - - Called to invoke the property changed event. - - - - - Defines a column series. - - The type of the model. - The type of the visual. - The type of the label. - The type of the drawing context. - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Defines the internal series interface. - - - - - Gets the properties of the series. - - - - - Defines a chart series. - - - - - Gets or sets a series unique identifier, the library handles this id automatically. - - - - - Gets the properties of the series. - - - - - Gets whether the series requires to find the closest point when the pointer goes down. - - - - - Gets or sets the name of the series, the name is normally used by or - , the default value is set automatically by the library. - - - - - Gets or sets the values. - - - The values. - - - - - Gets or sets a value indicating whether this instance is visible. - - - true if this instance is visible; otherwise, false. - - - - - Gets or sets a value indicating whether this instance will show up in tool tips when the pointer is over a point. - default value is true. - - - true if this instance is hover-able; otherwise, false. - - - - - Gets or sets a value indicating whether this instance will show up in legends. - default value is true. - - - true if this instance is visible at legends; otherwise, false. - - - - - Gets or sets the size of the legend shape. - - - The size of the legend shape. - - - - - Gets or sets the data padding, the distance from the edge of the chart to where the series is drawn, - both coordinates (X and Y) from 0 to 1, where 0 is nothing and 1 is the axis tick (the separation between every label). - - - The data padding. - - - - - Gets or sets the z index position. - - - The index of the z. - - - - - Gets or sets the value where the direction of the axis changes, by default is 0. - - - - - Gets or sets the series geometry svg, this property requires the series visual to be - an instance. - - - - - Gets or sets the animations speed, if this property is null, the - property will be used. - - - The animations speed. - - - - - Gets or sets the easing function to animate the series, if this property is null, the - property will be used. - - - The easing function. - - - - - Occurs when the series property changes. - - - - - Gets the tool tip text for a give chart point. - - The chart point. - - - - - Gets the tool tip text for a give chart point. - - The chart point. - - - - - Gets the data label content for a given chart point. - - The chart point. - - - - - Gets a array with the points used to generate the plot. - - the chart - - - - - Gets the instances which contain the , according - to the chart's property. - - the chart. - the pointer position. - the strategy. - - - - - Called when the pointer enters a chart point. - - - - - - Called when the pointer leaves a chart point. - - - - - - Clears the visuals in the cache and re-starts animations. - - - - - Deletes the series from the user interface. - - - - - Defines a series. - - The type of the model. - - - - - Gets or sets the mapping. - - - The mapping. - - - - - Gets or sets the values. - - - The values. - - - - - An object that is able to throttle an action. - - - - - Initializes a new instance of the class. - - The target action to throttle. - The throttling time. - - - - Gets or sets the throttler time span. - - - The throttler time span. - - - - - Schedules a call to the target action. - - - - - - Forces the call to the target action, this call is not throttled. - - - - - - Defines a visual element in a chart. - - - - - Occurs when a property value changes. - - - - - - - - - - - - - - - - - - Gets the paint tasks registered by the . - - - - - - Sets a property value and handles the paints in the canvas. - - The referenced paint task. - The value - if set to true [is stroke]. - Name of the property. - - - - - Sets a property value. - - - - - - - - - Determines whether the property can be set. - 1. The user always can. - 2. A style can set it only if the user did not. - - - - - - - Schedules the delete for thew given instance. - - - - - - Called when the fill changes. - - - - - - Called when a property changes. - - Name of the property. - - - - - Represents additional data required by LiveCharts to draw a point. - - - - - Initializes a new instance of the class. - - The callback to call when the entity index changes. - - - - Gets the entity index, a consecutive integer based on the position of the entity in the data collection. - - - - - Gets the chart points dictionary. - - - - - Defines a point in a chart. - - - - - Initializes a new instance of the class. - - The chart. - The series. - The entity. - - - - Initializes a new instance of the class. - - The point. - - - - Gets a new instance of an empty chart point. - - - - - Gets the position of the point the collection that was used when the point was drawn. - - - - - Gets or sets the coordinate. - - - - - Gets or a value indicating whether this instance is empty, LivveCharts will ignore the point in the chart. - - - true if this instance is empty; otherwise, false. - - - - - Gets or sets the primary value. - - - The primary value. - - - - - Gets or sets the secondary value. - - - The secondary value. - - - - - Gets or sets the tertiary value. - - - The tertiary value. - - - - - Gets or sets the quaternary value. - - - The quaternary value. - - - - - Gets or sets the quinary value. - - - The quinary value. - - - - - Gets or sets the stacked value, if the point do not belongs to a stacked series then this property is null. - - - - - Gets the point as data label. - - - As tooltip string. - - - - - Gets the context. - - - The context. - - - - - Gets the distance to a given point. - - The point to calculate the distance to. - The distance in pixels. - - - - Defines a point in a chart with known visual and label types. - - The type of the model. - The type of the visual. - The type of the label. - - - - Initializes a new instance of the class. - - The point. - - - - Gets the model, this is the actual object that represents the point in the chart. - - - The model. - - - - - Gets the visual. - - - The visual. - - - - - Gets the label. - - - The label. - - - - - Defines the environment of a point in a chart. - - - - - Initializes a new instance of the class. - - The chart. - The series. - The entity. - - - - Gets the chart. - - - The chart. - - - - - Gets the series. - - - The series. - - - - - Gets the . - - - - - Gets the DataSource. - - - - - Gets the position of the point the collection that was used when the point was drawn. - - - - - Gets the visual. - - - The visual. - - - - - Gets the additional visuals, some series might have more than one visual, here you can find the rest of them. - - - - - Gets the label. - - - The label. - - - - - Gets or sets the area that triggers the ToolTip. - - - - - Defines the chart update parameter. - - - - - Gets or sets a value indicating whether this instance is automatic update. - - - true if this instance is automatic update; otherwise, false. - - - - - Gets or sets a value indicating whether this is throttling. - - - true if throttling; otherwise, false. - - - - - A helper class that tracks both, and - events. - - - - - - The check i notify property changed - - - - - Initializes a new instance of the class. - - The on collection changed handler. - The on item property changed handler. - if true, it will force the check to verify if the type {T} implements INotifyPropertyChanged. - - - - Initializes the listeners. - - The instance. - - - - - Disposes the listeners. - - The instance. - - - - - Defines a coordinate. - - - - - Initializes a new instance of the struct. - - - - - Initializes a new instance of the struct. - - The x value. - The maximum value. - The third quiartile value. - The first quartile value. - The minimum value. - The median value. - - - - Initializes a new instance of the struct. - - The x value. - The high value. - The open value. - The quaternary value. - The quinary value. - - - - Initializes a new instance of the struct. - - The X coordinate. - The Y coordinate. - - - - Initializes a new instance of the struct. - - The X coordinate. - The Y coordinate. - The weight of the pint. - - - - Gets an empty coordinate instance. - - - - - Evaluates whether the instance is empty. - - - - - Gets or sets the primary value, normally the Y coordinate or the value in a gauge. - - - The primary value. - - - - - Gets or sets the secondary value, normally the X coordinate. - - - The secondary value. - - - - - Gets or sets the tertiary value, normally used on weighted, financial or box series. - - - The tertiary value. - - - - - Gets or sets the quaternary value, normally used on financial or box series. - - - The quaternary value. - - - - - Gets or sets the quinary value, normally used on financial or box series. - - - The quinary value. - - - - - Gets or sets the senary value, normally used on financial or box series. - - - The senary value. - - - - - Gets or sets the coordinate error. - - - - - Designer series kind. - - - - - The Cartesian kind. - - - - - The pie kind. - - - - - Defines the bezier data class. - - - - - Initializes a new instance of the class. - - The chart point. - - - - Gets or sets the target point. - - - The target point. - - - - - Gets or sets the x0. - - - The x0. - - - - - Gets or sets the y0. - - - The y0. - - - - - Gets or sets the x1. - - - The x1. - - - - - Gets or sets the y1. - - - The y1. - - - - - Gets or sets the x2. - - - The x2. - - - - - Gets or sets the y2. - - - The y2. - - - - - Gets or sets a value indicating whether the next point is empty. - - - - - Defines a hover area. - - - - - Gets the distance to a given point. - - The point to calculate the distance to. - The distance in pixels. - - - - Determines whether the pointer is over the area. - - The pointer location. - The strategy. - - - - - Suggests the tooltip placement. - - The context. - Size of the tooltip. - - - - Defines a rectangle hover area. - - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The x. - The y. - The width. - The height. - - - - Gets or sets the x location. - - - The x. - - - - - Gets or sets the y location. - - - The y. - - - - - Gets or sets the width. - - - The width. - - - - - Gets or sets the height. - - - The height. - - - - - Gets or sets the suggested tool tip location - - - - - Gets or sets a value indicating whether the primary value is less than pivot. - - - - - Sets the area dimensions. - - The x. - The y. - The width. - The height. - The current instance. - - - - Sets the to the center of the in the X axis. - - The current instance. - - - - Sets the to the start of the in the X axis. - - The current instance. - - - - Sets the to the center of the in the X axis. - - The current instance. - - - - Sets the to the center of the in the Y axis. - - The current instance. - - - - Sets the to the start of the in the Y axis. - - The current instance. - - - - Sets the to the center of the in the Y axis. - - The current instance. - - - - Gets or sets a value indicating whether the primary value is less than pivot. - - The current instance. - - - - - - - - - - - - - Defines a semicircle hover area. - - - - - - Gets or sets the center x. - - - The center x coordinate. - - - - - Gets or sets the center y. - - - The center y coordinate. - - - - - Gets or sets the start angle in degrees. - - - - - Gets or sets the and angle in degrees. - - - - - Gets or sets the inner radius. - - - - - Gets or sets the radius. - - - - - Sets the area dimensions. - - The center x. - The center y. - The start angle. - The end angle. - The inner radius. - The radius. - - - - - - - - - - - - - - Defines the paint context. - - The type of the drawing context. - - - - Initializes a new instance of the class. - - The widht. - The height. - The svg path. - - - - Gets or sets the width. - - - The width. - kjio9 - - - - Gets or sets the height. - - - The height. - - - - - Gets or sets the Svg. - / - - - - Gets or sets the paint schedules. - - - The paint tasks schedule. - - - - - Defines an error point. - - - - - Initalizes a new instance of the struct. - - The left error in the x axis. - The right error in the x axis. - The top error in the Y axis. - The bottom error in the Y axis. - - - - Initalizes a new instance of the struct. - - The error in x. - The error in y. - - - - Gets the error to the left of the X axis. - - - - - Gets the error to the right of the X axis. - - - - - Gets the error to the top of the Y axis. - - - - - Gets the error to the bottom of Y axis. - - - - - Gets whether the error is empty. - - - - - Gets an empty instance of the error class. - - - - - Command arguments that describe when a chart event occurs. - - - - - Initializes a new instance of the class. - - The chart that fired the event. - - - - Gets the sender chart. - - - - - Defines a method that will handle an event in a chart. - - The type of the drawing context. - The chart. - - - - Defines a method to handle chart point events. - - The sender chart. - The found points. - - - - Defines a method to handle chart point events. - - The type of the model. - The type of the visual. - The type of the label. - The sender chart. - The found points. - - - - Defines a method to handle chart point events. - - The sender chart. - The found points. - - - - Defines a method to handle chart point events. - - The type of the model. - The type of the visual. - The type of the label. - The sender chart. - The found points. - - - - Command arguments that describe a pointer event in a LiveChart view. - - - - - Initializes a new instance of the class. - - The chart that fired the event. - The pointer position. - The original event args. - - - - Gets the pointer position relative to the chart. - - - - - Gets the framework-specific event arguments. - - - - - Defines the visual elements event arguments. - - - - - Initializes a new instance of the class. - - The chart. - The pointer location. - The visual elements. - - - - Initializes a new instance of the class. - - The chart. - The pointer location. - The visual element. - - - - Gets the chart. - - - - - Gets or sets the pointer location. - - - - - Gets the visual elements found. - - - - - Defines a method to handle chart visual elements events. - - The type of the drawing context. - The sender visual. - The visual elements arguments. - - - - Defines the visual elements event arguments. - - - - - Initializes a new instance of the class. - - The chart. - The pointer location. - The visual elements. - - - - Initializes a new instance of the class. - - The chart. - The pointer location. - The visual elements. - - - - Gets the chart. - - - - - Gets or sets the pointer location. - - - - - Gets the closest visual element to the pointer position. - - - - - Gets all the visual elements that were found. - - - - - Defines a method to handle chart visual elements events. - - The type of the drawing context. - The sender chart. - The visual elements arguments. - - - - LiveCharts kernel extensions. - - - - - Calculates the tooltip location. - - - The points. - The tooltip size. - The chart. - - - - - - Gets the tick. - - The axis. - Size of the control. - The bounds. - The max label size. - - - - - Gets the tick. - - The axis. - The chart. - The bounds. - - - - - Sets the transition of the given to the . - - The animatable object. - The animation. - - The properties, if this argument is not set then all the animatable properties in the object will use the given animation. - - - - - Sets the transition of the given to the specified and . - - The animatable object. - The animation's easing function. - The animation's speed. - - The properties, if this argument is not set then all the animatable properties in the object will use the given animation. - - - - - Sets the transition of the given to the animations config in the chart, - if the properties are not set, then all the animatable properties in the object will use the given animation. - - The animatable object. - - The chart, an animation will be built based on the - and . - - - The properties, if this argument is not set then all the animatable properties in the object will use the given animation. - - - - - Sets the transition of the given to the animations config in the chart - for all the geometries in a . - - - The visual. - The animation. - The properties. - - - - Sets the transition of the given to the specified and - for all the geometries in a . - - The visual object. - The animation's easing function. - The animation's speed. - - The properties, if this argument is not set then all the animatable properties in the object will use the given animation. - - - - - Sets the transition of the given to the animations config in the chart, - if the properties are not set, then all the animatable properties in the object will use the given animation. - The transition will be set for all the geometries in a . - - The visual`` object. - - The chart, an animation will be built based on the - and . - - - The properties, if this argument is not set then all the animatable properties in the object will use the given animation. - - - - - Determines whether is bar series. - - The series. - - true if [is bar series] [the specified series]; otherwise, false. - - - - - Determines whether is column series. - - The series. - - true if [is column series] [the specified series]; otherwise, false. - - - - - Determines whether is row series. - - The series. - - true if [is row series] [the specified series]; otherwise, false. - - - - - Determines whether is box series. - - The series. - - true if [is box series] [the specified series]; otherwise, false. - - - - - Determines whether is stacked series. - - The series. - - true if [is stacked series] [the specified series]; otherwise, false. - - - - - Determines whether is vertical series. - - The series. - - true if [is vertical series] [the specified series]; otherwise, false. - - - - - Determines whether is horizontal series. - - The series. - - true if [is horizontal series] [the specified series]; otherwise, false. - - - - - Determines whether is a financial series. - - - - - - - Determines whether is a pie series. - - The series. - - - - Determines whether is bar series. - - The series. - - true if [is bar series] [the specified series]; otherwise, false. - - - - - Calculates the tooltips finding strategy based on the series properties. - - The series collection. - - - - - Finds the closest point to the specified location [in pixels]. - - The points to look in to. - The location in pixels. - - - - - Finds the closest point to the specified location [in pixels]. - - The points to look into. - The location in pixels. - - - - - Gets a scaler for the given axis with the measured bounds (the target, the final dimension of the chart). - - - - - - - - - Gets a scaler that is built based on the dimensions of the chart at a given time, the scaler is built based on the - animations that are happening in the chart at the moment this method is called. - - - - - - - - - Returns an enumeration with only the first element. - - The source type. - The target type. - The source enumeration. - The mapping predicate. - - - - - Gets the point for the given view. - - The points dictionary. - The view. - - - - - Splits an enumerable of chartpoints by each null gap. - - The points. - Called when a point was deleted. - - - - - Builds a enumerator with the necessary data to build an Spline. - - - - - - - Returns when the given type is either a reference type or of type . - - - - - Defines an axis visual separator. - - The type of the drawing context. - - - - Gets or sets the value. - - - The value. - - - - - Gets or sets the text. - - - The text. - - - - - Gets or sets the line. - - - The line. - - - - - Gets or sets the line. - - - The line. - - - - - Gets or sets the sub separators. - - - - - Gets or sets the sub ticks. - - - - - Gets the geometry. - - - - - Defines a visual separator. - - - - - - Gets or sets the value. - - - The value. - - - - - Gets or sets the text. - - - The text. - - - - - Gets the geometry. - - - The line. - - - - - Defines an polar axis visual separator. - - The type of the drawing context. - - - - Gets or sets the value. - - - The value. - - - - - Gets or sets the text. - - - The text. - - - - - Gets or sets the circle. - - - The line. - - - - - Gets the geometry. - - - - - Defines a visual element in a chart. - - - - - Gets or sets the object that contains data about the control. - - - - - Invalidates the in the user interface. - - The chart. - - - - Deletes the instances that changed from the user interface. - - The chart. - - - - Removes the element from the UI. - - The chart. - - - - Defines a point with a visual representation in the user interface. - - - - - Gets or sets the meta data, the additional data required by LiveCharts to draw a point. - - - - - Gets or sets the coordinate, the position of the point in the chart. - - - - - Defines a gauge builder - - - - - Gets or sets the inner radius. - - - The inner radius. - - - - - Gets or sets the offset radius, the separation between each gauge if multiple gauges are nested. - - - The relative inner radius. - - - - - Gets or sets the maximum width of the radial column. - - - The maximum width of the radial column. - - - - - Gets or sets the corner radius. - - - The corner radius. - - - - - Gets or sets the radial align. - - - The radial align. - - - - - Gets or sets the background inner radius. - - - The background inner radius. - - - - - Gets or sets the background offset radius, the separation between each gauge if multiple gauges are nested. - - - The background relative inner radius. - - - - - Gets or sets the width of the background maximum radial column. - - - The width of the background maximum radial column. - - - - - Gets or sets the background corner radius. - - - The background corner radius. - - - - - Gets or sets the background. - - - The background. - - - - - Gets or sets the size of the labels. - - - The size of the labels. - - - - - Gets or sets the labels position. - - - The labels position. - - - - - Gets or sets the label formatter. - - - The label formatter. - - - - - LiveCharts global settings - - - - - Gets the theme identifier. - - - The theme identifier. - - - - - Gets or sets the default easing function. - - - The default easing function. - - - - - Gets or sets the default animations speed. - - - The default animations speed. - - - - - Gets or sets the default zoom speed. - - - The default zoom speed. - - - - - Gets or sets the default zoom mode. - - - The default zoom mode. - - - - - Gets or sets the default legend position. - - - The default legend position. - - - - - Gets or sets the default legend background paint. - - - - - Gets or sets the default legend text paint. - - - - - Gets or sets the default legend text size. - - - - - Gets or sets the default tooltip position. - - - The default tooltip position. - - - - - Gets or sets the default tooltip background paint. - - - - - Gets or sets the default tooltip text paint. - - - - - Gets or sets the default tooltip text size. - - - - - Gets or sets the default max with for labels inside tooltips and legends. - - - - - Gets or sets the default tooltip finding strategy. - - - The default tooltip finding strategy. - - - - - Gets or sets the default polar initial rotation. - - - The default animations speed. - - - - - Gets or sets the default update throttling timeout - - - The default update throttling timeout - - - - - Gets or sets a value indicating whether the text is right to left. - - - - - Adds or replaces a mapping for a given type, the mapper defines how a type is mapped to a instance, - then the will be drawn as a point in our chart. - - The type of the model. - The mapper. - - - - - Indicates that the library should render tooltips in a right to left mode, you also need to load - a right to left font. - - - - - - Sets the default animations speed. - - The animations speed. - The current settings - - - - Sets the default the default easing function. - - The easing function. - The current settings - - - - Sets the default the default zoom speed. - - The speed. - The current settings - - - - Sets the default the default zoom mode. - - The zoom mode. - The current settings - - - - Sets the default the default update throttling timeout - - The update throttling timeout. - The current settings - - - - Sets the default legend background paint. - - The type of the drawing context. - The paint. - The current settings. - - - - Sets the default legend text paint. - - The type of the drawing context. - The paint. - The current settings. - - - - Sets the default legend text size. - - The size. - The current settings. - - - - Sets the default tooltip background paint. - - The type of the drawing context. - The paint. - The current settings. - - - - Sets the default tooltip text paint. - - The type of the drawing context. - The paint. - The current settings. - - - - Sets the default tooltip text size. - - The size. - The current settings. - - - - Removes a map from the settings. - - The type of the model. - - - - - Adds the default styles. - - The type of the drawing context. - The builder. - - - - - Gets the styles builder. - - The type of the drawing context. - - $"The type {nameof(TDrawingContext)} is not registered. - - - - Enables LiveCharts to be able to plot short, int, long, float, double, decimal, short?, int?, long?, float?, double?, decimal?, - , , , and - . - - - - - - Defines a schedule to be drawn by an instance. - - The type of the drawing context. - - - - Initializes a new instance of the class. - - The task. - The geometries. - - - - Initializes a new instance of the class. - - The task. - The geometries. - - - - Gets or sets the paint task. - - - The drawable task. - - - - - Gets or sets the geometries. - - - The geometries. - - - - - Defines the class. - - The type of the drawing context. - - - - Gets a new instance of the default data factory. - - The type of the model. - - - - - Gets a new instance of the default map factory. - - - - - - Gets a new instance of the default Cartesian axis. - - - - - - Gets a new instance of the default polar axis. - - - - - - Gets a new paint of the given color. - - - - - - Defines the default data factory. - - - - - - - Gets or sets the previous known bounds. - - - - - Initializes a new instance of the class. - - - - - Fetches the points for the specified series. - - The series. - The chart. - - - - - Disposes a given point. - - The point. - - - - - Disposes the data provider from the given chart. - - - - - - Gets the Cartesian bounds. - - The chart. - The series. - The x. - The y. - - - - - Gets the financial bounds. - - The chart. - The series. - The x. - The y. - - - - - Gets the pie bounds. - - The chart. - The series. - - Unexpected null stacker - - - - Clears the visuals in the cache. - - - - - Defines a series context. - - The type of the drawing context. - - - - Initializes a new instance of the class. - - The series. - Indicates whether is the first time the chart is drawn. - The chart - - - - Gets the column position. - - The series. - - - - Gets the column series count. - - - - - Gets the required space by the labels to the outer side of the pie chart. - - - - - Gets the row position. - - The series. - - - - - Gets the row series count. - - - - - - Gets the box position. - - The series. - - - - - Gets the box series count. - - - - - - Gets the stacked column position. - - The series. - - - - - Gets the stacked column series count. - - - - - - Gets the stacked row position. - - The series. - - - - - Gets the stacked row series count. - - - - - - Gets the stack position. - - The series. - The stack group. - - - - - Gets or sets a value indicating whether is first draw of the chart. - - - - - Defines the series properties enumeration. - - - - - includes all series - - - - - The Cartesian series - - - - - The bar series - - - - - - The line series - - - - - The stepline series - - - - - The scatter series - - - - - The heat series. - - - - - The financial series. - - - - - The pie series. - - - - - The stacked series - - - - - The vertical orientation - - - - - The horizontal orientation - - - - - The gauge. - - - - - The gauge fill. - - - - - The sketch - - - - - The solid - - - - - The prefers x tool tips - - - - - The prefers y tool tips - - - - - The prefers xy tool tips - - - - - The polar series - - - - - The polar line series - - - - - Sepcifies that the series visual comes from a svg path. - - - - - The box series. - - - - - Defines a series style rule. - - The type of the visual. - The type of the drawing context. - - - - Gets or sets the series properties. - - - The series properties. - - - - - Gets or sets the rule. - - - The rule. - - - - - Defines a bar series point. - - The type of the drawing context. - - - - - Gets or sets the rx, the radius used in the x axis to round the corners of each column in pixels. - - - The rx. - - - - - Gets or sets the ry, the radius used in the y axis to round the corners of each column in pixels. - - - The ry. - - - - - Gets or sets the padding for each group of bars that share the same secondary coordinate. - - - The bar group padding. - - - - - Gets or sets the padding for each bar in the series. - - - The bar group padding. - - - - - Gets or sets the maximum width of the bar. - - - The maximum width of the bar. - - - - - Gets or sets a value indicating whether the bar position respects the other bars that share - the same . - - - - - Defines an error series series. - - The type of the drawing context. - - - - - Gets or sets the maximum width of the bar. - - - The maximum width of the bar. - - - - - Gets or sets the padding for each box in the series. - - - The bar group padding. - - - - - Defines an Axis in a Cartesian chart. - - - - - Gets the orientation. - - - The orientation. - - - - - Gets or sets the padding around the tick labels along the axis. - - - The padding in pixels. - - - - - Gets or sets the xo, a reference used internally to calculate the axis position. - - - The xo. - - - - - Gets or sets the yo, a reference used internally to calculate the axis position. - - - The yo. - - - - - Gets or sets the size of the axis, this value is used internally to calculate the axis position. - - - The length. - - - - - Gets or sets the min zoom delta, the minimum difference between the max and min visible limits of the axis. - default is null and null means that the library will calculate this value based on the current data. - - - - - Gets or sets a value indicating whether the ticks are centered to the , default is true. - - - - - Gets or sets a value indicating whether the separators are centered to the , default is true. - - - - - Gets or sets the reserved area for the labels. - - - - - Gets or sets the reserved area for the name. - - - - - Places the title in the same direction as the axis, default is false. - - - - - Gets or sets the labels alignment, default is null and means that the library will set it based on the - and properties. - - - - - Gets or sets the axis position. - - - The position. - - - - - Gets or sets the shared axes collection, useful to share the zooming an panning between several charts. - - - - - Initializes the axis for the specified orientation. - - The orientation. - - - - Occurs when the axis is initialized. - - - - - Gets the axis limits considering its own and the axes. - - The limits. - - - - Sets the axis limits (own and shared). - - The min limit. - The max limit. - - - - Defines an Axis in a Cartesian chart. - - - - - - Gets or sets the sub-separators paint. - - - The separators paint. - - - - - Gets or sets the number of subseparators to draw. - - - - - Gets or sets whether the ticks path should be drawn. - - - - - Gets or sets the separators paint. - - - The separators paint. - - - - - Gets or sets the separators paint. - - - The separators paint. - - - - - Gets or sets the zero paint. - - - The separators paint. - - - - - Gets or sets the crosshair paint. - - - The separators paint. - - - - - Gets or sets the crosshair labels paint. - - - The separators paint. - - - - - Gets or sets the crosshair background. - - - The separators paint. - - - - - Gets or sets the crosshair labels padding. - - - - - Gets or sets whether the crosshair snaps to nearest series. - - - - - Invalidates the crosshair visual. - - The chart. - The pointer position - - - - Defines a Cartesian chart view, this view is able to host one or many series in a Cartesian coordinate system. - - The type of the drawing context. - - - - - Gets the core. - - - The core. - - - - - Gets or sets the x axes. - - - The x axes. - - - - - Gets or sets the y axes. - - - The y axes. - - - - - Gets or sets the sections. - - - The sections. - - - - - Gets or sets the series to plot in the user interface. - - - The series. - - - - - Gets or sets the draw margin frame. - - - The draw margin frame. - - - - - Gets or sets the zoom mode. - - - The zoom mode. - - - - - Gets or sets the tool tip finding strategy. - - - The tool tip finding strategy. - - - - - Gets or sets the zooming speed from 0 to 1, where 0 is the slowest and 1 the fastest. - - - The zooming speed. - - - - - Scales a UI point to the chart values scale. - - The point. - Index of the x axis. - Index of the y axis. - - - - - Scales a point in pixels to the chart data scale. - - The point. - Index of the x axis. - Index of the y axis. - - - - - Scales a point in the chart data scale to pixels. - - The point. - Index of the x axis. - Index of the y axis. - - - - - Defines a Cartesian series. - - The type of the drawing context. - - - - - Gets or sets the axis index where the series is scaled in the X plane, the index must exist - in the collection. - - - The index of the axis. - - - - - Gets or sets the axis index where the series is scaled in the Y plane, the index must exist - in the collection. - - - The index of the axis. - - - - - Gets or sets the data labels position. - - - The data labels position. - - - - - Gets or sets the data labels translate transform, the property is of type , - where the property is in normalized units (from 0 to 1), where 1 is the width of the label and - the property is also in normalized units (from 0 to 1), where 1 is the height of the label. - - - The data labels trasnlate. - - - - - Gets or sets the clipping mode, clipping restricts the series and labels for being drawn outside of the chart area (DrawMargin), - default is , and means that anything outside the chart bounds will be ignored. - - - - - Gets the series bounds. - - The chart. - The x. - The y. - the series bounds - - - - Defines a chart. - - - - - Gets or sets the measure work. - - - The measure work. - - - - - Gets the chart view. - - - The view. - - - - - Gets the canvas. - - - The canvas. - - - - - Gets the legend position. - - - The legend position. - - - - - Gets the toolTip position. - - - The toolTip position. - - - - - Gets the toolTip finding strategy. - - - The toolTip finding strategy. - - - - - Updates the chart in the user interface. - - - - - Defines a chart legend. - - The type of the drawing context. - - - - Draws the legend for the specified chart. - - The chart. - - - - Measures the control. - - The chart that holds the control. - - - - Defines a series a chart series that has a visual representation in the user interface. - - The type of the drawing context. - - - - - Gets or sets the data labels paint. - - - The data labels paint. - - - - - Gets or sets the size of the data labels. - - - The size of the data labels. - - - - - Gets or sets the data labels rotation in degrees. - - - The rotation of the data labels in degrees. - - - - - Gets or sets the data labels padding. - - - The data labels padding. - - - - - Gets or sets the max width of the data labels. - - - The max with of the data labels. - - - - - Gets the paint schedule, normally handled internally to display tool tips and legends. - - - The default paint context. - - - - - Gets the stack group, normally used internally to handled the stacked series. - - - - - - - - - - - - Called when the pointer goes down on a data point or points. - - The chart. - The found points. - The pointer location. - - - - Defines a tool tip. - - The type of the drawing context. - - - - Shows the tool tip in the specified chart. - - The found points. - The chart. - - - - Hides this tool tip instance. - - The chart. - - - - Defines a chart view - - - - - Gets the core. - - - The core. - - - - - Gets whether the control is in designer mode. - - - - - Sets the back color of the control. - - - The color of the back. - - - - - Gets the size of the control. - - - The size of the control. - - - - - Gets or sets the draw margin, if this property is null, the library will calculate a margin, this margin is the distance - between the view bounds and the drawable area. - - - The draw margin. - - - - - Gets or sets the animations speed. - - - The animations speed. - - - - - Gets or sets the easing function, the library already provides many easing functions in the - LiveCharts.EasingFunction static class. - - - The easing function. - - - - - Gets or sets the updater throttler, this property controls the interval where the user interface updates. - - - The updater throttler. - - - - - Gets or sets the legend position. - - - The legend position. - - - - - Gets or sets the tooltip position. - - - The tooltip position. - - - - - Occurs when the pointer goes down over a chart point(s). - - - - - Occurs when the pointer goes down over a chart point, if there are multiple points, the closest one will be selected. - - - - - Called when the pointer goes down on a data point or points. - - The found points. - The pointer location. - - - - Gets or sets the Synchronization Context, use this property to - use an external object to handle multi threading synchronization. - - - - - Invokes an action in the UI thread. - - - - - - Invalidates the control. - - - - - Defines a chart view. - - The type of the drawing context. - - - - Gets or sets the legend default text paint, when null the library will use the default text paint. - - - - - Gets or sets the legend background paint, when null the library will use the default background paint. - - - - - Gets or sets the legend text size, when null the library will use the default text size. - - - - - Gets or sets the tooltip default text paint, when null the library will use the default text paint. - - - - - Gets or sets the tooltip background paint, when null the library will use the default background paint. - - - - - Gets or sets the tooltip text size, when null the library will use the default text size. - - - - - Gets or sets the chart title. - - - - - Occurs before the chart is measured, this is the first step before the chart updates. - - - - - Occurs when the chart started an update, just when the drawing loop started. - - - - - Occurs when a chart update finished, just when the drawing loop finished. - - - - - Occurs when the pointer goes down over a visual element. - - - - - Gets or sets a value indicating whether the automatic updates are enabled. - - - true if automatic update are enabled; otherwise, false. - - - - - Gets the core canvas. - - - The core canvas. - - - - - Gets or sets the legend. - - - The legend. - - - - - Gets or sets the tooltip. - - - The tooltip. - - - - - Gets or sets the visual elements. - - - - - Called when the pointer goes down on a visual element(s). - - The visual elements. - The pointer location. - - - - Gets all the that contain the given point. - - The given point. - The finding strategy, default is . - An enumerable of . - - - - Gets all the that contain the given point. - - The given point. - An enumerable of . - - - - Defines a seeries that can draw error bars. - - The type of the drawing context - - - - Gets or sets the error paint. - - - The shapes fill. - - - - - Defines a financial series. - - The type of the drawing context. - - - - - Gets or sets the maximum width of the bar. - - - The maximum width of the bar. - - - - - Gets or sets the up stroke, the stroke when the trend goes up. - - - The stroke. - - - - - Gets or sets the up stroke, the stroke when the trend goes down. - - - The stroke. - - - - - Gets or sets the up fill, the fill when the trend goes up. - - - The fill. - - - - - Gets or sets the up fill, the fill when the trend goes down. - - - The fill. - - - - - Defines a heat series plot. - - The type of the drawing context. - - - - - Gets or sets the heat map. - - - The heat map. - - - - - Gets or sets the color stops. - - - The color stops. - - - - - Gets or sets the padding for each point. - - - - - Defines a line series plot. - - The type of the drawing context. - - - - - Gets or sets the size of the geometry. - - - The size of the geometry. - - - - - Gets or sets the line smoothness, where 0 is a straight line, and 1 the most curved line, default is 0.65 - - - The line smoothness. - - - - - Gets or sets a value indicating whether the line should split every null point, - enabling it has a performance impact, default is true. - - - - - Gets or sets the geometry fill. - - - The shapes fill. - - - - - Gets or sets the geometry stroke. - - - The shapes stroke. - - - - - Defines a pie chart. - - The type of the drawing context. - - - - - Gets the core. - - - The core. - - - - - Gets or sets the series. - - - The series. - - - - - Gets or sets the initial rotation in degrees, this angle specifies where the first pie slice will be drawn, then the remaining - slices will stack according to its corresponding position. - - - The initial rotation. - - - - - Gets or sets the maximum angle in degrees, default is 360. - - - The maximum angle. - - - - - Gets or sets the total, it is the maximum value a pie slice can represent, when this property is null, the property - will be calculated automatically based on the series data. Default value is null. - - - - - Gets or sets the minimum valu, normally used in gauges to set the minimum value a pie slice can represent, - default is 0. - - - - - Gets or sets the end value, normally used in gauges to set the maximum value a pie slice can represent, - default is null, and means the pie chart total sum. - - - - - Gets or sets a value indicating whether the pie slices will be drawn clockwise, default is true. - - - - - Defines a pie series. - - The type of the drawing context. - - - - - Gets or sets the push out, it is the distance in pixels between the center of the control and the pie slice. - - - The push out. - - - - - Gets or sets the inner radius of the slice in pixels, in most cases the - is preferred, because it is more flexible on different chart sizes. - - - The inner radius. - - - - - Gets or sets the outer radius offset, it is the distance from the maximum radius available to the end of the slice [in pixels]. - - - The maximum outer radius. - - - - - Gets or sets the maximum outer radius, the value goes from 0 to 1, where 1 is the full available radius and 0 is none. - - - The maximum outer radius. - - - - - Gets or sets the hover push out in pixes, it defines the where the pointer is over the slice. - - - The hover pus hout. - - - - - Gets or sets the corner radius for every pie slice in the series. - - - The corner radius. - - - - - Gets or sets a value indicating whether the direction of the corner radius is inverted. - - - true if the direction is inverted; otherwise, false. - - - - - Gets or sets the maximum width of the radial column, if the width of the radial column slice exceeds this dimension the radial - column width will be capped to the value of this property, default value is double.MaxValue. - - - The maximum width of the radial column. - - - - - Gets or sets the data labels position. - - - The data labels position. - - - - - Gets or sets the radial align, this property determines the alignment of the pie slice only when the width of the column - exceeds . - - - The radial align. - - - - - Gets or sets the relative inner radius, it is the extra inner radius for every stacked slice in pixels. - - - The inner padding. - - - - - Gets or sets the relative outer radius, it is the decrement in the outer radius for every stacked slice in pixels. - - - The inner padding. - - - - - Gets or sets a value indicating whether this instance is a fill series, a fill series is a dummy series that will create a 360 degrees - pie slice, this series is normally used to set a background for pie charts, specially useful o create gauges. - - - true if this instance is fill series; otherwise, false. - - - - - Gets or sets a value indicating whether the values in this series are relative to the - property in the chart. - - - - - Gets the series bounds. - - The chart. - - - - - Defines a plane for a dimension. - - - - - Gets or sets the axis name. - - - - - Gets or sets the size of the name label. - - - The size of the text. - - - - - Gets or sets the padding of the name label. - - - - - Get or sets the actual bounds. - - - - - Gets the data bounds, the min and max values in the axis. - - - The data bounds. - - - - - Gets the data visible bounds, the min and max visible values in the axis that are currently in the UI. - - - The data bounds. - - - - - Gets or sets the labeler, a function that receives a number and return the label content as string. - - - The labeler. - - - - - Gets or sets the minimum step, the step defines the interval between every separator in the axis, - LiveCharts will calculate it automatically based on the chart data and the chart size size, if the calculated step is - less than the then will be used as the axis step, default is 0. - - - The step. - - - - - Gets or sets whether the axis should use the as the actual step of the axis, if true, the library - will not calculate the step of the axis automatically, instead it will use the value in the property. - Be careful when setting this property to true, it might cause performance issues if the step is too small for the current - data in the chart. Default value is false. - - - - - Gets or sets the unit with, it means the width of every point (if the series requires it) in the chart values scale, this value - should normally be 1, unless you are plotting in a custom scale, default is 1. - - - The unit with. - - - - - Gets or sets the minimum value visible in the axis, any point less than this value will be hidden, - set it to null to use a value based on the smaller value in the chart. - - - The minimum value. - - - - - Gets or sets the maximum value visible in the axis, any point greater than this value will be hidden, - set it null to use a value based on the greater value in the chart. - - - The maximum value. - - - - - Gets or sets a value indicating whether this instance is visible. - - - true if this instance is visible; otherwise, false. - - - - - Gets or sets a value indicating whether the axis is inverted based on the Cartesian coordinate system. - - - true if this instance is inverted; otherwise, false. - - - - - Gets or sets the labels rotation in degrees. - - - The labels rotation. - - - - - Gets or sets the size of the labels. - - - The size of the text. - - - - - Gets or sets the labels, if labels are not null, then the axis label will be pulled from the labels collection, - the label is mapped to the chart based on the position of the label and the position of the point, both integers, - if the axis requires a label outside the bounds of the labels collection, then the index will be returned as the label. - Default value is null. - - - The labels. - - - - - Gets or sets the animations speed, if this property is null, the - property will be used. - - - The animations speed. - - - - - Gets or sets the easing function to animate the series, if this property is null, the - property will be used. - - - The easing function. - - - - - Gets or sets a value indicating whether the separator lines are visible. - - - - - Gets or sets the custom separators array, when this property is set (not null) - the axis will use the values in this array instead of calculating the separators automatically. - Defalut is null. - - - - - Defines an Axis in a Cartesian chart. - - The type of the drawing context. - - - - - Gets or sets the name paint. - - - The text paint. - - - - - Gets or sets the text paint. - - - The text paint. - - - - - Gets or sets the separators paint. - - - The separators paint. - - - - - Gets the size of the possible. - - The chart. - - - - - Gets the size of the axis name label. - - the chart. - - - - - Defines a polar axis. - - - - - Gets the orientation. - - - The orientation. - - - - - Gets or sets the ro, a reference used internally to calculate the axis position. - - - The ro. - - - - - Gets the angle in degrees where the labels are drawn, default is 0, notice this property has no effect - when the axis has orientation. - - - - - Gets or sets the labels vertical alignment. - - - - - Gets or sets the labels horizontal alignment. - - - - - Gets or sets the labels padding. - - - - - Gets or sets the labels background. - - - - - Initializes the axis for the specified orientation. - - The orientation. - - - - Occurs when the axis is initialized. - - - - - Defines a polar chart view, this view is able to host one or many series in a polar coordinate system. - - The type of the drawing context. - - - - - Gets the core. - - - The core. - - - - - Gets whether the chart scales to try to fit the plot to the series bounds, it calculates a new center of the radial chart, - default is false. - - - - - Gets or sets the total circumference angle in degrees, default is 360. - - - The inner radius. - - - - - Gets or sets the inner radius, default is 0. - - - The inner radius. - - - - - Gets or sets the initial rotation, default is 0. - - - The inner radius. - - - - - Gets or sets the angle axes. - - - The angle axes. - - - - - Gets or sets the radius axes. - - - The radius axes. - - - - - Gets or sets the series to plot in the user interface. - - - The series. - - - - - Scales a point in pixels to the chart data scale. - - The point. - Index of the angle axis. - Index of the radius axis. - - - - - Scales a point in the chart data scale to pixels. - - The point. - Index of the x axis. - Index of the radius axis. - - - - - Defines a polar line series plot. - - The type of the drawing context. - - - - - Gets or sets a value indicating whether this series path is closed, default is true. - - - The value. - - - - - Gets or sets the size of the geometry. - - - The size of the geometry. - - - - - Gets or sets the line smoothness, where 0 is a straight line, and 1 the most curved line, default is 0.65 - - - The line smoothness. - - - - - Gets or sets a value indicating whether the line should split every null point, - enabling it has a performance impact, default is true. - - - - - Gets or sets the geometry fill. - - - The shapes fill. - - - - - Gets or sets the geometry stroke. - - - The shapes stroke. - - - - - Defines a polar series. - - The type of the drawing context. - - - - - Gets or sets the axis index where the series is scaled in the angle plane, the index must exist - in the collection. - - - The index of the axis. - - - - - Gets or sets the axis index where the series is scaled in the radius plane, the index must exist - in the collection. - - - The index of the axis. - - - - - Gets or sets the data labels position. - - - The data labels position. - - - - - Gets the series bounds. - - The chart. - The angle axis. - The radius axis. - the series bounds - - - - Defines a scatter series. - - The type of the drawing context. - - - - - Gets or sets the size of the geometry. - - - The size of the geometry. - - - - - Gets or sets the minimum size of the geometry. - - - The minimum size of the geometry. - - - - - Defines a stacked bar series. - - The type of the drawing context. - - - - - Gets or sets the rx, the radius used in the x axis to round the corners of each column, it goes from 0 to 1. - - - The rx. - - - - - Gets or sets the ry, the radius used in the y axis to round the corners of each column, it goes from 0 to 1. - - - The ry. - - - - - Gets or sets the padding for each group of bars that share the same secondary coordinate. - - - The bar group padding. - - - - - Gets or sets the maximum width of the bar. - - - The maximum width of the bar. - - - - - Gets or sets the stack group. - - - The stack group. - - - - - Defines a stepline series plot. - - The type of the drawing context. - - - - - Gets or sets a value indicating whether the line should split every null point, - enabling it has a performance impact, default is true. - - - - - Gets or sets the size of the geometry. - - - The size of the geometry. - - - - - Gets or sets the geometry fill. - - - The shapes fill. - - - - - Gets or sets the geometry stroke. - - - The shapes stroke. - - - - - Defines an object with a stroke and fill. - - The type of the drawing context. - - - - Gets or sets the fill. - - - The fill. - - - - - Gets or sets the stroke. - - - The stroke. - - - - - Defines a stack total. - - - - - Gets or sets the posive stack. - - - - - Gets or sets the negative stack. - - - - - Defines the a stacked value. - - - - - Gets or sets the start. - - - The start. - - - - - Gets or sets the end. - - - The end. - - - - - Gets or sets the total stacked. - - - The total. - - - - - Gets the share in the total stack. - - - - - Gets or sets the start. - - - The start. - - - - - Gets or sets the end. - - - The end. - - - - - Gets or sets the total stacked. - - - The total. - - - - - Defines the stacker helper class. - - The type of the drawing context. - - - - Initializes a new instance of the class. - - - - - Gets the maximum length. - - - The maximum length. - - - - - Gets the series stack position. - - The series. - - - - - Stacks the point. - - The point. - The series stack position. - - - - - Gets the stack. - - The point. - The series stack position. - - - - - Defines the stroke and ill drawable class. - - The type of the drawing context. - - - - Initializes a new instance of the class. - - The stroke. - The fill. - is hover state?. - - - - Gets the stroke. - - - The stroke. - - - - - Gets the fill. - - - The fill. - - - - - Gets or sets a value indicating whether this instance is hover state. - - - true if this instance is hover state; otherwise, false. - - - - - Defines the tooltip placement context class. - - - - - Intializes a new instance of the class. - - - - - - Gets the tool tip position. - - - - - Gets or sets the value for the pop-up placement. - - - - - Gets or sets a value indicating whether all the points evaluated are less than the series' pivot. - - - - - Gets or sets the most top. - - - The most top. - - - - - Gets or sets the most bottom. - - - The most bottom. - - - - - Gets or sets the most right. - - - The most right. - - - - - Gets or sets the most left. - - - The most left. - - - - - Gets or sets the most top auto. - - - The most top. - - - - - Gets or sets the most bottom auto. - - - The most bottom. - - - - - Gets or sets the pie x. - - - The pie x. - - - - - Gets or sets the pie y. - - - The pie y. - - - - - Gets or sets the pie most r, the longest known radius. - - - The pie most r. - - - - - Defines bounds for both, X and Y axes. - - - - - Initializes a new instance of the class. - - - Indicates if the intiial bounds should contain some values, - just to prevent the chart to be in an invalid range when the control is initializes without any data. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the primary bounds. - - - - - Gets or sets the secondary bounds. - - - - - Gets or sets the tertiary bounds. - - - - - Gets or sets the primary bounds. - - - - - Gets or sets the secondary bounds. - - - - - Gets or sets the tertiary bounds. - - - - - Defines common functions to build labels in a chart. - - - - - Gets the default labeler. - - - The default. - - - - - Gets the seven representative digits labeler. - - - The seven representative digits. - - - - - Gets the currency labeler. - - - The currency. - - - - - Sets the default labeler. - - The labeler. - - - - Formats to currency. - - The value. - The thousands. - The decimals. - The symbol. - - - - - Builds a named labeler. - - The labels. - - - - - Defines the data to plot as a line. - - The type of the model to plot. - The type of the visual point. - The type of the data label. - The type of the drawing context. - The type of the path geometry. - The type of the error geometry. - - - - Initializes a new instance of the - - class. - - if set to true [is stacked]. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets the paint tasks. - - - - - - Builds an spline from the given points. - - The points. - The stacker. - - - - - - - - - - - LiveCharts global settings. - - - - - A constant that indicates that the tool tip should not add the current label. - - - - - A constant that indicates that the tool tip should ignore the series name. - - - - - Gets a value indicating whether LiveCharts should create a log as it renders the charts. - - - - - Gets a value indicating whether LiveCharts has a backend registered. - - - - - Gets a value indicating whether LiveCharts has a theme registered. - - - - - Gets a value indicating whether LiveCharts has the default mappers registered. - - - - - Gets the current settings. - - - The current settings. - - - - - Gets the hover key. - - - The bar series hover key. - - - - - Gets a constant that indicates that a rotation angle follows the tangent line, this property is only useful in polar series. - - - - - Gets a constant that indicates that a rotation angle follows the cotangent line, this property is only useful in polar series. - - - - - The disable animations - - - - - Configures LiveCharts. - - The configuration. - - $"{nameof(LiveChartsSettings)} must not be null. - - - - Defines a mapper for the given type. - - The type of the model. - The mapper. - - - - - Converts ticks to Date, and prevents overflow exceptions. - - The ticks. - A DateTime object. - - - - Converts ticks to TimeSpan, and prevents overflow exceptions. - - The ticks. - A DateTime object. - - - - Defines the axis limit structure. - - - - - Initializes a new instance of the struct. - - The min value. - The masx value. - The min delta. - The data min value. - The data max value. - - - - Gets or sets the minimum value. - - - - - Gets or sets the maximum value. - - - - - Gets or sets the minimum value. - - - - - Gets or sets the maximum value. - - - - - Gets or sets the min delta. - - - - - Defines the axis orientation. - - - - - The unknown orientation. - - - - - The x orientation. - - - - - The y orientation. - - - - - Defines an axis position. - - - - - Places the axis at the bottom for X axes and at the left for Y axes - - - - - Places the axis at the top for X axes and at the right for Y axes - - - - - Defines an axis tick, the distance between every separator. - - - - - Gets or sets the value. - - - The value. - - - - - Gets or sets the magnitude. - - - The magnitude. - - - - - Represents the maximum and minimum values in a set. - - - - - Creates a new instance of the class. - - - - - Creates a new instance of the class. based on the given . - - - - - - Gets whether the bounds are empty. - - - - - Gets the maximum value in the data set. - - - - - Gets the minimum value in the data set. - - - - - Gets the padding, the distance from the edge to the first point in the series. - - - - - Gets the padding, the distance from the edge to the last point in the series. - - - - - Gets the requested geometry size. - - - - - Gets the delta, the absolute range in the axis. - - - The delta. - - - - - Gets the minimum delta. - - - The minimum delta. - - - - - Compares the current bounds with a given value, - if the given value is greater than the current instance property then the given value is set at property, - if the given value is less than the current instance property then the given value is set at property. - - the value to append - - - - Compares the current bounds with a given value, - if the given value is greater than the current instance property then the given value is set at property, - if the given value is less than the current instance property then the given value is set at property. - - the bounds to append - - - - Defines the clip mode in the draw margin of a chart. - - - - - Disables clipping. - - - - - Enables clipping in the x axis, it means that anything outside the DrawMargin - in the X axis will no be rendered. - - - - - Enables clipping in the y axis, it means that anything outside the DrawMargin - in the Y axis will not be rendered. - - - - - Enables clipping in the x and y axis, it means that anything outside the DrawMargin - will not be rendered. - - - - - A helper class to get the clipping rectangle. - - - - - Calculates the clipping rectangle based on a clipping mode. - - The type of the drawing context. - The mode. - The chart. - - - - - - Defines the data labels position. - - - - - Aligns the label to the end in the axis direction. - - - - - Aligns the label to the start in the axis direction. - - - - - Aligns the label to the middle of the axis. - - - - - Aligns the label to the top. - - - - - Aligns the label to the top. - - - - - Aligns the label to the left. - - - - - Aligns the label to the right. - - - - - Defines the legend orientation. - - - - - The automatic orientation. - - - - - The horizontal orientation. - - - - - The vertical orientation. - - - - - Defines the legend position enumeration. - - - - - The hidden position, hides the legend form the user interface. - - - - - The top position, places the legend at the top of the chart. - - - - - The left position, places the legend at the left of the chart. - - - - - The right position, places the legend at the right of the chart. - - - - - The bottom position, places the legend at the bottom of the chart. - - - - - Defines the margin class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The left. - The top. - The right. - The bottom. - - - - Initializes a new instance of the class. - - The margin for top, left, right and bottom. - - - - Initializes a new instance of the class. - - The margin for left and right. - The margin for top and bottom. - - - - Indicates that the margin should be calculated by the library. - - - - - Gets or sets the left. - - - The left. - - - - - Gets or sets the top. - - - The top. - - - - - Gets or sets the right. - - - The right. - - - - - Gets or sets the bottom. - - - The bottom. - - - - - Evaluates whether the given margin is automatic. - - - - - - - Defines measurement units. - - - - - Indicates that the unit is in pixels. - - - - - Indicates that the unit is in CahrtValues. - - - - - Defines the polar axis orientation. - - - - - The unknown orientation. - - - - - The angle orientation. - - - - - The radius orientation. - - - - - - - - - - Places the label at the center of the chart. - - - - - Aligns the label to the end of the angle of the shape. - - - - - Aligns the label to the start of the angle of the shape. - - - - - Aligns the label to the middle of the angle of the shape and the at the circumference radius. - - - - - Aligns the label to the middle of the angle of the shape and the at the circumference diameter. - - - - - Defines the polar scaler class, this class helps to scale from the data scale to the user interface scale and vise versa. - - - - - Initializes a new instance of the class. - - The draw margin location. - Size of the draw margin. - The radius axis. - The angle axis. - The inner radius. - The initial rotation. - The total angle. - Indicates if the scaler should be built based on the previous known data. - The axis is not ready to be scaled. - - - - Gets the center in the X axis. - - - - - Gets the center in the Y axis. - - - - - Gets the inner radius. - - - - - Gets the max radius in chart values scale. - - - - - Gets the min radius in chart values scale. - - - - - Gets the max angle. - - - - - Gets the min angle. - - - - - Converts to pixels. - - The polar point. - - - - - Converts to pixels. - - The angle in chart values scale. - The radius in chart values. - - - - - Converts to chart values. - - The x coordinate in pixels. - The y coordinate in pixels. - - - - - Converts to pixels. - - The angle in degrees. - The radius. - - - - - Converts to degrees the given angle in chart values. - - The angle in chart values. - - - - - Defines the pop up placement. - - - - - Places PopUp at top. - - - - - Places PopUp at bottom. - - - - - Places PopUp at left. - - - - - Places PopUp at right. - - - - - Defines the radial alignment. - - - - - Aligns the element to the outer radius. - - - - - Aligns the element to the center of the outer and inner radius. - - - - - Aligns the element to the inner radius. - - - - - Defines the scaler class, this class helps to scale from the data scale to the user interface scale and vise versa. - - - - - Initializes a new instance of the class. - - The draw margin location. - Size of the draw margin. - The axis. - Indicates the bounds to use. - The axis is not ready to be scaled. - - - - Gets the maximum value. - - - - - Gets the minimum value. - - - - - Measures an absolute value in pixels. - - The value. - - - - - Converts a given value (in chart values) to pixels. - - The value in chart values. - - - - - Converts a given value (in pixels) to chart values. - - The value in pixels. - - - - - Defines the series bounds class, it contains the data bounds in a series. - - - - - Initializes a new instance of the class. - - The bounds. - if set to true [is previous]. - - - - Gets the bounds. - - - The bounds. - - - - - Gets a value indicating whether this instance is previous. - - - true if this instance is previous; otherwise, false. - - - - - Defines the stack position. - - The type of the drawing context. - - - - Gets or sets the stacker. - - - The stacker. - - - - - Gets or sets the position. - - - The position. - - - - - Stacks the point. - - The point. - - - - - Gets the stack. - - The point. - - - - - Defines the tool tip finding strategy. - - - - - The automatic mode, it will be calculated automatically based on the series and the chart. - - - - - Looks for all the points that contain the pointer positon. - - - - - Looks for all the points that contain the pointer positon ignoring the Y axis. - - - - - Looks for all the points that contain the pointer positon ignoring the X axis. - - - - - Looks for the closest point (to the pointer) per series that contains the pointer positon. - - - - - Looks for the closest point (to the pointer) per series that contains the pointer positon ignoring the Y axis. - - - - - Looks for the closest point (to the pointer) per series that contains the pointer positon ignoring the X axis. - - - - - Defines the tool tip meta data class. - - - - - Gets or sets the tool tip placement. - - - - - Defines the tool tip position. - - - - - The hidden position, tool tips will be hidden. - - - - - Places the tool tip based on the space available. - - - - - The top position, places the tool tip at the top of the hovered point, - if there is not enough space, the library will place it in another position. - - - - - The bottom position, places the tool tip at the bottom of the hovered point, - if there is not enough space, the library will place it in another position. - - - - - The left position, places the tool tip at the left of the hovered point. - if there is not enough space, the library will place it in another position. - - - - - The right position, places the tool tip at the right of the hovered point. - if there is not enough space, the library will place it in another position. - - - - - The center position, places the tool tip at the center of the hovered point. - - - - - Defines the vector manager class. - - The type of the segment. - The type of the drawing context. - - - - Initializes a new instance of the class. - - The area geometry - - - - Gets the area geometry. - - - - - Adds a segment to the area geometry. - - The segment. - Indicates whether the segment follows the previous segment visual state. - - - - Clears the current vector segments. - - - - - Ends the vector. - - - - - Logs the path segments ids. - - - - - Defines the zooming and panning mode. - - - - - Disables zooming and panning. - - - - - Enables panning on the X axis. - - - - - Enables panning on the Y axis. - - - - - Enables zooming on the X axis. - - - - - Enables zooming on the Y axis. - - - - - When this flag is present the panning will be triggered using the right click on desktop devices and the touch-and-hold gesture on touch devices. - The "Zoom by section" feature will be triggered to the left click on desktop devices and the touch-and-hold gesture on touch devices. - - - - - Enables zooming and panning on the X axis. - - - - - Enables zooming and panning on the Y axis. - - - - - Enables zooming and panning on both axes. - - - - - Defines the zooming direction. - - - - - The zoom in - - - - - The zoom out - - - - - Indicates that the direction is defined by the distance variable. - - - - - Defines the animatable bounds class. - - - - - Intializes a new isntance of the class. - - - - - Gets or sets the max limit. - - - - - Gets or sets the min limit. - - - - - Gets or sets the max data limit. - - - - - Gets or sets the min data limit. - - - - - Gets or sets the max visible limit. - - - - - Gets or sets the min visible limit. - - - - - Gets a valuea indicating whewhter the bounds have a previous state. - - - - - Defines the animatable container class. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the location. - - - - - Gets or sets the size. - - - - - Gets a valuea indicating whewhter the container have a previous state. - - - - - Defines the color motion property class. - - - - - Initializes a new instance of the class. - - Name of the property. - - - - Initializes a new instance of the class. - - Name of the property. - The value. - - - - - - - Defines the double motion property class. - - - - - Initializes a new instance of the class. - - Name of the property. - - - - Initializes a new instance of the class. - - Name of the property. - The value. - - - - - - - Defines the float motion property class. - - - - - Initializes a new instance of the class. - - Name of the property. - - - - Initializes a new instance of the class. - - Name of the property. - The value. - - - - - - - Defines a motions property. - - - - - Gets or sets a value indicating whether this instance is completed. - - - true if this instance is completed; otherwise, false. - - - - - Gets the name of the property. - - - The name of the property. - - - - - Gets or sets the animation. - - - The animation. - - - - - Copies into this instance the source property. - - The source. - - - - Defines a canvas that is able to animate the shapes inside it. - - The type of the drawing context. - - - - Initializes a new instance of the class. - - - - - Occurs when the visual is invalidated. - - - - - Occurs when all the visuals in the canvas are valid. - - - - - Returns true if the visual is valid. - - - true if this instance is valid; otherwise, false. - - - - - Gets the synchronize object. - - - The synchronize. - - - - - Gets the animatables collection. - - - - - Draws the frame. - - The context. - - - - - Gets the drawables count. - - - The drawables count. - - - - - Invalidates this instance. - - - - - - Adds a drawable task. - - The task. - - - - - Sets the paint tasks. - - The tasks. - - - - - Removes the paint task. - - The task. - - - - - Clears the canvas and tasks. - - - - - Counts the geometries. - - - - - - Releases the resources. - - - - - The object tracks where a property of a is in a time line. - - - - - - From value - - - - - To value - - - - - Initializes a new instance of the class. - - Name of the property. - - - - Gets the value where the transition began. - - - - - Gets the value where the transition finished or will finish. - - - - - - - - - - - - - - - - - Moves to the specified value. - - The value to move to. - The instance that is moving. - - - - Gets the current movement in the . - - - - - - - Gets the current value in the time line. - - The animatable object. - The current value. - - - - Called to get the movement at a specific progress. - - The progress. - - - - - Defines the class. - - - - - Initializes a new instance of the class. - - Name of the property. - - - - Initializes a new instance of the class. - - Name of the property. - The value. - - - - - - - Defines the motion property class. - - - - - Initializes a new instance of the class. - - Name of the property. - - - - Initializes a new instance of the class. - - Name of the property. - The value. - - - - - - - Defines the motion property class. - - - - - Initializes a new instance of the class. - - Name of the property. - - - - Initializes a new instance of the class. - - Name of the property. - The value. - - - - - - - Defines a pie chart. - - The type of the drawing context. - - - - - Initializes a new instance of the class. - - The view. - The default platform configuration. - The canvas. - Forces the legends to redraw with every measure request. - - - - - - - - - - Gets the view. - - - The view. - - - - - Gets the value bounds. - - - The value bounds. - - - - - Gets the index bounds. - - - The index bounds. - - - - - Gets the pushout bounds. - - - The pushout bounds. - - - - - Finds the points near to the specified point. - - The pointer position. - - - - - Measures this chart. - - - - - - - - - Defines a pie series. - - The type of the model. - The type of the visual. - The type of the label. - The type of the miniature geometry, used in tool tips and legends. - The type of the drawing context. - - - - Initializes a new instance of the class. - - - - - Gets or sets the stroke. - - - The stroke. - - - - - Gets or sets the fill. - - - The fill. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets or sets the tool tip label formatter for the Y axis, this function will build the label when a point in this series - is shown inside a tool tip. - - - The tool tip label formatter. - - - - - - - - - - - - - - - - - - - - GEts the stack group - - - - - - - - - - - - - - - - Sets the default point transitions. - - The chart point. - Unable to initialize the point instance. - - - - Softs the delete point. - - The point. - The primary scale. - The secondary scale. - - - - Gets the label polar position. - - The center x. - The center y. - The iner radius. - The outer radius. - The start angle. - The sweep angle. - Size of the label. - The position. - - - - - Softly deletes the all points from the chart. - - - - - - - Defines an Axis in a Cartesian chart. - - The type of the drawing context. - The type of the text geometry. - The type of the circle geometry. - /// The type of the line geometry. - - - - The active separators - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Deletes the specified chart. - - The chart. - - - - - - - - Softly deletes the separator. - - The chart. - The separator. - The scale. - - - - - Called when [paint changed]. - - Name of the property. - - - - - Gets the paint tasks. - - - - - - Defines a Polar chart. - - The type of the drawing context. - - - - - Initializes a new instance of the class. - - The view. - The default platform configuration. - The canvas. - Forces the legends to redraw with every measure request. - - - - Gets the angle axes. - - - The x axes. - - - - - Gets the radius axes. - - - The y axes. - - - - - - - - - - - Gets whether the series fit to bounds or not. - - - - - Gets the total circumference angle. - - - The total angle. - - - - - Gets the Inner radius. - - - The inner radius. - - - - - Gets the Initial rotation. - - /// - The inner radius. - - - - - Gets the view. - - - The view. - - - - - Finds the points near to the specified point. - - The pointer position. - - - - - Measures this chart. - - - - - - Scales the specified point to the UI. - - The point, where X = angle, Y = radius. - Index of the angle axis. - Index of the radius axis. - - - - - - - - Defines the data to plot as a polar line. - - The type of the model to plot. - The type of the visual point. - The type of the data label. - The type of the drawing context. - The type of the path geometry. - - - - Initializes a new instance of the class. - - if set to true [is stacked]. - - - - Gets or sets the stroke. - - - The stroke. - - - - - Gets or sets the fill. - - - The fill. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets or sets the tool tip label formatter for the X axis, this function will build the label when a point in this series - is shown inside a tool tip. - - - The tool tip label formatter. - - - - - Gets or sets the tool tip label formatter for the Y axis, this function will build the label when a point in this series - is shown inside a tool tip. - - - The tool tip label formatter. - - - - - - - - - - - - - - - - - - - - Builds an spline from the given points. - - - - - - - - - - - - Softs the delete point. - - The point. - The scaler. - - - - - - - Gets the paint tasks. - - - - - - Gets the label polar position. - - The center x. - The center y. - The radius. - The start angle. - Size of the label. - The geometry size. - The position. - - - - - - - - - - - Defines the row series - - The type of the model. - The type of the visual. - The type of the label. - The type of the drawing context. - - The type of the error geometry. - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - Defines a scatter series. - - The type of the model. - The type of the visual. - The type of the label. - The type of the drawing context. - The type of the error geometry. - - - - - - Initializes a new instance of the class. - - - - - Gets or sets the minimum size of the geometry. - - - The minimum size of the geometry. - - - - - Gets or sets the size of the geometry. - - - The size of the geometry. - - - - - Gets a value indicating whether the points in this series use weight. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Defines a visual section in a chart. - - The type of the drawing context. - - - - - Gets or sets the stroke. - - - The stroke. - - - - - Gets or sets the fill. - - - The fill. - - - - - Gets or sets the label paint. - - - The fill. - - - - - Gets or sets whether the section is visible or not. - - - - - Gets or sets the xi, the value where the section starts at the X axis, - set the property to null to indicate that the section must start at the beginning of the X axis, default is null. - - - The xi. - - - - - Gets or sets the xj, the value where the section ends and the X axis. - set the property to null to indicate that the section must go to the end of the X axis, default is null. - - - The xj. - - - - - Gets or sets the yi, the value where the section starts and the Y axis. - set the property to null to indicate that the section must start at the beginning of the Y axis, default is null. - - - The yi. - - - - - Gets or sets the yj, the value where the section ends and the Y axis. - set the property to null to indicate that the section must go to the end of the Y axis, default is null. - - - The yj. - - - - - Gets or sets the axis index where the section is scaled in the X plane, the index must exist - in the collection. - - - The index of the axis. - - - - - Gets or sets the axis index where the section is scaled in the Y plane, the index must exist - in the collection. - - - The index of the axis. - - - - - Gets or sets the index of the z axis. - - - The index of the z. - - - - - Gets the paint tasks. - - - - - - Called when the fill changes. - - - - - - Defines a visual section in a chart. - - The type of the sized geometry. - The type of the label geometry. - The type of the drawing context. - - - - - The fill sized geometry - - - - - The stroke sized geometry - - - - - The label geometry. - - - - - Gets or sets the label, a string to be displayed within the section. - - - - - Gets or sets the label size. - - - - - Measures the specified chart. - - The chart. - - - - Defines a series in a Cartesian chart. - - The type of the model. - The type of the visual. - The type of the label. - The type of the drawing context. - - - - - - - - The subscribed to - - - - - The implements icp - - - - - The pivot - - - - - The max series stroke. - - - - - The ever fetched points. - - - - - Indicates whether the custom measure handler was requested already. - - - - - The custom measure handler. - - - - - Indicates whether the geometry svg changed. - - - - - Will be deleted on future versions - - - - - Initializes a new instance of the class. - - The properties. - - - - - - - - - - Gets or sets the data set to draw in the chart. - - - - - - - - Gets or sets the mapping that defines how a type is mapped to a instance, - then the will be drawn as a point in the chart. - - - - - - - - Occurs when an instance of is measured. - - - - - Occurs when an instance of is created. - - - - - Occurs when the pointer goes down over a chart point(s). - - - - - Occurs when the pointer is over a chart point. - - - - - Occurs when the pointer left a chart point. - - - - - Occurs when the pointer is over a chart point. - - - - - Occurs when the pointer left a chart point. - - - - - Occurs when the pointer goes down over a chart point, if there are multiple points, the closest one will be selected. - - - - - - - - Gets or sets the tool tip label formatter, this function will build the label when a point in this series - is shown inside a tool tip. - - - The tool tip label formatter. - - - - - Gets or sets the data label formatter, this function will build the label when a point in this series - is shown as data label. - - - The data label formatter. - - - - - - - - - - - - - - - - - - - - - - - Gets the data factory. - - - - - Called when a point is measured. - - - - - Gets or sets the size of the legend shape. - - - The size of the legend shape. - - - - - Gets or sets the size of the legend shape. - - - The size of the legend shape. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Converts a chart to a strong-typed version of it. - - - - - - - - - - - - - Builds a paint schedule. - - - - - - - - Called when a point was measured. - - The chart point. - - - - Called when a point is created. - - The chart point. - - - - Sets the default point transitions. - - The chart point. - - - - - Called when the visibility changes. - - - - - Called when the pointer enters a point. - - The chart point. - - - - Called when the pointer leaves a point. - - The chart point. - - - - - - - Called when the miniature changes. - - - - - Defines the stacked area series class. - - The type of the model to plot. - The type of the visual point. - The type of the data label. - The type of the drawing context. - The type of the path geometry. - The type of the error geometry. - - - - - Initializes a new instance of the class. - - - - - Defines the stacked column series class. - - The type of the model. - The type of the visual. - The type of the label. - The type of the drawing context. - The type of the error geometry. - - - - - Initializes a new instance of the class. - - - - - - - - Gets the stack group. - - - - - - - Defines a stacked row series. - - The type of the model. - The type of the visual. - The type of the label. - The type of the error geometry. - The type of the drawing context. - - - - Initializes a new instance of the class. - - - - - - - - Gets the stack group. - - - - - - - Defines the stacked area series class. - - The type of the model to plot. - The type of the visual point. - The type of the data label. - The type of the drawing context. - The type of the path geometry. - - - - - Initializes a new instance of the class. - - - - - Defines the data to plot as a line. - - The type of the model to plot. - The type of the visual point. - The type of the data label. - The type of the drawing context. - The type of the path geometry. - - - - Initializes a new instance of the class. - - if set to true [is stacked]. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets the paint tasks. - - - - - - Defines a data series with stroke and fill properties. - - The type of the model. - The type of the visual. - The type of the label. - The type of the drawing context. - - - - Initializes a new instance of the class. - - The properties. - - - - Gets or sets the stroke. - - - The stroke. - - - - - Gets or sets the fill. - - - The fill. - - - - - Gets the paint tasks. - - - - - - - Defines a set of predefined colors to use. - - - - - Gets the fluent design colors. - - - The fluent design. - - - - - Gets the material design500 colors. - - - The material design500. - - - - - Gets the material design200 colors. - - - The material design200. - - - - - Gets the material design800 colors. - - - The material design800. - - - - - Defines the LiveCharts styler extensions. - - - - - Defines a style builder for objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for objects when used as gauges. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for objects when used as gauges fills. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for stacked objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for stacked objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for tacked objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for vertical objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for horizontal objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for stacked objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for stacked vertical objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for stacked horizontal objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder for objects. - - The type of the drawing context. - The styler. - The predicate. - - - - - Defines a style builder. - - The type of the drawing context. - - - - Gets or sets the theme colors. - - - - - Gets or sets the axis builder. - - - The axis builder. - - - - - Gets or sets the draw margin frame builder. - - - The draw margin frame builder. - - - - - Gets or sets the series builder. - - - The pie series builder. - - - - - Gets or sets the pie series builder. - - - The pie series builder. - - - - - Gets or sets the gauge series builder. - - - The pie series builder. - - - - - Gets or sets the gauge fill series builder. - - - The pie series builder. - - - - - Gets or sets the Cartesian series builder. - - - The pie series builder. - - - - - Gets or sets the stepline series builder. - - - The pie series builder. - - - - - Gets or sets the stacked stepline series builder. - - - The pie series builder. - - - - - Gets or sets the line series builder. - - - The pie series builder. - - - - - Gets or sets the line series builder. - - - The polar series builder. - - - - - Gets or sets the line series builder. - - - The polar series builder. - - - - - Gets or sets the line series builder. - - - The polar series builder. - - - - - Gets or sets the line series builder. - - - The pie series builder. - - - - - Gets or sets the financial series builder. - - - The pie series builder. - - - - - Gets or sets the stacked line series builder. - - - The pie series builder. - - - - - Gets or sets the bar series builder. - - - The pie series builder. - - - - - Gets or sets the column series builder. - - - The pie series builder. - - - - - Gets or sets the row series builder. - - - The pie series builder. - - - - - Gets or sets the stacked bar series builder. - - - The pie series builder. - - - - - Gets or sets the stacked column series builder. - - - The pie series builder. - - - - - Gets or sets the stacked row series builder. - - - The pie series builder. - - - - - Gets or sets the scatter series builder. - - - The pie series builder. - - - - - Gets or sets the error series builder. - - - The pie series builder. - - - - - Applies the theme to an axis. - - The axis. - - - - Applies the theme to a series. - - The series. - - - - Applies the theme to a draw margin. - - - - - - Gets the color of a series according to the theme. - - - - - - Defines a visual element in a chart that draws a sized geometry in the user interface. - - The type of the arc geometry. - The type of the line geometry. - The type of the label. - The type of the drawing context. - - - - Gets or sets the labels paint. - - - - - Gets or sets the fill paint. - - - - - Gets or sets the outer offset, the distance between the edge of the chart and the arc and ticks. - - - - - Gets or sets the labels outer offset, the distance between the edge of the chart and the labels. - - - - - Gets or sets the ticks lenght. - - - - - Gets or sets the labels size. - - - - - - - - - - - - - - Defines a visual element that has stroke and fill, it can also be scaled in - or . - - The type of the drawing context, - - - - Gets or sets the height of the rectangle [in Pixels or ChartValues, see ]. - - - - - Gets or sets the width of the rectangle [in Pixels or ChartValues, see ]. - - - - - Gets or sets the unit of the and properties. - - - - - Gets or sets the fill paint. - - - - - Gets or sets the stroke paint. - - - - - - - - Called when [paint changed]. - - Name of the property. - - - - - Defines a visual element in a chart that draws a sized geometry in the user interface. - - The type of the geometry. - The type of the label. - The type of the drawing context. - - - - Gets or sets the label, a string to be displayed within the section. - - - - - Gets or sets the label size. - - - - - Gets or sets the label paint. - - - The fill. - - - - - - - - - - - - - - Defines a label visual element. - - The type of the label. - The type of the drawing context. - - - - Gets or sets the fill paint. - - - - - Gets or sets the label text. - - - - - Gets or sets the font size. - - - - - Gets or sets the vertical alignment. - - - - - Gets or sets the horizontal alignment. - - - - - Gets or sets the background color. - - - - - Gets or sets the padding. - - - - - Gets or sets the line height [times the text measured height]. - - - - - Gets or sets the maximum width. - - - - - - - - - - - - - - Defines a visual element in a chart that draws a needle. - - The type of the geometry. - The type of the label. - The type of the drawing context. - - - - Gets or sets the value. - - - - - Gets or sets the fill paint. - - - - - - - - - - - - - - Defines the relative panel class. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the size. - - - - - Gets the children collection. - - - - - Gets or sets the background paint. - - - - - Gets the background geometry. - - - - - - - - - - - - - - - - - Defines the stack panel class. - - The type of the background geometry. - The type of the drawing context. - - - - Initializes a new instance of the class. - - - - - Gets the children collection. - - - - - Gets or sets the panel orientation. - - - - - Gets or sets the vertical alignment. - - - - - Gets or sets the horizontal alignment. - - - - - Gets or sets the padding. - - - - - Gets or sets the background paint. - - - - - Gets the background geometry. - - - - - Gets or sets the maximum width. When the maximum with is reached, a new row is created. - - - - - Gets or sets the maximum height. When the maximum height is reached, a new column is created. - - - - - - - - - - - - - - - - - Defines the table panel class. - - The type of the background geometry. - The type of the drawing context. - - - - Initializes a new instance of the class. - - - - - Gets or sets the padding. - - - - - Gets or sets the horizontal alignment. - - - - - Gets or sets the horizontal alignment. - - - - - Gets or sets the background paint. - - - - - Gets the background geometry. - - - - - - - - - - - Adds a child to the layout. - - The row index. - The column index. - The visual to add. - The cell horizontal alignment, if null the alignment will be defined by the layout. - The cell vertical alignment, if null the alignment will be defined by the layout. - - - - Removes a child from the layout. - - The row. - The column. - - - - Enumerates the children in the layout. - - - - - - - - - - - Defines a cell in the . - - - - - Initializes a new instance of the class. - - The row index. - The column index. - The visual to add. - The cell vertical alignment, if null the alignment will be defined by the layout. - The cell horizontal alignment, if null the alignment will be defined by the layout. - - - - Gets the row. - - - - - Gets the column. - - - - - Gets or sets the vertical alignment. - - - - - Gets or sets the horizontal alignment. - - - - - Gets the visual element. - - - - - Defines a visual element that is useful to create series miniatures in the tool tips and legends. - - The type of the drawing context. - - - - Initializes a new instance of the class. - - - - - - Gets or sets the geometry. - - - - - Occurs when the geometry is initialized. - - - - - - - - - - - - - - Defines the base visual element class, inheriting from this class makes it easy to implement a visual element. - - - - - Gets the primary scaler. - - - - - Gets the secondary scaler. - - - - - Gets or sets the X coordinate [in Pixels or ChartValues, see ]. - - - - - Gets or sets the Y coordinate [in Pixels or ChartValues, see ]. - - - - - Gets or sets the rotation. - - - - - Gets or sets the translate transform. - - - - - Gets or sets the unit of the and properties. - - - - - Gets or sets the axis index where the series is scaled in the X plane, the index must exist - in the collection. - - - The index of the axis. - - - - - Gets or sets the axis index where the series is scaled in the Y plane, the index must exist - in the collection. - - - The index of the axis. - - - - - Gets or sets the clipping mode, clipping restricts the visual element for being drawn outside of the chart area (DrawMargin), - default is , and means that anything outside the chart bounds will be ignored. - - - - - Called when the pointer goes down on the visual. - - - - - - - - Measures the element and returns the size. - - The chart. - - - - Called when [paint changed]. - - Name of the property. - - - - - Called when the visual is drawn. - - The chart. - - - - Sets the parent to all the geometries in the visual. - - - - - Gets the acdtual coordinate of the visual. - - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Core.dll deleted file mode 100644 index f785703..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Core.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Core.xml deleted file mode 100644 index d52a9e7..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Core.xml +++ /dev/null @@ -1,247 +0,0 @@ - - - - MahApps.Metro.IconPacks.Core - - - - - Specifies meta data for a class. - - - - - ValueConverter which converts the PackIconFlipOrientation enumeration value to ScaleX value of a ScaleTransformation. - - - - - ValueConverter which converts the PackIconFlipOrientation enumeration value to ScaleY value of a ScaleTransformation. - - - - - MarkupConverter is a MarkupExtension which can be used for IValueConverter. - - - - - - - - Converts a value. - - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - A converted value. If the method returns null, the valid null value is used. - - - - Converts a value. - - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - A converted value. If the method returns null, the valid null value is used. - - - - - - - - - - Gets or sets the brush to draw the icon. - - - - - Gets or sets the flip orientation for the icon. - - - - - Gets or sets the rotation (angle) for the icon. - - - - - Gets the path data for the given kind. - - - - - Gets the ScaleTransform for the given kind. - - The icon kind to draw. - - - - Gets the for the . - - The icon kind to draw. - - - - Gets the object that will be used for the . - - - - - Gets the ImageSource for the given kind. - - - - - - - - - - - Class PackIconControlBase which is the base class for any PackIcon control. - - - - - Gets the path data for the current icon kind. - - - - - Identifies the Flip dependency property. - - - - - Gets or sets the flip orientation. - - - - - Identifies the RotationAngle dependency property. - - - - - Gets or sets the rotation (angle). - - The rotation. - - - - Identifies the Spin dependency property. - - - - - Gets or sets a value indicating whether the inner icon is spinning. - - true if spin; otherwise, false. - - - - Identifies the SpinDuration dependency property. - - - - - Gets or sets the duration of the spinning animation (in seconds). This will also restart the spin animation. - - The duration of the spin in seconds. - - - - Identifies the SpinEasingFunction dependency property. - - - - - Gets or sets the EasingFunction of the spinning animation. This will also restart the spin animation. - - The spin easing function. - - - - Identifies the SpinAutoReverse dependency property. - - - - - Gets or sets the AutoReverse of the spinning animation. This will also restart the spin animation. - - true if [spin automatic reverse]; otherwise, false. - - - - Enum PackIconFlipOrientation for the Flip property of any PackIcon control. - - - - - No flip - - - - - Flip the icon horizontal - - - - - Flip the icon vertical - - - - - Flip the icon vertical and horizontal - - - - - Gets or sets the brush to draw the icon. - - - - - Gets or sets the flip orientation for the icon. - - - - - Gets or sets the rotation (angle) for the icon. - - - - - Gets the path data for the given kind. - - - - - Gets the ScaleTransform for the given kind. - - The icon kind to draw. - - - - Gets the for the . - - The icon kind to draw. - - - - Gets the object that will be used for the . - - - - - Gets the ImageSource for the given kind. - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.FontAwesome.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.FontAwesome.dll deleted file mode 100644 index 771fe0c..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.FontAwesome.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.FontAwesome.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.FontAwesome.xml deleted file mode 100644 index 12c01f7..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.FontAwesome.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - MahApps.Metro.IconPacks.FontAwesome - - - - - All icons sourced from Font Awesome Free https://fontawesome.com/ - License https://fontawesome.com/license/free - GitHub https://fontawesome.com/ - - - - - Gets or sets the icon to display. - - - - - - - - - - - - - - - - - - - - - - ****************************************** - This code is auto generated. Do not amend. - ****************************************** - - List of available icons for use with . - - - All icons sourced from Font Awesome Free https://fontawesome.com/ - License https://fontawesome.com/license/free - GitHub https://fontawesome.com/ - - - - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Material.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Material.dll deleted file mode 100644 index f9b2765..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Material.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Material.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Material.xml deleted file mode 100644 index ab39569..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Material.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - MahApps.Metro.IconPacks.Material - - - - - All icons sourced from Material Design Icons Font https://pictogrammers.com/library/mdi/ - In accordance of https://github.com/Templarian/MaterialDesign?tab=License-1-ov-file#readme. - - - - - Gets or sets the icon to display. - - - - - - - - - - - - - - - - - - - - - - ****************************************** - This code is auto generated. Do not amend. - ****************************************** - - List of available icons for use with . - - - All icons sourced from Material Design Icons Font https://pictogrammers.com/library/mdi/ - In accordance of https://github.com/Templarian/MaterialDesign?tab=License-1-ov-file#readme. - - - - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.RemixIcon.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.RemixIcon.dll deleted file mode 100644 index e31e9e6..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.RemixIcon.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.RemixIcon.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.RemixIcon.xml deleted file mode 100644 index 32dae93..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.RemixIcon.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - MahApps.Metro.IconPacks.RemixIcon - - - - - RemixIcon released under the [Apache License Version 2.0](https://github.com/Remix-Design/RemixIcon?tab=Apache-2.0-1-ov-file#readme) - Contributions, corrections and requests can be made on GitHub https://github.com/Remix-Design/RemixIcon. - - - - - Gets or sets the icon to display. - - - - - - - - - - - - - - - - - - - - - - ****************************************** - This code is auto generated. Do not amend. - ****************************************** - - List of available icons for use with . - - - RemixIcon released under the [Apache License Version 2.0](https://github.com/Remix-Design/RemixIcon?tab=Apache-2.0-1-ov-file#readme) - Contributions, corrections and requests can be made on GitHub https://github.com/Remix-Design/RemixIcon. - - - - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Unicons.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Unicons.dll deleted file mode 100644 index 820214c..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Unicons.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Unicons.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Unicons.xml deleted file mode 100644 index 5cec779..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.IconPacks.Unicons.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - MahApps.Metro.IconPacks.Unicons - - - - - Unicons are licensed under [Apache 2.0](https://github.com/Iconscout/unicons/blob/master/LICENSE). - Contributions, corrections and requests can be made on GitHub https://github.com/Iconscout/unicons. - - - - - Gets or sets the icon to display. - - - - ****************************************** - This code is auto generated. Do not amend. - ****************************************** - - - - - - ****************************************** - This code is auto generated. Do not amend. - ****************************************** - - List of available icons for use with . - - - Unicons are licensed under [Apache 2.0](https://github.com/Iconscout/unicons/blob/master/LICENSE). - Contributions, corrections and requests can be made on GitHub https://github.com/Iconscout/unicons. - - - - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.dll deleted file mode 100644 index 92884be..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.xml deleted file mode 100644 index f092ff8..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/MahApps.Metro.xml +++ /dev/null @@ -1,9677 +0,0 @@ - - - - MahApps.Metro - - - - - Switch to force accessibility to only use features compatible with .NET 472 - When true, all accessibility features are compatible with .NET 472 - When false, accessibility features added in .NET versions greater than 472 can be enabled. - - - - - This CommandTriggerAction can be used to bind any event on any FrameworkElement to an . - This trigger can only be attached to a FrameworkElement or a class deriving from FrameworkElement. - - This class is inspired from Laurent Bugnion and his EventToCommand. - http://www.mvvmlight.net - See license.txt in this solution or http://www.galasoft.ch/license_MIT.txt - - - - - Identifies the dependency property - - - - - Gets or sets the command that this trigger is bound to. - - - - - Identifies the dependency property - - - - - Gets or sets an object that will be passed to the attached to this trigger. - - - - - The MetroHeaderAutomationPeer class exposes the type to UI Automation. - - - - - The MetroThumbContentControlAutomationPeer class exposes the type to UI Automation. - - - - Initializes a new instance of the class. - The associated with this . - - - - - - - - - - - - - - - - - - - - - - - - - Gets or sets the bindable Password property on the PasswordBox control. This is a dependency property. - - - - - Handles changes to the 'Password' attached property. - - - - - Handle the 'PasswordChanged'-event on the PasswordBox - - - - - Called after the behavior is attached to an AssociatedObject. - - - Override this to hook up functionality to the AssociatedObject. - - - - - Called when the behavior is being detached from its AssociatedObject, but before it has actually occurred. - - - Override this to unhook functionality from the AssociatedObject. - - - - - The DependencyProperty for the ' OnDataContextChanged property. - - With the OnDataContextChanged property the Reload behavior of the MetroContentControl can be switched on or off. - If the property is set to true, the transition of the is triggered again when the DataContext is changed. - - - - - Helper for getting from . - - If the property is set to true, the transition of the is triggered again when the DataContext is changed. - - to read from. - OnDataContextChanged property value. - - - - Helper for setting on . - - If the property is set to true, the transition of the is triggered again when the DataContext is changed. - - to set on. - OnDataContextChanged property value. - - - - The DependencyProperty for the ' and ' OnSelectedTabChanged property. - - With the OnSelectedTabChanged property the Reload behavior of the control can be switched on or off. - If the property is set to true, the transition is triggered again when the SelectionChanged event of a TabControl was raised. - - - - - Helper for getting from . - - If the property is set to true, the transition is triggered again when the SelectionChanged event of a TabControl was raised. - - to read from. - OnSelectedTabChanged property value. - - - - Helper for setting on . - - If the property is set to true, the transition is triggered again when the SelectionChanged event of a TabControl was raised. - - to set on. - OnSelectedTabChanged property value. - - - - - Sets the first TabItem with Visibility="" as - the SelectedItem of the TabControl. - - - If there is no visible TabItem, null is set as the SelectedItem - - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - - - - - - Identifies the dependency property. - - - - Represents a border whose contents are clipped within the bounds - of the border. The border may have rounded corners. - - - - - BorderThickness Dependency Property - - - - - Gets or sets the BorderThickness property. This dependency property - indicates the BorderThickness. - - - - - Checks if the given Thickness is valid or not - - Thickness - - - - - Padding Dependency Property - - - - - Gets or sets the Padding property. This dependency property - indicates the Padding. - - - - - CornerRadius Dependency Property - - - - - Gets or sets the CornerRadius property. This dependency property - indicates the CornerRadius of the border. - - - - - Checks if the given CornerRadius is valid or not - - CornerRadius - - - - - BorderBrush Dependency Property - - - - - Gets or sets the BorderBrush property. This dependency property - indicates the BorderBrush with which the Border is drawn. - - - - - Background Dependency Property - - - - - Gets or sets the Background property. This dependency property - indicates the Background with which the Background is drawn. - - - - - OptimizeClipRendering Dependency Property - - - - - Gets or sets the OptimizeClipRendering property. This dependency property - indicates whether the rendering of the clip should be optimized. When set to true, - In order to optimize the rendering of the clipped Child, - the background is rendered with the same brush as the border. Any other brush set for - the background will be ignored. The Child will be rendered on top of it. - This is done to prevent any gaps between the border the the clipped Child (this is - evidently visible if both the Border and the Child are of same color). - This works best when the Child does not have any level of transparency and is opaque. - - - - - Updates DesiredSize of the ClipBorder. Called by parent UIElement. This is the first pass of layout. - - - Border determines its desired size it needs from the specified border the child: its sizing - properties, margin, and requested size. - - Constraint size is an "upper limit" that the return value should not exceed. - The Decorator's desired size. - - - - ClipBorder computes the position of its single child and applies its child's alignments to the child. - - - The size reserved for this element by the parent - The actual ink area of the element, typically the same as finalSize - - - - Here the ClipBorder's Child, Border and Background are rendered. - - Drawing Context - - - - Generates a StreamGeometry. - - An already opened StreamGeometryContext. - Rectangle for geomentry conversion. - The core points of the border which needs to be used to create - the geometry - Result geometry. - - - - Encapsulates the details of each of the core points of the border which is calculated - based on the given CornerRadius, BorderThickness, Padding and a flag to indicate whether - the inner or outer border is to be calculated. - - CornerRadius - BorderThickness - Padding - Flag to indicate whether outer or inner border needs - to be calculated - - - - A few very useful extension methods - - - - - Returns whether or not two doubles are "close". - - The first double to compare. - The second double to compare. - - bool - the result of the AreClose comparision. - - - - - Returns whether or not the first double is less than the second double. - - The first double to compare. - The second double to compare. - - bool - the result of the LessThan comparision. - - - - - Returns whether or not the first double is greater than the second double. - - The first double to compare. - The second double to compare. - - bool - the result of the GreaterThan comparision. - - - - - Returns whether or not the double is "close" to 1. Same as AreClose(double, 1), - but this is faster. - - The double to compare to 1. - - bool - the result of the AreClose comparision. - - - - - IsZero - Returns whether or not the double is "close" to 0. Same as AreClose(double, 0), - but this is faster. - - The double to compare to 0. - - bool - the result of the AreClose comparision. - - - - - Compares two points for fuzzy equality. This function - helps compensate for the fact that double values can - acquire error when operated upon - - The first point to compare - The second point to compare - Whether or not the two points are equal - - - - Compares two Size instances for fuzzy equality. This function - helps compensate for the fact that double values can - acquire error when operated upon - - The first size to compare - The second size to compare - Whether or not the two Size instances are equal - - - - Compares two Vector instances for fuzzy equality. This function - helps compensate for the fact that double values can - acquire error when operated upon - - The first Vector to compare - The second Vector to compare - Whether or not the two Vector instances are equal - - - - Compares two rectangles for fuzzy equality. This function - helps compensate for the fact that double values can - acquire error when operated upon - - The first rectangle to compare - The second rectangle to compare - Whether or not the two rectangles are equal - - - - Faster check for NaN ( faster than double.IsNaN() ) - IEEE 754 : If the argument is any value in the range 0x7ff0000000000001L through 0x7fffffffffffffffL - or in the range 0xfff0000000000001L through 0xffffffffffffffffL, the result will be NaN. - - Value to check - - - - - Rounds the given value based on the DPI scale - - Value to round - DPI Scale - - - - - Verifies if this Thickness contains only valid values - The set of validity checks is passed as parameters. - - Thickness value - allows negative values - allows Double.NaN - allows Double.PositiveInfinity - allows Double.NegativeInfinity - Whether or not the thickness complies to the range specified - - - - Method to add up the left and right size as width, as well as the top and bottom size as height - - Thickness - Size - - - - Verifies if the Thickness contains only zero values - - Thickness - Size - - - - Verifies if all the values in Thickness are same - - Thickness - true if yes, otherwise false - - - - Verifies if this CornerRadius contains only valid values - The set of validity checks is passed as parameters. - - CornerRadius value - allows negative values - allows Double.NaN - allows Double.PositiveInfinity - allows Double.NegativeInfinity - Whether or not the CornerRadius complies to the range specified - - - - Verifies if the CornerRadius contains only zero values - - CornerRadius - Size - - - - Verifies if the CornerRadius contains same values - - CornerRadius - true if yes, otherwise false - - - - Deflates rectangle by given thickness - - Rectangle - Thickness - Deflated Rectangle - - - - Inflates rectangle by given thickness - - Rectangle - Thickness - Inflated Rectangle - - - - Verifies if the given brush is a SolidColorBrush and - its color does not include transparency. - - Brush - true if yes, otherwise false - - - - Verifies if the given brush is the same as the otherBrush. - - Brush - Brush - true if yes, otherwise false - - - Helper for getting from . - to read from. - MaximumRecentColorsCount property value. - - - Helper for setting on . - to set on. - MaximumRecentColorsCount property value. - - - Identifies the dependency property. - - - - Gets or sets the selected . - - - - Identifies the dependency property. - - - - Gets or sets the number of additional pixel in the preview image. - - - - Identifies the dependency property. - - - - Gets or sets the Cursor for Selecting Color Mode - - - - Identifies the dependency property. - - - - Gets or sets the ContentControl.ContentTemplate for the preview. - - - - Identifies the routed event. - - - - Occurs when the property is changed. - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - Gets the preview image while the cursor is moving - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - Gets the preview brush while the cursor is moving - - - - - A Helper class for the Color-Struct - - - - - This function tries to convert a given string into a Color in the following order: - 1. If the string starts with '#' the function tries to get the color from the hex-code - 2. else the function tries to find the color in the color names Dictionary - 3. If 1. + 2. were not successful the function adds a '#' sign and tries 1. + 2. again - - The localized name of the color, the hex-code of the color or the internal color name - Optional: The dictionary where the ColorName should be looked up - the Color if successful, else null - - - - This function tries to convert a given string into a Color in the following order: - 1. If the string starts with '#' the function tries to get the color from the hex-code - 2. else the function tries to find the color in the default - 3. If 1. + 2. were not successful the function adds a '#' sign and tries 1. + 2. again - - The localized name of the color, the hex-code of the color or the internal color name - the Color if successful, else null - - - - A Dictionary with localized Color Names - - - - - Searches for the localized name of a given - - color - Optional: The dictionary where the ColorName should be looked up - the local color name or null if the given color doesn't have a name - - - - Searches for the localized name of a given by using the default - - color - the local color name or null if the given color doesn't have a name - - - Identifies the dependency property. - - - - Gets or sets the Header of this Control - - - - Identifies the dependency property. - - - - Gets or sets the HeaderTemplate of this Control - - - - Identifies the dependency property. - - - - Gets or sets a custom dictionary for color to name. If null, the default dictionary will be used. - - - - Identifies the routed event. - - - - Occurs when the DropDown is closed. - - - - Identifies the routed event. - - - - Occurs when the DropDown is opened. - - - - Identifies the dependency property. - - - - Gets or sets the height of the DropDown. - - - - Identifies the dependency property. - - - - Gets or sets the width of the DropDown. - - - - Identifies the dependency property. - - - - Whether or not the "popup" for this control is currently open - - - - Identifies the dependency property. - - - - Gets or sets the for the - - - - Identifies the dependency property. - - - - Gets or sets when to add the to the - - - - Identifies the dependency property. - - - - Gets or sets the visibility of the available . - - - - Identifies the dependency property. - - - - Gets or sets the of the available . - - - - Identifies the dependency property. - - - - Gets or sets the of the available . - - - - Identifies the dependency property. - - - - Gets or sets the of the available . - - - - Identifies the dependency property. - - - - Gets or sets the of the available . - - - - Identifies the dependency property. - - - - Gets or sets the visibility of the custom (1/2). - - - - Identifies the dependency property. - - - - Gets or sets the of the custom (1/2). - - - - Identifies the dependency property. - - - - Gets or sets the of the custom (1/2). - - - - Identifies the dependency property. - - - - Gets or sets the of the custom (1/2). - - - - Identifies the dependency property. - - - - Gets or sets the of the custom (1/2). - - - - Identifies the dependency property. - - - - Gets or sets the visibility of the custom (2/2). - - - - Identifies the dependency property. - - - - Gets or sets the of the custom (2/2). - - - - Identifies the dependency property. - - - - Gets or sets the of the custom (2/2). - - - - Identifies the dependency property. - - - - Gets or sets the of the custom (2/2). - - - - Identifies the dependency property. - - - - Gets or sets the of the custom (2/2). - - - - Identifies the dependency property. - - - - Gets or sets the visibility of the recent . - - - - Identifies the dependency property. - - - - Gets or sets the of the recent . - - - - Identifies the dependency property. - - - - Gets or sets the of the recent . - - - - Identifies the dependency property. - - - - Gets or sets the of the recent . - - - - Identifies the dependency property. - - - - Gets or sets the of the recent . - - - - Identifies the dependency property. - - - - Gets or sets the visibility of the standard . - - - - Identifies the dependency property. - - - - Gets or sets the of the standard . - - - - Identifies the dependency property. - - - - Gets or sets the of the standard . - - - - Identifies the dependency property. - - - - Gets or sets the of the standard . - - - - Identifies the dependency property. - - - - Gets or sets the of the standard . - - - - Identifies the dependency property. - - - - Gets or sets the for the . - - - - Identifies the dependency property. - - - - Gets or sets the for the - - - - Identifies the dependency property. - - - - Gets or sets the for the . - - - - Identifies the dependency property. - - - - Gets or sets the for the . - - - - Identifies the dependency property. - - - - Gets or sets the visibility of the . - - - - Identifies the dependency property. - - - - Gets or sets the for the . - - - - Identifies the dependency property. - - - - Gets or sets the for the . - - - - Identifies the dependency property. - - - - Gets or sets the visibility of the . - - - - Identifies the dependency property. - - - - Gets or sets the selected . - - - - Identifies the dependency property. - - - - Gets or sets a default selected - - - - Identifies the dependency property. - - - - Gets the as . This property is read only. - - - - Identifies the dependency property. - - - - Gets or sets the name of the . - - - - Identifies the dependency property. - - - - Gets or sets a for looking up the - - - - Identifies the dependency property. - - - - Gets or sets the Alpha-Channel - - - - Identifies the dependency property. - - - - Gets or sets the Red-Channel - - - - Identifies the dependency property. - - - - Gets or sets the Green-Channel - - - - Identifies the dependency property. - - - - Gets or sets the Blue-Channel - - - - Identifies the dependency property. - - - - Gets or sets the Hue-Channel - - - - Identifies the dependency property. - - - - Gets or sets the Saturation-Channel - - - - Identifies the dependency property. - - - - Gets or sets the Value-Channel - - - - Identifies the dependency property. - - - - Gets or sets the label for the Alpha-Channel in the UI - - - - Identifies the dependency property. - - - - Gets or sets the label for the Red-Channel in the UI - - - - Identifies the dependency property. - - - - Gets or sets the label for the Green-Channel in the UI - - - - Identifies the dependency property. - - - - Gets or sets the label for the Blue-Channel in the UI - - - - Identifies the dependency property. - - - - Gets or sets the label for the Preview in the UI - - - - Identifies the dependency property. - - - - Gets or sets the label for the Hue-Channel in the UI - - - - Identifies the dependency property. - - - - Gets or sets the label for the Saturation-Channel in the UI - - - - Identifies the dependency property. - - - - Gets or sets the label for the Value-Channel in the UI - - - - Identifies the dependency property. - - - - Gets or sets the label for the in the UI - - - - Identifies the routed event. - - - - Occurs when the property is changed. - - - - - This struct represent a Color in HSV (Hue, Saturation, Value) - - For more information visit: https://en.wikipedia.org/wiki/HSL_and_HSV - - - - - Gets the Alpha channel. - - - - - Gets the Hue channel. - - - - - Gets the Saturation channel - - - - - Gets the Value channel - - - - - Creates a new HSV Color from a given - - The to convert - - - - Creates a new HSV Color - - channel [0;360] - channel [0;1] - channel [0;1] - - - - Creates a new HSV Color - - (Alpha) channel [0;1] - channel [0;360] - channel [0;1] - channel [0;1] - - - - Gets the for this HSV Color struct - - - - - Identifies the dependency property. - - - - Gets or sets the character casing of the Content. - - - - Identifies the dependency property. - - - - Determine if the inner ContentPresenter should use AccessText in its style - - - - - This custom popup is used by the validation error template. - It provides some additional nice features: - - repositioning if host-window size or location changed - - repositioning if host-window gets maximized and vice versa - - it's only topmost if the host-window is activated - - - - Identifies the dependency property. - - - - Gets or sets whether if the popup can be closed by left mouse button down. - - - - Identifies the dependency property. - - - - Gets or sets whether the validation error text will be shown when hovering the validation triangle. - - - - Identifies the dependency property. - - - - Gets or sets the that this object is reserving space for. - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - Gets whether the popup can be shown (useful for transitions). - - - - - Called when a cell has just switched to edit mode. - - A reference to element returned by GenerateEditingElement. - The event args of the input event that caused the cell to go into edit mode. May be null. - The unedited value of the cell. - - - - Synchronizes the column property. Taken from Helper code for DataGrid. - - - - - Taken from Helper code for DataGrid. - - - - Identifies the dependency property. - - - - Gets or sets the formatting for the displaying value. - - - - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - Gets or sets the decimal-point correction mode. The default is - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - The font family of the desired font. - - - - Identifies the dependency property. - - - - The size of the desired font. - - - - Identifies the dependency property. - - - - The style of the desired font. - - - - Identifies the dependency property. - - - - The weight or thickness of the desired font. - - - - Identifies the dependency property. - - - - An brush that describes the foreground color. This overrides the cell foreground inherited color. - - - - - Method used as property changed callback for properties which need RefreshCellContent to be called - - - - - Rebuilds the contents of a cell in the column in response to a binding change. - - The cell to update. - The name of the column property that has changed. - - - - (Default) No correction is applied, and any style - inherited setting may influence the correction behavior. - - - - - Enable the decimal-point correction for generic numbers. - - - - - Enable the decimal-point correction for currency numbers. - - - - - Enable the decimal-point correction for percent-numbers. - - - - - The base class for dialogs. - - You probably don't want to use this class, if you want to add arbitrary content to your dialog, - use the class. - - - - Identifies the dependency property. - - - - Gets or sets the left and right margin for the dialog content. - - - - Identifies the dependency property. - - - - Gets or sets the width for the dialog content. - - - - Identifies the dependency property. - - - - Gets or sets the title of the dialog. - - - - Identifies the dependency property. - - - - Gets or sets the content above the dialog. - - - - Identifies the dependency property. - - - - Gets or sets the content below the dialog. - - - - Identifies the dependency property. - - - - Gets or sets the font size of the dialog title. - - - - Identifies the dependency property. - - - - Gets or sets the font size of the dialog message text. - - - - Identifies the dependency property. - - - - Gets or sets the font size of any dialog buttons. - - - - - Initializes a new . - - The window that is the parent of the dialog. - The settings for the message dialog. - - - - Initializes a new . - - - - - - - - With this method it's possible to return your own settings in a custom dialog. - - - - - - - This is called in the loaded event. - - - - - Waits for the dialog to become ready for interaction. - - A task that represents the operation and it's status. - - - - Requests an externally shown Dialog to close. Will throw an exception if the Dialog is inside of a MetroWindow. - - - - - A last chance virtual method for stopping an external dialog from closing. - - - - - - Gets the window that owns the current Dialog IF AND ONLY IF the dialog is shown externally. - - - - - Gets the window that owns the current Dialog IF AND ONLY IF the dialog is shown inside of a window. - - - - - Waits until this dialog gets unloaded. - - - - - - An implementation of BaseMetroDialog allowing arbitrary content. - - - - - Gets the default instance if the dialog coordinator, which can be injected into a view model. - - - - - Creates a LoginDialog inside of the current window. - - The window that is the parent of the dialog. - The title of the LoginDialog. - The message contained within the LoginDialog. - Optional settings that override the global metro dialog settings. - The text that was entered or null (Nothing in Visual Basic) if the user cancelled the operation. - - - - Creates a InputDialog inside of the current window. - - The MetroWindow - The title of the MessageDialog. - The message contained within the MessageDialog. - Optional settings that override the global metro dialog settings. - The text that was entered or null (Nothing in Visual Basic) if the user cancelled the operation. - - - - Creates a MessageDialog inside of the current window. - - The MetroWindow - The title of the MessageDialog. - The message contained within the MessageDialog. - The type of buttons to use. - Optional settings that override the global metro dialog settings. - A task promising the result of which button was pressed. - - - - Creates a ProgressDialog inside of the current window. - - The MetroWindow - The title of the ProgressDialog. - The message within the ProgressDialog. - Determines if the cancel button is visible. - Optional Settings that override the global metro dialog settings. - A task promising the instance of ProgressDialogController for this operation. - - - - Adds a Metro Dialog instance to the specified window and makes it visible asynchronously. - If you want to wait until the user has closed the dialog, use - You have to close the resulting dialog yourself with . - - The owning window of the dialog. - The dialog instance itself. - An optional pre-defined settings instance. - A task representing the operation. - The is already visible in the window. - - - - Adds a Metro Dialog instance of the given type to the specified window and makes it visible asynchronously. - If you want to wait until the user has closed the dialog, use - You have to close the resulting dialog yourself with . - - The owning window of the dialog. - An optional pre-defined settings instance. - A task with the dialog representing the operation. - - - - Hides a visible Metro Dialog instance. - - The window with the dialog that is visible. - The dialog instance to hide. - An optional pre-defined settings instance. - A task representing the operation. - - The is not visible in the window. - This happens if hasn't been called before. - - - - - Gets the current shown dialog in async way. - - The dialog owner. - - - - Create and show an external dialog. - - The dialog which will be shown externally. - The owner for the external window. If it's null the main window will be use. - The delegate for customizing dialog window. It can be null. - The given dialog. - - - - Create and show an external modal dialog. - - The dialog which will be shown externally. - The owner for the external window. If it's null the main window will be use. - The delegate for customizing dialog window. It can be null. - The given dialog. - - - - Creates a LoginDialog outside of the current window. - - The window that is the parent of the dialog. - The title of the LoginDialog. - The message contained within the LoginDialog. - Optional settings that override the global metro dialog settings. - The text that was entered or null (Nothing in Visual Basic) if the user cancelled the operation. - - - - Creates a InputDialog outside of the current window. - - The MetroWindow - The title of the MessageDialog. - The message contained within the MessageDialog. - Optional settings that override the global metro dialog settings. - The text that was entered or null (Nothing in Visual Basic) if the user cancelled the operation. - - - - Creates a MessageDialog ouside of the current window. - - The MetroWindow - The title of the MessageDialog. - The message contained within the MessageDialog. - The type of buttons to use. - Optional settings that override the global metro dialog settings. - A task promising the result of which button was pressed. - - - - Use the dialog coordinator to help you interfact with dialogs from a view model. - - - - - Shows the input dialog. - - Typically this should be the view model, which you register in XAML using . - The title of the MessageDialog. - The message contained within the MessageDialog. - Optional settings that override the global metro dialog settings. - The text that was entered or null (Nothing in Visual Basic) if the user cancelled the operation. - - - - Shows the input dialog. - - Typically this should be the view model, which you register in XAML using . - The title of the MessageDialog. - The message contained within the MessageDialog. - Optional settings that override the global metro dialog settings. - The text that was entered or null (Nothing in Visual Basic) if the user cancelled the operation. - - - - Creates a LoginDialog inside of the current window. - - Typically this should be the view model, which you register in XAML using . - The title of the LoginDialog. - The message contained within the LoginDialog. - Optional settings that override the global metro dialog settings. - The text that was entered or null (Nothing in Visual Basic) if the user cancelled the operation. - - - - Creates a LoginDialog outside of the current window. - - Typically this should be the view model, which you register in XAML using . - The title of the LoginDialog. - The message contained within the LoginDialog. - Optional settings that override the global metro dialog settings. - The text that was entered or null (Nothing in Visual Basic) if the user cancelled the operation. - - - - Creates a MessageDialog inside of the current window. - - Typically this should be the view model, which you register in XAML using . - The title of the MessageDialog. - The message contained within the MessageDialog. - The type of buttons to use. - Optional settings that override the global metro dialog settings. - A task promising the result of which button was pressed. - - - - Creates a MessageDialog outside of the current window. - - Typically this should be the view model, which you register in XAML using . - The title of the MessageDialog. - The message contained within the MessageDialog. - The type of buttons to use. - Optional settings that override the global metro dialog settings. - A task promising the result of which button was pressed. - - - - Creates a ProgressDialog inside of the current window. - - Typically this should be the view model, which you register in XAML using . - The title of the ProgressDialog. - The message within the ProgressDialog. - Determines if the cancel button is visible. - Optional Settings that override the global metro dialog settings. - A task promising the instance of ProgressDialogController for this operation. - - - - Adds a Metro Dialog instance to the specified window and makes it visible asynchronously. - You have to close the resulting dialog yourself with . - - Typically this should be the view model, which you register in XAML using . - The dialog instance itself. - An optional pre-defined settings instance. - A task representing the operation. - The is already visible in the window. - - - - Hides a visible Metro Dialog instance. - - Typically this should be the view model, which you register in XAML using . - The dialog instance to hide. - An optional pre-defined settings instance. - A task representing the operation. - - The is not visible in the window. - This happens if hasn't been called before. - - - - - Gets the current shown dialog. - - Typically this should be the view model, which you register in XAML using . - - - - InputDialog - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - InitializeComponent - - - - - LoginDialog - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - InitializeComponent - - - - - An internal control that represents a message dialog. Please use MetroWindow.ShowMessage instead! - - - MessageDialog - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - InitializeComponent - - - - - An enum representing the result of a Message Dialog. - - - - - An enum representing the different button states for a Message Dialog. - - - - - Just "OK" - - - - - "OK" and "Cancel" - - - - - An enum representing the different choices for a color scheme in a Metro Dialog. - - - - - A class that represents the settings used by Metro Dialogs. - - - - - Gets or sets wheater the owner of the dialog can be closed. - - - - - Gets or sets the text used for the Affirmative button. For example: "OK" or "Yes". - - - - - Enable or disable dialog hiding animation - "True" - play hiding animation. - "False" - skip hiding animation. - - - - - Enable or disable dialog showing animation. - "True" - play showing animation. - "False" - skip showing animation. - - - - - Gets or sets a token to cancel the dialog. - - - - - Gets or sets whether the metro dialog should use the default black/white appearance (theme) or try to use the current accent. - - - - - Gets or sets a custom resource dictionary which can contains custom styles, brushes or something else. - - - - - Gets or sets which button should be focused by default - - - - - Gets or sets the default text (just the inputdialog needed) - - - - - Gets or sets the size of the dialog message font. - - - The size of the dialog message font. - - - - - Gets or sets the size of the dialog button font. - - - The size of the dialog button font. - - - - - Gets or sets the dialog result when the user cancelled the dialog with 'ESC' key - - If the value is the default behavior is determined - by the . - - - - -
    - - - - -
    -
    - - - Gets or sets the size of the dialog title font. - - - The size of the dialog title font. - - - - - Gets or sets the text used for the first auxiliary button. - - - - - Gets or sets the maximum height. (Default is unlimited height, Double.NaN) - - - - - Gets or sets the text used for the Negative button. For example: "Cancel" or "No". - - - - - Gets or sets the text used for the second auxiliary button. - - - - - An internal control that represents a message dialog. Please use MetroWindow.ShowMessage instead! - - - ProgressDialog - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - InitializeComponent - - - - - A class for manipulating an open ProgressDialog. - - - - - This event is raised when the associated was closed programmatically. - - - - - This event is raised when the associated was cancelled by the user. - - - - - Gets if the Cancel button has been pressed. - - - - - Gets if the wrapped ProgressDialog is open. - - - - - Sets the ProgressBar's IsIndeterminate to true. To set it to false, call SetProgress. - - - - - Sets if the Cancel button is visible. - - - - - - Sets the dialog's progress bar value and sets IsIndeterminate to false. - - The percentage to set as the value. - - - - Gets/Sets the minimum restriction of the progress Value property. - - - - - Gets/Sets the maximum restriction of the progress Value property. - - - - - Sets the dialog's message content. - - The message to be set. - - - - Sets the dialog's title. - - The title to be set. - - - - Sets the dialog's progress bar brush. - - The brush to use for the progress bar's foreground. - - - - Begins an operation to close the ProgressDialog. - - A task representing the operation. - - - Identifies the dependency property. - - - - Whether or not the "popup" menu for this control is currently open - - - - Identifies the dependency property. - - - - Gets or sets an extra tag. - - - - Identifies the dependency property. - - - - Gets or sets the orientation of children stacking. - - - - Identifies the dependency property. - - - - Gets or sets the content for the icon part. - - - - Identifies the dependency property. - - - - Gets or sets the DataTemplate for the icon part. - - - - Identifies the dependency property. - - - - Gets or sets the command to invoke when the content button is pressed. - - - - Identifies the dependency property. - - - - Gets or sets the element on which to raise the specified command. - - - - Identifies the dependency property. - - - - Gets or sets the parameter to pass to the command property. - - - - Identifies the dependency property. - - - - Gets or sets the content of this control. - - - - Identifies the dependency property. - - - - Gets or sets the data template used to display the content of the DropDownButton. - - - - Identifies the dependency property. - - - - Gets or sets a template selector that enables an application writer to provide custom template-selection logic. - - - This property is ignored if is set. - - - - Identifies the dependency property. - - - - Gets or sets a composite string that specifies how to format the content property if it is displayed as a string. - - - This property is ignored if is set. - - - - Identifies the dependency property. - - - - Gets or sets the button content style. - - - - Identifies the dependency property. - - - - Gets or sets the "popup" menu style. - - - - Identifies the dependency property. - - - - Gets or sets the foreground brush for the button arrow icon. - - - - Identifies the dependency property. - - - - Gets or sets the foreground brush of the button arrow icon if the mouse is over the drop down button. - - - - Identifies the dependency property. - - - - Gets or sets the foreground brush of the button arrow icon if the arrow button is pressed. - - - - Identifies the dependency property. - - - - Gets or sets the visibility of the button arrow icon. - - - - - - - - - - Invoked when the property changes. - Information about the change. - - - - Executes the specified action asynchronously with the DispatcherPriority.Background on the thread that the Dispatcher was created on. - - The dispatcher object where the action runs. - An action that takes no parameters. - The dispatcher priority. - - - - Executes the specified action if the element is loaded or at the loaded event if it's not loaded. - - The element where the action should be run. - An action that takes no parameters. - - - - A control that imitate a slide show with back/forward buttons. - - - - Identifies the dependency property. - - - - Gets or sets the border brush of the mouse hover effect. - - - - Identifies the dependency property. - - - - Gets or sets a value indicating whether the border for mouse over effect is enabled or not. - - - - Identifies the dependency property. - - - - Gets or sets the border thickness for the border of the mouse hover effect. - - - - Identifies the dependency property. - - - - Gets or sets a value indicating whether the navigation index should be visible. - - - - Identifies the dependency property. - - - - Gets or sets a style for the navigation index items. - - - - Identifies the dependency property. - - - - Gets or sets a value specifying where the navigation index should be rendered. - - - - - Gets or sets the horizontal alignment characteristics applied to the navigation index. - - - - - Gets or sets the vertical alignment characteristics applied to the navigation index. - - - - Identifies the dependency property. - - - - Gets or sets a value indicating whether the navigation is circular, so you get the first after last and the last before first. - - - - Identifies the dependency property. - - - - Gets or sets the position of the navigation buttons. - - - - Identifies the dependency property. - - - - Gets or sets the orientation of the navigation. - - - - Identifies the dependency property. - - - - Gets or sets the transition of the left navigation. - - - - Identifies the dependency property. - - - - Gets or sets the transition of the right navigation. - - - - Identifies the dependency property. - - - - Gets or sets the transition of the up navigation. - - - - Identifies the dependency property. - - - - Gets or sets the transition of the down navigation. - - - - Identifies the dependency property. - - - - Gets or sets whether the banner is visible or not. - - - - Identifies the dependency property. - - - - Gets or sets whether the navigation button are visible or not. - - - - Identifies the dependency property. - - - - Gets or sets the banner text. - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - Gets or sets the DataTemplate used to display the banner's content. - - - - Identifies the dependency property. - - - - Gets or sets a template selector for BannerText property that enables an application writer to provide custom template-selection logic . - - - This property is ignored if is set. - - - - Identifies the dependency property. - - - - Gets or sets a composite string that specifies how to format the BannerText property if it is displayed as a string. - - - This property is ignored if is set. - - - - - Gets or sets a that is used to fill the banner. - - - - Identifies the dependency property. - - - - Gets or sets a that describes the foreground color of the banner label. - - - - Identifies the dependency property. - - - - Gets or sets the opacity factor applied to the entire banner when it is rendered in the user interface (UI). - - - - Identifies the dependency property. - - - - Gets or sets the for the navigation buttons. - - - - Identifies the dependency property. - - - - Provides the object content that should be displayed on the Back Button. - - - - Identifies the dependency property. - - - - Gets or sets the DataTemplate used to display the Back button's content. - - - - Identifies the dependency property. - - - - Gets or sets a composite string that specifies how to format the ButtonBackContent property if it is displayed as a string. - - - This property is ignored if is set. - - - - Identifies the dependency property. - - - - Provides the object content that should be displayed on the Forward Button. - - - - Identifies the dependency property. - - - - Gets or sets the DataTemplate used to display the Forward button's content. - - - - Identifies the dependency property. - - - - Gets or sets a composite string that specifies how to format the ButtonForwardContent property if it is displayed as a string. - - - This property is ignored if is set. - - - - Identifies the dependency property. - - - - Provides the object content that should be displayed on the Up Button. - - - - Identifies the dependency property. - - - - Gets or sets the DataTemplate used to display the Up button's content. - - - - Identifies the dependency property. - - - - Gets or sets a composite string that specifies how to format the ButtonUpContent property if it is displayed as a string. - - - This property is ignored if is set. - - - - Identifies the dependency property. - - - - Provides the object content that should be displayed on the Down Button. - - - - Identifies the dependency property. - - - - Gets or sets the DataTemplate used to display the Down button's content. - - - - Identifies the dependency property. - - - - Gets or sets a composite string that specifies how to format the ButtonDownContent property if it is displayed as a string. - - - This property is ignored if is set. - - - - - To counteract the double Loaded event issue. - - - - - Coerce SelectedIndexProperty's value. - - The object that the property exists on. - The new value of the property, prior to any coercion attempt. - The coerced value (with appropriate type). - - - - Changes the current slide to the previous item. - - - - - Changes the current to the next item. - - - - - Brings the control buttons (next/previous) into view. - - - - - Removes the control buttons (next/previous) from view. - - - - - Applies actions to navigation buttons. - - Action applied to the previous button. - Action applied to the next button. - Action applied to the inactive buttons. - Any action is null. - - - - Computes the transition when changing selected index. - - Previous selected index. - New selected index. - - - - Sets the visibility of navigation buttons. - - Visibility of active buttons. - - - - Gets the navigation buttons. - - Previous button. - Next button. - Inactive buttons. - - - Identifies the dependency property. - - - - Gets or sets the banner text. - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - - - - A sliding panel control that is hosted in a via a . - - - - - An event that is raised when property changes. - - - - - An event that is raised when the opening animation has finished. - - - - - An event that is raised when the closing animation has finished. - - - - - Gets or sets the position of this inside the . - - - - - Gets or sets whether this stays open when the user clicks somewhere outside of it. - - - - - Gets or sets whether this should be visible or not. - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - Gets whether the is completely shown (after was set to true). - - - - - Gets or sets whether this uses the open/close animation when changing the property (default is true). - - - - - Gets or sets whether this animates the opacity when opening/closing the . - - - - - Gets or sets whether this is modal. - - - - - Gets or sets a which will be executed if the close button was clicked. - - - The won't be executed when property will be set to false/true. - - - - - Gets or sets the parameter for the . - - - - - Gets or sets the theme for the . - - - - - Gets or sets the mouse button that closes the when the user clicks somewhere outside of it. - - - - - Gets or sets the visibility of the close button for this . - - - - - Gets or sets a value that indicates whether the close button is a Cancel button. A user can activate the Cancel button by pressing the ESC key. - - - - - Gets or sets the visibility of the title. - - - - - Gets or sets a value that indicates whether the uses animations for open/close. - - - - - Gets or sets the focused element. - - - - - Gets or sets a value indicating whether the should try focus an element. - - - - - Gets or sets a value indicating whether the should auto close after the has passed. - - - - - Gets or sets the time in milliseconds when the should auto close. - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - property changed notifier used in . - - - - - property changed notifier used in . - - - - - A FlyoutsControl is for displaying flyouts in a . - - - - Identifies the dependency property. - - - - Gets or sets whether is ignored and all flyouts behave as if it was set to the value of this property. - - - - Identifies the dependency property. - - - - Gets or sets whether is ignored and all flyouts behave as if it was set false. - - - - - Adapts the theme to the theme of the host window or application. - - - - - Adapts the theme to the theme of the host window or application, but inverted. - - - This theme can only be applied if the host window's theme abides the "Dark" and "Light" affix convention. - (see for more infos. - - - - - Use the dark theme for the . This is the default theme. - - - - - Use the light theme for the . - - - - - The theme will match the host window's accent color. - - - - - Represents an icon that uses a glyph from the specified font. - - - - Identifies the dependency property. - - - - Gets or sets the character code that identifies the icon glyph. - - The hexadecimal character code for the icon glyph. - - - - The HamburgerMenu is based on a control. By default it contains a HamburgerButton and a ListView to display menu items. - - - - - Initializes a new instance of the class. - - - - - Override default OnApplyTemplate to capture children controls - - - - Identifies the routed event. - - - - Event raised when an item is clicked - - - - Identifies the routed event. - - - - Event raised when an options' item is clicked - - - - Identifies the routed event. - - - - Event raised when an item is invoked - - - - Identifies the routed event. - - - - Event raised when the hamburger button is clicked - - - - Identifies the dependency property. - - - - Gets or sets HamburgerMenu button's . - - - - Identifies the dependency property. - - - - Gets or sets the for the HamburgerMenu button. - - - - Identifies the dependency property. - - - - Gets or sets the margin for the HamburgerMenu button. - - - - Identifies the dependency property. - - - - Gets or sets the for the HamburgerMenu button. - - - - Identifies the dependency property. - - - - Gets or sets the for the HamburgerMenu button. - - - - Identifies the dependency property. - - - - Gets or sets the for the HamburgerMenu button. - - - - Identifies the dependency property. - - - - Gets or sets the for the HamburgerMenu button. - - - - Identifies the dependency property. - - - - Gets or sets the for the HamburgerMenu button. - - - - Identifies the dependency property. - - - - Gets or sets the for the HamburgerMenu pane header. - - - - Identifies the dependency property. - - - - Gets or sets an object source used to generate the content of the options. - - - - Identifies the dependency property. - - - - Gets or sets the used for each item in the options. - - - - Identifies the dependency property. - - - - Gets or sets the used to display each item in the options. - - - - Identifies the dependency property. - - - - Gets or sets the used to display each item in the options. - - - - Identifies the dependency property. - - - - Gets or sets the of the options menu. - - - - Identifies the dependency property. - - - - Gets or sets the selected options menu item. - - - - Identifies the dependency property. - - - - Gets or sets the selected options menu index. - - - - Identifies the dependency property. - - - - Gets or sets a which will be executed if an options item was clicked by the user. - - - - Identifies the dependency property. - - - - Gets or sets the parameter which will be passed by the . - - - - - Gets the collection used to generate the content of the option list. - - - Exception thrown if OptionsListView is not yet defined. - - - - - Executes the . - - - - Identifies the dependency property. - - - - Gets or sets the width of the pane when it's fully expanded. - - - - Identifies the dependency property. - - - - Gets or sets the width of the pane when in its compact display mode. - - - - Identifies the dependency property. - - - - Gets or sets the minimum width of the pane when it's fully expanded. - - - - Identifies the dependency property. - - - - Gets or sets the maximum width of the pane when it's fully expanded. - - - - Identifies the dependency property. - - - - Gets or Sets whether the open pane can be resized by the user. The default value is false. - - - - Identifies the dependency property. - - - - Gets or Sets the for the resizing Thumb (type of ) - - - - Identifies the dependency property. - - - - Gets or sets a value that specifies whether the pane is shown on the right or on left side of the HamburgerMenu. - - - - Identifies the dependency property. - - - - Gets or sets a value that specifies how the pane and content areas are shown. - - - - Identifies the dependency property. - - - - Gets or sets the margin for the pane. - - - - Identifies the dependency property. - - - - Gets or sets the margin for the pane header. - - - - Identifies the dependency property. - - - - Gets or sets the Brush to apply to the background of the pane area of the HamburgerMenu. - - - - Identifies the dependency property. - - - - Gets or sets the Brush to apply to the foreground of the pane area of the HamburgerMenu. - - - - Identifies the dependency property. - - - - Gets or sets a value indicating whether the pane is expanded to its full width. - - - - Identifies the dependency property. - - - - Gets or sets an object source used to generate the content of the menu. - - - - Identifies the dependency property. - - - - Gets or sets the used for each item. - - - - Identifies the dependency property. - - - - Gets or sets the used for each header item. - - - - Identifies the dependency property. - - - - Gets or sets the used for each separator item. - - - - Identifies the dependency property. - - - - Gets or sets the used to display each item. - - - - Identifies the dependency property. - - - - Gets or sets the used to display each item. - - - - Identifies the dependency property. - - - - Gets or sets the selected menu item. - - - - Identifies the dependency property. - - - - Gets or sets the selected menu index. - - - - Identifies the dependency property. - - - - Gets or sets the for the which shows the selected menu item content. - - - - Identifies the dependency property. - - - - Gets or sets a which will be executed if an item was clicked by the user. - - - - Identifies the dependency property. - - - - Gets or sets the parameter which will be passed by the . - - - - Identifies the dependency property. - - - - Gets or sets whether the ScrollBar of the HamburgerMenu is on the left side or on the right side of the menu items. - - - - Identifies the dependency property. - - - - Gets or sets whether a selection indicator will be shown on the HamburgerMenuItem. - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - Gets or sets the default FocusVisualStyle for a HamburgerMenuItem. - This style can be override at the HamburgerMenuItem style by setting the FocusVisualStyle property. - - - - - Gets the collection used to generate the content of the items list. - - - Exception thrown if ButtonsListView is not yet defined. - - - - - Executes the . - - - - - EventArgs used for the and events. - - - - - - - - - - - - - - Gets the clicked item (options item). - - - - - RoutedEventHandler used for the and events. - - - - - EventArgs used for the event. - - - - - - - - - - - - - - Gets the invoked item. - - - - - Gets a value indicating whether the invoked item is an options item - - - - - RoutedEventHandler used for the event. - - - - - The HamburgerMenuGlyphItem provides a glyph based implementation for HamburgerMenu entries. - - - - - Identifies the dependency property. - - - - - Gets or sets a value that specifies the glyph to use from Segoe MDL2 Assets font. - - - - - Identifies the dependency property. - - - - - Gets or sets a value that specifies label to display. - - - - - The HamburgerMenuIconItem provides an icon based implementation for HamburgerMenu entries. - - - - - Identifies the dependency property. - - - - - Gets or sets a value that specifies an user specific object which can be used as icon. - - - - - The HamburgerMenuImageItem provides an image based implementation for HamburgerMenu entries. - - - - - Identifies the dependency property. - - - - - Gets or sets a value that specifies a bitmap to display with an Image control. - - - - - The HamburgerMenuItem provides an implementation for HamburgerMenu entries. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Gets or sets a value that specifies label to display. - - - - - Gets or sets a value that specifies the page to navigate to (if you use the HamburgerMenu with a Frame content) - - - - - Gets or sets a command which will be executed if an item is clicked by the user. - - - - - Gets or sets the command parameter which will be passed by the Command. - - - - - Gets or sets the element on which to raise the specified command. - - - Element on which to raise a command. - - - - - Gets or sets a value indicating whether this item is enabled in the user interface (UI). This is a dependency property. - - - true if the item is enabled; otherwise, false. The default value is true. - - - - - Gets or sets a value that specifies ToolTip to display. - - - - - Executes the command which can be set by the user. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Gets or sets a value that specifies an user specific value. - - - - - Gets or sets the value indicating whether this element is visible in the user interface (UI). This is a dependency property. - - - true if the item is visible, otherwise false. The default value is true. - - - - - The HamburgerMenuItemCollection provides typed collection of HamburgerMenuItemBase. - - - - - Gets or sets a value indicating whether which item container style will be used for the HamburgerMenuItem. - - - - - - - - The HamburgerMenuSeparatorItem provides an separator based implementation for HamburgerMenu entries. - - - - - Gets or sets a value that specifies label to display. - - - - - Gets or sets a value that specifies label to display. - - - - - Gets or sets a value that specifies ToolTip to display. - - - - - Gets or sets a value indicating whether this item is enabled in the user interface (UI). - - - true if the item is enabled; otherwise, false. The default value is true. - - - - - Gets or sets the value indicating whether this element is visible in the user interface (UI). This is a dependency property. - - - true if the item is visible, otherwise false. The default value is true. - - - - - Represents an hour comparison operation that ensures that 12 is smaller than 1. - This ensures that in the control the first hour that is selectable is 12 (AM/PM). - - - This ensures that the first hour that is selectable is 12 (AM/PM).

    - This comparer is used only if in the corresponding the value for is false. -
    -
    - - - Gets the size of the CheckBox itself. - - - - - Sets the size of the CheckBox itself. - - - - - Gets the CornerRadius of the CheckBox itself. - The CheckCornerRadius property allows users to control the roundness of the CheckBox corners independently by setting a radius value for each corner. - - - - - Sets the CornerRadius of the CheckBox itself. - - - - - Gets the stroke thickness of the CheckBox itself. - - - - - Sets the stroke thickness of the CheckBox itself. - - - - - Gets the Glyph for IsChecked = false. - - - - - Sets the Glyph for IsChecked = false. - - - - - Gets the GlyphTemplate for IsChecked = false. - - - - - Sets the GlyphTemplate for IsChecked = false. - - - - - Gets the Foreground for IsChecked = false. - - - - - Sets the Foreground for IsChecked = false. - - - - - Gets the Background for IsChecked = false. - - - - - Sets the Background for IsChecked = false. - - - - - Gets the BorderBrush for IsChecked = false. - - - - - Sets the BorderBrush for IsChecked = false. - - - - - Gets the check BackgroundBrush for IsChecked = false. - - - - - Sets the BackgroundBrush for IsChecked = false. - - - - - Gets the check BorderBrush for IsChecked = false. - - - - - Sets the check BorderBrush for IsChecked = false. - - - - - Gets the check Foreground for IsChecked = false. - - - - - Sets the check Foreground for IsChecked = false. - - - - - Gets the Foreground for IsChecked = false, IsMouseOver = true. - - - - - Sets the Foreground for IsChecked = false, IsMouseOver = true. - - - - - Gets the Background for IsChecked = false, IsMouseOver = true. - - - - - Sets the Background for IsChecked = false, IsMouseOver = true. - - - - - Gets the BorderBrush for IsChecked = false, IsMouseOver = true. - - - - - Sets the BorderBrush for IsChecked = false, IsMouseOver = true. - - - - - Gets the check BackgroundBrush for IsChecked = false, IsMouseOver = true. - - - - - Sets the BackgroundBrush for IsChecked = false, IsMouseOver = true. - - - - - Gets the check BorderBrush for IsChecked = false, IsMouseOver = true. - - - - - Sets the check BorderBrush for IsChecked = false, IsMouseOver = true. - - - - - Gets the check Foreground for IsChecked = false, IsMouseOver = true. - - - - - Sets the check Foreground for IsChecked = false, IsMouseOver = true. - - - - - Gets the Foreground for IsChecked = false, IsPressed = true. - - - - - Sets the Foreground for IsChecked = false, IsPressed = true. - - - - - Gets the Background for IsChecked = false, IsPressed = true. - - - - - Sets the Background for IsChecked = false, IsPressed = true. - - - - - Gets the BorderBrush for IsChecked = false, IsPressed = true. - - - - - Sets the BorderBrush for IsChecked = false, IsPressed = true. - - - - - Gets the check BackgroundBrush for IsChecked = false, IsPressed = true. - - - - - Sets the BackgroundBrush for IsChecked = false, IsPressed = true. - - - - - Gets the check BorderBrush for IsChecked = false, IsPressed = true. - - - - - Sets the check BorderBrush for IsChecked = false, IsPressed = true. - - - - - Gets the check Foreground for IsChecked = false, IsPressed = true. - - - - - Sets the check Foreground for IsChecked = false, IsPressed = true. - - - - - Gets the Foreground for IsChecked = false, IsEnabled = false. - - - - - Sets the Foreground for IsChecked = false, IsEnabled = false. - - - - - Gets the Background for IsChecked = false, IsEnabled = false. - - - - - Sets the Background for IsChecked = false, IsEnabled = false. - - - - - Gets the BorderBrush for IsChecked = false, IsEnabled = false. - - - - - Sets the BorderBrush for IsChecked = false, IsEnabled = false. - - - - - Gets the check BackgroundBrush for IsChecked = false, IsEnabled = false. - - - - - Sets the BackgroundBrush for IsChecked = false, IsEnabled = false. - - - - - Gets the check BorderBrush for IsChecked = false, IsEnabled = false. - - - - - Sets the check BorderBrush for IsChecked = false, IsEnabled = false. - - - - - Gets the check Foreground for IsChecked = false, IsEnabled = false. - - - - - Sets the check Foreground for IsChecked = false, IsEnabled = false. - - - - - Gets the Glyph for IsChecked = true. - - - - - Sets the Glyph for IsChecked = true. - - - - - Gets the GlyphTemplate for IsChecked = true. - - - - - Sets the GlyphTemplate for IsChecked = true. - - - - - Gets the Foreground for IsChecked = true. - - - - - Sets the Foreground for IsChecked = true. - - - - - Gets the Background for IsChecked = true. - - - - - Sets the Background for IsChecked = true. - - - - - Gets the BorderBrush for IsChecked = true. - - - - - Sets the BorderBrush for IsChecked = true. - - - - - Gets the check Background for IsChecked = true. - - - - - Sets the check Background for IsChecked = true. - - - - - Gets the check BorderBrush for IsChecked = true. - - - - - Sets the check BorderBrush for IsChecked = true. - - - - - Gets the check glyph Foreground for IsChecked = true. - - - - - Sets the check glyph Foreground for IsChecked = true. - - - - - Gets the Foreground for IsChecked = true, IsMouseOver = true. - - - - - Sets the Foreground for IsChecked = true, IsMouseOver = true. - - - - - Gets the Background for IsChecked = true, IsMouseOver = true. - - - - - Sets the Background for IsChecked = true, IsMouseOver = true. - - - - - Gets the BorderBrush for IsChecked = true, IsMouseOver = true. - - - - - Sets the BorderBrush for IsChecked = true, IsMouseOver = true. - - - - - Gets the check Background for IsChecked = true, IsMouseOver = true. - - - - - Sets the check Background for IsChecked = true, IsMouseOver = true. - - - - - Gets the check BorderBrush for IsChecked = true, IsMouseOver = true. - - - - - Sets the check BorderBrush for IsChecked = true, IsMouseOver = true. - - - - - Gets the check glyph Foreground for IsChecked = true, IsMouseOver = true. - - - - - Sets the check glyph Foreground for IsChecked = true, IsMouseOver = true. - - - - - Gets the Foreground for IsChecked = true, IsPressed = true. - - - - - Sets the Foreground for IsChecked = true, IsPressed = true. - - - - - Gets the Background for IsChecked = true, IsPressed = true. - - - - - Sets the Background for IsChecked = true, IsPressed = true. - - - - - Gets the BorderBrush for IsChecked = true, IsPressed = true. - - - - - Sets the BorderBrush for IsChecked = true, IsPressed = true. - - - - - Gets the check Background for IsChecked = true, IsPressed = true. - - - - - Sets the check Background for IsChecked = true, IsPressed = true. - - - - - Gets the check BorderBrush for IsChecked = true, IsPressed = true. - - - - - Sets the check BorderBrush for IsChecked = true, IsPressed = true. - - - - - Gets the check glyph Foreground for IsChecked = true, IsPressed = true. - - - - - Sets the check glyph Foreground for IsChecked = true, IsPressed = true. - - - - - Gets the Foreground for IsChecked = true, IsEnabled = false. - - - - - Sets the Foreground for IsChecked = true, IsEnabled = false. - - - - - Gets the Background for IsChecked = true, IsEnabled = false. - - - - - Sets the Background for IsChecked = true, IsEnabled = false. - - - - - Gets the BorderBrush for IsChecked = true, IsEnabled = false. - - - - - Sets the BorderBrush for IsChecked = true, IsEnabled = false. - - - - - Gets the check Background for IsChecked = true, IsEnabled = false. - - - - - Sets the check Background for IsChecked = true, IsEnabled = false. - - - - - Gets the check BorderBrush for IsChecked = true, IsEnabled = false. - - - - - Sets the check BorderBrush for IsChecked = true, IsEnabled = false. - - - - - Gets the check glyph Foreground for IsChecked = true, IsEnabled = false. - - - - - Sets the check glyph Foreground for IsChecked = true, IsEnabled = false. - - - - - Gets the Glyph for IsChecked = null. - - - - - Sets the Glyph for IsChecked = null. - - - - - Gets the GlyphTemplate for IsChecked = null. - - - - - Sets the GlyphTemplate for IsChecked = null. - - - - - Gets the Foreground for IsChecked = null. - - - - - Sets the Foreground for IsChecked = null. - - - - - Gets the Background for IsChecked = null. - - - - - Sets the Background for IsChecked = null. - - - - - Gets the BorderBrush for IsChecked = null. - - - - - Sets the BorderBrush for IsChecked = null. - - - - - Gets the glyph BackgroundBrush for IsChecked = null. - - - - - Sets the glyph BackgroundBrush for IsChecked = null. - - - - - Gets the glyph BorderBrush for IsChecked = null. - - - - - Sets the glyph BorderBrush for IsChecked = null. - - - - - Gets the glyph Foreground for IsChecked = null. - - - - - Sets the glyph Foregorund for IsChecked = null. - - - - - Gets the Foreground for IsChecked = null, IsMouseOver = true. - - - - - Sets the Foreground for IsChecked = null, IsMouseOver = true. - - - - - Gets the Background for IsChecked = null, IsMouseOver = true. - - - - - Sets the Background for IsChecked = null, IsMouseOver = true. - - - - - Gets the BorderBrush for IsChecked = null, IsMouseOver = true. - - - - - Sets the BorderBrush for IsChecked = null, IsMouseOver = true. - - - - - Gets the glyph BackgroundBrush for IsChecked = null, IsMouseOver = true. - - - - - Sets the glyph BackgroundBrush for IsChecked = null, IsMouseOver = true. - - - - - Gets the glyph BorderBrush for IsChecked = null, IsMouseOver = true. - - - - - Sets the glyph BorderBrush for IsChecked = null, IsMouseOver = true. - - - - - Gets the glyph Foreground for IsChecked = null, IsMouseOver = true. - - - - - Sets the glyph Foregorund for IsChecked = null, IsMouseOver = true. - - - - - Gets the Foreground for IsChecked = null, IsPressed = true. - - - - - Sets the Foreground for IsChecked = null, IsPressed = true. - - - - - Gets the Background for IsChecked = null, IsPressed = true. - - - - - Sets the Background for IsChecked = null, IsPressed = true. - - - - - Gets the BorderBrush for IsChecked = null, IsPressed = true. - - - - - Sets the BorderBrush for IsChecked = null, IsPressed = true. - - - - - Gets the glyph BackgroundBrush for IsChecked = null, IsPressed = true. - - - - - Sets the glyph BackgroundBrush for IsChecked = null, IsPressed = true. - - - - - Gets the glyph BorderBrush for IsChecked = null, IsPressed = true. - - - - - Sets the glyph BorderBrush for IsChecked = null, IsPressed = true. - - - - - Gets the glyph Foreground for IsChecked = null, IsPressed = true. - - - - - Sets the glyph Foregorund for IsChecked = null, IsPressed = true. - - - - - Gets the Foreground for IsChecked = null, IsEnabled = false. - - - - - Sets the Foreground for IsChecked = null, IsEnabled = false. - - - - - Gets the Background for IsChecked = null, IsEnabled = false. - - - - - Sets the Background for IsChecked = null, IsEnabled = false. - - - - - Gets the BorderBrush for IsChecked = null, IsEnabled = false. - - - - - Sets the BorderBrush for IsChecked = null, IsEnabled = false. - - - - - Gets the glyph BackgroundBrush for IsChecked = null, IsEnabled = false. - - - - - Sets the glyph BackgroundBrush for IsChecked = null, IsEnabled = false. - - - - - Gets the glyph BorderBrush for IsChecked = null, IsEnabled = false. - - - - - Sets the glyph BorderBrush for IsChecked = null, IsEnabled = false. - - - - - Gets the glyph Foreground for IsChecked = null, IsEnabled = false. - - - - - Sets the glyph Foregorund for IsChecked = null, IsEnabled = false. - - - - - A helper class that provides various attached properties for the control. - - - - - Gets the Maximum number of characters the TextBox can accept. - - - - - Sets the Maximum number of characters the TextBox can accept. - - - - - Gets the Character casing of the TextBox. - - - - - Sets the Character casing of the TextBox. - - - - - A helper class that provides various controls. - - - - - Gets the value to handle the visibility of the DisabledVisualElement in the template. - - - - - Sets the value to handle the visibility of the DisabledVisualElement in the template. - - - - - The DependencyProperty for the CharacterCasing property. - Controls whether or not content is converted to upper or lower case - - - - - Gets the character casing of the control - - - - - Sets the character casing of the control - - - - - Gets the value if the inner ContentPresenter use AccessText in its style. - - - - - Sets the value if the inner ContentPresenter should use AccessText in its style. - - - - - Gets the brush used to draw the focus border. - - - - - Sets the brush used to draw the focus border. - - - - - Gets the brush used to draw the focus border. - - - - - Sets the brush used to draw the focus border. - - - - - Gets the brush used to draw the mouse over brush. - - - - - Sets the brush used to draw the mouse over brush. - - - - - DependencyProperty for property. - - - - - The CornerRadius property allows users to control the roundness of the button corners independently by - setting a radius value for each corner. Radius values that are too large are scaled so that they - smoothly blend from corner to corner. (Can be used e.g. at MetroButton style) - Description taken from original Microsoft description :-D - - - - - Gets or sets a value indicating whether the child contents of the control are not editable. - - - - - Gets a value indicating whether the child contents of the control are not editable. - - - - - Sets a value indicating whether the child contents of the control are not editable. - - - - - Attach this helper to the DataGrid. - - - - - - Detach the helper from the attached DataGrid - - - - - - - - - - - Sets binding from the source dependency property to the dependency property of the given target. - - The target object. - The target's dependency property. - The source object. - The dependency property of the source. - - - - Clears the binding from the source dependency property to the dependency property of the given target. - - The target object. - The target's dependency property. - The source object. - The dependency property of the source. - - - - Overriding classes should avoid returning 'this' as this would like result in in the method - - - - The DependencyProperty for the ' AutoGeneratedCheckBoxColumnStyle property. - - If a style is set, the DataGridCheckBoxColumn of the DataGrid will use this style for normal cells. - - - - - Helper for getting from . - - If a style is set, the DataGridCheckBoxColumn of the DataGrid will use this style for normal cells. - - to read from. - AutoGeneratedCheckBoxColumnStyle property value. - - - - Helper for setting on . - - If a style is set, the DataGridCheckBoxColumn of the DataGrid will use this style for normal cells. - - to set on. - AutoGeneratedCheckBoxColumnStyle property value. - - - - The DependencyProperty for the ' AutoGeneratedCheckBoxColumnEditingStyle property. - - If a style is set, the DataGridCheckBoxColumn of the DataGrid will use this style for cells in edit mode. - - - - - Helper for getting from . - - If a style is set, the DataGridCheckBoxColumn of the DataGrid will use this style for cells in edit mode. - - to read from. - AutoGeneratedCheckBoxColumnEditingStyle property value. - - - - Helper for setting on . - - If a style is set, the DataGridCheckBoxColumn of the DataGrid will use this style for cells in edit mode. - - to set on. - AutoGeneratedCheckBoxColumnEditingStyle property value. - - - - The DependencyProperty for the ' AutoGeneratedTextColumnStyle property. - - If a style is set, the DataGridTextColumn columns of the DataGrid will use this style for normal cells. - - - - - Helper for getting from . - - If a style is set, the DataGridTextColumn columns of the DataGrid will use this style for normal cells. - - to read from. - AutoGeneratedTextColumnStyle property value. - - - - Helper for setting on . - - If a style is set, the DataGridTextColumn columns of the DataGrid will use this style for normal cells. - - to set on. - AutoGeneratedTextColumnStyle property value. - - - - The DependencyProperty for the ' AutoGeneratedTextColumnEditingStyle property. - - If a style is set, the DataGridTextColumn of the DataGrid will use this style for cells in edit mode. - - - - - Helper for getting from . - - If a style is set, the DataGridTextColumn of the DataGrid will use this style for cells in edit mode. - - to read from. - AutoGeneratedTextColumnEditingStyle property value. - - - - Helper for setting on . - - If a style is set, the DataGridTextColumn of the DataGrid will use this style for cells in edit mode. - - to set on. - AutoGeneratedTextColumnEditingStyle property value. - - - - The DependencyProperty for the ' AutoGeneratedComboBoxColumnStyle property. - - If a style is set, the DataGridComboBoxColumn columns of the DataGrid will use this style for normal cells. - - - - - Helper for getting from . - - If a style is set, the DataGridComboBoxColumn columns of the DataGrid will use this style for normal cells. - - to read from. - AutoGeneratedComboBoxColumnStyle property value. - - - - Helper for setting on . - - If a style is set, the DataGridComboBoxColumn columns of the DataGrid will use this style for normal cells. - - to set on. - AutoGeneratedComboBoxColumnStyle property value. - - - - The DependencyProperty for the ' AutoGeneratedComboBoxColumnEditingStyle property. - - If a style is set, the DataGridComboBoxColumn of the DataGrid will use this style for cells in edit mode. - - - - - Helper for getting from . - - If a style is set, the DataGridComboBoxColumn of the DataGrid will use this style for cells in edit mode. - - to read from. - AutoGeneratedComboBoxColumnEditingStyle property value. - - - - Helper for setting on . - - If a style is set, the DataGridComboBoxColumn of the DataGrid will use this style for cells in edit mode. - - to set on. - AutoGeneratedComboBoxColumnEditingStyle property value. - - - - The DependencyProperty for the ' AutoGeneratedNumericUpDownColumnStyle property. - - If a style is set, the DataGridNumericUpDownColumn columns of the DataGrid will use this style for normal cells. - - - - - Helper for getting from . - - If a style is set, the DataGridNumericUpDownColumn columns of the DataGrid will use this style for normal cells. - - to read from. - AutoGeneratedNumericUpDownColumnStyle property value. - - - - Helper for setting on . - - If a style is set, the DataGridNumericUpDownColumn columns of the DataGrid will use this style for normal cells. - - to set on. - AutoGeneratedNumericUpDownColumnStyle property value. - - - - The DependencyProperty for the ' AutoGeneratedNumericUpDownColumnEditingStyle property. - - If a style is set, the DataGridNumericUpDownColumn of the DataGrid will use this style for cells in edit mode. - - - - - Helper for getting from . - - If a style is set, the DataGridNumericUpDownColumn of the DataGrid will use this style for cells in edit mode. - - to read from. - AutoGeneratedNumericUpDownColumnEditingStyle property value. - - - - Helper for setting on . - - If a style is set, the DataGridNumericUpDownColumn of the DataGrid will use this style for cells in edit mode. - - to set on. - AutoGeneratedNumericUpDownColumnEditingStyle property value. - - - - The DependencyProperty for the ' AutoGeneratedHyperlinkColumnStyle property. - - If a style is set, the DataGridHyperlinkColumn columns of the DataGrid will use this style for normal cells. - - - - - Helper for getting from . - - If a style is set, the DataGridHyperlinkColumn columns of the DataGrid will use this style for normal cells. - - to read from. - AutoGeneratedHyperlinkColumnStyle property value. - - - - Helper for setting on . - - If a style is set, the DataGridHyperlinkColumn columns of the DataGrid will use this style for normal cells. - - to set on. - AutoGeneratedHyperlinkColumnStyle property value. - - - - The DependencyProperty for the ' AutoGeneratedHyperlinkColumnEditingStyle property. - - If a style is set, the DataGridHyperlinkColumn of the DataGrid will use this style for cells in edit mode. - - - - - Helper for getting from . - - If a style is set, the DataGridHyperlinkColumn of the DataGrid will use this style for cells in edit mode. - - to read from. - AutoGeneratedHyperlinkColumnEditingStyle property value. - - - - Helper for setting on . - - If a style is set, the DataGridHyperlinkColumn of the DataGrid will use this style for cells in edit mode. - - to set on. - AutoGeneratedHyperlinkColumnEditingStyle property value. - - - - Gets the padding inside the cell. - - - - - Sets the padding inside the cell. - - - - - Gets the padding inside the column. - - - - - Sets the padding inside the column. - - - - - Gets a value which indicates the preview cell editing is enabled or not. - - - - - Sets a value which indicates the preview cell editing is enabled or not. - - - - - Gets the value to define the selection behavior. - - - - - Sets the value to define the selection behavior. - - - - - The DependencyProperty for the ' ColumnStylesHelper property. - - If the helper is set, the columns of the DataGrid will use the styles for the columns from the ' attached properties. - - - - - Helper for getting from . - - If the helper is set, the columns of the DataGrid will use the styles for the columns from the ' attached properties. - - to read from. - ColumnStylesHelper property value. - - - - Helper for setting from . - - If the helper is set, the columns of the DataGrid will use the styles for the columns from the ' attached properties. - - to set on. - ColumnStylesHelper property value. - - - - Gets the content of the DropDown Button. - - - - - Sets the content of the DropDown Button. - - - - - Gets the data template used to display the content of the DropDown Button. - - - - - Sets the data template used to display the content of the DropDown Button. - - - - - Gets the font family of the desired font. - - - - - Sets the font family of the desired font. - - - - - Gets the size of the desired font. - - - - - Sets the size of the desired font. - - - - - A helper class that provides various attached properties for the Expander control. - - - - - - Gets the toggle button style used for the ExpandDirection Up. - - - - - Sets the toggle button style used for the ExpandDirection Up. - - - - - Gets the toggle button style used for the ExpandDirection Down. - - - - - Sets the toggle button style used for the ExpandDirection Down. - - - - - Gets the toggle button style used for the ExpandDirection Left. - - - - - Sets the toggle button style used for the ExpandDirection Left. - - - - - Gets the toggle button style used for the ExpandDirection Right. - - - - - Sets the toggle button style used for the ExpandDirection Right. - - - - - The DependencyProperty for the ' ExpandStoryboard property. - - If the Storyboard is set, the expanded event applies this to the inner grid. - - - - - Helper for getting from . - - If the Storyboard is set, the expanded event applies this to the inner grid. - - to read from. - ExpandStoryboard property value. - - - - Helper for setting on . - - If the Storyboard is set, the expanded event applies this to the inner grid. - - to set on. - ExpandStoryboard property value. - - - - The DependencyProperty for the ' CollapseStoryboard property. - - If the Storyboard is set, the collapsed event applies this to the inner grid. - - - - - Helper for getting from . - - If the Storyboard is set, the collapsed event applies this to the inner grid. - - to read from. - CollapseStoryboard property value. - - - - Helper for setting on . - - If the Storyboard is set, the collapsed event applies this to the inner grid. - - to set on. - CollapseStoryboard property value. - - - - Gets the value of the Foreground for the header. - - - - - Sets the value of the Foreground for the header. - - - - - Gets the value of the Background for the header. - - - - - Sets the value of the Background for the header. - - - - - Gets the value of the FontFamily for the header. - - - - - Sets the value of the FontFamily for the header. - - - - - Gets the value of the FontSize for the header. - - - - - Sets the value of the FontSize for the header. - - - - - Gets the value of the FontStretch for the header. - - - - - Sets the value of the FontStretch for the header. - - - - - Gets the value of the FontWeight for the header. - - - - - Sets the value of the FontWeight for the header. - - - - - Gets or sets the outer margin for the header. - - - - - Sets or sets the outer margin for the header. - - - - - Gets the horizontal alignment of the header. - - - - - Sets the horizontal alignment of the header. - - - - - Gets the vertical alignment of the header. - - - - - Sets the vertical alignment of the header. - - - - - Gets or sets the background brush which will be used for the active selected item (if the keyboard focus is within). - - - - - Gets the brush the background brush which will be used for the active selected item (if the keyboard focus is within). - - - - - Sets the brush the background brush which will be used for the active selected item (if the keyboard focus is within). - - - - - Gets or sets the foreground brush which will be used for the active selected item (if the keyboard focus is within). - - - - - Gets the brush the foreground brush which will be used for the active selected item (if the keyboard focus is within). - - - - - Sets the brush the foreground brush which will be used for the active selected item (if the keyboard focus is within). - - - - - Gets or sets the background brush which will be used for a selected item. - - - - - Gets the background brush which will be used for a selected item. - - - - - Sets the background brush which will be used for a selected item. - - - - - Gets or sets the foreground brush which will be used for a selected item. - - - - - Gets the foreground brush which will be used for a selected item. - - - - - Sets the foreground brush which will be used for a selected item. - - - - - Gets or sets the background brush which will be used for an mouse hovered item. - - - - - Gets the background brush which will be used for an mouse hovered item. - - - - - Sets the background brush which will be used for an mouse hovered item. - - - - - Gets or sets the foreground brush which will be used for an mouse hovered item. - - - - - Gets the foreground brush which will be used for an mouse hovered item. - - - - - Sets the foreground brush which will be used for an mouse hovered item. - - - - - Gets or sets the background brush which will be used for an mouse hovered and selected item. - - - - - Gets the background brush which will be used for an mouse hovered and selected item. - - - - - Sets the background brush which will be used for an mouse hovered and selected item. - - - - - Gets or sets the foreground brush which will be used for an mouse hovered and selected item. - - - - - Gets the foreground brush which will be used for an mouse hovered and selected item. - - - - - Sets the foreground brush which will be used for an mouse hovered and selected item. - - - - - Gets or sets the background brush which will be used for selected disabled items. - - - - - Gets the background brush which will be used for selected disabled items. - - - - - Sets the background brush which will be used for selected disabled items. - - - - - Gets or sets the foreground brush which will be used for selected disabled items. - - - - - Gets the foreground brush which will be used for selected disabled items. - - - - - Sets the foreground brush which will be used for selected disabled items. - - - - - Gets or sets the background brush which will be used for disabled items. - - - - - Gets the background brush which will be used for disabled items. - - - - - Sets the background brush which will be used for disabled items. - - - - - Gets or sets the foreground brush which will be used for disabled items. - - - - - Gets the foreground brush which will be used for disabled items. - - - - - Sets the foreground brush which will be used for disabled items. - - - - - Gets or sets the background brush which will be used when an item is pressed by the left mouse button. - - - - - Gets the background brush which will be used when an item is pressed by the left mouse button. - - - - - Sets the background brush which will be used when an item is pressed by the left mouse button. - - - - - Gets or sets the foreground brush which will be used when an item is pressed by the left mouse button. - - - - - Gets the foreground brush which will be used when an item is pressed by the left mouse button. - - - - - Sets the foreground brush which will be used when an item is pressed by the left mouse button. - - - - - Gets or sets the background brush which will be used when an item is pressed by the right mouse button. - - - - - Gets the background brush which will be used when an item is pressed by the right mouse button. - - - - - Sets the background brush which will be used when an item is pressed by the right mouse button. - - - - - Gets or sets the foreground brush which will be used when an item is pressed by the right mouse button. - - - - - Gets the foreground brush which will be used when an item is pressed by the right mouse button. - - - - - Sets the foreground brush which will be used when an item is pressed by the right mouse button. - - - - - Change the value of the slider if the user rotates the mouse wheel by the value defined for - - - - - Change the value of the slider if the user rotates the mouse wheel by the value defined for - - - - - Do not change the value of the slider if the user rotates the mouse wheel. - - - - - Change the value of the slider only if the control is focused. - - - - - Changes the value of the slider if the mouse pointer is over this element. - - - - - Defines a helper class for selected items binding on collections with multiselector elements - - - - - Handles disposal and creation of old and new bindings - - - - - Gets the selected items property binding - - - - - Sets the selected items property binding - - - - - Gets the for a binding - - - - - Sets the for a bining - - - - - Defines a binding between multi selector and property - - - - - Creates an instance of - - The selector of this binding - The bound collection - - - - Registers the event handlers for selector and collection changes - - - - - Unregisters the event handlers for selector and collection changes - - - - - Updates the collection with changes made in the selector - - - - - Updates the selector with changes made in the collection - - - - - Gets the content of the RevealButton. - - - - - Sets the content of the RevealButton. - - - - - Gets the data template used to display the content of the RevealButton. - - - - - Sets the data template used to display the content of the RevealButton. - - - - Helper for getting from . - to read from. - RadioSize property value. - - - Helper for setting on . - to set on. - RadioSize property value. - - - Helper for getting from . - to read from. - RadioCheckSize property value. - - - Helper for setting on . - to set on. - RadioCheckSize property value. - - - Helper for getting from . - to read from. - RadioStrokeThickness property value. - - - Helper for setting on . - to set on. - RadioStrokeThickness property value. - - - Helper for getting from . - to read from. - ForegroundPointerOver property value. - - - Helper for setting on . - to set on. - ForegroundPointerOver property value. - - - Helper for getting from . - to read from. - ForegroundPressed property value. - - - Helper for setting on . - to set on. - ForegroundPressed property value. - - - Helper for getting from . - to read from. - ForegroundDisabled property value. - - - Helper for setting on . - to set on. - ForegroundDisabled property value. - - - Helper for getting from . - to read from. - BackgroundPointerOver property value. - - - Helper for setting on . - to set on. - BackgroundPointerOver property value. - - - Helper for getting from . - to read from. - BackgroundPressed property value. - - - Helper for setting on . - to set on. - BackgroundPressed property value. - - - Helper for getting from . - to read from. - BackgroundDisabled property value. - - - Helper for setting on . - to set on. - BackgroundDisabled property value. - - - Helper for getting from . - to read from. - BorderBrushPointerOver property value. - - - Helper for setting on . - to set on. - BorderBrushPointerOver property value. - - - Helper for getting from . - to read from. - BorderBrushPressed property value. - - - Helper for setting on . - to set on. - BorderBrushPressed property value. - - - Helper for getting from . - to read from. - BorderBrushDisabled property value. - - - Helper for setting on . - to set on. - BorderBrushDisabled property value. - - - Helper for getting from . - to read from. - OuterEllipseFill property value. - - - Helper for setting on . - to set on. - OuterEllipseFill property value. - - - Helper for getting from . - to read from. - OuterEllipseFillPointerOver property value. - - - Helper for setting on . - to set on. - OuterEllipseFillPointerOver property value. - - - Helper for getting from . - to read from. - OuterEllipseFillPressed property value. - - - Helper for setting on . - to set on. - OuterEllipseFillPressed property value. - - - Helper for getting from . - to read from. - OuterEllipseFillDisabled property value. - - - Helper for setting on . - to set on. - OuterEllipseFillDisabled property value. - - - Helper for getting from . - to read from. - OuterEllipseStroke property value. - - - Helper for setting on . - to set on. - OuterEllipseStroke property value. - - - Helper for getting from . - to read from. - OuterEllipseStrokePointerOver property value. - - - Helper for setting on . - to set on. - OuterEllipseStrokePointerOver property value. - - - Helper for getting from . - to read from. - OuterEllipseStrokePressed property value. - - - Helper for setting on . - to set on. - OuterEllipseStrokePressed property value. - - - Helper for getting from . - to read from. - OuterEllipseStrokeDisabled property value. - - - Helper for setting on . - to set on. - OuterEllipseStrokeDisabled property value. - - - Helper for getting from . - to read from. - OuterEllipseCheckedFill property value. - - - Helper for setting on . - to set on. - OuterEllipseCheckedFill property value. - - - Helper for getting from . - to read from. - OuterEllipseCheckedFillPointerOver property value. - - - Helper for setting on . - to set on. - OuterEllipseCheckedFillPointerOver property value. - - - Helper for getting from . - to read from. - OuterEllipseCheckedFillPressed property value. - - - Helper for setting on . - to set on. - OuterEllipseCheckedFillPressed property value. - - - Helper for getting from . - to read from. - OuterEllipseCheckedFillDisabled property value. - - - Helper for setting on . - to set on. - OuterEllipseCheckedFillDisabled property value. - - - Helper for getting from . - to read from. - OuterEllipseCheckedStroke property value. - - - Helper for setting on . - to set on. - OuterEllipseCheckedStroke property value. - - - Helper for getting from . - to read from. - OuterEllipseCheckedStrokePointerOver property value. - - - Helper for setting on . - to set on. - OuterEllipseCheckedStrokePointerOver property value. - - - Helper for getting from . - to read from. - OuterEllipseCheckedStrokePressed property value. - - - Helper for setting on . - to set on. - OuterEllipseCheckedStrokePressed property value. - - - Helper for getting from . - to read from. - OuterEllipseCheckedStrokeDisabled property value. - - - Helper for setting on . - to set on. - OuterEllipseCheckedStrokeDisabled property value. - - - Helper for getting from . - to read from. - CheckGlyphFill property value. - - - Helper for setting on . - to set on. - CheckGlyphFill property value. - - - Helper for getting from . - to read from. - CheckGlyphFillPointerOver property value. - - - Helper for setting on . - to set on. - CheckGlyphFillPointerOver property value. - - - Helper for getting from . - to read from. - CheckGlyphFillPressed property value. - - - Helper for setting on . - to set on. - CheckGlyphFillPressed property value. - - - Helper for getting from . - to read from. - CheckGlyphFillDisabled property value. - - - Helper for setting on . - to set on. - CheckGlyphFillDisabled property value. - - - Helper for getting from . - to read from. - CheckGlyphStroke property value. - - - Helper for setting on . - to set on. - CheckGlyphStroke property value. - - - Helper for getting from . - to read from. - CheckGlyphStrokePointerOver property value. - - - Helper for setting on . - to set on. - CheckGlyphStrokePointerOver property value. - - - Helper for getting from . - to read from. - CheckGlyphStrokePressed property value. - - - Helper for setting on . - to set on. - CheckGlyphStrokePressed property value. - - - Helper for getting from . - to read from. - CheckGlyphStrokeDisabled property value. - - - Helper for setting on . - to set on. - CheckGlyphStrokeDisabled property value. - - - - Identifies the VerticalScrollBarOnLeftSide attached property. - This property can be used to set vertical scrollbar left side from the tabpanel (look at MetroAnimatedSingleRowTabControl) - - - - Helper for getting from . - to read from. - VerticalScrollBarOnLeftSide property value. - - - Helper for setting on . - to set on. - VerticalScrollBarOnLeftSide property value. - - - - Identifies the IsHorizontalScrollWheelEnabled attached property. - - - - Helper for getting from . - to read from. - IsHorizontalScrollWheelEnabled property value. - - - Helper for setting on . - to set on. - IsHorizontalScrollWheelEnabled property value. - - - - This property can be used to trigger the call to a command when the user reach the end of the vertical scrollable area. - - - - Helper for getting from . - to read from. - EndOfVerticalScrollReachedCommand property value. - - - Helper for setting on . - to set on. - EndOfVerticalScrollReachedCommand property value. - - - - This property can be used to trigger the call to a command when the user reach the end of the horizontal scrollable area. - - - - Helper for getting from . - to read from. - EndOfHorizontalScrollReachedCommand property value. - - - Helper for setting on . - to set on. - EndOfHorizontalScrollReachedCommand property value. - - - - This property can be used to provide a command parameter to the command called when reaching the end of the vertical or horizontal scrollable area. - - - - Helper for getting from . - to read from. - EndOfScrollReachedCommandParameter property value. - - - Helper for setting on . - to set on. - EndOfScrollReachedCommandParameter property value. - - - Helper for getting on . - to get on. - - - Helper for setting on . - to set on. - BubbleUpScrollEventToParentScrollviewerProperty property value. - - - - Gets or sets the brush of the thumb. - - - - - Gets the brush of the thumb. - - - - - Sets the brush of the thumb. - - - - - Gets or sets the brush of the thumb if the mouse is over the slider. - - - - - Gets the brush of the thumb if the mouse is over the slider. - - - - - Sets the brush of the thumb if the mouse is over the slider. - - - - - Gets or sets the brush of the thumb if the mouse button is pressed. - - - - - Gets the brush of the thumb if the mouse button is pressed. - - - - - Sets the brush of the thumb if the mouse button is pressed. - - - - - Gets or sets the brush of the thumb if the slider is disabled. - - - - - Gets the brush of the thumb if the slider is disabled. - - - - - Sets the brush of the thumb if the slider is disabled. - - - - - Gets or sets the brush of the track. - - - - - Gets the brush of the track. - - - - - Sets the brush of the track. - - - - - Gets or sets the brush of the track if the mouse is over the slider. - - - - - Gets the brush of the track if the mouse is over the slider. - - - - - Sets the brush of the track if the mouse is over the slider. - - - - - Gets or sets the brush of the track if the mouse button is pressed. - - - - - Gets the brush of the track if the mouse button is pressed. - - - - - Sets the brush of the track if the mouse button is pressed. - - - - - Gets or sets the brush of the track if the slider is disabled. - - - - - Gets the brush of the track if the slider is disabled. - - - - - Sets the brush of the track if the slider is disabled. - - - - - Gets or sets the brush of the track value. - - - - - Gets the brush of the track value. - - - - - Sets the brush of the track value. - - - - - Gets or sets the brush of the track value if the mouse is over the slider. - - - - - Gets the brush of the track value if the mouse is over the slider. - - - - - Sets the brush of the track value if the mouse is over the slider. - - - - - Gets or sets the brush of the track value if the mouse button is pressed. - - - - - Gets the brush of the track value if the mouse button is pressed. - - - - - Sets the brush of the track value if the mouse button is pressed. - - - - - Gets or sets the brush of the track value if the slider is disabled. - - - - - Gets the brush of the track value if the slider is disabled. - - - - - Sets the brush of the track value if the slider is disabled. - - - - - Gets/Sets the type how the value will be changed if the user rotates the mouse wheel. - - - - - Gets/Sets the type how the value will be changed if the user rotates the mouse wheel. - - - - - Gets/Sets the value when the slider will be changed. Possible values are if the slider is focused or if the mouse is over the slider. - - - - - Gets/Sets the value when the slider will be changed. Possible values are if the slider is focused or if the mouse is over the slider. - - - - - Specifies the underline position of a TabControl. - - - - Sets the Style and Template property to null. - - Removing a TabItem in code behind can produce such nasty output - System.Windows.Data Warning: 4 : Cannot find source for binding with reference 'RelativeSource FindAncestor, AncestorType='System.Windows.Controls.TabControl', AncestorLevel='1''. BindingExpression:Path=Background; DataItem=null; target element is 'TabItem' (Name=''); target property is 'Background' (type 'Brush') - or - System.Windows.Data Error: 4 : Cannot find source for binding with reference 'RelativeSource FindAncestor, AncestorType='System.Windows.Controls.TabControl', AncestorLevel='1''. BindingExpression:Path=(0); DataItem=null; target element is 'TabItem' (Name=''); target property is 'UnderlineBrush' (type 'Brush') - - This is a timing problem in WPF of the binding mechanism itself. - - To avoid this, we can set the Style and Template to null. - - - - Identifies the CloseButtonEnabled attached property. - - - - - Gets whether a close button should be visible or not. - - - - - Sets whether a close button should be visible or not. - - - - - Identifies the CloseTabCommand attached property. - - - - - Gets a command for the TabItem which executes if the TabItem will be closed. - - - - - Sets a command for the TabItem which executes if the TabItem will be closed. - - - - - Identifies the CloseTabCommandParameter attached property. - - - - - Gets a command parameter for the TabItem that will be passed to the CloseTabCommand. - - - - - Sets a command parameter for the TabItem that will be passed to the CloseTabCommand. - - - - - Defines whether the underline below the or is shown or not. - - - - - Defines the underline brush below the or . - - - - - Defines the underline brush below the or of an selected item. - - - - - Defines the underline brush below the or if the mouse is over an item. - - - - - Defines the underline brush below the or if the mouse is over a selected item. - - - - - This property can be used to set the Transition for animated TabControls - - - - - Defines the position of the Underline - - - - - A helper class that provides various attached properties for the TextBox control. - - - Password watermarking code from: http://prabu-guru.blogspot.com/2010/06/how-to-add-watermark-text-to-textbox.html - - - - - The clear text button behavior property. It sets a click event to the button if the value is true. - - - - - This property can be used to set the button width (PART_ClearText) of TextBox, PasswordBox, ComboBox, NumericUpDown - - - - - This property can be used to retrieve the watermark using the of bound property. - - - Setting this property to true will uses reflection. - - - - - Indicates if a TextBox or RichTextBox should use SpellCheck context menu - - - - - Indicates if the watermark is automatically retrieved by using the of the bound property. - - This attached property uses reflection; thus it might reduce the performance of the application. - The auto-watermak does work for the following controls: - In the following case no custom watermark is shown - - There is no binding - Binding path errors - Binding to a element of a collection without using a property of that element Binding Path=Collection[0] use: Binding Path=Collection[0].SubProperty - The bound property does not have a - - - - - Gets a value that indicates the horizontal alignment of the watermark. - - - One of the values that specifies the desired alignment. The default is . - - - - - Sets a value that indicates the horizontal alignment of the watermark. - - - - - Gets the text trimming behavior to employ when watermark overflows the content area. - - - One of the values that specifies the text trimming behavior to employ. The default is . - - - - - Sets the text trimming behavior to employ when watermark overflows the content area. - - - - - Gets how the watermark should wrap text. - - One of the values. The default is . - - - - - Sets how the watermark should wrap text. - - - - - Gets if the attached TextBox has text. - - - - - Gets the clear text button visibility / feature. Can be used to enable text deletion. - - - - - Sets the clear text button visibility / feature. Can be used to enable text deletion. - - - - - Gets the text button visibility. - - - - - Sets the text button visibility. - - - - - Gets the buttons placement variant. - - - - - Sets the buttons placement variant. - - - - - Gets the clear text button behavior. - - - - - Sets the clear text button behavior. - - - - - ButtonContentTemplate is the template used to display the content of the ClearText button. - - - - - This property can be used to handle the style for CheckBox and RadioButton - LeftToRight means content left and button right and RightToLeft vise versa - - - - - This property can be used to handle the style for CheckBox and RadioButton - LeftToRight means content left and button right and RightToLeft vise versa - - - - - Gets the toggle button style used for the TreeViewItem expander. - - - - - Sets the toggle button style used for the TreeViewItem expander. - - - - - Identifies the CloseOnMouseLeftButtonDown attached property. - - - - - Gets whether if the popup can be closed by left mouse button down. - - - - - Sets whether if the popup can be closed by left mouse button down. - - - - - Identifies the ShowValidationErrorOnMouseOver attached property. - - - - - Gets whether the validation error text will be shown when hovering the validation triangle. - - - - - Sets whether the validation error text will be shown when hovering the validation triangle. - - - - - Represents the base class for an icon UI element. - - - - - A MetroTabControl (Pivot) that wraps TabItem/MetroTabItem headers on a single row. - - - - - Initializes a new instance of the MahApps.Metro.Controls.MetroAnimatedSingleRowTabControl class. - - - - - A MetroTabControl (Pivot) that uses a TransitioningContentControl to animate the contents of a TabItem/MetroTabItem. - - - - - Initializes a new instance of the MahApps.Metro.Controls.MetroAnimatedTabControl class. - - - - - A ContentControl which use a transition to slide in the content. - - - - Identifies the dependency property. - - - - Gets or sets whether the reverse version of the transition should be used. - - - - Identifies the dependency property. - - - - Gets or sets the value if a transition should be used or not. - - - - Identifies the dependency property. - - - - Gets or sets whether the transition should be used only at the loaded event of the control. - - - - Identifies the routed event. - - - - The event which will be fired when the transition starts. - - - - Identifies the routed event. - - - - The event which will be fired when the transition ends. - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - Gets whether if the content is transitioning. - - - - - Execute the transition again. - - - - - - - - Creates AutomationPeer () - - - - - A reimplementation of NavigationWindow based on MetroWindow. - - - - MetroNavigationWindow - - - - - Gets an IEnumerable that you use to enumerate the entries in back navigation history for a NavigationWindow. - - - - - - Gets an IEnumerable that you use to enumerate the entries in back navigation history for a NavigationWindow. - - - - - - Gets the NavigationService that is used by this MetroNavigationWindow to provide navigation services to its content. - - - - - - Gets a value that indicates whether there is at least one entry in back navigation history. - - - - - - Gets a value that indicates whether there is at least one entry in forward navigation history. - - - - - - Gets or sets the base uniform resource identifier (URI) of the current context. - - - - - - Gets or sets the uniform resource identifier (URI) of the current content, or the URI of new content that is currently being navigated to. - - - - - - Adds an entry to back navigation history that contains a CustomContentState object. - - A CustomContentState object that represents application-defined state that is associated with a specific piece of content. - - - - - Removes the most recent journal entry from back history. - - The most recent JournalEntry in back navigation history, if there is one. - - - - - Navigates to the most recent item in back navigation history. - - - - - - Navigates to the most recent item in forward navigation history. - - - - - - Navigates asynchronously to content that is contained by an object. - - An Object that contains the content to navigate to. - true if a navigation is not canceled; otherwise, false. - - - - - Navigates asynchronously to content that is specified by a uniform resource identifier (URI). - - A Uri object initialized with the URI for the desired content. - true if a navigation is not canceled; otherwise, false. - - - - - Navigates asynchronously to content that is contained by an object, and passes an object that contains data to be used for processing during navigation. - - An Object that contains the content to navigate to. - A Object that contains data to be used for processing during navigation. - true if a navigation is not canceled; otherwise, false. - - - - - Navigates asynchronously to source content located at a uniform resource identifier (URI), and pass an object that contains data to be used for processing during navigation. - - A Uri object initialized with the URI for the desired content. - A Object that contains data to be used for processing during navigation. - true if a navigation is not canceled; otherwise, false. - - - - - Stops further downloading of content for the current navigation request. - - - - - - Occurs when navigation to a content fragment begins, which occurs immediately, if the desired fragment is in the current content, or after the source XAML content has been loaded, if the desired fragment is in different content. - - - - - - Occurs when a new navigation is requested. - - - - - - Occurs when an error is raised while navigating to the requested content. - - - - - - Occurs periodically during a download to provide navigation progress information. - - - - - - Occurs when the StopLoading method is called, or when a new navigation is requested while a current navigation is in progre - - - - - - Occurs when the content that is being navigated to has been found, and is available from the PageContent property, although it may not have completed loading - - - - - - Occurs when content that was navigated to has been loaded, parsed, and has begun rendering. - - - - - - InitializeComponent - - - - - A metrofied ProgressBar. - - - - - - Gets/sets the diameter of the ellipses used in the indeterminate animation. - - - - - Gets/sets the offset of the ellipses used in the indeterminate animation. - - - - - A standard MetroTabControl (Pivot). - - - - - Initializes a new instance of the MahApps.Metro.Controls.MetroTabControl class. - - - - Identifies the dependency property. - - - - A base class for every MetroTabControl (Pivot). - - - - - Get/sets the command that executes when a MetroTabItem's close button is clicked. - - - - - An event that is raised when a TabItem is closed. - - - - - Event args that is created when a TabItem is closed. - - - - - Gets the MetroTabItem that will be closed. - - - - - An extended TabItem with a metro style. - - - - - Gets/sets whether the Close Button is visible. - - - - - Gets/sets the command that is executed when the Close Button is clicked. - - - - - Gets/sets the command parameter which is passed to the close button command. - - - - - Gets/sets the Close Button Margin. - - - - - The MetroThumbContentControl control can be used for titles or something else and enables basic drag movement functionality. - - - - - Adds or remove a DragStartedEvent handler - - - - - Adds or remove a DragDeltaEvent handler - - - - - Adds or remove a DragCompletedEvent handler - - - - - DependencyProperty for the IsDragging property. - - - - - Indicates that the left mouse button is pressed and is over the MetroThumbContentControl. - - - - - An extended, metrofied Window class. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Allows easy handling of window commands brush. Theme is also applied based on this brush. - - - - - Gets/sets whether the window's entrance transition animation is enabled. - - - - - Gets/sets the FlyoutsControl that hosts the window's flyouts. - - - - - Gets/sets the icon content template to show a custom icon. - - - - - Gets/sets the title content template to show a custom title. - - - - - Gets/sets the left window commands that hosts the user commands. - - - - - Gets/sets the right window commands that hosts the user commands. - - - - - Gets/sets the window button commands that hosts the min/max/close commands. - - - - - Defines if the Taskbar should be ignored when maximizing a Window. - This only works with WindowStyle = None. - - - - - Identifies the dependency property. - - - - - Gets or sets resize border thickness. This enables animation, styling, binding, etc... - - - - - for . - - - - - Gets/sets if the border thickness value should be kept on maximize - if the MaxHeight/MaxWidth of the window is less than the monitor resolution. - - - - - for . - - - - - Gets or sets wether the resizing of the window should be tried in a way that does not cause flicker/jitter, especially when resizing from the left side. - - - Please note that setting this to true may cause resize lag and black areas appearing on some systems. - - - - - for . - - - - - Gets/sets the brush used for the titlebar's foreground. - - - - - Gets/sets whether the window will save it's position between loads. - - - - - Gets the window placement settings (can be overwritten). - - - - - Get/sets whether the titlebar icon is visible or not. - - - - - Get/sets whether dialogs show over the title bar. - - - - - Gets whether one or more dialogs are shown. - - - - - Gets/sets edge mode of the titlebar icon. - - - - - Gets/sets bitmap scaling mode of the titlebar icon. - - - - - Gets/sets icon scaling mode of the titlebar. - - - - - Gets/sets whether the TitleBar is visible or not. - - - - - Gets/sets whether the WindowStyle is None or not. - - - - - Gets or sets whether if the minimize button is visible and the minimize system menu is enabled. - - - - - Gets or sets whether if the maximize/restore button is visible and the maximize/restore system menu is enabled. - - - - - Gets or sets whether if the close button is visible. - - - - - Gets/sets if the min button is enabled. - - - - - Gets/sets if the max/restore button is enabled. - - - - - Gets/sets if the close button is enabled. - - - - - Gets or sets whether if the close button should be enabled or not if a dialog is shown. - - - - - Gets or sets a value that indicates whether the system menu should popup with left mouse click on the window icon. - - - - - Gets or sets a value that indicates whether the system menu should popup with right mouse click if the mouse position is on title bar or on the entire window if it has no title bar (and no title bar height). - - - - - Gets/sets the TitleBar's height. - - - - - Character casing of the title - - - - - Gets/sets the title horizontal alignment. - - - - - Gets/sets the brush used for the Window's title bar. - - - - - Gets/sets the brush used for the Window's glow. - - - - - Gets/sets the brush used for the Window's non-active glow. - - - - - Gets/sets the brush used for the Window's non-active border. - - - - - Gets/sets the brush used for the Window's non-active title bar. - - - - - Gets/sets the brush used for the dialog overlay. - - - - - Gets/sets the opacity used for the dialog overlay. - - - - - Gets or sets the brush used for the Flyouts overlay. - - - - - Gets or sets the overlay fade in storyboard. - - - - - Gets or sets the overlay fade out storyboard. - - - - - Begins to show the MetroWindow's overlay effect. - - A task representing the process. - - - - Begins to hide the MetroWindow's overlay effect. - - A task representing the process. - - - - Stores the given element, or the last focused element via FocusManager, for restoring the focus after closing a dialog. - - The element which will be focused again. - - - - Clears the stored element which would get the focus after closing a dialog. - - - - - Initializes a new instance of the MahApps.Metro.Controls.MetroWindow class. - - - - - Initializes various behaviors for the window. - For example , and . - - - - - - - - Creates AutomationPeer () - - - - - Gets the template child with the given name. - - The interface type inheirted from DependencyObject. - The name of the template child. - - - - Gets the template child with the given name. - - The name of the template child. - - - - This class eats little children. - - - - - Sets the IsHitTestVisibleInChromeProperty to a MetroWindow template child - - The MetroWindow. - The name of the template child. - - - - - Sets the WindowChrome ResizeGripDirection to a MetroWindow template child. - - The MetroWindow. - The name of the template child. - The direction. - - - - Adapts the WindowCommands to the theme of the first opened, topmost && (top || right || left) flyout - - The MetroWindow - All the flyouts! Or flyouts that fall into the category described in the summary. - - - - For specifying where the navigation index is placed relative to the . - - - - - Index on left side - - - - - Index on right side - - - - - Index on top side - - - - - Index on bottom side - - - - - Index on left side over the item - - - - - Index on right side over the item - - - - - Index on top side over the item - - - - - Index on bottom side over the item - - - - - Enum NumericInput which indicates what input is allowed for NumericUpdDown. - - - - - Only numbers are allowed - - - - - Numbers with decimal point and allowed scientific input - - - - - All is allowed - - - - - Represents a Windows spin box (also known as an up-down control) that displays numeric values. - - - - Identifies the routed event. - - - - Add / Remove ValueIncrementedEvent handler - Event which will be fired from this NumericUpDown when its value was incremented. - - - - Identifies the routed event. - - - - Add / Remove ValueDecrementedEvent handler - Event which will be fired from this NumericUpDown when its value was decremented. - - - - Identifies the routed event. - - - - Add / Remove DelayChangedEvent handler - Event which will be fired from this NumericUpDown when its delay value has been changed. - - - - Identifies the routed event. - - - - Add / Remove MaximumReachedEvent handler - Event fired from this NumericUpDown when its value has reached the maximum value. - - - - Identifies the routed event. - - - - Add / Remove MinimumReachedEvent handler - Event fired from this NumericUpDown when its value has reached the minimum value. - - - - Identifies the routed event. - - - - Add / Remove ValueChangedEvent handler - Event which will be fired from this NumericUpDown when its value has been changed. - - - - Identifies the dependency property. - - - - Gets or sets the amount of time, in milliseconds, the NumericUpDown waits while the up/down button is pressed - before it starts increasing/decreasing the for the specified . - The value must be non-negative. - - - - Identifies the dependency property. - - - - Gets or sets the horizontal alignment of the contents inside the text box. - - - - Identifies the dependency property. - - - - Gets or sets a value indicating whether the value to be added to or subtracted from remains - always or if it will increase faster after pressing the up/down button/arrow some time. - - - - Identifies the dependency property. - - - - Gets or sets a value indicating whether the text can be changed by the use of the up or down buttons only. - - - - Identifies the dependency property. - - - - Gets or sets the formatting for the displaying - - - - - - - Identifies the dependency property. - - - - Gets or sets a value indicating whether the user can use the arrow keys and to change the value. - - - - Identifies the dependency property. - - - - Gets or sets a value indicating whether the user can use the mouse wheel to change the value. - - - - Identifies the dependency property. - - - - Gets or sets a value indicating whether the user can enter text in the control. - - - - Identifies the dependency property. - - - - Gets or sets the value of the NumericUpDown. - - - - Identifies the dependency property. - - - - Minimum restricts the minimum value of the Value property. - - - - Identifies the dependency property. - - - - Maximum restricts the maximum value of the Value property. - - - - Identifies the dependency property. - - - - Gets or sets the interval value for increasing/decreasing the . - - - - Identifies the dependency property. - - - - Gets or sets a value indicating whether the control must have the focus in order to change values using the mouse wheel. - - - If the value is true then the value changes when the mouse wheel is over the control.
    - If the value is false then the value changes only if the control has the focus.
    - If is set to "false" then this property has no effect. -
    -
    - - Identifies the dependency property. - - - - The ButtonsAlignment property specifies horizontal alignment of the up/down buttons. - - - - Identifies the dependency property. - - - - Gets or sets a value indicating whether the up/down button of the control are visible. - - - If the value is false then the of the control can be changed only if one of the following cases is satisfied: - - - is true. - - - is true. - - - is true. - - - - - - Identifies the dependency property. - - - - Gets or sets the width of the up/down buttons. - - - - Identifies the dependency property. - - - - Gets or sets whether the up and down buttons will got the focus when using them. - - - - Identifies the dependency property. - - - - Gets or sets a value indicating whether the up/down buttons will be switched. - - - - Identifies the dependency property. - - - - Gets or sets a value indicating whether the value will be changed directly on every TextBox text changed input event or when using the Enter key. - - - - Identifies the dependency property. - - - - Gets or sets a value indicating the culture to be used in string formatting and converting operations. - - - - Identifies the dependency property. - - - - Gets or sets which numeric input for this NumericUpDown is allowed. - - - - Identifies the dependency property. - - - - Gets or sets the decimal-point correction mode. The default is - - - - Identifies the dependency property. - - - - Indicates if the NumericUpDown should round the value to the nearest possible interval when the focus moves to another element. - - - - Identifies the dependency property. - - - - Gets or sets the parsing number style for the value from text to numeric value. - - - - - Called when this element or any below gets focus. - - - - - When overridden in a derived class, is invoked whenever application code or internal processes call - . - - - - - This method is invoked when the Delay property changes. - - The old value of the Delay property. - The new value of the Delay property. - - - - This method is invoked when the Speedup property changes. - - The old value of the Speedup property. - The new value of the Speedup property. - - - - This method is invoked when the Maximum property changes. - - The old value of the Maximum property. - The new value of the Maximum property. - - - - This method is invoked when the Minimum property changes. - - The old value of the Minimum property. - The new value of the Minimum property. - - - - Raises the routed event. - - - Old value of the property - - - New value of the property - - - - - Insertion of the proper decimal-point as part of the TextBox content - - The TextBox which will be used for the correction - The decimal correction mode. - The culture with the decimal-point information. - - Typical "async-void" pattern as "fire-and-forget" behavior. - - - - - Doesn't overlay Flyouts nor a hidden TitleBar. - - - - - Overlays opened controls. - - - - - Overlays a hidden TitleBar. - - - - - Based on Greg Schechter's Planerator - http://blogs.msdn.com/b/greg_schechter/archive/2007/10/26/enter-the-planerator-dead-simple-3d-in-wpf-with-a-stupid-name.aspx - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - An Enum representing different positions, such as Left or Right. - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - This delegate must used by handlers of the RangeSelectionChangedEvent event. - - The current element along the event's route. - The event arguments containing additional information about the event. - Nothing. - - - - This RangeSelectionChangedEventArgs class contains old and new value when - RangeSelectionChanged is raised. - - - - - - - Return the old lower value. - - - - - Return the new lower value. - - - - - Return the old upper value. - - - - - Return the new upper value. - - - - - This is an instance constructor for the RangeSelectionChangedEventArgs class. - - The old lower property value - The new lower property value - The old upper property value - The new upper property value - - - - This is an instance constructor for the RoutedPropertyChangedEventArgs class. - It is constructed with a reference to the event being raised. - - The old lower property value - The new lower property value - The old upper property value - The new upper property value - RoutedEvent - - - - This method is used to perform the proper type casting in order to - call the type-safe RoutedPropertyChangedEventHandler delegate for the IsCheckedChangedEvent event. - - The handler to invoke. - The current object along the event's route. - Nothing. - - - - A slider control with the ability to select a range between two values. - - - - Identifies the routed event. - - - Identifies the routed event. - - - Identifies the routed event. - - - Identifies the routed event. - - - Identifies the routed event. - - - Identifies the routed event. - - - Identifies the routed event. - - - Identifies the routed event. - - - Identifies the routed event. - - - Identifies the routed event. - - - Identifies the routed event. - - - Identifies the routed event. - - - Identifies the dependency property. - - - - Get/sets the end of the range selection. - - - - Identifies the dependency property. - - - - Get/sets the beginning of the range selection. - - - - Identifies the dependency property. - - - - Get/sets the minimum range that can be selected. - - - - Identifies the dependency property. - - - - Get/sets the minimal distance between two thumbs. - - - - Identifies the dependency property. - - - - Get/sets whether whole range will be moved when press on right/left/central part of control - - - - Identifies the dependency property. - - - - Get/sets whether possibility to make manipulations inside range with left/right mouse buttons + cotrol button - - - - Identifies the dependency property. - - - - Get/sets whether possibility to make manipulations inside range with left/right mouse buttons + cotrol button - - - - Identifies the dependency property. - - - - Gets or sets the orientation of the . - - - - Identifies the dependency property. - - - - Gets or sets the position of tick marks with respect to the of the . - - - A value that defines how to position the tick marks in a with respect to the slider bar. The default is . - - - - Identifies the dependency property. - - - - Gets or sets the interval between tick marks. - - - The distance between tick marks. The default is (1.0). - - - - Identifies the dependency property. - - - - Gets or sets the positions of the tick marks to display for a . - - A set of tick marks to display for a . The default is . - - - - Identifies the dependency property. - - - - Get or sets IsMoveToPoint feature which will enable/disable moving to exact point inside control when user clicked on it - Gets or sets a value that indicates whether the two of a moves immediately to the location of the mouse click that occurs while the mouse pointer pauses on the tracks. - - - - Identifies the dependency property. - - - - Gets or sets whether a tooltip that contains the current value of the displays when the is pressed. If a tooltip is displayed, this property also specifies the placement of the tooltip. - - - One of the values that determines where to display the tooltip with respect to the of the , or that specifies to not show a tooltip. The default is , which specifies that a tooltip is not displayed. - - - - Identifies the dependency property. - - - - Gets or sets the number of digits that are displayed to the right side of the decimal point for the of the in a tooltip. - - - The precision of the that displays in the tooltip, specified as the number of digits that appear to the right of the decimal point. The default is zero (0). - - - - Identifies the dependency property. - - - - Gets or sets a template for the auto tooltip to show the lower value. - - - - Identifies the dependency property. - - - - Gets or sets a template for the auto tooltip to show the upper value. - - - - Identifies the dependency property. - - - - Gets or sets a template for the auto tooltip to show the center value. - - - - Identifies the dependency property. - - - - Get/sets value how fast thumbs will move when user press on left/right/central with left mouse button (IsMoveToPoint must be set to FALSE) - - - - Identifies the dependency property. - - - - Gets or sets a value that indicates whether the displays a selection range along the . - - - if a selection range is displayed; otherwise, . The default is . - - - - Identifies the dependency property. - - - - Gets or sets the smallest value of a specified selection for a . - - - The largest value of a selected range of values of a . The default is zero (0.0). - - - - Identifies the dependency property. - - - - Gets or sets the largest value of a specified selection for a . - - - The largest value of a selected range of values of a . The default is zero (0.0). - - - - - Responds to a change in the value of the property. - - The old value of the property.The new value of the property. - - - - Responds to a change in the value of the property. - - The old value of the property.The new value of the property. - - - - Gets the lower value of the range selection. - - - - - Gets the upper value of the range selection. - - - - - - - - RevealImage - - - - - InitializeComponent - - - - Identifies the routed event. - - - Identifies the dependency property. - - - - Gets or sets an extra tag. - - - - Identifies the dependency property. - - - - Gets or sets the orientation of children stacking. - - - - Identifies the dependency property. - - - - Gets or sets the content for the icon part. - - - - Identifies the dependency property. - - - - Gets or sets the DataTemplate for the icon part. - - - - Identifies the dependency property. - - - - Gets or sets the command to invoke when the content button is pressed. - - - - Identifies the dependency property. - - - - Gets or sets the element on which to raise the specified command. - - - - Identifies the dependency property. - - - - Gets or sets the parameter to pass to the command property. - - - - Identifies the dependency property. - - - - Gets or sets the button content style. - - - - Identifies the dependency property. - - - - Gets or sets the button arrow style. - - - - Identifies the dependency property. - - - - Gets or sets the foreground brush for the button arrow icon. - - - - Identifies the dependency property. - - - - Gets or sets the foreground brush of the button arrow icon if the mouse is over the split button. - - - - Identifies the dependency property. - - - - Gets or sets the foreground brush of the button arrow icon if the arrow button is pressed. - - - - - - - - A special animation used to animates the length of a . - - - - - - - Represents a container with two views; one view for the main content and another view that is typically used for - navigation commands. - - - - Identifies the dependency property. - - - - Gets or sets the width of the pane in its compact display mode. - - - The width of the pane in it's compact display mode. The default is 48 device-independent pixel (DIP) (defined - by the SplitViewCompactPaneThemeLength resource). - - - - Identifies the dependency property. - - - - Gets or sets the contents of the main panel of a . - - The contents of the main panel of a . The default is null. - - - Identifies the dependency property. - - - - Gets of sets a value that specifies how the pane and content areas of a are shown. - - - A value of the enumeration that specifies how the pane and content areas of a are - shown. The default is . - - - - Identifies the dependency property. - - - - Gets or sets a value that specifies whether the pane is expanded to its full width. - - true if the pane is expanded to its full width; otherwise, false. The default is true. - - - Identifies the dependency property. - - - - Gets or sets a value that specifies the OverlayBrush - - The current OverlayBrush - - - Identifies the dependency property. - - - - Gets or sets the width of the pane when it's fully expanded. - - - The width of the pane when it's fully expanded. The default is 320 device-independent - pixel (DIP). - - - - Identifies the dependency property. - - - - Gets or sets the minimum width of the pane when it's fully expanded. - - - The minimum width of the pane when it's fully expanded. The default is 320 device-independent - pixel (DIP). - - - - Identifies the dependency property. - - - - Gets or sets the maximum width of the pane when it's fully expanded. - - - The maximum width of the pane when it's fully expanded. The default is 320 device-independent - pixel (DIP). - - - - Identifies the dependency property. - - - - Gets or Sets if the open pane can be resized by the user. The default value is false. - - - - Identifies the dependency property. - - - - Gets or Sets the for the resizing Thumb (type of ) - - - - Identifies the dependency property. - - - - Gets or sets the contents of the pane of a . - - The contents of the pane of a . The default is null. - - - Identifies the dependency property. - - - - Gets or sets the Brush to apply to the background of the area of the control. - - The Brush to apply to the background of the area of the control. - - - Identifies the dependency property. - - - - Gets or sets the Brush to apply to the foreground of the area of the control. - - The Brush to apply to the background of the area of the control. - - - Identifies the dependency property. - - - - Gets or sets a value that specifies whether the pane is shown on the right or left side of the - . - - - A value of the enumeration that specifies whether the pane is shown on the right or left side of the - . The default is . - - - - Identifies the dependency property. - - - - Gets an object that provides calculated values that can be referenced as TemplateBinding sources when defining - templates for a control. - - An object that provides calculated values for templates. - - - - Initializes a new instance of the class. - - - - - Occurs when the pane is closed. - - - - - Occurs when the pane is closing. - - - - - - - - - - - - - - Constants that specify how the pane is shown in a . - - - - - The pane covers the content when it's open and does not take up space in the control layout. - - - - - The pane is shown side-by-side with the content and takes up space in the control layout. - - - - - The amount of the pane defined by the property is shown side-by-side - with the content and takes up space in the control layout. - The remaining part of the pane covers the content when it's open and does not take up space in the control layout. - - - - - The amount of the pane defined by the property is shown side-by-side - with the content and takes up space in the control layout. - The remaining part of the pane pushes the content to the side when it's open and takes up space in the control - layout. - - - - - Provides event data for the event. - - - - - Gets or sets a value that indicates whether the pane closing action should be canceled. - - true to cancel the pane closing action; otherwise, false. - - - - Constants that specify whether the pane is set to the left or to the right of the content in a - . - - - - - The pane is shown to the left of the content. - - - - - The pane is shown to the right of the content. - - - - - Provides calculated values that can be referenced as TemplatedParent sources when defining templates for a - . - Not intended for general use. - - - - Identifies the dependency property. - - - - Gets the value as a GridLength. - - - - Identifies the dependency property. - - - - Gets the negative of the value. - - - - Identifies the dependency property. - - - - Gets the negative of the value calculated by subtracting the value from - the value. - - - - Identifies the dependency property. - - - - Gets the value as a GridLength. - - - - Identifies the dependency property. - - - - Gets the value. - - - - Identifies the dependency property. - - - - Gets a value calculated by subtracting the value from the - value. - - - - - HorizontalTitleAlignment Dependency Property. - Default Value: HorizontalAlignment.Left - - - - - Gets/Sets the horizontal alignment of the title. - - - - - VerticalTitleAlignment Dependency Property. - Default Value: VerticalAlignment.Bottom - - - - - Gets/Sets the vertical alignment of the title. - - - - - Represents a control that allows the user to select a date and a time. - - - - Identifies the dependency property. - - - - Gets or sets the last date to be displayed. - - The last date to display. - - - Identifies the dependency property. - - - - Gets or sets the date to display - - - The date to display. The default is . - - - - Identifies the dependency property. - - - - Gets or sets the first date to be displayed. - - The first date to display. - - - Identifies the dependency property. - - - - Gets or sets the day that is considered the beginning of the week. - - - A that represents the beginning of the week. The default is the - that is determined by the current culture. - - - - Identifies the dependency property. - - - - Gets or sets a value that indicates whether the current date will be highlighted. - - true if the current date is highlighted; otherwise, false. The default is true. - - - Identifies the dependency property. - - - - Gets or sets the format that is used to display the selected date. - - - - Identifies the dependency property. - - - - Gets or sets a value that indicates the dimension by which calendar and clock are stacked. - - - The of the calendar and clock. The default is - . - - - - Identifies the dependency property. - - - - Gets or sets the style that is used when rendering the calendar. - - - - - Gets the days that are not selectable. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Defines the visibility for time-parts that are visible for the . - - - - - Represents a control that allows the user to select a time. - - - - - - - - - - - Represents a base-class for time picking. - - - - - This list contains values from 0 to 55 with an interval of 5. It can be used to bind to and . - - - <MahApps:TimePicker SourceSeconds="{x:Static MahApps:TimePickerBase.IntervalOf5}" /> - <MahApps:DateTimePicker SourceSeconds="{x:Static MahApps:TimePickerBase.IntervalOf5}" /> - - - Returns a list containing {0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55}. - - - - - This list contains values from 0 to 50 with an interval of 10. It can be used to bind to and . - - - <MahApps:TimePicker SourceSeconds="{x:Static MahApps:TimePickerBase.IntervalOf10}" /> - <MahApps:DateTimePicker SourceSeconds="{x:Static MahApps:TimePickerBase.IntervalOf10}" /> - - - Returns a list containing {0, 10, 20, 30, 40, 50}. - - - - - This list contains values from 0 to 45 with an interval of 15. It can be used to bind to and . - - - <MahApps:TimePicker SourceSeconds="{x:Static MahApps:TimePickerBase.IntervalOf15}" /> - <MahApps:DateTimePicker SourceSeconds="{x:Static MahApps:TimePickerBase.IntervalOf15}" /> - - - Returns a list containing {0, 15, 30, 45}. - - - - Identifies the dependency property. - - - - Gets or sets a collection used to generate the content for selecting the hours. - - - A collection that is used to generate the content for selecting the hours. The default is a list of interger from 0 - to 23 if is false or a list of interger from - 1 to 12 otherwise.. - - - - Identifies the dependency property. - - - - Gets or sets a collection used to generate the content for selecting the minutes. - - - A collection that is used to generate the content for selecting the minutes. The default is a list of int from - 0 to 59. - - - - Identifies the dependency property. - - - - Gets or sets a collection used to generate the content for selecting the seconds. - - - A collection that is used to generate the content for selecting the minutes. The default is a list of int from - 0 to 59. - - - - Identifies the dependency property. - - - - Gets or sets a value indicating whether the drop-down for a box is currently - open. - - true if the drop-down is open; otherwise, false. The default is false. - - - - IsDropDownOpenProperty property changed handler. - - DatePicker that changed its IsDropDownOpen. - DependencyPropertyChangedEventArgs. - - - - This method is invoked when the changes. - - - - Identifies the dependency property. - - - - Gets or sets a value indicating whether the clock of this control is visible in the user interface (UI). This is a - dependency property. - - - If this value is set to false then is set to - - - - true if the clock is visible; otherwise, false. The default value is true. - - - - Identifies the dependency property. - - - - Gets or sets a value indicating whether the contents of the are not editable. - - - true if the is read-only; otherwise, false. The default is false. - - - - Identifies the dependency property. - - - - Gets or sets a value indicating the visibility of the clock hands in the user interface (UI). - - - The visibility definition of the clock hands. The default is . - - - - Identifies the dependency property. - - - - Gets or sets a value indicating the culture to be used in string formatting operations. - - - - Identifies the dependency property. - - - - Gets or sets a value indicating the visibility of the selectable date-time-parts in the user interface (UI). - - - visibility definition of the selectable date-time-parts. The default is . - - - - - Occurs when the property is changed. - - - - Identifies the dependency property. - - - - Gets or sets the currently selected date and time. - - - The date and time which is currently selected. The default is null. - - - - Identifies the dependency property. - - - - Gets or sets the format that is used to display the selected time. - - - - Identifies the dependency property. - - - - Gets or sets a composite string that specifies how to format the hour items. - - - - Identifies the dependency property. - - - - Gets or sets a composite string that specifies how to format the minute items. - - - - Identifies the dependency property. - - - - Gets or sets a composite string that specifies how to format the second items. - - - - - This readonly dependency property is to control whether to show the date-picker (in case of ) or hide it (in case of . - - - - Identifies the dependency property. - - - - Gets or sets a value indicating whether the date can be selected or not. This property is read-only. - - - - - Gets a value indicating whether the that is specified by the - - set by the ( if null) has not a value. - - - - - When overridden in a derived class, is invoked whenever application code or internal processes call - . - - - - - Gets the offset from the selected to use it in as hour - parameter. - - The current hour. - - An integer representing the offset to add to the hour that is selected in the hour-picker for setting the correct - . The offset is determined as follows: - - - ConditionOffset - - - is false0 - - - Selected hour is between 1 AM and 11 AM0 - - - Selected hour is 12 AM-12h - - - Selected hour is between 12 PM and 11 PM+12h - - - - - - - A control that allows the user to toggle between two states: One represents true; The other represents false. - - - - Identifies the dependency property. - - - - Gets or sets the flow direction of the switch and content. - - - LeftToRight means content left and button right and RightToLeft vise versa. - - - - Identifies the dependency property. - - - - Gets or sets the padding of the inner content. - - - - Identifies the dependency property. - - - - Gets or sets a value that declares whether the state of the ToggleSwitch is "On". - - - - Identifies the dependency property. - - - - Provides the object content that should be displayed using the OnContentTemplate when this ToggleSwitch has state of "On". - - - - Identifies the dependency property. - - - - Gets or sets the DataTemplate used to display the control's content while in "On" state. - - - - Identifies the dependency property. - - - - Gets or sets a template selector for OnContent property that enables an application writer to provide custom template-selection logic . - - - This property is ignored if is set. - - - - Identifies the dependency property. - - - - Gets or sets a composite string that specifies how to format the OnContent property if it is displayed as a string. - - - This property is ignored if is set. - - - - Identifies the dependency property. - - - - Provides the object content that should be displayed using the OffContentTemplate when this ToggleSwitch has state of "Off". - - - - Identifies the dependency property. - - - - Gets or sets the DataTemplate used to display the control's content while in "Off" state. - - - - Identifies the dependency property. - - - - Gets or sets a template selector for OffContent property that enables an application writer to provide custom template-selection logic . - - - This property is ignored if is set. - - - - Identifies the dependency property. - - - - Gets or sets a composite string that specifies how to format the OffContent property if it is displayed as a string. - - - This property is ignored if is set. - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - Gets or sets a command which will be executed when the changes. - - - - Identifies the dependency property. - - - - Gets or sets a command which will be executed when the changes. - - - - Identifies the dependency property. - - - - Gets or sets a command which will be executed when the changes. - - - - Identifies the dependency property. - - - - Gets or sets the command parameter which will be passed by the Command. - - - - Identifies the dependency property. - - - - Gets or sets the element on which to raise the specified Command. - - - Element on which to raise the Command. - - - - - Occurs when "On"/"Off" state changes for this ToggleSwitch. - - - - This method is invoked when the changes. - - - - - - - enumeration for the different transition types - - - - - Use the VisualState DefaultTransition - - - - - Use the VisualState Normal - - - - - Use the VisualState UpTransition - - - - - Use the VisualState DownTransition - - - - - Use the VisualState RightTransition - - - - - Use the VisualState RightReplaceTransition - - - - - Use the VisualState LeftTransition - - - - - Use the VisualState LeftReplaceTransition - - - - - Use a custom VisualState, the name must be set using CustomVisualStatesName property - - - - - A ContentControl that animates content as it loads and unloads. - - - - - Gets or sets the name of the custom transition visual state. - - - - - Gets/sets if the content is transitioning. - - - - - Reload the current transition if the content is the same. - - - - - Helper methods for UI-related tasks. - This class was obtained from Philip Sumi (a fellow WPF Disciples blog) - http://www.hardcodet.net/uploads/2009/06/UIHelper.cs - - - - - Finds a parent of a given item on the visual tree. - - The type of the queried item. - A direct or indirect child of the - queried item. - The first parent item that matches the submitted - type parameter. If not matching item can be found, a null - reference is being returned. - - - - Finds all Ancestors of a given item on the visual tree. - - A node in a visual tree - All ancestors in visual tree of element - - - - Returns full visual ancestry, starting at the leaf. - If element is not of or the logical ancestry is used. - - The starting object. - - - - - Tries to find and returns a visual ancestor, starting at the leaf. - If element is not of or the logical ancestry is used. - - The starting object. - - - - - Finds a Child of a given item in the visual tree. - - A direct parent of the queried item. - The type of the queried item. - x:Name or Name of child. - The first parent item that matches the submitted type parameter. - If not matching item can be found, - a null parent is being returned. - - - - This method is an alternative to WPF's - method, which also supports content elements. Keep in mind that for content element, - this method falls back to the logical tree of the element! - - The item to be processed. - The submitted item's parent, if available. Otherwise - null. - - - - Analyzes both visual and logical tree in order to find all elements of a given - type that are descendants of the item. - - The type of the queried items. - The root element that marks the source of the search. If the - source is already of the requested type, it will not be included in the result. - Sometimes it's better to search in the VisualTree (e.g. in tests) - All descendants of that match the requested type. - - - - This method is an alternative to WPF's - method, which also - supports content elements. Keep in mind that for content elements, - this method falls back to the logical tree of the element. - - The item to be processed. - Sometimes it's better to search in the VisualTree (e.g. in tests) - The submitted item's child elements, if available. - - - - Tries to locate a given item within the visual tree, - starting with the dependency object at a given position. - - The type of the element to be found - on the visual tree of the element at the given location. - The main element which is used to perform - hit testing. - The position to be evaluated on the origin. - - - - Get the working area size of the monitor from where the visual stays. - - The visual element to get the monitor information. - The working area size of the monitor. - - - Gets the text associated with the given window handle. - The window to act on. - The window text. - - - Gets the text associated with the given window handle. - The window to act on. - The window text. - - - Identifies the dependency property. - - - - Gets or sets the value indicating current light style for the minimize button. - - - - Identifies the dependency property. - - - - Gets or sets the value indicating current light style for the maximize button. - - - - Identifies the dependency property. - - - - Gets or sets the value indicating current light style for the close button. - - - - Identifies the dependency property. - - - - Gets or sets the value indicating current dark style for the minimize button. - - - - Identifies the dependency property. - - - - Gets or sets the value indicating current dark style for the maximize button. - - - - Identifies the dependency property. - - - - Gets or sets the value indicating current dark style for the close button. - - - - Identifies the dependency property. - - - - Gets or sets the value indicating current theme. - - - - Identifies the dependency property. - - - - Gets or sets the minimize button tooltip. - - - - Identifies the dependency property. - - - - Gets or sets the maximize button tooltip. - - - - Identifies the dependency property. - - - - Gets or sets the close button tooltip. - - - - Identifies the dependency property. - - - - Gets or sets the restore button tooltip. - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - Gets the window. - - - - Identifies the dependency property. - - - - Gets or sets the value indicating the current theme. - - - - Identifies the dependency property. - - - - Gets or sets the value indicating the light theme ControlTemplate. - - - - Identifies the dependency property. - - - - Gets or sets the value indicating the light theme ControlTemplate. - - - - Identifies the dependency property. - - - - Gets or sets the value indicating whether to show the separators or not. - - - - Identifies the dependency property. - - - - Gets or sets the value indicating whether to show the last separator or not. - - - - Identifies the dependency property. - - - - Gets or sets the value indicating the height of the separators. - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - Gets the window. - - - - - Creates AutomationPeer () - - - - Identifies the dependency property. - - - - Gets or sets the value indicating whether to show the separator. - - - - Identifies the dependency property. - - - Identifies the dependency property. - - - - - - - Doesn't overlay a hidden TitleBar. - - - - - Overlays a hidden TitleBar. - - - - - Refreshes the application settings property values from persistent storage. - - - - - Upgrades the application settings on loading. - - - - - Updates application settings to reflect a more recent installation of the application. - - - - - Stores the current values of the settings properties. - - - - - this settings class is the default way to save the placement of the window - - - - - Upgrades the application settings on loading. - - - - - Determining Ideal Text Color Based on Specified Background Color - http://www.codeproject.com/KB/GDI-plus/IdealTextColor.aspx - - The bg. - - - - - Converts a double representing either hour/minute/second to the corresponding angle. - - - - - Channel type for ColorChannelMinMaxConverter to pass in in as parameter. - - - - - Converts a given Color to a new Color with the specified Channel turned to the Min or Max Value - - - - Gets the default instance - - - - Converts a given to its Name - - Needed: The . - - Optional: A - - The name of the color or the Hex-Code if no name is available - - - - Converts a given to its Name - - Needed: The . Optional: A - - - - The name of the color or the Hex-Code if no name is available - - - - Converts a given back to a - - The name of the - - Optional: A - - - - - - The ConvertBack-Method is not available inside a . Use a with the optional instead. - - - - - - - - - - - Converts a given into a . - - - - - Gets a static instance of the converter if needed. - - - - - Gets or Sets the brush which will be used if the conversion fails. - - - - - Gets or Sets the color which will be used if the conversion fails. - - - - - Converts a CornerRadius to a new CornerRadius. It's possible to ignore a side with the IgnoreRadius property. - - - - - Filters a CornerRadius by the given Filter property. Result can be a new CornerRadius or a value of it's 4 corners. - - - - Gets the default instance - - - - Converts a given Color to a new Color with the specified Channel turned to the Min or Max Value - - - - Gets the default instance - - - - Converts the value from true to false and false to true. - - - - - The math operations which can be used at the - - - - - MathConverter provides a value converter which can be used for math operations. - It can be used for normal binding or multi binding as well. - If it is used for normal binding the given parameter will be used as operands with the selected operation. - If it is used for multi binding then the first and second binding will be used as operands with the selected operation. - This class cannot be inherited. - - - - - MathAddConverter provides a multi value converter as a MarkupExtension which can be used for math operations. - This class cannot be inherited. - - - - - MathSubtractConverter provides a multi value converter as a MarkupExtension which can be used for math operations. - This class cannot be inherited. - - - - - MathMultiplyConverter provides a multi value converter as a MarkupExtension which can be used for math operations. - This class cannot be inherited. - - - - - MathDivideConverter provides a multi value converter as a MarkupExtension which can be used for math operations. - This class cannot be inherited. - - - - Gets the default instance - - - - Use the radius of all corners. - - - - - Ignore the radius of the top-left and bottom-left corner. - - - - - Ignore the radius of the top-left and top-right corner. - - - - - Ignore the radius of the top-right and bottom-right corner. - - - - - Ignore the radius of the bottom-left and bottom-right corner. - - - - - Ignore the radius of the top-left corner. - - - - - Ignore radius of the top-right corner. - - - - - Ignore the radius of the bottom-right corner. - - - - - Ignore the radius of the bottom-left corner. - - - - - This Converter converts a given height or width of an control to a CornerRadius - - - - - Converts a String into a Visibility enumeration (and back) - The FalseEquivalent can be declared with the "FalseEquivalent" property - - - - - Initialize the properties with standard values - - - - - FalseEquivalent (default : Visibility.Collapsed => see Constructor) - - - - - Define whether the opposite boolean value is crucial (default : false) - - - - - Converts a Thickness to a new Thickness. It's possible to ignore a side with the IgnoreThicknessSide property. - - - - - Use all sides. - - - - - Ignore the left side. - - - - - Ignore the top side. - - - - - Ignore the right side. - - - - - Ignore the bottom side. - - - - Converts a value. - A converted value. If the method returns null, the valid null value is used. - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - - Converts a value. - A converted value. If the method returns null, the valid null value is used. - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Implements a markup extension that supports static (XAML load time) resource references made from XAML. - - - - - Provides theme resources from MahApps.Metro. - - - - - - - - Helps boxing Boolean values. - - - - - Gets a boxed representation for Boolean's "true" value. - - - - - Gets a boxed representation for Boolean's "false" value. - - - - - Returns a boxed representation for the specified Boolean value. - - The value to box. - - -
    -
    diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MathNet.Numerics.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MathNet.Numerics.dll deleted file mode 100644 index ede75a8..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MathNet.Numerics.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MathNet.Numerics.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/MathNet.Numerics.xml deleted file mode 100644 index 3d573a1..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/MathNet.Numerics.xml +++ /dev/null @@ -1,53733 +0,0 @@ - - - - MathNet.Numerics - - - - - AppContext based switches to disable functionality, controllable through also in the - host application through AppContext or by configuration with AppContextSwitchOverride. - https://docs.microsoft.com/en-us/dotnet/framework/configure-apps/file-schema/runtime/appcontextswitchoverrides-element - - - Since AppContext is not supported on .NET Framework 4.0, a local implementation is used there instead, - which cannot be controlled though configuration or through AppContext. - - - - - Useful extension methods for Arrays. - - - - - Copies the values from on array to another. - - The source array. - The destination array. - - - - Copies the values from on array to another. - - The source array. - The destination array. - - - - Copies the values from on array to another. - - The source array. - The destination array. - - - - Copies the values from on array to another. - - The source array. - The destination array. - - - - Enumerative Combinatorics and Counting. - - - - - Count the number of possible variations without repetition. - The order matters and each object can be chosen only once. - - Number of elements in the set. - Number of elements to choose from the set. Each element is chosen at most once. - Maximum number of distinct variations. - - - - Count the number of possible variations with repetition. - The order matters and each object can be chosen more than once. - - Number of elements in the set. - Number of elements to choose from the set. Each element is chosen 0, 1 or multiple times. - Maximum number of distinct variations with repetition. - - - - Count the number of possible combinations without repetition. - The order does not matter and each object can be chosen only once. - - Number of elements in the set. - Number of elements to choose from the set. Each element is chosen at most once. - Maximum number of combinations. - - - - Count the number of possible combinations with repetition. - The order does not matter and an object can be chosen more than once. - - Number of elements in the set. - Number of elements to choose from the set. Each element is chosen 0, 1 or multiple times. - Maximum number of combinations with repetition. - - - - Count the number of possible permutations (without repetition). - - Number of (distinguishable) elements in the set. - Maximum number of permutations without repetition. - - - - Generate a random permutation, without repetition, by generating the index numbers 0 to N-1 and shuffle them randomly. - Implemented using Fisher-Yates Shuffling. - - An array of length N that contains (in any order) the integers of the interval [0, N). - Number of (distinguishable) elements in the set. - The random number generator to use. Optional; the default random source will be used if null. - - - - Select a random permutation, without repetition, from a data array by reordering the provided array in-place. - Implemented using Fisher-Yates Shuffling. The provided data array will be modified. - - The data array to be reordered. The array will be modified by this routine. - The random number generator to use. Optional; the default random source will be used if null. - - - - Select a random permutation from a data sequence by returning the provided data in random order. - Implemented using Fisher-Yates Shuffling. - - The data elements to be reordered. - The random number generator to use. Optional; the default random source will be used if null. - - - - Generate a random combination, without repetition, by randomly selecting some of N elements. - - Number of elements in the set. - The random number generator to use. Optional; the default random source will be used if null. - Boolean mask array of length N, for each item true if it is selected. - - - - Generate a random combination, without repetition, by randomly selecting k of N elements. - - Number of elements in the set. - Number of elements to choose from the set. Each element is chosen at most once. - The random number generator to use. Optional; the default random source will be used if null. - Boolean mask array of length N, for each item true if it is selected. - - - - Select a random combination, without repetition, from a data sequence by selecting k elements in original order. - - The data source to choose from. - Number of elements (k) to choose from the data set. Each element is chosen at most once. - The random number generator to use. Optional; the default random source will be used if null. - The chosen combination, in the original order. - - - - Generates a random combination, with repetition, by randomly selecting k of N elements. - - Number of elements in the set. - Number of elements to choose from the set. Elements can be chosen more than once. - The random number generator to use. Optional; the default random source will be used if null. - Integer mask array of length N, for each item the number of times it was selected. - - - - Select a random combination, with repetition, from a data sequence by selecting k elements in original order. - - The data source to choose from. - Number of elements (k) to choose from the data set. Elements can be chosen more than once. - The random number generator to use. Optional; the default random source will be used if null. - The chosen combination with repetition, in the original order. - - - - Generate a random variation, without repetition, by randomly selecting k of n elements with order. - Implemented using partial Fisher-Yates Shuffling. - - Number of elements in the set. - Number of elements to choose from the set. Each element is chosen at most once. - The random number generator to use. Optional; the default random source will be used if null. - An array of length K that contains the indices of the selections as integers of the interval [0, N). - - - - Generate a random variation, without repetition, by randomly selecting k of n elements with order. This is an O(k) space-complexity implementation optimized for very large N.
    - The space complexity of Fisher-Yates Shuffling is O(n+k). When N is very large, the algorithm will be unexecutable in limited memory, and a more memory-efficient algorithm is needed.
    - You can explicitly cast N to if N is out of range of or memory, so that this special implementation is called. However, this implementation is slower than Fisher-Yates Shuffling: don't call it if time is more critical than space.
    - The K of type seems impossible, because the returned array is of size K and must all be stored in memory. -
    - Number of elements in the set. - Number of elements to choose from the set. Each element is chosen at most once. - The random number generator to use. Optional; the default random source will be used if null. - An array of length K that contains the indices of the selections as integers of the interval [0, N). -
    - - - Select a random variation, without repetition, from a data sequence by randomly selecting k elements in random order. - Implemented using partial Fisher-Yates Shuffling. - - The data source to choose from. - Number of elements (k) to choose from the set. Each element is chosen at most once. - The random number generator to use. Optional; the default random source will be used if null. - The chosen variation, in random order. - - - - Generate a random variation, with repetition, by randomly selecting k of n elements with order. - - Number of elements in the set. - Number of elements to choose from the set. Elements can be chosen more than once. - The random number generator to use. Optional; the default random source will be used if null. - An array of length K that contains the indices of the selections as integers of the interval [0, N). - - - - Select a random variation, with repetition, from a data sequence by randomly selecting k elements in random order. - - The data source to choose from. - Number of elements (k) to choose from the data set. Elements can be chosen more than once. - The random number generator to use. Optional; the default random source will be used if null. - The chosen variation with repetition, in random order. - - - - 32-bit single precision complex numbers class. - - - - The class Complex32 provides all elementary operations - on complex numbers. All the operators +, -, - *, /, ==, != are defined in the - canonical way. Additional complex trigonometric functions - are also provided. Note that the Complex32 structures - has two special constant values and - . - - - - Complex32 x = new Complex32(1f,2f); - Complex32 y = Complex32.FromPolarCoordinates(1f, Math.Pi); - Complex32 z = (x + y) / (x - y); - - - - For mathematical details about complex numbers, please - have a look at the - Wikipedia - - - - - - The real component of the complex number. - - - - - The imaginary component of the complex number. - - - - - Initializes a new instance of the Complex32 structure with the given real - and imaginary parts. - - The value for the real component. - The value for the imaginary component. - - - - Creates a complex number from a point's polar coordinates. - - A complex number. - The magnitude, which is the distance from the origin (the intersection of the x-axis and the y-axis) to the number. - The phase, which is the angle from the line to the horizontal axis, measured in radians. - - - - Returns a new instance - with a real number equal to zero and an imaginary number equal to zero. - - - - - Returns a new instance - with a real number equal to one and an imaginary number equal to zero. - - - - - Returns a new instance - with a real number equal to zero and an imaginary number equal to one. - - - - - Returns a new instance - with real and imaginary numbers positive infinite. - - - - - Returns a new instance - with real and imaginary numbers not a number. - - - - - Gets the real component of the complex number. - - The real component of the complex number. - - - - Gets the real imaginary component of the complex number. - - The real imaginary component of the complex number. - - - - Gets the phase or argument of this Complex32. - - - Phase always returns a value bigger than negative Pi and - smaller or equal to Pi. If this Complex32 is zero, the Complex32 - is assumed to be positive real with an argument of zero. - - The phase or argument of this Complex32 - - - - Gets the magnitude (or absolute value) of a complex number. - - Assuming that magnitude of (inf,a) and (a,inf) and (inf,inf) is inf and (NaN,a), (a,NaN) and (NaN,NaN) is NaN - The magnitude of the current instance. - - - - Gets the squared magnitude (or squared absolute value) of a complex number. - - The squared magnitude of the current instance. - - - - Gets the unity of this complex (same argument, but on the unit circle; exp(I*arg)) - - The unity of this Complex32. - - - - Gets a value indicating whether the Complex32 is zero. - - true if this instance is zero; otherwise, false. - - - - Gets a value indicating whether the Complex32 is one. - - true if this instance is one; otherwise, false. - - - - Gets a value indicating whether the Complex32 is the imaginary unit. - - true if this instance is ImaginaryOne; otherwise, false. - - - - Gets a value indicating whether the provided Complex32evaluates - to a value that is not a number. - - - true if this instance is ; otherwise, - false. - - - - - Gets a value indicating whether the provided Complex32 evaluates to an - infinite value. - - - true if this instance is infinite; otherwise, false. - - - True if it either evaluates to a complex infinity - or to a directed infinity. - - - - - Gets a value indicating whether the provided Complex32 is real. - - true if this instance is a real number; otherwise, false. - - - - Gets a value indicating whether the provided Complex32 is real and not negative, that is >= 0. - - - true if this instance is real nonnegative number; otherwise, false. - - - - - Exponential of this Complex32 (exp(x), E^x). - - - The exponential of this complex number. - - - - - Natural Logarithm of this Complex32 (Base E). - - The natural logarithm of this complex number. - - - - Common Logarithm of this Complex32 (Base 10). - - The common logarithm of this complex number. - - - - Logarithm of this Complex32 with custom base. - - The logarithm of this complex number. - - - - Raise this Complex32 to the given value. - - - The exponent. - - - The complex number raised to the given exponent. - - - - - Raise this Complex32 to the inverse of the given value. - - - The root exponent. - - - The complex raised to the inverse of the given exponent. - - - - - The Square (power 2) of this Complex32 - - - The square of this complex number. - - - - - The Square Root (power 1/2) of this Complex32 - - - The square root of this complex number. - - - - - Evaluate all square roots of this Complex32. - - - - - Evaluate all cubic roots of this Complex32. - - - - - Equality test. - - One of complex numbers to compare. - The other complex numbers to compare. - true if the real and imaginary components of the two complex numbers are equal; false otherwise. - - - - Inequality test. - - One of complex numbers to compare. - The other complex numbers to compare. - true if the real or imaginary components of the two complex numbers are not equal; false otherwise. - - - - Unary addition. - - The complex number to operate on. - Returns the same complex number. - - - - Unary minus. - - The complex number to operate on. - The negated value of the . - - - Addition operator. Adds two complex numbers together. - The result of the addition. - One of the complex numbers to add. - The other complex numbers to add. - - - Subtraction operator. Subtracts two complex numbers. - The result of the subtraction. - The complex number to subtract from. - The complex number to subtract. - - - Addition operator. Adds a complex number and float together. - The result of the addition. - The complex numbers to add. - The float value to add. - - - Subtraction operator. Subtracts float value from a complex value. - The result of the subtraction. - The complex number to subtract from. - The float value to subtract. - - - Addition operator. Adds a complex number and float together. - The result of the addition. - The float value to add. - The complex numbers to add. - - - Subtraction operator. Subtracts complex value from a float value. - The result of the subtraction. - The float vale to subtract from. - The complex value to subtract. - - - Multiplication operator. Multiplies two complex numbers. - The result of the multiplication. - One of the complex numbers to multiply. - The other complex number to multiply. - - - Multiplication operator. Multiplies a complex number with a float value. - The result of the multiplication. - The float value to multiply. - The complex number to multiply. - - - Multiplication operator. Multiplies a complex number with a float value. - The result of the multiplication. - The complex number to multiply. - The float value to multiply. - - - Division operator. Divides a complex number by another. - Enhanced Smith's algorithm for dividing two complex numbers - - The result of the division. - The dividend. - The divisor. - - - - Helper method for dividing. - - Re first - Im first - Re second - Im second - - - - - Division operator. Divides a float value by a complex number. - Algorithm based on Smith's algorithm - - The result of the division. - The dividend. - The divisor. - - - Division operator. Divides a complex number by a float value. - The result of the division. - The dividend. - The divisor. - - - - Computes the conjugate of a complex number and returns the result. - - - - - Returns the multiplicative inverse of a complex number. - - - - - Converts the value of the current complex number to its equivalent string representation in Cartesian form. - - The string representation of the current instance in Cartesian form. - - - - Converts the value of the current complex number to its equivalent string representation - in Cartesian form by using the specified format for its real and imaginary parts. - - The string representation of the current instance in Cartesian form. - A standard or custom numeric format string. - - is not a valid format string. - - - - Converts the value of the current complex number to its equivalent string representation - in Cartesian form by using the specified culture-specific formatting information. - - The string representation of the current instance in Cartesian form, as specified by . - An object that supplies culture-specific formatting information. - - - Converts the value of the current complex number to its equivalent string representation - in Cartesian form by using the specified format and culture-specific format information for its real and imaginary parts. - The string representation of the current instance in Cartesian form, as specified by and . - A standard or custom numeric format string. - An object that supplies culture-specific formatting information. - - is not a valid format string. - - - - Checks if two complex numbers are equal. Two complex numbers are equal if their - corresponding real and imaginary components are equal. - - - Returns true if the two objects are the same object, or if their corresponding - real and imaginary components are equal, false otherwise. - - - The complex number to compare to with. - - - - - The hash code for the complex number. - - - The hash code of the complex number. - - - The hash code is calculated as - System.Math.Exp(ComplexMath.Absolute(complexNumber)). - - - - - Checks if two complex numbers are equal. Two complex numbers are equal if their - corresponding real and imaginary components are equal. - - - Returns true if the two objects are the same object, or if their corresponding - real and imaginary components are equal, false otherwise. - - - The complex number to compare to with. - - - - - Creates a complex number based on a string. The string can be in the - following formats (without the quotes): 'n', 'ni', 'n +/- ni', - 'ni +/- n', 'n,n', 'n,ni,' '(n,n)', or '(n,ni)', where n is a float. - - - A complex number containing the value specified by the given string. - - - the string to parse. - - - An that supplies culture-specific - formatting information. - - - - - Parse a part (real or complex) from a complex number. - - Start Token. - Is set to true if the part identified itself as being imaginary. - - An that supplies culture-specific - formatting information. - - Resulting part as float. - - - - - Converts the string representation of a complex number to a single-precision complex number equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a complex number to convert. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will contain complex32.Zero. This parameter is passed uninitialized - - - - - Converts the string representation of a complex number to single-precision complex number equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a complex number to convert. - - - An that supplies culture-specific formatting information about value. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will contain complex32.Zero. This parameter is passed uninitialized - - - - - Explicit conversion of a real decimal to a Complex32. - - The decimal value to convert. - The result of the conversion. - - - - Explicit conversion of a Complex to a Complex32. - - The decimal value to convert. - The result of the conversion. - - - - Implicit conversion of a real byte to a Complex32. - - The byte value to convert. - The result of the conversion. - - - - Implicit conversion of a real short to a Complex32. - - The short value to convert. - The result of the conversion. - - - - Implicit conversion of a signed byte to a Complex32. - - The signed byte value to convert. - The result of the conversion. - - - - Implicit conversion of a unsigned real short to a Complex32. - - The unsigned short value to convert. - The result of the conversion. - - - - Implicit conversion of a real int to a Complex32. - - The int value to convert. - The result of the conversion. - - - - Implicit conversion of a BigInteger int to a Complex32. - - The BigInteger value to convert. - The result of the conversion. - - - - Implicit conversion of a real long to a Complex32. - - The long value to convert. - The result of the conversion. - - - - Implicit conversion of a real uint to a Complex32. - - The uint value to convert. - The result of the conversion. - - - - Implicit conversion of a real ulong to a Complex32. - - The ulong value to convert. - The result of the conversion. - - - - Implicit conversion of a real float to a Complex32. - - The float value to convert. - The result of the conversion. - - - - Implicit conversion of a real double to a Complex32. - - The double value to convert. - The result of the conversion. - - - - Converts this Complex32 to a . - - A with the same values as this Complex32. - - - - Returns the additive inverse of a specified complex number. - - The result of the real and imaginary components of the value parameter multiplied by -1. - A complex number. - - - - Computes the conjugate of a complex number and returns the result. - - The conjugate of . - A complex number. - - - - Adds two complex numbers and returns the result. - - The sum of and . - The first complex number to add. - The second complex number to add. - - - - Subtracts one complex number from another and returns the result. - - The result of subtracting from . - The value to subtract from (the minuend). - The value to subtract (the subtrahend). - - - - Returns the product of two complex numbers. - - The product of the and parameters. - The first complex number to multiply. - The second complex number to multiply. - - - - Divides one complex number by another and returns the result. - - The quotient of the division. - The complex number to be divided. - The complex number to divide by. - - - - Returns the multiplicative inverse of a complex number. - - The reciprocal of . - A complex number. - - - - Returns the square root of a specified complex number. - - The square root of . - A complex number. - - - - Gets the absolute value (or magnitude) of a complex number. - - The absolute value of . - A complex number. - - - - Returns e raised to the power specified by a complex number. - - The number e raised to the power . - A complex number that specifies a power. - - - - Returns a specified complex number raised to a power specified by a complex number. - - The complex number raised to the power . - A complex number to be raised to a power. - A complex number that specifies a power. - - - - Returns a specified complex number raised to a power specified by a single-precision floating-point number. - - The complex number raised to the power . - A complex number to be raised to a power. - A single-precision floating-point number that specifies a power. - - - - Returns the natural (base e) logarithm of a specified complex number. - - The natural (base e) logarithm of . - A complex number. - - - - Returns the logarithm of a specified complex number in a specified base. - - The logarithm of in base . - A complex number. - The base of the logarithm. - - - - Returns the base-10 logarithm of a specified complex number. - - The base-10 logarithm of . - A complex number. - - - - Returns the sine of the specified complex number. - - The sine of . - A complex number. - - - - Returns the cosine of the specified complex number. - - The cosine of . - A complex number. - - - - Returns the tangent of the specified complex number. - - The tangent of . - A complex number. - - - - Returns the angle that is the arc sine of the specified complex number. - - The angle which is the arc sine of . - A complex number. - - - - Returns the angle that is the arc cosine of the specified complex number. - - The angle, measured in radians, which is the arc cosine of . - A complex number that represents a cosine. - - - - Returns the angle that is the arc tangent of the specified complex number. - - The angle that is the arc tangent of . - A complex number. - - - - Returns the hyperbolic sine of the specified complex number. - - The hyperbolic sine of . - A complex number. - - - - Returns the hyperbolic cosine of the specified complex number. - - The hyperbolic cosine of . - A complex number. - - - - Returns the hyperbolic tangent of the specified complex number. - - The hyperbolic tangent of . - A complex number. - - - - Extension methods for the Complex type provided by System.Numerics - - - - - Gets the squared magnitude of the Complex number. - - The number to perform this operation on. - The squared magnitude of the Complex number. - - - - Gets the squared magnitude of the Complex number. - - The number to perform this operation on. - The squared magnitude of the Complex number. - - - - Gets the unity of this complex (same argument, but on the unit circle; exp(I*arg)) - - The unity of this Complex. - - - - Gets the conjugate of the Complex number. - - The number to perform this operation on. - - The semantic of setting the conjugate is such that - - // a, b of type Complex32 - a.Conjugate = b; - - is equivalent to - - // a, b of type Complex32 - a = b.Conjugate - - - The conjugate of the number. - - - - Returns the multiplicative inverse of a complex number. - - - - - Exponential of this Complex (exp(x), E^x). - - The number to perform this operation on. - - The exponential of this complex number. - - - - - Natural Logarithm of this Complex (Base E). - - The number to perform this operation on. - - The natural logarithm of this complex number. - - - - - Common Logarithm of this Complex (Base 10). - - The common logarithm of this complex number. - - - - Logarithm of this Complex with custom base. - - The logarithm of this complex number. - - - - Raise this Complex to the given value. - - The number to perform this operation on. - - The exponent. - - - The complex number raised to the given exponent. - - - - - Raise this Complex to the inverse of the given value. - - The number to perform this operation on. - - The root exponent. - - - The complex raised to the inverse of the given exponent. - - - - - The Square (power 2) of this Complex - - The number to perform this operation on. - - The square of this complex number. - - - - - The Square Root (power 1/2) of this Complex - - The number to perform this operation on. - - The square root of this complex number. - - - - - Evaluate all square roots of this Complex. - - - - - Evaluate all cubic roots of this Complex. - - - - - Gets a value indicating whether the Complex32 is zero. - - The number to perform this operation on. - true if this instance is zero; otherwise, false. - - - - Gets a value indicating whether the Complex32 is one. - - The number to perform this operation on. - true if this instance is one; otherwise, false. - - - - Gets a value indicating whether the Complex32 is the imaginary unit. - - true if this instance is ImaginaryOne; otherwise, false. - The number to perform this operation on. - - - - Gets a value indicating whether the provided Complex32evaluates - to a value that is not a number. - - The number to perform this operation on. - - true if this instance is NaN; otherwise, - false. - - - - - Gets a value indicating whether the provided Complex32 evaluates to an - infinite value. - - The number to perform this operation on. - - true if this instance is infinite; otherwise, false. - - - True if it either evaluates to a complex infinity - or to a directed infinity. - - - - - Gets a value indicating whether the provided Complex32 is real. - - The number to perform this operation on. - true if this instance is a real number; otherwise, false. - - - - Gets a value indicating whether the provided Complex32 is real and not negative, that is >= 0. - - The number to perform this operation on. - - true if this instance is real nonnegative number; otherwise, false. - - - - - Returns a Norm of a value of this type, which is appropriate for measuring how - close this value is to zero. - - - - - Returns a Norm of a value of this type, which is appropriate for measuring how - close this value is to zero. - - - - - Returns a Norm of the difference of two values of this type, which is - appropriate for measuring how close together these two values are. - - - - - Returns a Norm of the difference of two values of this type, which is - appropriate for measuring how close together these two values are. - - - - - Creates a complex number based on a string. The string can be in the - following formats (without the quotes): 'n', 'ni', 'n +/- ni', - 'ni +/- n', 'n,n', 'n,ni,' '(n,n)', or '(n,ni)', where n is a double. - - - A complex number containing the value specified by the given string. - - - The string to parse. - - - - - Creates a complex number based on a string. The string can be in the - following formats (without the quotes): 'n', 'ni', 'n +/- ni', - 'ni +/- n', 'n,n', 'n,ni,' '(n,n)', or '(n,ni)', where n is a double. - - - A complex number containing the value specified by the given string. - - - the string to parse. - - - An that supplies culture-specific - formatting information. - - - - - Parse a part (real or complex) from a complex number. - - Start Token. - Is set to true if the part identified itself as being imaginary. - - An that supplies culture-specific - formatting information. - - Resulting part as double. - - - - - Converts the string representation of a complex number to a double-precision complex number equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a complex number to convert. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will contain Complex.Zero. This parameter is passed uninitialized. - - - - - Converts the string representation of a complex number to double-precision complex number equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a complex number to convert. - - - An that supplies culture-specific formatting information about value. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will contain complex32.Zero. This parameter is passed uninitialized - - - - - Creates a Complex32 number based on a string. The string can be in the - following formats (without the quotes): 'n', 'ni', 'n +/- ni', - 'ni +/- n', 'n,n', 'n,ni,' '(n,n)', or '(n,ni)', where n is a double. - - - A complex number containing the value specified by the given string. - - - the string to parse. - - - - - Creates a Complex32 number based on a string. The string can be in the - following formats (without the quotes): 'n', 'ni', 'n +/- ni', - 'ni +/- n', 'n,n', 'n,ni,' '(n,n)', or '(n,ni)', where n is a double. - - - A complex number containing the value specified by the given string. - - - the string to parse. - - - An that supplies culture-specific - formatting information. - - - - - Converts the string representation of a complex number to a single-precision complex number equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a complex number to convert. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will contain complex32.Zero. This parameter is passed uninitialized. - - - - - Converts the string representation of a complex number to single-precision complex number equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a complex number to convert. - - - An that supplies culture-specific formatting information about value. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will contain Complex.Zero. This parameter is passed uninitialized. - - - - - A collection of frequently used mathematical constants. - - - - The number e - - - The number log[2](e) - - - The number log[10](e) - - - The number log[e](2) - - - The number log[e](10) - - - The number log[e](pi) - - - The number log[e](2*pi)/2 - - - The number 1/e - - - The number sqrt(e) - - - The number sqrt(2) - - - The number sqrt(3) - - - The number sqrt(1/2) = 1/sqrt(2) = sqrt(2)/2 - - - The number sqrt(3)/2 - - - The number pi - - - The number pi*2 - - - The number pi/2 - - - The number pi*3/2 - - - The number pi/4 - - - The number sqrt(pi) - - - The number sqrt(2pi) - - - The number sqrt(pi/2) - - - The number sqrt(2*pi*e) - - - The number log(sqrt(2*pi)) - - - The number log(sqrt(2*pi*e)) - - - The number log(2 * sqrt(e / pi)) - - - The number 1/pi - - - The number 2/pi - - - The number 1/sqrt(pi) - - - The number 1/sqrt(2pi) - - - The number 2/sqrt(pi) - - - The number 2 * sqrt(e / pi) - - - The number (pi)/180 - factor to convert from Degree (deg) to Radians (rad). - - - - - The number (pi)/200 - factor to convert from NewGrad (grad) to Radians (rad). - - - - - The number ln(10)/20 - factor to convert from Power Decibel (dB) to Neper (Np). Use this version when the Decibel represent a power gain but the compared values are not powers (e.g. amplitude, current, voltage). - - - The number ln(10)/10 - factor to convert from Neutral Decibel (dB) to Neper (Np). Use this version when either both or neither of the Decibel and the compared values represent powers. - - - The Catalan constant - Sum(k=0 -> inf){ (-1)^k/(2*k + 1)2 } - - - The Euler-Mascheroni constant - lim(n -> inf){ Sum(k=1 -> n) { 1/k - log(n) } } - - - The number (1+sqrt(5))/2, also known as the golden ratio - - - The Glaisher constant - e^(1/12 - Zeta(-1)) - - - The Khinchin constant - prod(k=1 -> inf){1+1/(k*(k+2))^log(k,2)} - - - - The size of a double in bytes. - - - - - The size of an int in bytes. - - - - - The size of a float in bytes. - - - - - The size of a Complex in bytes. - - - - - The size of a Complex in bytes. - - - - Speed of Light in Vacuum: c_0 = 2.99792458e8 [m s^-1] (defined, exact; 2007 CODATA) - - - Magnetic Permeability in Vacuum: mu_0 = 4*Pi * 10^-7 [N A^-2 = kg m A^-2 s^-2] (defined, exact; 2007 CODATA) - - - Electric Permittivity in Vacuum: epsilon_0 = 1/(mu_0*c_0^2) [F m^-1 = A^2 s^4 kg^-1 m^-3] (defined, exact; 2007 CODATA) - - - Characteristic Impedance of Vacuum: Z_0 = mu_0*c_0 [Ohm = m^2 kg s^-3 A^-2] (defined, exact; 2007 CODATA) - - - Newtonian Constant of Gravitation: G = 6.67429e-11 [m^3 kg^-1 s^-2] (2007 CODATA) - - - Planck's constant: h = 6.62606896e-34 [J s = m^2 kg s^-1] (2007 CODATA) - - - Reduced Planck's constant: h_bar = h / (2*Pi) [J s = m^2 kg s^-1] (2007 CODATA) - - - Planck mass: m_p = (h_bar*c_0/G)^(1/2) [kg] (2007 CODATA) - - - Planck temperature: T_p = (h_bar*c_0^5/G)^(1/2)/k [K] (2007 CODATA) - - - Planck length: l_p = h_bar/(m_p*c_0) [m] (2007 CODATA) - - - Planck time: t_p = l_p/c_0 [s] (2007 CODATA) - - - Elementary Electron Charge: e = 1.602176487e-19 [C = A s] (2007 CODATA) - - - Magnetic Flux Quantum: theta_0 = h/(2*e) [Wb = m^2 kg s^-2 A^-1] (2007 CODATA) - - - Conductance Quantum: G_0 = 2*e^2/h [S = m^-2 kg^-1 s^3 A^2] (2007 CODATA) - - - Josephson Constant: K_J = 2*e/h [Hz V^-1] (2007 CODATA) - - - Von Klitzing Constant: R_K = h/e^2 [Ohm = m^2 kg s^-3 A^-2] (2007 CODATA) - - - Bohr Magneton: mu_B = e*h_bar/2*m_e [J T^-1] (2007 CODATA) - - - Nuclear Magneton: mu_N = e*h_bar/2*m_p [J T^-1] (2007 CODATA) - - - Fine Structure Constant: alpha = e^2/4*Pi*e_0*h_bar*c_0 [1] (2007 CODATA) - - - Rydberg Constant: R_infty = alpha^2*m_e*c_0/2*h [m^-1] (2007 CODATA) - - - Bor Radius: a_0 = alpha/4*Pi*R_infty [m] (2007 CODATA) - - - Hartree Energy: E_h = 2*R_infty*h*c_0 [J] (2007 CODATA) - - - Quantum of Circulation: h/2*m_e [m^2 s^-1] (2007 CODATA) - - - Fermi Coupling Constant: G_F/(h_bar*c_0)^3 [GeV^-2] (2007 CODATA) - - - Weak Mixin Angle: sin^2(theta_W) [1] (2007 CODATA) - - - Electron Mass: [kg] (2007 CODATA) - - - Electron Mass Energy Equivalent: [J] (2007 CODATA) - - - Electron Molar Mass: [kg mol^-1] (2007 CODATA) - - - Electron Compton Wavelength: [m] (2007 CODATA) - - - Classical Electron Radius: [m] (2007 CODATA) - - - Thomson Cross Section: [m^2] (2002 CODATA) - - - Electron Magnetic Moment: [J T^-1] (2007 CODATA) - - - Electon G-Factor: [1] (2007 CODATA) - - - Muon Mass: [kg] (2007 CODATA) - - - Muon Mass Energy Equivalent: [J] (2007 CODATA) - - - Muon Molar Mass: [kg mol^-1] (2007 CODATA) - - - Muon Compton Wavelength: [m] (2007 CODATA) - - - Muon Magnetic Moment: [J T^-1] (2007 CODATA) - - - Muon G-Factor: [1] (2007 CODATA) - - - Tau Mass: [kg] (2007 CODATA) - - - Tau Mass Energy Equivalent: [J] (2007 CODATA) - - - Tau Molar Mass: [kg mol^-1] (2007 CODATA) - - - Tau Compton Wavelength: [m] (2007 CODATA) - - - Proton Mass: [kg] (2007 CODATA) - - - Proton Mass Energy Equivalent: [J] (2007 CODATA) - - - Proton Molar Mass: [kg mol^-1] (2007 CODATA) - - - Proton Compton Wavelength: [m] (2007 CODATA) - - - Proton Magnetic Moment: [J T^-1] (2007 CODATA) - - - Proton G-Factor: [1] (2007 CODATA) - - - Proton Shielded Magnetic Moment: [J T^-1] (2007 CODATA) - - - Proton Gyro-Magnetic Ratio: [s^-1 T^-1] (2007 CODATA) - - - Proton Shielded Gyro-Magnetic Ratio: [s^-1 T^-1] (2007 CODATA) - - - Neutron Mass: [kg] (2007 CODATA) - - - Neutron Mass Energy Equivalent: [J] (2007 CODATA) - - - Neutron Molar Mass: [kg mol^-1] (2007 CODATA) - - - Neuron Compton Wavelength: [m] (2007 CODATA) - - - Neutron Magnetic Moment: [J T^-1] (2007 CODATA) - - - Neutron G-Factor: [1] (2007 CODATA) - - - Neutron Gyro-Magnetic Ratio: [s^-1 T^-1] (2007 CODATA) - - - Deuteron Mass: [kg] (2007 CODATA) - - - Deuteron Mass Energy Equivalent: [J] (2007 CODATA) - - - Deuteron Molar Mass: [kg mol^-1] (2007 CODATA) - - - Deuteron Magnetic Moment: [J T^-1] (2007 CODATA) - - - Helion Mass: [kg] (2007 CODATA) - - - Helion Mass Energy Equivalent: [J] (2007 CODATA) - - - Helion Molar Mass: [kg mol^-1] (2007 CODATA) - - - Avogadro constant: [mol^-1] (2010 CODATA) - - - The SI prefix factor corresponding to 1 000 000 000 000 000 000 000 000 - - - The SI prefix factor corresponding to 1 000 000 000 000 000 000 000 - - - The SI prefix factor corresponding to 1 000 000 000 000 000 000 - - - The SI prefix factor corresponding to 1 000 000 000 000 000 - - - The SI prefix factor corresponding to 1 000 000 000 000 - - - The SI prefix factor corresponding to 1 000 000 000 - - - The SI prefix factor corresponding to 1 000 000 - - - The SI prefix factor corresponding to 1 000 - - - The SI prefix factor corresponding to 100 - - - The SI prefix factor corresponding to 10 - - - The SI prefix factor corresponding to 0.1 - - - The SI prefix factor corresponding to 0.01 - - - The SI prefix factor corresponding to 0.001 - - - The SI prefix factor corresponding to 0.000 001 - - - The SI prefix factor corresponding to 0.000 000 001 - - - The SI prefix factor corresponding to 0.000 000 000 001 - - - The SI prefix factor corresponding to 0.000 000 000 000 001 - - - The SI prefix factor corresponding to 0.000 000 000 000 000 001 - - - The SI prefix factor corresponding to 0.000 000 000 000 000 000 001 - - - The SI prefix factor corresponding to 0.000 000 000 000 000 000 000 001 - - - - Sets parameters for the library. - - - - - Use a specific provider if configured, e.g. using - environment variables, or fall back to the best providers. - - - - - Use the best provider available. - - - - - Use the Intel MKL native provider for linear algebra. - Throws if it is not available or failed to initialize, in which case the previous provider is still active. - - - - - Try to use the Intel MKL native provider for linear algebra. - - - True if the provider was found and initialized successfully. - False if it failed and the previous provider is still active. - - - - - Use the Nvidia CUDA native provider for linear algebra. - Throws if it is not available or failed to initialize, in which case the previous provider is still active. - - - - - Try to use the Nvidia CUDA native provider for linear algebra. - - - True if the provider was found and initialized successfully. - False if it failed and the previous provider is still active. - - - - - Use the OpenBLAS native provider for linear algebra. - Throws if it is not available or failed to initialize, in which case the previous provider is still active. - - - - - Try to use the OpenBLAS native provider for linear algebra. - - - True if the provider was found and initialized successfully. - False if it failed and the previous provider is still active. - - - - - Try to use any available native provider in an undefined order. - - - True if one of the native providers was found and successfully initialized. - False if it failed and the previous provider is still active. - - - - - Gets or sets a value indicating whether the distribution classes check validate each parameter. - For the multivariate distributions this could involve an expensive matrix factorization. - The default setting of this property is true. - - - - - Gets or sets a value indicating whether to use thread safe random number generators (RNG). - Thread safe RNG about two and half time slower than non-thread safe RNG. - - - true to use thread safe random number generators ; otherwise, false. - - - - - Optional path to try to load native provider binaries from. - - - - - Gets or sets a value indicating how many parallel worker threads shall be used - when parallelization is applicable. - - Default to the number of processor cores, must be between 1 and 1024 (inclusive). - - - - Gets or sets the TaskScheduler used to schedule the worker tasks. - - - - - Gets or sets the order of the matrix when linear algebra provider - must calculate multiply in parallel threads. - - The order. Default 64, must be at least 3. - - - - Gets or sets the number of elements a vector or matrix - must contain before we multiply threads. - - Number of elements. Default 300, must be at least 3. - - - - Numerical Derivative. - - - - - Initialized a NumericalDerivative with the given points and center. - - - - - Initialized a NumericalDerivative with the default points and center for the given order. - - - - - Evaluates the derivative of a scalar univariate function. - - Univariate function handle. - Point at which to evaluate the derivative. - Derivative order. - - - - Creates a function handle for the derivative of a scalar univariate function. - - Univariate function handle. - Derivative order. - - - - Evaluates the first derivative of a scalar univariate function. - - Univariate function handle. - Point at which to evaluate the derivative. - - - - Creates a function handle for the first derivative of a scalar univariate function. - - Univariate function handle. - - - - Evaluates the second derivative of a scalar univariate function. - - Univariate function handle. - Point at which to evaluate the derivative. - - - - Creates a function handle for the second derivative of a scalar univariate function. - - Univariate function handle. - - - - Evaluates the partial derivative of a multivariate function. - - Multivariate function handle. - Vector at which to evaluate the derivative. - Index of independent variable for partial derivative. - Derivative order. - - - - Creates a function handle for the partial derivative of a multivariate function. - - Multivariate function handle. - Index of independent variable for partial derivative. - Derivative order. - - - - Evaluates the first partial derivative of a multivariate function. - - Multivariate function handle. - Vector at which to evaluate the derivative. - Index of independent variable for partial derivative. - - - - Creates a function handle for the first partial derivative of a multivariate function. - - Multivariate function handle. - Index of independent variable for partial derivative. - - - - Evaluates the partial derivative of a bivariate function. - - Bivariate function handle. - First argument at which to evaluate the derivative. - Second argument at which to evaluate the derivative. - Index of independent variable for partial derivative. - Derivative order. - - - - Creates a function handle for the partial derivative of a bivariate function. - - Bivariate function handle. - Index of independent variable for partial derivative. - Derivative order. - - - - Evaluates the first partial derivative of a bivariate function. - - Bivariate function handle. - First argument at which to evaluate the derivative. - Second argument at which to evaluate the derivative. - Index of independent variable for partial derivative. - - - - Creates a function handle for the first partial derivative of a bivariate function. - - Bivariate function handle. - Index of independent variable for partial derivative. - - - - Class to calculate finite difference coefficients using Taylor series expansion method. - - - For n points, coefficients are calculated up to the maximum derivative order possible (n-1). - The current function value position specifies the "center" for surrounding coefficients. - Selecting the first, middle or last positions represent forward, backwards and central difference methods. - - - - - - - Number of points for finite difference coefficients. Changing this value recalculates the coefficients table. - - - - - Initializes a new instance of the class. - - Number of finite difference coefficients. - - - - Gets the finite difference coefficients for a specified center and order. - - Current function position with respect to coefficients. Must be within point range. - Order of finite difference coefficients. - Vector of finite difference coefficients. - - - - Gets the finite difference coefficients for all orders at a specified center. - - Current function position with respect to coefficients. Must be within point range. - Rectangular array of coefficients, with columns specifying order. - - - - Type of finite different step size. - - - - - The absolute step size value will be used in numerical derivatives, regardless of order or function parameters. - - - - - A base step size value, h, will be scaled according to the function input parameter. A common example is hx = h*(1+abs(x)), however - this may vary depending on implementation. This definition only guarantees that the only scaling will be relative to the - function input parameter and not the order of the finite difference derivative. - - - - - A base step size value, eps (typically machine precision), is scaled according to the finite difference coefficient order - and function input parameter. The initial scaling according to finite different coefficient order can be thought of as producing a - base step size, h, that is equivalent to scaling. This step size is then scaled according to the function - input parameter. Although implementation may vary, an example of second order accurate scaling may be (eps)^(1/3)*(1+abs(x)). - - - - - Class to evaluate the numerical derivative of a function using finite difference approximations. - Variable point and center methods can be initialized . - This class can also be used to return function handles (delegates) for a fixed derivative order and variable. - It is possible to evaluate the derivative and partial derivative of univariate and multivariate functions respectively. - - - - - Initializes a NumericalDerivative class with the default 3 point center difference method. - - - - - Initialized a NumericalDerivative class. - - Number of points for finite difference derivatives. - Location of the center with respect to other points. Value ranges from zero to points-1. - - - - Sets and gets the finite difference step size. This value is for each function evaluation if relative step size types are used. - If the base step size used in scaling is desired, see . - - - Setting then getting the StepSize may return a different value. This is not unusual since a user-defined step size is converted to a - base-2 representable number to improve finite difference accuracy. - - - - - Sets and gets the base finite difference step size. This assigned value to this parameter is only used if is set to RelativeX. - However, if the StepType is Relative, it will contain the base step size computed from based on the finite difference order. - - - - - Sets and gets the base finite difference step size. This parameter is only used if is set to Relative. - By default this is set to machine epsilon, from which is computed. - - - - - Sets and gets the location of the center point for the finite difference derivative. - - - - - Number of times a function is evaluated for numerical derivatives. - - - - - Type of step size for computing finite differences. If set to absolute, dx = h. - If set to relative, dx = (1+abs(x))*h^(2/(order+1)). This provides accurate results when - h is approximately equal to the square-root of machine accuracy, epsilon. - - - - - Evaluates the derivative of equidistant points using the finite difference method. - - Vector of points StepSize apart. - Derivative order. - Finite difference step size. - Derivative of points of the specified order. - - - - Evaluates the derivative of a scalar univariate function. - - - Supplying the optional argument currentValue will reduce the number of function evaluations - required to calculate the finite difference derivative. - - Function handle. - Point at which to compute the derivative. - Derivative order. - Current function value at center. - Function derivative at x of the specified order. - - - - Creates a function handle for the derivative of a scalar univariate function. - - Input function handle. - Derivative order. - Function handle that evaluates the derivative of input function at a fixed order. - - - - Evaluates the partial derivative of a multivariate function. - - Multivariate function handle. - Vector at which to evaluate the derivative. - Index of independent variable for partial derivative. - Derivative order. - Current function value at center. - Function partial derivative at x of the specified order. - - - - Evaluates the partial derivatives of a multivariate function array. - - - This function assumes the input vector x is of the correct length for f. - - Multivariate vector function array handle. - Vector at which to evaluate the derivatives. - Index of independent variable for partial derivative. - Derivative order. - Current function value at center. - Vector of functions partial derivatives at x of the specified order. - - - - Creates a function handle for the partial derivative of a multivariate function. - - Input function handle. - Index of the independent variable for partial derivative. - Derivative order. - Function handle that evaluates partial derivative of input function at a fixed order. - - - - Creates a function handle for the partial derivative of a vector multivariate function. - - Input function handle. - Index of the independent variable for partial derivative. - Derivative order. - Function handle that evaluates partial derivative of input function at fixed order. - - - - Evaluates the mixed partial derivative of variable order for multivariate functions. - - - This function recursively uses to evaluate mixed partial derivative. - Therefore, it is more efficient to call for higher order derivatives of - a single independent variable. - - Multivariate function handle. - Points at which to evaluate the derivative. - Vector of indices for the independent variables at descending derivative orders. - Highest order of differentiation. - Current function value at center. - Function mixed partial derivative at x of the specified order. - - - - Evaluates the mixed partial derivative of variable order for multivariate function arrays. - - - This function recursively uses to evaluate mixed partial derivative. - Therefore, it is more efficient to call for higher order derivatives of - a single independent variable. - - Multivariate function array handle. - Vector at which to evaluate the derivative. - Vector of indices for the independent variables at descending derivative orders. - Highest order of differentiation. - Current function value at center. - Function mixed partial derivatives at x of the specified order. - - - - Creates a function handle for the mixed partial derivative of a multivariate function. - - Input function handle. - Vector of indices for the independent variables at descending derivative orders. - Highest derivative order. - Function handle that evaluates the fixed mixed partial derivative of input function at fixed order. - - - - Creates a function handle for the mixed partial derivative of a multivariate vector function. - - Input vector function handle. - Vector of indices for the independent variables at descending derivative orders. - Highest derivative order. - Function handle that evaluates the fixed mixed partial derivative of input function at fixed order. - - - - Resets the evaluation counter. - - - - - Class for evaluating the Hessian of a smooth continuously differentiable function using finite differences. - By default, a central 3-point method is used. - - - - - Number of function evaluations. - - - - - Creates a numerical Hessian object with a three point central difference method. - - - - - Creates a numerical Hessian with a specified differentiation scheme. - - Number of points for Hessian evaluation. - Center point for differentiation. - - - - Evaluates the Hessian of the scalar univariate function f at points x. - - Scalar univariate function handle. - Point at which to evaluate Hessian. - Hessian tensor. - - - - Evaluates the Hessian of a multivariate function f at points x. - - - This method of computing the Hessian is only valid for Lipschitz continuous functions. - The function mirrors the Hessian along the diagonal since d2f/dxdy = d2f/dydx for continuously differentiable functions. - - Multivariate function handle.> - Points at which to evaluate Hessian.> - Hessian tensor. - - - - Resets the function evaluation counter for the Hessian. - - - - - Class for evaluating the Jacobian of a function using finite differences. - By default, a central 3-point method is used. - - - - - Number of function evaluations. - - - - - Creates a numerical Jacobian object with a three point central difference method. - - - - - Creates a numerical Jacobian with a specified differentiation scheme. - - Number of points for Jacobian evaluation. - Center point for differentiation. - - - - Evaluates the Jacobian of scalar univariate function f at point x. - - Scalar univariate function handle. - Point at which to evaluate Jacobian. - Jacobian vector. - - - - Evaluates the Jacobian of a multivariate function f at vector x. - - - This function assumes that the length of vector x consistent with the argument count of f. - - Multivariate function handle. - Points at which to evaluate Jacobian. - Jacobian vector. - - - - Evaluates the Jacobian of a multivariate function f at vector x given a current function value. - - - To minimize the number of function evaluations, a user can supply the current value of the function - to be used in computing the Jacobian. This value must correspond to the "center" location for the - finite differencing. If a scheme is used where the center value is not evaluated, this will provide no - added efficiency. This method also assumes that the length of vector x consistent with the argument count of f. - - Multivariate function handle. - Points at which to evaluate Jacobian. - Current function value at finite difference center. - Jacobian vector. - - - - Evaluates the Jacobian of a multivariate function array f at vector x. - - Multivariate function array handle. - Vector at which to evaluate Jacobian. - Jacobian matrix. - - - - Evaluates the Jacobian of a multivariate function array f at vector x given a vector of current function values. - - - To minimize the number of function evaluations, a user can supply a vector of current values of the functions - to be used in computing the Jacobian. These value must correspond to the "center" location for the - finite differencing. If a scheme is used where the center value is not evaluated, this will provide no - added efficiency. This method also assumes that the length of vector x consistent with the argument count of f. - - Multivariate function array handle. - Vector at which to evaluate Jacobian. - Vector of current function values. - Jacobian matrix. - - - - Resets the function evaluation counter for the Jacobian. - - - - - Evaluates the Riemann-Liouville fractional derivative that uses the double exponential integration. - - - order = 1.0 : normal derivative - order = 0.5 : semi-derivative - order = -0.5 : semi-integral - order = -1.0 : normal integral - - The analytic smooth function to differintegrate. - The evaluation point. - The order of fractional derivative. - The reference point of integration. - The expected relative accuracy of the Double-Exponential integration. - Approximation of the differintegral of order n at x. - - - - Evaluates the Riemann-Liouville fractional derivative that uses the Gauss-Legendre integration. - - - order = 1.0 : normal derivative - order = 0.5 : semi-derivative - order = -0.5 : semi-integral - order = -1.0 : normal integral - - The analytic smooth function to differintegrate. - The evaluation point. - The order of fractional derivative. - The reference point of integration. - The number of Gauss-Legendre points. - Approximation of the differintegral of order n at x. - - - - Evaluates the Riemann-Liouville fractional derivative that uses the Gauss-Kronrod integration. - - - order = 1.0 : normal derivative - order = 0.5 : semi-derivative - order = -0.5 : semi-integral - order = -1.0 : normal integral - - The analytic smooth function to differintegrate. - The evaluation point. - The order of fractional derivative. - The reference point of integration. - The expected relative accuracy of the Gauss-Kronrod integration. - The number of Gauss-Kronrod points. Pre-computed for 15, 21, 31, 41, 51 and 61 points. - Approximation of the differintegral of order n at x. - - - - Metrics to measure the distance between two structures. - - - - - Sum of Absolute Difference (SAD), i.e. the L1-norm (Manhattan) of the difference. - - - - - Sum of Absolute Difference (SAD), i.e. the L1-norm (Manhattan) of the difference. - - - - - Sum of Absolute Difference (SAD), i.e. the L1-norm (Manhattan) of the difference. - - - - - Mean-Absolute Error (MAE), i.e. the normalized L1-norm (Manhattan) of the difference. - - - - - Mean-Absolute Error (MAE), i.e. the normalized L1-norm (Manhattan) of the difference. - - - - - Mean-Absolute Error (MAE), i.e. the normalized L1-norm (Manhattan) of the difference. - - - - - Sum of Squared Difference (SSD), i.e. the squared L2-norm (Euclidean) of the difference. - - - - - Sum of Squared Difference (SSD), i.e. the squared L2-norm (Euclidean) of the difference. - - - - - Sum of Squared Difference (SSD), i.e. the squared L2-norm (Euclidean) of the difference. - - - - - Mean-Squared Error (MSE), i.e. the normalized squared L2-norm (Euclidean) of the difference. - - - - - Mean-Squared Error (MSE), i.e. the normalized squared L2-norm (Euclidean) of the difference. - - - - - Mean-Squared Error (MSE), i.e. the normalized squared L2-norm (Euclidean) of the difference. - - - - - Euclidean Distance, i.e. the L2-norm of the difference. - - - - - Euclidean Distance, i.e. the L2-norm of the difference. - - - - - Euclidean Distance, i.e. the L2-norm of the difference. - - - - - Manhattan Distance, i.e. the L1-norm of the difference. - - - - - Manhattan Distance, i.e. the L1-norm of the difference. - - - - - Manhattan Distance, i.e. the L1-norm of the difference. - - - - - Chebyshev Distance, i.e. the Infinity-norm of the difference. - - - - - Chebyshev Distance, i.e. the Infinity-norm of the difference. - - - - - Chebyshev Distance, i.e. the Infinity-norm of the difference. - - - - - Minkowski Distance, i.e. the generalized p-norm of the difference. - - - - - Minkowski Distance, i.e. the generalized p-norm of the difference. - - - - - Minkowski Distance, i.e. the generalized p-norm of the difference. - - - - - Canberra Distance, a weighted version of the L1-norm of the difference. - - - - - Canberra Distance, a weighted version of the L1-norm of the difference. - - - - - Cosine Distance, representing the angular distance while ignoring the scale. - - - - - Cosine Distance, representing the angular distance while ignoring the scale. - - - - - Hamming Distance, i.e. the number of positions that have different values in the vectors. - - - - - Hamming Distance, i.e. the number of positions that have different values in the vectors. - - - - - Pearson's distance, i.e. 1 - the person correlation coefficient. - - - - - Jaccard distance, i.e. 1 - the Jaccard index. - - Thrown if a or b are null. - Throw if a and b are of different lengths. - Jaccard distance. - - - - Jaccard distance, i.e. 1 - the Jaccard index. - - Thrown if a or b are null. - Throw if a and b are of different lengths. - Jaccard distance. - - - - Discrete Univariate Bernoulli distribution. - The Bernoulli distribution is a distribution over bits. The parameter - p specifies the probability that a 1 is generated. - Wikipedia - Bernoulli distribution. - - - - - Initializes a new instance of the Bernoulli class. - - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - If the Bernoulli parameter is not in the range [0,1]. - - - - Initializes a new instance of the Bernoulli class. - - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - The random number generator which is used to draw random samples. - If the Bernoulli parameter is not in the range [0,1]. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - - - - Gets the probability of generating a one. Range: 0 ≤ p ≤ 1. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the smallest element in the domain of the distributions which can be represented by an integer. - - - - - Gets the largest element in the domain of the distributions which can be represented by an integer. - - - - - Gets the mode of the distribution. - - - - - Gets all modes of the distribution. - - - - - Gets the median of the distribution. - - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - the cumulative distribution at location . - - - - - Generates one sample from the Bernoulli distribution. - - The random source to use. - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - A random sample from the Bernoulli distribution. - - - - Samples a Bernoulli distributed random variable. - - A sample from the Bernoulli distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Samples an array of Bernoulli distributed random variables. - - a sequence of samples from the distribution. - - - - Samples a Bernoulli distributed random variable. - - The random number generator to use. - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - A sample from the Bernoulli distribution. - - - - Samples a sequence of Bernoulli distributed random variables. - - The random number generator to use. - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - a sequence of samples from the distribution. - - - - Samples a Bernoulli distributed random variable. - - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - A sample from the Bernoulli distribution. - - - - Samples a sequence of Bernoulli distributed random variables. - - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - a sequence of samples from the distribution. - - - - Continuous Univariate Beta distribution. - For details about this distribution, see - Wikipedia - Beta distribution. - - - There are a few special cases for the parameterization of the Beta distribution. When both - shape parameters are positive infinity, the Beta distribution degenerates to a point distribution - at 0.5. When one of the shape parameters is positive infinity, the distribution degenerates to a point - distribution at the positive infinity. When both shape parameters are 0.0, the Beta distribution - degenerates to a Bernoulli distribution with parameter 0.5. When one shape parameter is 0.0, the - distribution degenerates to a point distribution at the non-zero shape parameter. - - - - - Initializes a new instance of the Beta class. - - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - - - - Initializes a new instance of the Beta class. - - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - The random number generator which is used to draw random samples. - - - - A string representation of the distribution. - - A string representation of the Beta distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - - - - Gets the α shape parameter of the Beta distribution. Range: α ≥ 0. - - - - - Gets the β shape parameter of the Beta distribution. Range: β ≥ 0. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the Beta distribution. - - - - - Gets the variance of the Beta distribution. - - - - - Gets the standard deviation of the Beta distribution. - - - - - Gets the entropy of the Beta distribution. - - - - - Gets the skewness of the Beta distribution. - - - - - Gets the mode of the Beta distribution; when there are multiple answers, this routine will return 0.5. - - - - - Gets the median of the Beta distribution. - - - - - Gets the minimum of the Beta distribution. - - - - - Gets the maximum of the Beta distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - WARNING: currently not an explicit implementation, hence slow and unreliable. - - - - Generates a sample from the Beta distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the Beta distribution. - - a sequence of samples from the distribution. - - - - Samples Beta distributed random variables by sampling two Gamma variables and normalizing. - - The random number generator to use. - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - a random number from the Beta distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - the inverse cumulative density at . - - WARNING: currently not an explicit implementation, hence slow and unreliable. - - - - Generates a sample from the distribution. - - The random number generator to use. - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The random number generator to use. - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - a sequence of samples from the distribution. - - - - Generates a sample from the distribution. - - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - a sequence of samples from the distribution. - - - - Discrete Univariate Beta-Binomial distribution. - The beta-binomial distribution is a family of discrete probability distributions on a finite support of non-negative integers arising - when the probability of success in each of a fixed or known number of Bernoulli trials is either unknown or random. - The beta-binomial distribution is the binomial distribution in which the probability of success at each of n trials is not fixed but randomly drawn from a beta distribution. - It is frequently used in Bayesian statistics, empirical Bayes methods and classical statistics to capture overdispersion in binomial type distributed data. - Wikipedia - Beta-Binomial distribution. - - - - - Initializes a new instance of the class. - - The number of Bernoulli trials n - n is a positive integer - Shape parameter alpha of the Beta distribution. Range: a > 0. - Shape parameter beta of the Beta distribution. Range: b > 0. - - - - Initializes a new instance of the class. - - The number of Bernoulli trials n - n is a positive integer - Shape parameter alpha of the Beta distribution. Range: a > 0. - Shape parameter beta of the Beta distribution. Range: b > 0. - The random number generator which is used to draw random samples. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Tests whether the provided values are valid parameters for this distribution. - - The number of Bernoulli trials n - n is a positive integer - Shape parameter alpha of the Beta distribution. Range: a > 0. - Shape parameter beta of the Beta distribution. Range: b > 0. - - - - Tests whether the provided values are valid parameters for this distribution. - - The number of Bernoulli trials n - n is a positive integer - Shape parameter alpha of the Beta distribution. Range: a > 0. - Shape parameter beta of the Beta distribution. Range: b > 0. - The location in the domain where we want to evaluate the probability mass function. - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the mode of the distribution - - - - - Gets the median of the distribution. - - - - - Gets the smallest element in the domain of the distributions which can be represented by an integer. - - - - - Gets the largest element in the domain of the distributions which can be represented by an integer. - - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The number of Bernoulli trials n - n is a positive integer - Shape parameter alpha of the Beta distribution. Range: a > 0. - Shape parameter beta of the Beta distribution. Range: b > 0. - The location in the domain where we want to evaluate the probability mass function. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The number of Bernoulli trials n - n is a positive integer - Shape parameter alpha of the Beta distribution. Range: a > 0. - Shape parameter beta of the Beta distribution. Range: b > 0. - The location in the domain where we want to evaluate the probability mass function. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The number of Bernoulli trials n - n is a positive integer - Shape parameter alpha of the Beta distribution. Range: a > 0. - Shape parameter beta of the Beta distribution. Range: b > 0. - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Samples BetaBinomial distributed random variables by sampling a Beta distribution then passing to a Binomial distribution. - - The random number generator to use. - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - The number of trials (n). Range: n ≥ 0. - a random number from the BetaBinomial distribution. - - - - Samples a BetaBinomial distributed random variable. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Samples an array of BetaBinomial distributed random variables. - - a sequence of samples from the distribution. - - - - Samples a BetaBinomial distributed random variable. - - The random number generator to use. - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - The number of trials (n). Range: n ≥ 0. - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - The number of trials (n). Range: n ≥ 0. - - - - Samples an array of BetaBinomial distributed random variables. - - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - The number of trials (n). Range: n ≥ 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The α shape parameter of the Beta distribution. Range: α ≥ 0. - The β shape parameter of the Beta distribution. Range: β ≥ 0. - The number of trials (n). Range: n ≥ 0. - - - - Initializes a new instance of the BetaScaled class. - - The α shape parameter of the BetaScaled distribution. Range: α > 0. - The β shape parameter of the BetaScaled distribution. Range: β > 0. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - - - - Initializes a new instance of the BetaScaled class. - - The α shape parameter of the BetaScaled distribution. Range: α > 0. - The β shape parameter of the BetaScaled distribution. Range: β > 0. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The random number generator which is used to draw random samples. - - - - Create a Beta PERT distribution, used in risk analysis and other domains where an expert forecast - is used to construct an underlying beta distribution. - - The minimum value. - The maximum value. - The most likely value (mode). - The random number generator which is used to draw random samples. - The Beta distribution derived from the PERT parameters. - - - - A string representation of the distribution. - - A string representation of the BetaScaled distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The α shape parameter of the BetaScaled distribution. Range: α > 0. - The β shape parameter of the BetaScaled distribution. Range: β > 0. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - - - - Gets the α shape parameter of the BetaScaled distribution. Range: α > 0. - - - - - Gets the β shape parameter of the BetaScaled distribution. Range: β > 0. - - - - - Gets the location (μ) of the BetaScaled distribution. - - - - - Gets the scale (σ) of the BetaScaled distribution. Range: σ > 0. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the BetaScaled distribution. - - - - - Gets the variance of the BetaScaled distribution. - - - - - Gets the standard deviation of the BetaScaled distribution. - - - - - Gets the entropy of the BetaScaled distribution. - - - - - Gets the skewness of the BetaScaled distribution. - - - - - Gets the mode of the BetaScaled distribution; when there are multiple answers, this routine will return 0.5. - - - - - Gets the median of the BetaScaled distribution. - - - - - Gets the minimum of the BetaScaled distribution. - - - - - Gets the maximum of the BetaScaled distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - WARNING: currently not an explicit implementation, hence slow and unreliable. - - - - Generates a sample from the distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the distribution. - - a sequence of samples from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The α shape parameter of the BetaScaled distribution. Range: α > 0. - The β shape parameter of the BetaScaled distribution. Range: β > 0. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The α shape parameter of the BetaScaled distribution. Range: α > 0. - The β shape parameter of the BetaScaled distribution. Range: β > 0. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The α shape parameter of the BetaScaled distribution. Range: α > 0. - The β shape parameter of the BetaScaled distribution. Range: β > 0. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The α shape parameter of the BetaScaled distribution. Range: α > 0. - The β shape parameter of the BetaScaled distribution. Range: β > 0. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - WARNING: currently not an explicit implementation, hence slow and unreliable. - - - - Generates a sample from the distribution. - - The random number generator to use. - The α shape parameter of the BetaScaled distribution. Range: α > 0. - The β shape parameter of the BetaScaled distribution. Range: β > 0. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The random number generator to use. - The α shape parameter of the BetaScaled distribution. Range: α > 0. - The β shape parameter of the BetaScaled distribution. Range: β > 0. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The α shape parameter of the BetaScaled distribution. Range: α > 0. - The β shape parameter of the BetaScaled distribution. Range: β > 0. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - a sequence of samples from the distribution. - - - - Generates a sample from the distribution. - - The α shape parameter of the BetaScaled distribution. Range: α > 0. - The β shape parameter of the BetaScaled distribution. Range: β > 0. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The α shape parameter of the BetaScaled distribution. Range: α > 0. - The β shape parameter of the BetaScaled distribution. Range: β > 0. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The α shape parameter of the BetaScaled distribution. Range: α > 0. - The β shape parameter of the BetaScaled distribution. Range: β > 0. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - a sequence of samples from the distribution. - - - - Discrete Univariate Binomial distribution. - For details about this distribution, see - Wikipedia - Binomial distribution. - - - The distribution is parameterized by a probability (between 0.0 and 1.0). - - - - - Initializes a new instance of the Binomial class. - - The success probability (p) in each trial. Range: 0 ≤ p ≤ 1. - The number of trials (n). Range: n ≥ 0. - If is not in the interval [0.0,1.0]. - If is negative. - - - - Initializes a new instance of the Binomial class. - - The success probability (p) in each trial. Range: 0 ≤ p ≤ 1. - The number of trials (n). Range: n ≥ 0. - The random number generator which is used to draw random samples. - If is not in the interval [0.0,1.0]. - If is negative. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The success probability (p) in each trial. Range: 0 ≤ p ≤ 1. - The number of trials (n). Range: n ≥ 0. - - - - Gets the success probability in each trial. Range: 0 ≤ p ≤ 1. - - - - - Gets the number of trials. Range: n ≥ 0. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the smallest element in the domain of the distributions which can be represented by an integer. - - - - - Gets the largest element in the domain of the distributions which can be represented by an integer. - - - - - Gets the mode of the distribution. - - - - - Gets all modes of the distribution. - - - - - Gets the median of the distribution. - - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - The success probability (p) in each trial. Range: 0 ≤ p ≤ 1. - The number of trials (n). Range: n ≥ 0. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - The success probability (p) in each trial. Range: 0 ≤ p ≤ 1. - The number of trials (n). Range: n ≥ 0. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The success probability (p) in each trial. Range: 0 ≤ p ≤ 1. - The number of trials (n). Range: n ≥ 0. - the cumulative distribution at location . - - - - - Generates a sample from the Binomial distribution without doing parameter checking. - - The random number generator to use. - The success probability (p) in each trial. Range: 0 ≤ p ≤ 1. - The number of trials (n). Range: n ≥ 0. - The number of successful trials. - - - - Samples a Binomially distributed random variable. - - The number of successes in N trials. - - - - Fills an array with samples generated from the distribution. - - - - - Samples an array of Binomially distributed random variables. - - a sequence of successes in N trials. - - - - Samples a binomially distributed random variable. - - The random number generator to use. - The success probability (p) in each trial. Range: 0 ≤ p ≤ 1. - The number of trials (n). Range: n ≥ 0. - The number of successes in trials. - - - - Samples a sequence of binomially distributed random variable. - - The random number generator to use. - The success probability (p) in each trial. Range: 0 ≤ p ≤ 1. - The number of trials (n). Range: n ≥ 0. - a sequence of successes in trials. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The success probability (p) in each trial. Range: 0 ≤ p ≤ 1. - The number of trials (n). Range: n ≥ 0. - a sequence of successes in trials. - - - - Samples a binomially distributed random variable. - - The success probability (p) in each trial. Range: 0 ≤ p ≤ 1. - The number of trials (n). Range: n ≥ 0. - The number of successes in trials. - - - - Samples a sequence of binomially distributed random variable. - - The success probability (p) in each trial. Range: 0 ≤ p ≤ 1. - The number of trials (n). Range: n ≥ 0. - a sequence of successes in trials. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The success probability (p) in each trial. Range: 0 ≤ p ≤ 1. - The number of trials (n). Range: n ≥ 0. - a sequence of successes in trials. - - - - Gets the scale (a) of the distribution. Range: a > 0. - - - - - Gets the first shape parameter (c) of the distribution. Range: c > 0. - - - - - Gets the second shape parameter (k) of the distribution. Range: k > 0. - - - - - Initializes a new instance of the Burr Type XII class. - - The scale parameter a of the Burr distribution. Range: a > 0. - The first shape parameter c of the Burr distribution. Range: c > 0. - The second shape parameter k of the Burr distribution. Range: k > 0. - The random number generator which is used to draw random samples. Optional, can be null. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The scale parameter a of the Burr distribution. Range: a > 0. - The first shape parameter c of the Burr distribution. Range: c > 0. - The second shape parameter k of the Burr distribution. Range: k > 0. - - - - Gets the random number generator which is used to draw random samples. - - - - - Gets the mean of the Burr distribution. - - - - - Gets the variance of the Burr distribution. - - - - - Gets the standard deviation of the Burr distribution. - - - - - Gets the mode of the Burr distribution. - - - - - Gets the minimum of the Burr distribution. - - - - - Gets the maximum of the Burr distribution. - - - - - Gets the entropy of the Burr distribution (currently not supported). - - - - - Gets the skewness of the Burr distribution. - - - - - Gets the median of the Burr distribution. - - - - - Generates a sample from the Burr distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - - - - Generates a sequence of samples from the Burr distribution. - - a sequence of samples from the distribution. - - - - Generates a sample from the Burr distribution. - - The random number generator to use. - The scale parameter a of the Burr distribution. Range: a > 0. - The first shape parameter c of the Burr distribution. Range: c > 0. - The second shape parameter k of the Burr distribution. Range: k > 0. - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The scale parameter a of the Burr distribution. Range: a > 0. - The first shape parameter c of the Burr distribution. Range: c > 0. - The second shape parameter k of the Burr distribution. Range: k > 0. - - - - Generates a sequence of samples from the Burr distribution. - - The random number generator to use. - The scale parameter a of the Burr distribution. Range: a > 0. - The first shape parameter c of the Burr distribution. Range: c > 0. - The second shape parameter k of the Burr distribution. Range: k > 0. - a sequence of samples from the distribution. - - - - Gets the n-th raw moment of the distribution. - - The order (n) of the moment. Range: n ≥ 1. - the n-th moment of the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The scale parameter a of the Burr distribution. Range: a > 0. - The first shape parameter c of the Burr distribution. Range: c > 0. - The second shape parameter k of the Burr distribution. Range: k > 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The scale parameter a of the Burr distribution. Range: a > 0. - The first shape parameter c of the Burr distribution. Range: c > 0. - The second shape parameter k of the Burr distribution. Range: k > 0. - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The scale parameter a of the Burr distribution. Range: a > 0. - The first shape parameter c of the Burr distribution. Range: c > 0. - The second shape parameter k of the Burr distribution. Range: k > 0. - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Discrete Univariate Categorical distribution. - For details about this distribution, see - Wikipedia - Categorical distribution. This - distribution is sometimes called the Discrete distribution. - - - The distribution is parameterized by a vector of ratios: in other words, the parameter - does not have to be normalized and sum to 1. The reason is that some vectors can't be exactly normalized - to sum to 1 in floating point representation. - - - Support: 0..k where k = length(probability mass array)-1 - - - - - Initializes a new instance of the Categorical class. - - An array of nonnegative ratios: this array does not need to be normalized - as this is often impossible using floating point arithmetic. - If any of the probabilities are negative or do not sum to one. - - - - Initializes a new instance of the Categorical class. - - An array of nonnegative ratios: this array does not need to be normalized - as this is often impossible using floating point arithmetic. - The random number generator which is used to draw random samples. - If any of the probabilities are negative or do not sum to one. - - - - Initializes a new instance of the Categorical class from a . The distribution - will not be automatically updated when the histogram changes. The categorical distribution will have - one value for each bucket and a probability for that value proportional to the bucket count. - - The histogram from which to create the categorical variable. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Checks whether the parameters of the distribution are valid. - - An array of nonnegative ratios: this array does not need to be normalized as this is often impossible using floating point arithmetic. - If any of the probabilities are negative returns false, or if the sum of parameters is 0.0; otherwise true - - - - Checks whether the parameters of the distribution are valid. - - An array of nonnegative ratios: this array does not need to be normalized as this is often impossible using floating point arithmetic. - If any of the probabilities are negative returns false, or if the sum of parameters is 0.0; otherwise true - - - - Gets the probability mass vector (non-negative ratios) of the multinomial. - - Sometimes the normalized probability vector cannot be represented exactly in a floating point representation. - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - Throws a . - - - - Gets the smallest element in the domain of the distributions which can be represented by an integer. - - - - - Gets the largest element in the domain of the distributions which can be represented by an integer. - - - - - Gets he mode of the distribution. - - Throws a . - - - - Gets the median of the distribution. - - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. - - A real number between 0 and 1. - An integer between 0 and the size of the categorical (exclusive), that corresponds to the inverse CDF for the given probability. - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - An array of nonnegative ratios: this array does not need to be normalized - as this is often impossible using floating point arithmetic. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - An array of nonnegative ratios: this array does not need to be normalized - as this is often impossible using floating point arithmetic. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - An array of nonnegative ratios: this array does not need to be normalized - as this is often impossible using floating point arithmetic. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. - - An array of nonnegative ratios: this array does not need to be normalized - as this is often impossible using floating point arithmetic. - A real number between 0 and 1. - An integer between 0 and the size of the categorical (exclusive), that corresponds to the inverse CDF for the given probability. - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. - - An array corresponding to a CDF for a categorical distribution. Not assumed to be normalized. - A real number between 0 and 1. - An integer between 0 and the size of the categorical (exclusive), that corresponds to the inverse CDF for the given probability. - - - - Computes the cumulative distribution function. This method performs no parameter checking. - If the probability mass was normalized, the resulting cumulative distribution is normalized as well (up to numerical errors). - - An array of nonnegative ratios: this array does not need to be normalized - as this is often impossible using floating point arithmetic. - An array representing the unnormalized cumulative distribution function. - - - - Returns one trials from the categorical distribution. - - The random number generator to use. - The (unnormalized) cumulative distribution of the probability distribution. - One sample from the categorical distribution implied by . - - - - Samples a Binomially distributed random variable. - - The number of successful trials. - - - - Fills an array with samples generated from the distribution. - - - - - Samples an array of Bernoulli distributed random variables. - - a sequence of successful trial counts. - - - - Samples one categorical distributed random variable; also known as the Discrete distribution. - - The random number generator to use. - An array of nonnegative ratios. Not assumed to be normalized. - One random integer between 0 and the size of the categorical (exclusive). - - - - Samples a categorically distributed random variable. - - The random number generator to use. - An array of nonnegative ratios. Not assumed to be normalized. - random integers between 0 and the size of the categorical (exclusive). - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - An array of nonnegative ratios. Not assumed to be normalized. - random integers between 0 and the size of the categorical (exclusive). - - - - Samples one categorical distributed random variable; also known as the Discrete distribution. - - An array of nonnegative ratios. Not assumed to be normalized. - One random integer between 0 and the size of the categorical (exclusive). - - - - Samples a categorically distributed random variable. - - An array of nonnegative ratios. Not assumed to be normalized. - random integers between 0 and the size of the categorical (exclusive). - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - An array of nonnegative ratios. Not assumed to be normalized. - random integers between 0 and the size of the categorical (exclusive). - - - - Samples one categorical distributed random variable; also known as the Discrete distribution. - - The random number generator to use. - An array of the cumulative distribution. Not assumed to be normalized. - One random integer between 0 and the size of the categorical (exclusive). - - - - Samples a categorically distributed random variable. - - The random number generator to use. - An array of the cumulative distribution. Not assumed to be normalized. - random integers between 0 and the size of the categorical (exclusive). - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - An array of the cumulative distribution. Not assumed to be normalized. - random integers between 0 and the size of the categorical (exclusive). - - - - Samples one categorical distributed random variable; also known as the Discrete distribution. - - An array of the cumulative distribution. Not assumed to be normalized. - One random integer between 0 and the size of the categorical (exclusive). - - - - Samples a categorically distributed random variable. - - An array of the cumulative distribution. Not assumed to be normalized. - random integers between 0 and the size of the categorical (exclusive). - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - An array of the cumulative distribution. Not assumed to be normalized. - random integers between 0 and the size of the categorical (exclusive). - - - - Continuous Univariate Cauchy distribution. - The Cauchy distribution is a symmetric continuous probability distribution. For details about this distribution, see - Wikipedia - Cauchy distribution. - - - - - Initializes a new instance of the class with the location parameter set to 0 and the scale parameter set to 1 - - - - - Initializes a new instance of the class. - - The location (x0) of the distribution. - The scale (γ) of the distribution. Range: γ > 0. - - - - Initializes a new instance of the class. - - The location (x0) of the distribution. - The scale (γ) of the distribution. Range: γ > 0. - The random number generator which is used to draw random samples. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The location (x0) of the distribution. - The scale (γ) of the distribution. Range: γ > 0. - - - - Gets the location (x0) of the distribution. - - - - - Gets the scale (γ) of the distribution. Range: γ > 0. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the mode of the distribution. - - - - - Gets the median of the distribution. - - - - - Gets the minimum of the distribution. - - - - - Gets the maximum of the distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - - - - Draws a random sample from the distribution. - - A random number from this distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the Cauchy distribution. - - a sequence of samples from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location (x0) of the distribution. - The scale (γ) of the distribution. Range: γ > 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location (x0) of the distribution. - The scale (γ) of the distribution. Range: γ > 0. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The location (x0) of the distribution. - The scale (γ) of the distribution. Range: γ > 0. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - The location (x0) of the distribution. - The scale (γ) of the distribution. Range: γ > 0. - the inverse cumulative density at . - - - - - Generates a sample from the distribution. - - The random number generator to use. - The location (x0) of the distribution. - The scale (γ) of the distribution. Range: γ > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The random number generator to use. - The location (x0) of the distribution. - The scale (γ) of the distribution. Range: γ > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The location (x0) of the distribution. - The scale (γ) of the distribution. Range: γ > 0. - a sequence of samples from the distribution. - - - - Generates a sample from the distribution. - - The location (x0) of the distribution. - The scale (γ) of the distribution. Range: γ > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The location (x0) of the distribution. - The scale (γ) of the distribution. Range: γ > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The location (x0) of the distribution. - The scale (γ) of the distribution. Range: γ > 0. - a sequence of samples from the distribution. - - - - Continuous Univariate Chi distribution. - This distribution is a continuous probability distribution. The distribution usually arises when a k-dimensional vector's orthogonal - components are independent and each follow a standard normal distribution. The length of the vector will - then have a chi distribution. - Wikipedia - Chi distribution. - - - - - Initializes a new instance of the class. - - The degrees of freedom (k) of the distribution. Range: k > 0. - - - - Initializes a new instance of the class. - - The degrees of freedom (k) of the distribution. Range: k > 0. - The random number generator which is used to draw random samples. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The degrees of freedom (k) of the distribution. Range: k > 0. - - - - Gets the degrees of freedom (k) of the Chi distribution. Range: k > 0. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the mode of the distribution. - - - - - Gets the median of the distribution. - - - - - Gets the minimum of the distribution. - - - - - Gets the maximum of the distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Generates a sample from the Chi distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the Chi distribution. - - a sequence of samples from the distribution. - - - - Samples the distribution. - - The random number generator to use. - The degrees of freedom (k) of the distribution. Range: k > 0. - a random number from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The degrees of freedom (k) of the distribution. Range: k > 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The degrees of freedom (k) of the distribution. Range: k > 0. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The degrees of freedom (k) of the distribution. Range: k > 0. - the cumulative distribution at location . - - - - - Generates a sample from the distribution. - - The random number generator to use. - The degrees of freedom (k) of the distribution. Range: k > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The random number generator to use. - The degrees of freedom (k) of the distribution. Range: k > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The degrees of freedom (k) of the distribution. Range: k > 0. - a sequence of samples from the distribution. - - - - Generates a sample from the distribution. - - The degrees of freedom (k) of the distribution. Range: k > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The degrees of freedom (k) of the distribution. Range: k > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The degrees of freedom (k) of the distribution. Range: k > 0. - a sequence of samples from the distribution. - - - - Continuous Univariate Chi-Squared distribution. - This distribution is a sum of the squares of k independent standard normal random variables. - Wikipedia - ChiSquare distribution. - - - - - Initializes a new instance of the class. - - The degrees of freedom (k) of the distribution. Range: k > 0. - - - - Initializes a new instance of the class. - - The degrees of freedom (k) of the distribution. Range: k > 0. - The random number generator which is used to draw random samples. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The degrees of freedom (k) of the distribution. Range: k > 0. - - - - Gets the degrees of freedom (k) of the Chi-Squared distribution. Range: k > 0. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the mode of the distribution. - - - - - Gets the median of the distribution. - - - - - Gets the minimum of the distribution. - - - - - Gets the maximum of the distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - - - - Generates a sample from the ChiSquare distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the ChiSquare distribution. - - a sequence of samples from the distribution. - - - - Samples the distribution. - - The random number generator to use. - The degrees of freedom (k) of the distribution. Range: k > 0. - a random number from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The degrees of freedom (k) of the distribution. Range: k > 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The degrees of freedom (k) of the distribution. Range: k > 0. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The degrees of freedom (k) of the distribution. Range: k > 0. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The degrees of freedom (k) of the distribution. Range: k > 0. - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - - - Generates a sample from the ChiSquare distribution. - - The random number generator to use. - The degrees of freedom (k) of the distribution. Range: k > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The random number generator to use. - The degrees of freedom (k) of the distribution. Range: k > 0. - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The degrees of freedom (k) of the distribution. Range: k > 0. - a sample from the distribution. - - - - Generates a sample from the ChiSquare distribution. - - The degrees of freedom (k) of the distribution. Range: k > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The degrees of freedom (k) of the distribution. Range: k > 0. - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The degrees of freedom (k) of the distribution. Range: k > 0. - a sample from the distribution. - - - - Continuous Univariate Uniform distribution. - The continuous uniform distribution is a distribution over real numbers. For details about this distribution, see - Wikipedia - Continuous uniform distribution. - - - - - Initializes a new instance of the ContinuousUniform class with lower bound 0 and upper bound 1. - - - - - Initializes a new instance of the ContinuousUniform class with given lower and upper bounds. - - Lower bound. Range: lower ≤ upper. - Upper bound. Range: lower ≤ upper. - If the upper bound is smaller than the lower bound. - - - - Initializes a new instance of the ContinuousUniform class with given lower and upper bounds. - - Lower bound. Range: lower ≤ upper. - Upper bound. Range: lower ≤ upper. - The random number generator which is used to draw random samples. - If the upper bound is smaller than the lower bound. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - Lower bound. Range: lower ≤ upper. - Upper bound. Range: lower ≤ upper. - - - - Gets the lower bound of the distribution. - - - - - Gets the upper bound of the distribution. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - - Gets the skewness of the distribution. - - - - - Gets the mode of the distribution. - - - - - - Gets the median of the distribution. - - - - - - Gets the minimum of the distribution. - - - - - Gets the maximum of the distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - - - - Generates a sample from the ContinuousUniform distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the ContinuousUniform distribution. - - a sequence of samples from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - Lower bound. Range: lower ≤ upper. - Upper bound. Range: lower ≤ upper. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - Lower bound. Range: lower ≤ upper. - Upper bound. Range: lower ≤ upper. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - Lower bound. Range: lower ≤ upper. - Upper bound. Range: lower ≤ upper. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - Lower bound. Range: lower ≤ upper. - Upper bound. Range: lower ≤ upper. - the inverse cumulative density at . - - - - - Generates a sample from the ContinuousUniform distribution. - - The random number generator to use. - Lower bound. Range: lower ≤ upper. - Upper bound. Range: lower ≤ upper. - a uniformly distributed sample. - - - - Generates a sequence of samples from the ContinuousUniform distribution. - - The random number generator to use. - Lower bound. Range: lower ≤ upper. - Upper bound. Range: lower ≤ upper. - a sequence of uniformly distributed samples. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - Lower bound. Range: lower ≤ upper. - Upper bound. Range: lower ≤ upper. - a sequence of samples from the distribution. - - - - Generates a sample from the ContinuousUniform distribution. - - Lower bound. Range: lower ≤ upper. - Upper bound. Range: lower ≤ upper. - a uniformly distributed sample. - - - - Generates a sequence of samples from the ContinuousUniform distribution. - - Lower bound. Range: lower ≤ upper. - Upper bound. Range: lower ≤ upper. - a sequence of uniformly distributed samples. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - Lower bound. Range: lower ≤ upper. - Upper bound. Range: lower ≤ upper. - a sequence of samples from the distribution. - - - - Discrete Univariate Conway-Maxwell-Poisson distribution. - The Conway-Maxwell-Poisson distribution is a generalization of the Poisson, Geometric and Bernoulli - distributions. It is parameterized by two real numbers "lambda" and "nu". For - - nu = 0 the distribution reverts to a Geometric distribution - nu = 1 the distribution reverts to the Poisson distribution - nu -> infinity the distribution converges to a Bernoulli distribution - - This implementation will cache the value of the normalization constant. - Wikipedia - ConwayMaxwellPoisson distribution. - - - - - The mean of the distribution. - - - - - The variance of the distribution. - - - - - Caches the value of the normalization constant. - - - - - Since many properties of the distribution can only be computed approximately, the tolerance - level specifies how much error we accept. - - - - - Initializes a new instance of the class. - - The lambda (λ) parameter. Range: λ > 0. - The rate of decay (ν) parameter. Range: ν ≥ 0. - - - - Initializes a new instance of the class. - - The lambda (λ) parameter. Range: λ > 0. - The rate of decay (ν) parameter. Range: ν ≥ 0. - The random number generator which is used to draw random samples. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Tests whether the provided values are valid parameters for this distribution. - - The lambda (λ) parameter. Range: λ > 0. - The rate of decay (ν) parameter. Range: ν ≥ 0. - - - - Gets the lambda (λ) parameter. Range: λ > 0. - - - - - Gets the rate of decay (ν) parameter. Range: ν ≥ 0. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the mode of the distribution - - - - - Gets the median of the distribution. - - - - - Gets the smallest element in the domain of the distributions which can be represented by an integer. - - - - - Gets the largest element in the domain of the distributions which can be represented by an integer. - - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - The lambda (λ) parameter. Range: λ > 0. - The rate of decay (ν) parameter. Range: ν ≥ 0. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - The lambda (λ) parameter. Range: λ > 0. - The rate of decay (ν) parameter. Range: ν ≥ 0. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The lambda (λ) parameter. Range: λ > 0. - The rate of decay (ν) parameter. Range: ν ≥ 0. - the cumulative distribution at location . - - - - - Gets the normalization constant of the Conway-Maxwell-Poisson distribution. - - - - - Computes an approximate normalization constant for the CMP distribution. - - The lambda (λ) parameter for the CMP distribution. - The rate of decay (ν) parameter for the CMP distribution. - - an approximate normalization constant for the CMP distribution. - - - - - Returns one trials from the distribution. - - The random number generator to use. - The lambda (λ) parameter. Range: λ > 0. - The rate of decay (ν) parameter. Range: ν ≥ 0. - The z parameter. - - One sample from the distribution implied by , , and . - - - - - Samples a Conway-Maxwell-Poisson distributed random variable. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Samples a sequence of a Conway-Maxwell-Poisson distributed random variables. - - - a sequence of samples from a Conway-Maxwell-Poisson distribution. - - - - - Samples a random variable. - - The random number generator to use. - The lambda (λ) parameter. Range: λ > 0. - The rate of decay (ν) parameter. Range: ν ≥ 0. - - - - Samples a sequence of this random variable. - - The random number generator to use. - The lambda (λ) parameter. Range: λ > 0. - The rate of decay (ν) parameter. Range: ν ≥ 0. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The lambda (λ) parameter. Range: λ > 0. - The rate of decay (ν) parameter. Range: ν ≥ 0. - - - - Samples a random variable. - - The lambda (λ) parameter. Range: λ > 0. - The rate of decay (ν) parameter. Range: ν ≥ 0. - - - - Samples a sequence of this random variable. - - The lambda (λ) parameter. Range: λ > 0. - The rate of decay (ν) parameter. Range: ν ≥ 0. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The lambda (λ) parameter. Range: λ > 0. - The rate of decay (ν) parameter. Range: ν ≥ 0. - - - - Multivariate Dirichlet distribution. For details about this distribution, see - Wikipedia - Dirichlet distribution. - - - - - Initializes a new instance of the Dirichlet class. The distribution will - be initialized with the default random number generator. - - An array with the Dirichlet parameters. - - - - Initializes a new instance of the Dirichlet class. The distribution will - be initialized with the default random number generator. - - An array with the Dirichlet parameters. - The random number generator which is used to draw random samples. - - - - Initializes a new instance of the class. - random number generator. - The value of each parameter of the Dirichlet distribution. - The dimension of the Dirichlet distribution. - - - - Initializes a new instance of the class. - random number generator. - The value of each parameter of the Dirichlet distribution. - The dimension of the Dirichlet distribution. - The random number generator which is used to draw random samples. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Tests whether the provided values are valid parameters for this distribution. - No parameter can be less than zero and at least one parameter should be larger than zero. - - The parameters of the Dirichlet distribution. - - - - Gets or sets the parameters of the Dirichlet distribution. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the dimension of the Dirichlet distribution. - - - - - Gets the sum of the Dirichlet parameters. - - - - - Gets the mean of the Dirichlet distribution. - - - - - Gets the variance of the Dirichlet distribution. - - - - - Gets the entropy of the distribution. - - - - - Computes the density of the distribution. - - The locations at which to compute the density. - the density at . - The Dirichlet distribution requires that the sum of the components of x equals 1. - You can also leave out the last component, and it will be computed from the others. - - - - Computes the log density of the distribution. - - The locations at which to compute the density. - the density at . - - - - Samples a Dirichlet distributed random vector. - - A sample from this distribution. - - - - Samples a Dirichlet distributed random vector. - - The random number generator to use. - The Dirichlet distribution parameter. - a sample from the distribution. - - - - Discrete Univariate Uniform distribution. - The discrete uniform distribution is a distribution over integers. The distribution - is parameterized by a lower and upper bound (both inclusive). - Wikipedia - Discrete uniform distribution. - - - - - Initializes a new instance of the DiscreteUniform class. - - Lower bound, inclusive. Range: lower ≤ upper. - Upper bound, inclusive. Range: lower ≤ upper. - - - - Initializes a new instance of the DiscreteUniform class. - - Lower bound, inclusive. Range: lower ≤ upper. - Upper bound, inclusive. Range: lower ≤ upper. - The random number generator which is used to draw random samples. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Tests whether the provided values are valid parameters for this distribution. - - Lower bound, inclusive. Range: lower ≤ upper. - Upper bound, inclusive. Range: lower ≤ upper. - - - - Gets the inclusive lower bound of the probability distribution. - - - - - Gets the inclusive upper bound of the probability distribution. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the smallest element in the domain of the distributions which can be represented by an integer. - - - - - Gets the largest element in the domain of the distributions which can be represented by an integer. - - - - - Gets the mode of the distribution; since every element in the domain has the same probability this method returns the middle one. - - - - - Gets the median of the distribution. - - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - Lower bound, inclusive. Range: lower ≤ upper. - Upper bound, inclusive. Range: lower ≤ upper. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - Lower bound, inclusive. Range: lower ≤ upper. - Upper bound, inclusive. Range: lower ≤ upper. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - Lower bound, inclusive. Range: lower ≤ upper. - Upper bound, inclusive. Range: lower ≤ upper. - the cumulative distribution at location . - - - - - Generates one sample from the discrete uniform distribution. This method does not do any parameter checking. - - The random source to use. - Lower bound, inclusive. Range: lower ≤ upper. - Upper bound, inclusive. Range: lower ≤ upper. - A random sample from the discrete uniform distribution. - - - - Draws a random sample from the distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Samples an array of uniformly distributed random variables. - - a sequence of samples from the distribution. - - - - Samples a uniformly distributed random variable. - - The random number generator to use. - Lower bound, inclusive. Range: lower ≤ upper. - Upper bound, inclusive. Range: lower ≤ upper. - A sample from the discrete uniform distribution. - - - - Samples a sequence of uniformly distributed random variables. - - The random number generator to use. - Lower bound, inclusive. Range: lower ≤ upper. - Upper bound, inclusive. Range: lower ≤ upper. - a sequence of samples from the discrete uniform distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - Lower bound, inclusive. Range: lower ≤ upper. - Upper bound, inclusive. Range: lower ≤ upper. - a sequence of samples from the discrete uniform distribution. - - - - Samples a uniformly distributed random variable. - - Lower bound, inclusive. Range: lower ≤ upper. - Upper bound, inclusive. Range: lower ≤ upper. - A sample from the discrete uniform distribution. - - - - Samples a sequence of uniformly distributed random variables. - - Lower bound, inclusive. Range: lower ≤ upper. - Upper bound, inclusive. Range: lower ≤ upper. - a sequence of samples from the discrete uniform distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - Lower bound, inclusive. Range: lower ≤ upper. - Upper bound, inclusive. Range: lower ≤ upper. - a sequence of samples from the discrete uniform distribution. - - - - Continuous Univariate Erlang distribution. - This distribution is a continuous probability distribution with wide applicability primarily due to its - relation to the exponential and Gamma distributions. - Wikipedia - Erlang distribution. - - - - - Initializes a new instance of the class. - - The shape (k) of the Erlang distribution. Range: k ≥ 0. - The rate or inverse scale (λ) of the Erlang distribution. Range: λ ≥ 0. - - - - Initializes a new instance of the class. - - The shape (k) of the Erlang distribution. Range: k ≥ 0. - The rate or inverse scale (λ) of the Erlang distribution. Range: λ ≥ 0. - The random number generator which is used to draw random samples. - - - - Constructs a Erlang distribution from a shape and scale parameter. The distribution will - be initialized with the default random number generator. - - The shape (k) of the Erlang distribution. Range: k ≥ 0. - The scale (μ) of the Erlang distribution. Range: μ ≥ 0. - The random number generator which is used to draw random samples. Optional, can be null. - - - - Constructs a Erlang distribution from a shape and inverse scale parameter. The distribution will - be initialized with the default random number generator. - - The shape (k) of the Erlang distribution. Range: k ≥ 0. - The rate or inverse scale (λ) of the Erlang distribution. Range: λ ≥ 0. - The random number generator which is used to draw random samples. Optional, can be null. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The shape (k) of the Erlang distribution. Range: k ≥ 0. - The rate or inverse scale (λ) of the Erlang distribution. Range: λ ≥ 0. - - - - Gets the shape (k) of the Erlang distribution. Range: k ≥ 0. - - - - - Gets the rate or inverse scale (λ) of the Erlang distribution. Range: λ ≥ 0. - - - - - Gets the scale of the Erlang distribution. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the mode of the distribution. - - - - - Gets the median of the distribution. - - - - - Gets the minimum value. - - - - - Gets the Maximum value. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Generates a sample from the Erlang distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the Erlang distribution. - - a sequence of samples from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The shape (k) of the Erlang distribution. Range: k ≥ 0. - The rate or inverse scale (λ) of the Erlang distribution. Range: λ ≥ 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The shape (k) of the Erlang distribution. Range: k ≥ 0. - The rate or inverse scale (λ) of the Erlang distribution. Range: λ ≥ 0. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The shape (k) of the Erlang distribution. Range: k ≥ 0. - The rate or inverse scale (λ) of the Erlang distribution. Range: λ ≥ 0. - the cumulative distribution at location . - - - - - Generates a sample from the distribution. - - The random number generator to use. - The shape (k) of the Erlang distribution. Range: k ≥ 0. - The rate or inverse scale (λ) of the Erlang distribution. Range: λ ≥ 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The random number generator to use. - The shape (k) of the Erlang distribution. Range: k ≥ 0. - The rate or inverse scale (λ) of the Erlang distribution. Range: λ ≥ 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The shape (k) of the Erlang distribution. Range: k ≥ 0. - The rate or inverse scale (λ) of the Erlang distribution. Range: λ ≥ 0. - a sequence of samples from the distribution. - - - - Generates a sample from the distribution. - - The shape (k) of the Erlang distribution. Range: k ≥ 0. - The rate or inverse scale (λ) of the Erlang distribution. Range: λ ≥ 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The shape (k) of the Erlang distribution. Range: k ≥ 0. - The rate or inverse scale (λ) of the Erlang distribution. Range: λ ≥ 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The shape (k) of the Erlang distribution. Range: k ≥ 0. - The rate or inverse scale (λ) of the Erlang distribution. Range: λ ≥ 0. - a sequence of samples from the distribution. - - - - Continuous Univariate Exponential distribution. - The exponential distribution is a distribution over the real numbers parameterized by one non-negative parameter. - Wikipedia - exponential distribution. - - - - - Initializes a new instance of the class. - - The rate (λ) parameter of the distribution. Range: λ ≥ 0. - - - - Initializes a new instance of the class. - - The rate (λ) parameter of the distribution. Range: λ ≥ 0. - The random number generator which is used to draw random samples. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The rate (λ) parameter of the distribution. Range: λ ≥ 0. - - - - Gets the rate (λ) parameter of the distribution. Range: λ ≥ 0. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the mode of the distribution. - - - - - Gets the median of the distribution. - - - - - Gets the minimum of the distribution. - - - - - Gets the maximum of the distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - - - - Draws a random sample from the distribution. - - A random number from this distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the Exponential distribution. - - a sequence of samples from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The rate (λ) parameter of the distribution. Range: λ ≥ 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The rate (λ) parameter of the distribution. Range: λ ≥ 0. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The rate (λ) parameter of the distribution. Range: λ ≥ 0. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - The rate (λ) parameter of the distribution. Range: λ ≥ 0. - the inverse cumulative density at . - - - - - Draws a random sample from the distribution. - - The random number generator to use. - The rate (λ) parameter of the distribution. Range: λ ≥ 0. - A random number from this distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The rate (λ) parameter of the distribution. Range: λ ≥ 0. - a sequence of samples from the distribution. - - - - Generates a sequence of samples from the Exponential distribution. - - The random number generator to use. - The rate (λ) parameter of the distribution. Range: λ ≥ 0. - a sequence of samples from the distribution. - - - - Draws a random sample from the distribution. - - The rate (λ) parameter of the distribution. Range: λ ≥ 0. - A random number from this distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The rate (λ) parameter of the distribution. Range: λ ≥ 0. - a sequence of samples from the distribution. - - - - Generates a sequence of samples from the Exponential distribution. - - The rate (λ) parameter of the distribution. Range: λ ≥ 0. - a sequence of samples from the distribution. - - - - Continuous Univariate F-distribution, also known as Fisher-Snedecor distribution. - For details about this distribution, see - Wikipedia - FisherSnedecor distribution. - - - - - Initializes a new instance of the class. - - The first degree of freedom (d1) of the distribution. Range: d1 > 0. - The second degree of freedom (d2) of the distribution. Range: d2 > 0. - - - - Initializes a new instance of the class. - - The first degree of freedom (d1) of the distribution. Range: d1 > 0. - The second degree of freedom (d2) of the distribution. Range: d2 > 0. - The random number generator which is used to draw random samples. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The first degree of freedom (d1) of the distribution. Range: d1 > 0. - The second degree of freedom (d2) of the distribution. Range: d2 > 0. - - - - Gets the first degree of freedom (d1) of the distribution. Range: d1 > 0. - - - - - Gets the second degree of freedom (d2) of the distribution. Range: d2 > 0. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the mode of the distribution. - - - - - Gets the median of the distribution. - - - - - Gets the minimum of the distribution. - - - - - Gets the maximum of the distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - WARNING: currently not an explicit implementation, hence slow and unreliable. - - - - Generates a sample from the FisherSnedecor distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the FisherSnedecor distribution. - - a sequence of samples from the distribution. - - - - Generates one sample from the FisherSnedecor distribution without parameter checking. - - The random number generator to use. - The first degree of freedom (d1) of the distribution. Range: d1 > 0. - The second degree of freedom (d2) of the distribution. Range: d2 > 0. - a FisherSnedecor distributed random number. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The first degree of freedom (d1) of the distribution. Range: d1 > 0. - The second degree of freedom (d2) of the distribution. Range: d2 > 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The first degree of freedom (d1) of the distribution. Range: d1 > 0. - The second degree of freedom (d2) of the distribution. Range: d2 > 0. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The first degree of freedom (d1) of the distribution. Range: d1 > 0. - The second degree of freedom (d2) of the distribution. Range: d2 > 0. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - The first degree of freedom (d1) of the distribution. Range: d1 > 0. - The second degree of freedom (d2) of the distribution. Range: d2 > 0. - the inverse cumulative density at . - - WARNING: currently not an explicit implementation, hence slow and unreliable. - - - - Generates a sample from the distribution. - - The random number generator to use. - The first degree of freedom (d1) of the distribution. Range: d1 > 0. - The second degree of freedom (d2) of the distribution. Range: d2 > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The random number generator to use. - The first degree of freedom (d1) of the distribution. Range: d1 > 0. - The second degree of freedom (d2) of the distribution. Range: d2 > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The first degree of freedom (d1) of the distribution. Range: d1 > 0. - The second degree of freedom (d2) of the distribution. Range: d2 > 0. - a sequence of samples from the distribution. - - - - Generates a sample from the distribution. - - The first degree of freedom (d1) of the distribution. Range: d1 > 0. - The second degree of freedom (d2) of the distribution. Range: d2 > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The first degree of freedom (d1) of the distribution. Range: d1 > 0. - The second degree of freedom (d2) of the distribution. Range: d2 > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The first degree of freedom (d1) of the distribution. Range: d1 > 0. - The second degree of freedom (d2) of the distribution. Range: d2 > 0. - a sequence of samples from the distribution. - - - - Continuous Univariate Gamma distribution. - For details about this distribution, see - Wikipedia - Gamma distribution. - - - The Gamma distribution is parametrized by a shape and inverse scale parameter. When we want - to specify a Gamma distribution which is a point distribution we set the shape parameter to be the - location of the point distribution and the inverse scale as positive infinity. The distribution - with shape and inverse scale both zero is undefined. - - Random number generation for the Gamma distribution is based on the algorithm in: - "A Simple Method for Generating Gamma Variables" - Marsaglia & Tsang - ACM Transactions on Mathematical Software, Vol. 26, No. 3, September 2000, Pages 363–372. - - - - - Initializes a new instance of the Gamma class. - - The shape (k, α) of the Gamma distribution. Range: α ≥ 0. - The rate or inverse scale (β) of the Gamma distribution. Range: β ≥ 0. - - - - Initializes a new instance of the Gamma class. - - The shape (k, α) of the Gamma distribution. Range: α ≥ 0. - The rate or inverse scale (β) of the Gamma distribution. Range: β ≥ 0. - The random number generator which is used to draw random samples. - - - - Constructs a Gamma distribution from a shape and scale parameter. The distribution will - be initialized with the default random number generator. - - The shape (k) of the Gamma distribution. Range: k ≥ 0. - The scale (θ) of the Gamma distribution. Range: θ ≥ 0 - The random number generator which is used to draw random samples. Optional, can be null. - - - - Constructs a Gamma distribution from a shape and inverse scale parameter. The distribution will - be initialized with the default random number generator. - - The shape (k, α) of the Gamma distribution. Range: α ≥ 0. - The rate or inverse scale (β) of the Gamma distribution. Range: β ≥ 0. - The random number generator which is used to draw random samples. Optional, can be null. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The shape (k, α) of the Gamma distribution. Range: α ≥ 0. - The rate or inverse scale (β) of the Gamma distribution. Range: β ≥ 0. - - - - Gets or sets the shape (k, α) of the Gamma distribution. Range: α ≥ 0. - - - - - Gets or sets the rate or inverse scale (β) of the Gamma distribution. Range: β ≥ 0. - - - - - Gets or sets the scale (θ) of the Gamma distribution. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the Gamma distribution. - - - - - Gets the variance of the Gamma distribution. - - - - - Gets the standard deviation of the Gamma distribution. - - - - - Gets the entropy of the Gamma distribution. - - - - - Gets the skewness of the Gamma distribution. - - - - - Gets the mode of the Gamma distribution. - - - - - Gets the median of the Gamma distribution. - - - - - Gets the minimum of the Gamma distribution. - - - - - Gets the maximum of the Gamma distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - - - - Generates a sample from the Gamma distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the Gamma distribution. - - a sequence of samples from the distribution. - - - - Sampling implementation based on: - "A Simple Method for Generating Gamma Variables" - Marsaglia & Tsang - ACM Transactions on Mathematical Software, Vol. 26, No. 3, September 2000, Pages 363–372. - This method performs no parameter checks. - - The random number generator to use. - The shape (k, α) of the Gamma distribution. Range: α ≥ 0. - The rate or inverse scale (β) of the Gamma distribution. Range: β ≥ 0. - A sample from a Gamma distributed random variable. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The shape (k, α) of the Gamma distribution. Range: α ≥ 0. - The rate or inverse scale (β) of the Gamma distribution. Range: β ≥ 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The shape (k, α) of the Gamma distribution. Range: α ≥ 0. - The rate or inverse scale (β) of the Gamma distribution. Range: β ≥ 0. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The shape (k, α) of the Gamma distribution. Range: α ≥ 0. - The rate or inverse scale (β) of the Gamma distribution. Range: β ≥ 0. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - The shape (k, α) of the Gamma distribution. Range: α ≥ 0. - The rate or inverse scale (β) of the Gamma distribution. Range: β ≥ 0. - the inverse cumulative density at . - - - - - Generates a sample from the Gamma distribution. - - The random number generator to use. - The shape (k, α) of the Gamma distribution. Range: α ≥ 0. - The rate or inverse scale (β) of the Gamma distribution. Range: β ≥ 0. - a sample from the distribution. - - - - Generates a sequence of samples from the Gamma distribution. - - The random number generator to use. - The shape (k, α) of the Gamma distribution. Range: α ≥ 0. - The rate or inverse scale (β) of the Gamma distribution. Range: β ≥ 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The shape (k, α) of the Gamma distribution. Range: α ≥ 0. - The rate or inverse scale (β) of the Gamma distribution. Range: β ≥ 0. - a sequence of samples from the distribution. - - - - Generates a sample from the Gamma distribution. - - The shape (k, α) of the Gamma distribution. Range: α ≥ 0. - The rate or inverse scale (β) of the Gamma distribution. Range: β ≥ 0. - a sample from the distribution. - - - - Generates a sequence of samples from the Gamma distribution. - - The shape (k, α) of the Gamma distribution. Range: α ≥ 0. - The rate or inverse scale (β) of the Gamma distribution. Range: β ≥ 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The shape (k, α) of the Gamma distribution. Range: α ≥ 0. - The rate or inverse scale (β) of the Gamma distribution. Range: β ≥ 0. - a sequence of samples from the distribution. - - - - Discrete Univariate Geometric distribution. - The Geometric distribution is a distribution over positive integers parameterized by one positive real number. - This implementation of the Geometric distribution will never generate 0's. - Wikipedia - geometric distribution. - - - - - Initializes a new instance of the Geometric class. - - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - - - - Initializes a new instance of the Geometric class. - - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - The random number generator which is used to draw random samples. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Tests whether the provided values are valid parameters for this distribution. - - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - - - - Gets the probability of generating a one. Range: 0 ≤ p ≤ 1. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - Throws a not supported exception. - - - - Gets the mode of the distribution. - - - - - Gets the median of the distribution. - - - - - Gets the smallest element in the domain of the distributions which can be represented by an integer. - - - - - Gets the largest element in the domain of the distributions which can be represented by an integer. - - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - the cumulative distribution at location . - - - - - Returns one sample from the distribution. - - The random number generator to use. - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - One sample from the distribution implied by . - - - - Samples a Geometric distributed random variable. - - A sample from the Geometric distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Samples an array of Geometric distributed random variables. - - a sequence of samples from the distribution. - - - - Samples a random variable. - - The random number generator to use. - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - - - - Samples a sequence of this random variable. - - The random number generator to use. - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - - - - Samples a random variable. - - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - - - - Samples a sequence of this random variable. - - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The probability (p) of generating one. Range: 0 ≤ p ≤ 1. - - - - Discrete Univariate Hypergeometric distribution. - This distribution is a discrete probability distribution that describes the number of successes in a sequence - of n draws from a finite population without replacement, just as the binomial distribution - describes the number of successes for draws with replacement - Wikipedia - Hypergeometric distribution. - - - - - Initializes a new instance of the Hypergeometric class. - - The size of the population (N). - The number successes within the population (K, M). - The number of draws without replacement (n). - - - - Initializes a new instance of the Hypergeometric class. - - The size of the population (N). - The number successes within the population (K, M). - The number of draws without replacement (n). - The random number generator which is used to draw random samples. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Tests whether the provided values are valid parameters for this distribution. - - The size of the population (N). - The number successes within the population (K, M). - The number of draws without replacement (n). - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the size of the population (N). - - - - - Gets the number of draws without replacement (n). - - - - - Gets the number successes within the population (K, M). - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the mode of the distribution. - - - - - Gets the median of the distribution. - - - - - Gets the minimum of the distribution. - - - - - Gets the maximum of the distribution. - - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - The size of the population (N). - The number successes within the population (K, M). - The number of draws without replacement (n). - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - The size of the population (N). - The number successes within the population (K, M). - The number of draws without replacement (n). - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The size of the population (N). - The number successes within the population (K, M). - The number of draws without replacement (n). - the cumulative distribution at location . - - - - - Generates a sample from the Hypergeometric distribution without doing parameter checking. - - The random number generator to use. - The size of the population (N). - The number successes within the population (K, M). - The n parameter of the distribution. - a random number from the Hypergeometric distribution. - - - - Samples a Hypergeometric distributed random variable. - - The number of successes in n trials. - - - - Fills an array with samples generated from the distribution. - - - - - Samples an array of Hypergeometric distributed random variables. - - a sequence of successes in n trials. - - - - Samples a random variable. - - The random number generator to use. - The size of the population (N). - The number successes within the population (K, M). - The number of draws without replacement (n). - - - - Samples a sequence of this random variable. - - The random number generator to use. - The size of the population (N). - The number successes within the population (K, M). - The number of draws without replacement (n). - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The size of the population (N). - The number successes within the population (K, M). - The number of draws without replacement (n). - - - - Samples a random variable. - - The size of the population (N). - The number successes within the population (K, M). - The number of draws without replacement (n). - - - - Samples a sequence of this random variable. - - The size of the population (N). - The number successes within the population (K, M). - The number of draws without replacement (n). - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The size of the population (N). - The number successes within the population (K, M). - The number of draws without replacement (n). - - - - Continuous Univariate Probability Distribution. - - - - - - Gets the mode of the distribution. - - - - - Gets the smallest element in the domain of the distribution which can be represented by a double. - - - - - Gets the largest element in the domain of the distribution which can be represented by a double. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - Draws a random sample from the distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Draws a sequence of random samples from the distribution. - - an infinite sequence of samples from the distribution. - - - - Discrete Univariate Probability Distribution. - - - - - - Gets the mode of the distribution. - - - - - Gets the smallest element in the domain of the distribution which can be represented by an integer. - - - - - Gets the largest element in the domain of the distribution which can be represented by an integer. - - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - the log probability mass at location . - - - - Draws a random sample from the distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Draws a sequence of random samples from the distribution. - - an infinite sequence of samples from the distribution. - - - - Probability Distribution. - - - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Continuous Univariate Inverse Gamma distribution. - The inverse Gamma distribution is a distribution over the positive real numbers parameterized by - two positive parameters. - Wikipedia - InverseGamma distribution. - - - - - Initializes a new instance of the class. - - The shape (α) of the distribution. Range: α > 0. - The scale (β) of the distribution. Range: β > 0. - - - - Initializes a new instance of the class. - - The shape (α) of the distribution. Range: α > 0. - The scale (β) of the distribution. Range: β > 0. - The random number generator which is used to draw random samples. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The shape (α) of the distribution. Range: α > 0. - The scale (β) of the distribution. Range: β > 0. - - - - Gets or sets the shape (α) parameter. Range: α > 0. - - - - - Gets or sets The scale (β) parameter. Range: β > 0. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the mode of the distribution. - - - - - Gets the median of the distribution. - - Throws . - - - - Gets the minimum of the distribution. - - - - - Gets the maximum of the distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Draws a random sample from the distribution. - - A random number from this distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the Cauchy distribution. - - a sequence of samples from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The shape (α) of the distribution. Range: α > 0. - The scale (β) of the distribution. Range: β > 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The shape (α) of the distribution. Range: α > 0. - The scale (β) of the distribution. Range: β > 0. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The shape (α) of the distribution. Range: α > 0. - The scale (β) of the distribution. Range: β > 0. - the cumulative distribution at location . - - - - - Generates a sample from the distribution. - - The random number generator to use. - The shape (α) of the distribution. Range: α > 0. - The scale (β) of the distribution. Range: β > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The random number generator to use. - The shape (α) of the distribution. Range: α > 0. - The scale (β) of the distribution. Range: β > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The shape (α) of the distribution. Range: α > 0. - The scale (β) of the distribution. Range: β > 0. - a sequence of samples from the distribution. - - - - Generates a sample from the distribution. - - The shape (α) of the distribution. Range: α > 0. - The scale (β) of the distribution. Range: β > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The shape (α) of the distribution. Range: α > 0. - The scale (β) of the distribution. Range: β > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The shape (α) of the distribution. Range: α > 0. - The scale (β) of the distribution. Range: β > 0. - a sequence of samples from the distribution. - - - - Gets the mean (μ) of the distribution. Range: μ > 0. - - - - - Gets the shape (λ) of the distribution. Range: λ > 0. - - - - - Initializes a new instance of the InverseGaussian class. - - The mean (μ) of the distribution. Range: μ > 0. - The shape (λ) of the distribution. Range: λ > 0. - The random number generator which is used to draw random samples. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The mean (μ) of the distribution. Range: μ > 0. - The shape (λ) of the distribution. Range: λ > 0. - - - - Gets the random number generator which is used to draw random samples. - - - - - Gets the mean of the Inverse Gaussian distribution. - - - - - Gets the variance of the Inverse Gaussian distribution. - - - - - Gets the standard deviation of the Inverse Gaussian distribution. - - - - - Gets the median of the Inverse Gaussian distribution. - No closed form analytical expression exists, so this value is approximated numerically and can throw an exception. - - - - - Gets the minimum of the Inverse Gaussian distribution. - - - - - Gets the maximum of the Inverse Gaussian distribution. - - - - - Gets the skewness of the Inverse Gaussian distribution. - - - - - Gets the kurtosis of the Inverse Gaussian distribution. - - - - - Gets the mode of the Inverse Gaussian distribution. - - - - - Gets the entropy of the Inverse Gaussian distribution (currently not supported). - - - - - Generates a sample from the inverse Gaussian distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - - - - Generates a sequence of samples from the inverse Gaussian distribution. - - a sequence of samples from the distribution. - - - - Generates a sample from the inverse Gaussian distribution. - - The random number generator to use. - The mean (μ) of the distribution. Range: μ > 0. - The shape (λ) of the distribution. Range: λ > 0. - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The mean (μ) of the distribution. Range: μ > 0. - The shape (λ) of the distribution. Range: λ > 0. - - - - Generates a sequence of samples from the Burr distribution. - - The random number generator to use. - The mean (μ) of the distribution. Range: μ > 0. - The shape (λ) of the distribution. Range: λ > 0. - a sequence of samples from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse cumulative distribution (CDF) of the distribution at p, i.e. solving for P(X ≤ x) = p. - - The location at which to compute the inverse cumulative distribution function. - the inverse cumulative distribution at location . - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The mean (μ) of the distribution. Range: μ > 0. - The shape (λ) of the distribution. Range: λ > 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The mean (μ) of the distribution. Range: μ > 0. - The shape (λ) of the distribution. Range: λ > 0. - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The mean (μ) of the distribution. Range: μ > 0. - The shape (λ) of the distribution. Range: λ > 0. - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse cumulative distribution (CDF) of the distribution at p, i.e. solving for P(X ≤ x) = p. - - The mean (μ) of the distribution. Range: μ > 0. - The shape (λ) of the distribution. Range: λ > 0. - The location at which to compute the inverse cumulative distribution function. - the inverse cumulative distribution at location . - - - - - Estimates the Inverse Gaussian parameters from sample data with maximum-likelihood. - - The samples to estimate the distribution parameters from. - The random number generator which is used to draw random samples. Optional, can be null. - An Inverse Gaussian distribution. - - - - Multivariate Inverse Wishart distribution. This distribution is - parameterized by the degrees of freedom nu and the scale matrix S. The inverse Wishart distribution - is the conjugate prior for the covariance matrix of a multivariate normal distribution. - Wikipedia - Inverse-Wishart distribution. - - - - - Caches the Cholesky factorization of the scale matrix. - - - - - Initializes a new instance of the class. - - The degree of freedom (ν) for the inverse Wishart distribution. - The scale matrix (Ψ) for the inverse Wishart distribution. - - - - Initializes a new instance of the class. - - The degree of freedom (ν) for the inverse Wishart distribution. - The scale matrix (Ψ) for the inverse Wishart distribution. - The random number generator which is used to draw random samples. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The degree of freedom (ν) for the inverse Wishart distribution. - The scale matrix (Ψ) for the inverse Wishart distribution. - - - - Gets or sets the degree of freedom (ν) for the inverse Wishart distribution. - - - - - Gets or sets the scale matrix (Ψ) for the inverse Wishart distribution. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean. - - The mean of the distribution. - - - - Gets the mode of the distribution. - - The mode of the distribution. - A. O'Hagan, and J. J. Forster (2004). Kendall's Advanced Theory of Statistics: Bayesian Inference. 2B (2 ed.). Arnold. ISBN 0-340-80752-0. - - - - Gets the variance of the distribution. - - The variance of the distribution. - Kanti V. Mardia, J. T. Kent and J. M. Bibby (1979). Multivariate Analysis. - - - - Evaluates the probability density function for the inverse Wishart distribution. - - The matrix at which to evaluate the density at. - If the argument does not have the same dimensions as the scale matrix. - the density at . - - - - Samples an inverse Wishart distributed random variable by sampling - a Wishart random variable and inverting the matrix. - - a sample from the distribution. - - - - Samples an inverse Wishart distributed random variable by sampling - a Wishart random variable and inverting the matrix. - - The random number generator to use. - The degree of freedom (ν) for the inverse Wishart distribution. - The scale matrix (Ψ) for the inverse Wishart distribution. - a sample from the distribution. - - - - Univariate Probability Distribution. - - - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the median of the distribution. - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - Continuous Univariate Laplace distribution. - The Laplace distribution is a distribution over the real numbers parameterized by a mean and - scale parameter. The PDF is: - p(x) = \frac{1}{2 * scale} \exp{- |x - mean| / scale}. - Wikipedia - Laplace distribution. - - - - - Initializes a new instance of the class (location = 0, scale = 1). - - - - - Initializes a new instance of the class. - - The location (μ) of the distribution. - The scale (b) of the distribution. Range: b > 0. - If is negative. - - - - Initializes a new instance of the class. - - The location (μ) of the distribution. - The scale (b) of the distribution. Range: b > 0. - The random number generator which is used to draw random samples. - If is negative. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The location (μ) of the distribution. - The scale (b) of the distribution. Range: b > 0. - - - - Gets the location (μ) of the Laplace distribution. - - - - - Gets the scale (b) of the Laplace distribution. Range: b > 0. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the mode of the distribution. - - - - - Gets the median of the distribution. - - - - - Gets the minimum of the distribution. - - - - - Gets the maximum of the distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Samples a Laplace distributed random variable. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sample from the Laplace distribution. - - a sample from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location (μ) of the distribution. - The scale (b) of the distribution. Range: b > 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location (μ) of the distribution. - The scale (b) of the distribution. Range: b > 0. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The location (μ) of the distribution. - The scale (b) of the distribution. Range: b > 0. - the cumulative distribution at location . - - - - - Generates a sample from the distribution. - - The random number generator to use. - The location (μ) of the distribution. - The scale (b) of the distribution. Range: b > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The random number generator to use. - The location (μ) of the distribution. - The scale (b) of the distribution. Range: b > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The location (μ) of the distribution. - The scale (b) of the distribution. Range: b > 0. - a sequence of samples from the distribution. - - - - Generates a sample from the distribution. - - The location (μ) of the distribution. - The scale (b) of the distribution. Range: b > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The location (μ) of the distribution. - The scale (b) of the distribution. Range: b > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The location (μ) of the distribution. - The scale (b) of the distribution. Range: b > 0. - a sequence of samples from the distribution. - - - - Continuous Univariate Logistic distribution. - For details about this distribution, see - Wikipedia - Logistic distribution. - - - - - Initializes a new instance of the Logistic class. This is a logistic distribution with mean 0.0 - and scale 1.0. The distribution will be initialized with the default - random number generator. - - - - - Initializes a new instance of the Logistic class. This is a logistic distribution with mean 0.0 - and scale 1.0. The distribution will be initialized with the default - random number generator. - - The random number generator which is used to draw random samples. - - - - Initializes a new instance of the Logistic class with a particular mean and scale parameter. The - distribution will be initialized with the default random number generator. - - The mean (μ) of the logistic distribution. - The scale (s) of the logistic distribution. Range: s > 0. - - - - Initializes a new instance of the Logistic class with a particular mean and standard deviation. The distribution will - be initialized with the default random number generator. - - The mean (μ) of the logistic distribution. - The scale (s) of the logistic distribution. Range: s > 0. - The random number generator which is used to draw random samples. - - - - Constructs a logistic distribution from a mean and scale parameter. - - The mean (μ) of the logistic distribution. - The scale (s) of the logistic distribution. Range: s > 0. - The random number generator which is used to draw random samples. Optional, can be null. - a logistic distribution. - - - - Constructs a logistic distribution from a mean and standard deviation. - - The mean (μ) of the logistic distribution. - The standard deviation (σ) of the logistic distribution. Range: σ > 0. - The random number generator which is used to draw random samples. Optional, can be null. - a logistic distribution. - - - - Constructs a logistic distribution from a mean and variance. - - The mean (μ) of the logistic distribution. - The variance (σ^2) of the logistic distribution. Range: (σ^2) > 0. - The random number generator which is used to draw random samples. Optional, can be null. - A logistic distribution. - - - - Constructs a logistic distribution from a mean and precision. - - The mean (μ) of the logistic distribution. - The precision of the logistic distribution. Range: precision > 0. - The random number generator which is used to draw random samples. Optional, can be null. - A logistic distribution. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The mean (μ) of the logistic distribution. - The scale (s) of the logistic distribution. Range: s > 0. - - - - Gets the scale parameter of the Logistic distribution. Range: s > 0. - - - - - Gets the mean (μ) of the logistic distribution. - - - - - Gets the standard deviation (σ) of the logistic distribution. Range: σ > 0. - - - - - Gets the variance of the logistic distribution. - - - - - Gets the precision of the logistic distribution. - - - - - Gets the random number generator which is used to draw random samples. - - - - - Gets the entropy of the logistic distribution. - - - - - Gets the skewness of the logistic distribution. - - - - - Gets the mode of the logistic distribution. - - - - - Gets the median of the logistic distribution. - - - - - Gets the minimum of the logistic distribution. - - - - - Gets the maximum of the logistic distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - - - - Generates a sample from the logistic distribution using the Box-Muller algorithm. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the logistic distribution using the Box-Muller algorithm. - - a sequence of samples from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The mean (μ) of the logistic distribution. - The scale (s) of the logistic distribution. Range: s > 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The mean (μ) of the logistic distribution. - The scale (s) of the logistic distribution. Range: s > 0. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The mean (μ) of the logistic distribution. - The scale (s) of the logistic distribution. Range: s > 0. - the cumulative distribution at location . - - MATLAB: normcdf - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - The mean (μ) of the logistic distribution. - The scale (s) of the logistic distribution. Range: s > 0. - the inverse cumulative density at . - - MATLAB: norminv - - - - Generates a sample from the logistic distribution using the Box-Muller algorithm. - - The random number generator to use. - The mean (μ) of the logistic distribution. - The scale (s) of the logistic distribution. Range: s > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the logistic distribution using the Box-Muller algorithm. - - The random number generator to use. - The mean (μ) of the logistic distribution. - The scale (s) of the logistic distribution. Range: s > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The mean (μ) of the logistic distribution. - The scale (s) of the logistic distribution. Range: s > 0. - a sequence of samples from the distribution. - - - - Generates a sample from the logistic distribution using the Box-Muller algorithm. - - The mean (μ) of the logistic distribution. - The scale (s) of the logistic distribution. Range: s > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the logistic distribution using the Box-Muller algorithm. - - The mean (μ) of the logistic distribution. - The scale (s) of the logistic distribution. Range: s > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The mean (μ) of the logistic distribution. - The scale (s) of the logistic distribution. Range: s > 0. - a sequence of samples from the distribution. - - - - Continuous Univariate Log-Normal distribution. - For details about this distribution, see - Wikipedia - Log-Normal distribution. - - - - - Initializes a new instance of the class. - The distribution will be initialized with the default - random number generator. - - The log-scale (μ) of the logarithm of the distribution. - The shape (σ) of the logarithm of the distribution. Range: σ ≥ 0. - - - - Initializes a new instance of the class. - The distribution will be initialized with the default - random number generator. - - The log-scale (μ) of the distribution. - The shape (σ) of the distribution. Range: σ ≥ 0. - The random number generator which is used to draw random samples. - - - - Constructs a log-normal distribution with the desired mu and sigma parameters. - - The log-scale (μ) of the distribution. - The shape (σ) of the distribution. Range: σ ≥ 0. - The random number generator which is used to draw random samples. Optional, can be null. - A log-normal distribution. - - - - Constructs a log-normal distribution with the desired mean and variance. - - The mean of the log-normal distribution. - The variance of the log-normal distribution. - The random number generator which is used to draw random samples. Optional, can be null. - A log-normal distribution. - - - - Estimates the log-normal distribution parameters from sample data with maximum-likelihood. - - The samples to estimate the distribution parameters from. - The random number generator which is used to draw random samples. Optional, can be null. - A log-normal distribution. - MATLAB: lognfit - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The log-scale (μ) of the distribution. - The shape (σ) of the distribution. Range: σ ≥ 0. - - - - Gets the log-scale (μ) (mean of the logarithm) of the distribution. - - - - - Gets the shape (σ) (standard deviation of the logarithm) of the distribution. Range: σ ≥ 0. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mu of the log-normal distribution. - - - - - Gets the variance of the log-normal distribution. - - - - - Gets the standard deviation of the log-normal distribution. - - - - - Gets the entropy of the log-normal distribution. - - - - - Gets the skewness of the log-normal distribution. - - - - - Gets the mode of the log-normal distribution. - - - - - Gets the median of the log-normal distribution. - - - - - Gets the minimum of the log-normal distribution. - - - - - Gets the maximum of the log-normal distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - - - - Generates a sample from the log-normal distribution using the Box-Muller algorithm. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the log-normal distribution using the Box-Muller algorithm. - - a sequence of samples from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - The log-scale (μ) of the distribution. - The shape (σ) of the distribution. Range: σ ≥ 0. - the density at . - - MATLAB: lognpdf - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the density. - The log-scale (μ) of the distribution. - The shape (σ) of the distribution. Range: σ ≥ 0. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The log-scale (μ) of the distribution. - The shape (σ) of the distribution. Range: σ ≥ 0. - the cumulative distribution at location . - - MATLAB: logncdf - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - The log-scale (μ) of the distribution. - The shape (σ) of the distribution. Range: σ ≥ 0. - the inverse cumulative density at . - - MATLAB: logninv - - - - Generates a sample from the log-normal distribution using the Box-Muller algorithm. - - The random number generator to use. - The log-scale (μ) of the distribution. - The shape (σ) of the distribution. Range: σ ≥ 0. - a sample from the distribution. - - - - Generates a sequence of samples from the log-normal distribution using the Box-Muller algorithm. - - The random number generator to use. - The log-scale (μ) of the distribution. - The shape (σ) of the distribution. Range: σ ≥ 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The log-scale (μ) of the distribution. - The shape (σ) of the distribution. Range: σ ≥ 0. - a sequence of samples from the distribution. - - - - Generates a sample from the log-normal distribution using the Box-Muller algorithm. - - The log-scale (μ) of the distribution. - The shape (σ) of the distribution. Range: σ ≥ 0. - a sample from the distribution. - - - - Generates a sequence of samples from the log-normal distribution using the Box-Muller algorithm. - - The log-scale (μ) of the distribution. - The shape (σ) of the distribution. Range: σ ≥ 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The log-scale (μ) of the distribution. - The shape (σ) of the distribution. Range: σ ≥ 0. - a sequence of samples from the distribution. - - - - Multivariate Matrix-valued Normal distributions. The distribution - is parameterized by a mean matrix (M), a covariance matrix for the rows (V) and a covariance matrix - for the columns (K). If the dimension of M is d-by-m then V is d-by-d and K is m-by-m. - Wikipedia - MatrixNormal distribution. - - - - - The mean of the matrix normal distribution. - - - - - The covariance matrix for the rows. - - - - - The covariance matrix for the columns. - - - - - Initializes a new instance of the class. - - The mean of the matrix normal. - The covariance matrix for the rows. - The covariance matrix for the columns. - If the dimensions of the mean and two covariance matrices don't match. - - - - Initializes a new instance of the class. - - The mean of the matrix normal. - The covariance matrix for the rows. - The covariance matrix for the columns. - The random number generator which is used to draw random samples. - If the dimensions of the mean and two covariance matrices don't match. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Tests whether the provided values are valid parameters for this distribution. - - The mean of the matrix normal. - The covariance matrix for the rows. - The covariance matrix for the columns. - - - - Gets the mean. (M) - - The mean of the distribution. - - - - Gets the row covariance. (V) - - The row covariance. - - - - Gets the column covariance. (K) - - The column covariance. - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Evaluates the probability density function for the matrix normal distribution. - - The matrix at which to evaluate the density at. - the density at - If the argument does not have the correct dimensions. - - - - Samples a matrix normal distributed random variable. - - A random number from this distribution. - - - - Samples a matrix normal distributed random variable. - - The random number generator to use. - The mean of the matrix normal. - The covariance matrix for the rows. - The covariance matrix for the columns. - If the dimensions of the mean and two covariance matrices don't match. - a sequence of samples from the distribution. - - - - Samples a vector normal distributed random variable. - - The random number generator to use. - The mean of the vector normal distribution. - The covariance matrix of the vector normal distribution. - a sequence of samples from defined distribution. - - - - Multivariate Multinomial distribution. For details about this distribution, see - Wikipedia - Multinomial distribution. - - - The distribution is parameterized by a vector of ratios: in other words, the parameter - does not have to be normalized and sum to 1. The reason is that some vectors can't be exactly normalized - to sum to 1 in floating point representation. - - - - - Stores the normalized multinomial probabilities. - - - - - The number of trials. - - - - - Initializes a new instance of the Multinomial class. - - An array of nonnegative ratios: this array does not need to be normalized - as this is often impossible using floating point arithmetic. - The number of trials. - If any of the probabilities are negative or do not sum to one. - If is negative. - - - - Initializes a new instance of the Multinomial class. - - An array of nonnegative ratios: this array does not need to be normalized - as this is often impossible using floating point arithmetic. - The number of trials. - The random number generator which is used to draw random samples. - If any of the probabilities are negative or do not sum to one. - If is negative. - - - - Initializes a new instance of the Multinomial class from histogram . The distribution will - not be automatically updated when the histogram changes. - - Histogram instance - The number of trials. - If any of the probabilities are negative or do not sum to one. - If is negative. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - An array of nonnegative ratios: this array does not need to be normalized - as this is often impossible using floating point arithmetic. - The number of trials. - If any of the probabilities are negative returns false, - if the sum of parameters is 0.0, or if the number of trials is negative; otherwise true. - - - - Gets the proportion of ratios. - - - - - Gets the number of trials. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Computes values of the probability mass function. - - Non-negative integers x1, ..., xk - The probability mass at location . - When is null. - When length of is not equal to event probabilities count. - - - - Computes values of the log probability mass function. - - Non-negative integers x1, ..., xk - The log probability mass at location . - When is null. - When length of is not equal to event probabilities count. - - - - Samples one multinomial distributed random variable. - - the counts for each of the different possible values. - - - - Samples a sequence multinomially distributed random variables. - - a sequence of counts for each of the different possible values. - - - - Samples one multinomial distributed random variable. - - The random number generator to use. - An array of nonnegative ratios: this array does not need to be normalized - as this is often impossible using floating point arithmetic. - The number of trials. - the counts for each of the different possible values. - - - - Samples a multinomially distributed random variable. - - The random number generator to use. - An array of nonnegative ratios: this array does not need to be normalized - as this is often impossible using floating point arithmetic. - The number of variables needed. - a sequence of counts for each of the different possible values. - - - - Discrete Univariate Negative Binomial distribution. - The negative binomial is a distribution over the natural numbers with two parameters r, p. For the special - case that r is an integer one can interpret the distribution as the number of failures before the r'th success - when the probability of success is p. - Wikipedia - NegativeBinomial distribution. - - - - - Initializes a new instance of the class. - - The number of successes (r) required to stop the experiment. Range: r ≥ 0. - The probability (p) of a trial resulting in success. Range: 0 ≤ p ≤ 1. - - - - Initializes a new instance of the class. - - The number of successes (r) required to stop the experiment. Range: r ≥ 0. - The probability (p) of a trial resulting in success. Range: 0 ≤ p ≤ 1. - The random number generator which is used to draw random samples. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Tests whether the provided values are valid parameters for this distribution. - - The number of successes (r) required to stop the experiment. Range: r ≥ 0. - The probability (p) of a trial resulting in success. Range: 0 ≤ p ≤ 1. - - - - Gets the number of successes. Range: r ≥ 0. - - - - - Gets the probability of success. Range: 0 ≤ p ≤ 1. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the mode of the distribution - - - - - Gets the median of the distribution. - - - - - Gets the smallest element in the domain of the distributions which can be represented by an integer. - - - - - Gets the largest element in the domain of the distributions which can be represented by an integer. - - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - The number of successes (r) required to stop the experiment. Range: r ≥ 0. - The probability (p) of a trial resulting in success. Range: 0 ≤ p ≤ 1. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - The number of successes (r) required to stop the experiment. Range: r ≥ 0. - The probability (p) of a trial resulting in success. Range: 0 ≤ p ≤ 1. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The number of successes (r) required to stop the experiment. Range: r ≥ 0. - The probability (p) of a trial resulting in success. Range: 0 ≤ p ≤ 1. - the cumulative distribution at location . - - - - - Samples a negative binomial distributed random variable. - - The random number generator to use. - The number of successes (r) required to stop the experiment. Range: r ≥ 0. - The probability (p) of a trial resulting in success. Range: 0 ≤ p ≤ 1. - a sample from the distribution. - - - - Samples a NegativeBinomial distributed random variable. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Samples an array of NegativeBinomial distributed random variables. - - a sequence of samples from the distribution. - - - - Samples a random variable. - - The random number generator to use. - The number of successes (r) required to stop the experiment. Range: r ≥ 0. - The probability (p) of a trial resulting in success. Range: 0 ≤ p ≤ 1. - - - - Samples a sequence of this random variable. - - The random number generator to use. - The number of successes (r) required to stop the experiment. Range: r ≥ 0. - The probability (p) of a trial resulting in success. Range: 0 ≤ p ≤ 1. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The number of successes (r) required to stop the experiment. Range: r ≥ 0. - The probability (p) of a trial resulting in success. Range: 0 ≤ p ≤ 1. - - - - Samples a random variable. - - The number of successes (r) required to stop the experiment. Range: r ≥ 0. - The probability (p) of a trial resulting in success. Range: 0 ≤ p ≤ 1. - - - - Samples a sequence of this random variable. - - The number of successes (r) required to stop the experiment. Range: r ≥ 0. - The probability (p) of a trial resulting in success. Range: 0 ≤ p ≤ 1. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The number of successes (r) required to stop the experiment. Range: r ≥ 0. - The probability (p) of a trial resulting in success. Range: 0 ≤ p ≤ 1. - - - - Continuous Univariate Normal distribution, also known as Gaussian distribution. - For details about this distribution, see - Wikipedia - Normal distribution. - - - - - Initializes a new instance of the Normal class. This is a normal distribution with mean 0.0 - and standard deviation 1.0. The distribution will - be initialized with the default random number generator. - - - - - Initializes a new instance of the Normal class. This is a normal distribution with mean 0.0 - and standard deviation 1.0. The distribution will - be initialized with the default random number generator. - - The random number generator which is used to draw random samples. - - - - Initializes a new instance of the Normal class with a particular mean and standard deviation. The distribution will - be initialized with the default random number generator. - - The mean (μ) of the normal distribution. - The standard deviation (σ) of the normal distribution. Range: σ ≥ 0. - - - - Initializes a new instance of the Normal class with a particular mean and standard deviation. The distribution will - be initialized with the default random number generator. - - The mean (μ) of the normal distribution. - The standard deviation (σ) of the normal distribution. Range: σ ≥ 0. - The random number generator which is used to draw random samples. - - - - Constructs a normal distribution from a mean and standard deviation. - - The mean (μ) of the normal distribution. - The standard deviation (σ) of the normal distribution. Range: σ ≥ 0. - The random number generator which is used to draw random samples. Optional, can be null. - a normal distribution. - - - - Constructs a normal distribution from a mean and variance. - - The mean (μ) of the normal distribution. - The variance (σ^2) of the normal distribution. - The random number generator which is used to draw random samples. Optional, can be null. - A normal distribution. - - - - Constructs a normal distribution from a mean and precision. - - The mean (μ) of the normal distribution. - The precision of the normal distribution. - The random number generator which is used to draw random samples. Optional, can be null. - A normal distribution. - - - - Estimates the normal distribution parameters from sample data with maximum-likelihood. - - The samples to estimate the distribution parameters from. - The random number generator which is used to draw random samples. Optional, can be null. - A normal distribution. - MATLAB: normfit - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The mean (μ) of the normal distribution. - The standard deviation (σ) of the normal distribution. Range: σ ≥ 0. - - - - Gets the mean (μ) of the normal distribution. - - - - - Gets the standard deviation (σ) of the normal distribution. Range: σ ≥ 0. - - - - - Gets the variance of the normal distribution. - - - - - Gets the precision of the normal distribution. - - - - - Gets the random number generator which is used to draw random samples. - - - - - Gets the entropy of the normal distribution. - - - - - Gets the skewness of the normal distribution. - - - - - Gets the mode of the normal distribution. - - - - - Gets the median of the normal distribution. - - - - - Gets the minimum of the normal distribution. - - - - - Gets the maximum of the normal distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - - - - Generates a sample from the normal distribution using the Box-Muller algorithm. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the normal distribution using the Box-Muller algorithm. - - a sequence of samples from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The mean (μ) of the normal distribution. - The standard deviation (σ) of the normal distribution. Range: σ ≥ 0. - The location at which to compute the density. - the density at . - - MATLAB: normpdf - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The mean (μ) of the normal distribution. - The standard deviation (σ) of the normal distribution. Range: σ ≥ 0. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The mean (μ) of the normal distribution. - The standard deviation (σ) of the normal distribution. Range: σ ≥ 0. - the cumulative distribution at location . - - MATLAB: normcdf - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - The mean (μ) of the normal distribution. - The standard deviation (σ) of the normal distribution. Range: σ ≥ 0. - the inverse cumulative density at . - - MATLAB: norminv - - - - Generates a sample from the normal distribution using the Box-Muller algorithm. - - The random number generator to use. - The mean (μ) of the normal distribution. - The standard deviation (σ) of the normal distribution. Range: σ ≥ 0. - a sample from the distribution. - - - - Generates a sequence of samples from the normal distribution using the Box-Muller algorithm. - - The random number generator to use. - The mean (μ) of the normal distribution. - The standard deviation (σ) of the normal distribution. Range: σ ≥ 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The mean (μ) of the normal distribution. - The standard deviation (σ) of the normal distribution. Range: σ ≥ 0. - a sequence of samples from the distribution. - - - - Generates a sample from the normal distribution using the Box-Muller algorithm. - - The mean (μ) of the normal distribution. - The standard deviation (σ) of the normal distribution. Range: σ ≥ 0. - a sample from the distribution. - - - - Generates a sequence of samples from the normal distribution using the Box-Muller algorithm. - - The mean (μ) of the normal distribution. - The standard deviation (σ) of the normal distribution. Range: σ ≥ 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The mean (μ) of the normal distribution. - The standard deviation (σ) of the normal distribution. Range: σ ≥ 0. - a sequence of samples from the distribution. - - - - This structure represents the type over which the distribution - is defined. - - - - - Initializes a new instance of the struct. - - The mean of the pair. - The precision of the pair. - - - - Gets or sets the mean of the pair. - - - - - Gets or sets the precision of the pair. - - - - - Multivariate Normal-Gamma Distribution. - The distribution is the conjugate prior distribution for the - distribution. It specifies a prior over the mean and precision of the distribution. - It is parameterized by four numbers: the mean location, the mean scale, the precision shape and the - precision inverse scale. - The distribution NG(mu, tau | mloc,mscale,psscale,pinvscale) = Normal(mu | mloc, 1/(mscale*tau)) * Gamma(tau | psscale,pinvscale). - The following degenerate cases are special: when the precision is known, - the precision shape will encode the value of the precision while the precision inverse scale is positive - infinity. When the mean is known, the mean location will encode the value of the mean while the scale - will be positive infinity. A completely degenerate NormalGamma distribution with known mean and precision is possible as well. - Wikipedia - Normal-Gamma distribution. - - - - - Initializes a new instance of the class. - - The location of the mean. - The scale of the mean. - The shape of the precision. - The inverse scale of the precision. - - - - Initializes a new instance of the class. - - The location of the mean. - The scale of the mean. - The shape of the precision. - The inverse scale of the precision. - The random number generator which is used to draw random samples. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The location of the mean. - The scale of the mean. - The shape of the precision. - The inverse scale of the precision. - - - - Gets the location of the mean. - - - - - Gets the scale of the mean. - - - - - Gets the shape of the precision. - - - - - Gets the inverse scale of the precision. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Returns the marginal distribution for the mean of the NormalGamma distribution. - - the marginal distribution for the mean of the NormalGamma distribution. - - - - Returns the marginal distribution for the precision of the distribution. - - The marginal distribution for the precision of the distribution/ - - - - Gets the mean of the distribution. - - The mean of the distribution. - - - - Gets the variance of the distribution. - - The mean of the distribution. - - - - Evaluates the probability density function for a NormalGamma distribution. - - The mean/precision pair of the distribution - Density value - - - - Evaluates the probability density function for a NormalGamma distribution. - - The mean of the distribution - The precision of the distribution - Density value - - - - Evaluates the log probability density function for a NormalGamma distribution. - - The mean/precision pair of the distribution - The log of the density value - - - - Evaluates the log probability density function for a NormalGamma distribution. - - The mean of the distribution - The precision of the distribution - The log of the density value - - - - Generates a sample from the NormalGamma distribution. - - a sample from the distribution. - - - - Generates a sequence of samples from the NormalGamma distribution - - a sequence of samples from the distribution. - - - - Generates a sample from the NormalGamma distribution. - - The random number generator to use. - The location of the mean. - The scale of the mean. - The shape of the precision. - The inverse scale of the precision. - a sample from the distribution. - - - - Generates a sequence of samples from the NormalGamma distribution - - The random number generator to use. - The location of the mean. - The scale of the mean. - The shape of the precision. - The inverse scale of the precision. - a sequence of samples from the distribution. - - - - Continuous Univariate Pareto distribution. - The Pareto distribution is a power law probability distribution that coincides with social, - scientific, geophysical, actuarial, and many other types of observable phenomena. - For details about this distribution, see - Wikipedia - Pareto distribution. - - - - - Initializes a new instance of the class. - - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - If or are negative. - - - - Initializes a new instance of the class. - - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - The random number generator which is used to draw random samples. - If or are negative. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - - - - Gets the scale (xm) of the distribution. Range: xm > 0. - - - - - Gets the shape (α) of the distribution. Range: α > 0. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the mode of the distribution. - - - - - Gets the median of the distribution. - - - - - Gets the minimum of the distribution. - - - - - Gets the maximum of the distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - - - - Draws a random sample from the distribution. - - A random number from this distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the Pareto distribution. - - a sequence of samples from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - the inverse cumulative density at . - - - - - Generates a sample from the distribution. - - The random number generator to use. - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The random number generator to use. - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - a sequence of samples from the distribution. - - - - Generates a sample from the distribution. - - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - a sequence of samples from the distribution. - - - - Discrete Univariate Poisson distribution. - - - Distribution is described at Wikipedia - Poisson distribution. - Knuth's method is used to generate Poisson distributed random variables. - f(x) = exp(-λ)*λ^x/x!; - - - - - Initializes a new instance of the class. - - The lambda (λ) parameter of the Poisson distribution. Range: λ > 0. - If is equal or less then 0.0. - - - - Initializes a new instance of the class. - - The lambda (λ) parameter of the Poisson distribution. Range: λ > 0. - The random number generator which is used to draw random samples. - If is equal or less then 0.0. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Tests whether the provided values are valid parameters for this distribution. - - The lambda (λ) parameter of the Poisson distribution. Range: λ > 0. - - - - Gets the Poisson distribution parameter λ. Range: λ > 0. - - - - - Gets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - Approximation, see Wikipedia Poisson distribution - - - - Gets the skewness of the distribution. - - - - - Gets the smallest element in the domain of the distributions which can be represented by an integer. - - - - - Gets the largest element in the domain of the distributions which can be represented by an integer. - - - - - Gets the mode of the distribution. - - - - - Gets the median of the distribution. - - Approximation, see Wikipedia Poisson distribution - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - The lambda (λ) parameter of the Poisson distribution. Range: λ > 0. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - The lambda (λ) parameter of the Poisson distribution. Range: λ > 0. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The lambda (λ) parameter of the Poisson distribution. Range: λ > 0. - the cumulative distribution at location . - - - - - Generates one sample from the Poisson distribution. - - The random source to use. - The lambda (λ) parameter of the Poisson distribution. Range: λ > 0. - A random sample from the Poisson distribution. - - - - Generates one sample from the Poisson distribution by Knuth's method. - - The random source to use. - The lambda (λ) parameter of the Poisson distribution. Range: λ > 0. - A random sample from the Poisson distribution. - - - - Generates one sample from the Poisson distribution by "Rejection method PA". - - The random source to use. - The lambda (λ) parameter of the Poisson distribution. Range: λ > 0. - A random sample from the Poisson distribution. - "Rejection method PA" from "The Computer Generation of Poisson Random Variables" by A. C. Atkinson, - Journal of the Royal Statistical Society Series C (Applied Statistics) Vol. 28, No. 1. (1979) - The article is on pages 29-35. The algorithm given here is on page 32. - - - - Samples a Poisson distributed random variable. - - A sample from the Poisson distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Samples an array of Poisson distributed random variables. - - a sequence of successes in N trials. - - - - Samples a Poisson distributed random variable. - - The random number generator to use. - The lambda (λ) parameter of the Poisson distribution. Range: λ > 0. - A sample from the Poisson distribution. - - - - Samples a sequence of Poisson distributed random variables. - - The random number generator to use. - The lambda (λ) parameter of the Poisson distribution. Range: λ > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The lambda (λ) parameter of the Poisson distribution. Range: λ > 0. - a sequence of samples from the distribution. - - - - Samples a Poisson distributed random variable. - - The lambda (λ) parameter of the Poisson distribution. Range: λ > 0. - A sample from the Poisson distribution. - - - - Samples a sequence of Poisson distributed random variables. - - The lambda (λ) parameter of the Poisson distribution. Range: λ > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The lambda (λ) parameter of the Poisson distribution. Range: λ > 0. - a sequence of samples from the distribution. - - - - Continuous Univariate Rayleigh distribution. - The Rayleigh distribution (pronounced /ˈreɪli/) is a continuous probability distribution. As an - example of how it arises, the wind speed will have a Rayleigh distribution if the components of - the two-dimensional wind velocity vector are uncorrelated and normally distributed with equal variance. - For details about this distribution, see - Wikipedia - Rayleigh distribution. - - - - - Initializes a new instance of the class. - - The scale (σ) of the distribution. Range: σ > 0. - If is negative. - - - - Initializes a new instance of the class. - - The scale (σ) of the distribution. Range: σ > 0. - The random number generator which is used to draw random samples. - If is negative. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The scale (σ) of the distribution. Range: σ > 0. - - - - Gets the scale (σ) of the distribution. Range: σ > 0. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the mode of the distribution. - - - - - Gets the median of the distribution. - - - - - Gets the minimum of the distribution. - - - - - Gets the maximum of the distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - - - - Draws a random sample from the distribution. - - A random number from this distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the Rayleigh distribution. - - a sequence of samples from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The scale (σ) of the distribution. Range: σ > 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The scale (σ) of the distribution. Range: σ > 0. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The scale (σ) of the distribution. Range: σ > 0. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - The scale (σ) of the distribution. Range: σ > 0. - the inverse cumulative density at . - - - - - Generates a sample from the distribution. - - The random number generator to use. - The scale (σ) of the distribution. Range: σ > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The random number generator to use. - The scale (σ) of the distribution. Range: σ > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The scale (σ) of the distribution. Range: σ > 0. - a sequence of samples from the distribution. - - - - Generates a sample from the distribution. - - The scale (σ) of the distribution. Range: σ > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The scale (σ) of the distribution. Range: σ > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The scale (σ) of the distribution. Range: σ > 0. - a sequence of samples from the distribution. - - - - Continuous Univariate Skewed Generalized Error Distribution (SGED). - Implements the univariate Skewed Generalized Error Distribution. For details about this - distribution, see - - Wikipedia - Generalized Error Distribution. - It includes Laplace, Normal and Student-t distributions. - This is the distribution with q=Inf. - - This implementation is based on the R package dsgt and corresponding viginette, see - https://cran.r-project.org/web/packages/sgt/vignettes/sgt.pdf. Compared to that - implementation, the options for mean adjustment and variance adjustment are always true. - The location (μ) is the mean of the distribution. - The scale (σ) squared is the variance of the distribution. - - The distribution will use the by - default. Users can get/set the random number generator by using the - property. - The statistics classes will check all the incoming parameters - whether they are in the allowed range. - - - - Initializes a new instance of the SkewedGeneralizedError class. This is a generalized error distribution - with location=0.0, scale=1.0, skew=0.0 and p=2.0 (a standard normal distribution). - - - - - Initializes a new instance of the SkewedGeneralizedT class with a particular location, scale, skew - and kurtosis parameters. Different parameterizations result in different distributions. - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - Parameter that controls kurtosis. Range: p > 0 - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - Parameter that controls kurtosis. Range: p > 0 - - - - Gets the location (μ) of the Skewed Generalized t-distribution. - - - - - Gets the scale (σ) of the Skewed Generalized t-distribution. Range: σ > 0. - - - - - Gets the skew (λ) of the Skewed Generalized t-distribution. Range: 1 > λ > -1. - - - - - Gets the parameter that controls the kurtosis of the distribution. Range: p > 0. - - - - - Generates a sample from the Skew Generalized Error distribution. - - The random number generator to use. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - Parameter that controls kurtosis. Range: p > 0 - a sample from the distribution. - - - - Generates a sequence of samples from the Skew Generalized Error distribution using inverse transform. - - The random number generator to use. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - Parameter that controls kurtosis. Range: p > 0 - a sequence of samples from the distribution. - - - - Fills an array with samples from the Skew Generalized Error distribution using inverse transform. - - The random number generator to use. - The array to fill with the samples. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - Parameter that controls kurtosis. Range: p > 0 - a sequence of samples from the distribution. - - - - Generates a sample from the Skew Generalized Error distribution. - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - Parameter that controls kurtosis. Range: p > 0 - a sample from the distribution. - - - - Generates a sequence of samples from the Skew Generalized Error distribution using inverse transform. - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - Parameter that controls kurtosis. Range: p > 0 - a sequence of samples from the distribution. - - - - Fills an array with samples from the Skew Generalized Error distribution using inverse transform. - - The array to fill with the samples. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - Parameter that controls kurtosis. Range: p > 0 - a sequence of samples from the distribution. - - - - Continuous Univariate Skewed Generalized T-distribution. - Implements the univariate Skewed Generalized t-distribution. For details about this - distribution, see - - Wikipedia - Skewed generalized t-distribution. - The skewed generalized t-distribution contains many different distributions within it - as special cases based on the parameterization chosen. - - This implementation is based on the R package dsgt and corresponding viginette, see - https://cran.r-project.org/web/packages/sgt/vignettes/sgt.pdf. Compared to that - implementation, the options for mean adjustment and variance adjustment are always true. - The location (μ) is the mean of the distribution. - The scale (σ) squared is the variance of the distribution. - - The distribution will use the by - default. Users can get/set the random number generator by using the - property. - The statistics classes will check all the incoming parameters - whether they are in the allowed range. - - - - Initializes a new instance of the SkewedGeneralizedT class. This is a skewed generalized t-distribution - with location=0.0, scale=1.0, skew=0.0, p=2.0 and q=Inf (a standard normal distribution). - - - - - Initializes a new instance of the SkewedGeneralizedT class with a particular location, scale, skew - and kurtosis parameters. Different parameterizations result in different distributions. - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - First parameter that controls kurtosis. Range: p > 0 - Second parameter that controls kurtosis. Range: q > 0 - - - - Given a parameter set, returns the distribution that matches this parameterization. - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - First parameter that controls kurtosis. Range: p > 0 - Second parameter that controls kurtosis. Range: q > 0 - Null if no known distribution matches the parameterization, else the distribution. - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - First parameter that controls kurtosis. Range: p > 0 - Second parameter that controls kurtosis. Range: q > 0 - - - - Gets the location (μ) of the Skewed Generalized t-distribution. - - - - - Gets the scale (σ) of the Skewed Generalized t-distribution. Range: σ > 0. - - - - - Gets the skew (λ) of the Skewed Generalized t-distribution. Range: 1 > λ > -1. - - - - - Gets the first parameter that controls the kurtosis of the distribution. Range: p > 0. - - - - - Gets the second parameter that controls the kurtosis of the distribution. Range: q > 0. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - First parameter that controls kurtosis. Range: p > 0 - Second parameter that controls kurtosis. Range: q > 0 - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - First parameter that controls kurtosis. Range: p > 0 - Second parameter that controls kurtosis. Range: q > 0 - The location at which to compute the density. - the density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - First parameter that controls kurtosis. Range: p > 0 - Second parameter that controls kurtosis. Range: q > 0 - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - First parameter that controls kurtosis. Range: p > 0 - Second parameter that controls kurtosis. Range: q > 0 - the inverse cumulative density at . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - - - - Generates a sample from the Skew Generalized t-distribution. - - The random number generator to use. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - First parameter that controls kurtosis. Range: p > 0 - Second parameter that controls kurtosis. Range: q > 0 - a sample from the distribution. - - - - Generates a sequence of samples from the Skew Generalized t-distribution using inverse transform. - - The random number generator to use. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - First parameter that controls kurtosis. Range: p > 0 - Second parameter that controls kurtosis. Range: q > 0 - a sequence of samples from the distribution. - - - - Fills an array with samples from the Skew Generalized t-distribution using inverse transform. - - The random number generator to use. - The array to fill with the samples. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - First parameter that controls kurtosis. Range: p > 0 - Second parameter that controls kurtosis. Range: q > 0 - a sequence of samples from the distribution. - - - - Generates a sample from the Skew Generalized t-distribution. - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - First parameter that controls kurtosis. Range: p > 0 - Second parameter that controls kurtosis. Range: q > 0 - a sample from the distribution. - - - - Generates a sequence of samples from the Skew Generalized t-distribution using inverse transform. - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - First parameter that controls kurtosis. Range: p > 0 - Second parameter that controls kurtosis. Range: q > 0 - a sequence of samples from the distribution. - - - - Fills an array with samples from the Skew Generalized t-distribution using inverse transform. - - The array to fill with the samples. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The skew, 1 > λ > -1 - First parameter that controls kurtosis. Range: p > 0 - Second parameter that controls kurtosis. Range: q > 0 - a sequence of samples from the distribution. - - - - Continuous Univariate Stable distribution. - A random variable is said to be stable (or to have a stable distribution) if it has - the property that a linear combination of two independent copies of the variable has - the same distribution, up to location and scale parameters. - For details about this distribution, see - Wikipedia - Stable distribution. - - - - - Initializes a new instance of the class. - - The stability (α) of the distribution. Range: 2 ≥ α > 0. - The skewness (β) of the distribution. Range: 1 ≥ β ≥ -1. - The scale (c) of the distribution. Range: c > 0. - The location (μ) of the distribution. - - - - Initializes a new instance of the class. - - The stability (α) of the distribution. Range: 2 ≥ α > 0. - The skewness (β) of the distribution. Range: 1 ≥ β ≥ -1. - The scale (c) of the distribution. Range: c > 0. - The location (μ) of the distribution. - The random number generator which is used to draw random samples. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The stability (α) of the distribution. Range: 2 ≥ α > 0. - The skewness (β) of the distribution. Range: 1 ≥ β ≥ -1. - The scale (c) of the distribution. Range: c > 0. - The location (μ) of the distribution. - - - - Gets the stability (α) of the distribution. Range: 2 ≥ α > 0. - - - - - Gets The skewness (β) of the distribution. Range: 1 ≥ β ≥ -1. - - - - - Gets the scale (c) of the distribution. Range: c > 0. - - - - - Gets the location (μ) of the distribution. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets he entropy of the distribution. - - Always throws a not supported exception. - - - - Gets the skewness of the distribution. - - Throws a not supported exception of Alpha != 2. - - - - Gets the mode of the distribution. - - Throws a not supported exception if Beta != 0. - - - - Gets the median of the distribution. - - Throws a not supported exception if Beta != 0. - - - - Gets the minimum of the distribution. - - - - - Gets the maximum of the distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - Throws a not supported exception if Alpha != 2, (Alpha != 1 and Beta !=0), or (Alpha != 0.5 and Beta != 1) - - - - Samples the distribution. - - The random number generator to use. - The stability (α) of the distribution. Range: 2 ≥ α > 0. - The skewness (β) of the distribution. Range: 1 ≥ β ≥ -1. - The scale (c) of the distribution. Range: c > 0. - The location (μ) of the distribution. - a random number from the distribution. - - - - Draws a random sample from the distribution. - - A random number from this distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the Stable distribution. - - a sequence of samples from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The stability (α) of the distribution. Range: 2 ≥ α > 0. - The skewness (β) of the distribution. Range: 1 ≥ β ≥ -1. - The scale (c) of the distribution. Range: c > 0. - The location (μ) of the distribution. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The stability (α) of the distribution. Range: 2 ≥ α > 0. - The skewness (β) of the distribution. Range: 1 ≥ β ≥ -1. - The scale (c) of the distribution. Range: c > 0. - The location (μ) of the distribution. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The stability (α) of the distribution. Range: 2 ≥ α > 0. - The skewness (β) of the distribution. Range: 1 ≥ β ≥ -1. - The scale (c) of the distribution. Range: c > 0. - The location (μ) of the distribution. - the cumulative distribution at location . - - - - - Generates a sample from the distribution. - - The random number generator to use. - The stability (α) of the distribution. Range: 2 ≥ α > 0. - The skewness (β) of the distribution. Range: 1 ≥ β ≥ -1. - The scale (c) of the distribution. Range: c > 0. - The location (μ) of the distribution. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The random number generator to use. - The stability (α) of the distribution. Range: 2 ≥ α > 0. - The skewness (β) of the distribution. Range: 1 ≥ β ≥ -1. - The scale (c) of the distribution. Range: c > 0. - The location (μ) of the distribution. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The stability (α) of the distribution. Range: 2 ≥ α > 0. - The skewness (β) of the distribution. Range: 1 ≥ β ≥ -1. - The scale (c) of the distribution. Range: c > 0. - The location (μ) of the distribution. - a sequence of samples from the distribution. - - - - Generates a sample from the distribution. - - The stability (α) of the distribution. Range: 2 ≥ α > 0. - The skewness (β) of the distribution. Range: 1 ≥ β ≥ -1. - The scale (c) of the distribution. Range: c > 0. - The location (μ) of the distribution. - a sample from the distribution. - - - - Generates a sequence of samples from the distribution. - - The stability (α) of the distribution. Range: 2 ≥ α > 0. - The skewness (β) of the distribution. Range: 1 ≥ β ≥ -1. - The scale (c) of the distribution. Range: c > 0. - The location (μ) of the distribution. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The stability (α) of the distribution. Range: 2 ≥ α > 0. - The skewness (β) of the distribution. Range: 1 ≥ β ≥ -1. - The scale (c) of the distribution. Range: c > 0. - The location (μ) of the distribution. - a sequence of samples from the distribution. - - - - Continuous Univariate Student's T-distribution. - Implements the univariate Student t-distribution. For details about this - distribution, see - - Wikipedia - Student's t-distribution. - - We use a slightly generalized version (compared to - Wikipedia) of the Student t-distribution. Namely, one which also - parameterizes the location and scale. See the book "Bayesian Data - Analysis" by Gelman et al. for more details. - The density of the Student t-distribution p(x|mu,scale,dof) = - Gamma((dof+1)/2) (1 + (x - mu)^2 / (scale * scale * dof))^(-(dof+1)/2) / - (Gamma(dof/2)*Sqrt(dof*pi*scale)). - The distribution will use the by - default. Users can get/set the random number generator by using the - property. - The statistics classes will check all the incoming parameters - whether they are in the allowed range. This might involve heavy - computation. Optionally, by setting Control.CheckDistributionParameters - to false, all parameter checks can be turned off. - - - - Initializes a new instance of the StudentT class. This is a Student t-distribution with location 0.0 - scale 1.0 and degrees of freedom 1. - - - - - Initializes a new instance of the StudentT class with a particular location, scale and degrees of - freedom. - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The degrees of freedom (ν) for the distribution. Range: ν > 0. - - - - Initializes a new instance of the StudentT class with a particular location, scale and degrees of - freedom. - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The degrees of freedom (ν) for the distribution. Range: ν > 0. - The random number generator which is used to draw random samples. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The degrees of freedom (ν) for the distribution. Range: ν > 0. - - - - Gets the location (μ) of the Student t-distribution. - - - - - Gets the scale (σ) of the Student t-distribution. Range: σ > 0. - - - - - Gets the degrees of freedom (ν) of the Student t-distribution. Range: ν > 0. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the Student t-distribution. - - - - - Gets the variance of the Student t-distribution. - - - - - Gets the standard deviation of the Student t-distribution. - - - - - Gets the entropy of the Student t-distribution. - - - - - Gets the skewness of the Student t-distribution. - - - - - Gets the mode of the Student t-distribution. - - - - - Gets the median of the Student t-distribution. - - - - - Gets the minimum of the Student t-distribution. - - - - - Gets the maximum of the Student t-distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - WARNING: currently not an explicit implementation, hence slow and unreliable. - - - - Samples student-t distributed random variables. - - The algorithm is method 2 in section 5, chapter 9 - in L. Devroye's "Non-Uniform Random Variate Generation" - The random number generator to use. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The degrees of freedom (ν) for the distribution. Range: ν > 0. - a random number from the standard student-t distribution. - - - - Generates a sample from the Student t-distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the Student t-distribution. - - a sequence of samples from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The degrees of freedom (ν) for the distribution. Range: ν > 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The degrees of freedom (ν) for the distribution. Range: ν > 0. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The degrees of freedom (ν) for the distribution. Range: ν > 0. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The degrees of freedom (ν) for the distribution. Range: ν > 0. - the inverse cumulative density at . - - WARNING: currently not an explicit implementation, hence slow and unreliable. - - - - Generates a sample from the Student t-distribution. - - The random number generator to use. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The degrees of freedom (ν) for the distribution. Range: ν > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the Student t-distribution using the Box-Muller algorithm. - - The random number generator to use. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The degrees of freedom (ν) for the distribution. Range: ν > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The degrees of freedom (ν) for the distribution. Range: ν > 0. - a sequence of samples from the distribution. - - - - Generates a sample from the Student t-distribution. - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The degrees of freedom (ν) for the distribution. Range: ν > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the Student t-distribution using the Box-Muller algorithm. - - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The degrees of freedom (ν) for the distribution. Range: ν > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The location (μ) of the distribution. - The scale (σ) of the distribution. Range: σ > 0. - The degrees of freedom (ν) for the distribution. Range: ν > 0. - a sequence of samples from the distribution. - - - - Triangular distribution. - For details, see Wikipedia - Triangular distribution. - - The distribution will use the by default. - Users can get/set the random number generator by using the property. - The statistics classes will check whether all the incoming parameters are in the allowed range. This might involve heavy computation. Optionally, by setting Control.CheckDistributionParameters - to false, all parameter checks can be turned off. - - - - Initializes a new instance of the Triangular class with the given lower bound, upper bound and mode. - - Lower bound. Range: lower ≤ mode ≤ upper - Upper bound. Range: lower ≤ mode ≤ upper - Mode (most frequent value). Range: lower ≤ mode ≤ upper - If the upper bound is smaller than the mode or if the mode is smaller than the lower bound. - - - - Initializes a new instance of the Triangular class with the given lower bound, upper bound and mode. - - Lower bound. Range: lower ≤ mode ≤ upper - Upper bound. Range: lower ≤ mode ≤ upper - Mode (most frequent value). Range: lower ≤ mode ≤ upper - The random number generator which is used to draw random samples. - If the upper bound is smaller than the mode or if the mode is smaller than the lower bound. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - Lower bound. Range: lower ≤ mode ≤ upper - Upper bound. Range: lower ≤ mode ≤ upper - Mode (most frequent value). Range: lower ≤ mode ≤ upper - - - - Gets the lower bound of the distribution. - - - - - Gets the upper bound of the distribution. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - - Gets the skewness of the distribution. - - - - - Gets or sets the mode of the distribution. - - - - - Gets the median of the distribution. - - - - - - Gets the minimum of the distribution. - - - - - Gets the maximum of the distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - the inverse cumulative density at . - - - - - Generates a sample from the Triangular distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the Triangular distribution. - - a sequence of samples from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - Lower bound. Range: lower ≤ mode ≤ upper - Upper bound. Range: lower ≤ mode ≤ upper - Mode (most frequent value). Range: lower ≤ mode ≤ upper - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - Lower bound. Range: lower ≤ mode ≤ upper - Upper bound. Range: lower ≤ mode ≤ upper - Mode (most frequent value). Range: lower ≤ mode ≤ upper - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - Lower bound. Range: lower ≤ mode ≤ upper - Upper bound. Range: lower ≤ mode ≤ upper - Mode (most frequent value). Range: lower ≤ mode ≤ upper - the cumulative distribution at location . - - - - - Computes the inverse of the cumulative distribution function (InvCDF) for the distribution - at the given probability. This is also known as the quantile or percent point function. - - The location at which to compute the inverse cumulative density. - Lower bound. Range: lower ≤ mode ≤ upper - Upper bound. Range: lower ≤ mode ≤ upper - Mode (most frequent value). Range: lower ≤ mode ≤ upper - the inverse cumulative density at . - - - - - Generates a sample from the Triangular distribution. - - The random number generator to use. - Lower bound. Range: lower ≤ mode ≤ upper - Upper bound. Range: lower ≤ mode ≤ upper - Mode (most frequent value). Range: lower ≤ mode ≤ upper - a sample from the distribution. - - - - Generates a sequence of samples from the Triangular distribution. - - The random number generator to use. - Lower bound. Range: lower ≤ mode ≤ upper - Upper bound. Range: lower ≤ mode ≤ upper - Mode (most frequent value). Range: lower ≤ mode ≤ upper - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - Lower bound. Range: lower ≤ mode ≤ upper - Upper bound. Range: lower ≤ mode ≤ upper - Mode (most frequent value). Range: lower ≤ mode ≤ upper - a sequence of samples from the distribution. - - - - Generates a sample from the Triangular distribution. - - Lower bound. Range: lower ≤ mode ≤ upper - Upper bound. Range: lower ≤ mode ≤ upper - Mode (most frequent value). Range: lower ≤ mode ≤ upper - a sample from the distribution. - - - - Generates a sequence of samples from the Triangular distribution. - - Lower bound. Range: lower ≤ mode ≤ upper - Upper bound. Range: lower ≤ mode ≤ upper - Mode (most frequent value). Range: lower ≤ mode ≤ upper - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - Lower bound. Range: lower ≤ mode ≤ upper - Upper bound. Range: lower ≤ mode ≤ upper - Mode (most frequent value). Range: lower ≤ mode ≤ upper - a sequence of samples from the distribution. - - - - Initializes a new instance of the TruncatedPareto class. - - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - The truncation (T) of the distribution. Range: T > xm. - The random number generator which is used to draw random samples. - If or are non-positive or if T ≤ xm. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - The truncation (T) of the distribution. Range: T > xm. - - - - Gets the random number generator which is used to draw random samples. - - - - - Gets the scale (xm) of the distribution. Range: xm > 0. - - - - - Gets the shape (α) of the distribution. Range: α > 0. - - - - - Gets the truncation (T) of the distribution. Range: T > 0. - - - - - Gets the n-th raw moment of the distribution. - - The order (n) of the moment. Range: n ≥ 1. - the n-th moment of the distribution. - - - - Gets the mean of the truncated Pareto distribution. - - - - - Gets the variance of the truncated Pareto distribution. - - - - - Gets the standard deviation of the truncated Pareto distribution. - - - - - Gets the mode of the truncated Pareto distribution (not supported). - - - - - Gets the minimum of the truncated Pareto distribution. - - - - - Gets the maximum of the truncated Pareto distribution. - - - - - Gets the entropy of the truncated Pareto distribution (not supported). - - - - - Gets the skewness of the truncated Pareto distribution. - - - - - Gets the median of the truncated Pareto distribution. - - - - - Generates a sample from the truncated Pareto distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - - - - Generates a sequence of samples from the truncated Pareto distribution. - - a sequence of samples from the distribution. - - - - Generates a sample from the truncated Pareto distribution. - - The random number generator to use. - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - The truncation (T) of the distribution. Range: T > xm. - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - The truncation (T) of the distribution. Range: T > xm. - - - - Generates a sequence of samples from the truncated Pareto distribution. - - The random number generator to use. - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - The truncation (T) of the distribution. Range: T > xm. - a sequence of samples from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Computes the inverse cumulative distribution (CDF) of the distribution at p, i.e. solving for P(X ≤ x) = p. - - The location at which to compute the inverse cumulative distribution function. - the inverse cumulative distribution at location . - - - - Computes the inverse cumulative distribution (CDF) of the distribution at p, i.e. solving for P(X ≤ x) = p. - - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - The truncation (T) of the distribution. Range: T > xm. - The location at which to compute the inverse cumulative distribution function. - the inverse cumulative distribution at location . - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - The truncation (T) of the distribution. Range: T > xm. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - The truncation (T) of the distribution. Range: T > xm. - The location at which to compute the log density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The scale (xm) of the distribution. Range: xm > 0. - The shape (α) of the distribution. Range: α > 0. - The truncation (T) of the distribution. Range: T > xm. - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - - Continuous Univariate Weibull distribution. - For details about this distribution, see - Wikipedia - Weibull distribution. - - - The Weibull distribution is parametrized by a shape and scale parameter. - - - - - Reusable intermediate result 1 / (_scale ^ _shape) - - - By caching this parameter we can get slightly better numerics precision - in certain constellations without any additional computations. - - - - - Initializes a new instance of the Weibull class. - - The shape (k) of the Weibull distribution. Range: k > 0. - The scale (λ) of the Weibull distribution. Range: λ > 0. - - - - Initializes a new instance of the Weibull class. - - The shape (k) of the Weibull distribution. Range: k > 0. - The scale (λ) of the Weibull distribution. Range: λ > 0. - The random number generator which is used to draw random samples. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The shape (k) of the Weibull distribution. Range: k > 0. - The scale (λ) of the Weibull distribution. Range: λ > 0. - - - - Gets the shape (k) of the Weibull distribution. Range: k > 0. - - - - - Gets the scale (λ) of the Weibull distribution. Range: λ > 0. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the Weibull distribution. - - - - - Gets the variance of the Weibull distribution. - - - - - Gets the standard deviation of the Weibull distribution. - - - - - Gets the entropy of the Weibull distribution. - - - - - Gets the skewness of the Weibull distribution. - - - - - Gets the mode of the Weibull distribution. - - - - - Gets the median of the Weibull distribution. - - - - - Gets the minimum of the Weibull distribution. - - - - - Gets the maximum of the Weibull distribution. - - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The location at which to compute the density. - the density at . - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The location at which to compute the log density. - the log density at . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - Generates a sample from the Weibull distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Generates a sequence of samples from the Weibull distribution. - - a sequence of samples from the distribution. - - - - Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x. - - The shape (k) of the Weibull distribution. Range: k > 0. - The scale (λ) of the Weibull distribution. Range: λ > 0. - The location at which to compute the density. - the density at . - - - - - Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x). - - The shape (k) of the Weibull distribution. Range: k > 0. - The scale (λ) of the Weibull distribution. Range: λ > 0. - The location at which to compute the density. - the log density at . - - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The shape (k) of the Weibull distribution. Range: k > 0. - The scale (λ) of the Weibull distribution. Range: λ > 0. - the cumulative distribution at location . - - - - - Implemented according to: Parameter estimation of the Weibull probability distribution, 1994, Hongzhu Qiao, Chris P. Tsokos - - - - Returns a Weibull distribution. - - - - Generates a sample from the Weibull distribution. - - The random number generator to use. - The shape (k) of the Weibull distribution. Range: k > 0. - The scale (λ) of the Weibull distribution. Range: λ > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the Weibull distribution. - - The random number generator to use. - The shape (k) of the Weibull distribution. Range: k > 0. - The scale (λ) of the Weibull distribution. Range: λ > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The shape (k) of the Weibull distribution. Range: k > 0. - The scale (λ) of the Weibull distribution. Range: λ > 0. - a sequence of samples from the distribution. - - - - Generates a sample from the Weibull distribution. - - The shape (k) of the Weibull distribution. Range: k > 0. - The scale (λ) of the Weibull distribution. Range: λ > 0. - a sample from the distribution. - - - - Generates a sequence of samples from the Weibull distribution. - - The shape (k) of the Weibull distribution. Range: k > 0. - The scale (λ) of the Weibull distribution. Range: λ > 0. - a sequence of samples from the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The shape (k) of the Weibull distribution. Range: k > 0. - The scale (λ) of the Weibull distribution. Range: λ > 0. - a sequence of samples from the distribution. - - - - Multivariate Wishart distribution. This distribution is - parameterized by the degrees of freedom nu and the scale matrix S. The Wishart distribution - is the conjugate prior for the precision (inverse covariance) matrix of the multivariate - normal distribution. - Wikipedia - Wishart distribution. - - - - - The degrees of freedom for the Wishart distribution. - - - - - The scale matrix for the Wishart distribution. - - - - - Caches the Cholesky factorization of the scale matrix. - - - - - Initializes a new instance of the class. - - The degrees of freedom (n) for the Wishart distribution. - The scale matrix (V) for the Wishart distribution. - - - - Initializes a new instance of the class. - - The degrees of freedom (n) for the Wishart distribution. - The scale matrix (V) for the Wishart distribution. - The random number generator which is used to draw random samples. - - - - Tests whether the provided values are valid parameters for this distribution. - - The degrees of freedom (n) for the Wishart distribution. - The scale matrix (V) for the Wishart distribution. - - - - Gets or sets the degrees of freedom (n) for the Wishart distribution. - - - - - Gets or sets the scale matrix (V) for the Wishart distribution. - - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - The mean of the distribution. - - - - Gets the mode of the distribution. - - The mode of the distribution. - - - - Gets the variance of the distribution. - - The variance of the distribution. - - - - Evaluates the probability density function for the Wishart distribution. - - The matrix at which to evaluate the density at. - If the argument does not have the same dimensions as the scale matrix. - the density at . - - - - Samples a Wishart distributed random variable using the method - Algorithm AS 53: Wishart Variate Generator - W. B. Smith and R. R. Hocking - Applied Statistics, Vol. 21, No. 3 (1972), pp. 341-345 - - A random number from this distribution. - - - - Samples a Wishart distributed random variable using the method - Algorithm AS 53: Wishart Variate Generator - W. B. Smith and R. R. Hocking - Applied Statistics, Vol. 21, No. 3 (1972), pp. 341-345 - - The random number generator to use. - The degrees of freedom (n) for the Wishart distribution. - The scale matrix (V) for the Wishart distribution. - a sequence of samples from the distribution. - - - - Samples the distribution. - - The random number generator to use. - The degrees of freedom (n) for the Wishart distribution. - The scale matrix (V) for the Wishart distribution. - The cholesky decomposition to use. - a random number from the distribution. - - - - Discrete Univariate Zipf distribution. - Zipf's law, an empirical law formulated using mathematical statistics, refers to the fact - that many types of data studied in the physical and social sciences can be approximated with - a Zipfian distribution, one of a family of related discrete power law probability distributions. - For details about this distribution, see - Wikipedia - Zipf distribution. - - - - - The s parameter of the distribution. - - - - - The n parameter of the distribution. - - - - - Initializes a new instance of the class. - - The s parameter of the distribution. - The n parameter of the distribution. - - - - Initializes a new instance of the class. - - The s parameter of the distribution. - The n parameter of the distribution. - The random number generator which is used to draw random samples. - - - - A string representation of the distribution. - - a string representation of the distribution. - - - - Tests whether the provided values are valid parameters for this distribution. - - The s parameter of the distribution. - The n parameter of the distribution. - - - - Gets or sets the s parameter of the distribution. - - - - - Gets or sets the n parameter of the distribution. - - - - - Gets or sets the random number generator which is used to draw random samples. - - - - - Gets the mean of the distribution. - - - - - Gets the variance of the distribution. - - - - - Gets the standard deviation of the distribution. - - - - - Gets the entropy of the distribution. - - - - - Gets the skewness of the distribution. - - - - - Gets the mode of the distribution. - - - - - Gets the median of the distribution. - - - - - Gets the smallest element in the domain of the distributions which can be represented by an integer. - - - - - Gets the largest element in the domain of the distributions which can be represented by an integer. - - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - the cumulative distribution at location . - - - - Computes the probability mass (PMF) at k, i.e. P(X = k). - - The location in the domain where we want to evaluate the probability mass function. - The s parameter of the distribution. - The n parameter of the distribution. - the probability mass at location . - - - - Computes the log probability mass (lnPMF) at k, i.e. ln(P(X = k)). - - The location in the domain where we want to evaluate the log probability mass function. - The s parameter of the distribution. - The n parameter of the distribution. - the log probability mass at location . - - - - Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x). - - The location at which to compute the cumulative distribution function. - The s parameter of the distribution. - The n parameter of the distribution. - the cumulative distribution at location . - - - - - Generates a sample from the Zipf distribution without doing parameter checking. - - The random number generator to use. - The s parameter of the distribution. - The n parameter of the distribution. - a random number from the Zipf distribution. - - - - Draws a random sample from the distribution. - - a sample from the distribution. - - - - Fills an array with samples generated from the distribution. - - - - - Samples an array of zipf distributed random variables. - - a sequence of samples from the distribution. - - - - Samples a random variable. - - The random number generator to use. - The s parameter of the distribution. - The n parameter of the distribution. - - - - Samples a sequence of this random variable. - - The random number generator to use. - The s parameter of the distribution. - The n parameter of the distribution. - - - - Fills an array with samples generated from the distribution. - - The random number generator to use. - The array to fill with the samples. - The s parameter of the distribution. - The n parameter of the distribution. - - - - Samples a random variable. - - The s parameter of the distribution. - The n parameter of the distribution. - - - - Samples a sequence of this random variable. - - The s parameter of the distribution. - The n parameter of the distribution. - - - - Fills an array with samples generated from the distribution. - - The array to fill with the samples. - The s parameter of the distribution. - The n parameter of the distribution. - - - - Integer number theory functions. - - - - - Canonical Modulus. The result has the sign of the divisor. - - - - - Canonical Modulus. The result has the sign of the divisor. - - - - - Canonical Modulus. The result has the sign of the divisor. - - - - - Canonical Modulus. The result has the sign of the divisor. - - - - - Canonical Modulus. The result has the sign of the divisor. - - - - - Remainder (% operator). The result has the sign of the dividend. - - - - - Remainder (% operator). The result has the sign of the dividend. - - - - - Remainder (% operator). The result has the sign of the dividend. - - - - - Remainder (% operator). The result has the sign of the dividend. - - - - - Remainder (% operator). The result has the sign of the dividend. - - - - - Find out whether the provided 32 bit integer is an even number. - - The number to very whether it's even. - True if and only if it is an even number. - - - - Find out whether the provided 64 bit integer is an even number. - - The number to very whether it's even. - True if and only if it is an even number. - - - - Find out whether the provided 32 bit integer is an odd number. - - The number to very whether it's odd. - True if and only if it is an odd number. - - - - Find out whether the provided 64 bit integer is an odd number. - - The number to very whether it's odd. - True if and only if it is an odd number. - - - - Find out whether the provided 32 bit integer is a perfect power of two. - - The number to very whether it's a power of two. - True if and only if it is a power of two. - - - - Find out whether the provided 64 bit integer is a perfect power of two. - - The number to very whether it's a power of two. - True if and only if it is a power of two. - - - - Find out whether the provided 32 bit integer is a perfect square, i.e. a square of an integer. - - The number to very whether it's a perfect square. - True if and only if it is a perfect square. - - - - Find out whether the provided 64 bit integer is a perfect square, i.e. a square of an integer. - - The number to very whether it's a perfect square. - True if and only if it is a perfect square. - - - - Raises 2 to the provided integer exponent (0 <= exponent < 31). - - The exponent to raise 2 up to. - 2 ^ exponent. - - - - - Raises 2 to the provided integer exponent (0 <= exponent < 63). - - The exponent to raise 2 up to. - 2 ^ exponent. - - - - - Evaluate the binary logarithm of an integer number. - - Two-step method using a De Bruijn-like sequence table lookup. - - - - Find the closest perfect power of two that is larger or equal to the provided - 32 bit integer. - - The number of which to find the closest upper power of two. - A power of two. - - - - - Find the closest perfect power of two that is larger or equal to the provided - 64 bit integer. - - The number of which to find the closest upper power of two. - A power of two. - - - - - Returns the greatest common divisor (gcd) of two integers using Euclid's algorithm. - - First Integer: a. - Second Integer: b. - Greatest common divisor gcd(a,b) - - - - Returns the greatest common divisor (gcd) of a set of integers using Euclid's - algorithm. - - List of Integers. - Greatest common divisor gcd(list of integers) - - - - Returns the greatest common divisor (gcd) of a set of integers using Euclid's algorithm. - - List of Integers. - Greatest common divisor gcd(list of integers) - - - - Computes the extended greatest common divisor, such that a*x + b*y = gcd(a,b). - - First Integer: a. - Second Integer: b. - Resulting x, such that a*x + b*y = gcd(a,b). - Resulting y, such that a*x + b*y = gcd(a,b) - Greatest common divisor gcd(a,b) - - - long x,y,d; - d = Fn.GreatestCommonDivisor(45,18,out x, out y); - -> d == 9 && x == 1 && y == -2 - - The gcd of 45 and 18 is 9: 18 = 2*9, 45 = 5*9. 9 = 1*45 -2*18, therefore x=1 and y=-2. - - - - - Returns the least common multiple (lcm) of two integers using Euclid's algorithm. - - First Integer: a. - Second Integer: b. - Least common multiple lcm(a,b) - - - - Returns the least common multiple (lcm) of a set of integers using Euclid's algorithm. - - List of Integers. - Least common multiple lcm(list of integers) - - - - Returns the least common multiple (lcm) of a set of integers using Euclid's algorithm. - - List of Integers. - Least common multiple lcm(list of integers) - - - - Returns the greatest common divisor (gcd) of two big integers. - - First Integer: a. - Second Integer: b. - Greatest common divisor gcd(a,b) - - - - Returns the greatest common divisor (gcd) of a set of big integers. - - List of Integers. - Greatest common divisor gcd(list of integers) - - - - Returns the greatest common divisor (gcd) of a set of big integers. - - List of Integers. - Greatest common divisor gcd(list of integers) - - - - Computes the extended greatest common divisor, such that a*x + b*y = gcd(a,b). - - First Integer: a. - Second Integer: b. - Resulting x, such that a*x + b*y = gcd(a,b). - Resulting y, such that a*x + b*y = gcd(a,b) - Greatest common divisor gcd(a,b) - - - long x,y,d; - d = Fn.GreatestCommonDivisor(45,18,out x, out y); - -> d == 9 && x == 1 && y == -2 - - The gcd of 45 and 18 is 9: 18 = 2*9, 45 = 5*9. 9 = 1*45 -2*18, therefore x=1 and y=-2. - - - - - Returns the least common multiple (lcm) of two big integers. - - First Integer: a. - Second Integer: b. - Least common multiple lcm(a,b) - - - - Returns the least common multiple (lcm) of a set of big integers. - - List of Integers. - Least common multiple lcm(list of integers) - - - - Returns the least common multiple (lcm) of a set of big integers. - - List of Integers. - Least common multiple lcm(list of integers) - - - - Collection of functions equivalent to those provided by Microsoft Excel - but backed instead by Math.NET Numerics. - We do not recommend to use them except in an intermediate phase when - porting over solutions previously implemented in Excel. - - - - - An algorithm failed to converge. - - - - - An algorithm failed to converge due to a numerical breakdown. - - - - - An error occurred calling native provider function. - - - - - An error occurred calling native provider function. - - - - - Native provider was unable to allocate sufficient memory. - - - - - Native provider failed LU inversion do to a singular U matrix. - - - - - Compound Monthly Return or Geometric Return or Annualized Return - - - - - Average Gain or Gain Mean - This is a simple average (arithmetic mean) of the periods with a gain. It is calculated by summing the returns for gain periods (return 0) - and then dividing the total by the number of gain periods. - - http://www.offshore-library.com/kb/statistics.php - - - - Average Loss or LossMean - This is a simple average (arithmetic mean) of the periods with a loss. It is calculated by summing the returns for loss periods (return < 0) - and then dividing the total by the number of loss periods. - - http://www.offshore-library.com/kb/statistics.php - - - - Calculation is similar to Standard Deviation , except it calculates an average (mean) return only for periods with a gain - and measures the variation of only the gain periods around the gain mean. Measures the volatility of upside performance. - © Copyright 1996, 1999 Gary L.Gastineau. First Edition. © 1992 Swiss Bank Corporation. - - - - - Similar to standard deviation, except this statistic calculates an average (mean) return for only the periods with a loss and then - measures the variation of only the losing periods around this loss mean. This statistic measures the volatility of downside performance. - - http://www.offshore-library.com/kb/statistics.php - - - - This measure is similar to the loss standard deviation except the downside deviation - considers only returns that fall below a defined minimum acceptable return (MAR) rather than the arithmetic mean. - For example, if the MAR is 7%, the downside deviation would measure the variation of each period that falls below - 7%. (The loss standard deviation, on the other hand, would take only losing periods, calculate an average return for - the losing periods, and then measure the variation between each losing return and the losing return average). - - - - - A measure of volatility in returns below the mean. It's similar to standard deviation, but it only - looks at periods where the investment return was less than average return. - - - - - Measures a fund’s average gain in a gain period divided by the fund’s average loss in a losing - period. Periods can be monthly or quarterly depending on the data frequency. - - - - - Find value x that minimizes the scalar function f(x), constrained within bounds, using the Golden Section algorithm. - For more options and diagnostics consider to use directly. - - - - - Find vector x that minimizes the function f(x) using the Nelder-Mead Simplex algorithm. - For more options and diagnostics consider to use directly. - - - - - Find vector x that minimizes the function f(x) using the Nelder-Mead Simplex algorithm. - For more options and diagnostics consider to use directly. - - - - - Find vector x that minimizes the function f(x) using the Nelder-Mead Simplex algorithm. - For more options and diagnostics consider to use directly. - - - - - Find vector x that minimizes the function f(x) using the Nelder-Mead Simplex algorithm. - For more options and diagnostics consider to use directly. - - - - - Find vector x that minimizes the function f(x) using the Nelder-Mead Simplex algorithm. - For more options and diagnostics consider to use directly. - - - - - Find vector x that minimizes the function f(x) using the Nelder-Mead Simplex algorithm. - For more options and diagnostics consider to use directly. - - - - - Find vector x that minimizes the function f(x), constrained within bounds, using the Broyden–Fletcher–Goldfarb–Shanno Bounded (BFGS-B) algorithm. - The missing gradient is evaluated numerically (forward difference). - For more options and diagnostics consider to use directly. - - - - - Find vector x that minimizes the function f(x) using the Broyden–Fletcher–Goldfarb–Shanno (BFGS) algorithm. - For more options and diagnostics consider to use directly. - An alternative routine using conjugate gradients (CG) is available in . - - - - - Find vector x that minimizes the function f(x) using the Broyden–Fletcher–Goldfarb–Shanno (BFGS) algorithm. - For more options and diagnostics consider to use directly. - An alternative routine using conjugate gradients (CG) is available in . - - - - - Find vector x that minimizes the function f(x), constrained within bounds, using the Broyden–Fletcher–Goldfarb–Shanno Bounded (BFGS-B) algorithm. - For more options and diagnostics consider to use directly. - - - - - Find vector x that minimizes the function f(x), constrained within bounds, using the Broyden–Fletcher–Goldfarb–Shanno Bounded (BFGS-B) algorithm. - For more options and diagnostics consider to use directly. - - - - - Find vector x that minimizes the function f(x) using the Newton algorithm. - For more options and diagnostics consider to use directly. - - - - - Find vector x that minimizes the function f(x) using the Newton algorithm. - For more options and diagnostics consider to use directly. - - - - Find a solution of the equation f(x)=0. - The function to find roots from. - The low value of the range where the root is supposed to be. - The high value of the range where the root is supposed to be. - Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Example: 1e-14. - Maximum number of iterations. Example: 100. - - - Find a solution of the equation f(x)=0. - The function to find roots from. - The first derivative of the function to find roots from. - The low value of the range where the root is supposed to be. - The high value of the range where the root is supposed to be. - Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Example: 1e-14. - Maximum number of iterations. Example: 100. - - - - Find both complex roots of the quadratic equation c + b*x + a*x^2 = 0. - Note the special coefficient order ascending by exponent (consistent with polynomials). - - - - - Find all three complex roots of the cubic equation d + c*x + b*x^2 + a*x^3 = 0. - Note the special coefficient order ascending by exponent (consistent with polynomials). - - - - - Find all roots of a polynomial by calculating the characteristic polynomial of the companion matrix - - The coefficients of the polynomial in ascending order, e.g. new double[] {5, 0, 2} = "5 + 0 x^1 + 2 x^2" - The roots of the polynomial - - - - Find all roots of a polynomial by calculating the characteristic polynomial of the companion matrix - - The polynomial. - The roots of the polynomial - - - - Find all roots of the Chebychev polynomial of the first kind. - - The polynomial order and therefore the number of roots. - The real domain interval begin where to start sampling. - The real domain interval end where to stop sampling. - Samples in [a,b] at (b+a)/2+(b-1)/2*cos(pi*(2i-1)/(2n)) - - - - Find all roots of the Chebychev polynomial of the second kind. - - The polynomial order and therefore the number of roots. - The real domain interval begin where to start sampling. - The real domain interval end where to stop sampling. - Samples in [a,b] at (b+a)/2+(b-1)/2*cos(pi*i/(n-1)) - - - - Least-Squares Curve Fitting Routines - - - - - Least-Squares fitting the points (x,y) to a line y : x -> a+b*x, - returning its best fitting parameters as (a, b) tuple, - where a is the intercept and b the slope. - - - - - Least-Squares fitting the points (x,y) to a line y : x -> a+b*x, - returning a function y' for the best fitting line. - - - - - Least-Squares fitting the points (x,y) to a line through origin y : x -> b*x, - returning its best fitting parameter b, - where the intercept is zero and b the slope. - - - - - Least-Squares fitting the points (x,y) to a line through origin y : x -> b*x, - returning a function y' for the best fitting line. - - - - - Least-Squares fitting the points (x,y) to an exponential y : x -> a*exp(r*x), - returning its best fitting parameters as (a, r) tuple. - - - - - Least-Squares fitting the points (x,y) to an exponential y : x -> a*exp(r*x), - returning a function y' for the best fitting line. - - - - - Least-Squares fitting the points (x,y) to a logarithm y : x -> a + b*ln(x), - returning its best fitting parameters as (a, b) tuple. - - - - - Least-Squares fitting the points (x,y) to a logarithm y : x -> a + b*ln(x), - returning a function y' for the best fitting line. - - - - - Least-Squares fitting the points (x,y) to a power y : x -> a*x^b, - returning its best fitting parameters as (a, b) tuple. - - - - - Least-Squares fitting the points (x,y) to a power y : x -> a*x^b, - returning a function y' for the best fitting line. - - - - - Least-Squares fitting the points (x,y) to a k-order polynomial y : x -> p0 + p1*x + p2*x^2 + ... + pk*x^k, - returning its best fitting parameters as [p0, p1, p2, ..., pk] array, compatible with Polynomial.Evaluate. - A polynomial with order/degree k has (k+1) coefficients and thus requires at least (k+1) samples. - - - - - Least-Squares fitting the points (x,y) to a k-order polynomial y : x -> p0 + p1*x + p2*x^2 + ... + pk*x^k, - returning a function y' for the best fitting polynomial. - A polynomial with order/degree k has (k+1) coefficients and thus requires at least (k+1) samples. - - - - - Weighted Least-Squares fitting the points (x,y) and weights w to a k-order polynomial y : x -> p0 + p1*x + p2*x^2 + ... + pk*x^k, - returning its best fitting parameters as [p0, p1, p2, ..., pk] array, compatible with Polynomial.Evaluate. - A polynomial with order/degree k has (k+1) coefficients and thus requires at least (k+1) samples. - - - - - Least-Squares fitting the points (x,y) to an arbitrary linear combination y : x -> p0*f0(x) + p1*f1(x) + ... + pk*fk(x), - returning its best fitting parameters as [p0, p1, p2, ..., pk] array. - - - - - Least-Squares fitting the points (x,y) to an arbitrary linear combination y : x -> p0*f0(x) + p1*f1(x) + ... + pk*fk(x), - returning a function y' for the best fitting combination. - - - - - Least-Squares fitting the points (x,y) to an arbitrary linear combination y : x -> p0*f0(x) + p1*f1(x) + ... + pk*fk(x), - returning its best fitting parameters as [p0, p1, p2, ..., pk] array. - - - - - Least-Squares fitting the points (x,y) to an arbitrary linear combination y : x -> p0*f0(x) + p1*f1(x) + ... + pk*fk(x), - returning a function y' for the best fitting combination. - - - - - Least-Squares fitting the points (X,y) = ((x0,x1,..,xk),y) to a linear surface y : X -> p0*x0 + p1*x1 + ... + pk*xk, - returning its best fitting parameters as [p0, p1, p2, ..., pk] array. - If an intercept is added, its coefficient will be prepended to the resulting parameters. - - - - - Least-Squares fitting the points (X,y) = ((x0,x1,..,xk),y) to a linear surface y : X -> p0*x0 + p1*x1 + ... + pk*xk, - returning a function y' for the best fitting combination. - If an intercept is added, its coefficient will be prepended to the resulting parameters. - - - - - Weighted Least-Squares fitting the points (X,y) = ((x0,x1,..,xk),y) and weights w to a linear surface y : X -> p0*x0 + p1*x1 + ... + pk*xk, - returning its best fitting parameters as [p0, p1, p2, ..., pk] array. - - - - - Least-Squares fitting the points (X,y) = ((x0,x1,..,xk),y) to an arbitrary linear combination y : X -> p0*f0(x) + p1*f1(x) + ... + pk*fk(x), - returning its best fitting parameters as [p0, p1, p2, ..., pk] array. - - - - - Least-Squares fitting the points (X,y) = ((x0,x1,..,xk),y) to an arbitrary linear combination y : X -> p0*f0(x) + p1*f1(x) + ... + pk*fk(x), - returning a function y' for the best fitting combination. - - - - - Least-Squares fitting the points (X,y) = ((x0,x1,..,xk),y) to an arbitrary linear combination y : X -> p0*f0(x) + p1*f1(x) + ... + pk*fk(x), - returning its best fitting parameters as [p0, p1, p2, ..., pk] array. - - - - - Least-Squares fitting the points (X,y) = ((x0,x1,..,xk),y) to an arbitrary linear combination y : X -> p0*f0(x) + p1*f1(x) + ... + pk*fk(x), - returning a function y' for the best fitting combination. - - - - - Least-Squares fitting the points (T,y) = (T,y) to an arbitrary linear combination y : X -> p0*f0(T) + p1*f1(T) + ... + pk*fk(T), - returning its best fitting parameters as [p0, p1, p2, ..., pk] array. - - - - - Least-Squares fitting the points (T,y) = (T,y) to an arbitrary linear combination y : X -> p0*f0(T) + p1*f1(T) + ... + pk*fk(T), - returning a function y' for the best fitting combination. - - - - - Least-Squares fitting the points (T,y) = (T,y) to an arbitrary linear combination y : X -> p0*f0(T) + p1*f1(T) + ... + pk*fk(T), - returning its best fitting parameters as [p0, p1, p2, ..., pk] array. - - - - - Least-Squares fitting the points (T,y) = (T,y) to an arbitrary linear combination y : X -> p0*f0(T) + p1*f1(T) + ... + pk*fk(T), - returning a function y' for the best fitting combination. - - - - - Non-linear least-squares fitting the points (x,y) to an arbitrary function y : x -> f(p, x), - returning its best fitting parameter p. - - - - - Non-linear least-squares fitting the points (x,y) to an arbitrary function y : x -> f(p0, p1, x), - returning its best fitting parameter p0 and p1. - - - - - Non-linear least-squares fitting the points (x,y) to an arbitrary function y : x -> f(p0, p1, p2, x), - returning its best fitting parameter p0, p1 and p2. - - - - - Non-linear least-squares fitting the points (x,y) to an arbitrary function y : x -> f(p0, p1, p2, p3, x), - returning its best fitting parameter p0, p1, p2 and p3. - - - - - Non-linear least-squares fitting the points (x,y) to an arbitrary function y : x -> f(p0, p1, p2, p3, p4, x), - returning its best fitting parameter p0, p1, p2, p3 and p4. - - - - - Non-linear least-squares fitting the points (x,y) to an arbitrary function y : x -> f(p, x), - returning a function y' for the best fitting curve. - - - - - Non-linear least-squares fitting the points (x,y) to an arbitrary function y : x -> f(p0, p1, x), - returning a function y' for the best fitting curve. - - - - - Non-linear least-squares fitting the points (x,y) to an arbitrary function y : x -> f(p0, p1, p2, x), - returning a function y' for the best fitting curve. - - - - - Non-linear least-squares fitting the points (x,y) to an arbitrary function y : x -> f(p0, p1, p2, p3, x), - returning a function y' for the best fitting curve. - - - - - Non-linear least-squares fitting the points (x,y) to an arbitrary function y : x -> f(p0, p1, p2, p3, p4, x), - returning a function y' for the best fitting curve. - - - - - Generate samples by sampling a function at the provided points. - - - - - Generate a sample sequence by sampling a function at the provided point sequence. - - - - - Generate samples by sampling a function at the provided points. - - - - - Generate a sample sequence by sampling a function at the provided point sequence. - - - - - Generate a linearly spaced sample vector of the given length between the specified values (inclusive). - Equivalent to MATLAB linspace but with the length as first instead of last argument. - - - - - Generate samples by sampling a function at linearly spaced points between the specified values (inclusive). - - - - - Generate a base 10 logarithmically spaced sample vector of the given length between the specified decade exponents (inclusive). - Equivalent to MATLAB logspace but with the length as first instead of last argument. - - - - - Generate samples by sampling a function at base 10 logarithmically spaced points between the specified decade exponents (inclusive). - - - - - Generate a linearly spaced sample vector within the inclusive interval (start, stop) and step 1. - Equivalent to MATLAB colon operator (:). - - - - - Generate a linearly spaced sample vector within the inclusive interval (start, stop) and step 1. - Equivalent to MATLAB colon operator (:). - - - - - Generate a linearly spaced sample vector within the inclusive interval (start, stop) and the provided step. - The start value is aways included as first value, but stop is only included if it stop-start is a multiple of step. - Equivalent to MATLAB double colon operator (::). - - - - - Generate a linearly spaced sample vector within the inclusive interval (start, stop) and the provided step. - The start value is aways included as first value, but stop is only included if it stop-start is a multiple of step. - Equivalent to MATLAB double colon operator (::). - - - - - Generate a linearly spaced sample vector within the inclusive interval (start, stop) and the provide step. - The start value is aways included as first value, but stop is only included if it stop-start is a multiple of step. - Equivalent to MATLAB double colon operator (::). - - - - - Generate samples by sampling a function at linearly spaced points within the inclusive interval (start, stop) and the provide step. - The start value is aways included as first value, but stop is only included if it stop-start is a multiple of step. - - - - - Create a periodic wave. - - The number of samples to generate. - Samples per time unit (Hz). Must be larger than twice the frequency to satisfy the Nyquist criterion. - Frequency in periods per time unit (Hz). - The length of the period when sampled at one sample per time unit. This is the interval of the periodic domain, a typical value is 1.0, or 2*Pi for angular functions. - Optional phase offset. - Optional delay, relative to the phase. - - - - Create a periodic wave. - - The number of samples to generate. - The function to apply to each of the values and evaluate the resulting sample. - Samples per time unit (Hz). Must be larger than twice the frequency to satisfy the Nyquist criterion. - Frequency in periods per time unit (Hz). - The length of the period when sampled at one sample per time unit. This is the interval of the periodic domain, a typical value is 1.0, or 2*Pi for angular functions. - Optional phase offset. - Optional delay, relative to the phase. - - - - Create an infinite periodic wave sequence. - - Samples per time unit (Hz). Must be larger than twice the frequency to satisfy the Nyquist criterion. - Frequency in periods per time unit (Hz). - The length of the period when sampled at one sample per time unit. This is the interval of the periodic domain, a typical value is 1.0, or 2*Pi for angular functions. - Optional phase offset. - Optional delay, relative to the phase. - - - - Create an infinite periodic wave sequence. - - The function to apply to each of the values and evaluate the resulting sample. - Samples per time unit (Hz). Must be larger than twice the frequency to satisfy the Nyquist criterion. - Frequency in periods per time unit (Hz). - The length of the period when sampled at one sample per time unit. This is the interval of the periodic domain, a typical value is 1.0, or 2*Pi for angular functions. - Optional phase offset. - Optional delay, relative to the phase. - - - - Create a Sine wave. - - The number of samples to generate. - Samples per time unit (Hz). Must be larger than twice the frequency to satisfy the Nyquist criterion. - Frequency in periods per time unit (Hz). - The maximal reached peak. - The mean, or DC part, of the signal. - Optional phase offset. - Optional delay, relative to the phase. - - - - Create an infinite Sine wave sequence. - - Samples per unit. - Frequency in samples per unit. - The maximal reached peak. - The mean, or DC part, of the signal. - Optional phase offset. - Optional delay, relative to the phase. - - - - Create a periodic square wave, starting with the high phase. - - The number of samples to generate. - Number of samples of the high phase. - Number of samples of the low phase. - Sample value to be emitted during the low phase. - Sample value to be emitted during the high phase. - Optional delay. - - - - Create an infinite periodic square wave sequence, starting with the high phase. - - Number of samples of the high phase. - Number of samples of the low phase. - Sample value to be emitted during the low phase. - Sample value to be emitted during the high phase. - Optional delay. - - - - Create a periodic triangle wave, starting with the raise phase from the lowest sample. - - The number of samples to generate. - Number of samples of the raise phase. - Number of samples of the fall phase. - Lowest sample value. - Highest sample value. - Optional delay. - - - - Create an infinite periodic triangle wave sequence, starting with the raise phase from the lowest sample. - - Number of samples of the raise phase. - Number of samples of the fall phase. - Lowest sample value. - Highest sample value. - Optional delay. - - - - Create a periodic sawtooth wave, starting with the lowest sample. - - The number of samples to generate. - Number of samples a full sawtooth period. - Lowest sample value. - Highest sample value. - Optional delay. - - - - Create an infinite periodic sawtooth wave sequence, starting with the lowest sample. - - Number of samples a full sawtooth period. - Lowest sample value. - Highest sample value. - Optional delay. - - - - Create an array with each field set to the same value. - - The number of samples to generate. - The value that each field should be set to. - - - - Create an infinite sequence where each element has the same value. - - The value that each element should be set to. - - - - Create a Heaviside Step sample vector. - - The number of samples to generate. - The maximal reached peak. - Offset to the time axis. - - - - Create an infinite Heaviside Step sample sequence. - - The maximal reached peak. - Offset to the time axis. - - - - Create a Kronecker Delta impulse sample vector. - - The number of samples to generate. - The maximal reached peak. - Offset to the time axis. Zero or positive. - - - - Create a Kronecker Delta impulse sample vector. - - The maximal reached peak. - Offset to the time axis, hence the sample index of the impulse. - - - - Create a periodic Kronecker Delta impulse sample vector. - - The number of samples to generate. - impulse sequence period. - The maximal reached peak. - Offset to the time axis. Zero or positive. - - - - Create a Kronecker Delta impulse sample vector. - - impulse sequence period. - The maximal reached peak. - Offset to the time axis. Zero or positive. - - - - Generate samples generated by the given computation. - - - - - Generate samples generated by the given computation. - - - - - Generate an infinite sequence generated by the given computation. - - - - - Generate an infinite sequence generated by the given computation. - - - - - Generate a Fibonacci sequence, including zero as first value. - - - - - Generate an infinite Fibonacci sequence, including zero as first value. - - - - - Create random samples, uniform between 0 and 1. - Faster than other methods but with reduced guarantees on randomness. - - - - - Create an infinite random sample sequence, uniform between 0 and 1. - Faster than other methods but with reduced guarantees on randomness. - - - - - Generate samples by sampling a function at samples from a probability distribution, uniform between 0 and 1. - Faster than other methods but with reduced guarantees on randomness. - - - - - Generate a sample sequence by sampling a function at samples from a probability distribution, uniform between 0 and 1. - Faster than other methods but with reduced guarantees on randomness. - - - - - Generate samples by sampling a function at sample pairs from a probability distribution, uniform between 0 and 1. - Faster than other methods but with reduced guarantees on randomness. - - - - - Generate a sample sequence by sampling a function at sample pairs from a probability distribution, uniform between 0 and 1. - Faster than other methods but with reduced guarantees on randomness. - - - - - Create samples with independent amplitudes of standard distribution. - - - - - Create an infinite sample sequence with independent amplitudes of standard distribution. - - - - - Create samples with independent amplitudes of normal distribution and a flat spectral density. - - - - - Create an infinite sample sequence with independent amplitudes of normal distribution and a flat spectral density. - - - - - Create random samples. - - - - - Create an infinite random sample sequence. - - - - - Create random samples. - - - - - Create an infinite random sample sequence. - - - - - Create random samples. - - - - - Create an infinite random sample sequence. - - - - - Create random samples. - - - - - Create an infinite random sample sequence. - - - - - Generate samples by sampling a function at samples from a probability distribution. - - - - - Generate a sample sequence by sampling a function at samples from a probability distribution. - - - - - Generate samples by sampling a function at sample pairs from a probability distribution. - - - - - Generate a sample sequence by sampling a function at sample pairs from a probability distribution. - - - - - Globalized String Handling Helpers - - - - - Tries to get a from the format provider, - returning the current culture if it fails. - - - An that supplies culture-specific - formatting information. - - A instance. - - - - Tries to get a from the format - provider, returning the current culture if it fails. - - - An that supplies culture-specific - formatting information. - - A instance. - - - - Tries to get a from the format provider, returning the current culture if it fails. - - - An that supplies culture-specific - formatting information. - - A instance. - - - - Globalized Parsing: Tokenize a node by splitting it into several nodes. - - Node that contains the trimmed string to be tokenized. - List of keywords to tokenize by. - keywords to skip looking for (because they've already been handled). - - - - Globalized Parsing: Parse a double number - - First token of the number. - Culture Info. - The parsed double number using the given culture information. - - - - - Globalized Parsing: Parse a float number - - First token of the number. - Culture Info. - The parsed float number using the given culture information. - - - - - Calculates r^2, the square of the sample correlation coefficient between - the observed outcomes and the observed predictor values. - Not to be confused with R^2, the coefficient of determination, see . - - The modelled/predicted values - The observed/actual values - Squared Person product-momentum correlation coefficient. - - - - Calculates r, the sample correlation coefficient between the observed outcomes - and the observed predictor values. - - The modelled/predicted values - The observed/actual values - Person product-momentum correlation coefficient. - - - - Calculates the Standard Error of the regression, given a sequence of - modeled/predicted values, and a sequence of actual/observed values - - The modelled/predicted values - The observed/actual values - The Standard Error of the regression - - - - Calculates the Standard Error of the regression, given a sequence of - modeled/predicted values, and a sequence of actual/observed values - - The modelled/predicted values - The observed/actual values - The degrees of freedom by which the - number of samples is reduced for performing the Standard Error calculation - The Standard Error of the regression - - - - Calculates the R-Squared value, also known as coefficient of determination, - given some modelled and observed values. - - The values expected from the model. - The actual values obtained. - Coefficient of determination. - - - - Complex Fast (FFT) Implementation of the Discrete Fourier Transform (DFT). - - - - - Applies the forward Fast Fourier Transform (FFT) to arbitrary-length sample vectors. - - Sample vector, where the FFT is evaluated in place. - - - - Applies the forward Fast Fourier Transform (FFT) to arbitrary-length sample vectors. - - Sample vector, where the FFT is evaluated in place. - - - - Applies the forward Fast Fourier Transform (FFT) to arbitrary-length sample vectors. - - Sample vector, where the FFT is evaluated in place. - Fourier Transform Convention Options. - - - - Applies the forward Fast Fourier Transform (FFT) to arbitrary-length sample vectors. - - Sample vector, where the FFT is evaluated in place. - Fourier Transform Convention Options. - - - - Applies the forward Fast Fourier Transform (FFT) to arbitrary-length sample vectors. - - Real part of the sample vector, where the FFT is evaluated in place. - Imaginary part of the sample vector, where the FFT is evaluated in place. - Fourier Transform Convention Options. - - - - Applies the forward Fast Fourier Transform (FFT) to arbitrary-length sample vectors. - - Real part of the sample vector, where the FFT is evaluated in place. - Imaginary part of the sample vector, where the FFT is evaluated in place. - Fourier Transform Convention Options. - - - - Packed Real-Complex forward Fast Fourier Transform (FFT) to arbitrary-length sample vectors. - Since for real-valued time samples the complex spectrum is conjugate-even (symmetry), - the spectrum can be fully reconstructed from the positive frequencies only (first half). - The data array needs to be N+2 (if N is even) or N+1 (if N is odd) long in order to support such a packed spectrum. - - Data array of length N+2 (if N is even) or N+1 (if N is odd). - The number of samples. - Fourier Transform Convention Options. - - - - Packed Real-Complex forward Fast Fourier Transform (FFT) to arbitrary-length sample vectors. - Since for real-valued time samples the complex spectrum is conjugate-even (symmetry), - the spectrum can be fully reconstructed form the positive frequencies only (first half). - The data array needs to be N+2 (if N is even) or N+1 (if N is odd) long in order to support such a packed spectrum. - - Data array of length N+2 (if N is even) or N+1 (if N is odd). - The number of samples. - Fourier Transform Convention Options. - - - - Applies the forward Fast Fourier Transform (FFT) to multiple dimensional sample data. - - Sample data, where the FFT is evaluated in place. - - The data size per dimension. The first dimension is the major one. - For example, with two dimensions "rows" and "columns" the samples are assumed to be organized row by row. - - Fourier Transform Convention Options. - - - - Applies the forward Fast Fourier Transform (FFT) to multiple dimensional sample data. - - Sample data, where the FFT is evaluated in place. - - The data size per dimension. The first dimension is the major one. - For example, with two dimensions "rows" and "columns" the samples are assumed to be organized row by row. - - Fourier Transform Convention Options. - - - - Applies the forward Fast Fourier Transform (FFT) to two dimensional sample data. - - Sample data, organized row by row, where the FFT is evaluated in place - The number of rows. - The number of columns. - Data available organized column by column instead of row by row can be processed directly by swapping the rows and columns arguments. - Fourier Transform Convention Options. - - - - Applies the forward Fast Fourier Transform (FFT) to two dimensional sample data. - - Sample data, organized row by row, where the FFT is evaluated in place - The number of rows. - The number of columns. - Data available organized column by column instead of row by row can be processed directly by swapping the rows and columns arguments. - Fourier Transform Convention Options. - - - - Applies the forward Fast Fourier Transform (FFT) to a two dimensional data in form of a matrix. - - Sample matrix, where the FFT is evaluated in place - Fourier Transform Convention Options. - - - - Applies the forward Fast Fourier Transform (FFT) to a two dimensional data in form of a matrix. - - Sample matrix, where the FFT is evaluated in place - Fourier Transform Convention Options. - - - - Applies the inverse Fast Fourier Transform (iFFT) to arbitrary-length sample vectors. - - Spectrum data, where the iFFT is evaluated in place. - - - - Applies the inverse Fast Fourier Transform (iFFT) to arbitrary-length sample vectors. - - Spectrum data, where the iFFT is evaluated in place. - - - - Applies the inverse Fast Fourier Transform (iFFT) to arbitrary-length sample vectors. - - Spectrum data, where the iFFT is evaluated in place. - Fourier Transform Convention Options. - - - - Applies the inverse Fast Fourier Transform (iFFT) to arbitrary-length sample vectors. - - Spectrum data, where the iFFT is evaluated in place. - Fourier Transform Convention Options. - - - - Applies the inverse Fast Fourier Transform (iFFT) to arbitrary-length sample vectors. - - Real part of the sample vector, where the iFFT is evaluated in place. - Imaginary part of the sample vector, where the iFFT is evaluated in place. - Fourier Transform Convention Options. - - - - Applies the inverse Fast Fourier Transform (iFFT) to arbitrary-length sample vectors. - - Real part of the sample vector, where the iFFT is evaluated in place. - Imaginary part of the sample vector, where the iFFT is evaluated in place. - Fourier Transform Convention Options. - - - - Packed Real-Complex inverse Fast Fourier Transform (iFFT) to arbitrary-length sample vectors. - Since for real-valued time samples the complex spectrum is conjugate-even (symmetry), - the spectrum can be fully reconstructed form the positive frequencies only (first half). - The data array needs to be N+2 (if N is even) or N+1 (if N is odd) long in order to support such a packed spectrum. - - Data array of length N+2 (if N is even) or N+1 (if N is odd). - The number of samples. - Fourier Transform Convention Options. - - - - Packed Real-Complex inverse Fast Fourier Transform (iFFT) to arbitrary-length sample vectors. - Since for real-valued time samples the complex spectrum is conjugate-even (symmetry), - the spectrum can be fully reconstructed form the positive frequencies only (first half). - The data array needs to be N+2 (if N is even) or N+1 (if N is odd) long in order to support such a packed spectrum. - - Data array of length N+2 (if N is even) or N+1 (if N is odd). - The number of samples. - Fourier Transform Convention Options. - - - - Applies the inverse Fast Fourier Transform (iFFT) to multiple dimensional sample data. - - Spectrum data, where the iFFT is evaluated in place. - - The data size per dimension. The first dimension is the major one. - For example, with two dimensions "rows" and "columns" the samples are assumed to be organized row by row. - - Fourier Transform Convention Options. - - - - Applies the inverse Fast Fourier Transform (iFFT) to multiple dimensional sample data. - - Spectrum data, where the iFFT is evaluated in place. - - The data size per dimension. The first dimension is the major one. - For example, with two dimensions "rows" and "columns" the samples are assumed to be organized row by row. - - Fourier Transform Convention Options. - - - - Applies the inverse Fast Fourier Transform (iFFT) to two dimensional sample data. - - Sample data, organized row by row, where the iFFT is evaluated in place - The number of rows. - The number of columns. - Data available organized column by column instead of row by row can be processed directly by swapping the rows and columns arguments. - Fourier Transform Convention Options. - - - - Applies the inverse Fast Fourier Transform (iFFT) to two dimensional sample data. - - Sample data, organized row by row, where the iFFT is evaluated in place - The number of rows. - The number of columns. - Data available organized column by column instead of row by row can be processed directly by swapping the rows and columns arguments. - Fourier Transform Convention Options. - - - - Applies the inverse Fast Fourier Transform (iFFT) to a two dimensional data in form of a matrix. - - Sample matrix, where the iFFT is evaluated in place - Fourier Transform Convention Options. - - - - Applies the inverse Fast Fourier Transform (iFFT) to a two dimensional data in form of a matrix. - - Sample matrix, where the iFFT is evaluated in place - Fourier Transform Convention Options. - - - - Generate the frequencies corresponding to each index in frequency space. - The frequency space has a resolution of sampleRate/N. - Index 0 corresponds to the DC part, the following indices correspond to - the positive frequencies up to the Nyquist frequency (sampleRate/2), - followed by the negative frequencies wrapped around. - - Number of samples. - The sampling rate of the time-space data. - - - - Fourier Transform Convention - - - - - Inverse integrand exponent (forward: positive sign; inverse: negative sign). - - - - - Only scale by 1/N in the inverse direction; No scaling in forward direction. - - - - - Don't scale at all (neither on forward nor on inverse transformation). - - - - - Universal; Symmetric scaling and common exponent (used in Maple). - - - - - Only scale by 1/N in the inverse direction; No scaling in forward direction (used in Matlab). [= AsymmetricScaling] - - - - - Inverse integrand exponent; No scaling at all (used in all Numerical Recipes based implementations). [= InverseExponent | NoScaling] - - - - - Fast (FHT) Implementation of the Discrete Hartley Transform (DHT). - - - Fast (FHT) Implementation of the Discrete Hartley Transform (DHT). - - - - - Naive forward DHT, useful e.g. to verify faster algorithms. - - Time-space sample vector. - Hartley Transform Convention Options. - Corresponding frequency-space vector. - - - - Naive inverse DHT, useful e.g. to verify faster algorithms. - - Frequency-space sample vector. - Hartley Transform Convention Options. - Corresponding time-space vector. - - - - Rescale FFT-the resulting vector according to the provided convention options. - - Fourier Transform Convention Options. - Sample Vector. - - - - Rescale the iFFT-resulting vector according to the provided convention options. - - Fourier Transform Convention Options. - Sample Vector. - - - - Naive generic DHT, useful e.g. to verify faster algorithms. - - Time-space sample vector. - Corresponding frequency-space vector. - - - - Hartley Transform Convention - - - - - Only scale by 1/N in the inverse direction; No scaling in forward direction. - - - - - Don't scale at all (neither on forward nor on inverse transformation). - - - - - Universal; Symmetric scaling. - - - - - Numerical Integration (Quadrature). - - - - - Approximation of the definite integral of an analytic smooth function on a closed interval. - - The analytic smooth function to integrate. - Where the interval starts, inclusive and finite. - Where the interval stops, inclusive and finite. - The expected relative accuracy of the approximation. - Approximation of the finite integral in the given interval. - - - - Approximation of the definite integral of an analytic smooth function on a closed interval. - - The analytic smooth function to integrate. - Where the interval starts, inclusive and finite. - Where the interval stops, inclusive and finite. - Approximation of the finite integral in the given interval. - - - - Approximates a 2-dimensional definite integral using an Nth order Gauss-Legendre rule over the rectangle [a,b] x [c,d]. - - The 2-dimensional analytic smooth function to integrate. - Where the interval starts for the first (inside) integral, exclusive and finite. - Where the interval ends for the first (inside) integral, exclusive and finite. - Where the interval starts for the second (outside) integral, exclusive and finite. - /// Where the interval ends for the second (outside) integral, exclusive and finite. - Defines an Nth order Gauss-Legendre rule. The order also defines the number of abscissas and weights for the rule. Precomputed Gauss-Legendre abscissas/weights for orders 2-20, 32, 64, 96, 100, 128, 256, 512, 1024 are used, otherwise they're calculated on the fly. - Approximation of the finite integral in the given interval. - - - - Approximates a 2-dimensional definite integral using an Nth order Gauss-Legendre rule over the rectangle [a,b] x [c,d]. - - The 2-dimensional analytic smooth function to integrate. - Where the interval starts for the first (inside) integral, exclusive and finite. - Where the interval ends for the first (inside) integral, exclusive and finite. - Where the interval starts for the second (outside) integral, exclusive and finite. - /// Where the interval ends for the second (outside) integral, exclusive and finite. - Approximation of the finite integral in the given interval. - - - - Approximation of the definite integral of an analytic smooth function by double-exponential quadrature. When either or both limits are infinite, the integrand is assumed rapidly decayed to zero as x -> infinity. - - The analytic smooth function to integrate. - Where the interval starts. - Where the interval stops. - The expected relative accuracy of the approximation. - Approximation of the finite integral in the given interval. - - - - Approximation of the definite integral of an analytic smooth function by Gauss-Legendre quadrature. When either or both limits are infinite, the integrand is assumed rapidly decayed to zero as x -> infinity. - - The analytic smooth function to integrate. - Where the interval starts. - Where the interval stops. - Defines an Nth order Gauss-Legendre rule. The order also defines the number of abscissas and weights for the rule. Precomputed Gauss-Legendre abscissas/weights for orders 2-20, 32, 64, 96, 100, 128, 256, 512, 1024 are used, otherwise they're calculated on the fly. - Approximation of the finite integral in the given interval. - - - - Approximation of the definite integral of an analytic smooth function by Gauss-Kronrod quadrature. When either or both limits are infinite, the integrand is assumed rapidly decayed to zero as x -> infinity. - - The analytic smooth function to integrate. - Where the interval starts. - Where the interval stops. - The expected relative accuracy of the approximation. - The maximum number of interval splittings permitted before stopping. - The number of Gauss-Kronrod points. Pre-computed for 15, 21, 31, 41, 51 and 61 points. - Approximation of the finite integral in the given interval. - - - - Approximation of the definite integral of an analytic smooth function by Gauss-Kronrod quadrature. When either or both limits are infinite, the integrand is assumed rapidly decayed to zero as x -> infinity. - - The analytic smooth function to integrate. - Where the interval starts. - Where the interval stops. - The difference between the (N-1)/2 point Gauss approximation and the N-point Gauss-Kronrod approximation - The L1 norm of the result, if there is a significant difference between this and the returned value, then the result is likely to be ill-conditioned. - The expected relative accuracy of the approximation. - The maximum number of interval splittings permitted before stopping - The number of Gauss-Kronrod points. Pre-computed for 15, 21, 31, 41, 51 and 61 points - Approximation of the finite integral in the given interval. - - - - Numerical Contour Integration of a complex-valued function over a real variable,. - - - - - Approximation of the definite integral of an analytic smooth complex function by double-exponential quadrature. When either or both limits are infinite, the integrand is assumed rapidly decayed to zero as x -> infinity. - - The analytic smooth complex function to integrate, defined on the real domain. - Where the interval starts. - Where the interval stops. - The expected relative accuracy of the approximation. - Approximation of the finite integral in the given interval. - - - - Approximation of the definite integral of an analytic smooth complex function by double-exponential quadrature. When either or both limits are infinite, the integrand is assumed rapidly decayed to zero as x -> infinity. - - The analytic smooth complex function to integrate, defined on the real domain. - Where the interval starts. - Where the interval stops. - Defines an Nth order Gauss-Legendre rule. The order also defines the number of abscissas and weights for the rule. Precomputed Gauss-Legendre abscissas/weights for orders 2-20, 32, 64, 96, 100, 128, 256, 512, 1024 are used, otherwise they're calculated on the fly. - Approximation of the finite integral in the given interval. - - - - Approximation of the definite integral of an analytic smooth function by Gauss-Kronrod quadrature. When either or both limits are infinite, the integrand is assumed rapidly decayed to zero as x -> infinity. - - The analytic smooth complex function to integrate, defined on the real domain. - Where the interval starts. - Where the interval stops. - The expected relative accuracy of the approximation. - The maximum number of interval splittings permitted before stopping - The number of Gauss-Kronrod points. Pre-computed for 15, 21, 31, 41, 51 and 61 points - Approximation of the finite integral in the given interval. - - - - Approximation of the definite integral of an analytic smooth function by Gauss-Kronrod quadrature. When either or both limits are infinite, the integrand is assumed rapidly decayed to zero as x -> infinity. - - The analytic smooth complex function to integrate, defined on the real domain. - Where the interval starts. - Where the interval stops. - The difference between the (N-1)/2 point Gauss approximation and the N-point Gauss-Kronrod approximation - The L1 norm of the result, if there is a significant difference between this and the returned value, then the result is likely to be ill-conditioned. - The expected relative accuracy of the approximation. - The maximum number of interval splittings permitted before stopping - The number of Gauss-Kronrod points. Pre-computed for 15, 21, 31, 41, 51 and 61 points - Approximation of the finite integral in the given interval. - - - - Analytic integration algorithm for smooth functions with no discontinuities - or derivative discontinuities and no poles inside the interval. - - - - - Maximum number of iterations, until the asked - maximum error is (likely to be) satisfied. - - - - - Approximate the integral by the double exponential transformation - - The analytic smooth function to integrate. - Where the interval starts, inclusive and finite. - Where the interval stops, inclusive and finite. - The expected relative accuracy of the approximation. - Approximation of the finite integral in the given interval. - - - - Approximate the integral by the double exponential transformation - - The analytic smooth complex function to integrate, defined on the real domain. - Where the interval starts, inclusive and finite. - Where the interval stops, inclusive and finite. - The expected relative accuracy of the approximation. - Approximation of the finite integral in the given interval. - - - - Compute the abscissa vector for a single level. - - The level to evaluate the abscissa vector for. - Abscissa Vector. - - - - Compute the weight vector for a single level. - - The level to evaluate the weight vector for. - Weight Vector. - - - - Precomputed abscissa vector per level. - - - - - Precomputed weight vector per level. - - - - - Getter for the order. - - - - - Getter that returns a clone of the array containing the Kronrod abscissas. - - - - - Getter that returns a clone of the array containing the Kronrod weights. - - - - - Getter that returns a clone of the array containing the Gauss weights. - - - - - Performs adaptive Gauss-Kronrod quadrature on function f over the range (a,b) - - The analytic smooth function to integrate - Where the interval starts - Where the interval stops - The difference between the (N-1)/2 point Gauss approximation and the N-point Gauss-Kronrod approximation - The L1 norm of the result, if there is a significant difference between this and the returned value, then the result is likely to be ill-conditioned. - The maximum relative error in the result - The maximum number of interval splittings permitted before stopping - The number of Gauss-Kronrod points. Pre-computed for 15, 21, 31, 41, 51 and 61 points - - - - Performs adaptive Gauss-Kronrod quadrature on function f over the range (a,b) - - The analytic smooth complex function to integrate, defined on the real axis. - Where the interval starts - Where the interval stops - The difference between the (N-1)/2 point Gauss approximation and the N-point Gauss-Kronrod approximation - The L1 norm of the result, if there is a significant difference between this and the returned value, then the result is likely to be ill-conditioned. - The maximum relative error in the result - The maximum number of interval splittings permitted before stopping - The number of Gauss-Kronrod points. Pre-computed for 15, 21, 31, 41, 51 and 61 points - - - - - Approximates a definite integral using an Nth order Gauss-Legendre rule. Precomputed Gauss-Legendre abscissas/weights for orders 2-20, 32, 64, 96, 100, 128, 256, 512, 1024 are used, otherwise they're calculated on the fly. - - - - - Initializes a new instance of the class. - - Where the interval starts, inclusive and finite. - Where the interval stops, inclusive and finite. - Defines an Nth order Gauss-Legendre rule. The order also defines the number of abscissas and weights for the rule. Precomputed Gauss-Legendre abscissas/weights for orders 2-20, 32, 64, 96, 100, 128, 256, 512, 1024 are used, otherwise they're calculated on the fly. - - - - Gettter for the ith abscissa. - - Index of the ith abscissa. - The ith abscissa. - - - - Getter that returns a clone of the array containing the abscissas. - - - - - Getter for the ith weight. - - Index of the ith weight. - The ith weight. - - - - Getter that returns a clone of the array containing the weights. - - - - - Getter for the order. - - - - - Getter for the InvervalBegin. - - - - - Getter for the InvervalEnd. - - - - - Approximates a definite integral using an Nth order Gauss-Legendre rule. - - The analytic smooth function to integrate. - Where the interval starts, exclusive and finite. - Where the interval ends, exclusive and finite. - Defines an Nth order Gauss-Legendre rule. The order also defines the number of abscissas and weights for the rule. Precomputed Gauss-Legendre abscissas/weights for orders 2-20, 32, 64, 96, 100, 128, 256, 512, 1024 are used, otherwise they're calculated on the fly. - Approximation of the finite integral in the given interval. - - - - Approximates a definite integral using an Nth order Gauss-Legendre rule. - - The analytic smooth complex function to integrate, defined on the real domain. - Where the interval starts, exclusive and finite. - Where the interval ends, exclusive and finite. - Defines an Nth order Gauss-Legendre rule. The order also defines the number of abscissas and weights for the rule. Precomputed Gauss-Legendre abscissas/weights for orders 2-20, 32, 64, 96, 100, 128, 256, 512, 1024 are used, otherwise they're calculated on the fly. - Approximation of the finite integral in the given interval. - - - - Approximates a 2-dimensional definite integral using an Nth order Gauss-Legendre rule over the rectangle [a,b] x [c,d]. - - The 2-dimensional analytic smooth function to integrate. - Where the interval starts for the first (inside) integral, exclusive and finite. - Where the interval ends for the first (inside) integral, exclusive and finite. - Where the interval starts for the second (outside) integral, exclusive and finite. - /// Where the interval ends for the second (outside) integral, exclusive and finite. - Defines an Nth order Gauss-Legendre rule. The order also defines the number of abscissas and weights for the rule. Precomputed Gauss-Legendre abscissas/weights for orders 2-20, 32, 64, 96, 100, 128, 256, 512, 1024 are used, otherwise they're calculated on the fly. - Approximation of the finite integral in the given interval. - - - - Contains a method to compute the Gauss-Kronrod abscissas/weights and precomputed abscissas/weights for orders 15, 21, 31, 41, 51, 61. - - - Contains a method to compute the Gauss-Kronrod abscissas/weights. - - - - - Precomputed abscissas/weights for orders 15, 21, 31, 41, 51, 61. - - - - - Computes the Gauss-Kronrod abscissas/weights and Gauss weights. - - Defines an Nth order Gauss-Kronrod rule. The order also defines the number of abscissas and weights for the rule. - Required precision to compute the abscissas/weights. - Object containing the non-negative abscissas/weights, order. - - - - Returns coefficients of a Stieltjes polynomial in terms of Legendre polynomials. - - - - - Return value and derivative of a Legendre series at given points. - - - - - Return value and derivative of a Legendre polynomial of order at given points. - - - - - Creates a Gauss-Kronrod point. - - - - - Getter for the GaussKronrodPoint. - - Defines an Nth order Gauss-Kronrod rule. Precomputed Gauss-Kronrod abscissas/weights for orders 15, 21, 31, 41, 51, 61 are used, otherwise they're calculated on the fly. - Object containing the non-negative abscissas/weights, and order. - - - - Contains a method to compute the Gauss-Legendre abscissas/weights and precomputed abscissas/weights for orders 2-20, 32, 64, 96, 100, 128, 256, 512, 1024. - - - Contains a method to compute the Gauss-Legendre abscissas/weights and precomputed abscissas/weights for orders 2-20, 32, 64, 96, 100, 128, 256, 512, 1024. - - - - - Precomputed abscissas/weights for orders 2-20, 32, 64, 96, 100, 128, 256, 512, 1024. - - - - - Computes the Gauss-Legendre abscissas/weights. - See Pavel Holoborodko for a description of the algorithm. - - Defines an Nth order Gauss-Legendre rule. The order also defines the number of abscissas and weights for the rule. - Required precision to compute the abscissas/weights. 1e-10 is usually fine. - Object containing the non-negative abscissas/weights, order, and intervalBegin/intervalEnd. The non-negative abscissas/weights are generated over the interval [-1,1] for the given order. - - - - Creates and maps a Gauss-Legendre point. - - - - - Getter for the GaussPoint. - - Defines an Nth order Gauss-Legendre rule. Precomputed Gauss-Legendre abscissas/weights for orders 2-20, 32, 64, 96, 100, 128, 256, 512, 1024 are used, otherwise they're calculated on the fly. - Object containing the non-negative abscissas/weights, order, and intervalBegin/intervalEnd. The non-negative abscissas/weights are generated over the interval [-1,1] for the given order. - - - - Getter for the GaussPoint. - - Where the interval starts, inclusive and finite. - Where the interval stops, inclusive and finite. - Defines an Nth order Gauss-Legendre rule. Precomputed Gauss-Legendre abscissas/weights for orders 2-20, 32, 64, 96, 100, 128, 256, 512, 1024 are used, otherwise they're calculated on the fly. - Object containing the abscissas/weights, order, and intervalBegin/intervalEnd. - - - - Maps the non-negative abscissas/weights from the interval [-1, 1] to the interval [intervalBegin, intervalEnd]. - - Where the interval starts, inclusive and finite. - Where the interval stops, inclusive and finite. - Object containing the non-negative abscissas/weights, order, and intervalBegin/intervalEnd. The non-negative abscissas/weights are generated over the interval [-1,1] for the given order. - Object containing the abscissas/weights, order, and intervalBegin/intervalEnd. - - - - Contains the abscissas/weights, order, and intervalBegin/intervalEnd. - - - - - Contains two GaussPoint. - - - - - Approximation algorithm for definite integrals by the Trapezium rule of the Newton-Cotes family. - - - Wikipedia - Trapezium Rule - - - - - Direct 2-point approximation of the definite integral in the provided interval by the trapezium rule. - - The analytic smooth function to integrate. - Where the interval starts, inclusive and finite. - Where the interval stops, inclusive and finite. - Approximation of the finite integral in the given interval. - - - - Direct 2-point approximation of the definite integral in the provided interval by the trapezium rule. - - The analytic smooth complex function to integrate, defined on real domain. - Where the interval starts, inclusive and finite. - Where the interval stops, inclusive and finite. - Approximation of the finite integral in the given interval. - - - - Composite N-point approximation of the definite integral in the provided interval by the trapezium rule. - - The analytic smooth function to integrate. - Where the interval starts, inclusive and finite. - Where the interval stops, inclusive and finite. - Number of composite subdivision partitions. - Approximation of the finite integral in the given interval. - - - - Composite N-point approximation of the definite integral in the provided interval by the trapezium rule. - - The analytic smooth complex function to integrate, defined on real domain. - Where the interval starts, inclusive and finite. - Where the interval stops, inclusive and finite. - Number of composite subdivision partitions. - Approximation of the finite integral in the given interval. - - - - Adaptive approximation of the definite integral in the provided interval by the trapezium rule. - - The analytic smooth function to integrate. - Where the interval starts, inclusive and finite. - Where the interval stops, inclusive and finite. - The expected accuracy of the approximation. - Approximation of the finite integral in the given interval. - - - - Adaptive approximation of the definite integral in the provided interval by the trapezium rule. - - The analytic smooth complex function to integrate, define don real domain. - Where the interval starts, inclusive and finite. - Where the interval stops, inclusive and finite. - The expected accuracy of the approximation. - Approximation of the finite integral in the given interval. - - - - Adaptive approximation of the definite integral by the trapezium rule. - - The analytic smooth function to integrate. - Where the interval starts, inclusive and finite. - Where the interval stops, inclusive and finite. - Abscissa vector per level provider. - Weight vector per level provider. - First Level Step - The expected relative accuracy of the approximation. - Approximation of the finite integral in the given interval. - - - - Adaptive approximation of the definite integral by the trapezium rule. - - The analytic smooth complex function to integrate, defined on the real domain. - Where the interval starts, inclusive and finite. - Where the interval stops, inclusive and finite. - Abscissa vector per level provider. - Weight vector per level provider. - First Level Step - The expected relative accuracy of the approximation. - Approximation of the finite integral in the given interval. - - - - Approximation algorithm for definite integrals by Simpson's rule. - - - - - Direct 3-point approximation of the definite integral in the provided interval by Simpson's rule. - - The analytic smooth function to integrate. - Where the interval starts, inclusive and finite. - Where the interval stops, inclusive and finite. - Approximation of the finite integral in the given interval. - - - - Composite N-point approximation of the definite integral in the provided interval by Simpson's rule. - - The analytic smooth function to integrate. - Where the interval starts, inclusive and finite. - Where the interval stops, inclusive and finite. - Even number of composite subdivision partitions. - Approximation of the finite integral in the given interval. - - - - Interpolation Factory. - - - - - Creates an interpolation based on arbitrary points. - - The sample points t. - The sample point values x(t). - - An interpolation scheme optimized for the given sample points and values, - which can then be used to compute interpolations and extrapolations - on arbitrary points. - - - if your data is already sorted in arrays, consider to use - MathNet.Numerics.Interpolation.Barycentric.InterpolateRationalFloaterHormannSorted - instead, which is more efficient. - - - - - Create a Floater-Hormann rational pole-free interpolation based on arbitrary points. - - The sample points t. - The sample point values x(t). - - An interpolation scheme optimized for the given sample points and values, - which can then be used to compute interpolations and extrapolations - on arbitrary points. - - - if your data is already sorted in arrays, consider to use - MathNet.Numerics.Interpolation.Barycentric.InterpolateRationalFloaterHormannSorted - instead, which is more efficient. - - - - - Create a Bulirsch Stoer rational interpolation based on arbitrary points. - - The sample points t. - The sample point values x(t). - - An interpolation scheme optimized for the given sample points and values, - which can then be used to compute interpolations and extrapolations - on arbitrary points. - - - if your data is already sorted in arrays, consider to use - MathNet.Numerics.Interpolation.BulirschStoerRationalInterpolation.InterpolateSorted - instead, which is more efficient. - - - - - Create a barycentric polynomial interpolation where the given sample points are equidistant. - - The sample points t, must be equidistant. - The sample point values x(t). - - An interpolation scheme optimized for the given sample points and values, - which can then be used to compute interpolations and extrapolations - on arbitrary points. - - - if your data is already sorted in arrays, consider to use - MathNet.Numerics.Interpolation.Barycentric.InterpolatePolynomialEquidistantSorted - instead, which is more efficient. - - - - - Create a Neville polynomial interpolation based on arbitrary points. - If the points happen to be equidistant, consider to use the much more robust PolynomialEquidistant instead. - Otherwise, consider whether RationalWithoutPoles would not be a more robust alternative. - - The sample points t. - The sample point values x(t). - - An interpolation scheme optimized for the given sample points and values, - which can then be used to compute interpolations and extrapolations - on arbitrary points. - - - if your data is already sorted in arrays, consider to use - MathNet.Numerics.Interpolation.NevillePolynomialInterpolation.InterpolateSorted - instead, which is more efficient. - - - - - Create a piecewise linear interpolation based on arbitrary points. - - The sample points t. - The sample point values x(t). - - An interpolation scheme optimized for the given sample points and values, - which can then be used to compute interpolations and extrapolations - on arbitrary points. - - - if your data is already sorted in arrays, consider to use - MathNet.Numerics.Interpolation.LinearSpline.InterpolateSorted - instead, which is more efficient. - - - - - Create piecewise log-linear interpolation based on arbitrary points. - - The sample points t. - The sample point values x(t). - - An interpolation scheme optimized for the given sample points and values, - which can then be used to compute interpolations and extrapolations - on arbitrary points. - - - if your data is already sorted in arrays, consider to use - MathNet.Numerics.Interpolation.LogLinear.InterpolateSorted - instead, which is more efficient. - - - - - Create an piecewise natural cubic spline interpolation based on arbitrary points, - with zero secondary derivatives at the boundaries. - - The sample points t. - The sample point values x(t). - - An interpolation scheme optimized for the given sample points and values, - which can then be used to compute interpolations and extrapolations - on arbitrary points. - - - if your data is already sorted in arrays, consider to use - MathNet.Numerics.Interpolation.CubicSpline.InterpolateNaturalSorted - instead, which is more efficient. - - - - - Create a piecewise cubic Akima spline interpolation based on arbitrary points. - Akima splines are robust to outliers. - - The sample points t. - The sample point values x(t). - - An interpolation scheme optimized for the given sample points and values, - which can then be used to compute interpolations and extrapolations - on arbitrary points. - - - if your data is already sorted in arrays, consider to use - MathNet.Numerics.Interpolation.CubicSpline.InterpolateAkimaSorted - instead, which is more efficient. - - - - - Create a piecewise cubic monotone spline interpolation based on arbitrary points. - This is a shape-preserving spline with continuous first derivative. - - The sample points t. - The sample point values x(t). - - An interpolation scheme optimized for the given sample points and values, - which can then be used to compute interpolations and extrapolations - on arbitrary points. - - - if your data is already sorted in arrays, consider to use - MathNet.Numerics.Interpolation.CubicSpline.InterpolatePchipSorted - instead, which is more efficient. - - - - - Create a piecewise cubic Hermite spline interpolation based on arbitrary points - and their slopes/first derivative. - - The sample points t. - The sample point values x(t). - The slope at the sample points. Optimized for arrays. - - An interpolation scheme optimized for the given sample points and values, - which can then be used to compute interpolations and extrapolations - on arbitrary points. - - - if your data is already sorted in arrays, consider to use - MathNet.Numerics.Interpolation.CubicSpline.InterpolateHermiteSorted - instead, which is more efficient. - - - - - Create a step-interpolation based on arbitrary points. - - The sample points t. - The sample point values x(t). - - An interpolation scheme optimized for the given sample points and values, - which can then be used to compute interpolations and extrapolations - on arbitrary points. - - - if your data is already sorted in arrays, consider to use - MathNet.Numerics.Interpolation.StepInterpolation.InterpolateSorted - instead, which is more efficient. - - - - - Barycentric Interpolation Algorithm. - - Supports neither differentiation nor integration. - - - Sample points (N), sorted ascendingly. - Sample values (N), sorted ascendingly by x. - Barycentric weights (N), sorted ascendingly by x. - - - - Create a barycentric polynomial interpolation from a set of (x,y) value pairs with equidistant x, sorted ascendingly by x. - - - - - Create a barycentric polynomial interpolation from an unordered set of (x,y) value pairs with equidistant x. - WARNING: Works in-place and can thus causes the data array to be reordered. - - - - - Create a barycentric polynomial interpolation from an unsorted set of (x,y) value pairs with equidistant x. - - - - - Create a barycentric polynomial interpolation from a set of values related to linearly/equidistant spaced points within an interval. - - - - - Create a barycentric rational interpolation without poles, using Mike Floater and Kai Hormann's Algorithm. - The values are assumed to be sorted ascendingly by x. - - Sample points (N), sorted ascendingly. - Sample values (N), sorted ascendingly by x. - - Order of the interpolation scheme, 0 <= order <= N. - In most cases a value between 3 and 8 gives good results. - - - - - Create a barycentric rational interpolation without poles, using Mike Floater and Kai Hormann's Algorithm. - WARNING: Works in-place and can thus causes the data array to be reordered. - - Sample points (N), no sorting assumed. - Sample values (N). - - Order of the interpolation scheme, 0 <= order <= N. - In most cases a value between 3 and 8 gives good results. - - - - - Create a barycentric rational interpolation without poles, using Mike Floater and Kai Hormann's Algorithm. - - Sample points (N), no sorting assumed. - Sample values (N). - - Order of the interpolation scheme, 0 <= order <= N. - In most cases a value between 3 and 8 gives good results. - - - - - Create a barycentric rational interpolation without poles, using Mike Floater and Kai Hormann's Algorithm. - The values are assumed to be sorted ascendingly by x. - - Sample points (N), sorted ascendingly. - Sample values (N), sorted ascendingly by x. - - - - Create a barycentric rational interpolation without poles, using Mike Floater and Kai Hormann's Algorithm. - WARNING: Works in-place and can thus causes the data array to be reordered. - - Sample points (N), no sorting assumed. - Sample values (N). - - - - Create a barycentric rational interpolation without poles, using Mike Floater and Kai Hormann's Algorithm. - - Sample points (N), no sorting assumed. - Sample values (N). - - - - Gets a value indicating whether the algorithm supports differentiation (interpolated derivative). - - - - - Gets a value indicating whether the algorithm supports integration (interpolated quadrature). - - - - - Interpolate at point t. - - Point t to interpolate at. - Interpolated value x(t). - - - - Differentiate at point t. NOT SUPPORTED. - - Point t to interpolate at. - Interpolated first derivative at point t. - - - - Differentiate twice at point t. NOT SUPPORTED. - - Point t to interpolate at. - Interpolated second derivative at point t. - - - - Indefinite integral at point t. NOT SUPPORTED. - - Point t to integrate at. - - - - Definite integral between points a and b. NOT SUPPORTED. - - Left bound of the integration interval [a,b]. - Right bound of the integration interval [a,b]. - - - - Rational Interpolation (with poles) using Roland Bulirsch and Josef Stoer's Algorithm. - - - - This algorithm supports neither differentiation nor integration. - - - - - Sample Points t, sorted ascendingly. - Sample Values x(t), sorted ascendingly by x. - - - - Create a Bulirsch-Stoer rational interpolation from a set of (x,y) value pairs, sorted ascendingly by x. - - - - - Create a Bulirsch-Stoer rational interpolation from an unsorted set of (x,y) value pairs. - WARNING: Works in-place and can thus causes the data array to be reordered. - - - - - Create a Bulirsch-Stoer rational interpolation from an unsorted set of (x,y) value pairs. - - - - - Gets a value indicating whether the algorithm supports differentiation (interpolated derivative). - - - - - Gets a value indicating whether the algorithm supports integration (interpolated quadrature). - - - - - Interpolate at point t. - - Point t to interpolate at. - Interpolated value x(t). - - - - Differentiate at point t. NOT SUPPORTED. - - Point t to interpolate at. - Interpolated first derivative at point t. - - - - Differentiate twice at point t. NOT SUPPORTED. - - Point t to interpolate at. - Interpolated second derivative at point t. - - - - Indefinite integral at point t. NOT SUPPORTED. - - Point t to integrate at. - - - - Definite integral between points a and b. NOT SUPPORTED. - - Left bound of the integration interval [a,b]. - Right bound of the integration interval [a,b]. - - - - Cubic Spline Interpolation. - - Supports both differentiation and integration. - - - sample points (N+1), sorted ascending - Zero order spline coefficients (N) - First order spline coefficients (N) - second order spline coefficients (N) - third order spline coefficients (N) - - - - Create a Hermite cubic spline interpolation from a set of (x,y) value pairs and their slope (first derivative), sorted ascendingly by x. - - - - - Create a Hermite cubic spline interpolation from an unsorted set of (x,y) value pairs and their slope (first derivative). - WARNING: Works in-place and can thus causes the data array to be reordered. - - - - - Create a Hermite cubic spline interpolation from an unsorted set of (x,y) value pairs and their slope (first derivative). - - - - - Create an Akima cubic spline interpolation from a set of (x,y) value pairs, sorted ascendingly by x. - Akima splines are robust to outliers. - - - - - Create an Akima cubic spline interpolation from an unsorted set of (x,y) value pairs. - Akima splines are robust to outliers. - WARNING: Works in-place and can thus causes the data array to be reordered. - - - - - Create an Akima cubic spline interpolation from an unsorted set of (x,y) value pairs. - Akima splines are robust to outliers. - - - - - Create a piecewise cubic Hermite interpolating polynomial from an unsorted set of (x,y) value pairs. - Monotone-preserving interpolation with continuous first derivative. - - - - - Create a piecewise cubic Hermite interpolating polynomial from an unsorted set of (x,y) value pairs. - Monotone-preserving interpolation with continuous first derivative. - WARNING: Works in-place and can thus causes the data array to be reordered. - - - - - Create a piecewise cubic Hermite interpolating polynomial from an unsorted set of (x,y) value pairs. - Monotone-preserving interpolation with continuous first derivative. - - - - - Create a cubic spline interpolation from a set of (x,y) value pairs, sorted ascendingly by x, - and custom boundary/termination conditions. - - - - - Create a cubic spline interpolation from an unsorted set of (x,y) value pairs and custom boundary/termination conditions. - WARNING: Works in-place and can thus causes the data array to be reordered. - - - - - Create a cubic spline interpolation from an unsorted set of (x,y) value pairs and custom boundary/termination conditions. - - - - - Create a natural cubic spline interpolation from a set of (x,y) value pairs - and zero second derivatives at the two boundaries, sorted ascendingly by x. - - - - - Create a natural cubic spline interpolation from an unsorted set of (x,y) value pairs - and zero second derivatives at the two boundaries. - WARNING: Works in-place and can thus causes the data array to be reordered. - - - - - Create a natural cubic spline interpolation from an unsorted set of (x,y) value pairs - and zero second derivatives at the two boundaries. - - - - - Three-Point Differentiation Helper. - - Sample Points t. - Sample Values x(t). - Index of the point of the differentiation. - Index of the first sample. - Index of the second sample. - Index of the third sample. - The derivative approximation. - - - - Tridiagonal Solve Helper. - - The a-vector[n]. - The b-vector[n], will be modified by this function. - The c-vector[n]. - The d-vector[n], will be modified by this function. - The x-vector[n] - - - - Gets a value indicating whether the algorithm supports differentiation (interpolated derivative). - - - - - Gets a value indicating whether the algorithm supports integration (interpolated quadrature). - - - - - Interpolate at point t. - - Point t to interpolate at. - Interpolated value x(t). - - - - Differentiate at point t. - - Point t to interpolate at. - Interpolated first derivative at point t. - - - - Differentiate twice at point t. - - Point t to interpolate at. - Interpolated second derivative at point t. - - - - Indefinite integral at point t. - - Point t to integrate at. - - - - Definite integral between points a and b. - - Left bound of the integration interval [a,b]. - Right bound of the integration interval [a,b]. - - - - Find the index of the greatest sample point smaller than t, - or the left index of the closest segment for extrapolation. - - - - - Gets all the t values where the derivative is 0 - see: https://mathworld.wolfram.com/StationaryPoint.html - - An array of t values (in the domain of the function) where the derivative of the spline is 0 - - - - Returns the t values in the domain of the spline for which it takes the minimum and maximum value. - - A tuple containing the t value for which the spline is minimum in the first component and maximum in the second component - - - - Interpolation within the range of a discrete set of known data points. - - - - - Gets a value indicating whether the algorithm supports differentiation (interpolated derivative). - - - - - Gets a value indicating whether the algorithm supports integration (interpolated quadrature). - - - - - Interpolate at point t. - - Point t to interpolate at. - Interpolated value x(t). - - - - Differentiate at point t. - - Point t to interpolate at. - Interpolated first derivative at point t. - - - - Differentiate twice at point t. - - Point t to interpolate at. - Interpolated second derivative at point t. - - - - Indefinite integral at point t. - - Point t to integrate at. - - - - Definite integral between points a and b. - - Left bound of the integration interval [a,b]. - Right bound of the integration interval [a,b]. - - - - Piece-wise Linear Interpolation. - - Supports both differentiation and integration. - - - Sample points (N+1), sorted ascending - Sample values (N or N+1) at the corresponding points; intercept, zero order coefficients - Slopes (N) at the sample points (first order coefficients): N - - - - Create a linear spline interpolation from a set of (x,y) value pairs, sorted ascendingly by x. - - - - - Create a linear spline interpolation from an unsorted set of (x,y) value pairs. - WARNING: Works in-place and can thus causes the data array to be reordered. - - - - - Create a linear spline interpolation from an unsorted set of (x,y) value pairs. - - - - - Gets a value indicating whether the algorithm supports differentiation (interpolated derivative). - - - - - Gets a value indicating whether the algorithm supports integration (interpolated quadrature). - - - - - Interpolate at point t. - - Point t to interpolate at. - Interpolated value x(t). - - - - Differentiate at point t. - - Point t to interpolate at. - Interpolated first derivative at point t. - - - - Differentiate twice at point t. - - Point t to interpolate at. - Interpolated second derivative at point t. - - - - Indefinite integral at point t. - - Point t to integrate at. - - - - Definite integral between points a and b. - - Left bound of the integration interval [a,b]. - Right bound of the integration interval [a,b]. - - - - Find the index of the greatest sample point smaller than t, - or the left index of the closest segment for extrapolation. - - - - - Piece-wise Log-Linear Interpolation - - This algorithm supports differentiation, not integration. - - - - Internal Spline Interpolation - - - - Sample points (N), sorted ascending - Natural logarithm of the sample values (N) at the corresponding points - - - - Create a piecewise log-linear interpolation from a set of (x,y) value pairs, sorted ascendingly by x. - - - - - Create a piecewise log-linear interpolation from an unsorted set of (x,y) value pairs. - WARNING: Works in-place and can thus causes the data array to be reordered and modified. - - - - - Create a piecewise log-linear interpolation from an unsorted set of (x,y) value pairs. - - - - - Gets a value indicating whether the algorithm supports differentiation (interpolated derivative). - - - - - Gets a value indicating whether the algorithm supports integration (interpolated quadrature). - - - - - Interpolate at point t. - - Point t to interpolate at. - Interpolated value x(t). - - - - Differentiate at point t. - - Point t to interpolate at. - Interpolated first derivative at point t. - - - - Differentiate twice at point t. - - Point t to interpolate at. - Interpolated second derivative at point t. - - - - Indefinite integral at point t. - - Point t to integrate at. - - - - Definite integral between points a and b. - - Left bound of the integration interval [a,b]. - Right bound of the integration interval [a,b]. - - - - Lagrange Polynomial Interpolation using Neville's Algorithm. - - - - This algorithm supports differentiation, but doesn't support integration. - - - When working with equidistant or Chebyshev sample points it is - recommended to use the barycentric algorithms specialized for - these cases instead of this arbitrary Neville algorithm. - - - - - Sample Points t, sorted ascendingly. - Sample Values x(t), sorted ascendingly by x. - - - - Create a Neville polynomial interpolation from a set of (x,y) value pairs, sorted ascendingly by x. - - - - - Create a Neville polynomial interpolation from an unsorted set of (x,y) value pairs. - WARNING: Works in-place and can thus causes the data array to be reordered. - - - - - Create a Neville polynomial interpolation from an unsorted set of (x,y) value pairs. - - - - - Gets a value indicating whether the algorithm supports differentiation (interpolated derivative). - - - - - Gets a value indicating whether the algorithm supports integration (interpolated quadrature). - - - - - Interpolate at point t. - - Point t to interpolate at. - Interpolated value x(t). - - - - Differentiate at point t. - - Point t to interpolate at. - Interpolated first derivative at point t. - - - - Differentiate twice at point t. - - Point t to interpolate at. - Interpolated second derivative at point t. - - - - Indefinite integral at point t. NOT SUPPORTED. - - Point t to integrate at. - - - - Definite integral between points a and b. NOT SUPPORTED. - - Left bound of the integration interval [a,b]. - Right bound of the integration interval [a,b]. - - - - Quadratic Spline Interpolation. - - Supports both differentiation and integration. - - - sample points (N+1), sorted ascending - Zero order spline coefficients (N) - First order spline coefficients (N) - second order spline coefficients (N) - - - - Gets a value indicating whether the algorithm supports differentiation (interpolated derivative). - - - - - Gets a value indicating whether the algorithm supports integration (interpolated quadrature). - - - - - Interpolate at point t. - - Point t to interpolate at. - Interpolated value x(t). - - - - Differentiate at point t. - - Point t to interpolate at. - Interpolated first derivative at point t. - - - - Differentiate twice at point t. - - Point t to interpolate at. - Interpolated second derivative at point t. - - - - Indefinite integral at point t. - - Point t to integrate at. - - - - Definite integral between points a and b. - - Left bound of the integration interval [a,b]. - Right bound of the integration interval [a,b]. - - - - Find the index of the greatest sample point smaller than t, - or the left index of the closest segment for extrapolation. - - - - - Left and right boundary conditions. - - - - - Natural Boundary (Zero second derivative). - - - - - Parabolically Terminated boundary. - - - - - Fixed first derivative at the boundary. - - - - - Fixed second derivative at the boundary. - - - - - A step function where the start of each segment is included, and the last segment is open-ended. - Segment i is [x_i, x_i+1) for i < N, or [x_i, infinity] for i = N. - The domain of the function is all real numbers, such that y = 0 where x <. - - Supports both differentiation and integration. - - - Sample points (N), sorted ascending - Samples values (N) of each segment starting at the corresponding sample point. - - - - Create a linear spline interpolation from a set of (x,y) value pairs, sorted ascendingly by x. - - - - - Create a linear spline interpolation from an unsorted set of (x,y) value pairs. - WARNING: Works in-place and can thus causes the data array to be reordered. - - - - - Create a linear spline interpolation from an unsorted set of (x,y) value pairs. - - - - - Interpolate at point t. - - Point t to interpolate at. - Interpolated value x(t). - - - - Differentiate at point t. - - Point t to interpolate at. - Interpolated first derivative at point t. - - - - Differentiate twice at point t. - - Point t to interpolate at. - Interpolated second derivative at point t. - - - - Indefinite integral at point t. - - Point t to integrate at. - - - - Definite integral between points a and b. - - Left bound of the integration interval [a,b]. - Right bound of the integration interval [a,b]. - - - - Find the index of the greatest sample point smaller than t. - - - - - Wraps an interpolation with a transformation of the interpolated values. - - Neither differentiation nor integration is supported. - - - - Create a linear spline interpolation from a set of (x,y) value pairs, sorted ascendingly by x. - - - - - Create a linear spline interpolation from an unsorted set of (x,y) value pairs. - WARNING: Works in-place and can thus causes the data array to be reordered and modified. - - - - - Create a linear spline interpolation from an unsorted set of (x,y) value pairs. - - - - - Gets a value indicating whether the algorithm supports differentiation (interpolated derivative). - - - - - Gets a value indicating whether the algorithm supports integration (interpolated quadrature). - - - - - Interpolate at point t. - - Point t to interpolate at. - Interpolated value x(t). - - - - Differentiate at point t. NOT SUPPORTED. - - Point t to interpolate at. - Interpolated first derivative at point t. - - - - Differentiate twice at point t. NOT SUPPORTED. - - Point t to interpolate at. - Interpolated second derivative at point t. - - - - Indefinite integral at point t. NOT SUPPORTED. - - Point t to integrate at. - - - - Definite integral between points a and b. NOT SUPPORTED. - - Left bound of the integration interval [a,b]. - Right bound of the integration interval [a,b]. - - - - A Matrix class with dense storage. The underlying storage is a one dimensional array in column-major order (column by column). - - - - - Number of rows. - - Using this instead of the RowCount property to speed up calculating - a matrix index in the data array. - - - - Number of columns. - - Using this instead of the ColumnCount property to speed up calculating - a matrix index in the data array. - - - - Gets the matrix's data. - - The matrix's data. - - - - Create a new dense matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new square dense matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the order is less than one. - - - - Create a new dense matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the row or column count is less than one. - - - - Create a new dense matrix with the given number of rows and columns directly binding to a raw array. - The array is assumed to be in column-major order (column by column) and is used directly without copying. - Very efficient, but changes to the array and the matrix will affect each other. - - - - - - Create a new dense matrix as a copy of the given other matrix. - This new matrix will be independent from the other matrix. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given two-dimensional array. - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable. - The enumerable is assumed to be in column-major order (column by column). - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix and initialize each value to the same provided value. - - - - - Create a new dense matrix and initialize each value using the provided init function. - - - - - Create a new diagonal dense matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal dense matrix and initialize each diagonal value using the provided init function. - - - - - Create a new square sparse identity matrix where each diagonal value is set to One. - - - - - Create a new dense matrix with values sampled from the provided random distribution. - - - - - Gets the matrix's data. - - The matrix's data. - - - Calculates the induced L1 norm of this matrix. - The maximum absolute column sum of the matrix. - - - Calculates the induced infinity norm of this matrix. - The maximum absolute row sum of the matrix. - - - Calculates the entry-wise Frobenius norm of this matrix. - The square root of the sum of the squared values. - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - - - - Add a scalar to each element of the matrix and stores the result in the result vector. - - The scalar to add. - The matrix to store the result of the addition. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of add - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Subtracts a scalar from each element of the matrix and stores the result in the result vector. - - The scalar to subtract. - The matrix to store the result of the subtraction. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract. - The matrix to store the result of the subtraction. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Divides each element of the matrix by a scalar and places results into the result matrix. - - The scalar to divide the matrix with. - The matrix to store the result of the division. - - - - Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. - - The matrix to pointwise multiply with this one. - The matrix to store the result of the pointwise multiplication. - - - - Pointwise divide this matrix by another matrix and stores the result into the result matrix. - - The matrix to pointwise divide this one by. - The matrix to store the result of the pointwise division. - - - - Pointwise raise this matrix to an exponent and store the result into the result matrix. - - The exponent to raise this matrix values to. - The vector to store the result of the pointwise power. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - Computes the trace of this matrix. - - The trace of this matrix - If the matrix is not square - - - - Adds two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to add. - The right matrix to add. - The result of the addition. - If and don't have the same dimensions. - If or is . - - - - Returns a Matrix containing the same values of . - - The matrix to get the values from. - A matrix containing a the same values as . - If is . - - - - Subtracts two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to subtract. - The right matrix to subtract. - The result of the addition. - If and don't have the same dimensions. - If or is . - - - - Negates each element of the matrix. - - The matrix to negate. - A matrix containing the negated values. - If is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies two matrices. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to multiply. - The right matrix to multiply. - The result of multiplication. - If or is . - If the dimensions of or don't conform. - - - - Multiplies a Matrix and a Vector. - - The matrix to multiply. - The vector to multiply. - The result of multiplication. - If or is . - - - - Multiplies a Vector and a Matrix. - - The vector to multiply. - The matrix to multiply. - The result of multiplication. - If or is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Evaluates whether this matrix is symmetric. - - - - - A vector using dense storage. - - - - - Number of elements - - - - - Gets the vector's data. - - - - - Create a new dense vector straight from an initialized vector storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new dense vector with the given length. - All cells of the vector will be initialized to zero. - - If length is less than one. - - - - Create a new dense vector directly binding to a raw array. - The array is used directly without copying. - Very efficient, but changes to the array and the vector will affect each other. - - - - - Create a new dense vector as a copy of the given other vector. - This new vector will be independent from the other vector. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given array. - This new vector will be independent from the array. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given enumerable. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector and initialize each value using the provided value. - - - - - Create a new dense vector and initialize each value using the provided init function. - - - - - Create a new dense vector with values sampled from the provided random distribution. - - - - - Gets the vector's data. - - The vector's data. - - - - Returns a reference to the internal data structure. - - The DenseVector whose internal data we are - returning. - - A reference to the internal date of the given vector. - - - - - Returns a vector bound directly to a reference of the provided array. - - The array to bind to the DenseVector object. - - A DenseVector whose values are bound to the given array. - - - - - Adds a scalar to each element of the vector and stores the result in the result vector. - - The scalar to add. - The vector to store the result of the addition. - - - - Adds another vector to this vector and stores the result into the result vector. - - The vector to add to this one. - The vector to store the result of the addition. - - - - Adds two Vectors together and returns the results. - - One of the vectors to add. - The other vector to add. - The result of the addition. - If and are not the same size. - If or is . - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - The scalar to subtract. - The vector to store the result of the subtraction. - - - - Subtracts another vector to this vector and stores the result into the result vector. - - The vector to subtract from this one. - The vector to store the result of the subtraction. - - - - Returns a Vector containing the negated values of . - - The vector to get the values from. - A vector containing the negated values as . - If is . - - - - Subtracts two Vectors and returns the results. - - The vector to subtract from. - The vector to subtract. - The result of the subtraction. - If and are not the same size. - If or is . - - - - Negates vector and saves result to - - Target vector - - - - Multiplies a scalar to each element of the vector and stores the result in the result vector. - - The scalar to multiply. - The vector to store the result of the multiplication. - - - - - Computes the dot product between this vector and another vector. - - The other vector. - The sum of a[i]*b[i] for all i. - - - - Multiplies a vector with a scalar. - - The vector to scale. - The scalar value. - The result of the multiplication. - If is . - - - - Multiplies a vector with a scalar. - - The scalar value. - The vector to scale. - The result of the multiplication. - If is . - - - - Computes the dot product between two Vectors. - - The left row vector. - The right column vector. - The dot product between the two vectors. - If and are not the same size. - If or is . - - - - Divides a vector with a scalar. - - The vector to divide. - The scalar value. - The result of the division. - If is . - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for each element of the vector for the given divisor. - - The divisor to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for each element of the vector for the given divisor. - - The divisor to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - of each element of the vector of the given divisor. - - The vector whose elements we want to compute the remainder of. - The divisor to use, - If is . - - - - Returns the index of the absolute minimum element. - - The index of absolute minimum element. - - - - Returns the index of the absolute maximum element. - - The index of absolute maximum element. - - - - Returns the index of the maximum element. - - The index of maximum element. - - - - Returns the index of the minimum element. - - The index of minimum element. - - - - Computes the sum of the vector's elements. - - The sum of the vector's elements. - - - - Calculates the L1 norm of the vector, also known as Manhattan norm. - - The sum of the absolute values. - - - - Calculates the L2 norm of the vector, also known as Euclidean norm. - - The square root of the sum of the squared values. - - - - Calculates the infinity norm of the vector. - - The maximum absolute value. - - - - Computes the p-Norm. - - The p value. - Scalar ret = ( ∑|this[i]|^p )^(1/p) - - - - Pointwise divide this vector with another vector and stores the result into the result vector. - - The vector to pointwise divide this one by. - The vector to store the result of the pointwise division. - - - - Pointwise divide this vector with another vector and stores the result into the result vector. - - The vector to pointwise divide this one by. - The vector to store the result of the pointwise division. - - - - - Pointwise raise this vector to an exponent vector and store the result into the result vector. - - The exponent vector to raise this vector values to. - The vector to store the result of the pointwise power. - - - - Creates a double dense vector based on a string. The string can be in the following formats (without the - quotes): 'n', 'n,n,..', '(n,n,..)', '[n,n,...]', where n is a double. - - - A double dense vector containing the values specified by the given string. - - - the string to parse. - - - An that supplies culture-specific formatting information. - - - - - Converts the string representation of a real dense vector to double-precision dense vector equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a real vector to convert. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will be null. - - - - - Converts the string representation of a real dense vector to double-precision dense vector equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a real vector to convert. - - - An that supplies culture-specific formatting information about value. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will be null. - - - - - A matrix type for diagonal matrices. - - - Diagonal matrices can be non-square matrices but the diagonal always starts - at element 0,0. A diagonal matrix will throw an exception if non diagonal - entries are set. The exception to this is when the off diagonal elements are - 0.0 or NaN; these settings will cause no change to the diagonal matrix. - - - - - Gets the matrix's data. - - The matrix's data. - - - - Create a new diagonal matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new square diagonal matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the order is less than one. - - - - Create a new diagonal matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the row or column count is less than one. - - - - Create a new diagonal matrix with the given number of rows and columns. - All diagonal cells of the matrix will be initialized to the provided value, all non-diagonal ones to zero. - - If the row or column count is less than one. - - - - Create a new diagonal matrix with the given number of rows and columns directly binding to a raw array. - The array is assumed to contain the diagonal elements only and is used directly without copying. - Very efficient, but changes to the array and the matrix will affect each other. - - - - - Create a new diagonal matrix as a copy of the given other matrix. - This new matrix will be independent from the other matrix. - The matrix to copy from must be diagonal as well. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix as a copy of the given two-dimensional array. - This new matrix will be independent from the provided array. - The array to copy from must be diagonal as well. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix and initialize each diagonal value from the provided indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix and initialize each diagonal value from the provided indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix and initialize each diagonal value from the provided enumerable. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix and initialize each diagonal value using the provided init function. - - - - - Create a new square sparse identity matrix where each diagonal value is set to One. - - - - - Create a new diagonal matrix with diagonal values sampled from the provided random distribution. - - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of the addition. - If the two matrices don't have the same dimensions. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract. - The matrix to store the result of the subtraction. - If the two matrices don't have the same dimensions. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - If the result matrix's dimensions are not the same as this matrix. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Divides each element of the matrix by a scalar and places results into the result matrix. - - The scalar to divide the matrix with. - The matrix to store the result of the division. - - - - Divides a scalar by each element of the matrix and stores the result in the result matrix. - - The scalar to add. - The matrix to store the result of the division. - - - - Computes the determinant of this matrix. - - The determinant of this matrix. - - - - Returns the elements of the diagonal in a . - - The elements of the diagonal. - For non-square matrices, the method returns Min(Rows, Columns) elements where - i == j (i is the row index, and j is the column index). - - - - Copies the values of the given array to the diagonal. - - The array to copy the values from. The length of the vector should be - Min(Rows, Columns). - If the length of does not - equal Min(Rows, Columns). - For non-square matrices, the elements of are copied to - this[i,i]. - - - - Copies the values of the given to the diagonal. - - The vector to copy the values from. The length of the vector should be - Min(Rows, Columns). - If the length of does not - equal Min(Rows, Columns). - For non-square matrices, the elements of are copied to - this[i,i]. - - - Calculates the induced L1 norm of this matrix. - The maximum absolute column sum of the matrix. - - - Calculates the induced L2 norm of the matrix. - The largest singular value of the matrix. - - - Calculates the induced infinity norm of this matrix. - The maximum absolute row sum of the matrix. - - - Calculates the entry-wise Frobenius norm of this matrix. - The square root of the sum of the squared values. - - - Calculates the condition number of this matrix. - The condition number of the matrix. - - - Computes the inverse of this matrix. - If is not a square matrix. - If is singular. - The inverse of this matrix. - - - - Returns a new matrix containing the lower triangle of this matrix. - - The lower triangle of this matrix. - - - - Puts the lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If the result matrix's dimensions are not the same as this matrix. - - - - Returns a new matrix containing the lower triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The lower triangle of this matrix. - - - - Puts the strictly lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If the result matrix's dimensions are not the same as this matrix. - - - - Returns a new matrix containing the upper triangle of this matrix. - - The upper triangle of this matrix. - - - - Puts the upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If the result matrix's dimensions are not the same as this matrix. - - - - Returns a new matrix containing the upper triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The upper triangle of this matrix. - - - - Puts the strictly upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If the result matrix's dimensions are not the same as this matrix. - - - - Creates a matrix that contains the values from the requested sub-matrix. - - The row to start copying from. - The number of rows to copy. Must be positive. - The column to start copying from. - The number of columns to copy. Must be positive. - The requested sub-matrix. - If: is - negative, or greater than or equal to the number of rows. - is negative, or greater than or equal to the number - of columns. - (columnIndex + columnLength) >= Columns - (rowIndex + rowLength) >= Rows - If or - is not positive. - - - - Permute the columns of a matrix according to a permutation. - - The column permutation to apply to this matrix. - Always thrown - Permutation in diagonal matrix are senseless, because of matrix nature - - - - Permute the rows of a matrix according to a permutation. - - The row permutation to apply to this matrix. - Always thrown - Permutation in diagonal matrix are senseless, because of matrix nature - - - - Evaluates whether this matrix is symmetric. - - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - A class which encapsulates the functionality of a Cholesky factorization. - For a symmetric, positive definite matrix A, the Cholesky factorization - is an lower triangular matrix L so that A = L*L'. - - - The computation of the Cholesky factorization is done at construction time. If the matrix is not symmetric - or positive definite, the constructor will throw an exception. - - - - - Gets the determinant of the matrix for which the Cholesky matrix was computed. - - - - - Gets the log determinant of the matrix for which the Cholesky matrix was computed. - - - - - A class which encapsulates the functionality of a Cholesky factorization for dense matrices. - For a symmetric, positive definite matrix A, the Cholesky factorization - is an lower triangular matrix L so that A = L*L'. - - - The computation of the Cholesky factorization is done at construction time. If the matrix is not symmetric - or positive definite, the constructor will throw an exception. - - - - - Initializes a new instance of the class. This object will compute the - Cholesky factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - If is null. - If is not a square matrix. - If is not positive definite. - - - - Solves a system of linear equations, AX = B, with A Cholesky factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A Cholesky factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Calculates the Cholesky factorization of the input matrix. - - The matrix to be factorized. - If is null. - If is not a square matrix. - If is not positive definite. - If does not have the same dimensions as the existing factor. - - - - Eigenvalues and eigenvectors of a real matrix. - - - If A is symmetric, then A = V*D*V' where the eigenvalue matrix D is - diagonal and the eigenvector matrix V is orthogonal. - I.e. A = V*D*V' and V*VT=I. - If A is not symmetric, then the eigenvalue matrix D is block diagonal - with the real eigenvalues in 1-by-1 blocks and any complex eigenvalues, - lambda + i*mu, in 2-by-2 blocks, [lambda, mu; -mu, lambda]. The - columns of V represent the eigenvectors in the sense that A*V = V*D, - i.e. A.Multiply(V) equals V.Multiply(D). The matrix V may be badly - conditioned, or even singular, so the validity of the equation - A = V*D*Inverse(V) depends upon V.Condition(). - - - - - Initializes a new instance of the class. This object will compute the - the eigenvalue decomposition when the constructor is called and cache it's decomposition. - - The matrix to factor. - If it is known whether the matrix is symmetric or not the routine can skip checking it itself. - If is null. - If EVD algorithm failed to converge with matrix . - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A EVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the QR decomposition Modified Gram-Schmidt Orthogonalization. - Any real square matrix A may be decomposed as A = QR where Q is an orthogonal mxn matrix and R is an nxn upper triangular matrix. - - - The computation of the QR decomposition is done at construction time by modified Gram-Schmidt Orthogonalization. - - - - - Initializes a new instance of the class. This object creates an orthogonal matrix - using the modified Gram-Schmidt method. - - The matrix to factor. - If is null. - If row count is less then column count - If is rank deficient - - - - Factorize matrix using the modified Gram-Schmidt method. - - Initial matrix. On exit is replaced by Q. - Number of rows in Q. - Number of columns in Q. - On exit is filled by R. - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of an LU factorization. - For a matrix A, the LU factorization is a pair of lower triangular matrix L and - upper triangular matrix U so that A = L*U. - - - The computation of the LU factorization is done at construction time. - - - - - Initializes a new instance of the class. This object will compute the - LU factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - If is null. - If is not a square matrix. - - - - Solves a system of linear equations, AX = B, with A LU factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A LU factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Returns the inverse of this matrix. The inverse is calculated using LU decomposition. - - The inverse of this matrix. - - - - A class which encapsulates the functionality of the QR decomposition. - Any real square matrix A may be decomposed as A = QR where Q is an orthogonal matrix - (its columns are orthogonal unit vectors meaning QTQ = I) and R is an upper triangular matrix - (also called right triangular matrix). - - - The computation of the QR decomposition is done at construction time by Householder transformation. - - - - - Gets or sets Tau vector. Contains additional information on Q - used for native solver. - - - - - Initializes a new instance of the class. This object will compute the - QR factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - The type of QR factorization to perform. - If is null. - If row count is less then column count - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the singular value decomposition (SVD) for . - Suppose M is an m-by-n matrix whose entries are real numbers. - Then there exists a factorization of the form M = UΣVT where: - - U is an m-by-m unitary matrix; - - Σ is m-by-n diagonal matrix with nonnegative real numbers on the diagonal; - - VT denotes transpose of V, an n-by-n unitary matrix; - Such a factorization is called a singular-value decomposition of M. A common convention is to order the diagonal - entries Σ(i,i) in descending order. In this case, the diagonal matrix Σ is uniquely determined - by M (though the matrices U and V are not). The diagonal entries of Σ are known as the singular values of M. - - - The computation of the singular value decomposition is done at construction time. - - - - - Initializes a new instance of the class. This object will compute the - the singular value decomposition when the constructor is called and cache it's decomposition. - - The matrix to factor. - Compute the singular U and VT vectors or not. - If is null. - If SVD algorithm failed to converge with matrix . - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A SVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Eigenvalues and eigenvectors of a real matrix. - - - If A is symmetric, then A = V*D*V' where the eigenvalue matrix D is - diagonal and the eigenvector matrix V is orthogonal. - I.e. A = V*D*V' and V*VT=I. - If A is not symmetric, then the eigenvalue matrix D is block diagonal - with the real eigenvalues in 1-by-1 blocks and any complex eigenvalues, - lambda + i*mu, in 2-by-2 blocks, [lambda, mu; -mu, lambda]. The - columns of V represent the eigenvectors in the sense that A*V = V*D, - i.e. A.Multiply(V) equals V.Multiply(D). The matrix V may be badly - conditioned, or even singular, so the validity of the equation - A = V*D*Inverse(V) depends upon V.Condition(). - Matrix V is encoded in the property EigenVectors in the way that: - - column corresponding to real eigenvalue represents real eigenvector, - - columns corresponding to the pair of complex conjugate eigenvalues - lambda[i] and lambda[i+1] encode real and imaginary parts of eigenvectors. - - - - - Gets the absolute value of determinant of the square matrix for which the EVD was computed. - - - - - Gets the effective numerical matrix rank. - - The number of non-negligible singular values. - - - - Gets a value indicating whether the matrix is full rank or not. - - true if the matrix is full rank; otherwise false. - - - - A class which encapsulates the functionality of the QR decomposition Modified Gram-Schmidt Orthogonalization. - Any real square matrix A may be decomposed as A = QR where Q is an orthogonal mxn matrix and R is an nxn upper triangular matrix. - - - The computation of the QR decomposition is done at construction time by modified Gram-Schmidt Orthogonalization. - - - - - Gets the absolute determinant value of the matrix for which the QR matrix was computed. - - - - - Gets a value indicating whether the matrix is full rank or not. - - true if the matrix is full rank; otherwise false. - - - - A class which encapsulates the functionality of an LU factorization. - For a matrix A, the LU factorization is a pair of lower triangular matrix L and - upper triangular matrix U so that A = L*U. - In the Math.NET implementation we also store a set of pivot elements for increased - numerical stability. The pivot elements encode a permutation matrix P such that P*A = L*U. - - - The computation of the LU factorization is done at construction time. - - - - - Gets the determinant of the matrix for which the LU factorization was computed. - - - - - A class which encapsulates the functionality of the QR decomposition. - Any real square matrix A (m x n) may be decomposed as A = QR where Q is an orthogonal matrix - (its columns are orthogonal unit vectors meaning QTQ = I) and R is an upper triangular matrix - (also called right triangular matrix). - - - The computation of the QR decomposition is done at construction time by Householder transformation. - If a factorization is performed, the resulting Q matrix is an m x m matrix - and the R matrix is an m x n matrix. If a factorization is performed, the - resulting Q matrix is an m x n matrix and the R matrix is an n x n matrix. - - - - - Gets the absolute determinant value of the matrix for which the QR matrix was computed. - - - - - Gets a value indicating whether the matrix is full rank or not. - - true if the matrix is full rank; otherwise false. - - - - A class which encapsulates the functionality of the singular value decomposition (SVD). - Suppose M is an m-by-n matrix whose entries are real numbers. - Then there exists a factorization of the form M = UΣVT where: - - U is an m-by-m unitary matrix; - - Σ is m-by-n diagonal matrix with nonnegative real numbers on the diagonal; - - VT denotes transpose of V, an n-by-n unitary matrix; - Such a factorization is called a singular-value decomposition of M. A common convention is to order the diagonal - entries Σ(i,i) in descending order. In this case, the diagonal matrix Σ is uniquely determined - by M (though the matrices U and V are not). The diagonal entries of Σ are known as the singular values of M. - - - The computation of the singular value decomposition is done at construction time. - - - - - Gets the effective numerical matrix rank. - - The number of non-negligible singular values. - - - - Gets the two norm of the . - - The 2-norm of the . - - - - Gets the condition number max(S) / min(S) - - The condition number. - - - - Gets the determinant of the square matrix for which the SVD was computed. - - - - - A class which encapsulates the functionality of a Cholesky factorization for user matrices. - For a symmetric, positive definite matrix A, the Cholesky factorization - is an lower triangular matrix L so that A = L*L'. - - - The computation of the Cholesky factorization is done at construction time. If the matrix is not symmetric - or positive definite, the constructor will throw an exception. - - - - - Computes the Cholesky factorization in-place. - - On entry, the matrix to factor. On exit, the Cholesky factor matrix - If is null. - If is not a square matrix. - If is not positive definite. - - - - Initializes a new instance of the class. This object will compute the - Cholesky factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - If is null. - If is not a square matrix. - If is not positive definite. - - - - Calculates the Cholesky factorization of the input matrix. - - The matrix to be factorized. - If is null. - If is not a square matrix. - If is not positive definite. - If does not have the same dimensions as the existing factor. - - - - Calculate Cholesky step - - Factor matrix - Number of rows - Column start - Total columns - Multipliers calculated previously - Number of available processors - - - - Solves a system of linear equations, AX = B, with A Cholesky factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A Cholesky factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Eigenvalues and eigenvectors of a real matrix. - - - If A is symmetric, then A = V*D*V' where the eigenvalue matrix D is - diagonal and the eigenvector matrix V is orthogonal. - I.e. A = V*D*V' and V*VT=I. - If A is not symmetric, then the eigenvalue matrix D is block diagonal - with the real eigenvalues in 1-by-1 blocks and any complex eigenvalues, - lambda + i*mu, in 2-by-2 blocks, [lambda, mu; -mu, lambda]. The - columns of V represent the eigenvectors in the sense that A*V = V*D, - i.e. A.Multiply(V) equals V.Multiply(D). The matrix V may be badly - conditioned, or even singular, so the validity of the equation - A = V*D*Inverse(V) depends upon V.Condition(). - - - - - Initializes a new instance of the class. This object will compute the - the eigenvalue decomposition when the constructor is called and cache it's decomposition. - - The matrix to factor. - If it is known whether the matrix is symmetric or not the routine can skip checking it itself. - If is null. - If EVD algorithm failed to converge with matrix . - - - - Symmetric Householder reduction to tridiagonal form. - - The eigen vectors to work on. - Arrays for internal storage of real parts of eigenvalues - Arrays for internal storage of imaginary parts of eigenvalues - Order of initial matrix - This is derived from the Algol procedures tred2 by - Bowdler, Martin, Reinsch, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Symmetric tridiagonal QL algorithm. - - The eigen vectors to work on. - Arrays for internal storage of real parts of eigenvalues - Arrays for internal storage of imaginary parts of eigenvalues - Order of initial matrix - This is derived from the Algol procedures tql2, by - Bowdler, Martin, Reinsch, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - - Nonsymmetric reduction to Hessenberg form. - - The eigen vectors to work on. - Array for internal storage of nonsymmetric Hessenberg form. - Order of initial matrix - This is derived from the Algol procedures orthes and ortran, - by Martin and Wilkinson, Handbook for Auto. Comp., - Vol.ii-Linear Algebra, and the corresponding - Fortran subroutines in EISPACK. - - - - Nonsymmetric reduction from Hessenberg to real Schur form. - - The eigen vectors to work on. - Array for internal storage of nonsymmetric Hessenberg form. - Arrays for internal storage of real parts of eigenvalues - Arrays for internal storage of imaginary parts of eigenvalues - Order of initial matrix - This is derived from the Algol procedure hqr2, - by Martin and Wilkinson, Handbook for Auto. Comp., - Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Complex scalar division X/Y. - - Real part of X - Imaginary part of X - Real part of Y - Imaginary part of Y - Division result as a number. - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A EVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the QR decomposition Modified Gram-Schmidt Orthogonalization. - Any real square matrix A may be decomposed as A = QR where Q is an orthogonal mxn matrix and R is an nxn upper triangular matrix. - - - The computation of the QR decomposition is done at construction time by modified Gram-Schmidt Orthogonalization. - - - - - Initializes a new instance of the class. This object creates an orthogonal matrix - using the modified Gram-Schmidt method. - - The matrix to factor. - If is null. - If row count is less then column count - If is rank deficient - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of an LU factorization. - For a matrix A, the LU factorization is a pair of lower triangular matrix L and - upper triangular matrix U so that A = L*U. - - - The computation of the LU factorization is done at construction time. - - - - - Initializes a new instance of the class. This object will compute the - LU factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - If is null. - If is not a square matrix. - - - - Solves a system of linear equations, AX = B, with A LU factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A LU factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Returns the inverse of this matrix. The inverse is calculated using LU decomposition. - - The inverse of this matrix. - - - - A class which encapsulates the functionality of the QR decomposition. - Any real square matrix A may be decomposed as A = QR where Q is an orthogonal matrix - (its columns are orthogonal unit vectors meaning QTQ = I) and R is an upper triangular matrix - (also called right triangular matrix). - - - The computation of the QR decomposition is done at construction time by Householder transformation. - - - - - Initializes a new instance of the class. This object will compute the - QR factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - The QR factorization method to use. - If is null. - - - - Generate column from initial matrix to work array - - Initial matrix - The first row - Column index - Generated vector - - - - Perform calculation of Q or R - - Work array - Q or R matrices - The first row - The last row - The first column - The last column - Number of available CPUs - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the singular value decomposition (SVD) for . - Suppose M is an m-by-n matrix whose entries are real numbers. - Then there exists a factorization of the form M = UΣVT where: - - U is an m-by-m unitary matrix; - - Σ is m-by-n diagonal matrix with nonnegative real numbers on the diagonal; - - VT denotes transpose of V, an n-by-n unitary matrix; - Such a factorization is called a singular-value decomposition of M. A common convention is to order the diagonal - entries Σ(i,i) in descending order. In this case, the diagonal matrix Σ is uniquely determined - by M (though the matrices U and V are not). The diagonal entries of Σ are known as the singular values of M. - - - The computation of the singular value decomposition is done at construction time. - - - - - Initializes a new instance of the class. This object will compute the - the singular value decomposition when the constructor is called and cache it's decomposition. - - The matrix to factor. - Compute the singular U and VT vectors or not. - If is null. - - - - - Calculates absolute value of multiplied on signum function of - - Double value z1 - Double value z2 - Result multiplication of signum function and absolute value - - - - Swap column and - - Source matrix - The number of rows in - Column A index to swap - Column B index to swap - - - - Scale column by starting from row - - Source matrix - The number of rows in - Column to scale - Row to scale from - Scale value - - - - Scale vector by starting from index - - Source vector - Row to scale from - Scale value - - - - Given the Cartesian coordinates (da, db) of a point p, these function return the parameters da, db, c, and s - associated with the Givens rotation that zeros the y-coordinate of the point. - - Provides the x-coordinate of the point p. On exit contains the parameter r associated with the Givens rotation - Provides the y-coordinate of the point p. On exit contains the parameter z associated with the Givens rotation - Contains the parameter c associated with the Givens rotation - Contains the parameter s associated with the Givens rotation - This is equivalent to the DROTG LAPACK routine. - - - - Calculate Norm 2 of the column in matrix starting from row - - Source matrix - The number of rows in - Column index - Start row index - Norm2 (Euclidean norm) of the column - - - - Calculate Norm 2 of the vector starting from index - - Source vector - Start index - Norm2 (Euclidean norm) of the vector - - - - Calculate dot product of and - - Source matrix - The number of rows in - Index of column A - Index of column B - Starting row index - Dot product value - - - - Performs rotation of points in the plane. Given two vectors x and y , - each vector element of these vectors is replaced as follows: x(i) = c*x(i) + s*y(i); y(i) = c*y(i) - s*x(i) - - Source matrix - The number of rows in - Index of column A - Index of column B - Scalar "c" value - Scalar "s" value - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A SVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - double version of the class. - - - - - Initializes a new instance of the Matrix class. - - - - - Set all values whose absolute value is smaller than the threshold to zero. - - - - - Returns the conjugate transpose of this matrix. - - The conjugate transpose of this matrix. - - - - Puts the conjugate transpose of this matrix into the result matrix. - - - - - Complex conjugates each element of this matrix and place the results into the result matrix. - - The result of the conjugation. - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - - - - Add a scalar to each element of the matrix and stores the result in the result vector. - - The scalar to add. - The matrix to store the result of the addition. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of the addition. - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - The scalar to subtract. - The matrix to store the result of the subtraction. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract to this matrix. - The matrix to store the result of subtraction. - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Divides each element of the matrix by a scalar and places results into the result matrix. - - The scalar to divide the matrix with. - The matrix to store the result of the division. - - - - Divides a scalar by each element of the matrix and stores the result in the result matrix. - - The scalar to divide by each element of the matrix. - The matrix to store the result of the division. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. - - The matrix to pointwise multiply with this one. - The matrix to store the result of the pointwise multiplication. - - - - Pointwise divide this matrix by another matrix and stores the result into the result matrix. - - The matrix to pointwise divide this one by. - The matrix to store the result of the pointwise division. - - - - Pointwise raise this matrix to an exponent and store the result into the result matrix. - - The exponent to raise this matrix values to. - The matrix to store the result of the pointwise power. - - - - Pointwise raise this matrix to an exponent and store the result into the result matrix. - - The exponent to raise this matrix values to. - The vector to store the result of the pointwise power. - - - - Pointwise canonical modulus, where the result has the sign of the divisor, - of this matrix with another matrix and stores the result into the result matrix. - - The pointwise denominator matrix to use - The result of the modulus. - - - - Pointwise remainder (% operator), where the result has the sign of the dividend, - of this matrix with another matrix and stores the result into the result matrix. - - The pointwise denominator matrix to use - The result of the modulus. - - - - Pointwise applies the exponential function to each value and stores the result into the result matrix. - - The matrix to store the result. - - - - Pointwise applies the natural logarithm function to each value and stores the result into the result matrix. - - The matrix to store the result. - - - - Computes the Moore-Penrose Pseudo-Inverse of this matrix. - - - - - Computes the trace of this matrix. - - The trace of this matrix - If the matrix is not square - - - Calculates the induced L1 norm of this matrix. - The maximum absolute column sum of the matrix. - - - Calculates the induced infinity norm of this matrix. - The maximum absolute row sum of the matrix. - - - Calculates the entry-wise Frobenius norm of this matrix. - The square root of the sum of the squared values. - - - - Calculates the p-norms of all row vectors. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Calculates the p-norms of all column vectors. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Normalizes all row vectors to a unit p-norm. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Normalizes all column vectors to a unit p-norm. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Calculates the value sum of each row vector. - - - - - Calculates the absolute value sum of each row vector. - - - - - Calculates the value sum of each column vector. - - - - - Calculates the absolute value sum of each column vector. - - - - - Evaluates whether this matrix is Hermitian (conjugate symmetric). - - - - - A Bi-Conjugate Gradient stabilized iterative matrix solver. - - - - The Bi-Conjugate Gradient Stabilized (BiCGStab) solver is an 'improvement' - of the standard Conjugate Gradient (CG) solver. Unlike the CG solver the - BiCGStab can be used on non-symmetric matrices.
    - Note that much of the success of the solver depends on the selection of the - proper preconditioner. -
    - - The Bi-CGSTAB algorithm was taken from:
    - Templates for the solution of linear systems: Building blocks - for iterative methods -
    - Richard Barrett, Michael Berry, Tony F. Chan, James Demmel, - June M. Donato, Jack Dongarra, Victor Eijkhout, Roldan Pozo, - Charles Romine and Henk van der Vorst -
    - Url: http://www.netlib.org/templates/Templates.html -
    - Algorithm is described in Chapter 2, section 2.3.8, page 27 -
    - - The example code below provides an indication of the possible use of the - solver. - -
    -
    - - - Calculates the true residual of the matrix equation Ax = b according to: residual = b - Ax - - Instance of the A. - Residual values in . - Instance of the x. - Instance of the b. - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient , A. - The solution , b. - The result , x. - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - A composite matrix solver. The actual solver is made by a sequence of - matrix solvers. - - - - Solver based on:
    - Faster PDE-based simulations using robust composite linear solvers
    - S. Bhowmicka, P. Raghavan a,*, L. McInnes b, B. Norris
    - Future Generation Computer Systems, Vol 20, 2004, pp 373�387
    -
    - - Note that if an iterator is passed to this solver it will be used for all the sub-solvers. - -
    -
    - - - The collection of solvers that will be used - - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient matrix, A. - The solution vector, b - The result vector, x - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - A diagonal preconditioner. The preconditioner uses the inverse - of the matrix diagonal as preconditioning values. - - - - - The inverse of the matrix diagonal. - - - - - Returns the decomposed matrix diagonal. - - The matrix diagonal. - - - - Initializes the preconditioner and loads the internal data structures. - - - The upon which this preconditioner is based. - If is . - If is not a square matrix. - - - - Approximates the solution to the matrix equation Ax = b. - - The right hand side vector. - The left hand side vector. Also known as the result vector. - - - - A Generalized Product Bi-Conjugate Gradient iterative matrix solver. - - - - The Generalized Product Bi-Conjugate Gradient (GPBiCG) solver is an - alternative version of the Bi-Conjugate Gradient stabilized (CG) solver. - Unlike the CG solver the GPBiCG solver can be used on - non-symmetric matrices.
    - Note that much of the success of the solver depends on the selection of the - proper preconditioner. -
    - - The GPBiCG algorithm was taken from:
    - GPBiCG(m,l): A hybrid of BiCGSTAB and GPBiCG methods with - efficiency and robustness -
    - S. Fujino -
    - Applied Numerical Mathematics, Volume 41, 2002, pp 107 - 117 -
    -
    - - The example code below provides an indication of the possible use of the - solver. - -
    -
    - - - Indicates the number of BiCGStab steps should be taken - before switching. - - - - - Indicates the number of GPBiCG steps should be taken - before switching. - - - - - Gets or sets the number of steps taken with the BiCgStab algorithm - before switching over to the GPBiCG algorithm. - - - - - Gets or sets the number of steps taken with the GPBiCG algorithm - before switching over to the BiCgStab algorithm. - - - - - Calculates the true residual of the matrix equation Ax = b according to: residual = b - Ax - - Instance of the A. - Residual values in . - Instance of the x. - Instance of the b. - - - - Decide if to do steps with BiCgStab - - Number of iteration - true if yes, otherwise false - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient matrix, A. - The solution vector, b - The result vector, x - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - An incomplete, level 0, LU factorization preconditioner. - - - The ILU(0) algorithm was taken from:
    - Iterative methods for sparse linear systems
    - Yousef Saad
    - Algorithm is described in Chapter 10, section 10.3.2, page 275
    -
    -
    - - - The matrix holding the lower (L) and upper (U) matrices. The - decomposition matrices are combined to reduce storage. - - - - - Returns the upper triagonal matrix that was created during the LU decomposition. - - A new matrix containing the upper triagonal elements. - - - - Returns the lower triagonal matrix that was created during the LU decomposition. - - A new matrix containing the lower triagonal elements. - - - - Initializes the preconditioner and loads the internal data structures. - - The matrix upon which the preconditioner is based. - If is . - If is not a square matrix. - - - - Approximates the solution to the matrix equation Ax = b. - - The right hand side vector. - The left hand side vector. Also known as the result vector. - - - - This class performs an Incomplete LU factorization with drop tolerance - and partial pivoting. The drop tolerance indicates which additional entries - will be dropped from the factorized LU matrices. - - - The ILUTP-Mem algorithm was taken from:
    - ILUTP_Mem: a Space-Efficient Incomplete LU Preconditioner -
    - Tzu-Yi Chen, Department of Mathematics and Computer Science,
    - Pomona College, Claremont CA 91711, USA
    - Published in:
    - Lecture Notes in Computer Science
    - Volume 3046 / 2004
    - pp. 20 - 28
    - Algorithm is described in Section 2, page 22 -
    -
    - - - The default fill level. - - - - - The default drop tolerance. - - - - - The decomposed upper triangular matrix. - - - - - The decomposed lower triangular matrix. - - - - - The array containing the pivot values. - - - - - The fill level. - - - - - The drop tolerance. - - - - - The pivot tolerance. - - - - - Initializes a new instance of the class with the default settings. - - - - - Initializes a new instance of the class with the specified settings. - - - The amount of fill that is allowed in the matrix. The value is a fraction of - the number of non-zero entries in the original matrix. Values should be positive. - - - The absolute drop tolerance which indicates below what absolute value an entry - will be dropped from the matrix. A drop tolerance of 0.0 means that no values - will be dropped. Values should always be positive. - - - The pivot tolerance which indicates at what level pivoting will take place. A - value of 0.0 means that no pivoting will take place. - - - - - Gets or sets the amount of fill that is allowed in the matrix. The - value is a fraction of the number of non-zero entries in the original - matrix. The standard value is 200. - - - - Values should always be positive and can be higher than 1.0. A value lower - than 1.0 means that the eventual preconditioner matrix will have fewer - non-zero entries as the original matrix. A value higher than 1.0 means that - the eventual preconditioner can have more non-zero values than the original - matrix. - - - Note that any changes to the FillLevel after creating the preconditioner - will invalidate the created preconditioner and will require a re-initialization of - the preconditioner. - - - Thrown if a negative value is provided. - - - - Gets or sets the absolute drop tolerance which indicates below what absolute value - an entry will be dropped from the matrix. The standard value is 0.0001. - - - - The values should always be positive and can be larger than 1.0. A low value will - keep more small numbers in the preconditioner matrix. A high value will remove - more small numbers from the preconditioner matrix. - - - Note that any changes to the DropTolerance after creating the preconditioner - will invalidate the created preconditioner and will require a re-initialization of - the preconditioner. - - - Thrown if a negative value is provided. - - - - Gets or sets the pivot tolerance which indicates at what level pivoting will - take place. The standard value is 0.0 which means pivoting will never take place. - - - - The pivot tolerance is used to calculate if pivoting is necessary. Pivoting - will take place if any of the values in a row is bigger than the - diagonal value of that row divided by the pivot tolerance, i.e. pivoting - will take place if row(i,j) > row(i,i) / PivotTolerance for - any j that is not equal to i. - - - Note that any changes to the PivotTolerance after creating the preconditioner - will invalidate the created preconditioner and will require a re-initialization of - the preconditioner. - - - Thrown if a negative value is provided. - - - - Returns the upper triagonal matrix that was created during the LU decomposition. - - - This method is used for debugging purposes only and should normally not be used. - - A new matrix containing the upper triagonal elements. - - - - Returns the lower triagonal matrix that was created during the LU decomposition. - - - This method is used for debugging purposes only and should normally not be used. - - A new matrix containing the lower triagonal elements. - - - - Returns the pivot array. This array is not needed for normal use because - the preconditioner will return the solution vector values in the proper order. - - - This method is used for debugging purposes only and should normally not be used. - - The pivot array. - - - - Initializes the preconditioner and loads the internal data structures. - - - The upon which this preconditioner is based. Note that the - method takes a general matrix type. However internally the data is stored - as a sparse matrix. Therefore it is not recommended to pass a dense matrix. - - If is . - If is not a square matrix. - - - - Pivot elements in the according to internal pivot array - - Row to pivot in - - - - Was pivoting already performed - - Pivots already done - Current item to pivot - true if performed, otherwise false - - - - Swap columns in the - - Source . - First column index to swap - Second column index to swap - - - - Sort vector descending, not changing vector but placing sorted indices to - - Start sort form - Sort till upper bound - Array with sorted vector indices - Source - - - - Approximates the solution to the matrix equation Ax = b. - - The right hand side vector. - The left hand side vector. Also known as the result vector. - - - - Pivot elements in according to internal pivot array - - Source . - Result after pivoting. - - - - An element sort algorithm for the class. - - - This sort algorithm is used to sort the columns in a sparse matrix based on - the value of the element on the diagonal of the matrix. - - - - - Sorts the elements of the vector in decreasing - fashion. The vector itself is not affected. - - The starting index. - The stopping index. - An array that will contain the sorted indices once the algorithm finishes. - The that contains the values that need to be sorted. - - - - Sorts the elements of the vector in decreasing - fashion using heap sort algorithm. The vector itself is not affected. - - The starting index. - The stopping index. - An array that will contain the sorted indices once the algorithm finishes. - The that contains the values that need to be sorted. - - - - Build heap for double indices - - Root position - Length of - Indices of - Target - - - - Sift double indices - - Indices of - Target - Root position - Length of - - - - Sorts the given integers in a decreasing fashion. - - The values. - - - - Sort the given integers in a decreasing fashion using heapsort algorithm - - Array of values to sort - Length of - - - - Build heap - - Target values array - Root position - Length of - - - - Sift values - - Target value array - Root position - Length of - - - - Exchange values in array - - Target values array - First value to exchange - Second value to exchange - - - - A simple milu(0) preconditioner. - - - Original Fortran code by Yousef Saad (07 January 2004) - - - - Use modified or standard ILU(0) - - - - Gets or sets a value indicating whether to use modified or standard ILU(0). - - - - - Gets a value indicating whether the preconditioner is initialized. - - - - - Initializes the preconditioner and loads the internal data structures. - - The matrix upon which the preconditioner is based. - If is . - If is not a square or is not an - instance of SparseCompressedRowMatrixStorage. - - - - Approximates the solution to the matrix equation Ax = b. - - The right hand side vector b. - The left hand side vector x. - - - - MILU0 is a simple milu(0) preconditioner. - - Order of the matrix. - Matrix values in CSR format (input). - Column indices (input). - Row pointers (input). - Matrix values in MSR format (output). - Row pointers and column indices (output). - Pointer to diagonal elements (output). - True if the modified/MILU algorithm should be used (recommended) - Returns 0 on success or k > 0 if a zero pivot was encountered at step k. - - - - A Multiple-Lanczos Bi-Conjugate Gradient stabilized iterative matrix solver. - - - - The Multiple-Lanczos Bi-Conjugate Gradient stabilized (ML(k)-BiCGStab) solver is an 'improvement' - of the standard BiCgStab solver. - - - The algorithm was taken from:
    - ML(k)BiCGSTAB: A BiCGSTAB variant based on multiple Lanczos starting vectors -
    - Man-Chung Yeung and Tony F. Chan -
    - SIAM Journal of Scientific Computing -
    - Volume 21, Number 4, pp. 1263 - 1290 -
    - - The example code below provides an indication of the possible use of the - solver. - -
    -
    - - - The default number of starting vectors. - - - - - The collection of starting vectors which are used as the basis for the Krylov sub-space. - - - - - The number of starting vectors used by the algorithm - - - - - Gets or sets the number of starting vectors. - - - Must be larger than 1 and smaller than the number of variables in the matrix that - for which this solver will be used. - - - - - Resets the number of starting vectors to the default value. - - - - - Gets or sets a series of orthonormal vectors which will be used as basis for the - Krylov sub-space. - - - - - Gets the number of starting vectors to create - - Maximum number - Number of variables - Number of starting vectors to create - - - - Returns an array of starting vectors. - - The maximum number of starting vectors that should be created. - The number of variables. - - An array with starting vectors. The array will never be larger than the - but it may be smaller if - the is smaller than - the . - - - - - Create random vectors array - - Number of vectors - Size of each vector - Array of random vectors - - - - Calculates the true residual of the matrix equation Ax = b according to: residual = b - Ax - - Source A. - Residual data. - x data. - b data. - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient matrix, A. - The solution vector, b - The result vector, x - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - A Transpose Free Quasi-Minimal Residual (TFQMR) iterative matrix solver. - - - - The TFQMR algorithm was taken from:
    - Iterative methods for sparse linear systems. -
    - Yousef Saad -
    - Algorithm is described in Chapter 7, section 7.4.3, page 219 -
    - - The example code below provides an indication of the possible use of the - solver. - -
    -
    - - - Calculates the true residual of the matrix equation Ax = b according to: residual = b - Ax - - Instance of the A. - Residual values in . - Instance of the x. - Instance of the b. - - - - Is even? - - Number to check - true if even, otherwise false - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient matrix, A. - The solution vector, b - The result vector, x - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - A Matrix with sparse storage, intended for very large matrices where most of the cells are zero. - The underlying storage scheme is 3-array compressed-sparse-row (CSR) Format. - Wikipedia - CSR. - - - - - Gets the number of non zero elements in the matrix. - - The number of non zero elements. - - - - Create a new sparse matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new square sparse matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the order is less than one. - - - - Create a new sparse matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the row or column count is less than one. - - - - Create a new sparse matrix as a copy of the given other matrix. - This new matrix will be independent from the other matrix. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given two-dimensional array. - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable. - The enumerable is assumed to be in row-major order (row by row). - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - - Create a new sparse matrix with the given number of rows and columns as a copy of the given array. - The array is assumed to be in column-major order (column by column). - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix and initialize each value to the same provided value. - - - - - Create a new sparse matrix and initialize each value using the provided init function. - - - - - Create a new diagonal sparse matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal sparse matrix and initialize each diagonal value using the provided init function. - - - - - Create a new square sparse identity matrix where each diagonal value is set to One. - - - - - Returns a new matrix containing the lower triangle of this matrix. - - The lower triangle of this matrix. - - - - Puts the lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Puts the lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - - - - Returns a new matrix containing the upper triangle of this matrix. - - The upper triangle of this matrix. - - - - Puts the upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Puts the upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - - - - Returns a new matrix containing the lower triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The lower triangle of this matrix. - - - - Puts the strictly lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Puts the strictly lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - - - - Returns a new matrix containing the upper triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The upper triangle of this matrix. - - - - Puts the strictly upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Puts the strictly upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - - - Calculates the induced infinity norm of this matrix. - The maximum absolute row sum of the matrix. - - - Calculates the entry-wise Frobenius norm of this matrix. - The square root of the sum of the squared values. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of the addition. - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract to this matrix. - The matrix to store the result of subtraction. - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. - - The matrix to pointwise multiply with this one. - The matrix to store the result of the pointwise multiplication. - - - - Pointwise divide this matrix by another matrix and stores the result into the result matrix. - - The matrix to pointwise divide this one by. - The matrix to store the result of the pointwise division. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Evaluates whether this matrix is symmetric. - - - - - Adds two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to add. - The right matrix to add. - The result of the addition. - If and don't have the same dimensions. - If or is . - - - - Returns a Matrix containing the same values of . - - The matrix to get the values from. - A matrix containing a the same values as . - If is . - - - - Subtracts two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to subtract. - The right matrix to subtract. - The result of the addition. - If and don't have the same dimensions. - If or is . - - - - Negates each element of the matrix. - - The matrix to negate. - A matrix containing the negated values. - If is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies two matrices. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to multiply. - The right matrix to multiply. - The result of multiplication. - If or is . - If the dimensions of or don't conform. - - - - Multiplies a Matrix and a Vector. - - The matrix to multiply. - The vector to multiply. - The result of multiplication. - If or is . - - - - Multiplies a Vector and a Matrix. - - The vector to multiply. - The matrix to multiply. - The result of multiplication. - If or is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - A vector with sparse storage, intended for very large vectors where most of the cells are zero. - - The sparse vector is not thread safe. - - - - Gets the number of non zero elements in the vector. - - The number of non zero elements. - - - - Create a new sparse vector straight from an initialized vector storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new sparse vector with the given length. - All cells of the vector will be initialized to zero. - - If length is less than one. - - - - Create a new sparse vector as a copy of the given other vector. - This new vector will be independent from the other vector. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given enumerable. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector and initialize each value using the provided value. - - - - - Create a new sparse vector and initialize each value using the provided init function. - - - - - Adds a scalar to each element of the vector and stores the result in the result vector. - Warning, the new 'sparse vector' with a non-zero scalar added to it will be a 100% filled - sparse vector and very inefficient. Would be better to work with a dense vector instead. - - - The scalar to add. - - - The vector to store the result of the addition. - - - - - Adds another vector to this vector and stores the result into the result vector. - - - The vector to add to this one. - - - The vector to store the result of the addition. - - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - - The scalar to subtract. - - - The vector to store the result of the subtraction. - - - - - Subtracts another vector to this vector and stores the result into the result vector. - - - The vector to subtract from this one. - - - The vector to store the result of the subtraction. - - - - - Negates vector and saves result to - - Target vector - - - - Multiplies a scalar to each element of the vector and stores the result in the result vector. - - - The scalar to multiply. - - - The vector to store the result of the multiplication. - - - - - Computes the dot product between this vector and another vector. - - The other vector. - The sum of a[i]*b[i] for all i. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Adds two Vectors together and returns the results. - - One of the vectors to add. - The other vector to add. - The result of the addition. - If and are not the same size. - If or is . - - - - Returns a Vector containing the negated values of . - - The vector to get the values from. - A vector containing the negated values as . - If is . - - - - Subtracts two Vectors and returns the results. - - The vector to subtract from. - The vector to subtract. - The result of the subtraction. - If and are not the same size. - If or is . - - - - Multiplies a vector with a scalar. - - The vector to scale. - The scalar value. - The result of the multiplication. - If is . - - - - Multiplies a vector with a scalar. - - The scalar value. - The vector to scale. - The result of the multiplication. - If is . - - - - Computes the dot product between two Vectors. - - The left row vector. - The right column vector. - The dot product between the two vectors. - If and are not the same size. - If or is . - - - - Divides a vector with a scalar. - - The vector to divide. - The scalar value. - The result of the division. - If is . - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - of each element of the vector of the given divisor. - - The vector whose elements we want to compute the modulus of. - The divisor to use, - The result of the calculation - If is . - - - - Returns the index of the absolute minimum element. - - The index of absolute minimum element. - - - - Returns the index of the absolute maximum element. - - The index of absolute maximum element. - - - - Returns the index of the maximum element. - - The index of maximum element. - - - - Returns the index of the minimum element. - - The index of minimum element. - - - - Computes the sum of the vector's elements. - - The sum of the vector's elements. - - - - Calculates the L1 norm of the vector, also known as Manhattan norm. - - The sum of the absolute values. - - - - Calculates the infinity norm of the vector. - - The maximum absolute value. - - - - Computes the p-Norm. - - The p value. - Scalar ret = ( ∑|this[i]|^p )^(1/p) - - - - Pointwise multiplies this vector with another vector and stores the result into the result vector. - - The vector to pointwise multiply with this one. - The vector to store the result of the pointwise multiplication. - - - - Creates a double sparse vector based on a string. The string can be in the following formats (without the - quotes): 'n', 'n,n,..', '(n,n,..)', '[n,n,...]', where n is a double. - - - A double sparse vector containing the values specified by the given string. - - - the string to parse. - - - An that supplies culture-specific formatting information. - - - - - Converts the string representation of a real sparse vector to double-precision sparse vector equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a real vector to convert. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will be null. - - - - - Converts the string representation of a real sparse vector to double-precision sparse vector equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a real vector to convert. - - - An that supplies culture-specific formatting information about value. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will be null. - - - - - double version of the class. - - - - - Initializes a new instance of the Vector class. - - - - - Set all values whose absolute value is smaller than the threshold to zero. - - - - - Conjugates vector and save result to - - Target vector - - - - Negates vector and saves result to - - Target vector - - - - Adds a scalar to each element of the vector and stores the result in the result vector. - - - The scalar to add. - - - The vector to store the result of the addition. - - - - - Adds another vector to this vector and stores the result into the result vector. - - - The vector to add to this one. - - - The vector to store the result of the addition. - - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - - The scalar to subtract. - - - The vector to store the result of the subtraction. - - - - - Subtracts another vector to this vector and stores the result into the result vector. - - - The vector to subtract from this one. - - - The vector to store the result of the subtraction. - - - - - Multiplies a scalar to each element of the vector and stores the result in the result vector. - - - The scalar to multiply. - - - The vector to store the result of the multiplication. - - - - - Divides each element of the vector by a scalar and stores the result in the result vector. - - - The scalar to divide with. - - - The vector to store the result of the division. - - - - - Divides a scalar by each element of the vector and stores the result in the result vector. - - The scalar to divide. - The vector to store the result of the division. - - - - Pointwise multiplies this vector with another vector and stores the result into the result vector. - - The vector to pointwise multiply with this one. - The vector to store the result of the pointwise multiplication. - - - - Pointwise divide this vector with another vector and stores the result into the result vector. - - The vector to pointwise divide this one by. - The vector to store the result of the pointwise division. - - - - Pointwise raise this vector to an exponent and store the result into the result vector. - - The exponent to raise this vector values to. - The vector to store the result of the pointwise power. - - - - Pointwise raise this vector to an exponent vector and store the result into the result vector. - - The exponent vector to raise this vector values to. - The vector to store the result of the pointwise power. - - - - Pointwise canonical modulus, where the result has the sign of the divisor, - of this vector with another vector and stores the result into the result vector. - - The pointwise denominator vector to use. - The result of the modulus. - - - - Pointwise remainder (% operator), where the result has the sign of the dividend, - of this vector with another vector and stores the result into the result vector. - - The pointwise denominator vector to use. - The result of the modulus. - - - - Pointwise applies the exponential function to each value and stores the result into the result vector. - - The vector to store the result. - - - - Pointwise applies the natural logarithm function to each value and stores the result into the result vector. - - The vector to store the result. - - - - Computes the dot product between this vector and another vector. - - The other vector. - The sum of a[i]*b[i] for all i. - - - - Computes the dot product between the conjugate of this vector and another vector. - - The other vector. - The sum of conj(a[i])*b[i] for all i. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given dividend for each element of the vector. - - The scalar numerator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given dividend for each element of the vector. - - The scalar numerator to use. - A vector to store the results in. - - - - Returns the value of the absolute minimum element. - - The value of the absolute minimum element. - - - - Returns the index of the absolute minimum element. - - The index of absolute minimum element. - - - - Returns the value of the absolute maximum element. - - The value of the absolute maximum element. - - - - Returns the index of the absolute maximum element. - - The index of absolute maximum element. - - - - Computes the sum of the vector's elements. - - The sum of the vector's elements. - - - - Calculates the L1 norm of the vector, also known as Manhattan norm. - - The sum of the absolute values. - - - - Calculates the L2 norm of the vector, also known as Euclidean norm. - - The square root of the sum of the squared values. - - - - Calculates the infinity norm of the vector. - - The maximum absolute value. - - - - Computes the p-Norm. - - - The p value. - - - Scalar ret = ( ∑|At(i)|^p )^(1/p) - - - - - Returns the index of the maximum element. - - The index of maximum element. - - - - Returns the index of the minimum element. - - The index of minimum element. - - - - Normalizes this vector to a unit vector with respect to the p-norm. - - - The p value. - - - This vector normalized to a unit vector with respect to the p-norm. - - - - - A Matrix class with dense storage. The underlying storage is a one dimensional array in column-major order (column by column). - - - - - Number of rows. - - Using this instead of the RowCount property to speed up calculating - a matrix index in the data array. - - - - Number of columns. - - Using this instead of the ColumnCount property to speed up calculating - a matrix index in the data array. - - - - Gets the matrix's data. - - The matrix's data. - - - - Create a new dense matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new square dense matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the order is less than one. - - - - Create a new dense matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the row or column count is less than one. - - - - Create a new dense matrix with the given number of rows and columns directly binding to a raw array. - The array is assumed to be in column-major order (column by column) and is used directly without copying. - Very efficient, but changes to the array and the matrix will affect each other. - - - - - - Create a new dense matrix as a copy of the given other matrix. - This new matrix will be independent from the other matrix. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given two-dimensional array. - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable. - The enumerable is assumed to be in column-major order (column by column). - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix and initialize each value to the same provided value. - - - - - Create a new dense matrix and initialize each value using the provided init function. - - - - - Create a new diagonal dense matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal dense matrix and initialize each diagonal value using the provided init function. - - - - - Create a new square sparse identity matrix where each diagonal value is set to One. - - - - - Create a new dense matrix with values sampled from the provided random distribution. - - - - - Gets the matrix's data. - - The matrix's data. - - - Calculates the induced L1 norm of this matrix. - The maximum absolute column sum of the matrix. - - - Calculates the induced infinity norm of this matrix. - The maximum absolute row sum of the matrix. - - - Calculates the entry-wise Frobenius norm of this matrix. - The square root of the sum of the squared values. - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - - - - Add a scalar to each element of the matrix and stores the result in the result vector. - - The scalar to add. - The matrix to store the result of the addition. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of add - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Subtracts a scalar from each element of the matrix and stores the result in the result vector. - - The scalar to subtract. - The matrix to store the result of the subtraction. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract. - The matrix to store the result of the subtraction. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Divides each element of the matrix by a scalar and places results into the result matrix. - - The scalar to divide the matrix with. - The matrix to store the result of the division. - - - - Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. - - The matrix to pointwise multiply with this one. - The matrix to store the result of the pointwise multiplication. - - - - Pointwise divide this matrix by another matrix and stores the result into the result matrix. - - The matrix to pointwise divide this one by. - The matrix to store the result of the pointwise division. - - - - Pointwise raise this matrix to an exponent and store the result into the result matrix. - - The exponent to raise this matrix values to. - The vector to store the result of the pointwise power. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - Computes the trace of this matrix. - - The trace of this matrix - If the matrix is not square - - - - Adds two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to add. - The right matrix to add. - The result of the addition. - If and don't have the same dimensions. - If or is . - - - - Returns a Matrix containing the same values of . - - The matrix to get the values from. - A matrix containing a the same values as . - If is . - - - - Subtracts two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to subtract. - The right matrix to subtract. - The result of the addition. - If and don't have the same dimensions. - If or is . - - - - Negates each element of the matrix. - - The matrix to negate. - A matrix containing the negated values. - If is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies two matrices. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to multiply. - The right matrix to multiply. - The result of multiplication. - If or is . - If the dimensions of or don't conform. - - - - Multiplies a Matrix and a Vector. - - The matrix to multiply. - The vector to multiply. - The result of multiplication. - If or is . - - - - Multiplies a Vector and a Matrix. - - The vector to multiply. - The matrix to multiply. - The result of multiplication. - If or is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Evaluates whether this matrix is symmetric. - - - - - A vector using dense storage. - - - - - Number of elements - - - - - Gets the vector's data. - - - - - Create a new dense vector straight from an initialized vector storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new dense vector with the given length. - All cells of the vector will be initialized to zero. - - If length is less than one. - - - - Create a new dense vector directly binding to a raw array. - The array is used directly without copying. - Very efficient, but changes to the array and the vector will affect each other. - - - - - Create a new dense vector as a copy of the given other vector. - This new vector will be independent from the other vector. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given array. - This new vector will be independent from the array. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given enumerable. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector and initialize each value using the provided value. - - - - - Create a new dense vector and initialize each value using the provided init function. - - - - - Create a new dense vector with values sampled from the provided random distribution. - - - - - Gets the vector's data. - - The vector's data. - - - - Returns a reference to the internal data structure. - - The DenseVector whose internal data we are - returning. - - A reference to the internal date of the given vector. - - - - - Returns a vector bound directly to a reference of the provided array. - - The array to bind to the DenseVector object. - - A DenseVector whose values are bound to the given array. - - - - - Adds a scalar to each element of the vector and stores the result in the result vector. - - The scalar to add. - The vector to store the result of the addition. - - - - Adds another vector to this vector and stores the result into the result vector. - - The vector to add to this one. - The vector to store the result of the addition. - - - - Adds two Vectors together and returns the results. - - One of the vectors to add. - The other vector to add. - The result of the addition. - If and are not the same size. - If or is . - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - The scalar to subtract. - The vector to store the result of the subtraction. - - - - Subtracts another vector from this vector and stores the result into the result vector. - - The vector to subtract from this one. - The vector to store the result of the subtraction. - - - - Returns a Vector containing the negated values of . - - The vector to get the values from. - A vector containing the negated values as . - If is . - - - - Subtracts two Vectors and returns the results. - - The vector to subtract from. - The vector to subtract. - The result of the subtraction. - If and are not the same size. - If or is . - - - - Negates vector and saves result to - - Target vector - - - - Multiplies a scalar to each element of the vector and stores the result in the result vector. - - The scalar to multiply. - The vector to store the result of the multiplication. - - - - - Computes the dot product between this vector and another vector. - - The other vector. - The sum of a[i]*b[i] for all i. - - - - Multiplies a vector with a scalar. - - The vector to scale. - The scalar value. - The result of the multiplication. - If is . - - - - Multiplies a vector with a scalar. - - The scalar value. - The vector to scale. - The result of the multiplication. - If is . - - - - Computes the dot product between two Vectors. - - The left row vector. - The right column vector. - The dot product between the two vectors. - If and are not the same size. - If or is . - - - - Divides a vector with a scalar. - - The vector to divide. - The scalar value. - The result of the division. - If is . - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - of each element of the vector of the given divisor. - - The vector whose elements we want to compute the modulus of. - The divisor to use, - The result of the calculation - If is . - - - - Returns the index of the absolute minimum element. - - The index of absolute minimum element. - - - - Returns the index of the absolute maximum element. - - The index of absolute maximum element. - - - - Returns the index of the maximum element. - - The index of maximum element. - - - - Returns the index of the minimum element. - - The index of minimum element. - - - - Computes the sum of the vector's elements. - - The sum of the vector's elements. - - - - Calculates the L1 norm of the vector, also known as Manhattan norm. - - The sum of the absolute values. - - - - Calculates the L2 norm of the vector, also known as Euclidean norm. - - The square root of the sum of the squared values. - - - - Calculates the infinity norm of the vector. - - The maximum absolute value. - - - - Computes the p-Norm. - - The p value. - Scalar ret = ( ∑|this[i]|^p )^(1/p) - - - - Pointwise multiply this vector with another vector and stores the result into the result vector. - - The vector to pointwise multiply this one by. - The vector to store the result of the pointwise multiplication. - - - - Pointwise divide this vector with another vector and stores the result into the result vector. - - The vector to pointwise divide this one by. - The vector to store the result of the pointwise division. - - - - - Pointwise raise this vector to an exponent vector and store the result into the result vector. - - The exponent vector to raise this vector values to. - The vector to store the result of the pointwise power. - - - - Creates a float dense vector based on a string. The string can be in the following formats (without the - quotes): 'n', 'n,n,..', '(n,n,..)', '[n,n,...]', where n is a float. - - - A float dense vector containing the values specified by the given string. - - - the string to parse. - - - An that supplies culture-specific formatting information. - - - - - Converts the string representation of a real dense vector to float-precision dense vector equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a real vector to convert. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will be null. - - - - - Converts the string representation of a real dense vector to float-precision dense vector equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a real vector to convert. - - - An that supplies culture-specific formatting information about value. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will be null. - - - - - A matrix type for diagonal matrices. - - - Diagonal matrices can be non-square matrices but the diagonal always starts - at element 0,0. A diagonal matrix will throw an exception if non diagonal - entries are set. The exception to this is when the off diagonal elements are - 0.0 or NaN; these settings will cause no change to the diagonal matrix. - - - - - Gets the matrix's data. - - The matrix's data. - - - - Create a new diagonal matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new square diagonal matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the order is less than one. - - - - Create a new diagonal matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the row or column count is less than one. - - - - Create a new diagonal matrix with the given number of rows and columns. - All diagonal cells of the matrix will be initialized to the provided value, all non-diagonal ones to zero. - - If the row or column count is less than one. - - - - Create a new diagonal matrix with the given number of rows and columns directly binding to a raw array. - The array is assumed to contain the diagonal elements only and is used directly without copying. - Very efficient, but changes to the array and the matrix will affect each other. - - - - - Create a new diagonal matrix as a copy of the given other matrix. - This new matrix will be independent from the other matrix. - The matrix to copy from must be diagonal as well. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix as a copy of the given two-dimensional array. - This new matrix will be independent from the provided array. - The array to copy from must be diagonal as well. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix and initialize each diagonal value from the provided indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix and initialize each diagonal value from the provided indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix and initialize each diagonal value from the provided enumerable. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix and initialize each diagonal value using the provided init function. - - - - - Create a new square sparse identity matrix where each diagonal value is set to One. - - - - - Create a new diagonal matrix with diagonal values sampled from the provided random distribution. - - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of the addition. - If the two matrices don't have the same dimensions. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract. - The matrix to store the result of the subtraction. - If the two matrices don't have the same dimensions. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - If the result matrix's dimensions are not the same as this matrix. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Divides each element of the matrix by a scalar and places results into the result matrix. - - The scalar to divide the matrix with. - The matrix to store the result of the division. - - - - Divides a scalar by each element of the matrix and stores the result in the result matrix. - - The scalar to add. - The matrix to store the result of the division. - - - - Computes the determinant of this matrix. - - The determinant of this matrix. - - - - Returns the elements of the diagonal in a . - - The elements of the diagonal. - For non-square matrices, the method returns Min(Rows, Columns) elements where - i == j (i is the row index, and j is the column index). - - - - Copies the values of the given array to the diagonal. - - The array to copy the values from. The length of the vector should be - Min(Rows, Columns). - If the length of does not - equal Min(Rows, Columns). - For non-square matrices, the elements of are copied to - this[i,i]. - - - - Copies the values of the given to the diagonal. - - The vector to copy the values from. The length of the vector should be - Min(Rows, Columns). - If the length of does not - equal Min(Rows, Columns). - For non-square matrices, the elements of are copied to - this[i,i]. - - - Calculates the induced L1 norm of this matrix. - The maximum absolute column sum of the matrix. - - - Calculates the induced L2 norm of the matrix. - The largest singular value of the matrix. - - - Calculates the induced infinity norm of this matrix. - The maximum absolute row sum of the matrix. - - - Calculates the entry-wise Frobenius norm of this matrix. - The square root of the sum of the squared values. - - - Calculates the condition number of this matrix. - The condition number of the matrix. - - - Computes the inverse of this matrix. - If is not a square matrix. - If is singular. - The inverse of this matrix. - - - - Returns a new matrix containing the lower triangle of this matrix. - - The lower triangle of this matrix. - - - - Puts the lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If the result matrix's dimensions are not the same as this matrix. - - - - Returns a new matrix containing the lower triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The lower triangle of this matrix. - - - - Puts the strictly lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If the result matrix's dimensions are not the same as this matrix. - - - - Returns a new matrix containing the upper triangle of this matrix. - - The upper triangle of this matrix. - - - - Puts the upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If the result matrix's dimensions are not the same as this matrix. - - - - Returns a new matrix containing the upper triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The upper triangle of this matrix. - - - - Puts the strictly upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If the result matrix's dimensions are not the same as this matrix. - - - - Creates a matrix that contains the values from the requested sub-matrix. - - The row to start copying from. - The number of rows to copy. Must be positive. - The column to start copying from. - The number of columns to copy. Must be positive. - The requested sub-matrix. - If: is - negative, or greater than or equal to the number of rows. - is negative, or greater than or equal to the number - of columns. - (columnIndex + columnLength) >= Columns - (rowIndex + rowLength) >= Rows - If or - is not positive. - - - - Permute the columns of a matrix according to a permutation. - - The column permutation to apply to this matrix. - Always thrown - Permutation in diagonal matrix are senseless, because of matrix nature - - - - Permute the rows of a matrix according to a permutation. - - The row permutation to apply to this matrix. - Always thrown - Permutation in diagonal matrix are senseless, because of matrix nature - - - - Evaluates whether this matrix is symmetric. - - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - A class which encapsulates the functionality of a Cholesky factorization. - For a symmetric, positive definite matrix A, the Cholesky factorization - is an lower triangular matrix L so that A = L*L'. - - - The computation of the Cholesky factorization is done at construction time. If the matrix is not symmetric - or positive definite, the constructor will throw an exception. - - - - - Gets the determinant of the matrix for which the Cholesky matrix was computed. - - - - - Gets the log determinant of the matrix for which the Cholesky matrix was computed. - - - - - A class which encapsulates the functionality of a Cholesky factorization for dense matrices. - For a symmetric, positive definite matrix A, the Cholesky factorization - is an lower triangular matrix L so that A = L*L'. - - - The computation of the Cholesky factorization is done at construction time. If the matrix is not symmetric - or positive definite, the constructor will throw an exception. - - - - - Initializes a new instance of the class. This object will compute the - Cholesky factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - If is null. - If is not a square matrix. - If is not positive definite. - - - - Solves a system of linear equations, AX = B, with A Cholesky factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A Cholesky factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Calculates the Cholesky factorization of the input matrix. - - The matrix to be factorized. - If is null. - If is not a square matrix. - If is not positive definite. - If does not have the same dimensions as the existing factor. - - - - Eigenvalues and eigenvectors of a real matrix. - - - If A is symmetric, then A = V*D*V' where the eigenvalue matrix D is - diagonal and the eigenvector matrix V is orthogonal. - I.e. A = V*D*V' and V*VT=I. - If A is not symmetric, then the eigenvalue matrix D is block diagonal - with the real eigenvalues in 1-by-1 blocks and any complex eigenvalues, - lambda + i*mu, in 2-by-2 blocks, [lambda, mu; -mu, lambda]. The - columns of V represent the eigenvectors in the sense that A*V = V*D, - i.e. A.Multiply(V) equals V.Multiply(D). The matrix V may be badly - conditioned, or even singular, so the validity of the equation - A = V*D*Inverse(V) depends upon V.Condition(). - - - - - Initializes a new instance of the class. This object will compute the - the eigenvalue decomposition when the constructor is called and cache it's decomposition. - - The matrix to factor. - If it is known whether the matrix is symmetric or not the routine can skip checking it itself. - If is null. - If EVD algorithm failed to converge with matrix . - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A EVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the QR decomposition Modified Gram-Schmidt Orthogonalization. - Any real square matrix A may be decomposed as A = QR where Q is an orthogonal mxn matrix and R is an nxn upper triangular matrix. - - - The computation of the QR decomposition is done at construction time by modified Gram-Schmidt Orthogonalization. - - - - - Initializes a new instance of the class. This object creates an orthogonal matrix - using the modified Gram-Schmidt method. - - The matrix to factor. - If is null. - If row count is less then column count - If is rank deficient - - - - Factorize matrix using the modified Gram-Schmidt method. - - Initial matrix. On exit is replaced by Q. - Number of rows in Q. - Number of columns in Q. - On exit is filled by R. - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of an LU factorization. - For a matrix A, the LU factorization is a pair of lower triangular matrix L and - upper triangular matrix U so that A = L*U. - - - The computation of the LU factorization is done at construction time. - - - - - Initializes a new instance of the class. This object will compute the - LU factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - If is null. - If is not a square matrix. - - - - Solves a system of linear equations, AX = B, with A LU factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A LU factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Returns the inverse of this matrix. The inverse is calculated using LU decomposition. - - The inverse of this matrix. - - - - A class which encapsulates the functionality of the QR decomposition. - Any real square matrix A may be decomposed as A = QR where Q is an orthogonal matrix - (its columns are orthogonal unit vectors meaning QTQ = I) and R is an upper triangular matrix - (also called right triangular matrix). - - - The computation of the QR decomposition is done at construction time by Householder transformation. - - - - - Gets or sets Tau vector. Contains additional information on Q - used for native solver. - - - - - Initializes a new instance of the class. This object will compute the - QR factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - The QR factorization method to use. - If is null. - If row count is less then column count - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the singular value decomposition (SVD) for . - Suppose M is an m-by-n matrix whose entries are real numbers. - Then there exists a factorization of the form M = UΣVT where: - - U is an m-by-m unitary matrix; - - Σ is m-by-n diagonal matrix with nonnegative real numbers on the diagonal; - - VT denotes transpose of V, an n-by-n unitary matrix; - Such a factorization is called a singular-value decomposition of M. A common convention is to order the diagonal - entries Σ(i,i) in descending order. In this case, the diagonal matrix Σ is uniquely determined - by M (though the matrices U and V are not). The diagonal entries of Σ are known as the singular values of M. - - - The computation of the singular value decomposition is done at construction time. - - - - - Initializes a new instance of the class. This object will compute the - the singular value decomposition when the constructor is called and cache it's decomposition. - - The matrix to factor. - Compute the singular U and VT vectors or not. - If is null. - If SVD algorithm failed to converge with matrix . - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A SVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Eigenvalues and eigenvectors of a real matrix. - - - If A is symmetric, then A = V*D*V' where the eigenvalue matrix D is - diagonal and the eigenvector matrix V is orthogonal. - I.e. A = V*D*V' and V*VT=I. - If A is not symmetric, then the eigenvalue matrix D is block diagonal - with the real eigenvalues in 1-by-1 blocks and any complex eigenvalues, - lambda + i*mu, in 2-by-2 blocks, [lambda, mu; -mu, lambda]. The - columns of V represent the eigenvectors in the sense that A*V = V*D, - i.e. A.Multiply(V) equals V.Multiply(D). The matrix V may be badly - conditioned, or even singular, so the validity of the equation - A = V*D*Inverse(V) depends upon V.Condition(). - - - - - Gets the absolute value of determinant of the square matrix for which the EVD was computed. - - - - - Gets the effective numerical matrix rank. - - The number of non-negligible singular values. - - - - Gets a value indicating whether the matrix is full rank or not. - - true if the matrix is full rank; otherwise false. - - - - A class which encapsulates the functionality of the QR decomposition Modified Gram-Schmidt Orthogonalization. - Any real square matrix A may be decomposed as A = QR where Q is an orthogonal mxn matrix and R is an nxn upper triangular matrix. - - - The computation of the QR decomposition is done at construction time by modified Gram-Schmidt Orthogonalization. - - - - - Gets the absolute determinant value of the matrix for which the QR matrix was computed. - - - - - Gets a value indicating whether the matrix is full rank or not. - - true if the matrix is full rank; otherwise false. - - - - A class which encapsulates the functionality of an LU factorization. - For a matrix A, the LU factorization is a pair of lower triangular matrix L and - upper triangular matrix U so that A = L*U. - In the Math.NET implementation we also store a set of pivot elements for increased - numerical stability. The pivot elements encode a permutation matrix P such that P*A = L*U. - - - The computation of the LU factorization is done at construction time. - - - - - Gets the determinant of the matrix for which the LU factorization was computed. - - - - - A class which encapsulates the functionality of the QR decomposition. - Any real square matrix A (m x n) may be decomposed as A = QR where Q is an orthogonal matrix - (its columns are orthogonal unit vectors meaning QTQ = I) and R is an upper triangular matrix - (also called right triangular matrix). - - - The computation of the QR decomposition is done at construction time by Householder transformation. - If a factorization is performed, the resulting Q matrix is an m x m matrix - and the R matrix is an m x n matrix. If a factorization is performed, the - resulting Q matrix is an m x n matrix and the R matrix is an n x n matrix. - - - - - Gets the absolute determinant value of the matrix for which the QR matrix was computed. - - - - - Gets a value indicating whether the matrix is full rank or not. - - true if the matrix is full rank; otherwise false. - - - - A class which encapsulates the functionality of the singular value decomposition (SVD). - Suppose M is an m-by-n matrix whose entries are real numbers. - Then there exists a factorization of the form M = UΣVT where: - - U is an m-by-m unitary matrix; - - Σ is m-by-n diagonal matrix with nonnegative real numbers on the diagonal; - - VT denotes transpose of V, an n-by-n unitary matrix; - Such a factorization is called a singular-value decomposition of M. A common convention is to order the diagonal - entries Σ(i,i) in descending order. In this case, the diagonal matrix Σ is uniquely determined - by M (though the matrices U and V are not). The diagonal entries of Σ are known as the singular values of M. - - - The computation of the singular value decomposition is done at construction time. - - - - - Gets the effective numerical matrix rank. - - The number of non-negligible singular values. - - - - Gets the two norm of the . - - The 2-norm of the . - - - - Gets the condition number max(S) / min(S) - - The condition number. - - - - Gets the determinant of the square matrix for which the SVD was computed. - - - - - A class which encapsulates the functionality of a Cholesky factorization for user matrices. - For a symmetric, positive definite matrix A, the Cholesky factorization - is an lower triangular matrix L so that A = L*L'. - - - The computation of the Cholesky factorization is done at construction time. If the matrix is not symmetric - or positive definite, the constructor will throw an exception. - - - - - Computes the Cholesky factorization in-place. - - On entry, the matrix to factor. On exit, the Cholesky factor matrix - If is null. - If is not a square matrix. - If is not positive definite. - - - - Initializes a new instance of the class. This object will compute the - Cholesky factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - If is null. - If is not a square matrix. - If is not positive definite. - - - - Calculates the Cholesky factorization of the input matrix. - - The matrix to be factorized. - If is null. - If is not a square matrix. - If is not positive definite. - If does not have the same dimensions as the existing factor. - - - - Calculate Cholesky step - - Factor matrix - Number of rows - Column start - Total columns - Multipliers calculated previously - Number of available processors - - - - Solves a system of linear equations, AX = B, with A Cholesky factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A Cholesky factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Eigenvalues and eigenvectors of a real matrix. - - - If A is symmetric, then A = V*D*V' where the eigenvalue matrix D is - diagonal and the eigenvector matrix V is orthogonal. - I.e. A = V*D*V' and V*VT=I. - If A is not symmetric, then the eigenvalue matrix D is block diagonal - with the real eigenvalues in 1-by-1 blocks and any complex eigenvalues, - lambda + i*mu, in 2-by-2 blocks, [lambda, mu; -mu, lambda]. The - columns of V represent the eigenvectors in the sense that A*V = V*D, - i.e. A.Multiply(V) equals V.Multiply(D). The matrix V may be badly - conditioned, or even singular, so the validity of the equation - A = V*D*Inverse(V) depends upon V.Condition(). - - - - - Initializes a new instance of the class. This object will compute the - the eigenvalue decomposition when the constructor is called and cache it's decomposition. - - The matrix to factor. - If it is known whether the matrix is symmetric or not the routine can skip checking it itself. - If is null. - If EVD algorithm failed to converge with matrix . - - - - Symmetric Householder reduction to tridiagonal form. - - The eigen vectors to work on. - Arrays for internal storage of real parts of eigenvalues - Arrays for internal storage of imaginary parts of eigenvalues - Order of initial matrix - This is derived from the Algol procedures tred2 by - Bowdler, Martin, Reinsch, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Symmetric tridiagonal QL algorithm. - - The eigen vectors to work on. - Arrays for internal storage of real parts of eigenvalues - Arrays for internal storage of imaginary parts of eigenvalues - Order of initial matrix - This is derived from the Algol procedures tql2, by - Bowdler, Martin, Reinsch, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - - Nonsymmetric reduction to Hessenberg form. - - The eigen vectors to work on. - Array for internal storage of nonsymmetric Hessenberg form. - Order of initial matrix - This is derived from the Algol procedures orthes and ortran, - by Martin and Wilkinson, Handbook for Auto. Comp., - Vol.ii-Linear Algebra, and the corresponding - Fortran subroutines in EISPACK. - - - - Nonsymmetric reduction from Hessenberg to real Schur form. - - The eigen vectors to work on. - Array for internal storage of nonsymmetric Hessenberg form. - Arrays for internal storage of real parts of eigenvalues - Arrays for internal storage of imaginary parts of eigenvalues - Order of initial matrix - This is derived from the Algol procedure hqr2, - by Martin and Wilkinson, Handbook for Auto. Comp., - Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Complex scalar division X/Y. - - Real part of X - Imaginary part of X - Real part of Y - Imaginary part of Y - Division result as a number. - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A EVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the QR decomposition Modified Gram-Schmidt Orthogonalization. - Any real square matrix A may be decomposed as A = QR where Q is an orthogonal mxn matrix and R is an nxn upper triangular matrix. - - - The computation of the QR decomposition is done at construction time by modified Gram-Schmidt Orthogonalization. - - - - - Initializes a new instance of the class. This object creates an orthogonal matrix - using the modified Gram-Schmidt method. - - The matrix to factor. - If is null. - If row count is less then column count - If is rank deficient - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of an LU factorization. - For a matrix A, the LU factorization is a pair of lower triangular matrix L and - upper triangular matrix U so that A = L*U. - - - The computation of the LU factorization is done at construction time. - - - - - Initializes a new instance of the class. This object will compute the - LU factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - If is null. - If is not a square matrix. - - - - Solves a system of linear equations, AX = B, with A LU factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A LU factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Returns the inverse of this matrix. The inverse is calculated using LU decomposition. - - The inverse of this matrix. - - - - A class which encapsulates the functionality of the QR decomposition. - Any real square matrix A may be decomposed as A = QR where Q is an orthogonal matrix - (its columns are orthogonal unit vectors meaning QTQ = I) and R is an upper triangular matrix - (also called right triangular matrix). - - - The computation of the QR decomposition is done at construction time by Householder transformation. - - - - - Initializes a new instance of the class. This object will compute the - QR factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - The QR factorization method to use. - If is null. - - - - Generate column from initial matrix to work array - - Initial matrix - The first row - Column index - Generated vector - - - - Perform calculation of Q or R - - Work array - Q or R matrices - The first row - The last row - The first column - The last column - Number of available CPUs - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the singular value decomposition (SVD) for . - Suppose M is an m-by-n matrix whose entries are real numbers. - Then there exists a factorization of the form M = UΣVT where: - - U is an m-by-m unitary matrix; - - Σ is m-by-n diagonal matrix with nonnegative real numbers on the diagonal; - - VT denotes transpose of V, an n-by-n unitary matrix; - Such a factorization is called a singular-value decomposition of M. A common convention is to order the diagonal - entries Σ(i,i) in descending order. In this case, the diagonal matrix Σ is uniquely determined - by M (though the matrices U and V are not). The diagonal entries of Σ are known as the singular values of M. - - - The computation of the singular value decomposition is done at construction time. - - - - - Initializes a new instance of the class. This object will compute the - the singular value decomposition when the constructor is called and cache it's decomposition. - - The matrix to factor. - Compute the singular U and VT vectors or not. - If is null. - - - - - Calculates absolute value of multiplied on signum function of - - Double value z1 - Double value z2 - Result multiplication of signum function and absolute value - - - - Swap column and - - Source matrix - The number of rows in - Column A index to swap - Column B index to swap - - - - Scale column by starting from row - - Source matrix - The number of rows in - Column to scale - Row to scale from - Scale value - - - - Scale vector by starting from index - - Source vector - Row to scale from - Scale value - - - - Given the Cartesian coordinates (da, db) of a point p, these function return the parameters da, db, c, and s - associated with the Givens rotation that zeros the y-coordinate of the point. - - Provides the x-coordinate of the point p. On exit contains the parameter r associated with the Givens rotation - Provides the y-coordinate of the point p. On exit contains the parameter z associated with the Givens rotation - Contains the parameter c associated with the Givens rotation - Contains the parameter s associated with the Givens rotation - This is equivalent to the DROTG LAPACK routine. - - - - Calculate Norm 2 of the column in matrix starting from row - - Source matrix - The number of rows in - Column index - Start row index - Norm2 (Euclidean norm) of the column - - - - Calculate Norm 2 of the vector starting from index - - Source vector - Start index - Norm2 (Euclidean norm) of the vector - - - - Calculate dot product of and - - Source matrix - The number of rows in - Index of column A - Index of column B - Starting row index - Dot product value - - - - Performs rotation of points in the plane. Given two vectors x and y , - each vector element of these vectors is replaced as follows: x(i) = c*x(i) + s*y(i); y(i) = c*y(i) - s*x(i) - - Source matrix - The number of rows in - Index of column A - Index of column B - Scalar "c" value - Scalar "s" value - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A SVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - float version of the class. - - - - - Initializes a new instance of the Matrix class. - - - - - Set all values whose absolute value is smaller than the threshold to zero. - - - - - Returns the conjugate transpose of this matrix. - - The conjugate transpose of this matrix. - - - - Puts the conjugate transpose of this matrix into the result matrix. - - - - - Complex conjugates each element of this matrix and place the results into the result matrix. - - The result of the conjugation. - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - - - - Add a scalar to each element of the matrix and stores the result in the result vector. - - The scalar to add. - The matrix to store the result of the addition. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of the addition. - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - The scalar to subtract. - The matrix to store the result of the subtraction. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract to this matrix. - The matrix to store the result of subtraction. - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Divides each element of the matrix by a scalar and places results into the result matrix. - - The scalar to divide the matrix with. - The matrix to store the result of the division. - - - - Divides a scalar by each element of the matrix and stores the result in the result matrix. - - The scalar to divide by each element of the matrix. - The matrix to store the result of the division. - - - - Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. - - The matrix to pointwise multiply with this one. - The matrix to store the result of the pointwise multiplication. - - - - Pointwise divide this matrix by another matrix and stores the result into the result matrix. - - The matrix to pointwise divide this one by. - The matrix to store the result of the pointwise division. - - - - Pointwise raise this matrix to an exponent and store the result into the result matrix. - - The exponent to raise this matrix values to. - The matrix to store the result of the pointwise power. - - - - Pointwise raise this matrix to an exponent and store the result into the result matrix. - - The exponent to raise this matrix values to. - The vector to store the result of the pointwise power. - - - - Pointwise canonical modulus, where the result has the sign of the divisor, - of this matrix with another matrix and stores the result into the result matrix. - - The pointwise denominator matrix to use - The result of the modulus. - - - - Pointwise remainder (% operator), where the result has the sign of the dividend, - of this matrix with another matrix and stores the result into the result matrix. - - The pointwise denominator matrix to use - The result of the modulus. - - - - Pointwise applies the exponential function to each value and stores the result into the result matrix. - - The matrix to store the result. - - - - Pointwise applies the natural logarithm function to each value and stores the result into the result matrix. - - The matrix to store the result. - - - - Computes the Moore-Penrose Pseudo-Inverse of this matrix. - - - - - Computes the trace of this matrix. - - The trace of this matrix - If the matrix is not square - - - Calculates the induced L1 norm of this matrix. - The maximum absolute column sum of the matrix. - - - Calculates the induced infinity norm of this matrix. - The maximum absolute row sum of the matrix. - - - Calculates the entry-wise Frobenius norm of this matrix. - The square root of the sum of the squared values. - - - - Calculates the p-norms of all row vectors. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Calculates the p-norms of all column vectors. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Normalizes all row vectors to a unit p-norm. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Normalizes all column vectors to a unit p-norm. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Calculates the value sum of each row vector. - - - - - Calculates the absolute value sum of each row vector. - - - - - Calculates the value sum of each column vector. - - - - - Calculates the absolute value sum of each column vector. - - - - - Evaluates whether this matrix is Hermitian (conjugate symmetric). - - - - - A Bi-Conjugate Gradient stabilized iterative matrix solver. - - - - The Bi-Conjugate Gradient Stabilized (BiCGStab) solver is an 'improvement' - of the standard Conjugate Gradient (CG) solver. Unlike the CG solver the - BiCGStab can be used on non-symmetric matrices.
    - Note that much of the success of the solver depends on the selection of the - proper preconditioner. -
    - - The Bi-CGSTAB algorithm was taken from:
    - Templates for the solution of linear systems: Building blocks - for iterative methods -
    - Richard Barrett, Michael Berry, Tony F. Chan, James Demmel, - June M. Donato, Jack Dongarra, Victor Eijkhout, Roldan Pozo, - Charles Romine and Henk van der Vorst -
    - Url: http://www.netlib.org/templates/Templates.html -
    - Algorithm is described in Chapter 2, section 2.3.8, page 27 -
    - - The example code below provides an indication of the possible use of the - solver. - -
    -
    - - - Calculates the true residual of the matrix equation Ax = b according to: residual = b - Ax - - Instance of the A. - Residual values in . - Instance of the x. - Instance of the b. - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient , A. - The solution , b. - The result , x. - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - A composite matrix solver. The actual solver is made by a sequence of - matrix solvers. - - - - Solver based on:
    - Faster PDE-based simulations using robust composite linear solvers
    - S. Bhowmicka, P. Raghavan a,*, L. McInnes b, B. Norris
    - Future Generation Computer Systems, Vol 20, 2004, pp 373�387
    -
    - - Note that if an iterator is passed to this solver it will be used for all the sub-solvers. - -
    -
    - - - The collection of solvers that will be used - - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient matrix, A. - The solution vector, b - The result vector, x - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - A diagonal preconditioner. The preconditioner uses the inverse - of the matrix diagonal as preconditioning values. - - - - - The inverse of the matrix diagonal. - - - - - Returns the decomposed matrix diagonal. - - The matrix diagonal. - - - - Initializes the preconditioner and loads the internal data structures. - - - The upon which this preconditioner is based. - If is . - If is not a square matrix. - - - - Approximates the solution to the matrix equation Ax = b. - - The right hand side vector. - The left hand side vector. Also known as the result vector. - - - - A Generalized Product Bi-Conjugate Gradient iterative matrix solver. - - - - The Generalized Product Bi-Conjugate Gradient (GPBiCG) solver is an - alternative version of the Bi-Conjugate Gradient stabilized (CG) solver. - Unlike the CG solver the GPBiCG solver can be used on - non-symmetric matrices.
    - Note that much of the success of the solver depends on the selection of the - proper preconditioner. -
    - - The GPBiCG algorithm was taken from:
    - GPBiCG(m,l): A hybrid of BiCGSTAB and GPBiCG methods with - efficiency and robustness -
    - S. Fujino -
    - Applied Numerical Mathematics, Volume 41, 2002, pp 107 - 117 -
    -
    - - The example code below provides an indication of the possible use of the - solver. - -
    -
    - - - Indicates the number of BiCGStab steps should be taken - before switching. - - - - - Indicates the number of GPBiCG steps should be taken - before switching. - - - - - Gets or sets the number of steps taken with the BiCgStab algorithm - before switching over to the GPBiCG algorithm. - - - - - Gets or sets the number of steps taken with the GPBiCG algorithm - before switching over to the BiCgStab algorithm. - - - - - Calculates the true residual of the matrix equation Ax = b according to: residual = b - Ax - - Instance of the A. - Residual values in . - Instance of the x. - Instance of the b. - - - - Decide if to do steps with BiCgStab - - Number of iteration - true if yes, otherwise false - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient matrix, A. - The solution vector, b - The result vector, x - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - An incomplete, level 0, LU factorization preconditioner. - - - The ILU(0) algorithm was taken from:
    - Iterative methods for sparse linear systems
    - Yousef Saad
    - Algorithm is described in Chapter 10, section 10.3.2, page 275
    -
    -
    - - - The matrix holding the lower (L) and upper (U) matrices. The - decomposition matrices are combined to reduce storage. - - - - - Returns the upper triagonal matrix that was created during the LU decomposition. - - A new matrix containing the upper triagonal elements. - - - - Returns the lower triagonal matrix that was created during the LU decomposition. - - A new matrix containing the lower triagonal elements. - - - - Initializes the preconditioner and loads the internal data structures. - - The matrix upon which the preconditioner is based. - If is . - If is not a square matrix. - - - - Approximates the solution to the matrix equation Ax = b. - - The right hand side vector. - The left hand side vector. Also known as the result vector. - - - - This class performs an Incomplete LU factorization with drop tolerance - and partial pivoting. The drop tolerance indicates which additional entries - will be dropped from the factorized LU matrices. - - - The ILUTP-Mem algorithm was taken from:
    - ILUTP_Mem: a Space-Efficient Incomplete LU Preconditioner -
    - Tzu-Yi Chen, Department of Mathematics and Computer Science,
    - Pomona College, Claremont CA 91711, USA
    - Published in:
    - Lecture Notes in Computer Science
    - Volume 3046 / 2004
    - pp. 20 - 28
    - Algorithm is described in Section 2, page 22 -
    -
    - - - The default fill level. - - - - - The default drop tolerance. - - - - - The decomposed upper triangular matrix. - - - - - The decomposed lower triangular matrix. - - - - - The array containing the pivot values. - - - - - The fill level. - - - - - The drop tolerance. - - - - - The pivot tolerance. - - - - - Initializes a new instance of the class with the default settings. - - - - - Initializes a new instance of the class with the specified settings. - - - The amount of fill that is allowed in the matrix. The value is a fraction of - the number of non-zero entries in the original matrix. Values should be positive. - - - The absolute drop tolerance which indicates below what absolute value an entry - will be dropped from the matrix. A drop tolerance of 0.0 means that no values - will be dropped. Values should always be positive. - - - The pivot tolerance which indicates at what level pivoting will take place. A - value of 0.0 means that no pivoting will take place. - - - - - Gets or sets the amount of fill that is allowed in the matrix. The - value is a fraction of the number of non-zero entries in the original - matrix. The standard value is 200. - - - - Values should always be positive and can be higher than 1.0. A value lower - than 1.0 means that the eventual preconditioner matrix will have fewer - non-zero entries as the original matrix. A value higher than 1.0 means that - the eventual preconditioner can have more non-zero values than the original - matrix. - - - Note that any changes to the FillLevel after creating the preconditioner - will invalidate the created preconditioner and will require a re-initialization of - the preconditioner. - - - Thrown if a negative value is provided. - - - - Gets or sets the absolute drop tolerance which indicates below what absolute value - an entry will be dropped from the matrix. The standard value is 0.0001. - - - - The values should always be positive and can be larger than 1.0. A low value will - keep more small numbers in the preconditioner matrix. A high value will remove - more small numbers from the preconditioner matrix. - - - Note that any changes to the DropTolerance after creating the preconditioner - will invalidate the created preconditioner and will require a re-initialization of - the preconditioner. - - - Thrown if a negative value is provided. - - - - Gets or sets the pivot tolerance which indicates at what level pivoting will - take place. The standard value is 0.0 which means pivoting will never take place. - - - - The pivot tolerance is used to calculate if pivoting is necessary. Pivoting - will take place if any of the values in a row is bigger than the - diagonal value of that row divided by the pivot tolerance, i.e. pivoting - will take place if row(i,j) > row(i,i) / PivotTolerance for - any j that is not equal to i. - - - Note that any changes to the PivotTolerance after creating the preconditioner - will invalidate the created preconditioner and will require a re-initialization of - the preconditioner. - - - Thrown if a negative value is provided. - - - - Returns the upper triagonal matrix that was created during the LU decomposition. - - - This method is used for debugging purposes only and should normally not be used. - - A new matrix containing the upper triagonal elements. - - - - Returns the lower triagonal matrix that was created during the LU decomposition. - - - This method is used for debugging purposes only and should normally not be used. - - A new matrix containing the lower triagonal elements. - - - - Returns the pivot array. This array is not needed for normal use because - the preconditioner will return the solution vector values in the proper order. - - - This method is used for debugging purposes only and should normally not be used. - - The pivot array. - - - - Initializes the preconditioner and loads the internal data structures. - - - The upon which this preconditioner is based. Note that the - method takes a general matrix type. However internally the data is stored - as a sparse matrix. Therefore it is not recommended to pass a dense matrix. - - If is . - If is not a square matrix. - - - - Pivot elements in the according to internal pivot array - - Row to pivot in - - - - Was pivoting already performed - - Pivots already done - Current item to pivot - true if performed, otherwise false - - - - Swap columns in the - - Source . - First column index to swap - Second column index to swap - - - - Sort vector descending, not changing vector but placing sorted indices to - - Start sort form - Sort till upper bound - Array with sorted vector indices - Source - - - - Approximates the solution to the matrix equation Ax = b. - - The right hand side vector. - The left hand side vector. Also known as the result vector. - - - - Pivot elements in according to internal pivot array - - Source . - Result after pivoting. - - - - An element sort algorithm for the class. - - - This sort algorithm is used to sort the columns in a sparse matrix based on - the value of the element on the diagonal of the matrix. - - - - - Sorts the elements of the vector in decreasing - fashion. The vector itself is not affected. - - The starting index. - The stopping index. - An array that will contain the sorted indices once the algorithm finishes. - The that contains the values that need to be sorted. - - - - Sorts the elements of the vector in decreasing - fashion using heap sort algorithm. The vector itself is not affected. - - The starting index. - The stopping index. - An array that will contain the sorted indices once the algorithm finishes. - The that contains the values that need to be sorted. - - - - Build heap for double indices - - Root position - Length of - Indices of - Target - - - - Sift double indices - - Indices of - Target - Root position - Length of - - - - Sorts the given integers in a decreasing fashion. - - The values. - - - - Sort the given integers in a decreasing fashion using heapsort algorithm - - Array of values to sort - Length of - - - - Build heap - - Target values array - Root position - Length of - - - - Sift values - - Target value array - Root position - Length of - - - - Exchange values in array - - Target values array - First value to exchange - Second value to exchange - - - - A simple milu(0) preconditioner. - - - Original Fortran code by Yousef Saad (07 January 2004) - - - - Use modified or standard ILU(0) - - - - Gets or sets a value indicating whether to use modified or standard ILU(0). - - - - - Gets a value indicating whether the preconditioner is initialized. - - - - - Initializes the preconditioner and loads the internal data structures. - - The matrix upon which the preconditioner is based. - If is . - If is not a square or is not an - instance of SparseCompressedRowMatrixStorage. - - - - Approximates the solution to the matrix equation Ax = b. - - The right hand side vector b. - The left hand side vector x. - - - - MILU0 is a simple milu(0) preconditioner. - - Order of the matrix. - Matrix values in CSR format (input). - Column indices (input). - Row pointers (input). - Matrix values in MSR format (output). - Row pointers and column indices (output). - Pointer to diagonal elements (output). - True if the modified/MILU algorithm should be used (recommended) - Returns 0 on success or k > 0 if a zero pivot was encountered at step k. - - - - A Multiple-Lanczos Bi-Conjugate Gradient stabilized iterative matrix solver. - - - - The Multiple-Lanczos Bi-Conjugate Gradient stabilized (ML(k)-BiCGStab) solver is an 'improvement' - of the standard BiCgStab solver. - - - The algorithm was taken from:
    - ML(k)BiCGSTAB: A BiCGSTAB variant based on multiple Lanczos starting vectors -
    - Man-Chung Yeung and Tony F. Chan -
    - SIAM Journal of Scientific Computing -
    - Volume 21, Number 4, pp. 1263 - 1290 -
    - - The example code below provides an indication of the possible use of the - solver. - -
    -
    - - - The default number of starting vectors. - - - - - The collection of starting vectors which are used as the basis for the Krylov sub-space. - - - - - The number of starting vectors used by the algorithm - - - - - Gets or sets the number of starting vectors. - - - Must be larger than 1 and smaller than the number of variables in the matrix that - for which this solver will be used. - - - - - Resets the number of starting vectors to the default value. - - - - - Gets or sets a series of orthonormal vectors which will be used as basis for the - Krylov sub-space. - - - - - Gets the number of starting vectors to create - - Maximum number - Number of variables - Number of starting vectors to create - - - - Returns an array of starting vectors. - - The maximum number of starting vectors that should be created. - The number of variables. - - An array with starting vectors. The array will never be larger than the - but it may be smaller if - the is smaller than - the . - - - - - Create random vectors array - - Number of vectors - Size of each vector - Array of random vectors - - - - Calculates the true residual of the matrix equation Ax = b according to: residual = b - Ax - - Source A. - Residual data. - x data. - b data. - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient matrix, A. - The solution vector, b - The result vector, x - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - A Transpose Free Quasi-Minimal Residual (TFQMR) iterative matrix solver. - - - - The TFQMR algorithm was taken from:
    - Iterative methods for sparse linear systems. -
    - Yousef Saad -
    - Algorithm is described in Chapter 7, section 7.4.3, page 219 -
    - - The example code below provides an indication of the possible use of the - solver. - -
    -
    - - - Calculates the true residual of the matrix equation Ax = b according to: residual = b - Ax - - Instance of the A. - Residual values in . - Instance of the x. - Instance of the b. - - - - Is even? - - Number to check - true if even, otherwise false - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient matrix, A. - The solution vector, b - The result vector, x - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - A Matrix with sparse storage, intended for very large matrices where most of the cells are zero. - The underlying storage scheme is 3-array compressed-sparse-row (CSR) Format. - Wikipedia - CSR. - - - - - Gets the number of non zero elements in the matrix. - - The number of non zero elements. - - - - Create a new sparse matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new square sparse matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the order is less than one. - - - - Create a new sparse matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the row or column count is less than one. - - - - Create a new sparse matrix as a copy of the given other matrix. - This new matrix will be independent from the other matrix. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given two-dimensional array. - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable. - The enumerable is assumed to be in row-major order (row by row). - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - - Create a new sparse matrix with the given number of rows and columns as a copy of the given array. - The array is assumed to be in column-major order (column by column). - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix and initialize each value to the same provided value. - - - - - Create a new sparse matrix and initialize each value using the provided init function. - - - - - Create a new diagonal sparse matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal sparse matrix and initialize each diagonal value using the provided init function. - - - - - Create a new square sparse identity matrix where each diagonal value is set to One. - - - - - Returns a new matrix containing the lower triangle of this matrix. - - The lower triangle of this matrix. - - - - Puts the lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Puts the lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - - - - Returns a new matrix containing the upper triangle of this matrix. - - The upper triangle of this matrix. - - - - Puts the upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Puts the upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - - - - Returns a new matrix containing the lower triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The lower triangle of this matrix. - - - - Puts the strictly lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Puts the strictly lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - - - - Returns a new matrix containing the upper triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The upper triangle of this matrix. - - - - Puts the strictly upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Puts the strictly upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - - - Calculates the induced infinity norm of this matrix. - The maximum absolute row sum of the matrix. - - - Calculates the entry-wise Frobenius norm of this matrix. - The square root of the sum of the squared values. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of the addition. - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract to this matrix. - The matrix to store the result of subtraction. - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. - - The matrix to pointwise multiply with this one. - The matrix to store the result of the pointwise multiplication. - - - - Pointwise divide this matrix by another matrix and stores the result into the result matrix. - - The matrix to pointwise divide this one by. - The matrix to store the result of the pointwise division. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Evaluates whether this matrix is symmetric. - - - - - Adds two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to add. - The right matrix to add. - The result of the addition. - If and don't have the same dimensions. - If or is . - - - - Returns a Matrix containing the same values of . - - The matrix to get the values from. - A matrix containing a the same values as . - If is . - - - - Subtracts two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to subtract. - The right matrix to subtract. - The result of the addition. - If and don't have the same dimensions. - If or is . - - - - Negates each element of the matrix. - - The matrix to negate. - A matrix containing the negated values. - If is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies two matrices. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to multiply. - The right matrix to multiply. - The result of multiplication. - If or is . - If the dimensions of or don't conform. - - - - Multiplies a Matrix and a Vector. - - The matrix to multiply. - The vector to multiply. - The result of multiplication. - If or is . - - - - Multiplies a Vector and a Matrix. - - The vector to multiply. - The matrix to multiply. - The result of multiplication. - If or is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - A vector with sparse storage, intended for very large vectors where most of the cells are zero. - - The sparse vector is not thread safe. - - - - Gets the number of non zero elements in the vector. - - The number of non zero elements. - - - - Create a new sparse vector straight from an initialized vector storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new sparse vector with the given length. - All cells of the vector will be initialized to zero. - - If length is less than one. - - - - Create a new sparse vector as a copy of the given other vector. - This new vector will be independent from the other vector. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given enumerable. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector and initialize each value using the provided value. - - - - - Create a new sparse vector and initialize each value using the provided init function. - - - - - Adds a scalar to each element of the vector and stores the result in the result vector. - Warning, the new 'sparse vector' with a non-zero scalar added to it will be a 100% filled - sparse vector and very inefficient. Would be better to work with a dense vector instead. - - - The scalar to add. - - - The vector to store the result of the addition. - - - - - Adds another vector to this vector and stores the result into the result vector. - - - The vector to add to this one. - - - The vector to store the result of the addition. - - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - - The scalar to subtract. - - - The vector to store the result of the subtraction. - - - - - Subtracts another vector to this vector and stores the result into the result vector. - - - The vector to subtract from this one. - - - The vector to store the result of the subtraction. - - - - - Negates vector and saves result to - - Target vector - - - - Multiplies a scalar to each element of the vector and stores the result in the result vector. - - - The scalar to multiply. - - - The vector to store the result of the multiplication. - - - - - Computes the dot product between this vector and another vector. - - The other vector. - The sum of a[i]*b[i] for all i. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Adds two Vectors together and returns the results. - - One of the vectors to add. - The other vector to add. - The result of the addition. - If and are not the same size. - If or is . - - - - Returns a Vector containing the negated values of . - - The vector to get the values from. - A vector containing the negated values as . - If is . - - - - Subtracts two Vectors and returns the results. - - The vector to subtract from. - The vector to subtract. - The result of the subtraction. - If and are not the same size. - If or is . - - - - Multiplies a vector with a scalar. - - The vector to scale. - The scalar value. - The result of the multiplication. - If is . - - - - Multiplies a vector with a scalar. - - The scalar value. - The vector to scale. - The result of the multiplication. - If is . - - - - Computes the dot product between two Vectors. - - The left row vector. - The right column vector. - The dot product between the two vectors. - If and are not the same size. - If or is . - - - - Divides a vector with a scalar. - - The vector to divide. - The scalar value. - The result of the division. - If is . - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - of each element of the vector of the given divisor. - - The vector whose elements we want to compute the modulus of. - The divisor to use, - The result of the calculation - If is . - - - - Returns the index of the absolute minimum element. - - The index of absolute minimum element. - - - - Returns the index of the absolute maximum element. - - The index of absolute maximum element. - - - - Returns the index of the maximum element. - - The index of maximum element. - - - - Returns the index of the minimum element. - - The index of minimum element. - - - - Computes the sum of the vector's elements. - - The sum of the vector's elements. - - - - Calculates the L1 norm of the vector, also known as Manhattan norm. - - The sum of the absolute values. - - - - Calculates the infinity norm of the vector. - - The maximum absolute value. - - - - Computes the p-Norm. - - The p value. - Scalar ret = ( ∑|this[i]|^p )^(1/p) - - - - Pointwise multiplies this vector with another vector and stores the result into the result vector. - - The vector to pointwise multiply with this one. - The vector to store the result of the pointwise multiplication. - - - - Creates a float sparse vector based on a string. The string can be in the following formats (without the - quotes): 'n', 'n,n,..', '(n,n,..)', '[n,n,...]', where n is a float. - - - A float sparse vector containing the values specified by the given string. - - - the string to parse. - - - An that supplies culture-specific formatting information. - - - - - Converts the string representation of a real sparse vector to float-precision sparse vector equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a real vector to convert. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will be null. - - - - - Converts the string representation of a real sparse vector to float-precision sparse vector equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a real vector to convert. - - - An that supplies culture-specific formatting information about value. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will be null. - - - - - float version of the class. - - - - - Initializes a new instance of the Vector class. - - - - - Set all values whose absolute value is smaller than the threshold to zero. - - - - - Conjugates vector and save result to - - Target vector - - - - Negates vector and saves result to - - Target vector - - - - Adds a scalar to each element of the vector and stores the result in the result vector. - - - The scalar to add. - - - The vector to store the result of the addition. - - - - - Adds another vector to this vector and stores the result into the result vector. - - - The vector to add to this one. - - - The vector to store the result of the addition. - - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - - The scalar to subtract. - - - The vector to store the result of the subtraction. - - - - - Subtracts another vector to this vector and stores the result into the result vector. - - - The vector to subtract from this one. - - - The vector to store the result of the subtraction. - - - - - Multiplies a scalar to each element of the vector and stores the result in the result vector. - - - The scalar to multiply. - - - The vector to store the result of the multiplication. - - - - - Divides each element of the vector by a scalar and stores the result in the result vector. - - - The scalar to divide with. - - - The vector to store the result of the division. - - - - - Divides a scalar by each element of the vector and stores the result in the result vector. - - The scalar to divide. - The vector to store the result of the division. - - - - Pointwise multiplies this vector with another vector and stores the result into the result vector. - - The vector to pointwise multiply with this one. - The vector to store the result of the pointwise multiplication. - - - - Pointwise divide this vector with another vector and stores the result into the result vector. - - The vector to pointwise divide this one by. - The vector to store the result of the pointwise division. - - - - Pointwise raise this vector to an exponent and store the result into the result vector. - - The exponent to raise this vector values to. - The vector to store the result of the pointwise power. - - - - Pointwise raise this vector to an exponent vector and store the result into the result vector. - - The exponent vector to raise this vector values to. - The vector to store the result of the pointwise power. - - - - Pointwise canonical modulus, where the result has the sign of the divisor, - of this vector with another vector and stores the result into the result vector. - - The pointwise denominator vector to use. - The result of the modulus. - - - - Pointwise remainder (% operator), where the result has the sign of the dividend, - of this vector with another vector and stores the result into the result vector. - - The pointwise denominator vector to use. - The result of the modulus. - - - - Pointwise applies the exponential function to each value and stores the result into the result vector. - - The vector to store the result. - - - - Pointwise applies the natural logarithm function to each value and stores the result into the result vector. - - The vector to store the result. - - - - Computes the dot product between this vector and another vector. - - The other vector. - The sum of a[i]*b[i] for all i. - - - - Computes the dot product between the conjugate of this vector and another vector. - - The other vector. - The sum of conj(a[i])*b[i] for all i. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given dividend for each element of the vector. - - The scalar numerator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given dividend for each element of the vector. - - The scalar numerator to use. - A vector to store the results in. - - - - Returns the value of the absolute minimum element. - - The value of the absolute minimum element. - - - - Returns the index of the absolute minimum element. - - The index of absolute minimum element. - - - - Returns the value of the absolute maximum element. - - The value of the absolute maximum element. - - - - Returns the index of the absolute maximum element. - - The index of absolute maximum element. - - - - Computes the sum of the vector's elements. - - The sum of the vector's elements. - - - - Calculates the L1 norm of the vector, also known as Manhattan norm. - - The sum of the absolute values. - - - - Calculates the L2 norm of the vector, also known as Euclidean norm. - - The square root of the sum of the squared values. - - - - Calculates the infinity norm of the vector. - - The maximum absolute value. - - - - Computes the p-Norm. - - - The p value. - - - Scalar ret = ( ∑|At(i)|^p )^(1/p) - - - - - Returns the index of the maximum element. - - The index of maximum element. - - - - Returns the index of the minimum element. - - The index of minimum element. - - - - Normalizes this vector to a unit vector with respect to the p-norm. - - - The p value. - - - This vector normalized to a unit vector with respect to the p-norm. - - - - - A Matrix class with dense storage. The underlying storage is a one dimensional array in column-major order (column by column). - - - - - Number of rows. - - Using this instead of the RowCount property to speed up calculating - a matrix index in the data array. - - - - Number of columns. - - Using this instead of the ColumnCount property to speed up calculating - a matrix index in the data array. - - - - Gets the matrix's data. - - The matrix's data. - - - - Create a new dense matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new square dense matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the order is less than one. - - - - Create a new dense matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the row or column count is less than one. - - - - Create a new dense matrix with the given number of rows and columns directly binding to a raw array. - The array is assumed to be in column-major order (column by column) and is used directly without copying. - Very efficient, but changes to the array and the matrix will affect each other. - - - - - - Create a new dense matrix as a copy of the given other matrix. - This new matrix will be independent from the other matrix. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given two-dimensional array. - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable. - The enumerable is assumed to be in column-major order (column by column). - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix and initialize each value to the same provided value. - - - - - Create a new dense matrix and initialize each value using the provided init function. - - - - - Create a new diagonal dense matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal dense matrix and initialize each diagonal value using the provided init function. - - - - - Create a new square sparse identity matrix where each diagonal value is set to One. - - - - - Create a new dense matrix with values sampled from the provided random distribution. - - - - - Gets the matrix's data. - - The matrix's data. - - - Calculates the induced L1 norm of this matrix. - The maximum absolute column sum of the matrix. - - - Calculates the induced infinity norm of this matrix. - The maximum absolute row sum of the matrix. - - - Calculates the entry-wise Frobenius norm of this matrix. - The square root of the sum of the squared values. - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - - - - Complex conjugates each element of this matrix and place the results into the result matrix. - - The result of the conjugation. - - - - Add a scalar to each element of the matrix and stores the result in the result vector. - - The scalar to add. - The matrix to store the result of the addition. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of add - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Subtracts a scalar from each element of the matrix and stores the result in the result vector. - - The scalar to subtract. - The matrix to store the result of the subtraction. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract. - The matrix to store the result of the subtraction. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Divides each element of the matrix by a scalar and places results into the result matrix. - - The scalar to divide the matrix with. - The matrix to store the result of the division. - - - - Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. - - The matrix to pointwise multiply with this one. - The matrix to store the result of the pointwise multiplication. - - - - Pointwise divide this matrix by another matrix and stores the result into the result matrix. - - The matrix to pointwise divide this one by. - The matrix to store the result of the pointwise division. - - - - Pointwise raise this matrix to an exponent and store the result into the result matrix. - - The exponent to raise this matrix values to. - The vector to store the result of the pointwise power. - - - - Computes the trace of this matrix. - - The trace of this matrix - If the matrix is not square - - - - Adds two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to add. - The right matrix to add. - The result of the addition. - If and don't have the same dimensions. - If or is . - - - - Returns a Matrix containing the same values of . - - The matrix to get the values from. - A matrix containing a the same values as . - If is . - - - - Subtracts two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to subtract. - The right matrix to subtract. - The result of the addition. - If and don't have the same dimensions. - If or is . - - - - Negates each element of the matrix. - - The matrix to negate. - A matrix containing the negated values. - If is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies two matrices. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to multiply. - The right matrix to multiply. - The result of multiplication. - If or is . - If the dimensions of or don't conform. - - - - Multiplies a Matrix and a Vector. - - The matrix to multiply. - The vector to multiply. - The result of multiplication. - If or is . - - - - Multiplies a Vector and a Matrix. - - The vector to multiply. - The matrix to multiply. - The result of multiplication. - If or is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Evaluates whether this matrix is symmetric. - - - - - Evaluates whether this matrix is Hermitian (conjugate symmetric). - - - - - A vector using dense storage. - - - - - Number of elements - - - - - Gets the vector's data. - - - - - Create a new dense vector straight from an initialized vector storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new dense vector with the given length. - All cells of the vector will be initialized to zero. - - If length is less than one. - - - - Create a new dense vector directly binding to a raw array. - The array is used directly without copying. - Very efficient, but changes to the array and the vector will affect each other. - - - - - Create a new dense vector as a copy of the given other vector. - This new vector will be independent from the other vector. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given array. - This new vector will be independent from the array. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given enumerable. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector and initialize each value using the provided value. - - - - - Create a new dense vector and initialize each value using the provided init function. - - - - - Create a new dense vector with values sampled from the provided random distribution. - - - - - Gets the vector's data. - - The vector's data. - - - - Returns a reference to the internal data structure. - - The DenseVector whose internal data we are - returning. - - A reference to the internal date of the given vector. - - - - - Returns a vector bound directly to a reference of the provided array. - - The array to bind to the DenseVector object. - - A DenseVector whose values are bound to the given array. - - - - - Adds a scalar to each element of the vector and stores the result in the result vector. - - The scalar to add. - The vector to store the result of the addition. - - - - Adds another vector to this vector and stores the result into the result vector. - - The vector to add to this one. - The vector to store the result of the addition. - - - - Adds two Vectors together and returns the results. - - One of the vectors to add. - The other vector to add. - The result of the addition. - If and are not the same size. - If or is . - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - The scalar to subtract. - The vector to store the result of the subtraction. - - - - Subtracts another vector from this vector and stores the result into the result vector. - - The vector to subtract from this one. - The vector to store the result of the subtraction. - - - - Returns a Vector containing the negated values of . - - The vector to get the values from. - A vector containing the negated values as . - If is . - - - - Subtracts two Vectors and returns the results. - - The vector to subtract from. - The vector to subtract. - The result of the subtraction. - If and are not the same size. - If or is . - - - - Negates vector and saves result to - - Target vector - - - - Conjugates vector and save result to - - Target vector - - - - Multiplies a scalar to each element of the vector and stores the result in the result vector. - - The scalar to multiply. - The vector to store the result of the multiplication. - - - - - Computes the dot product between this vector and another vector. - - The other vector. - The sum of a[i]*b[i] for all i. - - - - Computes the dot product between the conjugate of this vector and another vector. - - The other vector. - The sum of conj(a[i])*b[i] for all i. - - - - Multiplies a vector with a complex. - - The vector to scale. - The Complex value. - The result of the multiplication. - If is . - - - - Multiplies a vector with a complex. - - The Complex value. - The vector to scale. - The result of the multiplication. - If is . - - - - Computes the dot product between two Vectors. - - The left row vector. - The right column vector. - The dot product between the two vectors. - If and are not the same size. - If or is . - - - - Divides a vector with a complex. - - The vector to divide. - The Complex value. - The result of the division. - If is . - - - - Returns the index of the absolute minimum element. - - The index of absolute minimum element. - - - - Returns the index of the absolute maximum element. - - The index of absolute maximum element. - - - - Computes the sum of the vector's elements. - - The sum of the vector's elements. - - - - Calculates the L1 norm of the vector, also known as Manhattan norm. - - The sum of the absolute values. - - - - Calculates the L2 norm of the vector, also known as Euclidean norm. - - The square root of the sum of the squared values. - - - - Calculates the infinity norm of the vector. - - The maximum absolute value. - - - - Computes the p-Norm. - - The p value. - Scalar ret = ( ∑|this[i]|^p )^(1/p) - - - - Pointwise divide this vector with another vector and stores the result into the result vector. - - The vector to pointwise divide this one by. - The vector to store the result of the pointwise division. - - - - Pointwise divide this vector with another vector and stores the result into the result vector. - - The vector to pointwise divide this one by. - The vector to store the result of the pointwise division. - - - - - Pointwise raise this vector to an exponent vector and store the result into the result vector. - - The exponent vector to raise this vector values to. - The vector to store the result of the pointwise power. - - - - Creates a Complex dense vector based on a string. The string can be in the following formats (without the - quotes): 'n', 'n;n;..', '(n;n;..)', '[n;n;...]', where n is a double. - - - A Complex dense vector containing the values specified by the given string. - - - the string to parse. - - - An that supplies culture-specific formatting information. - - - - - Converts the string representation of a complex dense vector to double-precision dense vector equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a complex vector to convert. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will be null. - - - - - Converts the string representation of a complex dense vector to double-precision dense vector equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a complex vector to convert. - - - An that supplies culture-specific formatting information about value. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will be null. - - - - - A matrix type for diagonal matrices. - - - Diagonal matrices can be non-square matrices but the diagonal always starts - at element 0,0. A diagonal matrix will throw an exception if non diagonal - entries are set. The exception to this is when the off diagonal elements are - 0.0 or NaN; these settings will cause no change to the diagonal matrix. - - - - - Gets the matrix's data. - - The matrix's data. - - - - Create a new diagonal matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new square diagonal matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the order is less than one. - - - - Create a new diagonal matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the row or column count is less than one. - - - - Create a new diagonal matrix with the given number of rows and columns. - All diagonal cells of the matrix will be initialized to the provided value, all non-diagonal ones to zero. - - If the row or column count is less than one. - - - - Create a new diagonal matrix with the given number of rows and columns directly binding to a raw array. - The array is assumed to contain the diagonal elements only and is used directly without copying. - Very efficient, but changes to the array and the matrix will affect each other. - - - - - Create a new diagonal matrix as a copy of the given other matrix. - This new matrix will be independent from the other matrix. - The matrix to copy from must be diagonal as well. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix as a copy of the given two-dimensional array. - This new matrix will be independent from the provided array. - The array to copy from must be diagonal as well. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix and initialize each diagonal value from the provided indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix and initialize each diagonal value from the provided indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix and initialize each diagonal value from the provided enumerable. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix and initialize each diagonal value using the provided init function. - - - - - Create a new square sparse identity matrix where each diagonal value is set to One. - - - - - Create a new diagonal matrix with diagonal values sampled from the provided random distribution. - - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - - - - Complex conjugates each element of this matrix and place the results into the result matrix. - - The result of the conjugation. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of the addition. - If the two matrices don't have the same dimensions. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract. - The matrix to store the result of the subtraction. - If the two matrices don't have the same dimensions. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - If the result matrix's dimensions are not the same as this matrix. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Divides each element of the matrix by a scalar and places results into the result matrix. - - The scalar to divide the matrix with. - The matrix to store the result of the division. - - - - Divides a scalar by each element of the matrix and stores the result in the result matrix. - - The scalar to add. - The matrix to store the result of the division. - - - - Computes the determinant of this matrix. - - The determinant of this matrix. - - - - Returns the elements of the diagonal in a . - - The elements of the diagonal. - For non-square matrices, the method returns Min(Rows, Columns) elements where - i == j (i is the row index, and j is the column index). - - - - Copies the values of the given array to the diagonal. - - The array to copy the values from. The length of the vector should be - Min(Rows, Columns). - If the length of does not - equal Min(Rows, Columns). - For non-square matrices, the elements of are copied to - this[i,i]. - - - - Copies the values of the given to the diagonal. - - The vector to copy the values from. The length of the vector should be - Min(Rows, Columns). - If the length of does not - equal Min(Rows, Columns). - For non-square matrices, the elements of are copied to - this[i,i]. - - - Calculates the induced L1 norm of this matrix. - The maximum absolute column sum of the matrix. - - - Calculates the induced L2 norm of the matrix. - The largest singular value of the matrix. - - - Calculates the induced infinity norm of this matrix. - The maximum absolute row sum of the matrix. - - - Calculates the Frobenius norm of this matrix. - The Frobenius norm of this matrix. - - - Calculates the condition number of this matrix. - The condition number of the matrix. - - - Computes the inverse of this matrix. - If is not a square matrix. - If is singular. - The inverse of this matrix. - - - - Returns a new matrix containing the lower triangle of this matrix. - - The lower triangle of this matrix. - - - - Puts the lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If the result matrix's dimensions are not the same as this matrix. - - - - Returns a new matrix containing the lower triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The lower triangle of this matrix. - - - - Puts the strictly lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If the result matrix's dimensions are not the same as this matrix. - - - - Returns a new matrix containing the upper triangle of this matrix. - - The upper triangle of this matrix. - - - - Puts the upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If the result matrix's dimensions are not the same as this matrix. - - - - Returns a new matrix containing the upper triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The upper triangle of this matrix. - - - - Puts the strictly upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If the result matrix's dimensions are not the same as this matrix. - - - - Creates a matrix that contains the values from the requested sub-matrix. - - The row to start copying from. - The number of rows to copy. Must be positive. - The column to start copying from. - The number of columns to copy. Must be positive. - The requested sub-matrix. - If: is - negative, or greater than or equal to the number of rows. - is negative, or greater than or equal to the number - of columns. - (columnIndex + columnLength) >= Columns - (rowIndex + rowLength) >= Rows - If or - is not positive. - - - - Permute the columns of a matrix according to a permutation. - - The column permutation to apply to this matrix. - Always thrown - Permutation in diagonal matrix are senseless, because of matrix nature - - - - Permute the rows of a matrix according to a permutation. - - The row permutation to apply to this matrix. - Always thrown - Permutation in diagonal matrix are senseless, because of matrix nature - - - - Evaluates whether this matrix is symmetric. - - - - - Evaluates whether this matrix is Hermitian (conjugate symmetric). - - - - - A class which encapsulates the functionality of a Cholesky factorization. - For a symmetric, positive definite matrix A, the Cholesky factorization - is an lower triangular matrix L so that A = L*L'. - - - The computation of the Cholesky factorization is done at construction time. If the matrix is not symmetric - or positive definite, the constructor will throw an exception. - - - - - Gets the determinant of the matrix for which the Cholesky matrix was computed. - - - - - Gets the log determinant of the matrix for which the Cholesky matrix was computed. - - - - - A class which encapsulates the functionality of a Cholesky factorization for dense matrices. - For a symmetric, positive definite matrix A, the Cholesky factorization - is an lower triangular matrix L so that A = L*L'. - - - The computation of the Cholesky factorization is done at construction time. If the matrix is not symmetric - or positive definite, the constructor will throw an exception. - - - - - Initializes a new instance of the class. This object will compute the - Cholesky factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - If is null. - If is not a square matrix. - If is not positive definite. - - - - Solves a system of linear equations, AX = B, with A Cholesky factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A Cholesky factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Calculates the Cholesky factorization of the input matrix. - - The matrix to be factorized. - If is null. - If is not a square matrix. - If is not positive definite. - If does not have the same dimensions as the existing factor. - - - - Eigenvalues and eigenvectors of a complex matrix. - - - If A is Hermitian, then A = V*D*V' where the eigenvalue matrix D is - diagonal and the eigenvector matrix V is Hermitian. - I.e. A = V*D*V' and V*VH=I. - If A is not symmetric, then the eigenvalue matrix D is block diagonal - with the real eigenvalues in 1-by-1 blocks and any complex eigenvalues, - lambda + i*mu, in 2-by-2 blocks, [lambda, mu; -mu, lambda]. The - columns of V represent the eigenvectors in the sense that A*V = V*D, - i.e. A.Multiply(V) equals V.Multiply(D). The matrix V may be badly - conditioned, or even singular, so the validity of the equation - A = V*D*Inverse(V) depends upon V.Condition(). - - - - - Initializes a new instance of the class. This object will compute the - the eigenvalue decomposition when the constructor is called and cache it's decomposition. - - The matrix to factor. - If it is known whether the matrix is symmetric or not the routine can skip checking it itself. - If is null. - If EVD algorithm failed to converge with matrix . - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A EVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the QR decomposition Modified Gram-Schmidt Orthogonalization. - Any complex square matrix A may be decomposed as A = QR where Q is an unitary mxn matrix and R is an nxn upper triangular matrix. - - - The computation of the QR decomposition is done at construction time by modified Gram-Schmidt Orthogonalization. - - - - - Initializes a new instance of the class. This object creates an unitary matrix - using the modified Gram-Schmidt method. - - The matrix to factor. - If is null. - If row count is less then column count - If is rank deficient - - - - Factorize matrix using the modified Gram-Schmidt method. - - Initial matrix. On exit is replaced by Q. - Number of rows in Q. - Number of columns in Q. - On exit is filled by R. - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of an LU factorization. - For a matrix A, the LU factorization is a pair of lower triangular matrix L and - upper triangular matrix U so that A = L*U. - - - The computation of the LU factorization is done at construction time. - - - - - Initializes a new instance of the class. This object will compute the - LU factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - If is null. - If is not a square matrix. - - - - Solves a system of linear equations, AX = B, with A LU factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A LU factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Returns the inverse of this matrix. The inverse is calculated using LU decomposition. - - The inverse of this matrix. - - - - A class which encapsulates the functionality of the QR decomposition. - Any real square matrix A may be decomposed as A = QR where Q is an orthogonal matrix - (its columns are orthogonal unit vectors meaning QTQ = I) and R is an upper triangular matrix - (also called right triangular matrix). - - - The computation of the QR decomposition is done at construction time by Householder transformation. - - - - - Gets or sets Tau vector. Contains additional information on Q - used for native solver. - - - - - Initializes a new instance of the class. This object will compute the - QR factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - The type of QR factorization to perform. - If is null. - If row count is less then column count - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the singular value decomposition (SVD) for . - Suppose M is an m-by-n matrix whose entries are real numbers. - Then there exists a factorization of the form M = UΣVT where: - - U is an m-by-m unitary matrix; - - Σ is m-by-n diagonal matrix with nonnegative real numbers on the diagonal; - - VT denotes transpose of V, an n-by-n unitary matrix; - Such a factorization is called a singular-value decomposition of M. A common convention is to order the diagonal - entries Σ(i,i) in descending order. In this case, the diagonal matrix Σ is uniquely determined - by M (though the matrices U and V are not). The diagonal entries of Σ are known as the singular values of M. - - - The computation of the singular value decomposition is done at construction time. - - - - - Initializes a new instance of the class. This object will compute the - the singular value decomposition when the constructor is called and cache it's decomposition. - - The matrix to factor. - Compute the singular U and VT vectors or not. - If is null. - If SVD algorithm failed to converge with matrix . - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A SVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Eigenvalues and eigenvectors of a real matrix. - - - If A is symmetric, then A = V*D*V' where the eigenvalue matrix D is - diagonal and the eigenvector matrix V is orthogonal. - I.e. A = V*D*V' and V*VT=I. - If A is not symmetric, then the eigenvalue matrix D is block diagonal - with the real eigenvalues in 1-by-1 blocks and any complex eigenvalues, - lambda + i*mu, in 2-by-2 blocks, [lambda, mu; -mu, lambda]. The - columns of V represent the eigenvectors in the sense that A*V = V*D, - i.e. A.Multiply(V) equals V.Multiply(D). The matrix V may be badly - conditioned, or even singular, so the validity of the equation - A = V*D*Inverse(V) depends upon V.Condition(). - - - - - Gets the absolute value of determinant of the square matrix for which the EVD was computed. - - - - - Gets the effective numerical matrix rank. - - The number of non-negligible singular values. - - - - Gets a value indicating whether the matrix is full rank or not. - - true if the matrix is full rank; otherwise false. - - - - A class which encapsulates the functionality of the QR decomposition Modified Gram-Schmidt Orthogonalization. - Any real square matrix A may be decomposed as A = QR where Q is an orthogonal mxn matrix and R is an nxn upper triangular matrix. - - - The computation of the QR decomposition is done at construction time by modified Gram-Schmidt Orthogonalization. - - - - - Gets the absolute determinant value of the matrix for which the QR matrix was computed. - - - - - Gets a value indicating whether the matrix is full rank or not. - - true if the matrix is full rank; otherwise false. - - - - A class which encapsulates the functionality of an LU factorization. - For a matrix A, the LU factorization is a pair of lower triangular matrix L and - upper triangular matrix U so that A = L*U. - In the Math.NET implementation we also store a set of pivot elements for increased - numerical stability. The pivot elements encode a permutation matrix P such that P*A = L*U. - - - The computation of the LU factorization is done at construction time. - - - - - Gets the determinant of the matrix for which the LU factorization was computed. - - - - - A class which encapsulates the functionality of the QR decomposition. - Any real square matrix A (m x n) may be decomposed as A = QR where Q is an orthogonal matrix - (its columns are orthogonal unit vectors meaning QTQ = I) and R is an upper triangular matrix - (also called right triangular matrix). - - - The computation of the QR decomposition is done at construction time by Householder transformation. - If a factorization is performed, the resulting Q matrix is an m x m matrix - and the R matrix is an m x n matrix. If a factorization is performed, the - resulting Q matrix is an m x n matrix and the R matrix is an n x n matrix. - - - - - Gets the absolute determinant value of the matrix for which the QR matrix was computed. - - - - - Gets a value indicating whether the matrix is full rank or not. - - true if the matrix is full rank; otherwise false. - - - - A class which encapsulates the functionality of the singular value decomposition (SVD). - Suppose M is an m-by-n matrix whose entries are real numbers. - Then there exists a factorization of the form M = UΣVT where: - - U is an m-by-m unitary matrix; - - Σ is m-by-n diagonal matrix with nonnegative real numbers on the diagonal; - - VT denotes transpose of V, an n-by-n unitary matrix; - Such a factorization is called a singular-value decomposition of M. A common convention is to order the diagonal - entries Σ(i,i) in descending order. In this case, the diagonal matrix Σ is uniquely determined - by M (though the matrices U and V are not). The diagonal entries of Σ are known as the singular values of M. - - - The computation of the singular value decomposition is done at construction time. - - - - - Gets the effective numerical matrix rank. - - The number of non-negligible singular values. - - - - Gets the two norm of the . - - The 2-norm of the . - - - - Gets the condition number max(S) / min(S) - - The condition number. - - - - Gets the determinant of the square matrix for which the SVD was computed. - - - - - A class which encapsulates the functionality of a Cholesky factorization for user matrices. - For a symmetric, positive definite matrix A, the Cholesky factorization - is an lower triangular matrix L so that A = L*L'. - - - The computation of the Cholesky factorization is done at construction time. If the matrix is not symmetric - or positive definite, the constructor will throw an exception. - - - - - Computes the Cholesky factorization in-place. - - On entry, the matrix to factor. On exit, the Cholesky factor matrix - If is null. - If is not a square matrix. - If is not positive definite. - - - - Initializes a new instance of the class. This object will compute the - Cholesky factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - If is null. - If is not a square matrix. - If is not positive definite. - - - - Calculates the Cholesky factorization of the input matrix. - - The matrix to be factorized. - If is null. - If is not a square matrix. - If is not positive definite. - If does not have the same dimensions as the existing factor. - - - - Calculate Cholesky step - - Factor matrix - Number of rows - Column start - Total columns - Multipliers calculated previously - Number of available processors - - - - Solves a system of linear equations, AX = B, with A Cholesky factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A Cholesky factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Eigenvalues and eigenvectors of a complex matrix. - - - If A is Hermitian, then A = V*D*V' where the eigenvalue matrix D is - diagonal and the eigenvector matrix V is Hermitian. - I.e. A = V*D*V' and V*VH=I. - If A is not symmetric, then the eigenvalue matrix D is block diagonal - with the real eigenvalues in 1-by-1 blocks and any complex eigenvalues, - lambda + i*mu, in 2-by-2 blocks, [lambda, mu; -mu, lambda]. The - columns of V represent the eigenvectors in the sense that A*V = V*D, - i.e. A.Multiply(V) equals V.Multiply(D). The matrix V may be badly - conditioned, or even singular, so the validity of the equation - A = V*D*Inverse(V) depends upon V.Condition(). - - - - - Initializes a new instance of the class. This object will compute the - the eigenvalue decomposition when the constructor is called and cache it's decomposition. - - The matrix to factor. - If it is known whether the matrix is symmetric or not the routine can skip checking it itself. - If is null. - If EVD algorithm failed to converge with matrix . - - - - Reduces a complex Hermitian matrix to a real symmetric tridiagonal matrix using unitary similarity transformations. - - Source matrix to reduce - Output: Arrays for internal storage of real parts of eigenvalues - Output: Arrays for internal storage of imaginary parts of eigenvalues - Output: Arrays that contains further information about the transformations. - Order of initial matrix - This is derived from the Algol procedures HTRIDI by - Smith, Boyle, Dongarra, Garbow, Ikebe, Klema, Moler, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Symmetric tridiagonal QL algorithm. - - The eigen vectors to work on. - Arrays for internal storage of real parts of eigenvalues - Arrays for internal storage of imaginary parts of eigenvalues - Order of initial matrix - This is derived from the Algol procedures tql2, by - Bowdler, Martin, Reinsch, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - - Determines eigenvectors by undoing the symmetric tridiagonalize transformation - - The eigen vectors to work on. - Previously tridiagonalized matrix by . - Contains further information about the transformations - Input matrix order - This is derived from the Algol procedures HTRIBK, by - by Smith, Boyle, Dongarra, Garbow, Ikebe, Klema, Moler, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Nonsymmetric reduction to Hessenberg form. - - The eigen vectors to work on. - Array for internal storage of nonsymmetric Hessenberg form. - Order of initial matrix - This is derived from the Algol procedures orthes and ortran, - by Martin and Wilkinson, Handbook for Auto. Comp., - Vol.ii-Linear Algebra, and the corresponding - Fortran subroutines in EISPACK. - - - - Nonsymmetric reduction from Hessenberg to real Schur form. - - The eigen vectors to work on. - The eigen values to work on. - Array for internal storage of nonsymmetric Hessenberg form. - Order of initial matrix - This is derived from the Algol procedure hqr2, - by Martin and Wilkinson, Handbook for Auto. Comp., - Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A EVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the QR decomposition Modified Gram-Schmidt Orthogonalization. - Any complex square matrix A may be decomposed as A = QR where Q is an unitary mxn matrix and R is an nxn upper triangular matrix. - - - The computation of the QR decomposition is done at construction time by modified Gram-Schmidt Orthogonalization. - - - - - Initializes a new instance of the class. This object creates an unitary matrix - using the modified Gram-Schmidt method. - - The matrix to factor. - If is null. - If row count is less then column count - If is rank deficient - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of an LU factorization. - For a matrix A, the LU factorization is a pair of lower triangular matrix L and - upper triangular matrix U so that A = L*U. - - - The computation of the LU factorization is done at construction time. - - - - - Initializes a new instance of the class. This object will compute the - LU factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - If is null. - If is not a square matrix. - - - - Solves a system of linear equations, AX = B, with A LU factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A LU factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Returns the inverse of this matrix. The inverse is calculated using LU decomposition. - - The inverse of this matrix. - - - - A class which encapsulates the functionality of the QR decomposition. - Any real square matrix A may be decomposed as A = QR where Q is an orthogonal matrix - (its columns are orthogonal unit vectors meaning QTQ = I) and R is an upper triangular matrix - (also called right triangular matrix). - - - The computation of the QR decomposition is done at construction time by Householder transformation. - - - - - Initializes a new instance of the class. This object will compute the - QR factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - The QR factorization method to use. - If is null. - - - - Generate column from initial matrix to work array - - Initial matrix - The first row - Column index - Generated vector - - - - Perform calculation of Q or R - - Work array - Q or R matrices - The first row - The last row - The first column - The last column - Number of available CPUs - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the singular value decomposition (SVD) for . - Suppose M is an m-by-n matrix whose entries are real numbers. - Then there exists a factorization of the form M = UΣVT where: - - U is an m-by-m unitary matrix; - - Σ is m-by-n diagonal matrix with nonnegative real numbers on the diagonal; - - VT denotes transpose of V, an n-by-n unitary matrix; - Such a factorization is called a singular-value decomposition of M. A common convention is to order the diagonal - entries Σ(i,i) in descending order. In this case, the diagonal matrix Σ is uniquely determined - by M (though the matrices U and V are not). The diagonal entries of Σ are known as the singular values of M. - - - The computation of the singular value decomposition is done at construction time. - - - - - Initializes a new instance of the class. This object will compute the - the singular value decomposition when the constructor is called and cache it's decomposition. - - The matrix to factor. - Compute the singular U and VT vectors or not. - If is null. - - - - - Calculates absolute value of multiplied on signum function of - - Complex value z1 - Complex value z2 - Result multiplication of signum function and absolute value - - - - Interchanges two vectors and - - Source matrix - The number of rows in - Column A index to swap - Column B index to swap - - - - Scale column by starting from row - - Source matrix - The number of rows in - Column to scale - Row to scale from - Scale value - - - - Scale vector by starting from index - - Source vector - Row to scale from - Scale value - - - - Given the Cartesian coordinates (da, db) of a point p, these function return the parameters da, db, c, and s - associated with the Givens rotation that zeros the y-coordinate of the point. - - Provides the x-coordinate of the point p. On exit contains the parameter r associated with the Givens rotation - Provides the y-coordinate of the point p. On exit contains the parameter z associated with the Givens rotation - Contains the parameter c associated with the Givens rotation - Contains the parameter s associated with the Givens rotation - This is equivalent to the DROTG LAPACK routine. - - - - Calculate Norm 2 of the column in matrix starting from row - - Source matrix - The number of rows in - Column index - Start row index - Norm2 (Euclidean norm) of the column - - - - Calculate Norm 2 of the vector starting from index - - Source vector - Start index - Norm2 (Euclidean norm) of the vector - - - - Calculate dot product of and conjugating the first vector. - - Source matrix - The number of rows in - Index of column A - Index of column B - Starting row index - Dot product value - - - - Performs rotation of points in the plane. Given two vectors x and y , - each vector element of these vectors is replaced as follows: x(i) = c*x(i) + s*y(i); y(i) = c*y(i) - s*x(i) - - Source matrix - The number of rows in - Index of column A - Index of column B - scalar cos value - scalar sin value - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A SVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Complex version of the class. - - - - - Initializes a new instance of the Matrix class. - - - - - Set all values whose absolute value is smaller than the threshold to zero. - - - - - Returns the conjugate transpose of this matrix. - - The conjugate transpose of this matrix. - - - - Puts the conjugate transpose of this matrix into the result matrix. - - - - - Complex conjugates each element of this matrix and place the results into the result matrix. - - The result of the conjugation. - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - - - - Add a scalar to each element of the matrix and stores the result in the result vector. - - The scalar to add. - The matrix to store the result of the addition. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of the addition. - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - The scalar to subtract. - The matrix to store the result of the subtraction. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract to this matrix. - The matrix to store the result of subtraction. - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Divides each element of the matrix by a scalar and places results into the result matrix. - - The scalar to divide the matrix with. - The matrix to store the result of the division. - - - - Divides a scalar by each element of the matrix and stores the result in the result matrix. - - The scalar to divide by each element of the matrix. - The matrix to store the result of the division. - - - - Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. - - The matrix to pointwise multiply with this one. - The matrix to store the result of the pointwise multiplication. - - - - Pointwise divide this matrix by another matrix and stores the result into the result matrix. - - The matrix to pointwise divide this one by. - The matrix to store the result of the pointwise division. - - - - Pointwise raise this matrix to an exponent and store the result into the result matrix. - - The exponent to raise this matrix values to. - The matrix to store the result of the pointwise power. - - - - Pointwise raise this matrix to an exponent and store the result into the result matrix. - - The exponent to raise this matrix values to. - The vector to store the result of the pointwise power. - - - - Pointwise canonical modulus, where the result has the sign of the divisor, - of this matrix with another matrix and stores the result into the result matrix. - - The pointwise denominator matrix to use - The result of the modulus. - - - - Pointwise remainder (% operator), where the result has the sign of the dividend, - of this matrix with another matrix and stores the result into the result matrix. - - The pointwise denominator matrix to use - The result of the modulus. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - Pointwise applies the exponential function to each value and stores the result into the result matrix. - - The matrix to store the result. - - - - Pointwise applies the natural logarithm function to each value and stores the result into the result matrix. - - The matrix to store the result. - - - - Computes the Moore-Penrose Pseudo-Inverse of this matrix. - - - - - Computes the trace of this matrix. - - The trace of this matrix - If the matrix is not square - - - Calculates the induced L1 norm of this matrix. - The maximum absolute column sum of the matrix. - - - Calculates the induced infinity norm of this matrix. - The maximum absolute row sum of the matrix. - - - Calculates the entry-wise Frobenius norm of this matrix. - The square root of the sum of the squared values. - - - - Calculates the p-norms of all row vectors. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Calculates the p-norms of all column vectors. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Normalizes all row vectors to a unit p-norm. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Normalizes all column vectors to a unit p-norm. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Calculates the value sum of each row vector. - - - - - Calculates the absolute value sum of each row vector. - - - - - Calculates the value sum of each column vector. - - - - - Calculates the absolute value sum of each column vector. - - - - - Evaluates whether this matrix is Hermitian (conjugate symmetric). - - - - - A Bi-Conjugate Gradient stabilized iterative matrix solver. - - - - The Bi-Conjugate Gradient Stabilized (BiCGStab) solver is an 'improvement' - of the standard Conjugate Gradient (CG) solver. Unlike the CG solver the - BiCGStab can be used on non-symmetric matrices.
    - Note that much of the success of the solver depends on the selection of the - proper preconditioner. -
    - - The Bi-CGSTAB algorithm was taken from:
    - Templates for the solution of linear systems: Building blocks - for iterative methods -
    - Richard Barrett, Michael Berry, Tony F. Chan, James Demmel, - June M. Donato, Jack Dongarra, Victor Eijkhout, Roldan Pozo, - Charles Romine and Henk van der Vorst -
    - Url: http://www.netlib.org/templates/Templates.html -
    - Algorithm is described in Chapter 2, section 2.3.8, page 27 -
    - - The example code below provides an indication of the possible use of the - solver. - -
    -
    - - - Calculates the true residual of the matrix equation Ax = b according to: residual = b - Ax - - Instance of the A. - Residual values in . - Instance of the x. - Instance of the b. - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient , A. - The solution , b. - The result , x. - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - A composite matrix solver. The actual solver is made by a sequence of - matrix solvers. - - - - Solver based on:
    - Faster PDE-based simulations using robust composite linear solvers
    - S. Bhowmicka, P. Raghavan a,*, L. McInnes b, B. Norris
    - Future Generation Computer Systems, Vol 20, 2004, pp 373�387
    -
    - - Note that if an iterator is passed to this solver it will be used for all the sub-solvers. - -
    -
    - - - The collection of solvers that will be used - - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient matrix, A. - The solution vector, b - The result vector, x - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - A diagonal preconditioner. The preconditioner uses the inverse - of the matrix diagonal as preconditioning values. - - - - - The inverse of the matrix diagonal. - - - - - Returns the decomposed matrix diagonal. - - The matrix diagonal. - - - - Initializes the preconditioner and loads the internal data structures. - - - The upon which this preconditioner is based. - If is . - If is not a square matrix. - - - - Approximates the solution to the matrix equation Ax = b. - - The right hand side vector. - The left hand side vector. Also known as the result vector. - - - - A Generalized Product Bi-Conjugate Gradient iterative matrix solver. - - - - The Generalized Product Bi-Conjugate Gradient (GPBiCG) solver is an - alternative version of the Bi-Conjugate Gradient stabilized (CG) solver. - Unlike the CG solver the GPBiCG solver can be used on - non-symmetric matrices.
    - Note that much of the success of the solver depends on the selection of the - proper preconditioner. -
    - - The GPBiCG algorithm was taken from:
    - GPBiCG(m,l): A hybrid of BiCGSTAB and GPBiCG methods with - efficiency and robustness -
    - S. Fujino -
    - Applied Numerical Mathematics, Volume 41, 2002, pp 107 - 117 -
    -
    - - The example code below provides an indication of the possible use of the - solver. - -
    -
    - - - Indicates the number of BiCGStab steps should be taken - before switching. - - - - - Indicates the number of GPBiCG steps should be taken - before switching. - - - - - Gets or sets the number of steps taken with the BiCgStab algorithm - before switching over to the GPBiCG algorithm. - - - - - Gets or sets the number of steps taken with the GPBiCG algorithm - before switching over to the BiCgStab algorithm. - - - - - Calculates the true residual of the matrix equation Ax = b according to: residual = b - Ax - - Instance of the A. - Residual values in . - Instance of the x. - Instance of the b. - - - - Decide if to do steps with BiCgStab - - Number of iteration - true if yes, otherwise false - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient matrix, A. - The solution vector, b - The result vector, x - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - An incomplete, level 0, LU factorization preconditioner. - - - The ILU(0) algorithm was taken from:
    - Iterative methods for sparse linear systems
    - Yousef Saad
    - Algorithm is described in Chapter 10, section 10.3.2, page 275
    -
    -
    - - - The matrix holding the lower (L) and upper (U) matrices. The - decomposition matrices are combined to reduce storage. - - - - - Returns the upper triagonal matrix that was created during the LU decomposition. - - A new matrix containing the upper triagonal elements. - - - - Returns the lower triagonal matrix that was created during the LU decomposition. - - A new matrix containing the lower triagonal elements. - - - - Initializes the preconditioner and loads the internal data structures. - - The matrix upon which the preconditioner is based. - If is . - If is not a square matrix. - - - - Approximates the solution to the matrix equation Ax = b. - - The right hand side vector. - The left hand side vector. Also known as the result vector. - - - - This class performs an Incomplete LU factorization with drop tolerance - and partial pivoting. The drop tolerance indicates which additional entries - will be dropped from the factorized LU matrices. - - - The ILUTP-Mem algorithm was taken from:
    - ILUTP_Mem: a Space-Efficient Incomplete LU Preconditioner -
    - Tzu-Yi Chen, Department of Mathematics and Computer Science,
    - Pomona College, Claremont CA 91711, USA
    - Published in:
    - Lecture Notes in Computer Science
    - Volume 3046 / 2004
    - pp. 20 - 28
    - Algorithm is described in Section 2, page 22 -
    -
    - - - The default fill level. - - - - - The default drop tolerance. - - - - - The decomposed upper triangular matrix. - - - - - The decomposed lower triangular matrix. - - - - - The array containing the pivot values. - - - - - The fill level. - - - - - The drop tolerance. - - - - - The pivot tolerance. - - - - - Initializes a new instance of the class with the default settings. - - - - - Initializes a new instance of the class with the specified settings. - - - The amount of fill that is allowed in the matrix. The value is a fraction of - the number of non-zero entries in the original matrix. Values should be positive. - - - The absolute drop tolerance which indicates below what absolute value an entry - will be dropped from the matrix. A drop tolerance of 0.0 means that no values - will be dropped. Values should always be positive. - - - The pivot tolerance which indicates at what level pivoting will take place. A - value of 0.0 means that no pivoting will take place. - - - - - Gets or sets the amount of fill that is allowed in the matrix. The - value is a fraction of the number of non-zero entries in the original - matrix. The standard value is 200. - - - - Values should always be positive and can be higher than 1.0. A value lower - than 1.0 means that the eventual preconditioner matrix will have fewer - non-zero entries as the original matrix. A value higher than 1.0 means that - the eventual preconditioner can have more non-zero values than the original - matrix. - - - Note that any changes to the FillLevel after creating the preconditioner - will invalidate the created preconditioner and will require a re-initialization of - the preconditioner. - - - Thrown if a negative value is provided. - - - - Gets or sets the absolute drop tolerance which indicates below what absolute value - an entry will be dropped from the matrix. The standard value is 0.0001. - - - - The values should always be positive and can be larger than 1.0. A low value will - keep more small numbers in the preconditioner matrix. A high value will remove - more small numbers from the preconditioner matrix. - - - Note that any changes to the DropTolerance after creating the preconditioner - will invalidate the created preconditioner and will require a re-initialization of - the preconditioner. - - - Thrown if a negative value is provided. - - - - Gets or sets the pivot tolerance which indicates at what level pivoting will - take place. The standard value is 0.0 which means pivoting will never take place. - - - - The pivot tolerance is used to calculate if pivoting is necessary. Pivoting - will take place if any of the values in a row is bigger than the - diagonal value of that row divided by the pivot tolerance, i.e. pivoting - will take place if row(i,j) > row(i,i) / PivotTolerance for - any j that is not equal to i. - - - Note that any changes to the PivotTolerance after creating the preconditioner - will invalidate the created preconditioner and will require a re-initialization of - the preconditioner. - - - Thrown if a negative value is provided. - - - - Returns the upper triagonal matrix that was created during the LU decomposition. - - - This method is used for debugging purposes only and should normally not be used. - - A new matrix containing the upper triagonal elements. - - - - Returns the lower triagonal matrix that was created during the LU decomposition. - - - This method is used for debugging purposes only and should normally not be used. - - A new matrix containing the lower triagonal elements. - - - - Returns the pivot array. This array is not needed for normal use because - the preconditioner will return the solution vector values in the proper order. - - - This method is used for debugging purposes only and should normally not be used. - - The pivot array. - - - - Initializes the preconditioner and loads the internal data structures. - - - The upon which this preconditioner is based. Note that the - method takes a general matrix type. However internally the data is stored - as a sparse matrix. Therefore it is not recommended to pass a dense matrix. - - If is . - If is not a square matrix. - - - - Pivot elements in the according to internal pivot array - - Row to pivot in - - - - Was pivoting already performed - - Pivots already done - Current item to pivot - true if performed, otherwise false - - - - Swap columns in the - - Source . - First column index to swap - Second column index to swap - - - - Sort vector descending, not changing vector but placing sorted indices to - - Start sort form - Sort till upper bound - Array with sorted vector indices - Source - - - - Approximates the solution to the matrix equation Ax = b. - - The right hand side vector. - The left hand side vector. Also known as the result vector. - - - - Pivot elements in according to internal pivot array - - Source . - Result after pivoting. - - - - An element sort algorithm for the class. - - - This sort algorithm is used to sort the columns in a sparse matrix based on - the value of the element on the diagonal of the matrix. - - - - - Sorts the elements of the vector in decreasing - fashion. The vector itself is not affected. - - The starting index. - The stopping index. - An array that will contain the sorted indices once the algorithm finishes. - The that contains the values that need to be sorted. - - - - Sorts the elements of the vector in decreasing - fashion using heap sort algorithm. The vector itself is not affected. - - The starting index. - The stopping index. - An array that will contain the sorted indices once the algorithm finishes. - The that contains the values that need to be sorted. - - - - Build heap for double indices - - Root position - Length of - Indices of - Target - - - - Sift double indices - - Indices of - Target - Root position - Length of - - - - Sorts the given integers in a decreasing fashion. - - The values. - - - - Sort the given integers in a decreasing fashion using heapsort algorithm - - Array of values to sort - Length of - - - - Build heap - - Target values array - Root position - Length of - - - - Sift values - - Target value array - Root position - Length of - - - - Exchange values in array - - Target values array - First value to exchange - Second value to exchange - - - - A simple milu(0) preconditioner. - - - Original Fortran code by Yousef Saad (07 January 2004) - - - - Use modified or standard ILU(0) - - - - Gets or sets a value indicating whether to use modified or standard ILU(0). - - - - - Gets a value indicating whether the preconditioner is initialized. - - - - - Initializes the preconditioner and loads the internal data structures. - - The matrix upon which the preconditioner is based. - If is . - If is not a square or is not an - instance of SparseCompressedRowMatrixStorage. - - - - Approximates the solution to the matrix equation Ax = b. - - The right hand side vector b. - The left hand side vector x. - - - - MILU0 is a simple milu(0) preconditioner. - - Order of the matrix. - Matrix values in CSR format (input). - Column indices (input). - Row pointers (input). - Matrix values in MSR format (output). - Row pointers and column indices (output). - Pointer to diagonal elements (output). - True if the modified/MILU algorithm should be used (recommended) - Returns 0 on success or k > 0 if a zero pivot was encountered at step k. - - - - A Multiple-Lanczos Bi-Conjugate Gradient stabilized iterative matrix solver. - - - - The Multiple-Lanczos Bi-Conjugate Gradient stabilized (ML(k)-BiCGStab) solver is an 'improvement' - of the standard BiCgStab solver. - - - The algorithm was taken from:
    - ML(k)BiCGSTAB: A BiCGSTAB variant based on multiple Lanczos starting vectors -
    - Man-Chung Yeung and Tony F. Chan -
    - SIAM Journal of Scientific Computing -
    - Volume 21, Number 4, pp. 1263 - 1290 -
    - - The example code below provides an indication of the possible use of the - solver. - -
    -
    - - - The default number of starting vectors. - - - - - The collection of starting vectors which are used as the basis for the Krylov sub-space. - - - - - The number of starting vectors used by the algorithm - - - - - Gets or sets the number of starting vectors. - - - Must be larger than 1 and smaller than the number of variables in the matrix that - for which this solver will be used. - - - - - Resets the number of starting vectors to the default value. - - - - - Gets or sets a series of orthonormal vectors which will be used as basis for the - Krylov sub-space. - - - - - Gets the number of starting vectors to create - - Maximum number - Number of variables - Number of starting vectors to create - - - - Returns an array of starting vectors. - - The maximum number of starting vectors that should be created. - The number of variables. - - An array with starting vectors. The array will never be larger than the - but it may be smaller if - the is smaller than - the . - - - - - Create random vectors array - - Number of vectors - Size of each vector - Array of random vectors - - - - Calculates the true residual of the matrix equation Ax = b according to: residual = b - Ax - - Source A. - Residual data. - x data. - b data. - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient matrix, A. - The solution vector, b - The result vector, x - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - A Transpose Free Quasi-Minimal Residual (TFQMR) iterative matrix solver. - - - - The TFQMR algorithm was taken from:
    - Iterative methods for sparse linear systems. -
    - Yousef Saad -
    - Algorithm is described in Chapter 7, section 7.4.3, page 219 -
    - - The example code below provides an indication of the possible use of the - solver. - -
    -
    - - - Calculates the true residual of the matrix equation Ax = b according to: residual = b - Ax - - Instance of the A. - Residual values in . - Instance of the x. - Instance of the b. - - - - Is even? - - Number to check - true if even, otherwise false - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient matrix, A. - The solution vector, b - The result vector, x - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - A Matrix with sparse storage, intended for very large matrices where most of the cells are zero. - The underlying storage scheme is 3-array compressed-sparse-row (CSR) Format. - Wikipedia - CSR. - - - - - Gets the number of non zero elements in the matrix. - - The number of non zero elements. - - - - Create a new sparse matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new square sparse matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the order is less than one. - - - - Create a new sparse matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the row or column count is less than one. - - - - Create a new sparse matrix as a copy of the given other matrix. - This new matrix will be independent from the other matrix. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given two-dimensional array. - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable. - The enumerable is assumed to be in row-major order (row by row). - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - - Create a new sparse matrix with the given number of rows and columns as a copy of the given array. - The array is assumed to be in column-major order (column by column). - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix and initialize each value to the same provided value. - - - - - Create a new sparse matrix and initialize each value using the provided init function. - - - - - Create a new diagonal sparse matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal sparse matrix and initialize each diagonal value using the provided init function. - - - - - Create a new square sparse identity matrix where each diagonal value is set to One. - - - - - Returns a new matrix containing the lower triangle of this matrix. - - The lower triangle of this matrix. - - - - Puts the lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Puts the lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - - - - Returns a new matrix containing the upper triangle of this matrix. - - The upper triangle of this matrix. - - - - Puts the upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Puts the upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - - - - Returns a new matrix containing the lower triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The lower triangle of this matrix. - - - - Puts the strictly lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Puts the strictly lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - - - - Returns a new matrix containing the upper triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The upper triangle of this matrix. - - - - Puts the strictly upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Puts the strictly upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - - - Calculates the induced infinity norm of this matrix. - The maximum absolute row sum of the matrix. - - - Calculates the entry-wise Frobenius norm of this matrix. - The square root of the sum of the squared values. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of the addition. - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract to this matrix. - The matrix to store the result of subtraction. - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. - - The matrix to pointwise multiply with this one. - The matrix to store the result of the pointwise multiplication. - - - - Pointwise divide this matrix by another matrix and stores the result into the result matrix. - - The matrix to pointwise divide this one by. - The matrix to store the result of the pointwise division. - - - - Evaluates whether this matrix is symmetric. - - - - - Evaluates whether this matrix is Hermitian (conjugate symmetric). - - - - - Adds two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to add. - The right matrix to add. - The result of the addition. - If and don't have the same dimensions. - If or is . - - - - Returns a Matrix containing the same values of . - - The matrix to get the values from. - A matrix containing a the same values as . - If is . - - - - Subtracts two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to subtract. - The right matrix to subtract. - The result of the addition. - If and don't have the same dimensions. - If or is . - - - - Negates each element of the matrix. - - The matrix to negate. - A matrix containing the negated values. - If is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies two matrices. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to multiply. - The right matrix to multiply. - The result of multiplication. - If or is . - If the dimensions of or don't conform. - - - - Multiplies a Matrix and a Vector. - - The matrix to multiply. - The vector to multiply. - The result of multiplication. - If or is . - - - - Multiplies a Vector and a Matrix. - - The vector to multiply. - The matrix to multiply. - The result of multiplication. - If or is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - A vector with sparse storage, intended for very large vectors where most of the cells are zero. - - The sparse vector is not thread safe. - - - - Gets the number of non zero elements in the vector. - - The number of non zero elements. - - - - Create a new sparse vector straight from an initialized vector storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new sparse vector with the given length. - All cells of the vector will be initialized to zero. - - If length is less than one. - - - - Create a new sparse vector as a copy of the given other vector. - This new vector will be independent from the other vector. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given enumerable. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector and initialize each value using the provided value. - - - - - Create a new sparse vector and initialize each value using the provided init function. - - - - - Adds a scalar to each element of the vector and stores the result in the result vector. - Warning, the new 'sparse vector' with a non-zero scalar added to it will be a 100% filled - sparse vector and very inefficient. Would be better to work with a dense vector instead. - - - The scalar to add. - - - The vector to store the result of the addition. - - - - - Adds another vector to this vector and stores the result into the result vector. - - - The vector to add to this one. - - - The vector to store the result of the addition. - - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - - The scalar to subtract. - - - The vector to store the result of the subtraction. - - - - - Subtracts another vector to this vector and stores the result into the result vector. - - - The vector to subtract from this one. - - - The vector to store the result of the subtraction. - - - - - Negates vector and saves result to - - Target vector - - - - Conjugates vector and save result to - - Target vector - - - - Multiplies a scalar to each element of the vector and stores the result in the result vector. - - - The scalar to multiply. - - - The vector to store the result of the multiplication. - - - - - Computes the dot product between this vector and another vector. - - The other vector. - The sum of a[i]*b[i] for all i. - - - - Computes the dot product between the conjugate of this vector and another vector. - - The other vector. - The sum of conj(a[i])*b[i] for all i. - - - - Adds two Vectors together and returns the results. - - One of the vectors to add. - The other vector to add. - The result of the addition. - If and are not the same size. - If or is . - - - - Returns a Vector containing the negated values of . - - The vector to get the values from. - A vector containing the negated values as . - If is . - - - - Subtracts two Vectors and returns the results. - - The vector to subtract from. - The vector to subtract. - The result of the subtraction. - If and are not the same size. - If or is . - - - - Multiplies a vector with a complex. - - The vector to scale. - The complex value. - The result of the multiplication. - If is . - - - - Multiplies a vector with a complex. - - The complex value. - The vector to scale. - The result of the multiplication. - If is . - - - - Computes the dot product between two Vectors. - - The left row vector. - The right column vector. - The dot product between the two vectors. - If and are not the same size. - If or is . - - - - Divides a vector with a complex. - - The vector to divide. - The complex value. - The result of the division. - If is . - - - - Computes the modulus of each element of the vector of the given divisor. - - The vector whose elements we want to compute the modulus of. - The divisor to use, - The result of the calculation - If is . - - - - Returns the index of the absolute minimum element. - - The index of absolute minimum element. - - - - Returns the index of the absolute maximum element. - - The index of absolute maximum element. - - - - Computes the sum of the vector's elements. - - The sum of the vector's elements. - - - - Calculates the L1 norm of the vector, also known as Manhattan norm. - - The sum of the absolute values. - - - - Calculates the infinity norm of the vector. - - The maximum absolute value. - - - - Computes the p-Norm. - - The p value. - Scalar ret = ( ∑|this[i]|^p )^(1/p) - - - - Pointwise multiplies this vector with another vector and stores the result into the result vector. - - The vector to pointwise multiply with this one. - The vector to store the result of the pointwise multiplication. - - - - Creates a double sparse vector based on a string. The string can be in the following formats (without the - quotes): 'n', 'n;n;..', '(n;n;..)', '[n;n;...]', where n is a Complex. - - - A double sparse vector containing the values specified by the given string. - - - the string to parse. - - - An that supplies culture-specific formatting information. - - - - - Converts the string representation of a complex sparse vector to double-precision sparse vector equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a complex vector to convert. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will be null. - - - - - Converts the string representation of a complex sparse vector to double-precision sparse vector equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a complex vector to convert. - - - An that supplies culture-specific formatting information about value. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will be null. - - - - - Complex version of the class. - - - - - Initializes a new instance of the Vector class. - - - - - Set all values whose absolute value is smaller than the threshold to zero. - - - - - Conjugates vector and save result to - - Target vector - - - - Negates vector and saves result to - - Target vector - - - - Adds a scalar to each element of the vector and stores the result in the result vector. - - - The scalar to add. - - - The vector to store the result of the addition. - - - - - Adds another vector to this vector and stores the result into the result vector. - - - The vector to add to this one. - - - The vector to store the result of the addition. - - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - - The scalar to subtract. - - - The vector to store the result of the subtraction. - - - - - Subtracts another vector to this vector and stores the result into the result vector. - - - The vector to subtract from this one. - - - The vector to store the result of the subtraction. - - - - - Multiplies a scalar to each element of the vector and stores the result in the result vector. - - - The scalar to multiply. - - - The vector to store the result of the multiplication. - - - - - Divides each element of the vector by a scalar and stores the result in the result vector. - - - The scalar to divide with. - - - The vector to store the result of the division. - - - - - Divides a scalar by each element of the vector and stores the result in the result vector. - - The scalar to divide. - The vector to store the result of the division. - - - - Pointwise multiplies this vector with another vector and stores the result into the result vector. - - The vector to pointwise multiply with this one. - The vector to store the result of the pointwise multiplication. - - - - Pointwise divide this vector with another vector and stores the result into the result vector. - - The vector to pointwise divide this one by. - The vector to store the result of the pointwise division. - - - - Pointwise raise this vector to an exponent and store the result into the result vector. - - The exponent to raise this vector values to. - The vector to store the result of the pointwise power. - - - - Pointwise raise this vector to an exponent vector and store the result into the result vector. - - The exponent vector to raise this vector values to. - The vector to store the result of the pointwise power. - - - - Pointwise canonical modulus, where the result has the sign of the divisor, - of this vector with another vector and stores the result into the result vector. - - The pointwise denominator vector to use. - The result of the modulus. - - - - Pointwise remainder (% operator), where the result has the sign of the dividend, - of this vector with another vector and stores the result into the result vector. - - The pointwise denominator vector to use. - The result of the modulus. - - - - Pointwise applies the exponential function to each value and stores the result into the result vector. - - The vector to store the result. - - - - Pointwise applies the natural logarithm function to each value and stores the result into the result vector. - - The vector to store the result. - - - - Computes the dot product between this vector and another vector. - - The other vector. - The sum of a[i]*b[i] for all i. - - - - Computes the dot product between the conjugate of this vector and another vector. - - The other vector. - The sum of conj(a[i])*b[i] for all i. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given dividend for each element of the vector. - - The scalar numerator to use. - A vector to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given dividend for each element of the vector. - - The scalar numerator to use. - A vector to store the results in. - - - - Returns the value of the absolute minimum element. - - The value of the absolute minimum element. - - - - Returns the index of the absolute minimum element. - - The index of absolute minimum element. - - - - Returns the value of the absolute maximum element. - - The value of the absolute maximum element. - - - - Returns the index of the absolute maximum element. - - The index of absolute maximum element. - - - - Computes the sum of the vector's elements. - - The sum of the vector's elements. - - - - Calculates the L1 norm of the vector, also known as Manhattan norm. - - The sum of the absolute values. - - - - Calculates the L2 norm of the vector, also known as Euclidean norm. - - The square root of the sum of the squared values. - - - - Calculates the infinity norm of the vector. - - The maximum absolute value. - - - - Computes the p-Norm. - - - The p value. - - - Scalar ret = ( ∑|At(i)|^p )^(1/p) - - - - - Returns the index of the maximum element. - - The index of maximum element. - - - - Returns the index of the minimum element. - - The index of minimum element. - - - - Normalizes this vector to a unit vector with respect to the p-norm. - - - The p value. - - - This vector normalized to a unit vector with respect to the p-norm. - - - - - A Matrix class with dense storage. The underlying storage is a one dimensional array in column-major order (column by column). - - - - - Number of rows. - - Using this instead of the RowCount property to speed up calculating - a matrix index in the data array. - - - - Number of columns. - - Using this instead of the ColumnCount property to speed up calculating - a matrix index in the data array. - - - - Gets the matrix's data. - - The matrix's data. - - - - Create a new dense matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new square dense matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the order is less than one. - - - - Create a new dense matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the row or column count is less than one. - - - - Create a new dense matrix with the given number of rows and columns directly binding to a raw array. - The array is assumed to be in column-major order (column by column) and is used directly without copying. - Very efficient, but changes to the array and the matrix will affect each other. - - - - - - Create a new dense matrix as a copy of the given other matrix. - This new matrix will be independent from the other matrix. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given two-dimensional array. - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable. - The enumerable is assumed to be in column-major order (column by column). - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix and initialize each value to the same provided value. - - - - - Create a new dense matrix and initialize each value using the provided init function. - - - - - Create a new diagonal dense matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal dense matrix and initialize each diagonal value using the provided init function. - - - - - Create a new square sparse identity matrix where each diagonal value is set to One. - - - - - Create a new dense matrix with values sampled from the provided random distribution. - - - - - Gets the matrix's data. - - The matrix's data. - - - Calculates the induced L1 norm of this matrix. - The maximum absolute column sum of the matrix. - - - Calculates the induced infinity norm of this matrix. - The maximum absolute row sum of the matrix. - - - Calculates the entry-wise Frobenius norm of this matrix. - The square root of the sum of the squared values. - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - - - - Complex conjugates each element of this matrix and place the results into the result matrix. - - The result of the conjugation. - - - - Add a scalar to each element of the matrix and stores the result in the result vector. - - The scalar to add. - The matrix to store the result of the addition. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of add - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Subtracts a scalar from each element of the matrix and stores the result in the result vector. - - The scalar to subtract. - The matrix to store the result of the subtraction. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract. - The matrix to store the result of the subtraction. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Divides each element of the matrix by a scalar and places results into the result matrix. - - The scalar to divide the matrix with. - The matrix to store the result of the division. - - - - Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. - - The matrix to pointwise multiply with this one. - The matrix to store the result of the pointwise multiplication. - - - - Pointwise divide this matrix by another matrix and stores the result into the result matrix. - - The matrix to pointwise divide this one by. - The matrix to store the result of the pointwise division. - - - - Pointwise raise this matrix to an exponent and store the result into the result matrix. - - The exponent to raise this matrix values to. - The vector to store the result of the pointwise power. - - - - Computes the trace of this matrix. - - The trace of this matrix - If the matrix is not square - - - - Adds two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to add. - The right matrix to add. - The result of the addition. - If and don't have the same dimensions. - If or is . - - - - Returns a Matrix containing the same values of . - - The matrix to get the values from. - A matrix containing a the same values as . - If is . - - - - Subtracts two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to subtract. - The right matrix to subtract. - The result of the addition. - If and don't have the same dimensions. - If or is . - - - - Negates each element of the matrix. - - The matrix to negate. - A matrix containing the negated values. - If is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies two matrices. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to multiply. - The right matrix to multiply. - The result of multiplication. - If or is . - If the dimensions of or don't conform. - - - - Multiplies a Matrix and a Vector. - - The matrix to multiply. - The vector to multiply. - The result of multiplication. - If or is . - - - - Multiplies a Vector and a Matrix. - - The vector to multiply. - The matrix to multiply. - The result of multiplication. - If or is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Evaluates whether this matrix is symmetric. - - - - - Evaluates whether this matrix is Hermitian (conjugate symmetric). - - - - - A vector using dense storage. - - - - - Number of elements - - - - - Gets the vector's data. - - - - - Create a new dense vector straight from an initialized vector storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new dense vector with the given length. - All cells of the vector will be initialized to zero. - - If length is less than one. - - - - Create a new dense vector directly binding to a raw array. - The array is used directly without copying. - Very efficient, but changes to the array and the vector will affect each other. - - - - - Create a new dense vector as a copy of the given other vector. - This new vector will be independent from the other vector. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given array. - This new vector will be independent from the array. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given enumerable. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector and initialize each value using the provided value. - - - - - Create a new dense vector and initialize each value using the provided init function. - - - - - Create a new dense vector with values sampled from the provided random distribution. - - - - - Gets the vector's data. - - The vector's data. - - - - Returns a reference to the internal data structure. - - The DenseVector whose internal data we are - returning. - - A reference to the internal date of the given vector. - - - - - Returns a vector bound directly to a reference of the provided array. - - The array to bind to the DenseVector object. - - A DenseVector whose values are bound to the given array. - - - - - Adds a scalar to each element of the vector and stores the result in the result vector. - - The scalar to add. - The vector to store the result of the addition. - - - - Adds another vector to this vector and stores the result into the result vector. - - The vector to add to this one. - The vector to store the result of the addition. - - - - Adds two Vectors together and returns the results. - - One of the vectors to add. - The other vector to add. - The result of the addition. - If and are not the same size. - If or is . - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - The scalar to subtract. - The vector to store the result of the subtraction. - - - - Subtracts another vector from this vector and stores the result into the result vector. - - The vector to subtract from this one. - The vector to store the result of the subtraction. - - - - Returns a Vector containing the negated values of . - - The vector to get the values from. - A vector containing the negated values as . - If is . - - - - Subtracts two Vectors and returns the results. - - The vector to subtract from. - The vector to subtract. - The result of the subtraction. - If and are not the same size. - If or is . - - - - Negates vector and saves result to - - Target vector - - - - Conjugates vector and save result to - - Target vector - - - - Multiplies a scalar to each element of the vector and stores the result in the result vector. - - The scalar to multiply. - The vector to store the result of the multiplication. - - - - - Computes the dot product between this vector and another vector. - - The other vector. - The sum of a[i]*b[i] for all i. - - - - Computes the dot product between the conjugate of this vector and another vector. - - The other vector. - The sum of conj(a[i])*b[i] for all i. - - - - Multiplies a vector with a complex. - - The vector to scale. - The Complex32 value. - The result of the multiplication. - If is . - - - - Multiplies a vector with a complex. - - The Complex32 value. - The vector to scale. - The result of the multiplication. - If is . - - - - Computes the dot product between two Vectors. - - The left row vector. - The right column vector. - The dot product between the two vectors. - If and are not the same size. - If or is . - - - - Divides a vector with a complex. - - The vector to divide. - The Complex32 value. - The result of the division. - If is . - - - - Returns the index of the absolute minimum element. - - The index of absolute minimum element. - - - - Returns the index of the absolute maximum element. - - The index of absolute maximum element. - - - - Computes the sum of the vector's elements. - - The sum of the vector's elements. - - - - Calculates the L1 norm of the vector, also known as Manhattan norm. - - The sum of the absolute values. - - - - Calculates the L2 norm of the vector, also known as Euclidean norm. - - The square root of the sum of the squared values. - - - - Calculates the infinity norm of the vector. - - The maximum absolute value. - - - - Computes the p-Norm. - - The p value. - Scalar ret = ( ∑|this[i]|^p )^(1/p) - - - - Pointwise divide this vector with another vector and stores the result into the result vector. - - The vector to pointwise divide this one by. - The vector to store the result of the pointwise division. - - - - Pointwise divide this vector with another vector and stores the result into the result vector. - - The vector to pointwise divide this one by. - The vector to store the result of the pointwise division. - - - - - Pointwise raise this vector to an exponent vector and store the result into the result vector. - - The exponent vector to raise this vector values to. - The vector to store the result of the pointwise power. - - - - Creates a Complex32 dense vector based on a string. The string can be in the following formats (without the - quotes): 'n', 'n;n;..', '(n;n;..)', '[n;n;...]', where n is a double. - - - A Complex32 dense vector containing the values specified by the given string. - - - the string to parse. - - - An that supplies culture-specific formatting information. - - - - - Converts the string representation of a complex dense vector to double-precision dense vector equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a complex vector to convert. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will be null. - - - - - Converts the string representation of a complex dense vector to double-precision dense vector equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a complex vector to convert. - - - An that supplies culture-specific formatting information about value. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will be null. - - - - - A matrix type for diagonal matrices. - - - Diagonal matrices can be non-square matrices but the diagonal always starts - at element 0,0. A diagonal matrix will throw an exception if non diagonal - entries are set. The exception to this is when the off diagonal elements are - 0.0 or NaN; these settings will cause no change to the diagonal matrix. - - - - - Gets the matrix's data. - - The matrix's data. - - - - Create a new diagonal matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new square diagonal matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the order is less than one. - - - - Create a new diagonal matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the row or column count is less than one. - - - - Create a new diagonal matrix with the given number of rows and columns. - All diagonal cells of the matrix will be initialized to the provided value, all non-diagonal ones to zero. - - If the row or column count is less than one. - - - - Create a new diagonal matrix with the given number of rows and columns directly binding to a raw array. - The array is assumed to contain the diagonal elements only and is used directly without copying. - Very efficient, but changes to the array and the matrix will affect each other. - - - - - Create a new diagonal matrix as a copy of the given other matrix. - This new matrix will be independent from the other matrix. - The matrix to copy from must be diagonal as well. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix as a copy of the given two-dimensional array. - This new matrix will be independent from the provided array. - The array to copy from must be diagonal as well. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix and initialize each diagonal value from the provided indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix and initialize each diagonal value from the provided indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix and initialize each diagonal value from the provided enumerable. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix and initialize each diagonal value using the provided init function. - - - - - Create a new square sparse identity matrix where each diagonal value is set to One. - - - - - Create a new diagonal matrix with diagonal values sampled from the provided random distribution. - - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - - - - Complex conjugates each element of this matrix and place the results into the result matrix. - - The result of the conjugation. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of the addition. - If the two matrices don't have the same dimensions. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract. - The matrix to store the result of the subtraction. - If the two matrices don't have the same dimensions. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Divides each element of the matrix by a scalar and places results into the result matrix. - - The scalar to divide the matrix with. - The matrix to store the result of the division. - - - - Divides a scalar by each element of the matrix and stores the result in the result matrix. - - The scalar to add. - The matrix to store the result of the division. - - - - Computes the determinant of this matrix. - - The determinant of this matrix. - - - - Returns the elements of the diagonal in a . - - The elements of the diagonal. - For non-square matrices, the method returns Min(Rows, Columns) elements where - i == j (i is the row index, and j is the column index). - - - - Copies the values of the given array to the diagonal. - - The array to copy the values from. The length of the vector should be - Min(Rows, Columns). - If the length of does not - equal Min(Rows, Columns). - For non-square matrices, the elements of are copied to - this[i,i]. - - - - Copies the values of the given to the diagonal. - - The vector to copy the values from. The length of the vector should be - Min(Rows, Columns). - If the length of does not - equal Min(Rows, Columns). - For non-square matrices, the elements of are copied to - this[i,i]. - - - Calculates the induced L1 norm of this matrix. - The maximum absolute column sum of the matrix. - - - Calculates the induced L2 norm of the matrix. - The largest singular value of the matrix. - - - Calculates the induced infinity norm of this matrix. - The maximum absolute row sum of the matrix. - - - Calculates the entry-wise Frobenius norm of this matrix. - The square root of the sum of the squared values. - - - Calculates the condition number of this matrix. - The condition number of the matrix. - - - Computes the inverse of this matrix. - If is not a square matrix. - If is singular. - The inverse of this matrix. - - - - Returns a new matrix containing the lower triangle of this matrix. - - The lower triangle of this matrix. - - - - Puts the lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If the result matrix's dimensions are not the same as this matrix. - - - - Returns a new matrix containing the lower triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The lower triangle of this matrix. - - - - Puts the strictly lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If the result matrix's dimensions are not the same as this matrix. - - - - Returns a new matrix containing the upper triangle of this matrix. - - The upper triangle of this matrix. - - - - Puts the upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If the result matrix's dimensions are not the same as this matrix. - - - - Returns a new matrix containing the upper triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The upper triangle of this matrix. - - - - Puts the strictly upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If the result matrix's dimensions are not the same as this matrix. - - - - Creates a matrix that contains the values from the requested sub-matrix. - - The row to start copying from. - The number of rows to copy. Must be positive. - The column to start copying from. - The number of columns to copy. Must be positive. - The requested sub-matrix. - If: is - negative, or greater than or equal to the number of rows. - is negative, or greater than or equal to the number - of columns. - (columnIndex + columnLength) >= Columns - (rowIndex + rowLength) >= Rows - If or - is not positive. - - - - Permute the columns of a matrix according to a permutation. - - The column permutation to apply to this matrix. - Always thrown - Permutation in diagonal matrix are senseless, because of matrix nature - - - - Permute the rows of a matrix according to a permutation. - - The row permutation to apply to this matrix. - Always thrown - Permutation in diagonal matrix are senseless, because of matrix nature - - - - Evaluates whether this matrix is symmetric. - - - - - Evaluates whether this matrix is Hermitian (conjugate symmetric). - - - - - A class which encapsulates the functionality of a Cholesky factorization. - For a symmetric, positive definite matrix A, the Cholesky factorization - is an lower triangular matrix L so that A = L*L'. - - - The computation of the Cholesky factorization is done at construction time. If the matrix is not symmetric - or positive definite, the constructor will throw an exception. - - - - - Gets the determinant of the matrix for which the Cholesky matrix was computed. - - - - - Gets the log determinant of the matrix for which the Cholesky matrix was computed. - - - - - A class which encapsulates the functionality of a Cholesky factorization for dense matrices. - For a symmetric, positive definite matrix A, the Cholesky factorization - is an lower triangular matrix L so that A = L*L'. - - - The computation of the Cholesky factorization is done at construction time. If the matrix is not symmetric - or positive definite, the constructor will throw an exception. - - - - - Initializes a new instance of the class. This object will compute the - Cholesky factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - If is null. - If is not a square matrix. - If is not positive definite. - - - - Solves a system of linear equations, AX = B, with A Cholesky factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A Cholesky factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Calculates the Cholesky factorization of the input matrix. - - The matrix to be factorized. - If is null. - If is not a square matrix. - If is not positive definite. - If does not have the same dimensions as the existing factor. - - - - Eigenvalues and eigenvectors of a complex matrix. - - - If A is Hermitian, then A = V*D*V' where the eigenvalue matrix D is - diagonal and the eigenvector matrix V is Hermitian. - I.e. A = V*D*V' and V*VH=I. - If A is not symmetric, then the eigenvalue matrix D is block diagonal - with the real eigenvalues in 1-by-1 blocks and any complex eigenvalues, - lambda + i*mu, in 2-by-2 blocks, [lambda, mu; -mu, lambda]. The - columns of V represent the eigenvectors in the sense that A*V = V*D, - i.e. A.Multiply(V) equals V.Multiply(D). The matrix V may be badly - conditioned, or even singular, so the validity of the equation - A = V*D*Inverse(V) depends upon V.Condition(). - - - - - Initializes a new instance of the class. This object will compute the - the eigenvalue decomposition when the constructor is called and cache it's decomposition. - - The matrix to factor. - If it is known whether the matrix is symmetric or not the routine can skip checking it itself. - If is null. - If EVD algorithm failed to converge with matrix . - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A EVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the QR decomposition Modified Gram-Schmidt Orthogonalization. - Any complex square matrix A may be decomposed as A = QR where Q is an unitary mxn matrix and R is an nxn upper triangular matrix. - - - The computation of the QR decomposition is done at construction time by modified Gram-Schmidt Orthogonalization. - - - - - Initializes a new instance of the class. This object creates an unitary matrix - using the modified Gram-Schmidt method. - - The matrix to factor. - If is null. - If row count is less then column count - If is rank deficient - - - - Factorize matrix using the modified Gram-Schmidt method. - - Initial matrix. On exit is replaced by Q. - Number of rows in Q. - Number of columns in Q. - On exit is filled by R. - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of an LU factorization. - For a matrix A, the LU factorization is a pair of lower triangular matrix L and - upper triangular matrix U so that A = L*U. - - - The computation of the LU factorization is done at construction time. - - - - - Initializes a new instance of the class. This object will compute the - LU factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - If is null. - If is not a square matrix. - - - - Solves a system of linear equations, AX = B, with A LU factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A LU factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Returns the inverse of this matrix. The inverse is calculated using LU decomposition. - - The inverse of this matrix. - - - - A class which encapsulates the functionality of the QR decomposition. - Any real square matrix A may be decomposed as A = QR where Q is an orthogonal matrix - (its columns are orthogonal unit vectors meaning QTQ = I) and R is an upper triangular matrix - (also called right triangular matrix). - - - The computation of the QR decomposition is done at construction time by Householder transformation. - - - - - Gets or sets Tau vector. Contains additional information on Q - used for native solver. - - - - - Initializes a new instance of the class. This object will compute the - QR factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - The QR factorization method to use. - If is null. - If row count is less then column count - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the singular value decomposition (SVD) for . - Suppose M is an m-by-n matrix whose entries are real numbers. - Then there exists a factorization of the form M = UΣVT where: - - U is an m-by-m unitary matrix; - - Σ is m-by-n diagonal matrix with nonnegative real numbers on the diagonal; - - VT denotes transpose of V, an n-by-n unitary matrix; - Such a factorization is called a singular-value decomposition of M. A common convention is to order the diagonal - entries Σ(i,i) in descending order. In this case, the diagonal matrix Σ is uniquely determined - by M (though the matrices U and V are not). The diagonal entries of Σ are known as the singular values of M. - - - The computation of the singular value decomposition is done at construction time. - - - - - Initializes a new instance of the class. This object will compute the - the singular value decomposition when the constructor is called and cache it's decomposition. - - The matrix to factor. - Compute the singular U and VT vectors or not. - If is null. - If SVD algorithm failed to converge with matrix . - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A SVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Eigenvalues and eigenvectors of a real matrix. - - - If A is symmetric, then A = V*D*V' where the eigenvalue matrix D is - diagonal and the eigenvector matrix V is orthogonal. - I.e. A = V*D*V' and V*VT=I. - If A is not symmetric, then the eigenvalue matrix D is block diagonal - with the real eigenvalues in 1-by-1 blocks and any complex eigenvalues, - lambda + i*mu, in 2-by-2 blocks, [lambda, mu; -mu, lambda]. The - columns of V represent the eigenvectors in the sense that A*V = V*D, - i.e. A.Multiply(V) equals V.Multiply(D). The matrix V may be badly - conditioned, or even singular, so the validity of the equation - A = V*D*Inverse(V) depends upon V.Condition(). - - - - - Gets the absolute value of determinant of the square matrix for which the EVD was computed. - - - - - Gets the effective numerical matrix rank. - - The number of non-negligible singular values. - - - - Gets a value indicating whether the matrix is full rank or not. - - true if the matrix is full rank; otherwise false. - - - - A class which encapsulates the functionality of the QR decomposition Modified Gram-Schmidt Orthogonalization. - Any real square matrix A may be decomposed as A = QR where Q is an orthogonal mxn matrix and R is an nxn upper triangular matrix. - - - The computation of the QR decomposition is done at construction time by modified Gram-Schmidt Orthogonalization. - - - - - Gets the absolute determinant value of the matrix for which the QR matrix was computed. - - - - - Gets a value indicating whether the matrix is full rank or not. - - true if the matrix is full rank; otherwise false. - - - - A class which encapsulates the functionality of an LU factorization. - For a matrix A, the LU factorization is a pair of lower triangular matrix L and - upper triangular matrix U so that A = L*U. - In the Math.NET implementation we also store a set of pivot elements for increased - numerical stability. The pivot elements encode a permutation matrix P such that P*A = L*U. - - - The computation of the LU factorization is done at construction time. - - - - - Gets the determinant of the matrix for which the LU factorization was computed. - - - - - A class which encapsulates the functionality of the QR decomposition. - Any real square matrix A (m x n) may be decomposed as A = QR where Q is an orthogonal matrix - (its columns are orthogonal unit vectors meaning QTQ = I) and R is an upper triangular matrix - (also called right triangular matrix). - - - The computation of the QR decomposition is done at construction time by Householder transformation. - If a factorization is performed, the resulting Q matrix is an m x m matrix - and the R matrix is an m x n matrix. If a factorization is performed, the - resulting Q matrix is an m x n matrix and the R matrix is an n x n matrix. - - - - - Gets the absolute determinant value of the matrix for which the QR matrix was computed. - - - - - Gets a value indicating whether the matrix is full rank or not. - - true if the matrix is full rank; otherwise false. - - - - A class which encapsulates the functionality of the singular value decomposition (SVD). - Suppose M is an m-by-n matrix whose entries are real numbers. - Then there exists a factorization of the form M = UΣVT where: - - U is an m-by-m unitary matrix; - - Σ is m-by-n diagonal matrix with nonnegative real numbers on the diagonal; - - VT denotes transpose of V, an n-by-n unitary matrix; - Such a factorization is called a singular-value decomposition of M. A common convention is to order the diagonal - entries Σ(i,i) in descending order. In this case, the diagonal matrix Σ is uniquely determined - by M (though the matrices U and V are not). The diagonal entries of Σ are known as the singular values of M. - - - The computation of the singular value decomposition is done at construction time. - - - - - Gets the effective numerical matrix rank. - - The number of non-negligible singular values. - - - - Gets the two norm of the . - - The 2-norm of the . - - - - Gets the condition number max(S) / min(S) - - The condition number. - - - - Gets the determinant of the square matrix for which the SVD was computed. - - - - - A class which encapsulates the functionality of a Cholesky factorization for user matrices. - For a symmetric, positive definite matrix A, the Cholesky factorization - is an lower triangular matrix L so that A = L*L'. - - - The computation of the Cholesky factorization is done at construction time. If the matrix is not symmetric - or positive definite, the constructor will throw an exception. - - - - - Computes the Cholesky factorization in-place. - - On entry, the matrix to factor. On exit, the Cholesky factor matrix - If is null. - If is not a square matrix. - If is not positive definite. - - - - Initializes a new instance of the class. This object will compute the - Cholesky factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - If is null. - If is not a square matrix. - If is not positive definite. - - - - Calculates the Cholesky factorization of the input matrix. - - The matrix to be factorized. - If is null. - If is not a square matrix. - If is not positive definite. - If does not have the same dimensions as the existing factor. - - - - Calculate Cholesky step - - Factor matrix - Number of rows - Column start - Total columns - Multipliers calculated previously - Number of available processors - - - - Solves a system of linear equations, AX = B, with A Cholesky factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A Cholesky factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Eigenvalues and eigenvectors of a complex matrix. - - - If A is Hermitian, then A = V*D*V' where the eigenvalue matrix D is - diagonal and the eigenvector matrix V is Hermitian. - I.e. A = V*D*V' and V*VH=I. - If A is not symmetric, then the eigenvalue matrix D is block diagonal - with the real eigenvalues in 1-by-1 blocks and any complex eigenvalues, - lambda + i*mu, in 2-by-2 blocks, [lambda, mu; -mu, lambda]. The - columns of V represent the eigenvectors in the sense that A*V = V*D, - i.e. A.Multiply(V) equals V.Multiply(D). The matrix V may be badly - conditioned, or even singular, so the validity of the equation - A = V*D*Inverse(V) depends upon V.Condition(). - - - - - Initializes a new instance of the class. This object will compute the - the eigenvalue decomposition when the constructor is called and cache it's decomposition. - - The matrix to factor. - If it is known whether the matrix is symmetric or not the routine can skip checking it itself. - If is null. - If EVD algorithm failed to converge with matrix . - - - - Reduces a complex Hermitian matrix to a real symmetric tridiagonal matrix using unitary similarity transformations. - - Source matrix to reduce - Output: Arrays for internal storage of real parts of eigenvalues - Output: Arrays for internal storage of imaginary parts of eigenvalues - Output: Arrays that contains further information about the transformations. - Order of initial matrix - This is derived from the Algol procedures HTRIDI by - Smith, Boyle, Dongarra, Garbow, Ikebe, Klema, Moler, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Symmetric tridiagonal QL algorithm. - - The eigen vectors to work on. - Arrays for internal storage of real parts of eigenvalues - Arrays for internal storage of imaginary parts of eigenvalues - Order of initial matrix - This is derived from the Algol procedures tql2, by - Bowdler, Martin, Reinsch, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - - Determines eigenvectors by undoing the symmetric tridiagonalize transformation - - The eigen vectors to work on. - Previously tridiagonalized matrix by . - Contains further information about the transformations - Input matrix order - This is derived from the Algol procedures HTRIBK, by - by Smith, Boyle, Dongarra, Garbow, Ikebe, Klema, Moler, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Nonsymmetric reduction to Hessenberg form. - - The eigen vectors to work on. - Array for internal storage of nonsymmetric Hessenberg form. - Order of initial matrix - This is derived from the Algol procedures orthes and ortran, - by Martin and Wilkinson, Handbook for Auto. Comp., - Vol.ii-Linear Algebra, and the corresponding - Fortran subroutines in EISPACK. - - - - Nonsymmetric reduction from Hessenberg to real Schur form. - - The eigen vectors to work on. - The eigen values to work on. - Array for internal storage of nonsymmetric Hessenberg form. - Order of initial matrix - This is derived from the Algol procedure hqr2, - by Martin and Wilkinson, Handbook for Auto. Comp., - Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A EVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the QR decomposition Modified Gram-Schmidt Orthogonalization. - Any complex square matrix A may be decomposed as A = QR where Q is an unitary mxn matrix and R is an nxn upper triangular matrix. - - - The computation of the QR decomposition is done at construction time by modified Gram-Schmidt Orthogonalization. - - - - - Initializes a new instance of the class. This object creates an unitary matrix - using the modified Gram-Schmidt method. - - The matrix to factor. - If is null. - If row count is less then column count - If is rank deficient - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of an LU factorization. - For a matrix A, the LU factorization is a pair of lower triangular matrix L and - upper triangular matrix U so that A = L*U. - - - The computation of the LU factorization is done at construction time. - - - - - Initializes a new instance of the class. This object will compute the - LU factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - If is null. - If is not a square matrix. - - - - Solves a system of linear equations, AX = B, with A LU factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A LU factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Returns the inverse of this matrix. The inverse is calculated using LU decomposition. - - The inverse of this matrix. - - - - A class which encapsulates the functionality of the QR decomposition. - Any real square matrix A may be decomposed as A = QR where Q is an orthogonal matrix - (its columns are orthogonal unit vectors meaning QTQ = I) and R is an upper triangular matrix - (also called right triangular matrix). - - - The computation of the QR decomposition is done at construction time by Householder transformation. - - - - - Initializes a new instance of the class. This object will compute the - QR factorization when the constructor is called and cache it's factorization. - - The matrix to factor. - The QR factorization method to use. - If is null. - - - - Generate column from initial matrix to work array - - Initial matrix - The first row - Column index - Generated vector - - - - Perform calculation of Q or R - - Work array - Q or R matrices - The first row - The last row - The first column - The last column - Number of available CPUs - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the singular value decomposition (SVD) for . - Suppose M is an m-by-n matrix whose entries are real numbers. - Then there exists a factorization of the form M = UΣVT where: - - U is an m-by-m unitary matrix; - - Σ is m-by-n diagonal matrix with nonnegative real numbers on the diagonal; - - VT denotes transpose of V, an n-by-n unitary matrix; - Such a factorization is called a singular-value decomposition of M. A common convention is to order the diagonal - entries Σ(i,i) in descending order. In this case, the diagonal matrix Σ is uniquely determined - by M (though the matrices U and V are not). The diagonal entries of Σ are known as the singular values of M. - - - The computation of the singular value decomposition is done at construction time. - - - - - Initializes a new instance of the class. This object will compute the - the singular value decomposition when the constructor is called and cache it's decomposition. - - The matrix to factor. - Compute the singular U and VT vectors or not. - If is null. - - - - - Calculates absolute value of multiplied on signum function of - - Complex32 value z1 - Complex32 value z2 - Result multiplication of signum function and absolute value - - - - Interchanges two vectors and - - Source matrix - The number of rows in - Column A index to swap - Column B index to swap - - - - Scale column by starting from row - - Source matrix - The number of rows in - Column to scale - Row to scale from - Scale value - - - - Scale vector by starting from index - - Source vector - Row to scale from - Scale value - - - - Given the Cartesian coordinates (da, db) of a point p, these function return the parameters da, db, c, and s - associated with the Givens rotation that zeros the y-coordinate of the point. - - Provides the x-coordinate of the point p. On exit contains the parameter r associated with the Givens rotation - Provides the y-coordinate of the point p. On exit contains the parameter z associated with the Givens rotation - Contains the parameter c associated with the Givens rotation - Contains the parameter s associated with the Givens rotation - This is equivalent to the DROTG LAPACK routine. - - - - Calculate Norm 2 of the column in matrix starting from row - - Source matrix - The number of rows in - Column index - Start row index - Norm2 (Euclidean norm) of the column - - - - Calculate Norm 2 of the vector starting from index - - Source vector - Start index - Norm2 (Euclidean norm) of the vector - - - - Calculate dot product of and conjugating the first vector. - - Source matrix - The number of rows in - Index of column A - Index of column B - Starting row index - Dot product value - - - - Performs rotation of points in the plane. Given two vectors x and y , - each vector element of these vectors is replaced as follows: x(i) = c*x(i) + s*y(i); y(i) = c*y(i) - s*x(i) - - Source matrix - The number of rows in - Index of column A - Index of column B - scalar cos value - scalar sin value - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A SVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Complex32 version of the class. - - - - - Initializes a new instance of the Matrix class. - - - - - Set all values whose absolute value is smaller than the threshold to zero. - - - - - Returns the conjugate transpose of this matrix. - - The conjugate transpose of this matrix. - - - - Puts the conjugate transpose of this matrix into the result matrix. - - - - - Complex conjugates each element of this matrix and place the results into the result matrix. - - The result of the conjugation. - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - - - - Add a scalar to each element of the matrix and stores the result in the result vector. - - The scalar to add. - The matrix to store the result of the addition. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of the addition. - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - The scalar to subtract. - The matrix to store the result of the subtraction. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract to this matrix. - The matrix to store the result of subtraction. - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Divides each element of the matrix by a scalar and places results into the result matrix. - - The scalar to divide the matrix with. - The matrix to store the result of the division. - - - - Divides a scalar by each element of the matrix and stores the result in the result matrix. - - The scalar to divide by each element of the matrix. - The matrix to store the result of the division. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. - - The matrix to pointwise multiply with this one. - The matrix to store the result of the pointwise multiplication. - - - - Pointwise divide this matrix by another matrix and stores the result into the result matrix. - - The matrix to pointwise divide this one by. - The matrix to store the result of the pointwise division. - - - - Pointwise raise this matrix to an exponent and store the result into the result matrix. - - The exponent to raise this matrix values to. - The matrix to store the result of the pointwise power. - - - - Pointwise raise this matrix to an exponent and store the result into the result matrix. - - The exponent to raise this matrix values to. - The vector to store the result of the pointwise power. - - - - Pointwise canonical modulus, where the result has the sign of the divisor, - of this matrix with another matrix and stores the result into the result matrix. - - The pointwise denominator matrix to use - The result of the modulus. - - - - Pointwise remainder (% operator), where the result has the sign of the dividend, - of this matrix with another matrix and stores the result into the result matrix. - - The pointwise denominator matrix to use - The result of the modulus. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - Pointwise applies the exponential function to each value and stores the result into the result matrix. - - The matrix to store the result. - - - - Pointwise applies the natural logarithm function to each value and stores the result into the result matrix. - - The matrix to store the result. - - - - Computes the Moore-Penrose Pseudo-Inverse of this matrix. - - - - - Computes the trace of this matrix. - - The trace of this matrix - If the matrix is not square - - - Calculates the induced L1 norm of this matrix. - The maximum absolute column sum of the matrix. - - - Calculates the induced infinity norm of this matrix. - The maximum absolute row sum of the matrix. - - - Calculates the entry-wise Frobenius norm of this matrix. - The square root of the sum of the squared values. - - - - Calculates the p-norms of all row vectors. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Calculates the p-norms of all column vectors. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Normalizes all row vectors to a unit p-norm. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Normalizes all column vectors to a unit p-norm. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Calculates the value sum of each row vector. - - - - - Calculates the absolute value sum of each row vector. - - - - - Calculates the value sum of each column vector. - - - - - Calculates the absolute value sum of each column vector. - - - - - Evaluates whether this matrix is Hermitian (conjugate symmetric). - - - - - A Bi-Conjugate Gradient stabilized iterative matrix solver. - - - - The Bi-Conjugate Gradient Stabilized (BiCGStab) solver is an 'improvement' - of the standard Conjugate Gradient (CG) solver. Unlike the CG solver the - BiCGStab can be used on non-symmetric matrices.
    - Note that much of the success of the solver depends on the selection of the - proper preconditioner. -
    - - The Bi-CGSTAB algorithm was taken from:
    - Templates for the solution of linear systems: Building blocks - for iterative methods -
    - Richard Barrett, Michael Berry, Tony F. Chan, James Demmel, - June M. Donato, Jack Dongarra, Victor Eijkhout, Roldan Pozo, - Charles Romine and Henk van der Vorst -
    - Url: http://www.netlib.org/templates/Templates.html -
    - Algorithm is described in Chapter 2, section 2.3.8, page 27 -
    - - The example code below provides an indication of the possible use of the - solver. - -
    -
    - - - Calculates the true residual of the matrix equation Ax = b according to: residual = b - Ax - - Instance of the A. - Residual values in . - Instance of the x. - Instance of the b. - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient , A. - The solution , b. - The result , x. - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - A composite matrix solver. The actual solver is made by a sequence of - matrix solvers. - - - - Solver based on:
    - Faster PDE-based simulations using robust composite linear solvers
    - S. Bhowmicka, P. Raghavan a,*, L. McInnes b, B. Norris
    - Future Generation Computer Systems, Vol 20, 2004, pp 373�387
    -
    - - Note that if an iterator is passed to this solver it will be used for all the sub-solvers. - -
    -
    - - - The collection of solvers that will be used - - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient matrix, A. - The solution vector, b - The result vector, x - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - A diagonal preconditioner. The preconditioner uses the inverse - of the matrix diagonal as preconditioning values. - - - - - The inverse of the matrix diagonal. - - - - - Returns the decomposed matrix diagonal. - - The matrix diagonal. - - - - Initializes the preconditioner and loads the internal data structures. - - - The upon which this preconditioner is based. - If is . - If is not a square matrix. - - - - Approximates the solution to the matrix equation Ax = b. - - The right hand side vector. - The left hand side vector. Also known as the result vector. - - - - A Generalized Product Bi-Conjugate Gradient iterative matrix solver. - - - - The Generalized Product Bi-Conjugate Gradient (GPBiCG) solver is an - alternative version of the Bi-Conjugate Gradient stabilized (CG) solver. - Unlike the CG solver the GPBiCG solver can be used on - non-symmetric matrices.
    - Note that much of the success of the solver depends on the selection of the - proper preconditioner. -
    - - The GPBiCG algorithm was taken from:
    - GPBiCG(m,l): A hybrid of BiCGSTAB and GPBiCG methods with - efficiency and robustness -
    - S. Fujino -
    - Applied Numerical Mathematics, Volume 41, 2002, pp 107 - 117 -
    -
    - - The example code below provides an indication of the possible use of the - solver. - -
    -
    - - - Indicates the number of BiCGStab steps should be taken - before switching. - - - - - Indicates the number of GPBiCG steps should be taken - before switching. - - - - - Gets or sets the number of steps taken with the BiCgStab algorithm - before switching over to the GPBiCG algorithm. - - - - - Gets or sets the number of steps taken with the GPBiCG algorithm - before switching over to the BiCgStab algorithm. - - - - - Calculates the true residual of the matrix equation Ax = b according to: residual = b - Ax - - Instance of the A. - Residual values in . - Instance of the x. - Instance of the b. - - - - Decide if to do steps with BiCgStab - - Number of iteration - true if yes, otherwise false - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient matrix, A. - The solution vector, b - The result vector, x - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - An incomplete, level 0, LU factorization preconditioner. - - - The ILU(0) algorithm was taken from:
    - Iterative methods for sparse linear systems
    - Yousef Saad
    - Algorithm is described in Chapter 10, section 10.3.2, page 275
    -
    -
    - - - The matrix holding the lower (L) and upper (U) matrices. The - decomposition matrices are combined to reduce storage. - - - - - Returns the upper triagonal matrix that was created during the LU decomposition. - - A new matrix containing the upper triagonal elements. - - - - Returns the lower triagonal matrix that was created during the LU decomposition. - - A new matrix containing the lower triagonal elements. - - - - Initializes the preconditioner and loads the internal data structures. - - The matrix upon which the preconditioner is based. - If is . - If is not a square matrix. - - - - Approximates the solution to the matrix equation Ax = b. - - The right hand side vector. - The left hand side vector. Also known as the result vector. - - - - This class performs an Incomplete LU factorization with drop tolerance - and partial pivoting. The drop tolerance indicates which additional entries - will be dropped from the factorized LU matrices. - - - The ILUTP-Mem algorithm was taken from:
    - ILUTP_Mem: a Space-Efficient Incomplete LU Preconditioner -
    - Tzu-Yi Chen, Department of Mathematics and Computer Science,
    - Pomona College, Claremont CA 91711, USA
    - Published in:
    - Lecture Notes in Computer Science
    - Volume 3046 / 2004
    - pp. 20 - 28
    - Algorithm is described in Section 2, page 22 -
    -
    - - - The default fill level. - - - - - The default drop tolerance. - - - - - The decomposed upper triangular matrix. - - - - - The decomposed lower triangular matrix. - - - - - The array containing the pivot values. - - - - - The fill level. - - - - - The drop tolerance. - - - - - The pivot tolerance. - - - - - Initializes a new instance of the class with the default settings. - - - - - Initializes a new instance of the class with the specified settings. - - - The amount of fill that is allowed in the matrix. The value is a fraction of - the number of non-zero entries in the original matrix. Values should be positive. - - - The absolute drop tolerance which indicates below what absolute value an entry - will be dropped from the matrix. A drop tolerance of 0.0 means that no values - will be dropped. Values should always be positive. - - - The pivot tolerance which indicates at what level pivoting will take place. A - value of 0.0 means that no pivoting will take place. - - - - - Gets or sets the amount of fill that is allowed in the matrix. The - value is a fraction of the number of non-zero entries in the original - matrix. The standard value is 200. - - - - Values should always be positive and can be higher than 1.0. A value lower - than 1.0 means that the eventual preconditioner matrix will have fewer - non-zero entries as the original matrix. A value higher than 1.0 means that - the eventual preconditioner can have more non-zero values than the original - matrix. - - - Note that any changes to the FillLevel after creating the preconditioner - will invalidate the created preconditioner and will require a re-initialization of - the preconditioner. - - - Thrown if a negative value is provided. - - - - Gets or sets the absolute drop tolerance which indicates below what absolute value - an entry will be dropped from the matrix. The standard value is 0.0001. - - - - The values should always be positive and can be larger than 1.0. A low value will - keep more small numbers in the preconditioner matrix. A high value will remove - more small numbers from the preconditioner matrix. - - - Note that any changes to the DropTolerance after creating the preconditioner - will invalidate the created preconditioner and will require a re-initialization of - the preconditioner. - - - Thrown if a negative value is provided. - - - - Gets or sets the pivot tolerance which indicates at what level pivoting will - take place. The standard value is 0.0 which means pivoting will never take place. - - - - The pivot tolerance is used to calculate if pivoting is necessary. Pivoting - will take place if any of the values in a row is bigger than the - diagonal value of that row divided by the pivot tolerance, i.e. pivoting - will take place if row(i,j) > row(i,i) / PivotTolerance for - any j that is not equal to i. - - - Note that any changes to the PivotTolerance after creating the preconditioner - will invalidate the created preconditioner and will require a re-initialization of - the preconditioner. - - - Thrown if a negative value is provided. - - - - Returns the upper triagonal matrix that was created during the LU decomposition. - - - This method is used for debugging purposes only and should normally not be used. - - A new matrix containing the upper triagonal elements. - - - - Returns the lower triagonal matrix that was created during the LU decomposition. - - - This method is used for debugging purposes only and should normally not be used. - - A new matrix containing the lower triagonal elements. - - - - Returns the pivot array. This array is not needed for normal use because - the preconditioner will return the solution vector values in the proper order. - - - This method is used for debugging purposes only and should normally not be used. - - The pivot array. - - - - Initializes the preconditioner and loads the internal data structures. - - - The upon which this preconditioner is based. Note that the - method takes a general matrix type. However internally the data is stored - as a sparse matrix. Therefore it is not recommended to pass a dense matrix. - - If is . - If is not a square matrix. - - - - Pivot elements in the according to internal pivot array - - Row to pivot in - - - - Was pivoting already performed - - Pivots already done - Current item to pivot - true if performed, otherwise false - - - - Swap columns in the - - Source . - First column index to swap - Second column index to swap - - - - Sort vector descending, not changing vector but placing sorted indices to - - Start sort form - Sort till upper bound - Array with sorted vector indices - Source - - - - Approximates the solution to the matrix equation Ax = b. - - The right hand side vector. - The left hand side vector. Also known as the result vector. - - - - Pivot elements in according to internal pivot array - - Source . - Result after pivoting. - - - - An element sort algorithm for the class. - - - This sort algorithm is used to sort the columns in a sparse matrix based on - the value of the element on the diagonal of the matrix. - - - - - Sorts the elements of the vector in decreasing - fashion. The vector itself is not affected. - - The starting index. - The stopping index. - An array that will contain the sorted indices once the algorithm finishes. - The that contains the values that need to be sorted. - - - - Sorts the elements of the vector in decreasing - fashion using heap sort algorithm. The vector itself is not affected. - - The starting index. - The stopping index. - An array that will contain the sorted indices once the algorithm finishes. - The that contains the values that need to be sorted. - - - - Build heap for double indices - - Root position - Length of - Indices of - Target - - - - Sift double indices - - Indices of - Target - Root position - Length of - - - - Sorts the given integers in a decreasing fashion. - - The values. - - - - Sort the given integers in a decreasing fashion using heapsort algorithm - - Array of values to sort - Length of - - - - Build heap - - Target values array - Root position - Length of - - - - Sift values - - Target value array - Root position - Length of - - - - Exchange values in array - - Target values array - First value to exchange - Second value to exchange - - - - A simple milu(0) preconditioner. - - - Original Fortran code by Yousef Saad (07 January 2004) - - - - Use modified or standard ILU(0) - - - - Gets or sets a value indicating whether to use modified or standard ILU(0). - - - - - Gets a value indicating whether the preconditioner is initialized. - - - - - Initializes the preconditioner and loads the internal data structures. - - The matrix upon which the preconditioner is based. - If is . - If is not a square or is not an - instance of SparseCompressedRowMatrixStorage. - - - - Approximates the solution to the matrix equation Ax = b. - - The right hand side vector b. - The left hand side vector x. - - - - MILU0 is a simple milu(0) preconditioner. - - Order of the matrix. - Matrix values in CSR format (input). - Column indices (input). - Row pointers (input). - Matrix values in MSR format (output). - Row pointers and column indices (output). - Pointer to diagonal elements (output). - True if the modified/MILU algorithm should be used (recommended) - Returns 0 on success or k > 0 if a zero pivot was encountered at step k. - - - - A Multiple-Lanczos Bi-Conjugate Gradient stabilized iterative matrix solver. - - - - The Multiple-Lanczos Bi-Conjugate Gradient stabilized (ML(k)-BiCGStab) solver is an 'improvement' - of the standard BiCgStab solver. - - - The algorithm was taken from:
    - ML(k)BiCGSTAB: A BiCGSTAB variant based on multiple Lanczos starting vectors -
    - Man-Chung Yeung and Tony F. Chan -
    - SIAM Journal of Scientific Computing -
    - Volume 21, Number 4, pp. 1263 - 1290 -
    - - The example code below provides an indication of the possible use of the - solver. - -
    -
    - - - The default number of starting vectors. - - - - - The collection of starting vectors which are used as the basis for the Krylov sub-space. - - - - - The number of starting vectors used by the algorithm - - - - - Gets or sets the number of starting vectors. - - - Must be larger than 1 and smaller than the number of variables in the matrix that - for which this solver will be used. - - - - - Resets the number of starting vectors to the default value. - - - - - Gets or sets a series of orthonormal vectors which will be used as basis for the - Krylov sub-space. - - - - - Gets the number of starting vectors to create - - Maximum number - Number of variables - Number of starting vectors to create - - - - Returns an array of starting vectors. - - The maximum number of starting vectors that should be created. - The number of variables. - - An array with starting vectors. The array will never be larger than the - but it may be smaller if - the is smaller than - the . - - - - - Create random vectors array - - Number of vectors - Size of each vector - Array of random vectors - - - - Calculates the true residual of the matrix equation Ax = b according to: residual = b - Ax - - Source A. - Residual data. - x data. - b data. - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient matrix, A. - The solution vector, b - The result vector, x - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - A Transpose Free Quasi-Minimal Residual (TFQMR) iterative matrix solver. - - - - The TFQMR algorithm was taken from:
    - Iterative methods for sparse linear systems. -
    - Yousef Saad -
    - Algorithm is described in Chapter 7, section 7.4.3, page 219 -
    - - The example code below provides an indication of the possible use of the - solver. - -
    -
    - - - Calculates the true residual of the matrix equation Ax = b according to: residual = b - Ax - - Instance of the A. - Residual values in . - Instance of the x. - Instance of the b. - - - - Is even? - - Number to check - true if even, otherwise false - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient matrix, A. - The solution vector, b - The result vector, x - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - A Matrix with sparse storage, intended for very large matrices where most of the cells are zero. - The underlying storage scheme is 3-array compressed-sparse-row (CSR) Format. - Wikipedia - CSR. - - - - - Gets the number of non zero elements in the matrix. - - The number of non zero elements. - - - - Create a new sparse matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new square sparse matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the order is less than one. - - - - Create a new sparse matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - If the row or column count is less than one. - - - - Create a new sparse matrix as a copy of the given other matrix. - This new matrix will be independent from the other matrix. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given two-dimensional array. - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable. - The enumerable is assumed to be in row-major order (row by row). - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - - Create a new sparse matrix with the given number of rows and columns as a copy of the given array. - The array is assumed to be in column-major order (column by column). - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix and initialize each value to the same provided value. - - - - - Create a new sparse matrix and initialize each value using the provided init function. - - - - - Create a new diagonal sparse matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal sparse matrix and initialize each diagonal value using the provided init function. - - - - - Create a new square sparse identity matrix where each diagonal value is set to One. - - - - - Returns a new matrix containing the lower triangle of this matrix. - - The lower triangle of this matrix. - - - - Puts the lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Puts the lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - - - - Returns a new matrix containing the upper triangle of this matrix. - - The upper triangle of this matrix. - - - - Puts the upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Puts the upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - - - - Returns a new matrix containing the lower triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The lower triangle of this matrix. - - - - Puts the strictly lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Puts the strictly lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - - - - Returns a new matrix containing the upper triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The upper triangle of this matrix. - - - - Puts the strictly upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Puts the strictly upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - - - Calculates the induced infinity norm of this matrix. - The maximum absolute row sum of the matrix. - - - Calculates the entry-wise Frobenius norm of this matrix. - The square root of the sum of the squared values. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of the addition. - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract to this matrix. - The matrix to store the result of subtraction. - If the other matrix is . - If the two matrices don't have the same dimensions. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. - - The matrix to pointwise multiply with this one. - The matrix to store the result of the pointwise multiplication. - - - - Pointwise divide this matrix by another matrix and stores the result into the result matrix. - - The matrix to pointwise divide this one by. - The matrix to store the result of the pointwise division. - - - - Evaluates whether this matrix is symmetric. - - - - - Evaluates whether this matrix is Hermitian (conjugate symmetric). - - - - - Adds two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to add. - The right matrix to add. - The result of the addition. - If and don't have the same dimensions. - If or is . - - - - Returns a Matrix containing the same values of . - - The matrix to get the values from. - A matrix containing a the same values as . - If is . - - - - Subtracts two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to subtract. - The right matrix to subtract. - The result of the addition. - If and don't have the same dimensions. - If or is . - - - - Negates each element of the matrix. - - The matrix to negate. - A matrix containing the negated values. - If is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies two matrices. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to multiply. - The right matrix to multiply. - The result of multiplication. - If or is . - If the dimensions of or don't conform. - - - - Multiplies a Matrix and a Vector. - - The matrix to multiply. - The vector to multiply. - The result of multiplication. - If or is . - - - - Multiplies a Vector and a Matrix. - - The vector to multiply. - The matrix to multiply. - The result of multiplication. - If or is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - A vector with sparse storage, intended for very large vectors where most of the cells are zero. - - The sparse vector is not thread safe. - - - - Gets the number of non zero elements in the vector. - - The number of non zero elements. - - - - Create a new sparse vector straight from an initialized vector storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new sparse vector with the given length. - All cells of the vector will be initialized to zero. - - If length is less than one. - - - - Create a new sparse vector as a copy of the given other vector. - This new vector will be independent from the other vector. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given enumerable. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector and initialize each value using the provided value. - - - - - Create a new sparse vector and initialize each value using the provided init function. - - - - - Adds a scalar to each element of the vector and stores the result in the result vector. - Warning, the new 'sparse vector' with a non-zero scalar added to it will be a 100% filled - sparse vector and very inefficient. Would be better to work with a dense vector instead. - - - The scalar to add. - - - The vector to store the result of the addition. - - - - - Adds another vector to this vector and stores the result into the result vector. - - - The vector to add to this one. - - - The vector to store the result of the addition. - - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - - The scalar to subtract. - - - The vector to store the result of the subtraction. - - - - - Subtracts another vector to this vector and stores the result into the result vector. - - - The vector to subtract from this one. - - - The vector to store the result of the subtraction. - - - - - Negates vector and saves result to - - Target vector - - - - Conjugates vector and save result to - - Target vector - - - - Multiplies a scalar to each element of the vector and stores the result in the result vector. - - - The scalar to multiply. - - - The vector to store the result of the multiplication. - - - - - Computes the dot product between this vector and another vector. - - The other vector. - The sum of a[i]*b[i] for all i. - - - - Computes the dot product between the conjugate of this vector and another vector. - - The other vector. - The sum of conj(a[i])*b[i] for all i. - - - - Adds two Vectors together and returns the results. - - One of the vectors to add. - The other vector to add. - The result of the addition. - If and are not the same size. - If or is . - - - - Returns a Vector containing the negated values of . - - The vector to get the values from. - A vector containing the negated values as . - If is . - - - - Subtracts two Vectors and returns the results. - - The vector to subtract from. - The vector to subtract. - The result of the subtraction. - If and are not the same size. - If or is . - - - - Multiplies a vector with a complex. - - The vector to scale. - The complex value. - The result of the multiplication. - If is . - - - - Multiplies a vector with a complex. - - The complex value. - The vector to scale. - The result of the multiplication. - If is . - - - - Computes the dot product between two Vectors. - - The left row vector. - The right column vector. - The dot product between the two vectors. - If and are not the same size. - If or is . - - - - Divides a vector with a complex. - - The vector to divide. - The complex value. - The result of the division. - If is . - - - - Computes the modulus of each element of the vector of the given divisor. - - The vector whose elements we want to compute the modulus of. - The divisor to use, - The result of the calculation - If is . - - - - Returns the index of the absolute minimum element. - - The index of absolute minimum element. - - - - Returns the index of the absolute maximum element. - - The index of absolute maximum element. - - - - Computes the sum of the vector's elements. - - The sum of the vector's elements. - - - - Calculates the L1 norm of the vector, also known as Manhattan norm. - - The sum of the absolute values. - - - - Calculates the infinity norm of the vector. - - The maximum absolute value. - - - - Computes the p-Norm. - - The p value. - Scalar ret = ( ∑|this[i]|^p )^(1/p) - - - - Pointwise multiplies this vector with another vector and stores the result into the result vector. - - The vector to pointwise multiply with this one. - The vector to store the result of the pointwise multiplication. - - - - Creates a double sparse vector based on a string. The string can be in the following formats (without the - quotes): 'n', 'n;n;..', '(n;n;..)', '[n;n;...]', where n is a Complex32. - - - A double sparse vector containing the values specified by the given string. - - - the string to parse. - - - An that supplies culture-specific formatting information. - - - - - Converts the string representation of a complex sparse vector to double-precision sparse vector equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a complex vector to convert. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will be null. - - - - - Converts the string representation of a complex sparse vector to double-precision sparse vector equivalent. - A return value indicates whether the conversion succeeded or failed. - - - A string containing a complex vector to convert. - - - An that supplies culture-specific formatting information about value. - - - The parsed value. - - - If the conversion succeeds, the result will contain a complex number equivalent to value. - Otherwise the result will be null. - - - - - Complex32 version of the class. - - - - - Initializes a new instance of the Vector class. - - - - - Set all values whose absolute value is smaller than the threshold to zero. - - - - - Conjugates vector and save result to - - Target vector - - - - Negates vector and saves result to - - Target vector - - - - Adds a scalar to each element of the vector and stores the result in the result vector. - - - The scalar to add. - - - The vector to store the result of the addition. - - - - - Adds another vector to this vector and stores the result into the result vector. - - - The vector to add to this one. - - - The vector to store the result of the addition. - - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - - The scalar to subtract. - - - The vector to store the result of the subtraction. - - - - - Subtracts another vector to this vector and stores the result into the result vector. - - - The vector to subtract from this one. - - - The vector to store the result of the subtraction. - - - - - Multiplies a scalar to each element of the vector and stores the result in the result vector. - - - The scalar to multiply. - - - The vector to store the result of the multiplication. - - - - - Divides each element of the vector by a scalar and stores the result in the result vector. - - - The scalar to divide with. - - - The vector to store the result of the division. - - - - - Divides a scalar by each element of the vector and stores the result in the result vector. - - The scalar to divide. - The vector to store the result of the division. - - - - Pointwise multiplies this vector with another vector and stores the result into the result vector. - - The vector to pointwise multiply with this one. - The vector to store the result of the pointwise multiplication. - - - - Pointwise divide this vector with another vector and stores the result into the result vector. - - The vector to pointwise divide this one by. - The vector to store the result of the pointwise division. - - - - Pointwise raise this vector to an exponent and store the result into the result vector. - - The exponent to raise this vector values to. - The vector to store the result of the pointwise power. - - - - Pointwise raise this vector to an exponent vector and store the result into the result vector. - - The exponent vector to raise this vector values to. - The vector to store the result of the pointwise power. - - - - Pointwise canonical modulus, where the result has the sign of the divisor, - of this vector with another vector and stores the result into the result vector. - - The pointwise denominator vector to use. - The result of the modulus. - - - - Pointwise remainder (% operator), where the result has the sign of the dividend, - of this vector with another vector and stores the result into the result vector. - - The pointwise denominator vector to use. - The result of the modulus. - - - - Pointwise applies the exponential function to each value and stores the result into the result vector. - - The vector to store the result. - - - - Pointwise applies the natural logarithm function to each value and stores the result into the result vector. - - The vector to store the result. - - - - Computes the dot product between this vector and another vector. - - The other vector. - The sum of a[i]*b[i] for all i. - - - - Computes the dot product between the conjugate of this vector and another vector. - - The other vector. - The sum of conj(a[i])*b[i] for all i. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given dividend for each element of the vector. - - The scalar numerator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given dividend for each element of the vector. - - The scalar numerator to use. - A vector to store the results in. - - - - Returns the value of the absolute minimum element. - - The value of the absolute minimum element. - - - - Returns the index of the absolute minimum element. - - The index of absolute minimum element. - - - - Returns the value of the absolute maximum element. - - The value of the absolute maximum element. - - - - Returns the index of the absolute maximum element. - - The index of absolute maximum element. - - - - Computes the sum of the vector's elements. - - The sum of the vector's elements. - - - - Calculates the L1 norm of the vector, also known as Manhattan norm. - - The sum of the absolute values. - - - - Calculates the L2 norm of the vector, also known as Euclidean norm. - - The square root of the sum of the squared values. - - - - Calculates the infinity norm of the vector. - - The maximum absolute value. - - - - Computes the p-Norm. - - - The p value. - - - Scalar ret = ( ∑|At(i)|^p )^(1/p) - - - - - Returns the index of the maximum element. - - The index of maximum element. - - - - Returns the index of the minimum element. - - The index of minimum element. - - - - Normalizes this vector to a unit vector with respect to the p-norm. - - - The p value. - - - This vector normalized to a unit vector with respect to the p-norm. - - - - - Generic linear algebra type builder, for situations where a matrix or vector - must be created in a generic way. Usage of generic builders should not be - required in normal user code. - - - - - Gets the value of 0.0 for type T. - - - - - Gets the value of 1.0 for type T. - - - - - Create a new matrix straight from an initialized matrix storage instance. - If you have an instance of a discrete storage type instead, use their direct methods instead. - - - - - Create a new matrix with the same kind of the provided example. - - - - - Create a new matrix with the same kind and dimensions of the provided example. - - - - - Create a new matrix with the same kind of the provided example. - - - - - Create a new matrix with a type that can represent and is closest to both provided samples. - - - - - Create a new matrix with a type that can represent and is closest to both provided samples and the dimensions of example. - - - - - Create a new dense matrix with values sampled from the provided random distribution. - - - - - Create a new dense matrix with values sampled from the standard distribution with a system random source. - - - - - Create a new dense matrix with values sampled from the standard distribution with a system random source. - - - - - Create a new positive definite dense matrix where each value is the product - of two samples from the provided random distribution. - - - - - Create a new positive definite dense matrix where each value is the product - of two samples from the standard distribution. - - - - - Create a new positive definite dense matrix where each value is the product - of two samples from the provided random distribution. - - - - - Create a new dense matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new dense matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - - - - Create a new dense matrix with the given number of rows and columns directly binding to a raw array. - The array is assumed to be in column-major order (column by column) and is used directly without copying. - Very efficient, but changes to the array and the matrix will affect each other. - - - - - - Create a new dense matrix and initialize each value to the same provided value. - - - - - Create a new dense matrix and initialize each value using the provided init function. - - - - - Create a new diagonal dense matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal dense matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal dense matrix and initialize each diagonal value using the provided init function. - - - - - Create a new diagonal dense identity matrix with a one-diagonal. - - - - - Create a new diagonal dense identity matrix with a one-diagonal. - - - - - Create a new dense matrix as a copy of the given other matrix. - This new matrix will be independent from the other matrix. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given two-dimensional array. - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable. - The enumerable is assumed to be in column-major order (column by column). - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix of T as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix of T as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable. - The enumerable is assumed to be in row-major order (row by row). - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix of T as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix of T as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix from a 2D array of existing matrices. - The matrices in the array are not required to be dense already. - If the matrices do not align properly, they are placed on the top left - corner of their cell with the remaining fields left zero. - - - - - Create a new sparse matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - The SparseCompressedRowMatrixStorage - - - - Create a sparse matrix of T with the given number of rows and columns. - - The number of rows. - The number of columns. - - - - Create a new sparse matrix and initialize each value to the same provided value. - - - - - Create a new sparse matrix and initialize each value using the provided init function. - - - - - Create a new diagonal sparse matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal sparse matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal sparse matrix and initialize each diagonal value using the provided init function. - - - - - Create a new diagonal dense identity matrix with a one-diagonal. - - - - - Create a new diagonal dense identity matrix with a one-diagonal. - - - - - Create a new sparse matrix as a copy of the given other matrix. - This new matrix will be independent from the other matrix. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given two-dimensional array. - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable. - The enumerable is assumed to be in row-major order (row by row). - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - - Create a new sparse matrix with the given number of rows and columns as a copy of the given array. - The array is assumed to be in column-major order (column by column). - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix from a 2D array of existing matrices. - The matrices in the array are not required to be sparse already. - If the matrices do not align properly, they are placed on the top left - corner of their cell with the remaining fields left zero. - - - - - Create a new sparse matrix from a coordinate format. - This new matrix will be independent from the given arrays. - A new memory block will be allocated for storing the matrix. - - The number of rows. - The number of columns. - The number of stored values including explicit zeros. - The row index array of the coordinate format. - The column index array of the coordinate format. - The data array of the coordinate format. - The sparse matrix from the coordinate format. - Duplicate entries will be summed together and explicit zeros will be not intentionally removed. - - - - Create a new sparse matrix from a compressed sparse row format. - This new matrix will be independent from the given arrays. - A new memory block will be allocated for storing the matrix. - - The number of rows. - The number of columns. - The number of stored values including explicit zeros. - The row pointer array of the compressed sparse row format. - The column index array of the compressed sparse row format. - The data array of the compressed sparse row format. - The sparse matrix from the compressed sparse row format. - Duplicate entries will be summed together and explicit zeros will be not intentionally removed. - - - - Create a new sparse matrix from a compressed sparse column format. - This new matrix will be independent from the given arrays. - A new memory block will be allocated for storing the matrix. - - The number of rows. - The number of columns. - The number of stored values including explicit zeros. - The row index array of the compressed sparse column format. - The column pointer array of the compressed sparse column format. - The data array of the compressed sparse column format. - The sparse matrix from the compressed sparse column format. - Duplicate entries will be summed together and explicit zeros will be not intentionally removed. - - - - Create a new diagonal matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new diagonal matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - - - - Create a new diagonal matrix with the given number of rows and columns directly binding to a raw array. - The array is assumed to represent the diagonal values and is used directly without copying. - Very efficient, but changes to the array and the matrix will affect each other. - - - - - Create a new square diagonal matrix directly binding to a raw array. - The array is assumed to represent the diagonal values and is used directly without copying. - Very efficient, but changes to the array and the matrix will affect each other. - - - - - Create a new diagonal matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal matrix and initialize each diagonal value using the provided init function. - - - - - Create a new diagonal identity matrix with a one-diagonal. - - - - - Create a new diagonal identity matrix with a one-diagonal. - - - - - Create a new diagonal matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Generic linear algebra type builder, for situations where a matrix or vector - must be created in a generic way. Usage of generic builders should not be - required in normal user code. - - - - - Gets the value of 0.0 for type T. - - - - - Gets the value of 1.0 for type T. - - - - - Create a new vector straight from an initialized matrix storage instance. - If you have an instance of a discrete storage type instead, use their direct methods instead. - - - - - Create a new vector with the same kind of the provided example. - - - - - Create a new vector with the same kind and dimension of the provided example. - - - - - Create a new vector with the same kind of the provided example. - - - - - Create a new vector with a type that can represent and is closest to both provided samples. - - - - - Create a new vector with a type that can represent and is closest to both provided samples and the dimensions of example. - - - - - Create a new vector with a type that can represent and is closest to both provided samples. - - - - - Create a new dense vector with values sampled from the provided random distribution. - - - - - Create a new dense vector with values sampled from the standard distribution with a system random source. - - - - - Create a new dense vector with values sampled from the standard distribution with a system random source. - - - - - Create a new dense vector straight from an initialized vector storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a dense vector of T with the given size. - - The size of the vector. - - - - Create a dense vector of T that is directly bound to the specified array. - - - - - Create a new dense vector and initialize each value using the provided value. - - - - - Create a new dense vector and initialize each value using the provided init function. - - - - - Create a new dense vector as a copy of the given other vector. - This new vector will be independent from the other vector. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given array. - This new vector will be independent from the array. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given enumerable. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector straight from an initialized vector storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a sparse vector of T with the given size. - - The size of the vector. - - - - Create a new sparse vector and initialize each value using the provided value. - - - - - Create a new sparse vector and initialize each value using the provided init function. - - - - - Create a new sparse vector as a copy of the given other vector. - This new vector will be independent from the other vector. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given array. - This new vector will be independent from the array. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given enumerable. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new matrix straight from an initialized matrix storage instance. - If you have an instance of a discrete storage type instead, use their direct methods instead. - - - - - Create a new matrix with the same kind of the provided example. - - - - - Create a new matrix with the same kind and dimensions of the provided example. - - - - - Create a new matrix with the same kind of the provided example. - - - - - Create a new matrix with a type that can represent and is closest to both provided samples. - - - - - Create a new matrix with a type that can represent and is closest to both provided samples and the dimensions of example. - - - - - Create a new dense matrix with values sampled from the provided random distribution. - - - - - Create a new dense matrix with values sampled from the standard distribution with a system random source. - - - - - Create a new dense matrix with values sampled from the standard distribution with a system random source. - - - - - Create a new positive definite dense matrix where each value is the product - of two samples from the provided random distribution. - - - - - Create a new positive definite dense matrix where each value is the product - of two samples from the standard distribution. - - - - - Create a new positive definite dense matrix where each value is the product - of two samples from the provided random distribution. - - - - - Create a new dense matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new dense matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - - - - Create a new dense matrix with the given number of rows and columns directly binding to a raw array. - The array is assumed to be in column-major order (column by column) and is used directly without copying. - Very efficient, but changes to the array and the matrix will affect each other. - - - - - - Create a new dense matrix and initialize each value to the same provided value. - - - - - Create a new dense matrix and initialize each value using the provided init function. - - - - - Create a new diagonal dense matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal dense matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal dense matrix and initialize each diagonal value using the provided init function. - - - - - Create a new diagonal dense identity matrix with a one-diagonal. - - - - - Create a new diagonal dense identity matrix with a one-diagonal. - - - - - Create a new dense matrix as a copy of the given other matrix. - This new matrix will be independent from the other matrix. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given two-dimensional array. - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable. - The enumerable is assumed to be in column-major order (column by column). - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix of T as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix of T as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix of T as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix of T as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new dense matrix from a 2D array of existing matrices. - The matrices in the array are not required to be dense already. - If the matrices do not align properly, they are placed on the top left - corner of their cell with the remaining fields left zero. - - - - - Create a new sparse matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a sparse matrix of T with the given number of rows and columns. - - The number of rows. - The number of columns. - - - - Create a new sparse matrix and initialize each value to the same provided value. - - - - - Create a new sparse matrix and initialize each value using the provided init function. - - - - - Create a new diagonal sparse matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal sparse matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal sparse matrix and initialize each diagonal value using the provided init function. - - - - - Create a new diagonal dense identity matrix with a one-diagonal. - - - - - Create a new diagonal dense identity matrix with a one-diagonal. - - - - - Create a new sparse matrix as a copy of the given other matrix. - This new matrix will be independent from the other matrix. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given two-dimensional array. - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable. - The enumerable is assumed to be in row-major order (row by row). - This new matrix will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - - Create a new sparse matrix with the given number of rows and columns as a copy of the given array. - The array is assumed to be in column-major order (column by column). - This new matrix will be independent from the provided array. - A new memory block will be allocated for storing the matrix. - - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable columns. - Each enumerable in the master enumerable specifies a column. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given column vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given enumerable of enumerable rows. - Each enumerable in the master enumerable specifies a row. - This new matrix will be independent from the enumerables. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row arrays. - This new matrix will be independent from the arrays. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix as a copy of the given row vectors. - This new matrix will be independent from the vectors. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new sparse matrix from a 2D array of existing matrices. - The matrices in the array are not required to be sparse already. - If the matrices do not align properly, they are placed on the top left - corner of their cell with the remaining fields left zero. - - - - - Create a new sparse matrix from a coordinate format. - This new matrix will be independent from the given arrays. - A new memory block will be allocated for storing the matrix. - - The number of rows. - The number of columns. - The number of stored values including explicit zeros. - The row index array of the coordinate format. - The column index array of the coordinate format. - The data array of the coordinate format. - The sparse matrix from the coordinate format. - Duplicate entries will be summed together and explicit zeros will be not intentionally removed. - - - - Create a new sparse matrix from a compressed sparse row format. - This new matrix will be independent from the given arrays. - A new memory block will be allocated for storing the matrix. - - The number of rows. - The number of columns. - The number of stored values including explicit zeros. - The row pointer array of the compressed sparse row format. - The column index array of the compressed sparse row format. - The data array of the compressed sparse row format. - The sparse matrix from the compressed sparse row format. - Duplicate entries will be summed together and explicit zeros will be not intentionally removed. - - - - Create a new sparse matrix from a compressed sparse column format. - This new matrix will be independent from the given arrays. - A new memory block will be allocated for storing the matrix. - - The number of rows. - The number of columns. - The number of stored values including explicit zeros. - The row index array of the compressed sparse column format. - The column pointer array of the compressed sparse column format. - The data array of the compressed sparse column format. - The sparse matrix from the compressed sparse column format. - Duplicate entries will be summed together and explicit zeros will be not intentionally removed. - - - - Create a new diagonal matrix straight from an initialized matrix storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a new diagonal matrix with the given number of rows and columns. - All cells of the matrix will be initialized to zero. - - - - - Create a new diagonal matrix with the given number of rows and columns directly binding to a raw array. - The array is assumed to represent the diagonal values and is used directly without copying. - Very efficient, but changes to the array and the matrix will affect each other. - - - - - Create a new square diagonal matrix directly binding to a raw array. - The array is assumed to represent the diagonal values and is used directly without copying. - Very efficient, but changes to the array and the matrix will affect each other. - - - - - Create a new diagonal matrix and initialize each diagonal value to the same provided value. - - - - - Create a new diagonal matrix and initialize each diagonal value using the provided init function. - - - - - Create a new diagonal identity matrix with a one-diagonal. - - - - - Create a new diagonal identity matrix with a one-diagonal. - - - - - Create a new diagonal matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix with the diagonal as a copy of the given vector. - This new matrix will be independent from the vector. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new diagonal matrix with the diagonal as a copy of the given array. - This new matrix will be independent from the array. - A new memory block will be allocated for storing the matrix. - - - - - Create a new vector straight from an initialized matrix storage instance. - If you have an instance of a discrete storage type instead, use their direct methods instead. - - - - - Create a new vector with the same kind of the provided example. - - - - - Create a new vector with the same kind and dimension of the provided example. - - - - - Create a new vector with the same kind of the provided example. - - - - - Create a new vector with a type that can represent and is closest to both provided samples. - - - - - Create a new vector with a type that can represent and is closest to both provided samples and the dimensions of example. - - - - - Create a new vector with a type that can represent and is closest to both provided samples. - - - - - Create a new dense vector with values sampled from the provided random distribution. - - - - - Create a new dense vector with values sampled from the standard distribution with a system random source. - - - - - Create a new dense vector with values sampled from the standard distribution with a system random source. - - - - - Create a new dense vector straight from an initialized vector storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a dense vector of T with the given size. - - The size of the vector. - - - - Create a dense vector of T that is directly bound to the specified array. - - - - - Create a new dense vector and initialize each value using the provided value. - - - - - Create a new dense vector and initialize each value using the provided init function. - - - - - Create a new dense vector as a copy of the given other vector. - This new vector will be independent from the other vector. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given array. - This new vector will be independent from the array. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given enumerable. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new dense vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector straight from an initialized vector storage instance. - The storage is used directly without copying. - Intended for advanced scenarios where you're working directly with - storage for performance or interop reasons. - - - - - Create a sparse vector of T with the given size. - - The size of the vector. - - - - Create a new sparse vector and initialize each value using the provided value. - - - - - Create a new sparse vector and initialize each value using the provided init function. - - - - - Create a new sparse vector as a copy of the given other vector. - This new vector will be independent from the other vector. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given array. - This new vector will be independent from the array. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given enumerable. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - Create a new sparse vector as a copy of the given indexed enumerable. - Keys must be provided at most once, zero is assumed if a key is omitted. - This new vector will be independent from the enumerable. - A new memory block will be allocated for storing the vector. - - - - - A class which encapsulates the functionality of a Cholesky factorization. - For a symmetric, positive definite matrix A, the Cholesky factorization - is an lower triangular matrix L so that A = L*L'. - - - The computation of the Cholesky factorization is done at construction time. If the matrix is not symmetric - or positive definite, the constructor will throw an exception. - - Supported data types are double, single, , and . - - - - Gets the lower triangular form of the Cholesky matrix. - - - - - Gets the determinant of the matrix for which the Cholesky matrix was computed. - - - - - Gets the log determinant of the matrix for which the Cholesky matrix was computed. - - - - - Calculates the Cholesky factorization of the input matrix. - - The matrix to be factorized. - - - - Solves a system of linear equations, AX = B, with A Cholesky factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, AX = B, with A Cholesky factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A Cholesky factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Solves a system of linear equations, Ax = b, with A Cholesky factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Eigenvalues and eigenvectors of a real matrix. - - - If A is symmetric, then A = V*D*V' where the eigenvalue matrix D is - diagonal and the eigenvector matrix V is orthogonal. - I.e. A = V*D*V' and V*VT=I. - If A is not symmetric, then the eigenvalue matrix D is block diagonal - with the real eigenvalues in 1-by-1 blocks and any complex eigenvalues, - lambda + i*mu, in 2-by-2 blocks, [lambda, mu; -mu, lambda]. The - columns of V represent the eigenvectors in the sense that A*V = V*D, - i.e. A.Multiply(V) equals V.Multiply(D). The matrix V may be badly - conditioned, or even singular, so the validity of the equation - A = V*D*Inverse(V) depends upon V.Condition(). - - Supported data types are double, single, , and . - - - - Gets or sets a value indicating whether matrix is symmetric or not - - - - - Gets the absolute value of determinant of the square matrix for which the EVD was computed. - - - - - Gets the effective numerical matrix rank. - - The number of non-negligible singular values. - - - - Gets a value indicating whether the matrix is full rank or not. - - true if the matrix is full rank; otherwise false. - - - - Gets or sets the eigen values (λ) of matrix in ascending value. - - - - - Gets or sets eigenvectors. - - - - - Gets or sets the block diagonal eigenvalue matrix. - - - - - Solves a system of linear equations, AX = B, with A EVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, AX = B, with A EVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A EVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Solves a system of linear equations, Ax = b, with A EVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the QR decomposition Modified Gram-Schmidt Orthogonalization. - Any real square matrix A may be decomposed as A = QR where Q is an orthogonal mxn matrix and R is an nxn upper triangular matrix. - - - The computation of the QR decomposition is done at construction time by modified Gram-Schmidt Orthogonalization. - - Supported data types are double, single, , and . - - - - Classes that solves a system of linear equations, AX = B. - - Supported data types are double, single, , and . - - - - Solves a system of linear equations, AX = B. - - The right hand side Matrix, B. - The left hand side Matrix, X. - - - - Solves a system of linear equations, AX = B. - - The right hand side Matrix, B. - The left hand side Matrix, X. - - - - Solves a system of linear equations, Ax = b - - The right hand side vector, b. - The left hand side Vector, x. - - - - Solves a system of linear equations, Ax = b. - - The right hand side vector, b. - The left hand side Matrix>, x. - - - - A class which encapsulates the functionality of an LU factorization. - For a matrix A, the LU factorization is a pair of lower triangular matrix L and - upper triangular matrix U so that A = L*U. - In the Math.NET implementation we also store a set of pivot elements for increased - numerical stability. The pivot elements encode a permutation matrix P such that P*A = L*U. - - - The computation of the LU factorization is done at construction time. - - Supported data types are double, single, , and . - - - - Gets the lower triangular factor. - - - - - Gets the upper triangular factor. - - - - - Gets the permutation applied to LU factorization. - - - - - Gets the determinant of the matrix for which the LU factorization was computed. - - - - - Solves a system of linear equations, AX = B, with A LU factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, AX = B, with A LU factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A LU factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Solves a system of linear equations, Ax = b, with A LU factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Returns the inverse of this matrix. The inverse is calculated using LU decomposition. - - The inverse of this matrix. - - - - The type of QR factorization go perform. - - - - - Compute the full QR factorization of a matrix. - - - - - Compute the thin QR factorization of a matrix. - - - - - A class which encapsulates the functionality of the QR decomposition. - Any real square matrix A (m x n) may be decomposed as A = QR where Q is an orthogonal matrix - (its columns are orthogonal unit vectors meaning QTQ = I) and R is an upper triangular matrix - (also called right triangular matrix). - - - The computation of the QR decomposition is done at construction time by Householder transformation. - If a factorization is performed, the resulting Q matrix is an m x m matrix - and the R matrix is an m x n matrix. If a factorization is performed, the - resulting Q matrix is an m x n matrix and the R matrix is an n x n matrix. - - Supported data types are double, single, , and . - - - - Gets or sets orthogonal Q matrix - - - - - Gets the upper triangular factor R. - - - - - Gets the absolute determinant value of the matrix for which the QR matrix was computed. - - - - - Gets a value indicating whether the matrix is full rank or not. - - true if the matrix is full rank; otherwise false. - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - A class which encapsulates the functionality of the singular value decomposition (SVD). - Suppose M is an m-by-n matrix whose entries are real numbers. - Then there exists a factorization of the form M = UΣVT where: - - U is an m-by-m unitary matrix; - - Σ is m-by-n diagonal matrix with nonnegative real numbers on the diagonal; - - VT denotes transpose of V, an n-by-n unitary matrix; - Such a factorization is called a singular-value decomposition of M. A common convention is to order the diagonal - entries Σ(i,i) in descending order. In this case, the diagonal matrix Σ is uniquely determined - by M (though the matrices U and V are not). The diagonal entries of Σ are known as the singular values of M. - - - The computation of the singular value decomposition is done at construction time. - - Supported data types are double, single, , and . - - - Indicating whether U and VT matrices have been computed during SVD factorization. - - - - Gets the singular values (Σ) of matrix in ascending value. - - - - - Gets the left singular vectors (U - m-by-m unitary matrix) - - - - - Gets the transpose right singular vectors (transpose of V, an n-by-n unitary matrix) - - - - - Returns the singular values as a diagonal . - - The singular values as a diagonal . - - - - Gets the effective numerical matrix rank. - - The number of non-negligible singular values. - - - - Gets the two norm of the . - - The 2-norm of the . - - - - Gets the condition number max(S) / min(S) - - The condition number. - - - - Gets the determinant of the square matrix for which the SVD was computed. - - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, AX = B, with A SVD factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A SVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Solves a system of linear equations, Ax = b, with A SVD factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Defines the base class for Matrix classes. - - - Defines the base class for Matrix classes. - - Supported data types are double, single, , and . - - Defines the base class for Matrix classes. - - - Defines the base class for Matrix classes. - - - - - The value of 1.0. - - - - - The value of 0.0. - - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - - - - Complex conjugates each element of this matrix and place the results into the result matrix. - - The result of the conjugation. - - - - Add a scalar to each element of the matrix and stores the result in the result vector. - - The scalar to add. - The matrix to store the result of the addition. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of the addition. - If the two matrices don't have the same dimensions. - - - - Subtracts a scalar from each element of the matrix and stores the result in the result matrix. - - The scalar to subtract. - The matrix to store the result of the subtraction. - - - - Subtracts each element of the matrix from a scalar and stores the result in the result matrix. - - The scalar to subtract from. - The matrix to store the result of the subtraction. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract. - The matrix to store the result of the subtraction. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with the transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - - - - Divides each element of the matrix by a scalar and places results into the result matrix. - - The scalar denominator to use. - The matrix to store the result of the division. - - - - Divides a scalar by each element of the matrix and stores the result in the result matrix. - - The scalar numerator to use. - The matrix to store the result of the division. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given divisor each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given dividend for each element of the matrix. - - The scalar numerator to use. - A vector to store the results in. - - - - Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. - - The matrix to pointwise multiply with this one. - The matrix to store the result of the pointwise multiplication. - - - - Pointwise divide this matrix by another matrix and stores the result into the result matrix. - - The pointwise denominator matrix to use. - The matrix to store the result of the pointwise division. - - - - Pointwise raise this matrix to an exponent and store the result into the result matrix. - - The exponent to raise this matrix values to. - The matrix to store the result of the pointwise power. - - - - Pointwise raise this matrix to an exponent matrix and store the result into the result matrix. - - The exponent matrix to raise this matrix values to. - The matrix to store the result of the pointwise power. - - - - Pointwise canonical modulus, where the result has the sign of the divisor, - of this matrix with another matrix and stores the result into the result matrix. - - The pointwise denominator matrix to use - The result of the modulus. - - - - Pointwise remainder (% operator), where the result has the sign of the dividend, - of this matrix with another matrix and stores the result into the result matrix. - - The pointwise denominator matrix to use - The result of the modulus. - - - - Pointwise applies the exponential function to each value and stores the result into the result matrix. - - The matrix to store the result. - - - - Pointwise applies the natural logarithm function to each value and stores the result into the result matrix. - - The matrix to store the result. - - - - Adds a scalar to each element of the matrix. - - The scalar to add. - The result of the addition. - If the two matrices don't have the same dimensions. - - - - Adds a scalar to each element of the matrix and stores the result in the result matrix. - - The scalar to add. - The matrix to store the result of the addition. - If the two matrices don't have the same dimensions. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The result of the addition. - If the two matrices don't have the same dimensions. - - - - Adds another matrix to this matrix. - - The matrix to add to this matrix. - The matrix to store the result of the addition. - If the two matrices don't have the same dimensions. - - - - Subtracts a scalar from each element of the matrix. - - The scalar to subtract. - A new matrix containing the subtraction of this matrix and the scalar. - - - - Subtracts a scalar from each element of the matrix and stores the result in the result matrix. - - The scalar to subtract. - The matrix to store the result of the subtraction. - If this matrix and are not the same size. - - - - Subtracts each element of the matrix from a scalar. - - The scalar to subtract from. - A new matrix containing the subtraction of the scalar and this matrix. - - - - Subtracts each element of the matrix from a scalar and stores the result in the result matrix. - - The scalar to subtract from. - The matrix to store the result of the subtraction. - If this matrix and are not the same size. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract. - The result of the subtraction. - If the two matrices don't have the same dimensions. - - - - Subtracts another matrix from this matrix. - - The matrix to subtract. - The matrix to store the result of the subtraction. - If the two matrices don't have the same dimensions. - - - - Multiplies each element of this matrix with a scalar. - - The scalar to multiply with. - The result of the multiplication. - - - - Multiplies each element of the matrix by a scalar and places results into the result matrix. - - The scalar to multiply the matrix with. - The matrix to store the result of the multiplication. - If the result matrix's dimensions are not the same as this matrix. - - - - Divides each element of this matrix with a scalar. - - The scalar to divide with. - The result of the division. - - - - Divides each element of the matrix by a scalar and places results into the result matrix. - - The scalar to divide the matrix with. - The matrix to store the result of the division. - If the result matrix's dimensions are not the same as this matrix. - - - - Divides a scalar by each element of the matrix. - - The scalar to divide. - The result of the division. - - - - Divides a scalar by each element of the matrix and places results into the result matrix. - - The scalar to divide. - The matrix to store the result of the division. - If the result matrix's dimensions are not the same as this matrix. - - - - Multiplies this matrix by a vector and returns the result. - - The vector to multiply with. - The result of the multiplication. - If this.ColumnCount != rightSide.Count. - - - - Multiplies this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - If result.Count != this.RowCount. - If this.ColumnCount != .Count. - - - - Left multiply a matrix with a vector ( = vector * matrix ). - - The vector to multiply with. - The result of the multiplication. - If this.RowCount != .Count. - - - - Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector. - - The vector to multiply with. - The result of the multiplication. - If result.Count != this.ColumnCount. - If this.RowCount != .Count. - - - - Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector. - - The vector to multiply with. - The result of the multiplication. - - - - Multiplies this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - If this.Columns != other.Rows. - If the result matrix's dimensions are not the this.Rows x other.Columns. - - - - Multiplies this matrix with another matrix and returns the result. - - The matrix to multiply with. - If this.Columns != other.Rows. - The result of the multiplication. - - - - Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - If this.Columns != other.ColumnCount. - If the result matrix's dimensions are not the this.RowCount x other.RowCount. - - - - Multiplies this matrix with transpose of another matrix and returns the result. - - The matrix to multiply with. - If this.Columns != other.ColumnCount. - The result of the multiplication. - - - - Multiplies the transpose of this matrix by a vector and returns the result. - - The vector to multiply with. - The result of the multiplication. - If this.RowCount != rightSide.Count. - - - - Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - If result.Count != this.ColumnCount. - If this.RowCount != .Count. - - - - Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - If this.Rows != other.RowCount. - If the result matrix's dimensions are not the this.ColumnCount x other.ColumnCount. - - - - Multiplies the transpose of this matrix with another matrix and returns the result. - - The matrix to multiply with. - If this.Rows != other.RowCount. - The result of the multiplication. - - - - Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - If this.Columns != other.ColumnCount. - If the result matrix's dimensions are not the this.RowCount x other.RowCount. - - - - Multiplies this matrix with the conjugate transpose of another matrix and returns the result. - - The matrix to multiply with. - If this.Columns != other.ColumnCount. - The result of the multiplication. - - - - Multiplies the conjugate transpose of this matrix by a vector and returns the result. - - The vector to multiply with. - The result of the multiplication. - If this.RowCount != rightSide.Count. - - - - Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector. - - The vector to multiply with. - The result of the multiplication. - If result.Count != this.ColumnCount. - If this.RowCount != .Count. - - - - Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix. - - The matrix to multiply with. - The result of the multiplication. - If this.Rows != other.RowCount. - If the result matrix's dimensions are not the this.ColumnCount x other.ColumnCount. - - - - Multiplies the conjugate transpose of this matrix with another matrix and returns the result. - - The matrix to multiply with. - If this.Rows != other.RowCount. - The result of the multiplication. - - - - Raises this square matrix to a positive integer exponent and places the results into the result matrix. - - The positive integer exponent to raise the matrix to. - The result of the power. - - - - Multiplies this square matrix with another matrix and returns the result. - - The positive integer exponent to raise the matrix to. - - - - Negate each element of this matrix. - - A matrix containing the negated values. - - - - Negate each element of this matrix and place the results into the result matrix. - - The result of the negation. - if the result matrix's dimensions are not the same as this matrix. - - - - Complex conjugate each element of this matrix. - - A matrix containing the conjugated values. - - - - Complex conjugate each element of this matrix and place the results into the result matrix. - - The result of the conjugation. - if the result matrix's dimensions are not the same as this matrix. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for each element of the matrix. - - The scalar denominator to use. - A matrix containing the results. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for each element of the matrix. - - The scalar numerator to use. - A matrix containing the results. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for each element of the matrix. - - The scalar numerator to use. - Matrix to store the results in. - - - - Computes the remainder (matrix % divisor), where the result has the sign of the dividend, - for each element of the matrix. - - The scalar denominator to use. - A matrix containing the results. - - - - Computes the remainder (matrix % divisor), where the result has the sign of the dividend, - for each element of the matrix. - - The scalar denominator to use. - Matrix to store the results in. - - - - Computes the remainder (dividend % matrix), where the result has the sign of the dividend, - for each element of the matrix. - - The scalar numerator to use. - A matrix containing the results. - - - - Computes the remainder (dividend % matrix), where the result has the sign of the dividend, - for each element of the matrix. - - The scalar numerator to use. - Matrix to store the results in. - - - - Pointwise multiplies this matrix with another matrix. - - The matrix to pointwise multiply with this one. - If this matrix and are not the same size. - A new matrix that is the pointwise multiplication of this matrix and . - - - - Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. - - The matrix to pointwise multiply with this one. - The matrix to store the result of the pointwise multiplication. - If this matrix and are not the same size. - If this matrix and are not the same size. - - - - Pointwise divide this matrix by another matrix. - - The pointwise denominator matrix to use. - If this matrix and are not the same size. - A new matrix that is the pointwise division of this matrix and . - - - - Pointwise divide this matrix by another matrix and stores the result into the result matrix. - - The pointwise denominator matrix to use. - The matrix to store the result of the pointwise division. - If this matrix and are not the same size. - If this matrix and are not the same size. - - - - Pointwise raise this matrix to an exponent and store the result into the result matrix. - - The exponent to raise this matrix values to. - - - - Pointwise raise this matrix to an exponent. - - The exponent to raise this matrix values to. - The matrix to store the result into. - If this matrix and are not the same size. - - - - Pointwise raise this matrix to an exponent and store the result into the result matrix. - - The exponent to raise this matrix values to. - - - - Pointwise raise this matrix to an exponent. - - The exponent to raise this matrix values to. - The matrix to store the result into. - If this matrix and are not the same size. - - - - Pointwise canonical modulus, where the result has the sign of the divisor, - of this matrix by another matrix. - - The pointwise denominator matrix to use. - If this matrix and are not the same size. - - - - Pointwise canonical modulus, where the result has the sign of the divisor, - of this matrix by another matrix and stores the result into the result matrix. - - The pointwise denominator matrix to use. - The matrix to store the result of the pointwise modulus. - If this matrix and are not the same size. - If this matrix and are not the same size. - - - - Pointwise remainder (% operator), where the result has the sign of the dividend, - of this matrix by another matrix. - - The pointwise denominator matrix to use. - If this matrix and are not the same size. - - - - Pointwise remainder (% operator), where the result has the sign of the dividend, - of this matrix by another matrix and stores the result into the result matrix. - - The pointwise denominator matrix to use. - The matrix to store the result of the pointwise remainder. - If this matrix and are not the same size. - If this matrix and are not the same size. - - - - Helper function to apply a unary function to a matrix. The function - f modifies the matrix given to it in place. Before its - called, a copy of the 'this' matrix is first created, then passed to - f. The copy is then returned as the result - - Function which takes a matrix, modifies it in place and returns void - New instance of matrix which is the result - - - - Helper function to apply a unary function which modifies a matrix - in place. - - Function which takes a matrix, modifies it in place and returns void - The matrix to be passed to f and where the result is to be stored - If this vector and are not the same size. - - - - Helper function to apply a binary function which takes two matrices - and modifies the latter in place. A copy of the "this" matrix is - first made and then passed to f together with the other matrix. The - copy is then returned as the result - - Function which takes two matrices, modifies the second in place and returns void - The other matrix to be passed to the function as argument. It is not modified - The resulting matrix - If this matrix and are not the same dimension. - - - - Helper function to apply a binary function which takes two matrices - and modifies the second one in place - - Function which takes two matrices, modifies the second in place and returns void - The other matrix to be passed to the function as argument. It is not modified - The matrix to store the result. - The resulting matrix - If this matrix and are not the same dimension. - - - - Pointwise applies the exponent function to each value. - - - - - Pointwise applies the exponent function to each value. - - The matrix to store the result. - If this matrix and are not the same size. - - - - Pointwise applies the natural logarithm function to each value. - - - - - Pointwise applies the natural logarithm function to each value. - - The matrix to store the result. - If this matrix and are not the same size. - - - - Pointwise applies the abs function to each value - - - - - Pointwise applies the abs function to each value - - The vector to store the result - - - - Pointwise applies the acos function to each value - - - - - Pointwise applies the acos function to each value - - The vector to store the result - - - - Pointwise applies the asin function to each value - - - - - Pointwise applies the asin function to each value - - The vector to store the result - - - - Pointwise applies the atan function to each value - - - - - Pointwise applies the atan function to each value - - The vector to store the result - - - - Pointwise applies the atan2 function to each value of the current - matrix and a given other matrix being the 'x' of atan2 and the - 'this' matrix being the 'y' - - - - - - - Pointwise applies the atan2 function to each value of the current - matrix and a given other matrix being the 'x' of atan2 and the - 'this' matrix being the 'y' - - The other matrix 'y' - The matrix with the result and 'x' - - - - - Pointwise applies the ceiling function to each value - - - - - Pointwise applies the ceiling function to each value - - The vector to store the result - - - - Pointwise applies the cos function to each value - - - - - Pointwise applies the cos function to each value - - The vector to store the result - - - - Pointwise applies the cosh function to each value - - - - - Pointwise applies the cosh function to each value - - The vector to store the result - - - - Pointwise applies the floor function to each value - - - - - Pointwise applies the floor function to each value - - The vector to store the result - - - - Pointwise applies the log10 function to each value - - - - - Pointwise applies the log10 function to each value - - The vector to store the result - - - - Pointwise applies the round function to each value - - - - - Pointwise applies the round function to each value - - The vector to store the result - - - - Pointwise applies the sign function to each value - - - - - Pointwise applies the sign function to each value - - The vector to store the result - - - - Pointwise applies the sin function to each value - - - - - Pointwise applies the sin function to each value - - The vector to store the result - - - - Pointwise applies the sinh function to each value - - - - - Pointwise applies the sinh function to each value - - The vector to store the result - - - - Pointwise applies the sqrt function to each value - - - - - Pointwise applies the sqrt function to each value - - The vector to store the result - - - - Pointwise applies the tan function to each value - - - - - Pointwise applies the tan function to each value - - The vector to store the result - - - - Pointwise applies the tanh function to each value - - - - - Pointwise applies the tanh function to each value - - The vector to store the result - - - - Computes the trace of this matrix. - - The trace of this matrix - If the matrix is not square - - - - Calculates the rank of the matrix. - - effective numerical rank, obtained from SVD - - - - Calculates the nullity of the matrix. - - effective numerical nullity, obtained from SVD - - - Calculates the condition number of this matrix. - The condition number of the matrix. - The condition number is calculated using singular value decomposition. - - - Computes the determinant of this matrix. - The determinant of this matrix. - - - - Computes an orthonormal basis for the null space of this matrix, - also known as the kernel of the corresponding matrix transformation. - - - - - Computes an orthonormal basis for the column space of this matrix, - also known as the range or image of the corresponding matrix transformation. - - - - Computes the inverse of this matrix. - The inverse of this matrix. - - - Computes the Moore-Penrose Pseudo-Inverse of this matrix. - - - - Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N - with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. - - The other matrix. - The Kronecker product of the two matrices. - - - - Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N - with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. - - The other matrix. - The Kronecker product of the two matrices. - If the result matrix's dimensions are not (this.Rows * lower.rows) x (this.Columns * lower.Columns). - - - - Pointwise applies the minimum with a scalar to each value. - - The scalar value to compare to. - - - - Pointwise applies the minimum with a scalar to each value. - - The scalar value to compare to. - The vector to store the result. - If this vector and are not the same size. - - - - Pointwise applies the maximum with a scalar to each value. - - The scalar value to compare to. - - - - Pointwise applies the maximum with a scalar to each value. - - The scalar value to compare to. - The matrix to store the result. - If this matrix and are not the same size. - - - - Pointwise applies the absolute minimum with a scalar to each value. - - The scalar value to compare to. - - - - Pointwise applies the absolute minimum with a scalar to each value. - - The scalar value to compare to. - The matrix to store the result. - If this matrix and are not the same size. - - - - Pointwise applies the absolute maximum with a scalar to each value. - - The scalar value to compare to. - - - - Pointwise applies the absolute maximum with a scalar to each value. - - The scalar value to compare to. - The matrix to store the result. - If this matrix and are not the same size. - - - - Pointwise applies the minimum with the values of another matrix to each value. - - The matrix with the values to compare to. - - - - Pointwise applies the minimum with the values of another matrix to each value. - - The matrix with the values to compare to. - The matrix to store the result. - If this matrix and are not the same size. - - - - Pointwise applies the maximum with the values of another matrix to each value. - - The matrix with the values to compare to. - - - - Pointwise applies the maximum with the values of another matrix to each value. - - The matrix with the values to compare to. - The matrix to store the result. - If this matrix and are not the same size. - - - - Pointwise applies the absolute minimum with the values of another matrix to each value. - - The matrix with the values to compare to. - - - - Pointwise applies the absolute minimum with the values of another matrix to each value. - - The matrix with the values to compare to. - The matrix to store the result. - If this matrix and are not the same size. - - - - Pointwise applies the absolute maximum with the values of another matrix to each value. - - The matrix with the values to compare to. - - - - Pointwise applies the absolute maximum with the values of another matrix to each value. - - The matrix with the values to compare to. - The matrix to store the result. - If this matrix and are not the same size. - - - Calculates the induced L1 norm of this matrix. - The maximum absolute column sum of the matrix. - - - Calculates the induced L2 norm of the matrix. - The largest singular value of the matrix. - - For sparse matrices, the L2 norm is computed using a dense implementation of singular value decomposition. - In a later release, it will be replaced with a sparse implementation. - - - - Calculates the induced infinity norm of this matrix. - The maximum absolute row sum of the matrix. - - - Calculates the entry-wise Frobenius norm of this matrix. - The square root of the sum of the squared values. - - - - Calculates the p-norms of all row vectors. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Calculates the p-norms of all column vectors. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Normalizes all row vectors to a unit p-norm. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Normalizes all column vectors to a unit p-norm. - Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and positive infinity (infinity norm) - - - - - Calculates the value sum of each row vector. - - - - - Calculates the value sum of each column vector. - - - - - Calculates the absolute value sum of each row vector. - - - - - Calculates the absolute value sum of each column vector. - - - - - Indicates whether the current object is equal to another object of the same type. - - - An object to compare with this object. - - - true if the current object is equal to the parameter; otherwise, false. - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Creates a new object that is a copy of the current instance. - - - A new object that is a copy of this instance. - - - - - Returns a string that describes the type, dimensions and shape of this matrix. - - - - - Returns a string 2D array that summarizes the content of this matrix. - - - - - Returns a string 2D array that summarizes the content of this matrix. - - - - - Returns a string that summarizes the content of this matrix. - - - - - Returns a string that summarizes the content of this matrix. - - - - - Returns a string that summarizes this matrix. - - - - - Returns a string that summarizes this matrix. - The maximum number of cells can be configured in the class. - - - - - Returns a string that summarizes this matrix. - The maximum number of cells can be configured in the class. - The format string is ignored. - - - - - Initializes a new instance of the Matrix class. - - - - - Gets the raw matrix data storage. - - - - - Gets the number of columns. - - The number of columns. - - - - Gets the number of rows. - - The number of rows. - - - - Gets or sets the value at the given row and column, with range checking. - - - The row of the element. - - - The column of the element. - - The value to get or set. - This method is ranged checked. and - to get and set values without range checking. - - - - Retrieves the requested element without range checking. - - - The row of the element. - - - The column of the element. - - - The requested element. - - - - - Sets the value of the given element without range checking. - - - The row of the element. - - - The column of the element. - - - The value to set the element to. - - - - - Sets all values to zero. - - - - - Sets all values of a row to zero. - - - - - Sets all values of a column to zero. - - - - - Sets all values for all of the chosen rows to zero. - - - - - Sets all values for all of the chosen columns to zero. - - - - - Sets all values of a sub-matrix to zero. - - - - - Set all values whose absolute value is smaller than the threshold to zero, in-place. - - - - - Set all values that meet the predicate to zero, in-place. - - - - - Creates a clone of this instance. - - - A clone of the instance. - - - - - Copies the elements of this matrix to the given matrix. - - - The matrix to copy values into. - - - If target is . - - - If this and the target matrix do not have the same dimensions.. - - - - - Copies a row into an Vector. - - The row to copy. - A Vector containing the copied elements. - If is negative, - or greater than or equal to the number of rows. - - - - Copies a row into to the given Vector. - - The row to copy. - The Vector to copy the row into. - If the result vector is . - If is negative, - or greater than or equal to the number of rows. - If this.Columns != result.Count. - - - - Copies the requested row elements into a new Vector. - - The row to copy elements from. - The column to start copying from. - The number of elements to copy. - A Vector containing the requested elements. - If: - is negative, - or greater than or equal to the number of rows. - is negative, - or greater than or equal to the number of columns. - (columnIndex + length) >= Columns. - If is not positive. - - - - Copies the requested row elements into a new Vector. - - The row to copy elements from. - The column to start copying from. - The number of elements to copy. - The Vector to copy the column into. - If the result Vector is . - If is negative, - or greater than or equal to the number of columns. - If is negative, - or greater than or equal to the number of rows. - If + - is greater than or equal to the number of rows. - If is not positive. - If result.Count < length. - - - - Copies a column into a new Vector>. - - The column to copy. - A Vector containing the copied elements. - If is negative, - or greater than or equal to the number of columns. - - - - Copies a column into to the given Vector. - - The column to copy. - The Vector to copy the column into. - If the result Vector is . - If is negative, - or greater than or equal to the number of columns. - If this.Rows != result.Count. - - - - Copies the requested column elements into a new Vector. - - The column to copy elements from. - The row to start copying from. - The number of elements to copy. - A Vector containing the requested elements. - If: - is negative, - or greater than or equal to the number of columns. - is negative, - or greater than or equal to the number of rows. - (rowIndex + length) >= Rows. - - If is not positive. - - - - Copies the requested column elements into the given vector. - - The column to copy elements from. - The row to start copying from. - The number of elements to copy. - The Vector to copy the column into. - If the result Vector is . - If is negative, - or greater than or equal to the number of columns. - If is negative, - or greater than or equal to the number of rows. - If + - is greater than or equal to the number of rows. - If is not positive. - If result.Count < length. - - - - Returns a new matrix containing the upper triangle of this matrix. - - The upper triangle of this matrix. - - - - Returns a new matrix containing the lower triangle of this matrix. - - The lower triangle of this matrix. - - - - Puts the lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Puts the upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Creates a matrix that contains the values from the requested sub-matrix. - - The row to start copying from. - The number of rows to copy. Must be positive. - The column to start copying from. - The number of columns to copy. Must be positive. - The requested sub-matrix. - If: is - negative, or greater than or equal to the number of rows. - is negative, or greater than or equal to the number - of columns. - (columnIndex + columnLength) >= Columns - (rowIndex + rowLength) >= Rows - If or - is not positive. - - - - Returns the elements of the diagonal in a Vector. - - The elements of the diagonal. - For non-square matrices, the method returns Min(Rows, Columns) elements where - i == j (i is the row index, and j is the column index). - - - - Returns a new matrix containing the lower triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The lower triangle of this matrix. - - - - Puts the strictly lower triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Returns a new matrix containing the upper triangle of this matrix. The new matrix - does not contain the diagonal elements of this matrix. - - The upper triangle of this matrix. - - - - Puts the strictly upper triangle of this matrix into the result matrix. - - Where to store the lower triangle. - If is . - If the result matrix's dimensions are not the same as this matrix. - - - - Creates a new matrix and inserts the given column at the given index. - - The index of where to insert the column. - The column to insert. - A new matrix with the inserted column. - If is . - If is < zero or > the number of columns. - If the size of != the number of rows. - - - - Creates a new matrix with the given column removed. - - The index of the column to remove. - A new matrix without the chosen column. - If is < zero or >= the number of columns. - - - - Copies the values of the given Vector to the specified column. - - The column to copy the values to. - The vector to copy the values from. - If is . - If is less than zero, - or greater than or equal to the number of columns. - If the size of does not - equal the number of rows of this Matrix. - - - - Copies the values of the given Vector to the specified sub-column. - - The column to copy the values to. - The row to start copying to. - The number of elements to copy. - The vector to copy the values from. - If is . - If is less than zero, - or greater than or equal to the number of columns. - If the size of does not - equal the number of rows of this Matrix. - - - - Copies the values of the given array to the specified column. - - The column to copy the values to. - The array to copy the values from. - If is . - If is less than zero, - or greater than or equal to the number of columns. - If the size of does not - equal the number of rows of this Matrix. - If the size of does not - equal the number of rows of this Matrix. - - - - Creates a new matrix and inserts the given row at the given index. - - The index of where to insert the row. - The row to insert. - A new matrix with the inserted column. - If is . - If is < zero or > the number of rows. - If the size of != the number of columns. - - - - Creates a new matrix with the given row removed. - - The index of the row to remove. - A new matrix without the chosen row. - If is < zero or >= the number of rows. - - - - Copies the values of the given Vector to the specified row. - - The row to copy the values to. - The vector to copy the values from. - If is . - If is less than zero, - or greater than or equal to the number of rows. - If the size of does not - equal the number of columns of this Matrix. - - - - Copies the values of the given Vector to the specified sub-row. - - The row to copy the values to. - The column to start copying to. - The number of elements to copy. - The vector to copy the values from. - If is . - If is less than zero, - or greater than or equal to the number of rows. - If the size of does not - equal the number of columns of this Matrix. - - - - Copies the values of the given array to the specified row. - - The row to copy the values to. - The array to copy the values from. - If is . - If is less than zero, - or greater than or equal to the number of rows. - If the size of does not - equal the number of columns of this Matrix. - - - - Copies the values of a given matrix into a region in this matrix. - - The row to start copying to. - The column to start copying to. - The sub-matrix to copy from. - If: is - negative, or greater than or equal to the number of rows. - is negative, or greater than or equal to the number - of columns. - (columnIndex + columnLength) >= Columns - (rowIndex + rowLength) >= Rows - - - - Copies the values of a given matrix into a region in this matrix. - - The row to start copying to. - The number of rows to copy. Must be positive. - The column to start copying to. - The number of columns to copy. Must be positive. - The sub-matrix to copy from. - If: is - negative, or greater than or equal to the number of rows. - is negative, or greater than or equal to the number - of columns. - (columnIndex + columnLength) >= Columns - (rowIndex + rowLength) >= Rows - the size of is not at least x . - If or - is not positive. - - - - Copies the values of a given matrix into a region in this matrix. - - The row to start copying to. - The row of the sub-matrix to start copying from. - The number of rows to copy. Must be positive. - The column to start copying to. - The column of the sub-matrix to start copying from. - The number of columns to copy. Must be positive. - The sub-matrix to copy from. - If: is - negative, or greater than or equal to the number of rows. - is negative, or greater than or equal to the number - of columns. - (columnIndex + columnLength) >= Columns - (rowIndex + rowLength) >= Rows - the size of is not at least x . - If or - is not positive. - - - - Copies the values of the given Vector to the diagonal. - - The vector to copy the values from. The length of the vector should be - Min(Rows, Columns). - If is . - If the length of does not - equal Min(Rows, Columns). - For non-square matrices, the elements of are copied to - this[i,i]. - - - - Copies the values of the given array to the diagonal. - - The array to copy the values from. The length of the vector should be - Min(Rows, Columns). - If is . - If the length of does not - equal Min(Rows, Columns). - For non-square matrices, the elements of are copied to - this[i,i]. - - - - Creates a new matrix with the desired size and copies this matrix to it. - Values which no longer exist in the new matrix are ignored, new values are set to zero. - - The number of rows of the new matrix. - The number of columns of the new matrix. - A new matrix with the desired rows and columns. - - - - Returns the transpose of this matrix. - - The transpose of this matrix. - - - - Puts the transpose of this matrix into the result matrix. - - - - - Returns the conjugate transpose of this matrix. - - The conjugate transpose of this matrix. - - - - Puts the conjugate transpose of this matrix into the result matrix. - - - - - Permute the rows of a matrix according to a permutation. - - The row permutation to apply to this matrix. - - - - Permute the columns of a matrix according to a permutation. - - The column permutation to apply to this matrix. - - - - Concatenates this matrix with the given matrix. - - The matrix to concatenate. - The combined matrix. - - - - - - Concatenates this matrix with the given matrix and places the result into the result matrix. - - The matrix to concatenate. - The combined matrix. - - - - - - Stacks this matrix on top of the given matrix and places the result into the result matrix. - - The matrix to stack this matrix upon. - The combined matrix. - If lower is . - If upper.Columns != lower.Columns. - - - - - - Stacks this matrix on top of the given matrix and places the result into the result matrix. - - The matrix to stack this matrix upon. - The combined matrix. - If lower is . - If upper.Columns != lower.Columns. - - - - - - Diagonally stacks his matrix on top of the given matrix. The new matrix is a M-by-N matrix, - where M = this.Rows + lower.Rows and N = this.Columns + lower.Columns. - The values of off the off diagonal matrices/blocks are set to zero. - - The lower, right matrix. - If lower is . - the combined matrix - - - - - - Diagonally stacks his matrix on top of the given matrix and places the combined matrix into the result matrix. - - The lower, right matrix. - The combined matrix - If lower is . - If the result matrix is . - If the result matrix's dimensions are not (this.Rows + lower.rows) x (this.Columns + lower.Columns). - - - - - - Evaluates whether this matrix is symmetric. - - - - - Evaluates whether this matrix is Hermitian (conjugate symmetric). - - - - - Returns this matrix as a multidimensional array. - The returned array will be independent from this matrix. - A new memory block will be allocated for the array. - - A multidimensional containing the values of this matrix. - - - - Returns the matrix's elements as an array with the data laid out column by column (column major). - The returned array will be independent from this matrix. - A new memory block will be allocated for the array. - -
    -            1, 2, 3
    -            4, 5, 6  will be returned as  1, 4, 7, 2, 5, 8, 3, 6, 9
    -            7, 8, 9
    -            
    - An array containing the matrix's elements. - - -
    - - - Returns the matrix's elements as an array with the data laid row by row (row major). - The returned array will be independent from this matrix. - A new memory block will be allocated for the array. - -
    -            1, 2, 3
    -            4, 5, 6  will be returned as  1, 2, 3, 4, 5, 6, 7, 8, 9
    -            7, 8, 9
    -            
    - An array containing the matrix's elements. - - -
    - - - Returns this matrix as array of row arrays. - The returned arrays will be independent from this matrix. - A new memory block will be allocated for the arrays. - - - - - Returns this matrix as array of column arrays. - The returned arrays will be independent from this matrix. - A new memory block will be allocated for the arrays. - - - - - Returns the internal multidimensional array of this matrix if, and only if, this matrix is stored by such an array internally. - Otherwise returns null. Changes to the returned array and the matrix will affect each other. - Use ToArray instead if you always need an independent array. - - - - - Returns the internal column by column (column major) array of this matrix if, and only if, this matrix is stored by such arrays internally. - Otherwise returns null. Changes to the returned arrays and the matrix will affect each other. - Use ToColumnMajorArray instead if you always need an independent array. - -
    -            1, 2, 3
    -            4, 5, 6  will be returned as  1, 4, 7, 2, 5, 8, 3, 6, 9
    -            7, 8, 9
    -            
    - An array containing the matrix's elements. - - -
    - - - Returns the internal row by row (row major) array of this matrix if, and only if, this matrix is stored by such arrays internally. - Otherwise returns null. Changes to the returned arrays and the matrix will affect each other. - Use ToRowMajorArray instead if you always need an independent array. - -
    -            1, 2, 3
    -            4, 5, 6  will be returned as  1, 2, 3, 4, 5, 6, 7, 8, 9
    -            7, 8, 9
    -            
    - An array containing the matrix's elements. - - -
    - - - Returns the internal row arrays of this matrix if, and only if, this matrix is stored by such arrays internally. - Otherwise returns null. Changes to the returned arrays and the matrix will affect each other. - Use ToRowArrays instead if you always need an independent array. - - - - - Returns the internal column arrays of this matrix if, and only if, this matrix is stored by such arrays internally. - Otherwise returns null. Changes to the returned arrays and the matrix will affect each other. - Use ToColumnArrays instead if you always need an independent array. - - - - - Returns an IEnumerable that can be used to iterate through all values of the matrix. - - - The enumerator will include all values, even if they are zero. - The ordering of the values is unspecified (not necessarily column-wise or row-wise). - - - - - Returns an IEnumerable that can be used to iterate through all values of the matrix. - - - The enumerator will include all values, even if they are zero. - The ordering of the values is unspecified (not necessarily column-wise or row-wise). - - - - - Returns an IEnumerable that can be used to iterate through all values of the matrix and their index. - - - The enumerator returns a Tuple with the first two values being the row and column index - and the third value being the value of the element at that index. - The enumerator will include all values, even if they are zero. - - - - - Returns an IEnumerable that can be used to iterate through all values of the matrix and their index. - - - The enumerator returns a Tuple with the first two values being the row and column index - and the third value being the value of the element at that index. - The enumerator will include all values, even if they are zero. - - - - - Returns an IEnumerable that can be used to iterate through all columns of the matrix. - - - - - Returns an IEnumerable that can be used to iterate through a subset of all columns of the matrix. - - The column to start enumerating over. - The number of columns to enumerating over. - - - - Returns an IEnumerable that can be used to iterate through all columns of the matrix and their index. - - - The enumerator returns a Tuple with the first value being the column index - and the second value being the value of the column at that index. - - - - - Returns an IEnumerable that can be used to iterate through a subset of all columns of the matrix and their index. - - The column to start enumerating over. - The number of columns to enumerating over. - - The enumerator returns a Tuple with the first value being the column index - and the second value being the value of the column at that index. - - - - - Returns an IEnumerable that can be used to iterate through all rows of the matrix. - - - - - Returns an IEnumerable that can be used to iterate through a subset of all rows of the matrix. - - The row to start enumerating over. - The number of rows to enumerating over. - - - - Returns an IEnumerable that can be used to iterate through all rows of the matrix and their index. - - - The enumerator returns a Tuple with the first value being the row index - and the second value being the value of the row at that index. - - - - - Returns an IEnumerable that can be used to iterate through a subset of all rows of the matrix and their index. - - The row to start enumerating over. - The number of rows to enumerating over. - - The enumerator returns a Tuple with the first value being the row index - and the second value being the value of the row at that index. - - - - - Applies a function to each value of this matrix and replaces the value with its result. - If forceMapZero is not set to true, zero values may or may not be skipped depending - on the actual data storage implementation (relevant mostly for sparse matrices). - - - - - Applies a function to each value of this matrix and replaces the value with its result. - The row and column indices of each value (zero-based) are passed as first arguments to the function. - If forceMapZero is not set to true, zero values may or may not be skipped depending - on the actual data storage implementation (relevant mostly for sparse matrices). - - - - - Applies a function to each value of this matrix and replaces the value in the result matrix. - If forceMapZero is not set to true, zero values may or may not be skipped depending - on the actual data storage implementation (relevant mostly for sparse matrices). - - - - - Applies a function to each value of this matrix and replaces the value in the result matrix. - The index of each value (zero-based) is passed as first argument to the function. - If forceMapZero is not set to true, zero values may or may not be skipped depending - on the actual data storage implementation (relevant mostly for sparse matrices). - - - - - Applies a function to each value of this matrix and replaces the value in the result matrix. - If forceMapZero is not set to true, zero values may or may not be skipped depending - on the actual data storage implementation (relevant mostly for sparse matrices). - - - - - Applies a function to each value of this matrix and replaces the value in the result matrix. - The index of each value (zero-based) is passed as first argument to the function. - If forceMapZero is not set to true, zero values may or may not be skipped depending - on the actual data storage implementation (relevant mostly for sparse matrices). - - - - - Applies a function to each value of this matrix and returns the results as a new matrix. - If forceMapZero is not set to true, zero values may or may not be skipped depending - on the actual data storage implementation (relevant mostly for sparse matrices). - - - - - Applies a function to each value of this matrix and returns the results as a new matrix. - The index of each value (zero-based) is passed as first argument to the function. - If forceMapZero is not set to true, zero values may or may not be skipped depending - on the actual data storage implementation (relevant mostly for sparse matrices). - - - - - For each row, applies a function f to each element of the row, threading an accumulator argument through the computation. - Returns an array with the resulting accumulator states for each row. - - - - - For each column, applies a function f to each element of the column, threading an accumulator argument through the computation. - Returns an array with the resulting accumulator states for each column. - - - - - Applies a function f to each row vector, threading an accumulator vector argument through the computation. - Returns the resulting accumulator vector. - - - - - Applies a function f to each column vector, threading an accumulator vector argument through the computation. - Returns the resulting accumulator vector. - - - - - Reduces all row vectors by applying a function between two of them, until only a single vector is left. - - - - - Reduces all column vectors by applying a function between two of them, until only a single vector is left. - - - - - Applies a function to each value pair of two matrices and replaces the value in the result vector. - - - - - Applies a function to each value pair of two matrices and returns the results as a new vector. - - - - - Applies a function to update the status with each value pair of two matrices and returns the resulting status. - - - - - Returns a tuple with the index and value of the first element satisfying a predicate, or null if none is found. - Zero elements may be skipped on sparse data structures if allowed (default). - - - - - Returns a tuple with the index and values of the first element pair of two matrices of the same size satisfying a predicate, or null if none is found. - Zero elements may be skipped on sparse data structures if allowed (default). - - - - - Returns true if at least one element satisfies a predicate. - Zero elements may be skipped on sparse data structures if allowed (default). - - - - - Returns true if at least one element pairs of two matrices of the same size satisfies a predicate. - Zero elements may be skipped on sparse data structures if allowed (default). - - - - - Returns true if all elements satisfy a predicate. - Zero elements may be skipped on sparse data structures if allowed (default). - - - - - Returns true if all element pairs of two matrices of the same size satisfy a predicate. - Zero elements may be skipped on sparse data structures if allowed (default). - - - - - Returns a Matrix containing the same values of . - - The matrix to get the values from. - A matrix containing a the same values as . - If is . - - - - Negates each element of the matrix. - - The matrix to negate. - A matrix containing the negated values. - If is . - - - - Adds two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to add. - The right matrix to add. - The result of the addition. - If and don't have the same dimensions. - If or is . - - - - Adds a scalar to each element of the matrix. - - This operator will allocate new memory for the result. It will - choose the representation of the provided matrix. - The left matrix to add. - The scalar value to add. - The result of the addition. - If is . - - - - Adds a scalar to each element of the matrix. - - This operator will allocate new memory for the result. It will - choose the representation of the provided matrix. - The scalar value to add. - The right matrix to add. - The result of the addition. - If is . - - - - Subtracts two matrices together and returns the results. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to subtract. - The right matrix to subtract. - The result of the subtraction. - If and don't have the same dimensions. - If or is . - - - - Subtracts a scalar from each element of a matrix. - - This operator will allocate new memory for the result. It will - choose the representation of the provided matrix. - The left matrix to subtract. - The scalar value to subtract. - The result of the subtraction. - If and don't have the same dimensions. - If or is . - - - - Subtracts each element of a matrix from a scalar. - - This operator will allocate new memory for the result. It will - choose the representation of the provided matrix. - The scalar value to subtract. - The right matrix to subtract. - The result of the subtraction. - If and don't have the same dimensions. - If or is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies a Matrix by a constant and returns the result. - - The matrix to multiply. - The constant to multiply the matrix by. - The result of the multiplication. - If is . - - - - Multiplies two matrices. - - This operator will allocate new memory for the result. It will - choose the representation of either or depending on which - is denser. - The left matrix to multiply. - The right matrix to multiply. - The result of multiplication. - If or is . - If the dimensions of or don't conform. - - - - Multiplies a Matrix and a Vector. - - The matrix to multiply. - The vector to multiply. - The result of multiplication. - If or is . - - - - Multiplies a Vector and a Matrix. - - The vector to multiply. - The matrix to multiply. - The result of multiplication. - If or is . - - - - Divides a scalar with a matrix. - - The scalar to divide. - The matrix. - The result of the division. - If is . - - - - Divides a matrix with a scalar. - - The matrix to divide. - The scalar value. - The result of the division. - If is . - - - - Computes the pointwise remainder (% operator), where the result has the sign of the dividend, - of each element of the matrix of the given divisor. - - The matrix whose elements we want to compute the modulus of. - The divisor to use. - The result of the calculation - If is . - - - - Computes the pointwise remainder (% operator), where the result has the sign of the dividend, - of the given dividend of each element of the matrix. - - The dividend we want to compute the modulus of. - The matrix whose elements we want to use as divisor. - The result of the calculation - If is . - - - - Computes the pointwise remainder (% operator), where the result has the sign of the dividend, - of each element of two matrices. - - The matrix whose elements we want to compute the remainder of. - The divisor to use. - If and are not the same size. - If is . - - - - Computes the sqrt of a matrix pointwise - - The input matrix - - - - - Computes the exponential of a matrix pointwise - - The input matrix - - - - - Computes the log of a matrix pointwise - - The input matrix - - - - - Computes the log10 of a matrix pointwise - - The input matrix - - - - - Computes the sin of a matrix pointwise - - The input matrix - - - - - Computes the cos of a matrix pointwise - - The input matrix - - - - - Computes the tan of a matrix pointwise - - The input matrix - - - - - Computes the asin of a matrix pointwise - - The input matrix - - - - - Computes the acos of a matrix pointwise - - The input matrix - - - - - Computes the atan of a matrix pointwise - - The input matrix - - - - - Computes the sinh of a matrix pointwise - - The input matrix - - - - - Computes the cosh of a matrix pointwise - - The input matrix - - - - - Computes the tanh of a matrix pointwise - - The input matrix - - - - - Computes the absolute value of a matrix pointwise - - The input matrix - - - - - Computes the floor of a matrix pointwise - - The input matrix - - - - - Computes the ceiling of a matrix pointwise - - The input matrix - - - - - Computes the rounded value of a matrix pointwise - - The input matrix - - - - - Computes the Cholesky decomposition for a matrix. - - The Cholesky decomposition object. - - - - Computes the LU decomposition for a matrix. - - The LU decomposition object. - - - - Computes the QR decomposition for a matrix. - - The type of QR factorization to perform. - The QR decomposition object. - - - - Computes the QR decomposition for a matrix using Modified Gram-Schmidt Orthogonalization. - - The QR decomposition object. - - - - Computes the SVD decomposition for a matrix. - - Compute the singular U and VT vectors or not. - The SVD decomposition object. - - - - Computes the EVD decomposition for a matrix. - - The EVD decomposition object. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, AX = B, with A QR factorized. - - The right hand side , B. - The left hand side , X. - - - - Solves a system of linear equations, Ax = b, with A QR factorized. - - The right hand side vector, b. - The left hand side , x. - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. - - The solution vector b. - The result vector x. - The iterative solver to use. - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. - - The solution matrix B. - The result matrix X - The iterative solver to use. - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. - - The solution vector b. - The result vector x. - The iterative solver to use. - Criteria to control when to stop iterating. - The preconditioner to use for approximations. - - - - Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. - - The solution matrix B. - The result matrix X - The iterative solver to use. - Criteria to control when to stop iterating. - The preconditioner to use for approximations. - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. - - The solution vector b. - The result vector x. - The iterative solver to use. - Criteria to control when to stop iterating. - - - - Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. - - The solution matrix B. - The result matrix X - The iterative solver to use. - Criteria to control when to stop iterating. - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. - - The solution vector b. - The iterative solver to use. - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - The result vector x. - - - - Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. - - The solution matrix B. - The iterative solver to use. - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - The result matrix X. - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. - - The solution vector b. - The iterative solver to use. - Criteria to control when to stop iterating. - The preconditioner to use for approximations. - The result vector x. - - - - Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. - - The solution matrix B. - The iterative solver to use. - Criteria to control when to stop iterating. - The preconditioner to use for approximations. - The result matrix X. - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. - - The solution vector b. - The iterative solver to use. - Criteria to control when to stop iterating. - The result vector x. - - - - Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. - - The solution matrix B. - The iterative solver to use. - Criteria to control when to stop iterating. - The result matrix X. - - - - Converts a matrix to single precision. - - - - - Converts a matrix to double precision. - - - - - Converts a matrix to single precision complex numbers. - - - - - Converts a matrix to double precision complex numbers. - - - - - Gets a single precision complex matrix with the real parts from the given matrix. - - - - - Gets a double precision complex matrix with the real parts from the given matrix. - - - - - Gets a real matrix representing the real parts of a complex matrix. - - - - - Gets a real matrix representing the real parts of a complex matrix. - - - - - Gets a real matrix representing the imaginary parts of a complex matrix. - - - - - Gets a real matrix representing the imaginary parts of a complex matrix. - - - - - Existing data may not be all zeros, so clearing may be necessary - if not all of it will be overwritten anyway. - - - - - If existing data is assumed to be all zeros already, - clearing it may be skipped if applicable. - - - - - Allow skipping zero entries (without enforcing skipping them). - When enumerating sparse matrices this can significantly speed up operations. - - - - - Force applying the operation to all fields even if they are zero. - - - - - It is not known yet whether a matrix is symmetric or not. - - - - - A matrix is symmetric - - - - - A matrix is Hermitian (conjugate symmetric). - - - - - A matrix is not symmetric - - - - - Defines an that uses a cancellation token as stop criterion. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Determines the status of the iterative calculation based on the stop criteria stored - by the current . Result is set into Status field. - - The number of iterations that have passed so far. - The vector containing the current solution values. - The right hand side vector. - The vector containing the current residual vectors. - - The individual stop criteria may internally track the progress of the calculation based - on the invocation of this method. Therefore this method should only be called if the - calculation has moved forwards at least one step. - - - - - Gets the current calculation status. - - - - - Resets the to the pre-calculation state. - - - - - Clones the current and its settings. - - A new instance of the class. - - - - Stop criterion that delegates the status determination to a delegate. - - - - - Create a new instance of this criterion with a custom implementation. - - Custom implementation with the same signature and semantics as the DetermineStatus method. - - - - Determines the status of the iterative calculation by delegating it to the provided delegate. - Result is set into Status field. - - The number of iterations that have passed so far. - The vector containing the current solution values. - The right hand side vector. - The vector containing the current residual vectors. - - The individual stop criteria may internally track the progress of the calculation based - on the invocation of this method. Therefore this method should only be called if the - calculation has moved forwards at least one step. - - - - - Gets the current calculation status. - - - - - Resets the IIterationStopCriterion to the pre-calculation state. - - - - - Clones this criterion and its settings. - - - - - Monitors an iterative calculation for signs of divergence. - - - - - The maximum relative increase the residual may experience without triggering a divergence warning. - - - - - The number of iterations over which a residual increase should be tracked before issuing a divergence warning. - - - - - The status of the calculation - - - - - The array that holds the tracking information. - - - - - The iteration number of the last iteration. - - - - - Initializes a new instance of the class with the specified maximum - relative increase and the specified minimum number of tracking iterations. - - The maximum relative increase that the residual may experience before a divergence warning is issued. - The minimum number of iterations over which the residual must grow before a divergence warning is issued. - - - - Gets or sets the maximum relative increase that the residual may experience before a divergence warning is issued. - - Thrown if the Maximum is set to zero or below. - - - - Gets or sets the minimum number of iterations over which the residual must grow before - issuing a divergence warning. - - Thrown if the value is set to less than one. - - - - Determines the status of the iterative calculation based on the stop criteria stored - by the current . Result is set into Status field. - - The number of iterations that have passed so far. - The vector containing the current solution values. - The right hand side vector. - The vector containing the current residual vectors. - - The individual stop criteria may internally track the progress of the calculation based - on the invocation of this method. Therefore this method should only be called if the - calculation has moved forwards at least one step. - - - - - Detect if solution is diverging - - true if diverging, otherwise false - - - - Gets required history Length - - - - - Gets the current calculation status. - - - - - Resets the to the pre-calculation state. - - - - - Clones the current and its settings. - - A new instance of the class. - - - - Defines an that monitors residuals for NaN's. - - - - - The status of the calculation - - - - - The iteration number of the last iteration. - - - - - Determines the status of the iterative calculation based on the stop criteria stored - by the current . Result is set into Status field. - - The number of iterations that have passed so far. - The vector containing the current solution values. - The right hand side vector. - The vector containing the current residual vectors. - - The individual stop criteria may internally track the progress of the calculation based - on the invocation of this method. Therefore this method should only be called if the - calculation has moved forwards at least one step. - - - - - Gets the current calculation status. - - - - - Resets the to the pre-calculation state. - - - - - Clones the current and its settings. - - A new instance of the class. - - - - The base interface for classes that provide stop criteria for iterative calculations. - - - - - Determines the status of the iterative calculation based on the stop criteria stored - by the current IIterationStopCriterion. Status is set to Status field of current object. - - The number of iterations that have passed so far. - The vector containing the current solution values. - The right hand side vector. - The vector containing the current residual vectors. - - The individual stop criteria may internally track the progress of the calculation based - on the invocation of this method. Therefore this method should only be called if the - calculation has moved forwards at least one step. - - - - - Gets the current calculation status. - - is not a legal value. Status should be set in implementation. - - - - Resets the IIterationStopCriterion to the pre-calculation state. - - To implementers: Invoking this method should not clear the user defined - property values, only the state that is used to track the progress of the - calculation. - - - - Defines the interface for classes that solve the matrix equation Ax = b in - an iterative manner. - - - - - Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the - solution vector and x is the unknown vector. - - The coefficient matrix, A. - The solution vector, b - The result vector, x - The iterator to use to control when to stop iterating. - The preconditioner to use for approximations. - - - - Defines the interface for objects that can create an iterative solver with - specific settings. This interface is used to pass iterative solver creation - setup information around. - - - - - Gets the type of the solver that will be created by this setup object. - - - - - Gets type of preconditioner, if any, that will be created by this setup object. - - - - - Creates the iterative solver to be used. - - - - - Creates the preconditioner to be used by default (can be overwritten). - - - - - Gets the relative speed of the solver. - - Returns a value between 0 and 1, inclusive. - - - - Gets the relative reliability of the solver. - - Returns a value between 0 and 1 inclusive. - - - - The base interface for preconditioner classes. - - - - Preconditioners are used by iterative solvers to improve the convergence - speed of the solving process. Increase in convergence speed - is related to the number of iterations necessary to get a converged solution. - So while in general the use of a preconditioner means that the iterative - solver will perform fewer iterations it does not guarantee that the actual - solution time decreases given that some preconditioners can be expensive to - setup and run. - - - Note that in general changes to the matrix will invalidate the preconditioner - if the changes occur after creating the preconditioner. - - - - - - Initializes the preconditioner and loads the internal data structures. - - The matrix on which the preconditioner is based. - - - - Approximates the solution to the matrix equation Mx = b. - - The right hand side vector. - The left hand side vector. Also known as the result vector. - - - - Defines an that monitors the numbers of iteration - steps as stop criterion. - - - - - The default value for the maximum number of iterations the process is allowed - to perform. - - - - - The maximum number of iterations the calculation is allowed to perform. - - - - - The status of the calculation - - - - - Initializes a new instance of the class with the default maximum - number of iterations. - - - - - Initializes a new instance of the class with the specified maximum - number of iterations. - - The maximum number of iterations the calculation is allowed to perform. - - - - Gets or sets the maximum number of iterations the calculation is allowed to perform. - - Thrown if the Maximum is set to a negative value. - - - - Returns the maximum number of iterations to the default. - - - - - Determines the status of the iterative calculation based on the stop criteria stored - by the current . Result is set into Status field. - - The number of iterations that have passed so far. - The vector containing the current solution values. - The right hand side vector. - The vector containing the current residual vectors. - - The individual stop criteria may internally track the progress of the calculation based - on the invocation of this method. Therefore this method should only be called if the - calculation has moved forwards at least one step. - - - - - Gets the current calculation status. - - - - - Resets the to the pre-calculation state. - - - - - Clones the current and its settings. - - A new instance of the class. - - - - Iterative Calculation Status - - - - - An iterator that is used to check if an iterative calculation should continue or stop. - - - - - The collection that holds all the stop criteria and the flag indicating if they should be added - to the child iterators. - - - - - The status of the iterator. - - - - - Initializes a new instance of the class with the default stop criteria. - - - - - Initializes a new instance of the class with the specified stop criteria. - - - The specified stop criteria. Only one stop criterion of each type can be passed in. None - of the stop criteria will be passed on to child iterators. - - - - - Initializes a new instance of the class with the specified stop criteria. - - - The specified stop criteria. Only one stop criterion of each type can be passed in. None - of the stop criteria will be passed on to child iterators. - - - - - Gets the current calculation status. - - - - - Determines the status of the iterative calculation based on the stop criteria stored - by the current . Result is set into Status field. - - The number of iterations that have passed so far. - The vector containing the current solution values. - The right hand side vector. - The vector containing the current residual vectors. - - The individual iterators may internally track the progress of the calculation based - on the invocation of this method. Therefore this method should only be called if the - calculation has moved forwards at least one step. - - - - - Indicates to the iterator that the iterative process has been cancelled. - - - Does not reset the stop-criteria. - - - - - Resets the to the pre-calculation state. - - - - - Creates a deep clone of the current iterator. - - The deep clone of the current iterator. - - - - Defines an that monitors residuals as stop criterion. - - - - - The maximum value for the residual below which the calculation is considered converged. - - - - - The minimum number of iterations for which the residual has to be below the maximum before - the calculation is considered converged. - - - - - The status of the calculation - - - - - The number of iterations since the residuals got below the maximum. - - - - - The iteration number of the last iteration. - - - - - Initializes a new instance of the class with the specified - maximum residual and minimum number of iterations. - - - The maximum value for the residual below which the calculation is considered converged. - - - The minimum number of iterations for which the residual has to be below the maximum before - the calculation is considered converged. - - - - - Gets or sets the maximum value for the residual below which the calculation is considered - converged. - - Thrown if the Maximum is set to a negative value. - - - - Gets or sets the minimum number of iterations for which the residual has to be - below the maximum before the calculation is considered converged. - - Thrown if the BelowMaximumFor is set to a value less than 1. - - - - Determines the status of the iterative calculation based on the stop criteria stored - by the current . Result is set into Status field. - - The number of iterations that have passed so far. - The vector containing the current solution values. - The right hand side vector. - The vector containing the current residual vectors. - - The individual stop criteria may internally track the progress of the calculation based - on the invocation of this method. Therefore this method should only be called if the - calculation has moved forwards at least one step. - - - - - Gets the current calculation status. - - - - - Resets the to the pre-calculation state. - - - - - Clones the current and its settings. - - A new instance of the class. - - - - Loads the available objects from the specified assembly. - - The assembly which will be searched for setup objects. - If true, types that fail to load are simply ignored. Otherwise the exception is rethrown. - The types that should not be loaded. - - - - Loads the available objects from the specified assembly. - - The type in the assembly which should be searched for setup objects. - If true, types that fail to load are simply ignored. Otherwise the exception is rethrown. - The types that should not be loaded. - - - - Loads the available objects from the specified assembly. - - The of the assembly that should be searched for setup objects. - If true, types that fail to load are simply ignored. Otherwise the exception is rethrown. - The types that should not be loaded. - - - - Loads the available objects from the Math.NET Numerics assembly. - - The types that should not be loaded. - - - - Loads the available objects from the Math.NET Numerics assembly. - - - - - A unit preconditioner. This preconditioner does not actually do anything - it is only used when running an without - a preconditioner. - - - - - The coefficient matrix on which this preconditioner operates. - Is used to check dimensions on the different vectors that are processed. - - - - - Initializes the preconditioner and loads the internal data structures. - - - The matrix upon which the preconditioner is based. - - If is not a square matrix. - - - - Approximates the solution to the matrix equation Ax = b. - - The right hand side vector. - The left hand side vector. Also known as the result vector. - - - If and do not have the same size. - - - - or - - - - If the size of is different the number of rows of the coefficient matrix. - - - - - - True if the matrix storage format is dense. - - - - - True if all fields of this matrix can be set to any value. - False if some fields are fixed, like on a diagonal matrix. - - - - - True if the specified field can be set to any value. - False if the field is fixed, like an off-diagonal field on a diagonal matrix. - - - - - Retrieves the requested element without range checking. - - - - - Sets the element without range checking. - - - - - Evaluate the row and column at a specific data index. - - - - - True if the vector storage format is dense. - - - - - Retrieves the requested element without range checking. - - - - - Sets the element without range checking. - - - - - True if the matrix storage format is dense. - - - - - True if all fields of this matrix can be set to any value. - False if some fields are fixed, like on a diagonal matrix. - - - - - True if the specified field can be set to any value. - False if the field is fixed, like an off-diagonal field on a diagonal matrix. - - - - - Retrieves the requested element without range checking. - - - - - Sets the element without range checking. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - True if the matrix storage format is dense. - - - - - True if all fields of this matrix can be set to any value. - False if some fields are fixed, like on a diagonal matrix. - - - - - True if the specified field can be set to any value. - False if the field is fixed, like an off-diagonal field on a diagonal matrix. - - - - - Gets or sets the value at the given row and column, with range checking. - - - The row of the element. - - - The column of the element. - - The value to get or set. - This method is ranged checked. and - to get and set values without range checking. - - - - Retrieves the requested element without range checking. - - - The row of the element. - - - The column of the element. - - - The requested element. - - Not range-checked. - - - - Sets the element without range checking. - - The row of the element. - The column of the element. - The value to set the element to. - WARNING: This method is not thread safe. Use "lock" with it and be sure to avoid deadlocks. - - - - Indicates whether the current object is equal to another object of the same type. - - - An object to compare with this object. - - - true if the current object is equal to the parameter; otherwise, false. - - - - - Determines whether the specified is equal to the current . - - - true if the specified is equal to the current ; otherwise, false. - - The to compare with the current . - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - The state array will not be modified, unless it is the same instance as the target array (which is allowed). - - - The state array will not be modified, unless it is the same instance as the target array (which is allowed). - - - The state array will not be modified, unless it is the same instance as the target array (which is allowed). - - - The state array will not be modified, unless it is the same instance as the target array (which is allowed). - - - - The array containing the row indices of the existing rows. Element "i" of the array gives the index of the - element in the array that is first non-zero element in a row "i". - The last value is equal to ValueCount, so that the number of non-zero entries in row "i" is always - given by RowPointers[i+i] - RowPointers[i]. This array thus has length RowCount+1. - - - - - An array containing the column indices of the non-zero values. Element "j" of the array - is the number of the column in matrix that contains the j-th value in the array. - - - - - Array that contains the non-zero elements of matrix. Values of the non-zero elements of matrix are mapped into the values - array using the row-major storage mapping described in a compressed sparse row (CSR) format. - - - - - Gets the number of non zero elements in the matrix. - - The number of non zero elements. - - - - True if the matrix storage format is dense. - - - - - True if all fields of this matrix can be set to any value. - False if some fields are fixed, like on a diagonal matrix. - - - - - True if the specified field can be set to any value. - False if the field is fixed, like an off-diagonal field on a diagonal matrix. - - - - - Retrieves the requested element without range checking. - - - The row of the element. - - - The column of the element. - - - The requested element. - - Not range-checked. - - - - Sets the element without range checking. - - The row of the element. - The column of the element. - The value to set the element to. - WARNING: This method is not thread safe. Use "lock" with it and be sure to avoid deadlocks. - - - - Delete value from internal storage - - Index of value in nonZeroValues array - Row number of matrix - WARNING: This method is not thread safe. Use "lock" with it and be sure to avoid deadlocks - - - - Find item Index in nonZeroValues array - - Matrix row index - Matrix column index - Item index - WARNING: This method is not thread safe. Use "lock" with it and be sure to avoid deadlocks - - - - Calculates the amount with which to grow the storage array's if they need to be - increased in size. - - The amount grown. - - - - Eliminate duplicate entries by adding them together. - - - - - Fill zeros explicitly on the diagonal entries as required by the Intel MKL direct sparse solver. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Create a new sparse storage from a compressed sparse row (CSR) format. - This new storage will be independent from the given arrays. - A new memory block will be allocated for storing the matrix. - - The number of rows. - The number of columns. - The number of stored values including explicit zeros. - The row pointer array of the compressed sparse row format. - The column index array of the compressed sparse row format. - The data array of the compressed sparse row format. - The sparse storage from the compressed sparse row format. - Duplicate entries will be summed together and explicit zeros will be not intentionally removed. - - - - Create a new sparse matrix storage from a compressed sparse column (CSC) format. - This new storage will be independent from the given arrays. - A new memory block will be allocated. - - The number of rows. - The number of columns. - The number of stored values including explicit zeros. - The row index array of the compressed sparse column format. - The column pointer array of the compressed sparse column format. - The data array of the compressed sparse column format. - The sparse storage from the compressed sparse column format. - Duplicate entries will be summed together and explicit zeros will be not intentionally removed. - - - - Create a new sparse storage from a coordinate (COO) format. - This new storage will be independent from the given arrays. - A new memory block will be allocated for storing the matrix. - - The number of rows. - The number of columns. - The number of stored values including explicit zeros. - The row index array of the coordinate format. - The column index array of the coordinate format. - The data array of the coordinate format. - The sparse storage from the coordinate format. - Duplicate entries will be summed together and - explicit zeros will be not intentionally removed. - - - - Array that contains the indices of the non-zero values. - - - - - Array that contains the non-zero elements of the vector. - - - - - Gets the number of non-zero elements in the vector. - - - - - True if the vector storage format is dense. - - - - - Retrieves the requested element without range checking. - - - - - Sets the element without range checking. - - - - - Calculates the amount with which to grow the storage array's if they need to be - increased in size. - - The amount grown. - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - True if the vector storage format is dense. - - - - - Gets or sets the value at the given index, with range checking. - - - The index of the element. - - The value to get or set. - This method is ranged checked. and - to get and set values without range checking. - - - - Retrieves the requested element without range checking. - - The index of the element. - The requested element. - Not range-checked. - - - - Sets the element without range checking. - - The index of the element. - The value to set the element to. - WARNING: This method is not thread safe. Use "lock" with it and be sure to avoid deadlocks. - - - - Indicates whether the current object is equal to another object of the same type. - - - An object to compare with this object. - - - true if the current object is equal to the parameter; otherwise, false. - - - - - Determines whether the specified is equal to the current . - - - true if the specified is equal to the current ; otherwise, false. - - The to compare with the current . - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Defines the generic class for Vector classes. - - Supported data types are double, single, , and . - - - - The zero value for type T. - - - - - The value of 1.0 for type T. - - - - - Negates vector and save result to - - Target vector - - - - Complex conjugates vector and save result to - - Target vector - - - - Adds a scalar to each element of the vector and stores the result in the result vector. - - The scalar to add. - The vector to store the result of the addition. - - - - Adds another vector to this vector and stores the result into the result vector. - - The vector to add to this one. - The vector to store the result of the addition. - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - The scalar to subtract. - The vector to store the result of the subtraction. - - - - Subtracts each element of the vector from a scalar and stores the result in the result vector. - - The scalar to subtract from. - The vector to store the result of the subtraction. - - - - Subtracts another vector to this vector and stores the result into the result vector. - - The vector to subtract from this one. - The vector to store the result of the subtraction. - - - - Multiplies a scalar to each element of the vector and stores the result in the result vector. - - The scalar to multiply. - The vector to store the result of the multiplication. - - - - Computes the dot product between this vector and another vector. - - The other vector. - The sum of a[i]*b[i] for all i. - - - - Computes the dot product between the conjugate of this vector and another vector. - - The other vector. - The sum of conj(a[i])*b[i] for all i. - - - - Computes the outer product M[i,j] = u[i]*v[j] of this and another vector and stores the result in the result matrix. - - The other vector - The matrix to store the result of the product. - - - - Divides each element of the vector by a scalar and stores the result in the result vector. - - The scalar denominator to use. - The vector to store the result of the division. - - - - Divides a scalar by each element of the vector and stores the result in the result vector. - - The scalar numerator to use. - The vector to store the result of the division. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given dividend for each element of the vector. - - The scalar numerator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - for the given dividend for each element of the vector. - - The scalar numerator to use. - A vector to store the results in. - - - - Pointwise multiplies this vector with another vector and stores the result into the result vector. - - The vector to pointwise multiply with this one. - The vector to store the result of the pointwise multiplication. - - - - Pointwise divide this vector with another vector and stores the result into the result vector. - - The pointwise denominator vector to use. - The result of the division. - - - - Pointwise raise this vector to an exponent and store the result into the result vector. - - The exponent to raise this vector values to. - The vector to store the result of the pointwise power. - - - - Pointwise raise this vector to an exponent vector and store the result into the result vector. - - The exponent vector to raise this vector values to. - The vector to store the result of the pointwise power. - - - - Pointwise canonical modulus, where the result has the sign of the divisor, - of this vector with another vector and stores the result into the result vector. - - The pointwise denominator vector to use. - The result of the modulus. - - - - Pointwise remainder (% operator), where the result has the sign of the dividend, - of this vector with another vector and stores the result into the result vector. - - The pointwise denominator vector to use. - The result of the modulus. - - - - Pointwise applies the exponential function to each value and stores the result into the result vector. - - The vector to store the result. - - - - Pointwise applies the natural logarithm function to each value and stores the result into the result vector. - - The vector to store the result. - - - - Adds a scalar to each element of the vector. - - The scalar to add. - A copy of the vector with the scalar added. - - - - Adds a scalar to each element of the vector and stores the result in the result vector. - - The scalar to add. - The vector to store the result of the addition. - If this vector and are not the same size. - - - - Adds another vector to this vector. - - The vector to add to this one. - A new vector containing the sum of both vectors. - If this vector and are not the same size. - - - - Adds another vector to this vector and stores the result into the result vector. - - The vector to add to this one. - The vector to store the result of the addition. - If this vector and are not the same size. - If this vector and are not the same size. - - - - Subtracts a scalar from each element of the vector. - - The scalar to subtract. - A new vector containing the subtraction of this vector and the scalar. - - - - Subtracts a scalar from each element of the vector and stores the result in the result vector. - - The scalar to subtract. - The vector to store the result of the subtraction. - If this vector and are not the same size. - - - - Subtracts each element of the vector from a scalar. - - The scalar to subtract from. - A new vector containing the subtraction of the scalar and this vector. - - - - Subtracts each element of the vector from a scalar and stores the result in the result vector. - - The scalar to subtract from. - The vector to store the result of the subtraction. - If this vector and are not the same size. - - - - Returns a negated vector. - - The negated vector. - Added as an alternative to the unary negation operator. - - - - Negates vector and save result to - - Target vector - - - - Subtracts another vector from this vector. - - The vector to subtract from this one. - A new vector containing the subtraction of the two vectors. - If this vector and are not the same size. - - - - Subtracts another vector to this vector and stores the result into the result vector. - - The vector to subtract from this one. - The vector to store the result of the subtraction. - If this vector and are not the same size. - If this vector and are not the same size. - - - - Return vector with complex conjugate values of the source vector - - Conjugated vector - - - - Complex conjugates vector and save result to - - Target vector - - - - Multiplies a scalar to each element of the vector. - - The scalar to multiply. - A new vector that is the multiplication of the vector and the scalar. - - - - Multiplies a scalar to each element of the vector and stores the result in the result vector. - - The scalar to multiply. - The vector to store the result of the multiplication. - If this vector and are not the same size. - - - - Computes the dot product between this vector and another vector. - - The other vector. - The sum of a[i]*b[i] for all i. - If is not of the same size. - - - - - Computes the dot product between the conjugate of this vector and another vector. - - The other vector. - The sum of conj(a[i])*b[i] for all i. - If is not of the same size. - If is . - - - - - Divides each element of the vector by a scalar. - - The scalar to divide with. - A new vector that is the division of the vector and the scalar. - - - - Divides each element of the vector by a scalar and stores the result in the result vector. - - The scalar to divide with. - The vector to store the result of the division. - If this vector and are not the same size. - - - - Divides a scalar by each element of the vector. - - The scalar to divide. - A new vector that is the division of the vector and the scalar. - - - - Divides a scalar by each element of the vector and stores the result in the result vector. - - The scalar to divide. - The vector to store the result of the division. - If this vector and are not the same size. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector containing the result. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given dividend for each element of the vector. - - The scalar numerator to use. - A vector containing the result. - - - - Computes the canonical modulus, where the result has the sign of the divisor, - for the given dividend for each element of the vector. - - The scalar numerator to use. - A vector to store the results in. - - - - Computes the remainder (vector % divisor), where the result has the sign of the dividend, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector containing the result. - - - - Computes the remainder (vector % divisor), where the result has the sign of the dividend, - for each element of the vector for the given divisor. - - The scalar denominator to use. - A vector to store the results in. - - - - Computes the remainder (dividend % vector), where the result has the sign of the dividend, - for the given dividend for each element of the vector. - - The scalar numerator to use. - A vector containing the result. - - - - Computes the remainder (dividend % vector), where the result has the sign of the dividend, - for the given dividend for each element of the vector. - - The scalar numerator to use. - A vector to store the results in. - - - - Pointwise multiplies this vector with another vector. - - The vector to pointwise multiply with this one. - A new vector which is the pointwise multiplication of the two vectors. - If this vector and are not the same size. - - - - Pointwise multiplies this vector with another vector and stores the result into the result vector. - - The vector to pointwise multiply with this one. - The vector to store the result of the pointwise multiplication. - If this vector and are not the same size. - If this vector and are not the same size. - - - - Pointwise divide this vector with another vector. - - The pointwise denominator vector to use. - A new vector which is the pointwise division of the two vectors. - If this vector and are not the same size. - - - - Pointwise divide this vector with another vector and stores the result into the result vector. - - The pointwise denominator vector to use. - The vector to store the result of the pointwise division. - If this vector and are not the same size. - If this vector and are not the same size. - - - - Pointwise raise this vector to an exponent. - - The exponent to raise this vector values to. - - - - Pointwise raise this vector to an exponent and store the result into the result vector. - - The exponent to raise this vector values to. - The matrix to store the result into. - If this vector and are not the same size. - - - - Pointwise raise this vector to an exponent and store the result into the result vector. - - The exponent to raise this vector values to. - - - - Pointwise raise this vector to an exponent. - - The exponent to raise this vector values to. - The vector to store the result into. - If this vector and are not the same size. - - - - Pointwise canonical modulus, where the result has the sign of the divisor, - of this vector with another vector. - - The pointwise denominator vector to use. - If this vector and are not the same size. - - - - Pointwise canonical modulus, where the result has the sign of the divisor, - of this vector with another vector and stores the result into the result vector. - - The pointwise denominator vector to use. - The vector to store the result of the pointwise modulus. - If this vector and are not the same size. - If this vector and are not the same size. - - - - Pointwise remainder (% operator), where the result has the sign of the dividend, - of this vector with another vector. - - The pointwise denominator vector to use. - If this vector and are not the same size. - - - - Pointwise remainder (% operator), where the result has the sign of the dividend, - this vector with another vector and stores the result into the result vector. - - The pointwise denominator vector to use. - The vector to store the result of the pointwise remainder. - If this vector and are not the same size. - If this vector and are not the same size. - - - - Helper function to apply a unary function to a vector. The function - f modifies the vector given to it in place. Before its - called, a copy of the 'this' vector with the same dimension is - first created, then passed to f. The copy is returned as the result - - Function which takes a vector, modifies it in place and returns void - New instance of vector which is the result - - - - Helper function to apply a unary function which modifies a vector - in place. - - Function which takes a vector, modifies it in place and returns void - The vector where the result is to be stored - If this vector and are not the same size. - - - - Helper function to apply a binary function which takes a scalar and - a vector and modifies the latter in place. A copy of the "this" - vector is therefore first made and then passed to f together with - the scalar argument. The copy is then returned as the result - - Function which takes a scalar and a vector, modifies the vector in place and returns void - The scalar to be passed to the function - The resulting vector - - - - Helper function to apply a binary function which takes a scalar and - a vector, modifies the latter in place and returns void. - - Function which takes a scalar and a vector, modifies the vector in place and returns void - The scalar to be passed to the function - The vector where the result will be placed - If this vector and are not the same size. - - - - Helper function to apply a binary function which takes two vectors - and modifies the latter in place. A copy of the "this" vector is - first made and then passed to f together with the other vector. The - copy is then returned as the result - - Function which takes two vectors, modifies the second in place and returns void - The other vector to be passed to the function as argument. It is not modified - The resulting vector - If this vector and are not the same size. - - - - Helper function to apply a binary function which takes two vectors - and modifies the second one in place - - Function which takes two vectors, modifies the second in place and returns void - The other vector to be passed to the function as argument. It is not modified - The resulting vector - If this vector and are not the same size. - - - - Pointwise applies the exponent function to each value. - - - - - Pointwise applies the exponent function to each value. - - The vector to store the result. - If this vector and are not the same size. - - - - Pointwise applies the natural logarithm function to each value. - - - - - Pointwise applies the natural logarithm function to each value. - - The vector to store the result. - If this vector and are not the same size. - - - - Pointwise applies the abs function to each value - - - - - Pointwise applies the abs function to each value - - The vector to store the result - - - - Pointwise applies the acos function to each value - - - - - Pointwise applies the acos function to each value - - The vector to store the result - - - - Pointwise applies the asin function to each value - - - - - Pointwise applies the asin function to each value - - The vector to store the result - - - - Pointwise applies the atan function to each value - - - - - Pointwise applies the atan function to each value - - The vector to store the result - - - - Pointwise applies the atan2 function to each value of the current - vector and a given other vector being the 'x' of atan2 and the - 'this' vector being the 'y' - - - - - - Pointwise applies the atan2 function to each value of the current - vector and a given other vector being the 'x' of atan2 and the - 'this' vector being the 'y' - - - The vector to store the result - - - - Pointwise applies the ceiling function to each value - - - - - Pointwise applies the ceiling function to each value - - The vector to store the result - - - - Pointwise applies the cos function to each value - - - - - Pointwise applies the cos function to each value - - The vector to store the result - - - - Pointwise applies the cosh function to each value - - - - - Pointwise applies the cosh function to each value - - The vector to store the result - - - - Pointwise applies the floor function to each value - - - - - Pointwise applies the floor function to each value - - The vector to store the result - - - - Pointwise applies the log10 function to each value - - - - - Pointwise applies the log10 function to each value - - The vector to store the result - - - - Pointwise applies the round function to each value - - - - - Pointwise applies the round function to each value - - The vector to store the result - - - - Pointwise applies the sign function to each value - - - - - Pointwise applies the sign function to each value - - The vector to store the result - - - - Pointwise applies the sin function to each value - - - - - Pointwise applies the sin function to each value - - The vector to store the result - - - - Pointwise applies the sinh function to each value - - - - - Pointwise applies the sinh function to each value - - The vector to store the result - - - - Pointwise applies the sqrt function to each value - - - - - Pointwise applies the sqrt function to each value - - The vector to store the result - - - - Pointwise applies the tan function to each value - - - - - Pointwise applies the tan function to each value - - The vector to store the result - - - - Pointwise applies the tanh function to each value - - - - - Pointwise applies the tanh function to each value - - The vector to store the result - - - - Computes the outer product M[i,j] = u[i]*v[j] of this and another vector. - - The other vector - - - - Computes the outer product M[i,j] = u[i]*v[j] of this and another vector and stores the result in the result matrix. - - The other vector - The matrix to store the result of the product. - - - - Pointwise applies the minimum with a scalar to each value. - - The scalar value to compare to. - - - - Pointwise applies the minimum with a scalar to each value. - - The scalar value to compare to. - The vector to store the result. - If this vector and are not the same size. - - - - Pointwise applies the maximum with a scalar to each value. - - The scalar value to compare to. - - - - Pointwise applies the maximum with a scalar to each value. - - The scalar value to compare to. - The vector to store the result. - If this vector and are not the same size. - - - - Pointwise applies the absolute minimum with a scalar to each value. - - The scalar value to compare to. - - - - Pointwise applies the absolute minimum with a scalar to each value. - - The scalar value to compare to. - The vector to store the result. - If this vector and are not the same size. - - - - Pointwise applies the absolute maximum with a scalar to each value. - - The scalar value to compare to. - - - - Pointwise applies the absolute maximum with a scalar to each value. - - The scalar value to compare to. - The vector to store the result. - If this vector and are not the same size. - - - - Pointwise applies the minimum with the values of another vector to each value. - - The vector with the values to compare to. - - - - Pointwise applies the minimum with the values of another vector to each value. - - The vector with the values to compare to. - The vector to store the result. - If this vector and are not the same size. - - - - Pointwise applies the maximum with the values of another vector to each value. - - The vector with the values to compare to. - - - - Pointwise applies the maximum with the values of another vector to each value. - - The vector with the values to compare to. - The vector to store the result. - If this vector and are not the same size. - - - - Pointwise applies the absolute minimum with the values of another vector to each value. - - The vector with the values to compare to. - - - - Pointwise applies the absolute minimum with the values of another vector to each value. - - The vector with the values to compare to. - The vector to store the result. - If this vector and are not the same size. - - - - Pointwise applies the absolute maximum with the values of another vector to each value. - - The vector with the values to compare to. - - - - Pointwise applies the absolute maximum with the values of another vector to each value. - - The vector with the values to compare to. - The vector to store the result. - If this vector and are not the same size. - - - - Calculates the L1 norm of the vector, also known as Manhattan norm. - - The sum of the absolute values. - - - - Calculates the L2 norm of the vector, also known as Euclidean norm. - - The square root of the sum of the squared values. - - - - Calculates the infinity norm of the vector. - - The maximum absolute value. - - - - Computes the p-Norm. - - The p value. - Scalar ret = (sum(abs(this[i])^p))^(1/p) - - - - Normalizes this vector to a unit vector with respect to the p-norm. - - The p value. - This vector normalized to a unit vector with respect to the p-norm. - - - - Returns the value of the absolute minimum element. - - The value of the absolute minimum element. - - - - Returns the index of the absolute minimum element. - - The index of absolute minimum element. - - - - Returns the value of the absolute maximum element. - - The value of the absolute maximum element. - - - - Returns the index of the absolute maximum element. - - The index of absolute maximum element. - - - - Returns the value of maximum element. - - The value of maximum element. - - - - Returns the index of the maximum element. - - The index of maximum element. - - - - Returns the value of the minimum element. - - The value of the minimum element. - - - - Returns the index of the minimum element. - - The index of minimum element. - - - - Computes the sum of the vector's elements. - - The sum of the vector's elements. - - - - Computes the sum of the absolute value of the vector's elements. - - The sum of the absolute value of the vector's elements. - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - - true if the current object is equal to the parameter; otherwise, false. - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Creates a new object that is a copy of the current instance. - - - A new object that is a copy of this instance. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Returns a string that describes the type, dimensions and shape of this vector. - - - - - Returns a string that represents the content of this vector, column by column. - - Maximum number of entries and thus lines per column. Typical value: 12; Minimum: 3. - Maximum number of characters per line over all columns. Typical value: 80; Minimum: 16. - Character to use to print if there is not enough space to print all entries. Typical value: "..". - Character to use to separate two columns on a line. Typical value: " " (2 spaces). - Character to use to separate two rows/lines. Typical value: Environment.NewLine. - Function to provide a string for any given entry value. - - - - Returns a string that represents the content of this vector, column by column. - - Maximum number of entries and thus lines per column. Typical value: 12; Minimum: 3. - Maximum number of characters per line over all columns. Typical value: 80; Minimum: 16. - Floating point format string. Can be null. Default value: G6. - Format provider or culture. Can be null. - - - - Returns a string that represents the content of this vector, column by column. - - Floating point format string. Can be null. Default value: G6. - Format provider or culture. Can be null. - - - - Returns a string that summarizes this vector, column by column and with a type header. - - Maximum number of entries and thus lines per column. Typical value: 12; Minimum: 3. - Maximum number of characters per line over all columns. Typical value: 80; Minimum: 16. - Floating point format string. Can be null. Default value: G6. - Format provider or culture. Can be null. - - - - Returns a string that summarizes this vector. - The maximum number of cells can be configured in the class. - - - - - Returns a string that summarizes this vector. - The maximum number of cells can be configured in the class. - The format string is ignored. - - - - - Initializes a new instance of the Vector class. - - - - - Gets the raw vector data storage. - - - - - Gets the length or number of dimensions of this vector. - - - - Gets or sets the value at the given . - The index of the value to get or set. - The value of the vector at the given . - If is negative or - greater than the size of the vector. - - - Gets the value at the given without range checking.. - The index of the value to get or set. - The value of the vector at the given . - - - Sets the at the given without range checking.. - The index of the value to get or set. - The value to set. - - - - Resets all values to zero. - - - - - Sets all values of a subvector to zero. - - - - - Set all values whose absolute value is smaller than the threshold to zero, in-place. - - - - - Set all values that meet the predicate to zero, in-place. - - - - - Returns a deep-copy clone of the vector. - - A deep-copy clone of the vector. - - - - Set the values of this vector to the given values. - - The array containing the values to use. - If is . - If is not the same size as this vector. - - - - Copies the values of this vector into the target vector. - - The vector to copy elements into. - If is . - If is not the same size as this vector. - - - - Creates a vector containing specified elements. - - The first element to begin copying from. - The number of elements to copy. - A vector containing a copy of the specified elements. - If is not positive or - greater than or equal to the size of the vector. - If + is greater than or equal to the size of the vector. - - If is not positive. - - - - Copies the values of a given vector into a region in this vector. - - The field to start copying to - The number of fields to copy. Must be positive. - The sub-vector to copy from. - If is - - - - Copies the requested elements from this vector to another. - - The vector to copy the elements to. - The element to start copying from. - The element to start copying to. - The number of elements to copy. - - - - Returns the data contained in the vector as an array. - The returned array will be independent from this vector. - A new memory block will be allocated for the array. - - The vector's data as an array. - - - - Returns the internal array of this vector if, and only if, this vector is stored by such an array internally. - Otherwise returns null. Changes to the returned array and the vector will affect each other. - Use ToArray instead if you always need an independent array. - - - - - Create a matrix based on this vector in column form (one single column). - - - This vector as a column matrix. - - - - - Create a matrix based on this vector in row form (one single row). - - - This vector as a row matrix. - - - - - Returns an IEnumerable that can be used to iterate through all values of the vector. - - - The enumerator will include all values, even if they are zero. - - - - - Returns an IEnumerable that can be used to iterate through all values of the vector. - - - The enumerator will include all values, even if they are zero. - - - - - Returns an IEnumerable that can be used to iterate through all values of the vector and their index. - - - The enumerator returns a Tuple with the first value being the element index - and the second value being the value of the element at that index. - The enumerator will include all values, even if they are zero. - - - - - Returns an IEnumerable that can be used to iterate through all values of the vector and their index. - - - The enumerator returns a Tuple with the first value being the element index - and the second value being the value of the element at that index. - The enumerator will include all values, even if they are zero. - - - - - Applies a function to each value of this vector and replaces the value with its result. - If forceMapZero is not set to true, zero values may or may not be skipped depending - on the actual data storage implementation (relevant mostly for sparse vectors). - - - - - Applies a function to each value of this vector and replaces the value with its result. - The index of each value (zero-based) is passed as first argument to the function. - If forceMapZero is not set to true, zero values may or may not be skipped depending - on the actual data storage implementation (relevant mostly for sparse vectors). - - - - - Applies a function to each value of this vector and replaces the value in the result vector. - If forceMapZero is not set to true, zero values may or may not be skipped depending - on the actual data storage implementation (relevant mostly for sparse vectors). - - - - - Applies a function to each value of this vector and replaces the value in the result vector. - The index of each value (zero-based) is passed as first argument to the function. - If forceMapZero is not set to true, zero values may or may not be skipped depending - on the actual data storage implementation (relevant mostly for sparse vectors). - - - - - Applies a function to each value of this vector and replaces the value in the result vector. - If forceMapZero is not set to true, zero values may or may not be skipped depending - on the actual data storage implementation (relevant mostly for sparse vectors). - - - - - Applies a function to each value of this vector and replaces the value in the result vector. - The index of each value (zero-based) is passed as first argument to the function. - If forceMapZero is not set to true, zero values may or may not be skipped depending - on the actual data storage implementation (relevant mostly for sparse vectors). - - - - - Applies a function to each value of this vector and returns the results as a new vector. - If forceMapZero is not set to true, zero values may or may not be skipped depending - on the actual data storage implementation (relevant mostly for sparse vectors). - - - - - Applies a function to each value of this vector and returns the results as a new vector. - The index of each value (zero-based) is passed as first argument to the function. - If forceMapZero is not set to true, zero values may or may not be skipped depending - on the actual data storage implementation (relevant mostly for sparse vectors). - - - - - Applies a function to each value pair of two vectors and replaces the value in the result vector. - - - - - Applies a function to each value pair of two vectors and returns the results as a new vector. - - - - - Applies a function to update the status with each value pair of two vectors and returns the resulting status. - - - - - Returns a tuple with the index and value of the first element satisfying a predicate, or null if none is found. - Zero elements may be skipped on sparse data structures if allowed (default). - - - - - Returns a tuple with the index and values of the first element pair of two vectors of the same size satisfying a predicate, or null if none is found. - Zero elements may be skipped on sparse data structures if allowed (default). - - - - - Returns true if at least one element satisfies a predicate. - Zero elements may be skipped on sparse data structures if allowed (default). - - - - - Returns true if at least one element pairs of two vectors of the same size satisfies a predicate. - Zero elements may be skipped on sparse data structures if allowed (default). - - - - - Returns true if all elements satisfy a predicate. - Zero elements may be skipped on sparse data structures if allowed (default). - - - - - Returns true if all element pairs of two vectors of the same size satisfy a predicate. - Zero elements may be skipped on sparse data structures if allowed (default). - - - - - Returns a Vector containing the same values of . - - This method is included for completeness. - The vector to get the values from. - A vector containing the same values as . - If is . - - - - Returns a Vector containing the negated values of . - - The vector to get the values from. - A vector containing the negated values as . - If is . - - - - Adds two Vectors together and returns the results. - - One of the vectors to add. - The other vector to add. - The result of the addition. - If and are not the same size. - If or is . - - - - Adds a scalar to each element of a vector. - - The vector to add to. - The scalar value to add. - The result of the addition. - If is . - - - - Adds a scalar to each element of a vector. - - The scalar value to add. - The vector to add to. - The result of the addition. - If is . - - - - Subtracts two Vectors and returns the results. - - The vector to subtract from. - The vector to subtract. - The result of the subtraction. - If and are not the same size. - If or is . - - - - Subtracts a scalar from each element of a vector. - - The vector to subtract from. - The scalar value to subtract. - The result of the subtraction. - If is . - - - - Subtracts each element of a vector from a scalar. - - The scalar value to subtract from. - The vector to subtract. - The result of the subtraction. - If is . - - - - Multiplies a vector with a scalar. - - The vector to scale. - The scalar value. - The result of the multiplication. - If is . - - - - Multiplies a vector with a scalar. - - The scalar value. - The vector to scale. - The result of the multiplication. - If is . - - - - Computes the dot product between two Vectors. - - The left row vector. - The right column vector. - The dot product between the two vectors. - If and are not the same size. - If or is . - - - - Divides a scalar with a vector. - - The scalar to divide. - The vector. - The result of the division. - If is . - - - - Divides a vector with a scalar. - - The vector to divide. - The scalar value. - The result of the division. - If is . - - - - Pointwise divides two Vectors. - - The vector to divide. - The other vector. - The result of the division. - If and are not the same size. - If is . - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - of each element of the vector of the given divisor. - - The vector whose elements we want to compute the remainder of. - The divisor to use. - If is . - - - - Computes the remainder (% operator), where the result has the sign of the dividend, - of the given dividend of each element of the vector. - - The dividend we want to compute the remainder of. - The vector whose elements we want to use as divisor. - If is . - - - - Computes the pointwise remainder (% operator), where the result has the sign of the dividend, - of each element of two vectors. - - The vector whose elements we want to compute the remainder of. - The divisor to use. - If and are not the same size. - If is . - - - - Computes the sqrt of a vector pointwise - - The input vector - - - - - Computes the exponential of a vector pointwise - - The input vector - - - - - Computes the log of a vector pointwise - - The input vector - - - - - Computes the log10 of a vector pointwise - - The input vector - - - - - Computes the sin of a vector pointwise - - The input vector - - - - - Computes the cos of a vector pointwise - - The input vector - - - - - Computes the tan of a vector pointwise - - The input vector - - - - - Computes the asin of a vector pointwise - - The input vector - - - - - Computes the acos of a vector pointwise - - The input vector - - - - - Computes the atan of a vector pointwise - - The input vector - - - - - Computes the sinh of a vector pointwise - - The input vector - - - - - Computes the cosh of a vector pointwise - - The input vector - - - - - Computes the tanh of a vector pointwise - - The input vector - - - - - Computes the absolute value of a vector pointwise - - The input vector - - - - - Computes the floor of a vector pointwise - - The input vector - - - - - Computes the ceiling of a vector pointwise - - The input vector - - - - - Computes the rounded value of a vector pointwise - - The input vector - - - - - Converts a vector to single precision. - - - - - Converts a vector to double precision. - - - - - Converts a vector to single precision complex numbers. - - - - - Converts a vector to double precision complex numbers. - - - - - Gets a single precision complex vector with the real parts from the given vector. - - - - - Gets a double precision complex vector with the real parts from the given vector. - - - - - Gets a real vector representing the real parts of a complex vector. - - - - - Gets a real vector representing the real parts of a complex vector. - - - - - Gets a real vector representing the imaginary parts of a complex vector. - - - - - Gets a real vector representing the imaginary parts of a complex vector. - - - - - Find the model parameters β such that X*β with predictor X becomes as close to response Y as possible, with least squares residuals. - - Predictor matrix X - Response vector Y - The direct method to be used to compute the regression. - Best fitting vector for model parameters β - - - - Find the model parameters β such that X*β with predictor X becomes as close to response Y as possible, with least squares residuals. - - Predictor matrix X - Response matrix Y - The direct method to be used to compute the regression. - Best fitting vector for model parameters β - - - - Find the model parameters β such that their linear combination with all predictor-arrays in X become as close to their response in Y as possible, with least squares residuals. - - List of predictor-arrays. - List of responses - True if an intercept should be added as first artificial predictor value. Default = false. - The direct method to be used to compute the regression. - Best fitting list of model parameters β for each element in the predictor-arrays. - - - - Find the model parameters β such that their linear combination with all predictor-arrays in X become as close to their response in Y as possible, with least squares residuals. - Uses the cholesky decomposition of the normal equations. - - Sequence of predictor-arrays and their response. - True if an intercept should be added as first artificial predictor value. Default = false. - The direct method to be used to compute the regression. - Best fitting list of model parameters β for each element in the predictor-arrays. - - - - Find the model parameters β such that X*β with predictor X becomes as close to response Y as possible, with least squares residuals. - Uses the cholesky decomposition of the normal equations. - - Predictor matrix X - Response vector Y - Best fitting vector for model parameters β - - - - Find the model parameters β such that X*β with predictor X becomes as close to response Y as possible, with least squares residuals. - Uses the cholesky decomposition of the normal equations. - - Predictor matrix X - Response matrix Y - Best fitting vector for model parameters β - - - - Find the model parameters β such that their linear combination with all predictor-arrays in X become as close to their response in Y as possible, with least squares residuals. - Uses the cholesky decomposition of the normal equations. - - List of predictor-arrays. - List of responses - True if an intercept should be added as first artificial predictor value. Default = false. - Best fitting list of model parameters β for each element in the predictor-arrays. - - - - Find the model parameters β such that their linear combination with all predictor-arrays in X become as close to their response in Y as possible, with least squares residuals. - Uses the cholesky decomposition of the normal equations. - - Sequence of predictor-arrays and their response. - True if an intercept should be added as first artificial predictor value. Default = false. - Best fitting list of model parameters β for each element in the predictor-arrays. - - - - Find the model parameters β such that their linear combination with all predictor-arrays in X become as close to their response in Y as possible, with least squares residuals. - Uses the cholesky decomposition of the normal equations. - - Sequence of predictor-arrays and their response. - True if an intercept should be added as first artificial predictor value. Default = false. - Best fitting list of model parameters β for each element in the predictor-arrays. - - - - Find the model parameters β such that X*β with predictor X becomes as close to response Y as possible, with least squares residuals. - Uses an orthogonal decomposition and is therefore more numerically stable than the normal equations but also slower. - - Predictor matrix X - Response vector Y - Best fitting vector for model parameters β - - - - Find the model parameters β such that X*β with predictor X becomes as close to response Y as possible, with least squares residuals. - Uses an orthogonal decomposition and is therefore more numerically stable than the normal equations but also slower. - - Predictor matrix X - Response matrix Y - Best fitting vector for model parameters β - - - - Find the model parameters β such that their linear combination with all predictor-arrays in X become as close to their response in Y as possible, with least squares residuals. - Uses an orthogonal decomposition and is therefore more numerically stable than the normal equations but also slower. - - List of predictor-arrays. - List of responses - True if an intercept should be added as first artificial predictor value. Default = false. - Best fitting list of model parameters β for each element in the predictor-arrays. - - - - Find the model parameters β such that their linear combination with all predictor-arrays in X become as close to their response in Y as possible, with least squares residuals. - Uses an orthogonal decomposition and is therefore more numerically stable than the normal equations but also slower. - - Sequence of predictor-arrays and their response. - True if an intercept should be added as first artificial predictor value. Default = false. - Best fitting list of model parameters β for each element in the predictor-arrays. - - - - Find the model parameters β such that their linear combination with all predictor-arrays in X become as close to their response in Y as possible, with least squares residuals. - Uses an orthogonal decomposition and is therefore more numerically stable than the normal equations but also slower. - - Sequence of predictor-arrays and their response. - True if an intercept should be added as first artificial predictor value. Default = false. - Best fitting list of model parameters β for each element in the predictor-arrays. - - - - Find the model parameters β such that X*β with predictor X becomes as close to response Y as possible, with least squares residuals. - Uses a singular value decomposition and is therefore more numerically stable (especially if ill-conditioned) than the normal equations or QR but also slower. - - Predictor matrix X - Response vector Y - Best fitting vector for model parameters β - - - - Find the model parameters β such that X*β with predictor X becomes as close to response Y as possible, with least squares residuals. - Uses a singular value decomposition and is therefore more numerically stable (especially if ill-conditioned) than the normal equations or QR but also slower. - - Predictor matrix X - Response matrix Y - Best fitting vector for model parameters β - - - - Find the model parameters β such that their linear combination with all predictor-arrays in X become as close to their response in Y as possible, with least squares residuals. - Uses a singular value decomposition and is therefore more numerically stable (especially if ill-conditioned) than the normal equations or QR but also slower. - - List of predictor-arrays. - List of responses - True if an intercept should be added as first artificial predictor value. Default = false. - Best fitting list of model parameters β for each element in the predictor-arrays. - - - - Find the model parameters β such that their linear combination with all predictor-arrays in X become as close to their response in Y as possible, with least squares residuals. - Uses a singular value decomposition and is therefore more numerically stable (especially if ill-conditioned) than the normal equations or QR but also slower. - - Sequence of predictor-arrays and their response. - True if an intercept should be added as first artificial predictor value. Default = false. - Best fitting list of model parameters β for each element in the predictor-arrays. - - - - Find the model parameters β such that their linear combination with all predictor-arrays in X become as close to their response in Y as possible, with least squares residuals. - Uses a singular value decomposition and is therefore more numerically stable (especially if ill-conditioned) than the normal equations or QR but also slower. - - Sequence of predictor-arrays and their response. - True if an intercept should be added as first artificial predictor value. Default = false. - Best fitting list of model parameters β for each element in the predictor-arrays. - - - - Least-Squares fitting the points (x,y) to a line y : x -> a+b*x, - returning its best fitting parameters as (a, b) tuple, - where a is the intercept and b the slope. - - Predictor (independent) - Response (dependent) - - - - Least-Squares fitting the points (x,y) to a line y : x -> a+b*x, - returning its best fitting parameters as (a, b) tuple, - where a is the intercept and b the slope. - - Predictor-Response samples as tuples - - - - Least-Squares fitting the points (x,y) to a line y : x -> a+b*x, - returning its best fitting parameters as (a, b) tuple, - where a is the intercept and b the slope. - - Predictor-Response samples as tuples - - - - Least-Squares fitting the points (x,y) to a line y : x -> b*x, - returning its best fitting parameter b, - where the intercept is zero and b the slope. - - Predictor (independent) - Response (dependent) - - - - Least-Squares fitting the points (x,y) to a line y : x -> b*x, - returning its best fitting parameter b, - where the intercept is zero and b the slope. - - Predictor-Response samples as tuples - - - - Weighted Linear Regression using normal equations. - - Predictor matrix X - Response vector Y - Weight matrix W, usually diagonal with an entry for each predictor (row). - - - - Weighted Linear Regression using normal equations. - - Predictor matrix X - Response matrix Y - Weight matrix W, usually diagonal with an entry for each predictor (row). - - - - Weighted Linear Regression using normal equations. - - Predictor matrix X - Response vector Y - Weight matrix W, usually diagonal with an entry for each predictor (row). - True if an intercept should be added as first artificial predictor value. Default = false. - - - - Weighted Linear Regression using normal equations. - - List of sample vectors (predictor) together with their response. - List of weights, one for each sample. - True if an intercept should be added as first artificial predictor value. Default = false. - - - - Weighted Linear Regression using normal equations. - - List of sample vectors (predictor) together with their response. - List of weights, one for each sample. - True if an intercept should be added as first artificial predictor value. Default = false. - - - - Locally-Weighted Linear Regression using normal equations. - - - - - Locally-Weighted Linear Regression using normal equations. - - - - - First Order AB method(same as Forward Euler) - - Initial value - Start Time - End Time - Size of output array(the larger, the finer) - ode model - approximation with size N - - - - Second Order AB Method - - Initial value 1 - Start Time - End Time - Size of output array(the larger, the finer) - ode model - approximation with size N - - - - Third Order AB Method - - Initial value 1 - Start Time - End Time - Size of output array(the larger, the finer) - ode model - approximation with size N - - - - Fourth Order AB Method - - Initial value 1 - Start Time - End Time - Size of output array(the larger, the finer) - ode model - approximation with size N - - - - ODE Solver Algorithms - - - - - Second Order Runge-Kutta method - - initial value - start time - end time - Size of output array(the larger, the finer) - ode function - approximations - - - - Fourth Order Runge-Kutta method - - initial value - start time - end time - Size of output array(the larger, the finer) - ode function - approximations - - - - Second Order Runge-Kutta to solve ODE SYSTEM - - initial vector - start time - end time - Size of output array(the larger, the finer) - ode function - approximations - - - - Fourth Order Runge-Kutta to solve ODE SYSTEM - - initial vector - start time - end time - Size of output array(the larger, the finer) - ode function - approximations - - - - Broyden–Fletcher–Goldfarb–Shanno Bounded (BFGS-B) algorithm is an iterative method for solving box-constrained nonlinear optimization problems - http://www.ece.northwestern.edu/~nocedal/PSfiles/limited.ps.gz - - - - - Find the minimum of the objective function given lower and upper bounds - - The objective function, must support a gradient - The lower bound - The upper bound - The initial guess - The MinimizationResult which contains the minimum and the ExitCondition - - - - Broyden–Fletcher–Goldfarb–Shanno (BFGS) algorithm is an iterative method for solving unconstrained nonlinear optimization problems - - - - - Creates BFGS minimizer - - The gradient tolerance - The parameter tolerance - The function progress tolerance - The maximum number of iterations - - - - Find the minimum of the objective function given lower and upper bounds - - The objective function, must support a gradient - The initial guess - The MinimizationResult which contains the minimum and the ExitCondition - - - - - Creates a base class for BFGS minimization - - - - - Broyden-Fletcher-Goldfarb-Shanno solver for finding function minima - See http://en.wikipedia.org/wiki/Broyden%E2%80%93Fletcher%E2%80%93Goldfarb%E2%80%93Shanno_algorithm - Inspired by implementation: https://github.com/PatWie/CppNumericalSolvers/blob/master/src/BfgsSolver.cpp - - - - - Finds a minimum of a function by the BFGS quasi-Newton method - This uses the function and it's gradient (partial derivatives in each direction) and approximates the Hessian - - An initial guess - Evaluates the function at a point - Evaluates the gradient of the function at a point - The minimum found - - - - Objective function with a frozen evaluation that must not be changed from the outside. - - - - Create a new unevaluated and independent copy of this objective function - - - - Objective function with a mutable evaluation. - - - - Create a new independent copy of this objective function, evaluated at the same point. - - - - Get the y-values of the observations. - - - - - Get the values of the weights for the observations. - - - - - Get the y-values of the fitted model that correspond to the independent values. - - - - - Get the values of the parameters. - - - - - Get the residual sum of squares. - - - - - Get the Gradient vector. G = J'(y - f(x; p)) - - - - - Get the approximated Hessian matrix. H = J'J - - - - - Get the number of calls to function. - - - - - Get the number of calls to jacobian. - - - - - Get the degree of freedom. - - - - - The scale factor for initial mu - - - - - Non-linear least square fitting by the Levenberg-Marduardt algorithm. - - The objective function, including model, observations, and parameter bounds. - The initial guess values. - The initial damping parameter of mu. - The stopping threshold for infinity norm of the gradient vector. - The stopping threshold for L2 norm of the change of parameters. - The stopping threshold for L2 norm of the residuals. - The max iterations. - The result of the Levenberg-Marquardt minimization - - - - Limited Memory version of Broyden–Fletcher–Goldfarb–Shanno (BFGS) algorithm - - - - - - Creates L-BFGS minimizer - - Numbers of gradients and steps to store. - - - - Find the minimum of the objective function given lower and upper bounds - - The objective function, must support a gradient - The initial guess - The MinimizationResult which contains the minimum and the ExitCondition - - - - Search for a step size alpha that satisfies the weak Wolfe conditions. The weak Wolfe - Conditions are - i) Armijo Rule: f(x_k + alpha_k p_k) <= f(x_k) + c1 alpha_k p_k^T g(x_k) - ii) Curvature Condition: p_k^T g(x_k + alpha_k p_k) >= c2 p_k^T g(x_k) - where g(x) is the gradient of f(x), 0 < c1 < c2 < 1. - - Implementation is based on http://www.math.washington.edu/~burke/crs/408/lectures/L9-weak-Wolfe.pdf - - references: - http://en.wikipedia.org/wiki/Wolfe_conditions - http://www.math.washington.edu/~burke/crs/408/lectures/L9-weak-Wolfe.pdf - - - - Implemented following http://www.math.washington.edu/~burke/crs/408/lectures/L9-weak-Wolfe.pdf - The objective function being optimized, evaluated at the starting point of the search - Search direction - Initial size of the step in the search direction - - - - The objective function being optimized, evaluated at the starting point of the search - Search direction - Initial size of the step in the search direction - The upper bound - - - - Creates a base class for minimization - - The gradient tolerance - The parameter tolerance - The function progress tolerance - The maximum number of iterations - - - - Class implementing the Nelder-Mead simplex algorithm, used to find a minima when no gradient is available. - Called fminsearch() in Matlab. A description of the algorithm can be found at - http://se.mathworks.com/help/matlab/math/optimizing-nonlinear-functions.html#bsgpq6p-11 - or - https://en.wikipedia.org/wiki/Nelder%E2%80%93Mead_method - - - - - Finds the minimum of the objective function without an initial perturbation, the default values used - by fminsearch() in Matlab are used instead - http://se.mathworks.com/help/matlab/math/optimizing-nonlinear-functions.html#bsgpq6p-11 - - The objective function, no gradient or hessian needed - The initial guess - The minimum point - - - - Finds the minimum of the objective function with an initial perturbation - - The objective function, no gradient or hessian needed - The initial guess - The initial perturbation - The minimum point - - - - Finds the minimum of the objective function without an initial perturbation, the default values used - by fminsearch() in Matlab are used instead - http://se.mathworks.com/help/matlab/math/optimizing-nonlinear-functions.html#bsgpq6p-11 - - The objective function, no gradient or hessian needed - The initial guess - The minimum point - - - - Finds the minimum of the objective function with an initial perturbation - - The objective function, no gradient or hessian needed - The initial guess - The initial perturbation - The minimum point - - - - Evaluate the objective function at each vertex to create a corresponding - list of error values for each vertex - - - - - - - - Check whether the points in the error profile have so little range that we - consider ourselves to have converged - - - - - - - - - Examine all error values to determine the ErrorProfile - - - - - - - Construct an initial simplex, given starting guesses for the constants, and - initial step sizes for each dimension - - - - - - - Test a scaling operation of the high point, and replace it if it is an improvement - - - - - - - - - - - Contract the simplex uniformly around the lowest point - - - - - - - - - Compute the centroid of all points except the worst - - - - - - - - The value of the constant - - - - - Returns the best fit parameters. - - - - - Returns the standard errors of the corresponding parameters - - - - - Returns the y-values of the fitted model that correspond to the independent values. - - - - - Returns the covariance matrix at minimizing point. - - - - - Returns the correlation matrix at minimizing point. - - - - - The stopping threshold for the function value or L2 norm of the residuals. - - - - - The stopping threshold for L2 norm of the change of the parameters. - - - - - The stopping threshold for infinity norm of the gradient. - - - - - The maximum number of iterations. - - - - - The lower bound of the parameters. - - - - - The upper bound of the parameters. - - - - - The scale factors for the parameters. - - - - - Objective function where neither Gradient nor Hessian is available. - - - - - Objective function where the Gradient is available. Greedy evaluation. - - - - - Objective function where the Gradient is available. Lazy evaluation. - - - - - Objective function where the Hessian is available. Greedy evaluation. - - - - - Objective function where the Hessian is available. Lazy evaluation. - - - - - Objective function where both Gradient and Hessian are available. Greedy evaluation. - - - - - Objective function where both Gradient and Hessian are available. Lazy evaluation. - - - - - Objective function where neither first nor second derivative is available. - - - - - Objective function where the first derivative is available. - - - - - Objective function where the first and second derivatives are available. - - - - - objective model with a user supplied jacobian for non-linear least squares regression. - - - - - Objective model for non-linear least squares regression. - - - - - Objective model with a user supplied jacobian for non-linear least squares regression. - - - - - Objective model for non-linear least squares regression. - - - - - Objective function with a user supplied jacobian for nonlinear least squares regression. - - - - - Objective function for nonlinear least squares regression. - The numerical jacobian with accuracy order is used. - - - - - Adapts an objective function with only value implemented - to provide a gradient as well. Gradient calculation is - done using the finite difference method, specifically - forward differences. - - For each gradient computed, the algorithm requires an - additional number of function evaluations equal to the - functions's number of input parameters. - - - - - Set or get the values of the independent variable. - - - - - Set or get the values of the observations. - - - - - Set or get the values of the weights for the observations. - - - - - Get whether parameters are fixed or free. - - - - - Get the number of observations. - - - - - Get the number of unknown parameters. - - - - - Get the degree of freedom - - - - - Get the number of calls to function. - - - - - Get the number of calls to jacobian. - - - - - Set or get the values of the parameters. - - - - - Get the y-values of the fitted model that correspond to the independent values. - - - - - Get the residual sum of squares. - - - - - Get the Gradient vector of x and p. - - - - - Get the Hessian matrix of x and p, J'WJ - - - - - Set observed data to fit. - - - - - Set parameters and bounds. - - The initial values of parameters. - The list to the parameters fix or free. - - - - Non-linear least square fitting by the trust region dogleg algorithm. - - - - - The trust region subproblem. - - - - - The stopping threshold for the trust region radius. - - - - - Non-linear least square fitting by the trust-region algorithm. - - The objective model, including function, jacobian, observations, and parameter bounds. - The subproblem - The initial guess values. - The stopping threshold for L2 norm of the residuals. - The stopping threshold for infinity norm of the gradient vector. - The stopping threshold for L2 norm of the change of parameters. - The stopping threshold for trust region radius - The max iterations. - - - - - Non-linear least square fitting by the trust region Newton-Conjugate-Gradient algorithm. - - - - - Class to represent a permutation for a subset of the natural numbers. - - - - - Entry _indices[i] represents the location to which i is permuted to. - - - - - Initializes a new instance of the Permutation class. - - An array which represents where each integer is permuted too: indices[i] represents that integer i - is permuted to location indices[i]. - - - - Gets the number of elements this permutation is over. - - - - - Computes where permutes too. - - The index to permute from. - The index which is permuted to. - - - - Computes the inverse of the permutation. - - The inverse of the permutation. - - - - Construct an array from a sequence of inversions. - - - From wikipedia: the permutation 12043 has the inversions (0,2), (1,2) and (3,4). This would be - encoded using the array [22244]. - - The set of inversions to construct the permutation from. - A permutation generated from a sequence of inversions. - - - - Construct a sequence of inversions from the permutation. - - - From wikipedia: the permutation 12043 has the inversions (0,2), (1,2) and (3,4). This would be - encoded using the array [22244]. - - A sequence of inversions. - - - - Checks whether the array represents a proper permutation. - - An array which represents where each integer is permuted too: indices[i] represents that integer i - is permuted to location indices[i]. - True if represents a proper permutation, false otherwise. - - - - A single-variable polynomial with real-valued coefficients and non-negative exponents. - - - - - The coefficients of the polynomial in a - - - - - Only needed for the ToString method - - - - - Degree of the polynomial, i.e. the largest monomial exponent. For example, the degree of y=x^2+x^5 is 5, for y=3 it is 0. - The null-polynomial returns degree -1 because the correct degree, negative infinity, cannot be represented by integers. - - - - - Create a zero-polynomial with a coefficient array of the given length. - An array of length N can support polynomials of a degree of at most N-1. - - Length of the coefficient array - - - - Create a zero-polynomial - - - - - Create a constant polynomial. - Example: 3.0 -> "p : x -> 3.0" - - The coefficient of the "x^0" monomial. - - - - Create a polynomial with the provided coefficients (in ascending order, where the index matches the exponent). - Example: {5, 0, 2} -> "p : x -> 5 + 0 x^1 + 2 x^2". - - Polynomial coefficients as array - - - - Create a polynomial with the provided coefficients (in ascending order, where the index matches the exponent). - Example: {5, 0, 2} -> "p : x -> 5 + 0 x^1 + 2 x^2". - - Polynomial coefficients as enumerable - - - - Least-Squares fitting the points (x,y) to a k-order polynomial y : x -> p0 + p1*x + p2*x^2 + ... + pk*x^k - - - - - Evaluate a polynomial at point x. - Coefficients are ordered ascending by power with power k at index k. - Example: coefficients [3,-1,2] represent y=2x^2-x+3. - - The location where to evaluate the polynomial at. - The coefficients of the polynomial, coefficient for power k at index k. - - is a null reference. - - - - - Evaluate a polynomial at point x. - Coefficients are ordered ascending by power with power k at index k. - Example: coefficients [3,-1,2] represent y=2x^2-x+3. - - The location where to evaluate the polynomial at. - The coefficients of the polynomial, coefficient for power k at index k. - - is a null reference. - - - - - Evaluate a polynomial at point x. - Coefficients are ordered ascending by power with power k at index k. - Example: coefficients [3,-1,2] represent y=2x^2-x+3. - - The location where to evaluate the polynomial at. - The coefficients of the polynomial, coefficient for power k at index k. - - is a null reference. - - - - - Evaluate a polynomial at point x. - - The location where to evaluate the polynomial at. - - - - Evaluate a polynomial at point x. - - The location where to evaluate the polynomial at. - - - - Evaluate a polynomial at points z. - - The locations where to evaluate the polynomial at. - - - - Evaluate a polynomial at points z. - - The locations where to evaluate the polynomial at. - - - - Calculates the complex roots of the Polynomial by eigenvalue decomposition - - a vector of complex numbers with the roots - - - - Get the eigenvalue matrix A of this polynomial such that eig(A) = roots of this polynomial. - - Eigenvalue matrix A - This matrix is similar to the companion matrix of this polynomial, in such a way, that it's transpose is the columnflip of the companion matrix - - - - Addition of two Polynomials (point-wise). - - Left Polynomial - Right Polynomial - Resulting Polynomial - - - - Addition of a polynomial and a scalar. - - - - - Subtraction of two Polynomials (point-wise). - - Left Polynomial - Right Polynomial - Resulting Polynomial - - - - Addition of a scalar from a polynomial. - - - - - Addition of a polynomial from a scalar. - - - - - Negation of a polynomial. - - - - - Multiplies a polynomial by a polynomial (convolution) - - Left polynomial - Right polynomial - Resulting Polynomial - - or is a null reference. - - - - - Scales a polynomial by a scalar - - Polynomial - Scalar value - Resulting Polynomial - - - - Scales a polynomial by division by a scalar - - Polynomial - Scalar value - Resulting Polynomial - - - - Euclidean long division of two polynomials, returning the quotient q and remainder r of the two polynomials a and b such that a = q*b + r - - Left polynomial - Right polynomial - A tuple holding quotient in first and remainder in second - - - - Point-wise division of two Polynomials - - Left Polynomial - Right Polynomial - Resulting Polynomial - - - - Point-wise multiplication of two Polynomials - - Left Polynomial - Right Polynomial - Resulting Polynomial - - - - Division of two polynomials returning the quotient-with-remainder of the two polynomials given - - Right polynomial - A tuple holding quotient in first and remainder in second - - - - Addition of two Polynomials (piecewise) - - Left polynomial - Right polynomial - Resulting Polynomial - - - - adds a scalar to a polynomial. - - Polynomial - Scalar value - Resulting Polynomial - - - - adds a scalar to a polynomial. - - Scalar value - Polynomial - Resulting Polynomial - - - - Subtraction of two polynomial. - - Left polynomial - Right polynomial - Resulting Polynomial - - - - Subtracts a scalar from a polynomial. - - Polynomial - Scalar value - Resulting Polynomial - - - - Subtracts a polynomial from a scalar. - - Scalar value - Polynomial - Resulting Polynomial - - - - Negates a polynomial. - - Polynomial - Resulting Polynomial - - - - Multiplies a polynomial by a polynomial (convolution). - - Left polynomial - Right polynomial - resulting Polynomial - - - - Multiplies a polynomial by a scalar. - - Polynomial - Scalar value - Resulting Polynomial - - - - Multiplies a polynomial by a scalar. - - Scalar value - Polynomial - Resulting Polynomial - - - - Divides a polynomial by scalar value. - - Polynomial - Scalar value - Resulting Polynomial - - - - Format the polynomial in ascending order, e.g. "4.3 + 2.0x^2 - x^3". - - - - - Format the polynomial in descending order, e.g. "x^3 + 2.0x^2 - 4.3". - - - - - Format the polynomial in ascending order, e.g. "4.3 + 2.0x^2 - x^3". - - - - - Format the polynomial in descending order, e.g. "x^3 + 2.0x^2 - 4.3". - - - - - Format the polynomial in ascending order, e.g. "4.3 + 2.0x^2 - x^3". - - - - - Format the polynomial in descending order, e.g. "x^3 + 2.0x^2 - 4.3". - - - - - Format the polynomial in ascending order, e.g. "4.3 + 2.0x^2 - x^3". - - - - - Format the polynomial in descending order, e.g. "x^3 + 2.0x^2 - 4.3". - - - - - Creates a new object that is a copy of the current instance. - - - A new object that is a copy of this instance. - - - - - Utilities for working with floating point numbers. - - - - Useful links: - - - http://docs.sun.com/source/806-3568/ncg_goldberg.html#689 - What every computer scientist should know about floating-point arithmetic - - - http://en.wikipedia.org/wiki/Machine_epsilon - Gives the definition of machine epsilon - - - - - - - - Compares two doubles and determines which double is bigger. - a < b -> -1; a ~= b (almost equal according to parameter) -> 0; a > b -> +1. - - The first value. - The second value. - The absolute accuracy required for being almost equal. - - - - Compares two doubles and determines which double is bigger. - a < b -> -1; a ~= b (almost equal according to parameter) -> 0; a > b -> +1. - - The first value. - The second value. - The number of decimal places on which the values must be compared. Must be 1 or larger. - - - - Compares two doubles and determines which double is bigger. - a < b -> -1; a ~= b (almost equal according to parameter) -> 0; a > b -> +1. - - The first value. - The second value. - The relative accuracy required for being almost equal. - - - - Compares two doubles and determines which double is bigger. - a < b -> -1; a ~= b (almost equal according to parameter) -> 0; a > b -> +1. - - The first value. - The second value. - The number of decimal places on which the values must be compared. Must be 1 or larger. - - - - Compares two doubles and determines which double is bigger. - a < b -> -1; a ~= b (almost equal according to parameter) -> 0; a > b -> +1. - - The first value. - The second value. - The maximum error in terms of Units in Last Place (ulps), i.e. the maximum number of decimals that may be different. Must be 1 or larger. - - - - Compares two doubles and determines if the first value is larger than the second - value to within the specified number of decimal places or not. - - - - The values are equal if the difference between the two numbers is smaller than 10^(-numberOfDecimalPlaces). We divide by - two so that we have half the range on each side of the numbers, e.g. if == 2, then 0.01 will equal between - 0.005 and 0.015, but not 0.02 and not 0.00 - - - The first value. - The second value. - The number of decimal places. - true if the first value is larger than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is larger than the second - value to within the specified number of decimal places or not. - - - - The values are equal if the difference between the two numbers is smaller than 10^(-numberOfDecimalPlaces). We divide by - two so that we have half the range on each side of the numbers, e.g. if == 2, then 0.01 will equal between - 0.005 and 0.015, but not 0.02 and not 0.00 - - - The first value. - The second value. - The number of decimal places. - true if the first value is larger than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is larger than the second - value to within the specified number of decimal places or not. - - The first value. - The second value. - The absolute accuracy required for being almost equal. - true if the first value is larger than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is larger than the second - value to within the specified number of decimal places or not. - - The first value. - The second value. - The absolute accuracy required for being almost equal. - true if the first value is larger than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is larger than the second - value to within the specified number of decimal places or not. - - - - The values are equal if the difference between the two numbers is smaller than 10^(-numberOfDecimalPlaces). We divide by - two so that we have half the range on each side of the numbers, e.g. if == 2, then 0.01 will equal between - 0.005 and 0.015, but not 0.02 and not 0.00 - - - The first value. - The second value. - The number of decimal places. - true if the first value is larger than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is larger than the second - value to within the specified number of decimal places or not. - - - - The values are equal if the difference between the two numbers is smaller than 10^(-numberOfDecimalPlaces). We divide by - two so that we have half the range on each side of the numbers, e.g. if == 2, then 0.01 will equal between - 0.005 and 0.015, but not 0.02 and not 0.00 - - - The first value. - The second value. - The number of decimal places. - true if the first value is larger than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is larger than the second - value to within the specified number of decimal places or not. - - The first value. - The second value. - The relative accuracy required for being almost equal. - true if the first value is larger than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is larger than the second - value to within the specified number of decimal places or not. - - The first value. - The second value. - The relative accuracy required for being almost equal. - true if the first value is larger than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is larger than the second - value to within the tolerance or not. Equality comparison is based on the binary representation. - - The first value. - The second value. - The maximum number of floating point values for which the two values are considered equal. Must be 1 or larger. - true if the first value is larger than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is larger than the second - value to within the tolerance or not. Equality comparison is based on the binary representation. - - The first value. - The second value. - The maximum number of floating point values for which the two values are considered equal. Must be 1 or larger. - true if the first value is larger than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is smaller than the second - value to within the specified number of decimal places or not. - - - - The values are equal if the difference between the two numbers is smaller than 10^(-numberOfDecimalPlaces). We divide by - two so that we have half the range on each side of thg. if == 2, then 0.01 will equal between - 0.005 and 0.015, but not 0.02 and not 0.00 - - - The first value. - The second value. - The number of decimal places. - true if the first value is smaller than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is smaller than the second - value to within the specified number of decimal places or not. - - - - The values are equal if the difference between the two numbers is smaller than 10^(-numberOfDecimalPlaces). We divide by - two so that we have half the range on each side of thg. if == 2, then 0.01 will equal between - 0.005 and 0.015, but not 0.02 and not 0.00 - - - The first value. - The second value. - The number of decimal places. - true if the first value is smaller than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is smaller than the second - value to within the specified number of decimal places or not. - - The first value. - The second value. - The absolute accuracy required for being almost equal. - true if the first value is smaller than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is smaller than the second - value to within the specified number of decimal places or not. - - The first value. - The second value. - The absolute accuracy required for being almost equal. - true if the first value is smaller than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is smaller than the second - value to within the specified number of decimal places or not. - - The first value. - The second value. - The number of decimal places. - true if the first value is smaller than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is smaller than the second - value to within the specified number of decimal places or not. - - The first value. - The second value. - The number of decimal places. - true if the first value is smaller than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is smaller than the second - value to within the specified number of decimal places or not. - - The first value. - The second value. - The relative accuracy required for being almost equal. - true if the first value is smaller than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is smaller than the second - value to within the specified number of decimal places or not. - - The first value. - The second value. - The relative accuracy required for being almost equal. - true if the first value is smaller than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is smaller than the second - value to within the tolerance or not. Equality comparison is based on the binary representation. - - The first value. - The second value. - The maximum number of floating point values for which the two values are considered equal. Must be 1 or larger. - true if the first value is smaller than the second value; otherwise false. - - - - Compares two doubles and determines if the first value is smaller than the second - value to within the tolerance or not. Equality comparison is based on the binary representation. - - The first value. - The second value. - The maximum number of floating point values for which the two values are considered equal. Must be 1 or larger. - true if the first value is smaller than the second value; otherwise false. - - - - Checks if a given double values is finite, i.e. neither NaN nor inifnity - - The value to be checked fo finitenes. - - - - The number of binary digits used to represent the binary number for a double precision floating - point value. i.e. there are this many digits used to represent the - actual number, where in a number as: 0.134556 * 10^5 the digits are 0.134556 and the exponent is 5. - - - - - The number of binary digits used to represent the binary number for a single precision floating - point value. i.e. there are this many digits used to represent the - actual number, where in a number as: 0.134556 * 10^5 the digits are 0.134556 and the exponent is 5. - - - - - Standard epsilon, the maximum relative precision of IEEE 754 double-precision floating numbers (64 bit). - According to the definition of Prof. Demmel and used in LAPACK and Scilab. - - - - - Standard epsilon, the maximum relative precision of IEEE 754 double-precision floating numbers (64 bit). - According to the definition of Prof. Higham and used in the ISO C standard and MATLAB. - - - - - Standard epsilon, the maximum relative precision of IEEE 754 single-precision floating numbers (32 bit). - According to the definition of Prof. Demmel and used in LAPACK and Scilab. - - - - - Standard epsilon, the maximum relative precision of IEEE 754 single-precision floating numbers (32 bit). - According to the definition of Prof. Higham and used in the ISO C standard and MATLAB. - - - - - Actual double precision machine epsilon, the smallest number that can be subtracted from 1, yielding a results different than 1. - This is also known as unit roundoff error. According to the definition of Prof. Demmel. - On a standard machine this is equivalent to `DoublePrecision`. - - - - - Actual double precision machine epsilon, the smallest number that can be added to 1, yielding a results different than 1. - This is also known as unit roundoff error. According to the definition of Prof. Higham. - On a standard machine this is equivalent to `PositiveDoublePrecision`. - - - - - The number of significant decimal places of double-precision floating numbers (64 bit). - - - - - The number of significant decimal places of single-precision floating numbers (32 bit). - - - - - Value representing 10 * 2^(-53) = 1.11022302462516E-15 - - - - - Value representing 10 * 2^(-24) = 5.96046447753906E-07 - - - - - Returns the magnitude of the number. - - The value. - The magnitude of the number. - - - - Returns the magnitude of the number. - - The value. - The magnitude of the number. - - - - Returns the number divided by it's magnitude, effectively returning a number between -10 and 10. - - The value. - The value of the number. - - - - Returns a 'directional' long value. This is a long value which acts the same as a double, - e.g. a negative double value will return a negative double value starting at 0 and going - more negative as the double value gets more negative. - - The input double value. - A long value which is roughly the equivalent of the double value. - - - - Returns a 'directional' int value. This is a int value which acts the same as a float, - e.g. a negative float value will return a negative int value starting at 0 and going - more negative as the float value gets more negative. - - The input float value. - An int value which is roughly the equivalent of the double value. - - - - Increments a floating point number to the next bigger number representable by the data type. - - The value which needs to be incremented. - How many times the number should be incremented. - - The incrementation step length depends on the provided value. - Increment(double.MaxValue) will return positive infinity. - - The next larger floating point value. - - - - Decrements a floating point number to the next smaller number representable by the data type. - - The value which should be decremented. - How many times the number should be decremented. - - The decrementation step length depends on the provided value. - Decrement(double.MinValue) will return negative infinity. - - The next smaller floating point value. - - - - Forces small numbers near zero to zero, according to the specified absolute accuracy. - - The real number to coerce to zero, if it is almost zero. - The maximum count of numbers between the zero and the number . - - Zero if || is fewer than numbers from zero, otherwise. - - - - - Forces small numbers near zero to zero, according to the specified absolute accuracy. - - The real number to coerce to zero, if it is almost zero. - The maximum count of numbers between the zero and the number . - - Zero if || is fewer than numbers from zero, otherwise. - - - Thrown if is smaller than zero. - - - - - Forces small numbers near zero to zero, according to the specified absolute accuracy. - - The real number to coerce to zero, if it is almost zero. - The absolute threshold for to consider it as zero. - Zero if || is smaller than , otherwise. - - Thrown if is smaller than zero. - - - - - Forces small numbers near zero to zero. - - The real number to coerce to zero, if it is almost zero. - Zero if || is smaller than 2^(-53) = 1.11e-16, otherwise. - - - - Determines the range of floating point numbers that will match the specified value with the given tolerance. - - The value. - The ulps difference. - - Thrown if is smaller than zero. - - Tuple of the bottom and top range ends. - - - - Returns the floating point number that will match the value with the tolerance on the maximum size (i.e. the result is - always bigger than the value) - - The value. - The ulps difference. - The maximum floating point number which is larger than the given . - - - - Returns the floating point number that will match the value with the tolerance on the minimum size (i.e. the result is - always smaller than the value) - - The value. - The ulps difference. - The minimum floating point number which is smaller than the given . - - - - Determines the range of ulps that will match the specified value with the given tolerance. - - The value. - The relative difference. - - Thrown if is smaller than zero. - - - Thrown if is double.PositiveInfinity or double.NegativeInfinity. - - - Thrown if is double.NaN. - - - Tuple with the number of ULPS between the value and the value - relativeDifference as first, - and the number of ULPS between the value and the value + relativeDifference as second value. - - - - - Evaluates the count of numbers between two double numbers - - The first parameter. - The second parameter. - The second number is included in the number, thus two equal numbers evaluate to zero and two neighbor numbers evaluate to one. Therefore, what is returned is actually the count of numbers between plus 1. - The number of floating point values between and . - - Thrown if is double.PositiveInfinity or double.NegativeInfinity. - - - Thrown if is double.NaN. - - - Thrown if is double.PositiveInfinity or double.NegativeInfinity. - - - Thrown if is double.NaN. - - - - - Evaluates the minimum distance to the next distinguishable number near the argument value. - - The value used to determine the minimum distance. - - Relative Epsilon (positive double or NaN). - - Evaluates the negative epsilon. The more common positive epsilon is equal to two times this negative epsilon. - - - - - Evaluates the minimum distance to the next distinguishable number near the argument value. - - The value used to determine the minimum distance. - - Relative Epsilon (positive float or NaN). - - Evaluates the negative epsilon. The more common positive epsilon is equal to two times this negative epsilon. - - - - - Evaluates the minimum distance to the next distinguishable number near the argument value. - - The value used to determine the minimum distance. - Relative Epsilon (positive double or NaN) - Evaluates the positive epsilon. See also - - - - - Evaluates the minimum distance to the next distinguishable number near the argument value. - - The value used to determine the minimum distance. - Relative Epsilon (positive float or NaN) - Evaluates the positive epsilon. See also - - - - - Calculates the actual (negative) double precision machine epsilon - the smallest number that can be subtracted from 1, yielding a results different than 1. - This is also known as unit roundoff error. According to the definition of Prof. Demmel. - - Positive Machine epsilon - - - - Calculates the actual positive double precision machine epsilon - the smallest number that can be added to 1, yielding a results different than 1. - This is also known as unit roundoff error. According to the definition of Prof. Higham. - - Machine epsilon - - - - Round to a multiple of the provided positive basis. - - Number to be rounded. - The basis to whose multiples to round to. Must be positive. - - - - Round to a multiple of the provided positive basis. - - Number to be rounded. - The basis to whose multiples to round to. Must be positive. - - - - Round to a multiple of the provided positive basis. - - Number to be rounded. - The basis to whose multiples to round to. Must be positive. - - - - Round to a multiple of the provided positive basis. - - Number to be rounded. - The basis to whose powers to round to. Must be positive. - - - - Round to a multiple of the provided positive basis. - - Number to be rounded. - The basis to whose powers to round to. Must be positive. - - - - Round to the number closest to 10^(-decimals). Negative decimals to round within the integer part. - - Number to be rounded - If positive the number of decimals to round to. If negative the number of digits within the integer part to round, e.g. -3 will wound to the closes 1000. - To round 123456789 to hundreds Round(123456789, -2) = 123456800 - Rounded number - - - - Round to the number closest to 10^(-decimals). Negative decimals to round within the integer part. - - Number to be rounded - If positive the number of decimals to round to. If negative the number of digits within the integer part to round, e.g. -3 will wound to the closes 1000. - To round 123456789 to hundreds Round(123456789, -2) = 123456800 - Rounded number - - - - Round to the number closest to 10^(-decimals). Negative decimals to round within the integer part. - - Number to be rounded - If positive the number of decimals to round to. If negative the number of digits within the integer part to round, e.g. -3 will wound to the closes 1000. - To round 123456789 to hundreds Round(123456789, -2) = 123456800 - Rounded number - - - - Round to the number closest to 10^(-decimals). Negative decimals to round within the integer part. - - Number to be rounded - If positive the number of decimals to round to. If negative the number of digits within the integer part to round, e.g. -3 will wound to the closes 1000. - To round 123456789 to hundreds Round(123456789, -2) = 123456800 - Rounded number - - - - Round to the number closest to 10^(-decimals). Negative decimals to round within the integer part. - - Number to be rounded - If positive the number of decimals to round to. If negative the number of digits within the integer part to round, e.g. -3 will wound to the closes 1000. - To round 123456789 to hundreds Round(123456789, -2) = 123456800 - Rounded number - - - - Round to the number closest to 10^(-decimals). Negative decimals to round within the integer part. - - Number to be rounded - If positive the number of decimals to round to. If negative the number of digits within the integer part to round, e.g. -3 will wound to the closes 1000. - To round 123456789 to hundreds Round(123456789, -2) = 123456800 - Rounded number - - - - Round to the number closest to 10^(-decimals). Negative decimals to round within the integer part. - - Number to be rounded - If positive the number of decimals to round to. If negative the number of digits within the integer part to round, e.g. -3 will wound to the closes 1000. - To round 123456789 to hundreds Round(123456789, -2) = 123456800 - Rounded number - - - - Round to the number closest to 10^(-decimals). Negative decimals to round within the integer part. - - Number to be rounded - If positive the number of decimals to round to. If negative the number of digits within the integer part to round, e.g. -3 will wound to the closes 1000. - To round 123456789 to hundreds Round(123456789, -2) = 123456800 - Rounded number - - - - Round to the number closest to 10^(-decimals). Negative decimals to round within the integer part. - - Number to be rounded - If positive the number of decimals to round to. If negative the number of digits within the integer part to round, e.g. -3 will wound to the closes 1000. - To round 123456789 to hundreds Round(123456789, -2) = 123456800 - Rounded number - - - - Round to the number closest to 10^(-decimals). Negative decimals to round within the integer part. - - Number to be rounded - If positive the number of decimals to round to. If negative the number of digits within the integer part to round, e.g. -3 will wound to the closes 1000. - To round 123456789 to hundreds Round(123456789, -2) = 123456800 - Rounded number - - - - Compares two doubles and determines if they are equal - within the specified maximum absolute error. - - The norm of the first value (can be negative). - The norm of the second value (can be negative). - The norm of the difference of the two values (can be negative). - The absolute accuracy required for being almost equal. - True if both doubles are almost equal up to the specified maximum absolute error, false otherwise. - - - - Compares two doubles and determines if they are equal - within the specified maximum absolute error. - - The first value. - The second value. - The absolute accuracy required for being almost equal. - True if both doubles are almost equal up to the specified maximum absolute error, false otherwise. - - - - Compares two doubles and determines if they are equal - within the specified maximum error. - - The norm of the first value (can be negative). - The norm of the second value (can be negative). - The norm of the difference of the two values (can be negative). - The accuracy required for being almost equal. - True if both doubles are almost equal up to the specified maximum error, false otherwise. - - - - Compares two doubles and determines if they are equal - within the specified maximum error. - - The first value. - The second value. - The accuracy required for being almost equal. - True if both doubles are almost equal up to the specified maximum error, false otherwise. - - - - Compares two doubles and determines if they are equal within - the specified maximum error. - - The first value. - The second value. - The accuracy required for being almost equal. - - - - Compares two complex and determines if they are equal within - the specified maximum error. - - The first value. - The second value. - The accuracy required for being almost equal. - - - - Compares two complex and determines if they are equal within - the specified maximum error. - - The first value. - The second value. - The accuracy required for being almost equal. - - - - Compares two complex and determines if they are equal within - the specified maximum error. - - The first value. - The second value. - The accuracy required for being almost equal. - - - - Compares two doubles and determines if they are equal within - the specified maximum error. - - The first value. - The second value. - The accuracy required for being almost equal. - - - - Compares two complex and determines if they are equal within - the specified maximum error. - - The first value. - The second value. - The accuracy required for being almost equal. - - - - Compares two complex and determines if they are equal within - the specified maximum error. - - The first value. - The second value. - The accuracy required for being almost equal. - - - - Compares two complex and determines if they are equal within - the specified maximum error. - - The first value. - The second value. - The accuracy required for being almost equal. - - - - Checks whether two real numbers are almost equal. - - The first number - The second number - true if the two values differ by no more than 10 * 2^(-52); false otherwise. - - - - Checks whether two real numbers are almost equal. - - The first number - The second number - true if the two values differ by no more than 10 * 2^(-52); false otherwise. - - - - Checks whether two Complex numbers are almost equal. - - The first number - The second number - true if the two values differ by no more than 10 * 2^(-52); false otherwise. - - - - Checks whether two Complex numbers are almost equal. - - The first number - The second number - true if the two values differ by no more than 10 * 2^(-52); false otherwise. - - - - Checks whether two real numbers are almost equal. - - The first number - The second number - true if the two values differ by no more than 10 * 2^(-52); false otherwise. - - - - Checks whether two real numbers are almost equal. - - The first number - The second number - true if the two values differ by no more than 10 * 2^(-52); false otherwise. - - - - Checks whether two Complex numbers are almost equal. - - The first number - The second number - true if the two values differ by no more than 10 * 2^(-52); false otherwise. - - - - Checks whether two Complex numbers are almost equal. - - The first number - The second number - true if the two values differ by no more than 10 * 2^(-52); false otherwise. - - - - Compares two doubles and determines if they are equal to within the specified number of decimal places or not, using the - number of decimal places as an absolute measure. - - - - The values are equal if the difference between the two numbers is smaller than 0.5e-decimalPlaces. We divide by - two so that we have half the range on each side of the numbers, e.g. if == 2, then 0.01 will equal between - 0.005 and 0.015, but not 0.02 and not 0.00 - - - The norm of the first value (can be negative). - The norm of the second value (can be negative). - The norm of the difference of the two values (can be negative). - The number of decimal places. - - - - Compares two doubles and determines if they are equal to within the specified number of decimal places or not, using the - number of decimal places as an absolute measure. - - - - The values are equal if the difference between the two numbers is smaller than 0.5e-decimalPlaces. We divide by - two so that we have half the range on each side of the numbers, e.g. if == 2, then 0.01 will equal between - 0.005 and 0.015, but not 0.02 and not 0.00 - - - The first value. - The second value. - The number of decimal places. - - - - Compares two doubles and determines if they are equal to within the specified number of decimal places or not. If the numbers - are very close to zero an absolute difference is compared, otherwise the relative difference is compared. - - - - The values are equal if the difference between the two numbers is smaller than 10^(-numberOfDecimalPlaces). We divide by - two so that we have half the range on each side of the numbers, e.g. if == 2, then 0.01 will equal between - 0.005 and 0.015, but not 0.02 and not 0.00 - - - The norm of the first value (can be negative). - The norm of the second value (can be negative). - The norm of the difference of the two values (can be negative). - The number of decimal places. - Thrown if is smaller than zero. - - - - Compares two doubles and determines if they are equal to within the specified number of decimal places or not. If the numbers - are very close to zero an absolute difference is compared, otherwise the relative difference is compared. - - - - The values are equal if the difference between the two numbers is smaller than 10^(-numberOfDecimalPlaces). We divide by - two so that we have half the range on each side of the numbers, e.g. if == 2, then 0.01 will equal between - 0.005 and 0.015, but not 0.02 and not 0.00 - - - The first value. - The second value. - The number of decimal places. - - - - Compares two doubles and determines if they are equal to within the specified number of decimal places or not, using the - number of decimal places as an absolute measure. - - The first value. - The second value. - The number of decimal places. - - - - Compares two doubles and determines if they are equal to within the specified number of decimal places or not, using the - number of decimal places as an absolute measure. - - The first value. - The second value. - The number of decimal places. - - - - Compares two doubles and determines if they are equal to within the specified number of decimal places or not, using the - number of decimal places as an absolute measure. - - The first value. - The second value. - The number of decimal places. - - - - Compares two doubles and determines if they are equal to within the specified number of decimal places or not, using the - number of decimal places as an absolute measure. - - The first value. - The second value. - The number of decimal places. - - - - Compares two doubles and determines if they are equal to within the specified number of decimal places or not. If the numbers - are very close to zero an absolute difference is compared, otherwise the relative difference is compared. - - The first value. - The second value. - The number of decimal places. - - - - Compares two doubles and determines if they are equal to within the specified number of decimal places or not. If the numbers - are very close to zero an absolute difference is compared, otherwise the relative difference is compared. - - The first value. - The second value. - The number of decimal places. - - - - Compares two doubles and determines if they are equal to within the specified number of decimal places or not. If the numbers - are very close to zero an absolute difference is compared, otherwise the relative difference is compared. - - The first value. - The second value. - The number of decimal places. - - - - Compares two doubles and determines if they are equal to within the specified number of decimal places or not. If the numbers - are very close to zero an absolute difference is compared, otherwise the relative difference is compared. - - The first value. - The second value. - The number of decimal places. - - - - Compares two doubles and determines if they are equal to within the tolerance or not. Equality comparison is based on the binary representation. - - - - Determines the 'number' of floating point numbers between two values (i.e. the number of discrete steps - between the two numbers) and then checks if that is within the specified tolerance. So if a tolerance - of 1 is passed then the result will be true only if the two numbers have the same binary representation - OR if they are two adjacent numbers that only differ by one step. - - - The comparison method used is explained in http://www.cygnus-software.com/papers/comparingfloats/comparingfloats.htm . The article - at http://www.extremeoptimization.com/resources/Articles/FPDotNetConceptsAndFormats.aspx explains how to transform the C code to - .NET enabled code without using pointers and unsafe code. - - - The first value. - The second value. - The maximum number of floating point values between the two values. Must be 1 or larger. - Thrown if is smaller than one. - - - - Compares two floats and determines if they are equal to within the tolerance or not. Equality comparison is based on the binary representation. - - The first value. - The second value. - The maximum number of floating point values between the two values. Must be 1 or larger. - Thrown if is smaller than one. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The accuracy required for being almost equal. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The accuracy required for being almost equal. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The accuracy required for being almost equal. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The accuracy required for being almost equal. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The accuracy required for being almost equal. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The accuracy required for being almost equal. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The accuracy required for being almost equal. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The accuracy required for being almost equal. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The number of decimal places. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The number of decimal places. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The number of decimal places. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The number of decimal places. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The number of decimal places. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The number of decimal places. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The number of decimal places. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The number of decimal places. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The accuracy required for being almost equal. - - - - Compares two lists of doubles and determines if they are equal within the - specified maximum error. - - The first value list. - The second value list. - The accuracy required for being almost equal. - - - - Compares two vectors and determines if they are equal within the specified maximum error. - - The first value. - The second value. - The accuracy required for being almost equal. - - - - Compares two vectors and determines if they are equal within the specified maximum error. - - The first value. - The second value. - The accuracy required for being almost equal. - - - - Compares two vectors and determines if they are equal to within the specified number - of decimal places or not, using the number of decimal places as an absolute measure. - - The first value. - The second value. - The number of decimal places. - - - - Compares two vectors and determines if they are equal to within the specified number of decimal places or not. - If the numbers are very close to zero an absolute difference is compared, otherwise the relative difference is compared. - - The first value. - The second value. - The number of decimal places. - - - - Compares two matrices and determines if they are equal within the specified maximum error. - - The first value. - The second value. - The accuracy required for being almost equal. - - - - Compares two matrices and determines if they are equal within the specified maximum error. - - The first value. - The second value. - The accuracy required for being almost equal. - - - - Compares two matrices and determines if they are equal to within the specified number - of decimal places or not, using the number of decimal places as an absolute measure. - - The first value. - The second value. - The number of decimal places. - - - - Compares two matrices and determines if they are equal to within the specified number of decimal places or not. - If the numbers are very close to zero an absolute difference is compared, otherwise the relative difference is compared. - - The first value. - The second value. - The number of decimal places. - - - - Support Interface for Precision Operations (like AlmostEquals). - - Type of the implementing class. - - - - Returns a Norm of a value of this type, which is appropriate for measuring how - close this value is to zero. - - A norm of this value. - - - - Returns a Norm of the difference of two values of this type, which is - appropriate for measuring how close together these two values are. - - The value to compare with. - A norm of the difference between this and the other value. - - - - Optional path to try to load native provider binaries from, - if the provider specific hint path is not set. - If neither is set, Numerics falls back to the provider specific - environment variables, or the default probing paths. - - - - - Gets or sets the Fourier transform provider. Consider to use UseNativeMKL or UseManaged instead. - - The linear algebra provider. - - - - Try to use a native provider, if available. - - - - - Use the best provider available. - - - - - Use a specific provider if configured, e.g. using the - "MathNetNumericsFFTProvider" environment variable, - or fall back to the best provider. - - - - - Try to find out whether the provider is available, at least in principle. - Verification may still fail if available, but it will certainly fail if unavailable. - - - - - Initialize and verify that the provided is indeed available. If not, fall back to alternatives like the managed provider - - - - - Frees memory buffers, caches and handles allocated in or to the provider. - Does not unload the provider itself, it is still usable afterwards. - - - - - Sequences with length greater than Math.Sqrt(Int32.MaxValue) + 1 - will cause k*k in the Bluestein sequence to overflow (GH-286). - - - - - Generate the bluestein sequence for the provided problem size. - - Number of samples. - Bluestein sequence exp(I*Pi*k^2/N) - - - - Generate the bluestein sequence for the provided problem size. - - Number of samples. - Bluestein sequence exp(I*Pi*k^2/N) - - - - Convolution with the bluestein sequence (Parallel Version). - - Sample Vector. - - - - Convolution with the bluestein sequence (Parallel Version). - - Sample Vector. - - - - Swap the real and imaginary parts of each sample. - - Sample Vector. - - - - Swap the real and imaginary parts of each sample. - - Sample Vector. - - - - Bluestein generic FFT for arbitrary sized sample vectors. - - - - - Bluestein generic FFT for arbitrary sized sample vectors. - - - - - Bluestein generic FFT for arbitrary sized sample vectors. - - - - - Bluestein generic FFT for arbitrary sized sample vectors. - - - - - Try to find out whether the provider is available, at least in principle. - Verification may still fail if available, but it will certainly fail if unavailable. - - - - - Initialize and verify that the provided is indeed available. If not, fall back to alternatives like the managed provider - - - - - Frees memory buffers, caches and handles allocated in or to the provider. - Does not unload the provider itself, it is still usable afterwards. - - - - - Radix-2 Reorder Helper Method - - Sample type - Sample vector - - - - Radix-2 Step Helper Method - - Sample vector. - Fourier series exponent sign. - Level Group Size. - Index inside of the level. - - - - Radix-2 Step Helper Method - - Sample vector. - Fourier series exponent sign. - Level Group Size. - Index inside of the level. - - - - Radix-2 generic FFT for power-of-two sized sample vectors. - - - - - Radix-2 generic FFT for power-of-two sized sample vectors. - - - - - Radix-2 generic FFT for power-of-two sized sample vectors. - - - - - Radix-2 generic FFT for power-of-two sized sample vectors. - - - - - Radix-2 generic FFT for power-of-two sample vectors (Parallel Version). - - - - - Radix-2 generic FFT for power-of-two sample vectors (Parallel Version). - - - - - Radix-2 generic FFT for power-of-two sample vectors (Parallel Version). - - - - - Radix-2 generic FFT for power-of-two sample vectors (Parallel Version). - - - - - Fully rescale the FFT result. - - Sample Vector. - - - - Fully rescale the FFT result. - - Sample Vector. - - - - Half rescale the FFT result (e.g. for symmetric transforms). - - Sample Vector. - - - - Fully rescale the FFT result (e.g. for symmetric transforms). - - Sample Vector. - - - - How to transpose a matrix. - - - - - Don't transpose a matrix. - - - - - Transpose a matrix. - - - - - Conjugate transpose a complex matrix. - - If a conjugate transpose is used with a real matrix, then the matrix is just transposed. - - - - Types of matrix norms. - - - - - The 1-norm. - - - - - The Frobenius norm. - - - - - The infinity norm. - - - - - The largest absolute value norm. - - - - - Interface to linear algebra algorithms that work off 1-D arrays. - - - - - Try to find out whether the provider is available, at least in principle. - Verification may still fail if available, but it will certainly fail if unavailable. - - - - - Initialize and verify that the provided is indeed available. If not, fall back to alternatives like the managed provider - - - - - Frees memory buffers, caches and handles allocated in or to the provider. - Does not unload the provider itself, it is still usable afterwards. - - - - - Interface to linear algebra algorithms that work off 1-D arrays. - - Supported data types are Double, Single, Complex, and Complex32. - - - - Adds a scaled vector to another: result = y + alpha*x. - - The vector to update. - The value to scale by. - The vector to add to . - The result of the addition. - This is similar to the AXPY BLAS routine. - - - - Scales an array. Can be used to scale a vector and a matrix. - - The scalar. - The values to scale. - This result of the scaling. - This is similar to the SCAL BLAS routine. - - - - Conjugates an array. Can be used to conjugate a vector and a matrix. - - The values to conjugate. - This result of the conjugation. - - - - Computes the dot product of x and y. - - The vector x. - The vector y. - The dot product of x and y. - This is equivalent to the DOT BLAS routine. - - - - Does a point wise add of two arrays z = x + y. This can be used - to add vectors or matrices. - - The array x. - The array y. - The result of the addition. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise subtraction of two arrays z = x - y. This can be used - to subtract vectors or matrices. - - The array x. - The array y. - The result of the subtraction. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise multiplication of two arrays z = x * y. This can be used - to multiply elements of vectors or matrices. - - The array x. - The array y. - The result of the point wise multiplication. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise division of two arrays z = x / y. This can be used - to divide elements of vectors or matrices. - - The array x. - The array y. - The result of the point wise division. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise power of two arrays z = x ^ y. This can be used - to raise elements of vectors or matrices to the powers of another vector or matrix. - - The array x. - The array y. - The result of the point wise power. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Computes the requested of the matrix. - - The type of norm to compute. - The number of rows. - The number of columns. - The matrix to compute the norm from. - - The requested of the matrix. - - - - - Multiples two matrices. result = x * y - - The x matrix. - The number of rows in the x matrix. - The number of columns in the x matrix. - The y matrix. - The number of rows in the y matrix. - The number of columns in the y matrix. - Where to store the result of the multiplication. - This is a simplified version of the BLAS GEMM routine with alpha - set to 1.0 and beta set to 0.0, and x and y are not transposed. - - - - Multiplies two matrices and updates another with the result. c = alpha*op(a)*op(b) + beta*c - - How to transpose the matrix. - How to transpose the matrix. - The value to scale matrix. - The a matrix. - The number of rows in the matrix. - The number of columns in the matrix. - The b matrix - The number of rows in the matrix. - The number of columns in the matrix. - The value to scale the matrix. - The c matrix. - - - - Computes the LUP factorization of A. P*A = L*U. - - An by matrix. The matrix is overwritten with the - the LU factorization on exit. The lower triangular factor L is stored in under the diagonal of (the diagonal is always 1.0 - for the L factor). The upper triangular factor U is stored on and above the diagonal of . - The order of the square matrix . - On exit, it contains the pivot indices. The size of the array must be . - This is equivalent to the GETRF LAPACK routine. - - - - Computes the inverse of matrix using LU factorization. - - The N by N matrix to invert. Contains the inverse On exit. - The order of the square matrix . - This is equivalent to the GETRF and GETRI LAPACK routines. - - - - Computes the inverse of a previously factored matrix. - - The LU factored N by N matrix. Contains the inverse On exit. - The order of the square matrix . - The pivot indices of . - This is equivalent to the GETRI LAPACK routine. - - - - Solves A*X=B for X using LU factorization. - - The number of columns of B. - The square matrix A. - The order of the square matrix . - On entry the B matrix; on exit the X matrix. - This is equivalent to the GETRF and GETRS LAPACK routines. - - - - Solves A*X=B for X using a previously factored A matrix. - - The number of columns of B. - The factored A matrix. - The order of the square matrix . - The pivot indices of . - On entry the B matrix; on exit the X matrix. - This is equivalent to the GETRS LAPACK routine. - - - - Computes the Cholesky factorization of A. - - On entry, a square, positive definite matrix. On exit, the matrix is overwritten with the - the Cholesky factorization. - The number of rows or columns in the matrix. - This is equivalent to the POTRF LAPACK routine. - - - - Solves A*X=B for X using Cholesky factorization. - - The square, positive definite matrix A. - The number of rows and columns in A. - On entry the B matrix; on exit the X matrix. - The number of columns in the B matrix. - This is equivalent to the POTRF add POTRS LAPACK routines. - - - - Solves A*X=B for X using a previously factored A matrix. - - The square, positive definite matrix A. - The number of rows and columns in A. - On entry the B matrix; on exit the X matrix. - The number of columns in the B matrix. - This is equivalent to the POTRS LAPACK routine. - - - - Computes the full QR factorization of A. - - On entry, it is the M by N A matrix to factor. On exit, - it is overwritten with the R matrix of the QR factorization. - The number of rows in the A matrix. - The number of columns in the A matrix. - On exit, A M by M matrix that holds the Q matrix of the - QR factorization. - A min(m,n) vector. On exit, contains additional information - to be used by the QR solve routine. - This is similar to the GEQRF and ORGQR LAPACK routines. - - - - Computes the thin QR factorization of A where M > N. - - On entry, it is the M by N A matrix to factor. On exit, - it is overwritten with the Q matrix of the QR factorization. - The number of rows in the A matrix. - The number of columns in the A matrix. - On exit, A N by N matrix that holds the R matrix of the - QR factorization. - A min(m,n) vector. On exit, contains additional information - to be used by the QR solve routine. - This is similar to the GEQRF and ORGQR LAPACK routines. - - - - Solves A*X=B for X using QR factorization of A. - - The A matrix. - The number of rows in the A matrix. - The number of columns in the A matrix. - The B matrix. - The number of columns of B. - On exit, the solution matrix. - The type of QR factorization to perform. - Rows must be greater or equal to columns. - - - - Solves A*X=B for X using a previously QR factored matrix. - - The Q matrix obtained by QR factor. This is only used for the managed provider and can be - null for the native provider. The native provider uses the Q portion stored in the R matrix. - The R matrix obtained by calling . - The number of rows in the A matrix. - The number of columns in the A matrix. - Contains additional information on Q. Only used for the native solver - and can be null for the managed provider. - On entry the B matrix; on exit the X matrix. - The number of columns of B. - On exit, the solution matrix. - Rows must be greater or equal to columns. - The type of QR factorization to perform. - - - - Computes the singular value decomposition of A. - - Compute the singular U and VT vectors or not. - On entry, the M by N matrix to decompose. On exit, A may be overwritten. - The number of rows in the A matrix. - The number of columns in the A matrix. - The singular values of A in ascending value. - If is true, on exit U contains the left - singular vectors. - If is true, on exit VT contains the transposed - right singular vectors. - This is equivalent to the GESVD LAPACK routine. - - - - Solves A*X=B for X using the singular value decomposition of A. - - On entry, the M by N matrix to decompose. - The number of rows in the A matrix. - The number of columns in the A matrix. - The B matrix. - The number of columns of B. - On exit, the solution matrix. - - - - Solves A*X=B for X using a previously SVD decomposed matrix. - - The number of rows in the A matrix. - The number of columns in the A matrix. - The s values returned by . - The left singular vectors returned by . - The right singular vectors returned by . - The B matrix - The number of columns of B. - On exit, the solution matrix. - - - - Computes the eigenvalues and eigenvectors of a matrix. - - Whether the matrix is symmetric or not. - The order of the matrix. - The matrix to decompose. The length of the array must be order * order. - On output, the matrix contains the eigen vectors. The length of the array must be order * order. - On output, the eigen values (λ) of matrix in ascending value. The length of the array must . - On output, the block diagonal eigenvalue matrix. The length of the array must be order * order. - - - - Optional path to try to load native provider binaries from, - if the provider specific hint path is not set. - If neither is set, Numerics falls back to the provider specific - environment variables, or the default probing paths. - - - - - Gets or sets the linear algebra provider. - Consider to use UseNativeMKL or UseManaged instead. - - The linear algebra provider. - - - - Try to use a native provider, if available. - - - - - Use the best provider available. - - - - - Use a specific provider if configured, e.g. using the - "MathNetNumericsLAProvider" environment variable, - or fall back to the best provider. - - - - - The managed linear algebra provider. - - - The managed linear algebra provider. - - - The managed linear algebra provider. - - - The managed linear algebra provider. - - - The managed linear algebra provider. - - - - - Adds a scaled vector to another: result = y + alpha*x. - - The vector to update. - The value to scale by. - The vector to add to . - The result of the addition. - This is similar to the AXPY BLAS routine. - - - - Scales an array. Can be used to scale a vector and a matrix. - - The scalar. - The values to scale. - This result of the scaling. - This is similar to the SCAL BLAS routine. - - - - Conjugates an array. Can be used to conjugate a vector and a matrix. - - The values to conjugate. - This result of the conjugation. - - - - Computes the dot product of x and y. - - The vector x. - The vector y. - The dot product of x and y. - This is equivalent to the DOT BLAS routine. - - - - Does a point wise add of two arrays z = x + y. This can be used - to add vectors or matrices. - - The array x. - The array y. - The result of the addition. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise subtraction of two arrays z = x - y. This can be used - to subtract vectors or matrices. - - The array x. - The array y. - The result of the subtraction. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise multiplication of two arrays z = x * y. This can be used - to multiple elements of vectors or matrices. - - The array x. - The array y. - The result of the point wise multiplication. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise division of two arrays z = x / y. This can be used - to divide elements of vectors or matrices. - - The array x. - The array y. - The result of the point wise division. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise power of two arrays z = x ^ y. This can be used - to raise elements of vectors or matrices to the powers of another vector or matrix. - - The array x. - The array y. - The result of the point wise power. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Computes the requested of the matrix. - - The type of norm to compute. - The number of rows. - The number of columns. - The matrix to compute the norm from. - - The requested of the matrix. - - - - - Multiples two matrices. result = x * y - - The x matrix. - The number of rows in the x matrix. - The number of columns in the x matrix. - The y matrix. - The number of rows in the y matrix. - The number of columns in the y matrix. - Where to store the result of the multiplication. - This is a simplified version of the BLAS GEMM routine with alpha - set to 1.0 and beta set to 0.0, and x and y are not transposed. - - - - Multiplies two matrices and updates another with the result. c = alpha*op(a)*op(b) + beta*c - - How to transpose the matrix. - How to transpose the matrix. - The value to scale matrix. - The a matrix. - The number of rows in the matrix. - The number of columns in the matrix. - The b matrix - The number of rows in the matrix. - The number of columns in the matrix. - The value to scale the matrix. - The c matrix. - - - - Computes the LUP factorization of A. P*A = L*U. - - An by matrix. The matrix is overwritten with the - the LU factorization on exit. The lower triangular factor L is stored in under the diagonal of (the diagonal is always 1.0 - for the L factor). The upper triangular factor U is stored on and above the diagonal of . - The order of the square matrix . - On exit, it contains the pivot indices. The size of the array must be . - This is equivalent to the GETRF LAPACK routine. - - - - Computes the inverse of matrix using LU factorization. - - The N by N matrix to invert. Contains the inverse On exit. - The order of the square matrix . - This is equivalent to the GETRF and GETRI LAPACK routines. - - - - Computes the inverse of a previously factored matrix. - - The LU factored N by N matrix. Contains the inverse On exit. - The order of the square matrix . - The pivot indices of . - This is equivalent to the GETRI LAPACK routine. - - - - Solves A*X=B for X using LU factorization. - - The number of columns of B. - The square matrix A. - The order of the square matrix . - On entry the B matrix; on exit the X matrix. - This is equivalent to the GETRF and GETRS LAPACK routines. - - - - Solves A*X=B for X using a previously factored A matrix. - - The number of columns of B. - The factored A matrix. - The order of the square matrix . - The pivot indices of . - On entry the B matrix; on exit the X matrix. - This is equivalent to the GETRS LAPACK routine. - - - - Computes the Cholesky factorization of A. - - On entry, a square, positive definite matrix. On exit, the matrix is overwritten with the - the Cholesky factorization. - The number of rows or columns in the matrix. - This is equivalent to the POTRF LAPACK routine. - - - - Calculate Cholesky step - - Factor matrix - Number of rows - Column start - Total columns - Multipliers calculated previously - Number of available processors - - - - Solves A*X=B for X using Cholesky factorization. - - The square, positive definite matrix A. - The number of rows and columns in A. - On entry the B matrix; on exit the X matrix. - The number of columns in the B matrix. - This is equivalent to the POTRF add POTRS LAPACK routines. - - - - Solves A*X=B for X using a previously factored A matrix. - - The square, positive definite matrix A. - The number of rows and columns in A. - The B matrix. - The number of columns in the B matrix. - This is equivalent to the POTRS LAPACK routine. - - - - Solves A*X=B for X using a previously factored A matrix. - - The square, positive definite matrix A. Has to be different than . - The number of rows and columns in A. - On entry the B matrix; on exit the X matrix. - The column to solve for. - - - - Computes the QR factorization of A. - - On entry, it is the M by N A matrix to factor. On exit, - it is overwritten with the R matrix of the QR factorization. - The number of rows in the A matrix. - The number of columns in the A matrix. - On exit, A M by M matrix that holds the Q matrix of the - QR factorization. - A min(m,n) vector. On exit, contains additional information - to be used by the QR solve routine. - This is similar to the GEQRF and ORGQR LAPACK routines. - - - - Computes the QR factorization of A. - - On entry, it is the M by N A matrix to factor. On exit, - it is overwritten with the Q matrix of the QR factorization. - The number of rows in the A matrix. - The number of columns in the A matrix. - On exit, A N by N matrix that holds the R matrix of the - QR factorization. - A min(m,n) vector. On exit, contains additional information - to be used by the QR solve routine. - This is similar to the GEQRF and ORGQR LAPACK routines. - - - - Perform calculation of Q or R - - Work array - Index of column in work array - Q or R matrices - The first row in - The last row - The first column - The last column - Number of available CPUs - - - - Generate column from initial matrix to work array - - Work array - Initial matrix - The number of rows in matrix - The first row - Column index - - - - Solves A*X=B for X using QR factorization of A. - - The A matrix. - The number of rows in the A matrix. - The number of columns in the A matrix. - The B matrix. - The number of columns of B. - On exit, the solution matrix. - The type of QR factorization to perform. - Rows must be greater or equal to columns. - - - - Solves A*X=B for X using a previously QR factored matrix. - - The Q matrix obtained by calling . - The R matrix obtained by calling . - The number of rows in the A matrix. - The number of columns in the A matrix. - Contains additional information on Q. Only used for the native solver - and can be null for the managed provider. - The B matrix. - The number of columns of B. - On exit, the solution matrix. - The type of QR factorization to perform. - Rows must be greater or equal to columns. - - - - Computes the singular value decomposition of A. - - Compute the singular U and VT vectors or not. - On entry, the M by N matrix to decompose. On exit, A may be overwritten. - The number of rows in the A matrix. - The number of columns in the A matrix. - The singular values of A in ascending value. - If is true, on exit U contains the left - singular vectors. - If is true, on exit VT contains the transposed - right singular vectors. - This is equivalent to the GESVD LAPACK routine. - - - - Solves A*X=B for X using the singular value decomposition of A. - - On entry, the M by N matrix to decompose. - The number of rows in the A matrix. - The number of columns in the A matrix. - The B matrix. - The number of columns of B. - On exit, the solution matrix. - - - - Solves A*X=B for X using a previously SVD decomposed matrix. - - The number of rows in the A matrix. - The number of columns in the A matrix. - The s values returned by . - The left singular vectors returned by . - The right singular vectors returned by . - The B matrix. - The number of columns of B. - On exit, the solution matrix. - - - - Computes the eigenvalues and eigenvectors of a matrix. - - Whether the matrix is symmetric or not. - The order of the matrix. - The matrix to decompose. The length of the array must be order * order. - On output, the matrix contains the eigen vectors. The length of the array must be order * order. - On output, the eigen values (λ) of matrix in ascending value. The length of the array must . - On output, the block diagonal eigenvalue matrix. The length of the array must be order * order. - - - - Reduces a complex Hermitian matrix to a real symmetric tridiagonal matrix using unitary similarity transformations. - - Source matrix to reduce - Output: Arrays for internal storage of real parts of eigenvalues - Output: Arrays for internal storage of imaginary parts of eigenvalues - Output: Arrays that contains further information about the transformations. - Order of initial matrix - This is derived from the Algol procedures HTRIDI by - Smith, Boyle, Dongarra, Garbow, Ikebe, Klema, Moler, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Symmetric tridiagonal QL algorithm. - - Data array of matrix V (eigenvectors) - Arrays for internal storage of real parts of eigenvalues - Arrays for internal storage of imaginary parts of eigenvalues - Order of initial matrix - This is derived from the Algol procedures tql2, by - Bowdler, Martin, Reinsch, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - - Determines eigenvectors by undoing the symmetric tridiagonalize transformation - - Data array of matrix V (eigenvectors) - Previously tridiagonalized matrix by SymmetricTridiagonalize. - Contains further information about the transformations - Input matrix order - This is derived from the Algol procedures HTRIBK, by - by Smith, Boyle, Dongarra, Garbow, Ikebe, Klema, Moler, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Nonsymmetric reduction to Hessenberg form. - - Data array of matrix V (eigenvectors) - Array for internal storage of nonsymmetric Hessenberg form. - Order of initial matrix - This is derived from the Algol procedures orthes and ortran, - by Martin and Wilkinson, Handbook for Auto. Comp., - Vol.ii-Linear Algebra, and the corresponding - Fortran subroutines in EISPACK. - - - - Nonsymmetric reduction from Hessenberg to real Schur form. - - Data array of the eigenvectors - Data array of matrix V (eigenvectors) - Array for internal storage of nonsymmetric Hessenberg form. - Order of initial matrix - This is derived from the Algol procedure hqr2, - by Martin and Wilkinson, Handbook for Auto. Comp., - Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Assumes that and have already been transposed. - - - - - Assumes that and have already been transposed. - - - - - Adds a scaled vector to another: result = y + alpha*x. - - The vector to update. - The value to scale by. - The vector to add to . - The result of the addition. - This is similar to the AXPY BLAS routine. - - - - Scales an array. Can be used to scale a vector and a matrix. - - The scalar. - The values to scale. - This result of the scaling. - This is similar to the SCAL BLAS routine. - - - - Conjugates an array. Can be used to conjugate a vector and a matrix. - - The values to conjugate. - This result of the conjugation. - - - - Computes the dot product of x and y. - - The vector x. - The vector y. - The dot product of x and y. - This is equivalent to the DOT BLAS routine. - - - - Does a point wise add of two arrays z = x + y. This can be used - to add vectors or matrices. - - The array x. - The array y. - The result of the addition. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise subtraction of two arrays z = x - y. This can be used - to subtract vectors or matrices. - - The array x. - The array y. - The result of the subtraction. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise multiplication of two arrays z = x * y. This can be used - to multiple elements of vectors or matrices. - - The array x. - The array y. - The result of the point wise multiplication. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise division of two arrays z = x / y. This can be used - to divide elements of vectors or matrices. - - The array x. - The array y. - The result of the point wise division. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise power of two arrays z = x ^ y. This can be used - to raise elements of vectors or matrices to the powers of another vector or matrix. - - The array x. - The array y. - The result of the point wise power. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Computes the requested of the matrix. - - The type of norm to compute. - The number of rows. - The number of columns. - The matrix to compute the norm from. - The requested of the matrix. - - - - Multiples two matrices. result = x * y - - The x matrix. - The number of rows in the x matrix. - The number of columns in the x matrix. - The y matrix. - The number of rows in the y matrix. - The number of columns in the y matrix. - Where to store the result of the multiplication. - This is a simplified version of the BLAS GEMM routine with alpha - set to 1.0 and beta set to 0.0, and x and y are not transposed. - - - - Multiplies two matrices and updates another with the result. c = alpha*op(a)*op(b) + beta*c - - How to transpose the matrix. - How to transpose the matrix. - The value to scale matrix. - The a matrix. - The number of rows in the matrix. - The number of columns in the matrix. - The b matrix - The number of rows in the matrix. - The number of columns in the matrix. - The value to scale the matrix. - The c matrix. - - - - Computes the LUP factorization of A. P*A = L*U. - - An by matrix. The matrix is overwritten with the - the LU factorization on exit. The lower triangular factor L is stored in under the diagonal of (the diagonal is always 1.0 - for the L factor). The upper triangular factor U is stored on and above the diagonal of . - The order of the square matrix . - On exit, it contains the pivot indices. The size of the array must be . - This is equivalent to the GETRF LAPACK routine. - - - - Computes the inverse of matrix using LU factorization. - - The N by N matrix to invert. Contains the inverse On exit. - The order of the square matrix . - This is equivalent to the GETRF and GETRI LAPACK routines. - - - - Computes the inverse of a previously factored matrix. - - The LU factored N by N matrix. Contains the inverse On exit. - The order of the square matrix . - The pivot indices of . - This is equivalent to the GETRI LAPACK routine. - - - - Solves A*X=B for X using LU factorization. - - The number of columns of B. - The square matrix A. - The order of the square matrix . - On entry the B matrix; on exit the X matrix. - This is equivalent to the GETRF and GETRS LAPACK routines. - - - - Solves A*X=B for X using a previously factored A matrix. - - The number of columns of B. - The factored A matrix. - The order of the square matrix . - The pivot indices of . - On entry the B matrix; on exit the X matrix. - This is equivalent to the GETRS LAPACK routine. - - - - Computes the Cholesky factorization of A. - - On entry, a square, positive definite matrix. On exit, the matrix is overwritten with the - the Cholesky factorization. - The number of rows or columns in the matrix. - This is equivalent to the POTRF LAPACK routine. - - - - Calculate Cholesky step - - Factor matrix - Number of rows - Column start - Total columns - Multipliers calculated previously - Number of available processors - - - - Solves A*X=B for X using Cholesky factorization. - - The square, positive definite matrix A. - The number of rows and columns in A. - On entry the B matrix; on exit the X matrix. - The number of columns in the B matrix. - This is equivalent to the POTRF add POTRS LAPACK routines. - - - - Solves A*X=B for X using a previously factored A matrix. - - The square, positive definite matrix A. - The number of rows and columns in A. - On entry the B matrix; on exit the X matrix. - The number of columns in the B matrix. - This is equivalent to the POTRS LAPACK routine. - - - - Solves A*X=B for X using a previously factored A matrix. - - The square, positive definite matrix A. Has to be different than . - The number of rows and columns in A. - On entry the B matrix; on exit the X matrix. - The column to solve for. - - - - Computes the QR factorization of A. - - On entry, it is the M by N A matrix to factor. On exit, - it is overwritten with the R matrix of the QR factorization. - The number of rows in the A matrix. - The number of columns in the A matrix. - On exit, A M by M matrix that holds the Q matrix of the - QR factorization. - A min(m,n) vector. On exit, contains additional information - to be used by the QR solve routine. - This is similar to the GEQRF and ORGQR LAPACK routines. - - - - Computes the QR factorization of A. - - On entry, it is the M by N A matrix to factor. On exit, - it is overwritten with the Q matrix of the QR factorization. - The number of rows in the A matrix. - The number of columns in the A matrix. - On exit, A N by N matrix that holds the R matrix of the - QR factorization. - A min(m,n) vector. On exit, contains additional information - to be used by the QR solve routine. - This is similar to the GEQRF and ORGQR LAPACK routines. - - - - Perform calculation of Q or R - - Work array - Index of column in work array - Q or R matrices - The first row in - The last row - The first column - The last column - Number of available CPUs - - - - Generate column from initial matrix to work array - - Work array - Initial matrix - The number of rows in matrix - The first row - Column index - - - - Solves A*X=B for X using QR factorization of A. - - The A matrix. - The number of rows in the A matrix. - The number of columns in the A matrix. - The B matrix. - The number of columns of B. - On exit, the solution matrix. - The type of QR factorization to perform. - Rows must be greater or equal to columns. - - - - Solves A*X=B for X using a previously QR factored matrix. - - The Q matrix obtained by calling . - The R matrix obtained by calling . - The number of rows in the A matrix. - The number of columns in the A matrix. - Contains additional information on Q. Only used for the native solver - and can be null for the managed provider. - The B matrix. - The number of columns of B. - On exit, the solution matrix. - The type of QR factorization to perform. - Rows must be greater or equal to columns. - - - - Computes the singular value decomposition of A. - - Compute the singular U and VT vectors or not. - On entry, the M by N matrix to decompose. On exit, A may be overwritten. - The number of rows in the A matrix. - The number of columns in the A matrix. - The singular values of A in ascending value. - If is true, on exit U contains the left - singular vectors. - If is true, on exit VT contains the transposed - right singular vectors. - This is equivalent to the GESVD LAPACK routine. - - - - Solves A*X=B for X using the singular value decomposition of A. - - On entry, the M by N matrix to decompose. - The number of rows in the A matrix. - The number of columns in the A matrix. - The B matrix. - The number of columns of B. - On exit, the solution matrix. - - - - Solves A*X=B for X using a previously SVD decomposed matrix. - - The number of rows in the A matrix. - The number of columns in the A matrix. - The s values returned by . - The left singular vectors returned by . - The right singular vectors returned by . - The B matrix. - The number of columns of B. - On exit, the solution matrix. - - - - Computes the eigenvalues and eigenvectors of a matrix. - - Whether the matrix is symmetric or not. - The order of the matrix. - The matrix to decompose. The length of the array must be order * order. - On output, the matrix contains the eigen vectors. The length of the array must be order * order. - On output, the eigen values (λ) of matrix in ascending value. The length of the array must . - On output, the block diagonal eigenvalue matrix. The length of the array must be order * order. - - - - Reduces a complex Hermitian matrix to a real symmetric tridiagonal matrix using unitary similarity transformations. - - Source matrix to reduce - Output: Arrays for internal storage of real parts of eigenvalues - Output: Arrays for internal storage of imaginary parts of eigenvalues - Output: Arrays that contains further information about the transformations. - Order of initial matrix - This is derived from the Algol procedures HTRIDI by - Smith, Boyle, Dongarra, Garbow, Ikebe, Klema, Moler, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Symmetric tridiagonal QL algorithm. - - Data array of matrix V (eigenvectors) - Arrays for internal storage of real parts of eigenvalues - Arrays for internal storage of imaginary parts of eigenvalues - Order of initial matrix - This is derived from the Algol procedures tql2, by - Bowdler, Martin, Reinsch, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - - Determines eigenvectors by undoing the symmetric tridiagonalize transformation - - Data array of matrix V (eigenvectors) - Previously tridiagonalized matrix by SymmetricTridiagonalize. - Contains further information about the transformations - Input matrix order - This is derived from the Algol procedures HTRIBK, by - by Smith, Boyle, Dongarra, Garbow, Ikebe, Klema, Moler, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Nonsymmetric reduction to Hessenberg form. - - Data array of matrix V (eigenvectors) - Array for internal storage of nonsymmetric Hessenberg form. - Order of initial matrix - This is derived from the Algol procedures orthes and ortran, - by Martin and Wilkinson, Handbook for Auto. Comp., - Vol.ii-Linear Algebra, and the corresponding - Fortran subroutines in EISPACK. - - - - Nonsymmetric reduction from Hessenberg to real Schur form. - - Data array of the eigenvectors - Data array of matrix V (eigenvectors) - Array for internal storage of nonsymmetric Hessenberg form. - Order of initial matrix - This is derived from the Algol procedure hqr2, - by Martin and Wilkinson, Handbook for Auto. Comp., - Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Assumes that and have already been transposed. - - - - - Assumes that and have already been transposed. - - - - - Try to find out whether the provider is available, at least in principle. - Verification may still fail if available, but it will certainly fail if unavailable. - - - - - Initialize and verify that the provided is indeed available. If not, fall back to alternatives like the managed provider - - - - - Frees memory buffers, caches and handles allocated in or to the provider. - Does not unload the provider itself, it is still usable afterwards. - - - - - Assumes that and have already been transposed. - - - - - Assumes that and have already been transposed. - - - - - Adds a scaled vector to another: result = y + alpha*x. - - The vector to update. - The value to scale by. - The vector to add to . - The result of the addition. - This is similar to the AXPY BLAS routine. - - - - Scales an array. Can be used to scale a vector and a matrix. - - The scalar. - The values to scale. - This result of the scaling. - This is similar to the SCAL BLAS routine. - - - - Conjugates an array. Can be used to conjugate a vector and a matrix. - - The values to conjugate. - This result of the conjugation. - - - - Computes the dot product of x and y. - - The vector x. - The vector y. - The dot product of x and y. - This is equivalent to the DOT BLAS routine. - - - - Does a point wise add of two arrays z = x + y. This can be used - to add vectors or matrices. - - The array x. - The array y. - The result of the addition. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise subtraction of two arrays z = x - y. This can be used - to subtract vectors or matrices. - - The array x. - The array y. - The result of the subtraction. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise multiplication of two arrays z = x * y. This can be used - to multiple elements of vectors or matrices. - - The array x. - The array y. - The result of the point wise multiplication. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise division of two arrays z = x / y. This can be used - to divide elements of vectors or matrices. - - The array x. - The array y. - The result of the point wise division. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise power of two arrays z = x ^ y. This can be used - to raise elements of vectors or matrices to the powers of another vector or matrix. - - The array x. - The array y. - The result of the point wise power. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Computes the requested of the matrix. - - The type of norm to compute. - The number of rows. - The number of columns. - The matrix to compute the norm from. - - The requested of the matrix. - - - - - Multiples two matrices. result = x * y - - The x matrix. - The number of rows in the x matrix. - The number of columns in the x matrix. - The y matrix. - The number of rows in the y matrix. - The number of columns in the y matrix. - Where to store the result of the multiplication. - This is a simplified version of the BLAS GEMM routine with alpha - set to 1.0 and beta set to 0.0, and x and y are not transposed. - - - - Multiplies two matrices and updates another with the result. c = alpha*op(a)*op(b) + beta*c - - How to transpose the matrix. - How to transpose the matrix. - The value to scale matrix. - The a matrix. - The number of rows in the matrix. - The number of columns in the matrix. - The b matrix - The number of rows in the matrix. - The number of columns in the matrix. - The value to scale the matrix. - The c matrix. - - - - Computes the LUP factorization of A. P*A = L*U. - - An by matrix. The matrix is overwritten with the - the LU factorization on exit. The lower triangular factor L is stored in under the diagonal of (the diagonal is always 1.0 - for the L factor). The upper triangular factor U is stored on and above the diagonal of . - The order of the square matrix . - On exit, it contains the pivot indices. The size of the array must be . - This is equivalent to the GETRF LAPACK routine. - - - - Computes the inverse of matrix using LU factorization. - - The N by N matrix to invert. Contains the inverse On exit. - The order of the square matrix . - This is equivalent to the GETRF and GETRI LAPACK routines. - - - - Computes the inverse of a previously factored matrix. - - The LU factored N by N matrix. Contains the inverse On exit. - The order of the square matrix . - The pivot indices of . - This is equivalent to the GETRI LAPACK routine. - - - - Solves A*X=B for X using LU factorization. - - The number of columns of B. - The square matrix A. - The order of the square matrix . - On entry the B matrix; on exit the X matrix. - This is equivalent to the GETRF and GETRS LAPACK routines. - - - - Solves A*X=B for X using a previously factored A matrix. - - The number of columns of B. - The factored A matrix. - The order of the square matrix . - The pivot indices of . - On entry the B matrix; on exit the X matrix. - This is equivalent to the GETRS LAPACK routine. - - - - Computes the Cholesky factorization of A. - - On entry, a square, positive definite matrix. On exit, the matrix is overwritten with the - the Cholesky factorization. - The number of rows or columns in the matrix. - This is equivalent to the POTRF LAPACK routine. - - - - Calculate Cholesky step - - Factor matrix - Number of rows - Column start - Total columns - Multipliers calculated previously - Number of available processors - - - - Solves A*X=B for X using Cholesky factorization. - - The square, positive definite matrix A. - The number of rows and columns in A. - On entry the B matrix; on exit the X matrix. - The number of columns in the B matrix. - This is equivalent to the POTRF add POTRS LAPACK routines. - - - - Solves A*X=B for X using a previously factored A matrix. - - The square, positive definite matrix A. Has to be different than . - The number of rows and columns in A. - On entry the B matrix; on exit the X matrix. - The number of columns in the B matrix. - This is equivalent to the POTRS LAPACK routine. - - - - Solves A*X=B for X using a previously factored A matrix. - - The square, positive definite matrix A. Has to be different than . - The number of rows and columns in A. - On entry the B matrix; on exit the X matrix. - The column to solve for. - - - - Computes the QR factorization of A. - - On entry, it is the M by N A matrix to factor. On exit, - it is overwritten with the R matrix of the QR factorization. - The number of rows in the A matrix. - The number of columns in the A matrix. - On exit, A M by M matrix that holds the Q matrix of the - QR factorization. - A min(m,n) vector. On exit, contains additional information - to be used by the QR solve routine. - This is similar to the GEQRF and ORGQR LAPACK routines. - - - - Computes the QR factorization of A. - - On entry, it is the M by N A matrix to factor. On exit, - it is overwritten with the Q matrix of the QR factorization. - The number of rows in the A matrix. - The number of columns in the A matrix. - On exit, A N by N matrix that holds the R matrix of the - QR factorization. - A min(m,n) vector. On exit, contains additional information - to be used by the QR solve routine. - This is similar to the GEQRF and ORGQR LAPACK routines. - - - - Perform calculation of Q or R - - Work array - Index of column in work array - Q or R matrices - The first row in - The last row - The first column - The last column - Number of available CPUs - - - - Generate column from initial matrix to work array - - Work array - Initial matrix - The number of rows in matrix - The first row - Column index - - - - Solves A*X=B for X using QR factorization of A. - - The A matrix. - The number of rows in the A matrix. - The number of columns in the A matrix. - The B matrix. - The number of columns of B. - On exit, the solution matrix. - The type of QR factorization to perform. - Rows must be greater or equal to columns. - - - - Solves A*X=B for X using a previously QR factored matrix. - - The Q matrix obtained by calling . - The R matrix obtained by calling . - The number of rows in the A matrix. - The number of columns in the A matrix. - Contains additional information on Q. Only used for the native solver - and can be null for the managed provider. - The B matrix. - The number of columns of B. - On exit, the solution matrix. - The type of QR factorization to perform. - Rows must be greater or equal to columns. - - - - Computes the singular value decomposition of A. - - Compute the singular U and VT vectors or not. - On entry, the M by N matrix to decompose. On exit, A may be overwritten. - The number of rows in the A matrix. - The number of columns in the A matrix. - The singular values of A in ascending value. - If is true, on exit U contains the left - singular vectors. - If is true, on exit VT contains the transposed - right singular vectors. - This is equivalent to the GESVD LAPACK routine. - - - - Given the Cartesian coordinates (da, db) of a point p, these function return the parameters da, db, c, and s - associated with the Givens rotation that zeros the y-coordinate of the point. - - Provides the x-coordinate of the point p. On exit contains the parameter r associated with the Givens rotation - Provides the y-coordinate of the point p. On exit contains the parameter z associated with the Givens rotation - Contains the parameter c associated with the Givens rotation - Contains the parameter s associated with the Givens rotation - This is equivalent to the DROTG LAPACK routine. - - - - Solves A*X=B for X using the singular value decomposition of A. - - On entry, the M by N matrix to decompose. - The number of rows in the A matrix. - The number of columns in the A matrix. - The B matrix. - The number of columns of B. - On exit, the solution matrix. - - - - Solves A*X=B for X using a previously SVD decomposed matrix. - - The number of rows in the A matrix. - The number of columns in the A matrix. - The s values returned by . - The left singular vectors returned by . - The right singular vectors returned by . - The B matrix. - The number of columns of B. - On exit, the solution matrix. - - - - Computes the eigenvalues and eigenvectors of a matrix. - - Whether the matrix is symmetric or not. - The order of the matrix. - The matrix to decompose. The length of the array must be order * order. - On output, the matrix contains the eigen vectors. The length of the array must be order * order. - On output, the eigen values (λ) of matrix in ascending value. The length of the array must . - On output, the block diagonal eigenvalue matrix. The length of the array must be order * order. - - - - Symmetric Householder reduction to tridiagonal form. - - Data array of matrix V (eigenvectors) - Arrays for internal storage of real parts of eigenvalues - Arrays for internal storage of imaginary parts of eigenvalues - Order of initial matrix - This is derived from the Algol procedures tred2 by - Bowdler, Martin, Reinsch, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Symmetric tridiagonal QL algorithm. - - Data array of matrix V (eigenvectors) - Arrays for internal storage of real parts of eigenvalues - Arrays for internal storage of imaginary parts of eigenvalues - Order of initial matrix - This is derived from the Algol procedures tql2, by - Bowdler, Martin, Reinsch, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - - Nonsymmetric reduction to Hessenberg form. - - Data array of matrix V (eigenvectors) - Array for internal storage of nonsymmetric Hessenberg form. - Order of initial matrix - This is derived from the Algol procedures orthes and ortran, - by Martin and Wilkinson, Handbook for Auto. Comp., - Vol.ii-Linear Algebra, and the corresponding - Fortran subroutines in EISPACK. - - - - Nonsymmetric reduction from Hessenberg to real Schur form. - - Data array of matrix V (eigenvectors) - Array for internal storage of nonsymmetric Hessenberg form. - Arrays for internal storage of real parts of eigenvalues - Arrays for internal storage of imaginary parts of eigenvalues - Order of initial matrix - This is derived from the Algol procedure hqr2, - by Martin and Wilkinson, Handbook for Auto. Comp., - Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - - Complex scalar division X/Y. - - Real part of X - Imaginary part of X - Real part of Y - Imaginary part of Y - Division result as a number. - - - - Adds a scaled vector to another: result = y + alpha*x. - - The vector to update. - The value to scale by. - The vector to add to . - The result of the addition. - This is similar to the AXPY BLAS routine. - - - - Scales an array. Can be used to scale a vector and a matrix. - - The scalar. - The values to scale. - This result of the scaling. - This is similar to the SCAL BLAS routine. - - - - Conjugates an array. Can be used to conjugate a vector and a matrix. - - The values to conjugate. - This result of the conjugation. - - - - Computes the dot product of x and y. - - The vector x. - The vector y. - The dot product of x and y. - This is equivalent to the DOT BLAS routine. - - - - Does a point wise add of two arrays z = x + y. This can be used - to add vectors or matrices. - - The array x. - The array y. - The result of the addition. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise subtraction of two arrays z = x - y. This can be used - to subtract vectors or matrices. - - The array x. - The array y. - The result of the subtraction. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise multiplication of two arrays z = x * y. This can be used - to multiple elements of vectors or matrices. - - The array x. - The array y. - The result of the point wise multiplication. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise division of two arrays z = x / y. This can be used - to divide elements of vectors or matrices. - - The array x. - The array y. - The result of the point wise division. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Does a point wise power of two arrays z = x ^ y. This can be used - to raise elements of vectors or matrices to the powers of another vector or matrix. - - The array x. - The array y. - The result of the point wise power. - There is no equivalent BLAS routine, but many libraries - provide optimized (parallel and/or vectorized) versions of this - routine. - - - - Computes the requested of the matrix. - - The type of norm to compute. - The number of rows. - The number of columns. - The matrix to compute the norm from. - - The requested of the matrix. - - - - - Multiples two matrices. result = x * y - - The x matrix. - The number of rows in the x matrix. - The number of columns in the x matrix. - The y matrix. - The number of rows in the y matrix. - The number of columns in the y matrix. - Where to store the result of the multiplication. - This is a simplified version of the BLAS GEMM routine with alpha - set to 1.0 and beta set to 0.0, and x and y are not transposed. - - - - Multiplies two matrices and updates another with the result. c = alpha*op(a)*op(b) + beta*c - - How to transpose the matrix. - How to transpose the matrix. - The value to scale matrix. - The a matrix. - The number of rows in the matrix. - The number of columns in the matrix. - The b matrix - The number of rows in the matrix. - The number of columns in the matrix. - The value to scale the matrix. - The c matrix. - - - - Computes the LUP factorization of A. P*A = L*U. - - An by matrix. The matrix is overwritten with the - the LU factorization on exit. The lower triangular factor L is stored in under the diagonal of (the diagonal is always 1.0 - for the L factor). The upper triangular factor U is stored on and above the diagonal of . - The order of the square matrix . - On exit, it contains the pivot indices. The size of the array must be . - This is equivalent to the GETRF LAPACK routine. - - - - Computes the inverse of matrix using LU factorization. - - The N by N matrix to invert. Contains the inverse On exit. - The order of the square matrix . - This is equivalent to the GETRF and GETRI LAPACK routines. - - - - Computes the inverse of a previously factored matrix. - - The LU factored N by N matrix. Contains the inverse On exit. - The order of the square matrix . - The pivot indices of . - This is equivalent to the GETRI LAPACK routine. - - - - Solves A*X=B for X using LU factorization. - - The number of columns of B. - The square matrix A. - The order of the square matrix . - On entry the B matrix; on exit the X matrix. - This is equivalent to the GETRF and GETRS LAPACK routines. - - - - Solves A*X=B for X using a previously factored A matrix. - - The number of columns of B. - The factored A matrix. - The order of the square matrix . - The pivot indices of . - On entry the B matrix; on exit the X matrix. - This is equivalent to the GETRS LAPACK routine. - - - - Computes the Cholesky factorization of A. - - On entry, a square, positive definite matrix. On exit, the matrix is overwritten with the - the Cholesky factorization. - The number of rows or columns in the matrix. - This is equivalent to the POTRF LAPACK routine. - - - - Calculate Cholesky step - - Factor matrix - Number of rows - Column start - Total columns - Multipliers calculated previously - Number of available processors - - - - Solves A*X=B for X using Cholesky factorization. - - The square, positive definite matrix A. - The number of rows and columns in A. - On entry the B matrix; on exit the X matrix. - The number of columns in the B matrix. - This is equivalent to the POTRF add POTRS LAPACK routines. - - - - Solves A*X=B for X using a previously factored A matrix. - - The square, positive definite matrix A. - The number of rows and columns in A. - On entry the B matrix; on exit the X matrix. - The number of columns in the B matrix. - This is equivalent to the POTRS LAPACK routine. - - - - Solves A*X=B for X using a previously factored A matrix. - - The square, positive definite matrix A. Has to be different than . - The number of rows and columns in A. - On entry the B matrix; on exit the X matrix. - The column to solve for. - - - - Computes the QR factorization of A. - - On entry, it is the M by N A matrix to factor. On exit, - it is overwritten with the R matrix of the QR factorization. - The number of rows in the A matrix. - The number of columns in the A matrix. - On exit, A M by M matrix that holds the Q matrix of the - QR factorization. - A min(m,n) vector. On exit, contains additional information - to be used by the QR solve routine. - This is similar to the GEQRF and ORGQR LAPACK routines. - - - - Computes the QR factorization of A. - - On entry, it is the M by N A matrix to factor. On exit, - it is overwritten with the Q matrix of the QR factorization. - The number of rows in the A matrix. - The number of columns in the A matrix. - On exit, A N by N matrix that holds the R matrix of the - QR factorization. - A min(m,n) vector. On exit, contains additional information - to be used by the QR solve routine. - This is similar to the GEQRF and ORGQR LAPACK routines. - - - - Perform calculation of Q or R - - Work array - Index of column in work array - Q or R matrices - The first row in - The last row - The first column - The last column - Number of available CPUs - - - - Generate column from initial matrix to work array - - Work array - Initial matrix - The number of rows in matrix - The first row - Column index - - - - Solves A*X=B for X using QR factorization of A. - - The A matrix. - The number of rows in the A matrix. - The number of columns in the A matrix. - The B matrix. - The number of columns of B. - On exit, the solution matrix. - The type of QR factorization to perform. - Rows must be greater or equal to columns. - - - - Solves A*X=B for X using a previously QR factored matrix. - - The Q matrix obtained by calling . - The R matrix obtained by calling . - The number of rows in the A matrix. - The number of columns in the A matrix. - Contains additional information on Q. Only used for the native solver - and can be null for the managed provider. - The B matrix. - The number of columns of B. - On exit, the solution matrix. - The type of QR factorization to perform. - Rows must be greater or equal to columns. - - - - Computes the singular value decomposition of A. - - Compute the singular U and VT vectors or not. - On entry, the M by N matrix to decompose. On exit, A may be overwritten. - The number of rows in the A matrix. - The number of columns in the A matrix. - The singular values of A in ascending value. - If is true, on exit U contains the left - singular vectors. - If is true, on exit VT contains the transposed - right singular vectors. - This is equivalent to the GESVD LAPACK routine. - - - - Given the Cartesian coordinates (da, db) of a point p, these function return the parameters da, db, c, and s - associated with the Givens rotation that zeros the y-coordinate of the point. - - Provides the x-coordinate of the point p. On exit contains the parameter r associated with the Givens rotation - Provides the y-coordinate of the point p. On exit contains the parameter z associated with the Givens rotation - Contains the parameter c associated with the Givens rotation - Contains the parameter s associated with the Givens rotation - This is equivalent to the DROTG LAPACK routine. - - - - Solves A*X=B for X using the singular value decomposition of A. - - On entry, the M by N matrix to decompose. - The number of rows in the A matrix. - The number of columns in the A matrix. - The B matrix. - The number of columns of B. - On exit, the solution matrix. - - - - Solves A*X=B for X using a previously SVD decomposed matrix. - - The number of rows in the A matrix. - The number of columns in the A matrix. - The s values returned by . - The left singular vectors returned by . - The right singular vectors returned by . - The B matrix. - The number of columns of B. - On exit, the solution matrix. - - - - Computes the eigenvalues and eigenvectors of a matrix. - - Whether the matrix is symmetric or not. - The order of the matrix. - The matrix to decompose. The length of the array must be order * order. - On output, the matrix contains the eigen vectors. The length of the array must be order * order. - On output, the eigen values (λ) of matrix in ascending value. The length of the array must . - On output, the block diagonal eigenvalue matrix. The length of the array must be order * order. - - - - Symmetric Householder reduction to tridiagonal form. - - Data array of matrix V (eigenvectors) - Arrays for internal storage of real parts of eigenvalues - Arrays for internal storage of imaginary parts of eigenvalues - Order of initial matrix - This is derived from the Algol procedures tred2 by - Bowdler, Martin, Reinsch, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - Symmetric tridiagonal QL algorithm. - - Data array of matrix V (eigenvectors) - Arrays for internal storage of real parts of eigenvalues - Arrays for internal storage of imaginary parts of eigenvalues - Order of initial matrix - This is derived from the Algol procedures tql2, by - Bowdler, Martin, Reinsch, and Wilkinson, Handbook for - Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - - Nonsymmetric reduction to Hessenberg form. - - Data array of matrix V (eigenvectors) - Array for internal storage of nonsymmetric Hessenberg form. - Order of initial matrix - This is derived from the Algol procedures orthes and ortran, - by Martin and Wilkinson, Handbook for Auto. Comp., - Vol.ii-Linear Algebra, and the corresponding - Fortran subroutines in EISPACK. - - - - Nonsymmetric reduction from Hessenberg to real Schur form. - - Data array of matrix V (eigenvectors) - Array for internal storage of nonsymmetric Hessenberg form. - Arrays for internal storage of real parts of eigenvalues - Arrays for internal storage of imaginary parts of eigenvalues - Order of initial matrix - This is derived from the Algol procedure hqr2, - by Martin and Wilkinson, Handbook for Auto. Comp., - Vol.ii-Linear Algebra, and the corresponding - Fortran subroutine in EISPACK. - - - - - Complex scalar division X/Y. - - Real part of X - Imaginary part of X - Real part of Y - Imaginary part of Y - Division result as a number. - - - - Structure option. - - - - - Factorization option. - - - - - Solver step's substitution. - - - - - Solve a system, Ax = b. - - - - - Solve a transposed system, A'x = b - - - - - Solve a conjugate transposed system, A†x = b - - - - - Status values - - - - - The operation was successful. - - - - - Try to find out whether the provider is available, at least in principle. - Verification may still fail if available, but it will certainly fail if unavailable. - - - - - Initialize and verify that the provided is indeed available. If not, fall back to alternatives like the managed provider - - - - - Frees memory buffers, caches and handles allocated in or to the provider. - Does not unload the provider itself, it is still usable afterwards. - - - - - The managed sparse solver provider - - - - - Try to find out whether the provider is available, at least in principle. - Verification may still fail if available, but it will certainly fail if unavailable. - - - - - Initialize and verify that the provided is indeed available. If not, fall back to alternatives like the managed provider - - - - - Frees memory buffers, caches and handles allocated in or to the provider. - Does not unload the provider itself, it is still usable afterwards. - - - - - Optional path to try to load native provider binaries from, - if the provider specific hint path is not set. - If neither is set, Numerics falls back to the provider specific - environment variables, or the default probing paths. - - - - - Gets or sets the sparse solver provider. Consider to use UseNativeMKL or UseManaged instead. - - The linear algebra provider. - - - - Try to use a native provider, if available. - - - - - Use the best provider available. - - - - - Use a specific provider if configured, e.g. using the - "MathNetNumericsDSSProvider" environment variable, - or fall back to the best provider. - - - - - A random number generator based on the class in the .NET library. - - - - - Construct a new random number generator with a random seed. - - Uses and uses the value of - to set whether the instance is thread safe. - - - - Construct a new random number generator with random seed. - - The to use. - Uses the value of to set whether the instance is thread safe. - - - - Construct a new random number generator with random seed. - - Uses - if set to true , the class is thread safe. - - - - Construct a new random number generator with random seed. - - The to use. - if set to true , the class is thread safe. - - - - Fills the elements of a specified array of bytes with random numbers in full range, including zero and 255 (). - - - - - Returns a random double-precision floating point number greater than or equal to 0.0, and less than 1.0. - - - - - Returns a random 32-bit signed integer greater than or equal to zero and less than - - - - - Fills an array with random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an array of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an infinite sequence of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Multiplicative congruential generator using a modulus of 2^31-1 and a multiplier of 1132489760. - - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - if set to true , the class is thread safe. - - - - Initializes a new instance of the class. - - The seed value. - If the seed value is zero, it is set to one. Uses the - value of to - set whether the instance is thread safe. - - - - Initializes a new instance of the class. - - The seed value. - if set to true, the class is thread safe. - - - - Returns a random double-precision floating point number greater than or equal to 0.0, and less than 1.0. - - - - - Fills an array with random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an array of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an infinite sequence of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads, but the result must be enumerated from a single thread each. - - - - Multiplicative congruential generator using a modulus of 2^59 and a multiplier of 13^13. - - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - if set to true , the class is thread safe. - - - - Initializes a new instance of the class. - - The seed value. - If the seed value is zero, it is set to one. Uses the - value of to - set whether the instance is thread safe. - - - - Initializes a new instance of the class. - - The seed value. - The seed is set to 1, if the zero is used as the seed. - if set to true , the class is thread safe. - - - - Returns a random double-precision floating point number greater than or equal to 0.0, and less than 1.0. - - - - - Fills an array with random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an array of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an infinite sequence of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads, but the result must be enumerated from a single thread each. - - - - Random number generator using Mersenne Twister 19937 algorithm. - - - - - Mersenne twister constant. - - - - - Mersenne twister constant. - - - - - Mersenne twister constant. - - - - - Mersenne twister constant. - - - - - Mersenne twister constant. - - - - - Mersenne twister constant. - - - - - Mersenne twister constant. - - - - - Mersenne twister constant. - - - - - Mersenne twister constant. - - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - If the seed value is zero, it is set to one. Uses the - value of to - set whether the instance is thread safe. - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - if set to true , the class is thread safe. - - - - Initializes a new instance of the class. - - The seed value. - Uses the value of to - set whether the instance is thread safe. - - - - Initializes a new instance of the class. - - The seed value. - if set to true, the class is thread safe. - - - - Default instance, thread-safe. - - - - - Returns a random double-precision floating point number greater than or equal to 0.0, and less than 1.0. - - - - - Returns a random 32-bit signed integer greater than or equal to zero and less than - - - - - Fills the elements of a specified array of bytes with random numbers in full range, including zero and 255 (). - - - - - Fills an array with random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an array of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an infinite sequence of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads, but the result must be enumerated from a single thread each. - - - - A 32-bit combined multiple recursive generator with 2 components of order 3. - - Based off of P. L'Ecuyer, "Combined Multiple Recursive Random Number Generators," Operations Research, 44, 5 (1996), 816--822. - - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - If the seed value is zero, it is set to one. Uses the - value of to - set whether the instance is thread safe. - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - if set to true , the class is thread safe. - - - - Initializes a new instance of the class. - - The seed value. - If the seed value is zero, it is set to one. Uses the - value of to - set whether the instance is thread safe. - - - - Initializes a new instance of the class. - - The seed value. - if set to true, the class is thread safe. - - - - Returns a random double-precision floating point number greater than or equal to 0.0, and less than 1.0. - - - - - Fills an array with random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an array of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an infinite sequence of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads, but the result must be enumerated from a single thread each. - - - - Represents a Parallel Additive Lagged Fibonacci pseudo-random number generator. - - - The type bases upon the implementation in the - Boost Random Number Library. - It uses the modulus 232 and by default the "lags" 418 and 1279. Some popular pairs are presented on - Wikipedia - Lagged Fibonacci generator. - - - - - Default value for the ShortLag - - - - - Default value for the LongLag - - - - - The multiplier to compute a double-precision floating point number [0, 1) - - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - If the seed value is zero, it is set to one. Uses the - value of to - set whether the instance is thread safe. - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - if set to true , the class is thread safe. - - - - Initializes a new instance of the class. - - The seed value. - If the seed value is zero, it is set to one. Uses the - value of to - set whether the instance is thread safe. - - - - Initializes a new instance of the class. - - The seed value. - if set to true , the class is thread safe. - - - - Initializes a new instance of the class. - - The seed value. - if set to true, the class is thread safe. - The ShortLag value - TheLongLag value - - - - Gets the short lag of the Lagged Fibonacci pseudo-random number generator. - - - - - Gets the long lag of the Lagged Fibonacci pseudo-random number generator. - - - - - Stores an array of random numbers - - - - - Stores an index for the random number array element that will be accessed next. - - - - - Fills the array with new unsigned random numbers. - - - Generated random numbers are 32-bit unsigned integers greater than or equal to 0 - and less than or equal to . - - - - - Returns a random double-precision floating point number greater than or equal to 0.0, and less than 1.0. - - - - - Returns a random 32-bit signed integer greater than or equal to zero and less than - - - - - Fills an array with random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an array of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an infinite sequence of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads, but the result must be enumerated from a single thread each. - - - - This class implements extension methods for the System.Random class. The extension methods generate - pseudo-random distributed numbers for types other than double and int32. - - - - - Fills an array with uniform random numbers greater than or equal to 0.0 and less than 1.0. - - The random number generator. - The array to fill with random values. - - This extension is thread-safe if and only if called on an random number - generator provided by Math.NET Numerics or derived from the RandomSource class. - - - - - Returns an array of uniform random numbers greater than or equal to 0.0 and less than 1.0. - - The random number generator. - The size of the array to fill. - - This extension is thread-safe if and only if called on an random number - generator provided by Math.NET Numerics or derived from the RandomSource class. - - - - - Returns an infinite sequence of uniform random numbers greater than or equal to 0.0 and less than 1.0. - - - This extension is thread-safe if and only if called on an random number - generator provided by Math.NET Numerics or derived from the RandomSource class. - - - - - Returns an array of uniform random bytes. - - The random number generator. - The size of the array to fill. - - This extension is thread-safe if and only if called on an random number - generator provided by Math.NET Numerics or derived from the RandomSource class. - - - - - Fills an array with uniform random 32-bit signed integers greater than or equal to zero and less than . - - The random number generator. - The array to fill with random values. - - This extension is thread-safe if and only if called on an random number - generator provided by Math.NET Numerics or derived from the RandomSource class. - - - - - Fills an array with uniform random 32-bit signed integers within the specified range. - - The random number generator. - The array to fill with random values. - Lower bound, inclusive. - Upper bound, exclusive. - - This extension is thread-safe if and only if called on an random number - generator provided by Math.NET Numerics or derived from the RandomSource class. - - - - - Returns an infinite sequence of uniform random 32-bit signed integers within the specified range. - - - This extension is thread-safe if and only if called on an random number - generator provided by Math.NET Numerics or derived from the RandomSource class. - - - - - Returns an infinite sequence of uniform random within the specified range. - - - This extension is thread-safe if and only if called on an random number - generator provided by Math.NET Numerics or derived from the RandomSource class. - - - - - Returns a nonnegative random number less than . - - The random number generator. - - A 64-bit signed integer greater than or equal to 0, and less than ; that is, - the range of return values includes 0 but not . - - - - This extension is thread-safe if and only if called on an random number - generator provided by Math.NET Numerics or derived from the RandomSource class. - - - - - Returns a random number of the full Int32 range. - - The random number generator. - - A 32-bit signed integer of the full range, including 0, negative numbers, - and . - - - - This extension is thread-safe if and only if called on an random number - generator provided by Math.NET Numerics or derived from the RandomSource class. - - - - - Returns a random number of the full Int64 range. - - The random number generator. - - A 64-bit signed integer of the full range, including 0, negative numbers, - and . - - - - This extension is thread-safe if and only if called on an random number - generator provided by Math.NET Numerics or derived from the RandomSource class. - - - - - Returns a nonnegative decimal floating point random number less than 1.0. - - The random number generator. - - A decimal floating point number greater than or equal to 0.0, and less than 1.0; that is, - the range of return values includes 0.0 but not 1.0. - - - This extension is thread-safe if and only if called on an random number - generator provided by Math.NET Numerics or derived from the RandomSource class. - - - - - Returns a random boolean. - - The random number generator. - - This extension is thread-safe if and only if called on an random number - generator provided by Math.NET Numerics or derived from the RandomSource class. - - - - - Provides a time-dependent seed value, matching the default behavior of System.Random. - WARNING: There is no randomness in this seed and quick repeated calls can cause - the same seed value. Do not use for cryptography! - - - - - Provides a seed based on time and unique GUIDs. - WARNING: There is only low randomness in this seed, but at least quick repeated - calls will result in different seed values. Do not use for cryptography! - - - - - Provides a seed based on an internal random number generator (crypto if available), time and unique GUIDs. - WARNING: There is only medium randomness in this seed, but quick repeated - calls will result in different seed values. Do not use for cryptography! - - - - - Base class for random number generators. This class introduces a layer between - and the Math.NET Numerics random number generators to provide thread safety. - When used directly it use the System.Random as random number source. - - - - - Initializes a new instance of the class using - the value of to set whether - the instance is thread safe or not. - - - - - Initializes a new instance of the class. - - if set to true , the class is thread safe. - Thread safe instances are two and half times slower than non-thread - safe classes. - - - - Fills an array with uniform random numbers greater than or equal to 0.0 and less than 1.0. - - The array to fill with random values. - - - - Returns an array of uniform random numbers greater than or equal to 0.0 and less than 1.0. - - The size of the array to fill. - - - - Returns an infinite sequence of uniform random numbers greater than or equal to 0.0 and less than 1.0. - - - - - Returns a random 32-bit signed integer greater than or equal to zero and less than . - - - - - Returns a random number less then a specified maximum. - - The exclusive upper bound of the random number returned. Range: maxExclusive ≥ 1. - A 32-bit signed integer less than . - is zero or negative. - - - - Returns a random number within a specified range. - - The inclusive lower bound of the random number returned. - The exclusive upper bound of the random number returned. Range: maxExclusive > minExclusive. - - A 32-bit signed integer greater than or equal to and less than ; that is, the range of return values includes but not . If equals , is returned. - - is greater than . - - - - Fills an array with random 32-bit signed integers greater than or equal to zero and less than . - - The array to fill with random values. - - - - Returns an array with random 32-bit signed integers greater than or equal to zero and less than . - - The size of the array to fill. - - - - Fills an array with random numbers within a specified range. - - The array to fill with random values. - The exclusive upper bound of the random number returned. Range: maxExclusive ≥ 1. - - - - Returns an array with random 32-bit signed integers within the specified range. - - The size of the array to fill. - The exclusive upper bound of the random number returned. Range: maxExclusive ≥ 1. - - - - Fills an array with random numbers within a specified range. - - The array to fill with random values. - The inclusive lower bound of the random number returned. - The exclusive upper bound of the random number returned. Range: maxExclusive > minExclusive. - - - - Returns an array with random 32-bit signed integers within the specified range. - - The size of the array to fill. - The inclusive lower bound of the random number returned. - The exclusive upper bound of the random number returned. Range: maxExclusive > minExclusive. - - - - Returns an infinite sequence of random 32-bit signed integers greater than or equal to zero and less than . - - - - - Returns an infinite sequence of random numbers within a specified range. - - The inclusive lower bound of the random number returned. - The exclusive upper bound of the random number returned. Range: maxExclusive > minExclusive. - - - - Fills the elements of a specified array of bytes with random numbers. - - An array of bytes to contain random numbers. - is null. - - - - Returns a random number between 0.0 and 1.0. - - A double-precision floating point number greater than or equal to 0.0, and less than 1.0. - - - - Returns a random double-precision floating point number greater than or equal to 0.0, and less than 1.0. - - - - - Returns a random 32-bit signed integer greater than or equal to zero and less than 2147483647 (). - - - - - Fills the elements of a specified array of bytes with random numbers in full range, including zero and 255 (). - - - - - Returns a random N-bit signed integer greater than or equal to zero and less than 2^N. - N (bit count) is expected to be greater than zero and less than 32 (not verified). - - - - - Returns a random N-bit signed long integer greater than or equal to zero and less than 2^N. - N (bit count) is expected to be greater than zero and less than 64 (not verified). - - - - - Returns a random 32-bit signed integer within the specified range. - - The exclusive upper bound of the random number returned. Range: maxExclusive ≥ 2 (not verified, must be ensured by caller). - - - - Returns a random 32-bit signed integer within the specified range. - - The inclusive lower bound of the random number returned. - The exclusive upper bound of the random number returned. Range: maxExclusive ≥ minExclusive + 2 (not verified, must be ensured by caller). - - - - A random number generator based on the class in the .NET library. - - - - - Construct a new random number generator with a random seed. - - - - - Construct a new random number generator with random seed. - - if set to true , the class is thread safe. - - - - Construct a new random number generator with random seed. - - The seed value. - - - - Construct a new random number generator with random seed. - - The seed value. - if set to true , the class is thread safe. - - - - Default instance, thread-safe. - - - - - Returns a random double-precision floating point number greater than or equal to 0.0, and less than 1.0. - - - - - Returns a random 32-bit signed integer greater than or equal to zero and less than - - - - - Returns a random 32-bit signed integer within the specified range. - - The exclusive upper bound of the random number returned. Range: maxExclusive ≥ 2 (not verified, must be ensured by caller). - - - - Returns a random 32-bit signed integer within the specified range. - - The inclusive lower bound of the random number returned. - The exclusive upper bound of the random number returned. Range: maxExclusive ≥ minExclusive + 2 (not verified, must be ensured by caller). - - - - Fills the elements of a specified array of bytes with random numbers in full range, including zero and 255 (). - - - - - Fill an array with uniform random numbers greater than or equal to 0.0 and less than 1.0. - WARNING: potentially very short random sequence length, can generate repeated partial sequences. - - Parallelized on large length, but also supports being called in parallel from multiple threads - - - - Returns an array of uniform random numbers greater than or equal to 0.0 and less than 1.0. - WARNING: potentially very short random sequence length, can generate repeated partial sequences. - - Parallelized on large length, but also supports being called in parallel from multiple threads - - - - Returns an infinite sequence of uniform random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads, but the result must be enumerated from a single thread each. - - - - Fills an array with random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an array of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an infinite sequence of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads, but the result must be enumerated from a single thread each. - - - - Wichmann-Hill’s 1982 combined multiplicative congruential generator. - - See: Wichmann, B. A. & Hill, I. D. (1982), "Algorithm AS 183: - An efficient and portable pseudo-random number generator". Applied Statistics 31 (1982) 188-190 - - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - if set to true , the class is thread safe. - - - - Initializes a new instance of the class. - - The seed value. - If the seed value is zero, it is set to one. Uses the - value of to - set whether the instance is thread safe. - - - - Initializes a new instance of the class. - - The seed value. - The seed is set to 1, if the zero is used as the seed. - if set to true , the class is thread safe. - - - - Returns a random double-precision floating point number greater than or equal to 0.0, and less than 1.0. - - - - - Fills an array with random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an array of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an infinite sequence of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads, but the result must be enumerated from a single thread each. - - - - Wichmann-Hill’s 2006 combined multiplicative congruential generator. - - See: Wichmann, B. A. & Hill, I. D. (2006), "Generating good pseudo-random numbers". - Computational Statistics & Data Analysis 51:3 (2006) 1614-1622 - - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - if set to true , the class is thread safe. - - - - Initializes a new instance of the class. - - The seed value. - If the seed value is zero, it is set to one. Uses the - value of to - set whether the instance is thread safe. - - - - Initializes a new instance of the class. - - The seed value. - The seed is set to 1, if the zero is used as the seed. - if set to true , the class is thread safe. - - - - Returns a random double-precision floating point number greater than or equal to 0.0, and less than 1.0. - - - - - Fills an array with random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an array of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an infinite sequence of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads, but the result must be enumerated from a single thread each. - - - - Implements a multiply-with-carry Xorshift pseudo random number generator (RNG) specified in Marsaglia, George. (2003). Xorshift RNGs. - Xn = a * Xn−3 + c mod 2^32 - http://www.jstatsoft.org/v08/i14/paper - - - - - The default value for X1. - - - - - The default value for X2. - - - - - The default value for the multiplier. - - - - - The default value for the carry over. - - - - - The multiplier to compute a double-precision floating point number [0, 1) - - - - - Seed or last but three unsigned random number. - - - - - Last but two unsigned random number. - - - - - Last but one unsigned random number. - - - - - The value of the carry over. - - - - - The multiplier. - - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - If the seed value is zero, it is set to one. Uses the - value of to - set whether the instance is thread safe. - Uses the default values of: - - a = 916905990 - c = 13579 - X1 = 77465321 - X2 = 362436069 - - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - The multiply value - The initial carry value. - The initial value if X1. - The initial value if X2. - If the seed value is zero, it is set to one. Uses the - value of to - set whether the instance is thread safe. - Note: must be less than . - - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - if set to true , the class is thread safe. - - Uses the default values of: - - a = 916905990 - c = 13579 - X1 = 77465321 - X2 = 362436069 - - - - - Initializes a new instance of the class using - a seed based on time and unique GUIDs. - - if set to true , the class is thread safe. - The multiply value - The initial carry value. - The initial value if X1. - The initial value if X2. - must be less than . - - - - Initializes a new instance of the class. - - The seed value. - If the seed value is zero, it is set to one. Uses the - value of to - set whether the instance is thread safe. - Uses the default values of: - - a = 916905990 - c = 13579 - X1 = 77465321 - X2 = 362436069 - - - - - Initializes a new instance of the class. - - The seed value. - If the seed value is zero, it is set to one. Uses the - value of to - set whether the instance is thread safe. - The multiply value - The initial carry value. - The initial value if X1. - The initial value if X2. - must be less than . - - - - Initializes a new instance of the class. - - The seed value. - if set to true, the class is thread safe. - - Uses the default values of: - - a = 916905990 - c = 13579 - X1 = 77465321 - X2 = 362436069 - - - - - Initializes a new instance of the class. - - The seed value. - if set to true, the class is thread safe. - The multiply value - The initial carry value. - The initial value if X1. - The initial value if X2. - must be less than . - - - - Returns a random double-precision floating point number greater than or equal to 0.0, and less than 1.0. - - - - - Returns a random 32-bit signed integer greater than or equal to zero and less than - - - - - Fills the elements of a specified array of bytes with random numbers in full range, including zero and 255 (). - - - - - Fills an array with random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an array of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an infinite sequence of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads, but the result must be enumerated from a single thread each. - - - - Xoshiro256** pseudo random number generator. - A random number generator based on the class in the .NET library. - - - This is xoshiro256** 1.0, our all-purpose, rock-solid generator. It has - excellent(sub-ns) speed, a state space(256 bits) that is large enough - for any parallel application, and it passes all tests we are aware of. - - For generating just floating-point numbers, xoshiro256+ is even faster. - - The state must be seeded so that it is not everywhere zero.If you have - a 64-bit seed, we suggest to seed a splitmix64 generator and use its - output to fill s. - - For further details see: - David Blackman & Sebastiano Vigna (2018), "Scrambled Linear Pseudorandom Number Generators". - https://arxiv.org/abs/1805.01407 - - - - - Construct a new random number generator with a random seed. - - - - - Construct a new random number generator with random seed. - - if set to true , the class is thread safe. - - - - Construct a new random number generator with random seed. - - The seed value. - - - - Construct a new random number generator with random seed. - - The seed value. - if set to true , the class is thread safe. - - - - Returns a random double-precision floating point number greater than or equal to 0.0, and less than 1.0. - - - - - Returns a random 32-bit signed integer greater than or equal to zero and less than - - - - - Fills the elements of a specified array of bytes with random numbers in full range, including zero and 255 (). - - - - - Returns a random N-bit signed integer greater than or equal to zero and less than 2^N. - N (bit count) is expected to be greater than zero and less than 32 (not verified). - - - - - Returns a random N-bit signed long integer greater than or equal to zero and less than 2^N. - N (bit count) is expected to be greater than zero and less than 64 (not verified). - - - - - Fills an array with random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an array of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads. - - - - Returns an infinite sequence of random numbers greater than or equal to 0.0 and less than 1.0. - - Supports being called in parallel from multiple threads, but the result must be enumerated from a single thread each. - - - - Splitmix64 RNG. - - RNG state. This can take any value, including zero. - A new random UInt64. - - Splitmix64 produces equidistributed outputs, thus if a zero is generated then the - next zero will be after a further 2^64 outputs. - - - - - Bisection root-finding algorithm. - - - - Find a solution of the equation f(x)=0. - The function to find roots from. - Guess for the low value of the range where the root is supposed to be. Will be expanded if needed. - Guess for the high value of the range where the root is supposed to be. Will be expanded if needed. - Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Default 1e-8. Must be greater than 0. - Maximum number of iterations. Default 100. - Factor at which to expand the bounds, if needed. Default 1.6. - Maximum number of expand iterations. Default 100. - Returns the root with the specified accuracy. - - - - Find a solution of the equation f(x)=0. - The function to find roots from. - The low value of the range where the root is supposed to be. - The high value of the range where the root is supposed to be. - Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Default 1e-8. Must be greater than 0. - Maximum number of iterations. Default 100. - Returns the root with the specified accuracy. - - - - Find a solution of the equation f(x)=0. - The function to find roots from. - The low value of the range where the root is supposed to be. - The high value of the range where the root is supposed to be. - Desired accuracy for both the root and the function value at the root. The root will be refined until the accuracy or the maximum number of iterations is reached. Must be greater than 0. - Maximum number of iterations. Usually 100. - The root that was found, if any. Undefined if the function returns false. - True if a root with the specified accuracy was found, else false. - - - - Algorithm by Brent, Van Wijngaarden, Dekker et al. - Implementation inspired by Press, Teukolsky, Vetterling, and Flannery, "Numerical Recipes in C", 2nd edition, Cambridge University Press - - - - Find a solution of the equation f(x)=0. - The function to find roots from. - Guess for the low value of the range where the root is supposed to be. Will be expanded if needed. - Guess for the high value of the range where the root is supposed to be. Will be expanded if needed. - Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Default 1e-8. Must be greater than 0. - Maximum number of iterations. Default 100. - Factor at which to expand the bounds, if needed. Default 1.6. - Maximum number of expand iterations. Default 100. - Returns the root with the specified accuracy. - - - - Find a solution of the equation f(x)=0. - The function to find roots from. - The low value of the range where the root is supposed to be. - The high value of the range where the root is supposed to be. - Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Default 1e-8. Must be greater than 0. - Maximum number of iterations. Default 100. - Returns the root with the specified accuracy. - - - - Find a solution of the equation f(x)=0. - The function to find roots from. - The low value of the range where the root is supposed to be. - The high value of the range where the root is supposed to be. - Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Must be greater than 0. - Maximum number of iterations. Usually 100. - The root that was found, if any. Undefined if the function returns false. - True if a root with the specified accuracy was found, else false. - - - Helper method useful for preventing rounding errors. - a*sign(b) - - - - Algorithm by Broyden. - Implementation inspired by Press, Teukolsky, Vetterling, and Flannery, "Numerical Recipes in C", 2nd edition, Cambridge University Press - - - - Find a solution of the equation f(x)=0. - The function to find roots from. - Initial guess of the root. - Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Default 1e-8. Must be greater than 0. - Maximum number of iterations. Default 100. - Relative step size for calculating the Jacobian matrix at first step. Default 1.0e-4 - Returns the root with the specified accuracy. - - - - Find a solution of the equation f(x)=0. - The function to find roots from. - Initial guess of the root. - Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Must be greater than 0. - Maximum number of iterations. Usually 100. - Relative step size for calculating the Jacobian matrix at first step. - The root that was found, if any. Undefined if the function returns false. - True if a root with the specified accuracy was found, else false. - - - Find a solution of the equation f(x)=0. - The function to find roots from. - Initial guess of the root. - Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Must be greater than 0. - Maximum number of iterations. Usually 100. - The root that was found, if any. Undefined if the function returns false. - True if a root with the specified accuracy was found, else false. - - - - Helper method to calculate an approximation of the Jacobian. - - The function. - The argument (initial guess). - The result (of initial guess). - Relative step size for calculating the Jacobian. - - - - Finds roots to the cubic equation x^3 + a2*x^2 + a1*x + a0 = 0 - Implements the cubic formula in http://mathworld.wolfram.com/CubicFormula.html - - - - - Q and R are transformed variables. - - - - - n^(1/3) - work around a negative double raised to (1/3) - - - - - Find all real-valued roots of the cubic equation a0 + a1*x + a2*x^2 + x^3 = 0. - Note the special coefficient order ascending by exponent (consistent with polynomials). - - - - - Find all three complex roots of the cubic equation d + c*x + b*x^2 + a*x^3 = 0. - Note the special coefficient order ascending by exponent (consistent with polynomials). - - - - - Pure Newton-Raphson root-finding algorithm without any recovery measures in cases it behaves badly. - The algorithm aborts immediately if the root leaves the bound interval. - - - - - Find a solution of the equation f(x)=0. - The function to find roots from. - The first derivative of the function to find roots from. - The low value of the range where the root is supposed to be. Aborts if it leaves the interval. - The high value of the range where the root is supposed to be. Aborts if it leaves the interval. - Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Default 1e-8. Must be greater than 0. - Maximum number of iterations. Default 100. - Returns the root with the specified accuracy. - - - - Find a solution of the equation f(x)=0. - The function to find roots from. - The first derivative of the function to find roots from. - Initial guess of the root. - The low value of the range where the root is supposed to be. Aborts if it leaves the interval. Default MinValue. - The high value of the range where the root is supposed to be. Aborts if it leaves the interval. Default MaxValue. - Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Default 1e-8. Must be greater than 0. - Maximum number of iterations. Default 100. - Returns the root with the specified accuracy. - - - - Find a solution of the equation f(x)=0. - The function to find roots from. - The first derivative of the function to find roots from. - Initial guess of the root. - The low value of the range where the root is supposed to be. Aborts if it leaves the interval. - The high value of the range where the root is supposed to be. Aborts if it leaves the interval. - Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Example: 1e-14. Must be greater than 0. - Maximum number of iterations. Example: 100. - The root that was found, if any. Undefined if the function returns false. - True if a root with the specified accuracy was found, else false. - - - - Robust Newton-Raphson root-finding algorithm that falls back to bisection when overshooting or converging too slow, or to subdivision on lacking bracketing. - - - - - Find a solution of the equation f(x)=0. - The function to find roots from. - The first derivative of the function to find roots from. - The low value of the range where the root is supposed to be. - The high value of the range where the root is supposed to be. - Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Default 1e-8. Must be greater than 0. - Maximum number of iterations. Default 100. - How many parts an interval should be split into for zero crossing scanning in case of lacking bracketing. Default 20. - Returns the root with the specified accuracy. - - - - Find a solution of the equation f(x)=0. - The function to find roots from. - The first derivative of the function to find roots from. - The low value of the range where the root is supposed to be. - The high value of the range where the root is supposed to be. - Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Example: 1e-14. Must be greater than 0. - Maximum number of iterations. Example: 100. - How many parts an interval should be split into for zero crossing scanning in case of lacking bracketing. Example: 20. - The root that was found, if any. Undefined if the function returns false. - True if a root with the specified accuracy was found, else false. - - - - Pure Secant root-finding algorithm without any recovery measures in cases it behaves badly. - The algorithm aborts immediately if the root leaves the bound interval. - - - - - Find a solution of the equation f(x)=0. - The function to find roots from. - The first guess of the root within the bounds specified. - The second guess of the root within the bounds specified. - The low value of the range where the root is supposed to be. Aborts if it leaves the interval. Default MinValue. - The high value of the range where the root is supposed to be. Aborts if it leaves the interval. Default MaxValue. - Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Default 1e-8. Must be greater than 0. - Maximum number of iterations. Default 100. - Returns the root with the specified accuracy. - - - - Find a solution of the equation f(x)=0. - The function to find roots from. - The first guess of the root within the bounds specified. - The second guess of the root within the bounds specified. - The low value of the range where the root is supposed to be. Aborts if it leaves the interval. - The low value of the range where the root is supposed to be. Aborts if it leaves the interval. - Desired accuracy. The root will be refined until the accuracy or the maximum number of iterations is reached. Example: 1e-14. Must be greater than 0. - Maximum number of iterations. Example: 100. - The root that was found, if any. Undefined if the function returns false. - True if a root with the specified accuracy was found, else false - - - Detect a range containing at least one root. - The function to detect roots from. - Lower value of the range. - Upper value of the range - The growing factor of research. Usually 1.6. - Maximum number of iterations. Usually 50. - True if the bracketing operation succeeded, false otherwise. - This iterative methods stops when two values with opposite signs are found. - - - - Numerically stable series summation (stops automatically). - - provides the summands sequentially - Sum - - - - Numerically stable series summation (stops automatically). - - provides the summands sequentially - Sum - - - - Sorting algorithms for single, tuple and triple lists. - - - - - Sort a list of keys, in place using the quick sort algorithm using the quick sort algorithm. - - The type of elements in the key list. - List to sort. - Comparison, defining the sort order. - - - - Sort a list of keys and items with respect to the keys, in place using the quick sort algorithm. - - The type of elements in the key list. - The type of elements in the item list. - List to sort. - List to permute the same way as the key list. - Comparison, defining the sort order. - - - - Sort a list of keys, items1 and items2 with respect to the keys, in place using the quick sort algorithm. - - The type of elements in the key list. - The type of elements in the first item list. - The type of elements in the second item list. - List to sort. - First list to permute the same way as the key list. - Second list to permute the same way as the key list. - Comparison, defining the sort order. - - - - Sort a range of a list of keys, in place using the quick sort algorithm. - - The type of element in the list. - List to sort. - The zero-based starting index of the range to sort. - The length of the range to sort. - Comparison, defining the sort order. - - - - Sort a list of keys and items with respect to the keys, in place using the quick sort algorithm. - - The type of elements in the key list. - The type of elements in the item list. - List to sort. - List to permute the same way as the key list. - The zero-based starting index of the range to sort. - The length of the range to sort. - Comparison, defining the sort order. - - - - Sort a list of keys, items1 and items2 with respect to the keys, in place using the quick sort algorithm. - - The type of elements in the key list. - The type of elements in the first item list. - The type of elements in the second item list. - List to sort. - First list to permute the same way as the key list. - Second list to permute the same way as the key list. - The zero-based starting index of the range to sort. - The length of the range to sort. - Comparison, defining the sort order. - - - - Sort a list of keys and items with respect to the keys, in place using the quick sort algorithm. - - The type of elements in the primary list. - The type of elements in the secondary list. - List to sort. - List to sort on duplicate primary items, and permute the same way as the key list. - Comparison, defining the primary sort order. - Comparison, defining the secondary sort order. - - - - Recursive implementation for an in place quick sort on a list. - - The type of the list on which the quick sort is performed. - The list which is sorted using quick sort. - The method with which to compare two elements of the quick sort. - The left boundary of the quick sort. - The right boundary of the quick sort. - - - - Recursive implementation for an in place quick sort on a list while reordering one other list accordingly. - - The type of the list on which the quick sort is performed. - The type of the list which is automatically reordered accordingly. - The list which is sorted using quick sort. - The list which is automatically reordered accordingly. - The method with which to compare two elements of the quick sort. - The left boundary of the quick sort. - The right boundary of the quick sort. - - - - Recursive implementation for an in place quick sort on one list while reordering two other lists accordingly. - - The type of the list on which the quick sort is performed. - The type of the first list which is automatically reordered accordingly. - The type of the second list which is automatically reordered accordingly. - The list which is sorted using quick sort. - The first list which is automatically reordered accordingly. - The second list which is automatically reordered accordingly. - The method with which to compare two elements of the quick sort. - The left boundary of the quick sort. - The right boundary of the quick sort. - - - - Recursive implementation for an in place quick sort on the primary and then by the secondary list while reordering one secondary list accordingly. - - The type of the primary list. - The type of the secondary list. - The list which is sorted using quick sort. - The list which is sorted secondarily (on primary duplicates) and automatically reordered accordingly. - The method with which to compare two elements of the primary list. - The method with which to compare two elements of the secondary list. - The left boundary of the quick sort. - The right boundary of the quick sort. - - - - Performs an in place swap of two elements in a list. - - The type of elements stored in the list. - The list in which the elements are stored. - The index of the first element of the swap. - The index of the second element of the swap. - - - - This partial implementation of the SpecialFunctions class contains all methods related to the Airy functions. - - - This partial implementation of the SpecialFunctions class contains all methods related to the Bessel functions. - - - This partial implementation of the SpecialFunctions class contains all methods related to the error function. - - - This partial implementation of the SpecialFunctions class contains all methods related to the Hankel function. - - - This partial implementation of the SpecialFunctions class contains all methods related to the harmonic function. - - - This partial implementation of the SpecialFunctions class contains all methods related to the modified Bessel function. - - - This partial implementation of the SpecialFunctions class contains all methods related to the log1p function. - - - This partial implementation of the SpecialFunctions class contains all methods related to the logistic function. - - - This partial implementation of the SpecialFunctions class contains all methods related to the Marcum-Q functions. - - - This partial implementation of the SpecialFunctions class contains all methods related to the modified Bessel function. - - - This partial implementation of the SpecialFunctions class contains all methods related to the modified Bessel function. - - - This partial implementation of the SpecialFunctions class contains all methods related to the spherical Bessel functions. - - - - - Returns the Airy function Ai. - AiryAi(z) is a solution to the Airy equation, y'' - y * z = 0. - - The value to compute the Airy function of. - The Airy function Ai. - - - - Returns the exponentially scaled Airy function Ai. - ScaledAiryAi(z) is given by Exp(zta) * AiryAi(z), where zta = (2/3) * z * Sqrt(z). - - The value to compute the Airy function of. - The exponentially scaled Airy function Ai. - - - - Returns the Airy function Ai. - AiryAi(z) is a solution to the Airy equation, y'' - y * z = 0. - - The value to compute the Airy function of. - The Airy function Ai. - - - - Returns the exponentially scaled Airy function Ai. - ScaledAiryAi(z) is given by Exp(zta) * AiryAi(z), where zta = (2/3) * z * Sqrt(z). - - The value to compute the Airy function of. - The exponentially scaled Airy function Ai. - - - - Returns the derivative of the Airy function Ai. - AiryAiPrime(z) is defined as d/dz AiryAi(z). - - The value to compute the derivative of the Airy function of. - The derivative of the Airy function Ai. - - - - Returns the exponentially scaled derivative of Airy function Ai - ScaledAiryAiPrime(z) is given by Exp(zta) * AiryAiPrime(z), where zta = (2/3) * z * Sqrt(z). - - The value to compute the derivative of the Airy function of. - The exponentially scaled derivative of Airy function Ai. - - - - Returns the derivative of the Airy function Ai. - AiryAiPrime(z) is defined as d/dz AiryAi(z). - - The value to compute the derivative of the Airy function of. - The derivative of the Airy function Ai. - - - - Returns the exponentially scaled derivative of the Airy function Ai. - ScaledAiryAiPrime(z) is given by Exp(zta) * AiryAiPrime(z), where zta = (2/3) * z * Sqrt(z). - - The value to compute the derivative of the Airy function of. - The exponentially scaled derivative of the Airy function Ai. - - - - Returns the Airy function Bi. - AiryBi(z) is a solution to the Airy equation, y'' - y * z = 0. - - The value to compute the Airy function of. - The Airy function Bi. - - - - Returns the exponentially scaled Airy function Bi. - ScaledAiryBi(z) is given by Exp(-Abs(zta.Real)) * AiryBi(z) where zta = (2 / 3) * z * Sqrt(z). - - The value to compute the Airy function of. - The exponentially scaled Airy function Bi(z). - - - - Returns the Airy function Bi. - AiryBi(z) is a solution to the Airy equation, y'' - y * z = 0. - - The value to compute the Airy function of. - The Airy function Bi. - - - - Returns the exponentially scaled Airy function Bi. - ScaledAiryBi(z) is given by Exp(-Abs(zta.Real)) * AiryBi(z) where zta = (2 / 3) * z * Sqrt(z). - - The value to compute the Airy function of. - The exponentially scaled Airy function Bi. - - - - Returns the derivative of the Airy function Bi. - AiryBiPrime(z) is defined as d/dz AiryBi(z). - - The value to compute the derivative of the Airy function of. - The derivative of the Airy function Bi. - - - - Returns the exponentially scaled derivative of the Airy function Bi. - ScaledAiryBiPrime(z) is given by Exp(-Abs(zta.Real)) * AiryBiPrime(z) where zta = (2 / 3) * z * Sqrt(z). - - The value to compute the derivative of the Airy function of. - The exponentially scaled derivative of the Airy function Bi. - - - - Returns the derivative of the Airy function Bi. - AiryBiPrime(z) is defined as d/dz AiryBi(z). - - The value to compute the derivative of the Airy function of. - The derivative of the Airy function Bi. - - - - Returns the exponentially scaled derivative of the Airy function Bi. - ScaledAiryBiPrime(z) is given by Exp(-Abs(zta.Real)) * AiryBiPrime(z) where zta = (2 / 3) * z * Sqrt(z). - - The value to compute the derivative of the Airy function of. - The exponentially scaled derivative of the Airy function Bi. - - - - Returns the Bessel function of the first kind. - BesselJ(n, z) is a solution to the Bessel differential equation. - - The order of the Bessel function. - The value to compute the Bessel function of. - The Bessel function of the first kind. - - - - Returns the exponentially scaled Bessel function of the first kind. - ScaledBesselJ(n, z) is given by Exp(-Abs(z.Imaginary)) * BesselJ(n, z). - - The order of the Bessel function. - The value to compute the Bessel function of. - The exponentially scaled Bessel function of the first kind. - - - - Returns the Bessel function of the first kind. - BesselJ(n, z) is a solution to the Bessel differential equation. - - The order of the Bessel function. - The value to compute the Bessel function of. - The Bessel function of the first kind. - - - - Returns the exponentially scaled Bessel function of the first kind. - ScaledBesselJ(n, z) is given by Exp(-Abs(z.Imaginary)) * BesselJ(n, z). - - The order of the Bessel function. - The value to compute the Bessel function of. - The exponentially scaled Bessel function of the first kind. - - - - Returns the Bessel function of the second kind. - BesselY(n, z) is a solution to the Bessel differential equation. - - The order of the Bessel function. - The value to compute the Bessel function of. - The Bessel function of the second kind. - - - - Returns the exponentially scaled Bessel function of the second kind. - ScaledBesselY(n, z) is given by Exp(-Abs(z.Imaginary)) * Y(n, z). - - The order of the Bessel function. - The value to compute the Bessel function of. - The exponentially scaled Bessel function of the second kind. - - - - Returns the Bessel function of the second kind. - BesselY(n, z) is a solution to the Bessel differential equation. - - The order of the Bessel function. - The value to compute the Bessel function of. - The Bessel function of the second kind. - - - - Returns the exponentially scaled Bessel function of the second kind. - ScaledBesselY(n, z) is given by Exp(-Abs(z.Imaginary)) * BesselY(n, z). - - The order of the Bessel function. - The value to compute the Bessel function of. - The exponentially scaled Bessel function of the second kind. - - - - Returns the modified Bessel function of the first kind. - BesselI(n, z) is a solution to the modified Bessel differential equation. - - The order of the modified Bessel function. - The value to compute the modified Bessel function of. - The modified Bessel function of the first kind. - - - - Returns the exponentially scaled modified Bessel function of the first kind. - ScaledBesselI(n, z) is given by Exp(-Abs(z.Real)) * BesselI(n, z). - - The order of the modified Bessel function. - The value to compute the modified Bessel function of. - The exponentially scaled modified Bessel function of the first kind. - - - - Returns the modified Bessel function of the first kind. - BesselI(n, z) is a solution to the modified Bessel differential equation. - - The order of the modified Bessel function. - The value to compute the modified Bessel function of. - The modified Bessel function of the first kind. - - - - Returns the exponentially scaled modified Bessel function of the first kind. - ScaledBesselI(n, z) is given by Exp(-Abs(z.Real)) * BesselI(n, z). - - The order of the modified Bessel function. - The value to compute the modified Bessel function of. - The exponentially scaled modified Bessel function of the first kind. - - - - Returns the modified Bessel function of the second kind. - BesselK(n, z) is a solution to the modified Bessel differential equation. - - The order of the modified Bessel function. - The value to compute the modified Bessel function of. - The modified Bessel function of the second kind. - - - - Returns the exponentially scaled modified Bessel function of the second kind. - ScaledBesselK(n, z) is given by Exp(z) * BesselK(n, z). - - The order of the modified Bessel function. - The value to compute the modified Bessel function of. - The exponentially scaled modified Bessel function of the second kind. - - - - Returns the modified Bessel function of the second kind. - BesselK(n, z) is a solution to the modified Bessel differential equation. - - The order of the modified Bessel function. - The value to compute the modified Bessel function of. - The modified Bessel function of the second kind. - - - - Returns the exponentially scaled modified Bessel function of the second kind. - ScaledBesselK(n, z) is given by Exp(z) * BesselK(n, z). - - The order of the modified Bessel function. - The value to compute the modified Bessel function of. - The exponentially scaled modified Bessel function of the second kind. - - - - Computes the logarithm of the Euler Beta function. - - The first Beta parameter, a positive real number. - The second Beta parameter, a positive real number. - The logarithm of the Euler Beta function evaluated at z,w. - If or are not positive. - - - - Computes the Euler Beta function. - - The first Beta parameter, a positive real number. - The second Beta parameter, a positive real number. - The Euler Beta function evaluated at z,w. - If or are not positive. - - - - Returns the lower incomplete (unregularized) beta function - B(a,b,x) = int(t^(a-1)*(1-t)^(b-1),t=0..x) for real a > 0, b > 0, 1 >= x >= 0. - - The first Beta parameter, a positive real number. - The second Beta parameter, a positive real number. - The upper limit of the integral. - The lower incomplete (unregularized) beta function. - - - - Returns the regularized lower incomplete beta function - I_x(a,b) = 1/Beta(a,b) * int(t^(a-1)*(1-t)^(b-1),t=0..x) for real a > 0, b > 0, 1 >= x >= 0. - - The first Beta parameter, a positive real number. - The second Beta parameter, a positive real number. - The upper limit of the integral. - The regularized lower incomplete beta function. - - - - ************************************** - COEFFICIENTS FOR METHOD ErfImp * - ************************************** - - Polynomial coefficients for a numerator of ErfImp - calculation for Erf(x) in the interval [1e-10, 0.5]. - - - - Polynomial coefficients for a denominator of ErfImp - calculation for Erf(x) in the interval [1e-10, 0.5]. - - - - Polynomial coefficients for a numerator in ErfImp - calculation for Erfc(x) in the interval [0.5, 0.75]. - - - - Polynomial coefficients for a denominator in ErfImp - calculation for Erfc(x) in the interval [0.5, 0.75]. - - - - Polynomial coefficients for a numerator in ErfImp - calculation for Erfc(x) in the interval [0.75, 1.25]. - - - - Polynomial coefficients for a denominator in ErfImp - calculation for Erfc(x) in the interval [0.75, 1.25]. - - - - Polynomial coefficients for a numerator in ErfImp - calculation for Erfc(x) in the interval [1.25, 2.25]. - - - - Polynomial coefficients for a denominator in ErfImp - calculation for Erfc(x) in the interval [1.25, 2.25]. - - - - Polynomial coefficients for a numerator in ErfImp - calculation for Erfc(x) in the interval [2.25, 3.5]. - - - - Polynomial coefficients for a denominator in ErfImp - calculation for Erfc(x) in the interval [2.25, 3.5]. - - - - Polynomial coefficients for a numerator in ErfImp - calculation for Erfc(x) in the interval [3.5, 5.25]. - - - - Polynomial coefficients for a denominator in ErfImp - calculation for Erfc(x) in the interval [3.5, 5.25]. - - - - Polynomial coefficients for a numerator in ErfImp - calculation for Erfc(x) in the interval [5.25, 8]. - - - - Polynomial coefficients for a denominator in ErfImp - calculation for Erfc(x) in the interval [5.25, 8]. - - - - Polynomial coefficients for a numerator in ErfImp - calculation for Erfc(x) in the interval [8, 11.5]. - - - - Polynomial coefficients for a denominator in ErfImp - calculation for Erfc(x) in the interval [8, 11.5]. - - - - Polynomial coefficients for a numerator in ErfImp - calculation for Erfc(x) in the interval [11.5, 17]. - - - - Polynomial coefficients for a denominator in ErfImp - calculation for Erfc(x) in the interval [11.5, 17]. - - - - Polynomial coefficients for a numerator in ErfImp - calculation for Erfc(x) in the interval [17, 24]. - - - - Polynomial coefficients for a denominator in ErfImp - calculation for Erfc(x) in the interval [17, 24]. - - - - Polynomial coefficients for a numerator in ErfImp - calculation for Erfc(x) in the interval [24, 38]. - - - - Polynomial coefficients for a denominator in ErfImp - calculation for Erfc(x) in the interval [24, 38]. - - - - Polynomial coefficients for a numerator in ErfImp - calculation for Erfc(x) in the interval [38, 60]. - - - - Polynomial coefficients for a denominator in ErfImp - calculation for Erfc(x) in the interval [38, 60]. - - - - Polynomial coefficients for a numerator in ErfImp - calculation for Erfc(x) in the interval [60, 85]. - - - - Polynomial coefficients for a denominator in ErfImp - calculation for Erfc(x) in the interval [60, 85]. - - - - Polynomial coefficients for a numerator in ErfImp - calculation for Erfc(x) in the interval [85, 110]. - - - - Polynomial coefficients for a denominator in ErfImp - calculation for Erfc(x) in the interval [85, 110]. - - - - - ************************************** - COEFFICIENTS FOR METHOD ErfInvImp * - ************************************** - - Polynomial coefficients for a numerator of ErfInvImp - calculation for Erf^-1(z) in the interval [0, 0.5]. - - - - Polynomial coefficients for a denominator of ErfInvImp - calculation for Erf^-1(z) in the interval [0, 0.5]. - - - - Polynomial coefficients for a numerator of ErfInvImp - calculation for Erf^-1(z) in the interval [0.5, 0.75]. - - - - Polynomial coefficients for a denominator of ErfInvImp - calculation for Erf^-1(z) in the interval [0.5, 0.75]. - - - - Polynomial coefficients for a numerator of ErfInvImp - calculation for Erf^-1(z) in the interval [0.75, 1] with x less than 3. - - - - Polynomial coefficients for a denominator of ErfInvImp - calculation for Erf^-1(z) in the interval [0.75, 1] with x less than 3. - - - - Polynomial coefficients for a numerator of ErfInvImp - calculation for Erf^-1(z) in the interval [0.75, 1] with x between 3 and 6. - - - - Polynomial coefficients for a denominator of ErfInvImp - calculation for Erf^-1(z) in the interval [0.75, 1] with x between 3 and 6. - - - - Polynomial coefficients for a numerator of ErfInvImp - calculation for Erf^-1(z) in the interval [0.75, 1] with x between 6 and 18. - - - - Polynomial coefficients for a denominator of ErfInvImp - calculation for Erf^-1(z) in the interval [0.75, 1] with x between 6 and 18. - - - - Polynomial coefficients for a numerator of ErfInvImp - calculation for Erf^-1(z) in the interval [0.75, 1] with x between 18 and 44. - - - - Polynomial coefficients for a denominator of ErfInvImp - calculation for Erf^-1(z) in the interval [0.75, 1] with x between 18 and 44. - - - - Polynomial coefficients for a numerator of ErfInvImp - calculation for Erf^-1(z) in the interval [0.75, 1] with x greater than 44. - - - - Polynomial coefficients for a denominator of ErfInvImp - calculation for Erf^-1(z) in the interval [0.75, 1] with x greater than 44. - - - - Calculates the error function. - The value to evaluate. - the error function evaluated at given value. - - - returns 1 if x == double.PositiveInfinity. - returns -1 if x == double.NegativeInfinity. - - - - - Calculates the complementary error function. - The value to evaluate. - the complementary error function evaluated at given value. - - - returns 0 if x == double.PositiveInfinity. - returns 2 if x == double.NegativeInfinity. - - - - - Calculates the inverse error function evaluated at z. - The inverse error function evaluated at given value. - - - returns double.PositiveInfinity if z >= 1.0. - returns double.NegativeInfinity if z <= -1.0. - - - Calculates the inverse error function evaluated at z. - value to evaluate. - the inverse error function evaluated at Z. - - - - Implementation of the error function. - - Where to evaluate the error function. - Whether to compute 1 - the error function. - the error function. - - - Calculates the complementary inverse error function evaluated at z. - The complementary inverse error function evaluated at given value. - We have tested this implementation against the arbitrary precision mpmath library - and found cases where we can only guarantee 9 significant figures correct. - - returns double.PositiveInfinity if z <= 0.0. - returns double.NegativeInfinity if z >= 2.0. - - - calculates the complementary inverse error function evaluated at z. - value to evaluate. - the complementary inverse error function evaluated at Z. - - - - The implementation of the inverse error function. - - First intermediate parameter. - Second intermediate parameter. - Third intermediate parameter. - the inverse error function. - - - - Numerically stable exponential minus one, i.e. x -> exp(x)-1 - - A number specifying a power. - Returns exp(power)-1. - - - - Numerically stable exponential minus one, i.e. x -> exp(x)-1 - - A number specifying a power. - Returns exp(power)-1. - - - - Computes the generalized Exponential Integral function (En). - - The argument of the Exponential Integral function. - Integer power of the denominator term. Generalization index. - The value of the Exponential Integral function. - - This implementation of the computation of the Exponential Integral function follows the derivation in - "Handbook of Mathematical Functions, Applied Mathematics Series, Volume 55", Abramowitz, M., and Stegun, I.A. 1964, reprinted 1968 by - Dover Publications, New York), Chapters 6, 7, and 26. - AND - "Advanced mathematical methods for scientists and engineers", Bender, Carl M.; Steven A. Orszag (1978). page 253 - - - for x > 1 uses continued fraction approach that is often used to compute incomplete gamma. - for 0 < x <= 1 uses Taylor series expansion - - Our unit tests suggest that the accuracy of the Exponential Integral function is correct up to 13 floating point digits. - - - - - Computes the factorial function x -> x! of an integer number > 0. The function can represent all number up - to 22! exactly, all numbers up to 170! using a double representation. All larger values will overflow. - - A value value! for value > 0 - - If you need to multiply or divide various such factorials, consider using the logarithmic version - instead so you can add instead of multiply and subtract instead of divide, and - then exponentiate the result using . This will also circumvent the problem that - factorials become very large even for small parameters. - - - - - - Computes the factorial of an integer. - - - - - Computes the logarithmic factorial function x -> ln(x!) of an integer number > 0. - - A value value! for value > 0 - - - - Computes the binomial coefficient: n choose k. - - A nonnegative value n. - A nonnegative value h. - The binomial coefficient: n choose k. - - - - Computes the natural logarithm of the binomial coefficient: ln(n choose k). - - A nonnegative value n. - A nonnegative value h. - The logarithmic binomial coefficient: ln(n choose k). - - - - Computes the multinomial coefficient: n choose n1, n2, n3, ... - - A nonnegative value n. - An array of nonnegative values that sum to . - The multinomial coefficient. - if is . - If or any of the are negative. - If the sum of all is not equal to . - - - - The order of the approximation. - - - - - Auxiliary variable when evaluating the function. - - - - - Polynomial coefficients for the approximation. - - - - - Computes the logarithm of the Gamma function. - - The argument of the gamma function. - The logarithm of the gamma function. - - This implementation of the computation of the gamma and logarithm of the gamma function follows the derivation in - "An Analysis Of The Lanczos Gamma Approximation", Glendon Ralph Pugh, 2004. - We use the implementation listed on p. 116 which achieves an accuracy of 16 floating point digits. Although 16 digit accuracy - should be sufficient for double values, improving accuracy is possible (see p. 126 in Pugh). - Our unit tests suggest that the accuracy of the Gamma function is correct up to 14 floating point digits. - - - - - Computes the Gamma function. - - The argument of the gamma function. - The logarithm of the gamma function. - - - This implementation of the computation of the gamma and logarithm of the gamma function follows the derivation in - "An Analysis Of The Lanczos Gamma Approximation", Glendon Ralph Pugh, 2004. - We use the implementation listed on p. 116 which should achieve an accuracy of 16 floating point digits. Although 16 digit accuracy - should be sufficient for double values, improving accuracy is possible (see p. 126 in Pugh). - - Our unit tests suggest that the accuracy of the Gamma function is correct up to 13 floating point digits. - - - - - Returns the upper incomplete regularized gamma function - Q(a,x) = 1/Gamma(a) * int(exp(-t)t^(a-1),t=0..x) for real a > 0, x > 0. - - The argument for the gamma function. - The lower integral limit. - The upper incomplete regularized gamma function. - - - - Returns the upper incomplete gamma function - Gamma(a,x) = int(exp(-t)t^(a-1),t=0..x) for real a > 0, x > 0. - - The argument for the gamma function. - The lower integral limit. - The upper incomplete gamma function. - - - - Returns the lower incomplete gamma function - gamma(a,x) = int(exp(-t)t^(a-1),t=0..x) for real a > 0, x > 0. - - The argument for the gamma function. - The upper integral limit. - The lower incomplete gamma function. - - - - Returns the lower incomplete regularized gamma function - P(a,x) = 1/Gamma(a) * int(exp(-t)t^(a-1),t=0..x) for real a > 0, x > 0. - - The argument for the gamma function. - The upper integral limit. - The lower incomplete gamma function. - - - - Returns the inverse P^(-1) of the regularized lower incomplete gamma function - P(a,x) = 1/Gamma(a) * int(exp(-t)t^(a-1),t=0..x) for real a > 0, x > 0, - such that P^(-1)(a,P(a,x)) == x. - - - - - Computes the Digamma function which is mathematically defined as the derivative of the logarithm of the gamma function. - This implementation is based on - Jose Bernardo - Algorithm AS 103: - Psi ( Digamma ) Function, - Applied Statistics, - Volume 25, Number 3, 1976, pages 315-317. - Using the modifications as in Tom Minka's lightspeed toolbox. - - The argument of the digamma function. - The value of the DiGamma function at . - - - - Computes the inverse Digamma function: this is the inverse of the logarithm of the gamma function. This function will - only return solutions that are positive. - This implementation is based on the bisection method. - - The argument of the inverse digamma function. - The positive solution to the inverse DiGamma function at . - - - - Computes the Rising Factorial (Pochhammer function) x -> (x)n, n>= 0. see: https://en.wikipedia.org/wiki/Falling_and_rising_factorials - - The real value of the Rising Factorial for x and n - - - - Computes the Falling Factorial (Pochhammer function) x -> x(n), n>= 0. see: https://en.wikipedia.org/wiki/Falling_and_rising_factorials - - The real value of the Falling Factorial for x and n - - - - A generalized hypergeometric series is a power series in which the ratio of successive coefficients indexed by n is a rational function of n. - This is the most common pFq(a1, ..., ap; b1,...,bq; z) representation - see: https://en.wikipedia.org/wiki/Generalized_hypergeometric_function - - The list of coefficients in the numerator - The list of coefficients in the denominator - The variable in the power series - The value of the Generalized HyperGeometric Function. - - - - Returns the Hankel function of the first kind. - HankelH1(n, z) is defined as BesselJ(n, z) + j * BesselY(n, z). - - The order of the Hankel function. - The value to compute the Hankel function of. - The Hankel function of the first kind. - - - - Returns the exponentially scaled Hankel function of the first kind. - ScaledHankelH1(n, z) is given by Exp(-z * j) * HankelH1(n, z) where j = Sqrt(-1). - - The order of the Hankel function. - The value to compute the Hankel function of. - The exponentially scaled Hankel function of the first kind. - - - - Returns the Hankel function of the second kind. - HankelH2(n, z) is defined as BesselJ(n, z) - j * BesselY(n, z). - - The order of the Hankel function. - The value to compute the Hankel function of. - The Hankel function of the second kind. - - - - Returns the exponentially scaled Hankel function of the second kind. - ScaledHankelH2(n, z) is given by Exp(z * j) * HankelH2(n, z) where j = Sqrt(-1). - - The order of the Hankel function. - The value to compute the Hankel function of. - The exponentially scaled Hankel function of the second kind. - - - - Computes the 'th Harmonic number. - - The Harmonic number which needs to be computed. - The t'th Harmonic number. - - - - Compute the generalized harmonic number of order n of m. (1 + 1/2^m + 1/3^m + ... + 1/n^m) - - The order parameter. - The power parameter. - General Harmonic number. - - - - Returns the Kelvin function of the first kind. - KelvinBe(nu, x) is given by BesselJ(0, j * sqrt(j) * x) where j = sqrt(-1). - KelvinBer(nu, x) and KelvinBei(nu, x) are the real and imaginary parts of the KelvinBe(nu, x) - - the order of the the Kelvin function. - The value to compute the Kelvin function of. - The Kelvin function of the first kind. - - - - Returns the Kelvin function ber. - KelvinBer(nu, x) is given by the real part of BesselJ(nu, j * sqrt(j) * x) where j = sqrt(-1). - - the order of the the Kelvin function. - The value to compute the Kelvin function of. - The Kelvin function ber. - - - - Returns the Kelvin function ber. - KelvinBer(x) is given by the real part of BesselJ(0, j * sqrt(j) * x) where j = sqrt(-1). - KelvinBer(x) is equivalent to KelvinBer(0, x). - - The value to compute the Kelvin function of. - The Kelvin function ber. - - - - Returns the Kelvin function bei. - KelvinBei(nu, x) is given by the imaginary part of BesselJ(nu, j * sqrt(j) * x) where j = sqrt(-1). - - the order of the the Kelvin function. - The value to compute the Kelvin function of. - The Kelvin function bei. - - - - Returns the Kelvin function bei. - KelvinBei(x) is given by the imaginary part of BesselJ(0, j * sqrt(j) * x) where j = sqrt(-1). - KelvinBei(x) is equivalent to KelvinBei(0, x). - - The value to compute the Kelvin function of. - The Kelvin function bei. - - - - Returns the derivative of the Kelvin function ber. - - The order of the Kelvin function. - The value to compute the derivative of the Kelvin function of. - the derivative of the Kelvin function ber - - - - Returns the derivative of the Kelvin function ber. - - The value to compute the derivative of the Kelvin function of. - The derivative of the Kelvin function ber. - - - - Returns the derivative of the Kelvin function bei. - - The order of the Kelvin function. - The value to compute the derivative of the Kelvin function of. - the derivative of the Kelvin function bei. - - - - Returns the derivative of the Kelvin function bei. - - The value to compute the derivative of the Kelvin function of. - The derivative of the Kelvin function bei. - - - - Returns the Kelvin function of the second kind - KelvinKe(nu, x) is given by Exp(-nu * pi * j / 2) * BesselK(nu, x * sqrt(j)) where j = sqrt(-1). - KelvinKer(nu, x) and KelvinKei(nu, x) are the real and imaginary parts of the KelvinBe(nu, x) - - The order of the Kelvin function. - The value to calculate the kelvin function of, - - - - - Returns the Kelvin function ker. - KelvinKer(nu, x) is given by the real part of Exp(-nu * pi * j / 2) * BesselK(nu, sqrt(j) * x) where j = sqrt(-1). - - the order of the the Kelvin function. - The non-negative real value to compute the Kelvin function of. - The Kelvin function ker. - - - - Returns the Kelvin function ker. - KelvinKer(x) is given by the real part of Exp(-nu * pi * j / 2) * BesselK(0, sqrt(j) * x) where j = sqrt(-1). - KelvinKer(x) is equivalent to KelvinKer(0, x). - - The non-negative real value to compute the Kelvin function of. - The Kelvin function ker. - - - - Returns the Kelvin function kei. - KelvinKei(nu, x) is given by the imaginary part of Exp(-nu * pi * j / 2) * BesselK(nu, sqrt(j) * x) where j = sqrt(-1). - - the order of the the Kelvin function. - The non-negative real value to compute the Kelvin function of. - The Kelvin function kei. - - - - Returns the Kelvin function kei. - KelvinKei(x) is given by the imaginary part of Exp(-nu * pi * j / 2) * BesselK(0, sqrt(j) * x) where j = sqrt(-1). - KelvinKei(x) is equivalent to KelvinKei(0, x). - - The non-negative real value to compute the Kelvin function of. - The Kelvin function kei. - - - - Returns the derivative of the Kelvin function ker. - - The order of the Kelvin function. - The non-negative real value to compute the derivative of the Kelvin function of. - The derivative of the Kelvin function ker. - - - - Returns the derivative of the Kelvin function ker. - - The value to compute the derivative of the Kelvin function of. - The derivative of the Kelvin function ker. - - - - Returns the derivative of the Kelvin function kei. - - The order of the Kelvin function. - The value to compute the derivative of the Kelvin function of. - The derivative of the Kelvin function kei. - - - - Returns the derivative of the Kelvin function kei. - - The value to compute the derivative of the Kelvin function of. - The derivative of the Kelvin function kei. - - - - Computes ln(1+x) with good relative precision when |x| is small - - The parameter for which to compute the log1p function. Range: x > 0. - - - - Computes the logistic function. see: http://en.wikipedia.org/wiki/Logistic - - The parameter for which to compute the logistic function. - The logistic function of . - - - - Computes the logit function, the inverse of the sigmoid logistic function. see: http://en.wikipedia.org/wiki/Logit - - The parameter for which to compute the logit function. This number should be - between 0 and 1. - The logarithm of divided by 1.0 - . - - - - Returns the Marcum Q-function Q[ν](a,b). Marcum Q-function (Wikipedia) - References: A. Gil, J. Segura and N.M. Temme. Efficient and accurate algorithms for the - computation and inversion of the incomplete gamma function ratios. SIAM J Sci Comput. (2012) 34(6), A2965-A2981 - - The order of generalized Marcum Q-function. Range: 1≦ν≦10000 - The value to compute the Marcum Q-function of. Range: 0≦a≦10000 - The value to compute the Marcum Q-function of. Range: 0≦b≦10000 - The Marcum Q-function Q[ν](a,b) - - - - Returns the Marcum Q-function Q[ν](a,b). Marcum Q-function (Wikipedia) - References: A. Gil, J. Segura and N.M. Temme. Efficient and accurate algorithms for the - computation and inversion of the incomplete gamma function ratios. SIAM J Sci Comput. (2012) 34(6), A2965-A2981 - - The order of generalized Marcum Q-function. Range: 1≦ν≦10000 - The value to compute the Marcum Q-function of. Range: 0≦a≦10000 - The value to compute the Marcum Q-function of. Range: 0≦b≦10000 - Error flag - 0: Computation succesful. - 1: Underflow problems. The function value is set to one. - 2: Any of the arguments of the function is out of range.The function value is set to zero. - - The Marcum Q-function Q[ν](a,b) - - - - Marcum Q-functions - References - [1] A. Gil, J. Segura and N.M. Temme, Accompanying paper in ACM Trans Math Soft - [2] A. Gil, J. Segura and N.M. Temme. Efficient and accurate algorithms for the - computation and inversion of the incomplete gamma function ratios. SIAM J Sci Comput. - (2012) 34(6), A2965-A2981 - - - - - Fortran 95 TINY(0.0d0) - - - - - Fortran 95 HUGE(0.0d0) - - - - - The number 2**(1/4) - - - - - machine-epsilon - - - - - The number log[e](sqrt(2*pi)) - - - - - Safe underflow limit - - - - - Safe overflow limit - - - - - Lower limit of exponential - - - - - Demanded accuracy - - - - - Calculation of the Marcum Q-functions P_mu(x,y) and Q_mu(x,y). Marcum Q-function (Wikipedia) - - - - In order to avoid, overflow/underflow problems in IEEE double precision arithmetic, the admissible parameter ranges for computation are: - - - 0≦x≦10000, 0≦y≦10000, 1≦mu≦10000 - - - The aimed relative accuracy is close to 1.0e-11 in the previous parameter domain. - - - argument of the functions - argument of the functions - argument of the functions - function P_mu(a,x) - function Q_mu(a,x) - error flag - 0: Computation succesful - 1: Underflow problems. The function values are set to zero and one. - 2: Any of the arguments of the function is out of range.The function values (P_mu(a, x) and Q_mu(a, x)) are set to zero. - - - - - computation of the incomplete gamma function ratios - - - - - Calculation of the incomplete gamma functions ratios P(a,x) and Q(a,x). - - argument of the functions - argument of the functions - function P(a,x) - function Q(a,x) - error flag - - - - Computes xr in the equations P(a,xr)=p and Q(a,xr)=q with a as a given positive parameter. In most cases, we invert the equation with min(p,q) - - argument of the functions - function P(a,x) - function Q(a,x) - soluction of the equations P(a,xr)=p and Q(a,xr)=q with a as a given positive parameter. - error flag - - - - dompart is approx. of x^a * exp(-x) / gamma(a+1) - - argument of the functions - argument of the functions - argument of the functions - - - - - Computation of ln(gamma(x)), x>0 - - argument of the functions - - - - - ************************************** - COEFFICIENTS FOR METHODS bessi0 * - ************************************** - - Chebyshev coefficients for exp(-x) I0(x) - in the interval [0, 8]. - - lim(x->0){ exp(-x) I0(x) } = 1. - - - - Chebyshev coefficients for exp(-x) sqrt(x) I0(x) - in the inverted interval [8, infinity]. - - lim(x->inf){ exp(-x) sqrt(x) I0(x) } = 1/sqrt(2pi). - - - - - ************************************** - COEFFICIENTS FOR METHODS bessi1 * - ************************************** - - Chebyshev coefficients for exp(-x) I1(x) / x - in the interval [0, 8]. - - lim(x->0){ exp(-x) I1(x) / x } = 1/2. - - - - Chebyshev coefficients for exp(-x) sqrt(x) I1(x) - in the inverted interval [8, infinity]. - - lim(x->inf){ exp(-x) sqrt(x) I1(x) } = 1/sqrt(2pi). - - - - - ************************************** - COEFFICIENTS FOR METHODS bessk0, bessk0e * - ************************************** - - Chebyshev coefficients for K0(x) + log(x/2) I0(x) - in the interval [0, 2]. The odd order coefficients are all - zero; only the even order coefficients are listed. - - lim(x->0){ K0(x) + log(x/2) I0(x) } = -EUL. - - - - Chebyshev coefficients for exp(x) sqrt(x) K0(x) - in the inverted interval [2, infinity]. - - lim(x->inf){ exp(x) sqrt(x) K0(x) } = sqrt(pi/2). - - - - - ************************************** - COEFFICIENTS FOR METHODS bessk1, bessk1e * - ************************************** - - Chebyshev coefficients for x(K1(x) - log(x/2) I1(x)) - in the interval [0, 2]. - - lim(x->0){ x(K1(x) - log(x/2) I1(x)) } = 1. - - - - Chebyshev coefficients for exp(x) sqrt(x) K1(x) - in the interval [2, infinity]. - - lim(x->inf){ exp(x) sqrt(x) K1(x) } = sqrt(pi/2). - - - - Returns the modified Bessel function of first kind, order 0 of the argument. -

    - The function is defined as i0(x) = j0( ix ). -

    - The range is partitioned into the two intervals [0, 8] and - (8, infinity). Chebyshev polynomial expansions are employed - in each interval. -

    - The value to compute the Bessel function of. - -
    - - Returns the modified Bessel function of first kind, - order 1 of the argument. -

    - The function is defined as i1(x) = -i j1( ix ). -

    - The range is partitioned into the two intervals [0, 8] and - (8, infinity). Chebyshev polynomial expansions are employed - in each interval. -

    - The value to compute the Bessel function of. - -
    - - Returns the modified Bessel function of the second kind - of order 0 of the argument. -

    - The range is partitioned into the two intervals [0, 8] and - (8, infinity). Chebyshev polynomial expansions are employed - in each interval. -

    - The value to compute the Bessel function of. - -
    - - Returns the exponentially scaled modified Bessel function - of the second kind of order 0 of the argument. - - The value to compute the Bessel function of. - - - - Returns the modified Bessel function of the second kind - of order 1 of the argument. -

    - The range is partitioned into the two intervals [0, 2] and - (2, infinity). Chebyshev polynomial expansions are employed - in each interval. -

    - The value to compute the Bessel function of. - -
    - - Returns the exponentially scaled modified Bessel function - of the second kind of order 1 of the argument. -

    - k1e(x) = exp(x) * k1(x). -

    - The value to compute the Bessel function of. - -
    - - - Returns the modified Struve function of order 0. - - The value to compute the function of. - - - - Returns the modified Struve function of order 1. - - The value to compute the function of. - - - - Returns the difference between the Bessel I0 and Struve L0 functions. - - The value to compute the function of. - - - - Returns the difference between the Bessel I1 and Struve L1 functions. - - The value to compute the function of. - - - - Returns the spherical Bessel function of the first kind. - SphericalBesselJ(n, z) is given by Sqrt(pi/2) / Sqrt(z) * BesselJ(n + 1/2, z). - - The order of the spherical Bessel function. - The value to compute the spherical Bessel function of. - The spherical Bessel function of the first kind. - - - - Returns the spherical Bessel function of the first kind. - SphericalBesselJ(n, z) is given by Sqrt(pi/2) / Sqrt(z) * BesselJ(n + 1/2, z). - - The order of the spherical Bessel function. - The value to compute the spherical Bessel function of. - The spherical Bessel function of the first kind. - - - - Returns the spherical Bessel function of the second kind. - SphericalBesselY(n, z) is given by Sqrt(pi/2) / Sqrt(z) * BesselY(n + 1/2, z). - - The order of the spherical Bessel function. - The value to compute the spherical Bessel function of. - The spherical Bessel function of the second kind. - - - - Returns the spherical Bessel function of the second kind. - SphericalBesselY(n, z) is given by Sqrt(pi/2) / Sqrt(z) * BesselY(n + 1/2, z). - - The order of the spherical Bessel function. - The value to compute the spherical Bessel function of. - The spherical Bessel function of the second kind. - - - - Numerically stable hypotenuse of a right angle triangle, i.e. (a,b) -> sqrt(a^2 + b^2) - - The length of side a of the triangle. - The length of side b of the triangle. - Returns sqrt(a2 + b2) without underflow/overflow. - - - - Numerically stable hypotenuse of a right angle triangle, i.e. (a,b) -> sqrt(a^2 + b^2) - - The length of side a of the triangle. - The length of side b of the triangle. - Returns sqrt(a2 + b2) without underflow/overflow. - - - - Numerically stable hypotenuse of a right angle triangle, i.e. (a,b) -> sqrt(a^2 + b^2) - - The length of side a of the triangle. - The length of side b of the triangle. - Returns sqrt(a2 + b2) without underflow/overflow. - - - - Numerically stable hypotenuse of a right angle triangle, i.e. (a,b) -> sqrt(a^2 + b^2) - - The length of side a of the triangle. - The length of side b of the triangle. - Returns sqrt(a2 + b2) without underflow/overflow. - - - - Evaluation functions, useful for function approximation. - - - - Evaluates the series of Chebyshev polynomials Ti at argument x/2. - The series is given by -
    -                  N-1
    -                   - '
    -            y  =   >   coef[i] T (x/2)
    -                   -            i
    -                  i=0
    -            
    - Coefficients are stored in reverse order, i.e. the zero - order term is last in the array. Note N is the number of - coefficients, not the order. -

    - If coefficients are for the interval a to b, x must - have been transformed to x -> 2(2x - b - a)/(b-a) before - entering the routine. This maps x from (a, b) to (-1, 1), - over which the Chebyshev polynomials are defined. -

    - If the coefficients are for the inverted interval, in - which (a, b) is mapped to (1/b, 1/a), the transformation - required is x -> 2(2ab/x - b - a)/(b-a). If b is infinity, - this becomes x -> 4a/x - 1. -

    - SPEED: -

    - Taking advantage of the recurrence properties of the - Chebyshev polynomials, the routine requires one more - addition per loop than evaluating a nested polynomial of - the same degree. -

    - The coefficients of the polynomial. - Argument to the polynomial. - - Reference: https://bpm2.svn.codeplex.com/svn/Common.Numeric/Arithmetic.cs -

    - Marked as Deprecated in - http://people.apache.org/~isabel/mahout_site/mahout-matrix/apidocs/org/apache/mahout/jet/math/Arithmetic.html - - - -

    - Summation of Chebyshev polynomials, using the Clenshaw method with Reinsch modification. - - The no. of terms in the sequence. - The coefficients of the Chebyshev series, length n+1. - The value at which the series is to be evaluated. - - ORIGINAL AUTHOR: - Dr. Allan J. MacLeod; Dept. of Mathematics and Statistics, University of Paisley; High St., PAISLEY, SCOTLAND - REFERENCES: - "An error analysis of the modified Clenshaw method for evaluating Chebyshev and Fourier series" - J. Oliver, J.I.M.A., vol. 20, 1977, pp379-391 - -
    - - - Valley-shaped Rosenbrock function for 2 dimensions: (x,y) -> (1-x)^2 + 100*(y-x^2)^2. - This function has a global minimum at (1,1) with f(1,1) = 0. - Common range: [-5,10] or [-2.048,2.048]. - - - https://en.wikipedia.org/wiki/Rosenbrock_function - http://www.sfu.ca/~ssurjano/rosen.html - - - - - Valley-shaped Rosenbrock function for 2 or more dimensions. - This function have a global minimum of all ones and, for 8 > N > 3, a local minimum at (-1,1,...,1). - - - https://en.wikipedia.org/wiki/Rosenbrock_function - http://www.sfu.ca/~ssurjano/rosen.html - - - - - Himmelblau, a multi-modal function: (x,y) -> (x^2+y-11)^2 + (x+y^2-7)^2 - This function has 4 global minima with f(x,y) = 0. - Common range: [-6,6]. - Named after David Mautner Himmelblau - - - https://en.wikipedia.org/wiki/Himmelblau%27s_function - - - - - Rastrigin, a highly multi-modal function with many local minima. - Global minimum of all zeros with f(0) = 0. - Common range: [-5.12,5.12]. - - - https://en.wikipedia.org/wiki/Rastrigin_function - http://www.sfu.ca/~ssurjano/rastr.html - - - - - Drop-Wave, a multi-modal and highly complex function with many local minima. - Global minimum of all zeros with f(0) = -1. - Common range: [-5.12,5.12]. - - - http://www.sfu.ca/~ssurjano/drop.html - - - - - Ackley, a function with many local minima. It is nearly flat in outer regions but has a large hole at the center. - Global minimum of all zeros with f(0) = 0. - Common range: [-32.768, 32.768]. - - - http://www.sfu.ca/~ssurjano/ackley.html - - - - - Bowl-shaped first Bohachevsky function. - Global minimum of all zeros with f(0,0) = 0. - Common range: [-100, 100] - - - http://www.sfu.ca/~ssurjano/boha.html - - - - - Plate-shaped Matyas function. - Global minimum of all zeros with f(0,0) = 0. - Common range: [-10, 10]. - - - http://www.sfu.ca/~ssurjano/matya.html - - - - - Valley-shaped six-hump camel back function. - Two global minima and four local minima. Global minima with f(x) ) -1.0316 at (0.0898,-0.7126) and (-0.0898,0.7126). - Common range: x in [-3,3], y in [-2,2]. - - - http://www.sfu.ca/~ssurjano/camel6.html - - - - - Statistics operating on arrays assumed to be unsorted. - WARNING: Methods with the Inplace-suffix may modify the data array by reordering its entries. - - - - - - - - Returns the smallest absolute value from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Returns the smallest absolute value from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Returns the largest absolute value from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Returns the largest absolute value from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Returns the smallest value from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Returns the largest value from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Returns the smallest absolute value from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Returns the largest absolute value from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Estimates the arithmetic sample mean from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Evaluates the geometric mean of the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Evaluates the harmonic mean of the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Estimates the unbiased population variance from the provided samples as unsorted array. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Evaluates the population variance from the full population provided as unsorted array. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Estimates the unbiased population standard deviation from the provided samples as unsorted array. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Evaluates the population standard deviation from the full population provided as unsorted array. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Estimates the arithmetic sample mean and the unbiased population variance from the provided samples as unsorted array. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN for mean if data is empty or any entry is NaN and NaN for variance if data has less than two entries or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Estimates the arithmetic sample mean and the unbiased population standard deviation from the provided samples as unsorted array. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN for mean if data is empty or any entry is NaN and NaN for standard deviation if data has less than two entries or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Estimates the unbiased population covariance from the provided two sample arrays. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - First sample array. - Second sample array. - - - - Evaluates the population covariance from the full population provided as two arrays. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - First population array. - Second population array. - - - - Estimates the root mean square (RMS) also known as quadratic mean from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Returns the order statistic (order 1..N) from the unsorted data array. - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - One-based order of the statistic, must be between 1 and N (inclusive). - - - - Estimates the median value from the unsorted data array. - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - - - - Estimates the p-Percentile value from the unsorted data array. - If a non-integer Percentile is needed, use Quantile instead. - Approximately median-unbiased regardless of the sample distribution (R8). - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - Percentile selector, between 0 and 100 (inclusive). - - - - Estimates the first quartile value from the unsorted data array. - Approximately median-unbiased regardless of the sample distribution (R8). - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - - - - Estimates the third quartile value from the unsorted data array. - Approximately median-unbiased regardless of the sample distribution (R8). - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - - - - Estimates the inter-quartile range from the unsorted data array. - Approximately median-unbiased regardless of the sample distribution (R8). - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - - - - Estimates {min, lower-quantile, median, upper-quantile, max} from the unsorted data array. - Approximately median-unbiased regardless of the sample distribution (R8). - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - - - - Estimates the tau-th quantile from the unsorted data array. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. - Approximately median-unbiased regardless of the sample distribution (R8). - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - Quantile selector, between 0.0 and 1.0 (inclusive). - - R-8, SciPy-(1/3,1/3): - Linear interpolation of the approximate medians for order statistics. - When tau < (2/3) / (N + 1/3), use x1. When tau >= (N - 1/3) / (N + 1/3), use xN. - - - - - Estimates the tau-th quantile from the unsorted data array. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified - by 4 parameters a, b, c and d, consistent with Mathematica. - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - Quantile selector, between 0.0 and 1.0 (inclusive) - a-parameter - b-parameter - c-parameter - d-parameter - - - - Estimates the tau-th quantile from the unsorted data array. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - Quantile selector, between 0.0 and 1.0 (inclusive) - Quantile definition, to choose what product/definition it should be consistent with - - - - Evaluates the rank of each entry of the unsorted data array. - The rank definition can be specified to be compatible - with an existing system. - WARNING: Works inplace and can thus causes the data array to be reordered. - - - - - Estimates the arithmetic sample mean from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Evaluates the geometric mean of the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Evaluates the harmonic mean of the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Estimates the unbiased population variance from the provided samples as unsorted array. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Evaluates the population variance from the full population provided as unsorted array. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Estimates the unbiased population standard deviation from the provided samples as unsorted array. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Evaluates the population standard deviation from the full population provided as unsorted array. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Estimates the arithmetic sample mean and the unbiased population variance from the provided samples as unsorted array. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN for mean if data is empty or any entry is NaN and NaN for variance if data has less than two entries or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Estimates the arithmetic sample mean and the unbiased population standard deviation from the provided samples as unsorted array. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN for mean if data is empty or any entry is NaN and NaN for standard deviation if data has less than two entries or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Estimates the unbiased population covariance from the provided two sample arrays. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - First sample array. - Second sample array. - - - - Evaluates the population covariance from the full population provided as two arrays. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - First population array. - Second population array. - - - - Estimates the root mean square (RMS) also known as quadratic mean from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Returns the smallest value from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Returns the smallest value from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Returns the smallest absolute value from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Returns the largest absolute value from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Estimates the arithmetic sample mean from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Evaluates the geometric mean of the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Evaluates the harmonic mean of the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Estimates the unbiased population variance from the provided samples as unsorted array. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Evaluates the population variance from the full population provided as unsorted array. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Estimates the unbiased population standard deviation from the provided samples as unsorted array. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Evaluates the population standard deviation from the full population provided as unsorted array. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Estimates the arithmetic sample mean and the unbiased population variance from the provided samples as unsorted array. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN for mean if data is empty or any entry is NaN and NaN for variance if data has less than two entries or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Estimates the arithmetic sample mean and the unbiased population standard deviation from the provided samples as unsorted array. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN for mean if data is empty or any entry is NaN and NaN for standard deviation if data has less than two entries or if any entry is NaN. - - Sample array, no sorting is assumed. - - - - Estimates the unbiased population covariance from the provided two sample arrays. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - First sample array. - Second sample array. - - - - Evaluates the population covariance from the full population provided as two arrays. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - First population array. - Second population array. - - - - Estimates the root mean square (RMS) also known as quadratic mean from the unsorted data array. - Returns NaN if data is empty or any entry is NaN. - - Sample array, no sorting is assumed. - - - - Returns the order statistic (order 1..N) from the unsorted data array. - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - One-based order of the statistic, must be between 1 and N (inclusive). - - - - Estimates the median value from the unsorted data array. - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - - - - Estimates the p-Percentile value from the unsorted data array. - If a non-integer Percentile is needed, use Quantile instead. - Approximately median-unbiased regardless of the sample distribution (R8). - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - Percentile selector, between 0 and 100 (inclusive). - - - - Estimates the first quartile value from the unsorted data array. - Approximately median-unbiased regardless of the sample distribution (R8). - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - - - - Estimates the third quartile value from the unsorted data array. - Approximately median-unbiased regardless of the sample distribution (R8). - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - - - - Estimates the inter-quartile range from the unsorted data array. - Approximately median-unbiased regardless of the sample distribution (R8). - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - - - - Estimates {min, lower-quantile, median, upper-quantile, max} from the unsorted data array. - Approximately median-unbiased regardless of the sample distribution (R8). - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - - - - Estimates the tau-th quantile from the unsorted data array. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. - Approximately median-unbiased regardless of the sample distribution (R8). - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - Quantile selector, between 0.0 and 1.0 (inclusive). - - R-8, SciPy-(1/3,1/3): - Linear interpolation of the approximate medians for order statistics. - When tau < (2/3) / (N + 1/3), use x1. When tau >= (N - 1/3) / (N + 1/3), use xN. - - - - - Estimates the tau-th quantile from the unsorted data array. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified - by 4 parameters a, b, c and d, consistent with Mathematica. - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - Quantile selector, between 0.0 and 1.0 (inclusive) - a-parameter - b-parameter - c-parameter - d-parameter - - - - Estimates the tau-th quantile from the unsorted data array. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - WARNING: Works inplace and can thus causes the data array to be reordered. - - Sample array, no sorting is assumed. Will be reordered. - Quantile selector, between 0.0 and 1.0 (inclusive) - Quantile definition, to choose what product/definition it should be consistent with - - - - Evaluates the rank of each entry of the unsorted data array. - The rank definition can be specified to be compatible - with an existing system. - WARNING: Works inplace and can thus causes the data array to be reordered. - - - - - A class with correlation measures between two datasets. - - - - - Auto-correlation function (ACF) based on FFT for all possible lags k. - - Data array to calculate auto correlation for. - An array with the ACF as a function of the lags k. - - - - Auto-correlation function (ACF) based on FFT for lags between kMin and kMax. - - The data array to calculate auto correlation for. - Max lag to calculate ACF for must be positive and smaller than x.Length. - Min lag to calculate ACF for (0 = no shift with acf=1) must be zero or positive and smaller than x.Length. - An array with the ACF as a function of the lags k. - - - - Auto-correlation function based on FFT for lags k. - - The data array to calculate auto correlation for. - Array with lags to calculate ACF for. - An array with the ACF as a function of the lags k. - - - - The internal method for calculating the auto-correlation. - - The data array to calculate auto-correlation for - Min lag to calculate ACF for (0 = no shift with acf=1) must be zero or positive and smaller than x.Length - Max lag (EXCLUSIVE) to calculate ACF for must be positive and smaller than x.Length - An array with the ACF as a function of the lags k. - - - - Computes the Pearson Product-Moment Correlation coefficient. - - Sample data A. - Sample data B. - The Pearson product-moment correlation coefficient. - - - - Computes the Weighted Pearson Product-Moment Correlation coefficient. - - Sample data A. - Sample data B. - Corresponding weights of data. - The Weighted Pearson product-moment correlation coefficient. - - - - Computes the Pearson Product-Moment Correlation matrix. - - Array of sample data vectors. - The Pearson product-moment correlation matrix. - - - - Computes the Pearson Product-Moment Correlation matrix. - - Enumerable of sample data vectors. - The Pearson product-moment correlation matrix. - - - - Computes the Spearman Ranked Correlation coefficient. - - Sample data series A. - Sample data series B. - The Spearman ranked correlation coefficient. - - - - Computes the Spearman Ranked Correlation matrix. - - Array of sample data vectors. - The Spearman ranked correlation matrix. - - - - Computes the Spearman Ranked Correlation matrix. - - Enumerable of sample data vectors. - The Spearman ranked correlation matrix. - - - - Computes the basic statistics of data set. The class meets the - NIST standard of accuracy for mean, variance, and standard deviation - (the only statistics they provide exact values for) and exceeds them - in increased accuracy mode. - Recommendation: consider to use RunningStatistics instead. - - - This type declares a DataContract for out of the box ephemeral serialization - with engines like DataContractSerializer, Protocol Buffers and FsPickler, - but does not guarantee any compatibility between versions. - It is not recommended to rely on this mechanism for durable persistence. - - - - - Initializes a new instance of the class. - - The sample data. - - If set to true, increased accuracy mode used. - Increased accuracy mode uses types for internal calculations. - - - Don't use increased accuracy for data sets containing large values (in absolute value). - This may cause the calculations to overflow. - - - - - Initializes a new instance of the class. - - The sample data. - - If set to true, increased accuracy mode used. - Increased accuracy mode uses types for internal calculations. - - - Don't use increased accuracy for data sets containing large values (in absolute value). - This may cause the calculations to overflow. - - - - - Gets the size of the sample. - - The size of the sample. - - - - Gets the sample mean. - - The sample mean. - - - - Gets the unbiased population variance estimator (on a dataset of size N will use an N-1 normalizer). - - The sample variance. - - - - Gets the unbiased population standard deviation (on a dataset of size N will use an N-1 normalizer). - - The sample standard deviation. - - - - Gets the sample skewness. - - The sample skewness. - Returns zero if is less than three. - - - - Gets the sample kurtosis. - - The sample kurtosis. - Returns zero if is less than four. - - - - Gets the maximum sample value. - - The maximum sample value. - - - - Gets the minimum sample value. - - The minimum sample value. - - - - Computes descriptive statistics from a stream of data values. - - A sequence of datapoints. - - - - Computes descriptive statistics from a stream of nullable data values. - - A sequence of datapoints. - - - - Computes descriptive statistics from a stream of data values. - - A sequence of datapoints. - - - - Computes descriptive statistics from a stream of nullable data values. - - A sequence of datapoints. - - - - Internal use. Method use for setting the statistics. - - For setting Mean. - For setting Variance. - For setting Skewness. - For setting Kurtosis. - For setting Minimum. - For setting Maximum. - For setting Count. - - - - A consists of a series of s, - each representing a region limited by a lower bound (exclusive) and an upper bound (inclusive). - - - This type declares a DataContract for out of the box ephemeral serialization - with engines like DataContractSerializer, Protocol Buffers and FsPickler, - but does not guarantee any compatibility between versions. - It is not recommended to rely on this mechanism for durable persistence. - - - - - This IComparer performs comparisons between a point and a bucket. - - - - - Compares a point and a bucket. The point will be encapsulated in a bucket with width 0. - - The first bucket to compare. - The second bucket to compare. - -1 when the point is less than this bucket, 0 when it is in this bucket and 1 otherwise. - - - - Lower Bound of the Bucket. - - - - - Upper Bound of the Bucket. - - - - - The number of datapoints in the bucket. - - - Value may be NaN if this was constructed as a argument. - - - - - Initializes a new instance of the Bucket class. - - - - - Constructs a Bucket that can be used as an argument for a - like when performing a Binary search. - - Value to look for - - - - Creates a copy of the Bucket with the lowerbound, upperbound and counts exactly equal. - - A cloned Bucket object. - - - - Width of the Bucket. - - - - - True if this is a single point argument for - when performing a Binary search. - - - - - Default comparer. - - - - - This method check whether a point is contained within this bucket. - - The point to check. - - 0 if the point falls within the bucket boundaries; - -1 if the point is smaller than the bucket, - +1 if the point is larger than the bucket. - - - - Comparison of two disjoint buckets. The buckets cannot be overlapping. - - - 0 if UpperBound and LowerBound are bit-for-bit equal - 1 if This bucket is lower that the compared bucket - -1 otherwise - - - - - Checks whether two Buckets are equal. - - - UpperBound and LowerBound are compared bit-for-bit, but This method tolerates a - difference in Count given by . - - - - - Provides a hash code for this bucket. - - - - - Formats a human-readable string for this bucket. - - - - - A class which computes histograms of data. - - - - - Contains all the Buckets of the Histogram. - - - - - Indicates whether the elements of buckets are currently sorted. - - - - - Initializes a new instance of the Histogram class. - - - - - Constructs a Histogram with a specific number of equally sized buckets. The upper and lower bound of the histogram - will be set to the smallest and largest datapoint. - - The data sequence to build a histogram on. - The number of buckets to use. - - - - Constructs a Histogram with a specific number of equally sized buckets. - - The data sequence to build a histogram on. - The number of buckets to use. - The histogram lower bound. - The histogram upper bound. - - - - Add one data point to the histogram. If the datapoint falls outside the range of the histogram, - the lowerbound or upperbound will automatically adapt. - - The datapoint which we want to add. - - - - Add a sequence of data point to the histogram. If the datapoint falls outside the range of the histogram, - the lowerbound or upperbound will automatically adapt. - - The sequence of datapoints which we want to add. - - - - Adds a Bucket to the Histogram. - - - - - Sort the buckets if needed. - - - - - Returns the Bucket that contains the value v. - - The point to search the bucket for. - A copy of the bucket containing point . - - - - Returns the index in the Histogram of the Bucket - that contains the value v. - - The point to search the bucket index for. - The index of the bucket containing the point. - - - - Returns the lower bound of the histogram. - - - - - Returns the upper bound of the histogram. - - - - - Gets the n'th bucket. - - The index of the bucket to be returned. - A copy of the n'th bucket. - - - - Gets the number of buckets. - - - - - Gets the total number of datapoints in the histogram. - - - - - Prints the buckets contained in the . - - - - - Kernel density estimation (KDE). - - - - - Estimate the probability density function of a random variable. - - - The routine assumes that the provided kernel is well defined, i.e. a real non-negative function that integrates to 1. - - - - - Estimate the probability density function of a random variable with a Gaussian kernel. - - - - - Estimate the probability density function of a random variable with an Epanechnikov kernel. - The Epanechnikov kernel is optimal in a mean square error sense. - - - - - Estimate the probability density function of a random variable with a uniform kernel. - - - - - Estimate the probability density function of a random variable with a triangular kernel. - - - - - A Gaussian kernel (PDF of Normal distribution with mean 0 and variance 1). - This kernel is the default. - - - - - Epanechnikov Kernel: - x => Math.Abs(x) <= 1.0 ? 3.0/4.0(1.0-x^2) : 0.0 - - - - - Uniform Kernel: - x => Math.Abs(x) <= 1.0 ? 1.0/2.0 : 0.0 - - - - - Triangular Kernel: - x => Math.Abs(x) <= 1.0 ? (1.0-Math.Abs(x)) : 0.0 - - - - - A hybrid Monte Carlo sampler for multivariate distributions. - - - - - Number of parameters in the density function. - - - - - Distribution to sample momentum from. - - - - - Standard deviations used in the sampling of different components of the - momentum. - - - - - Gets or sets the standard deviations used in the sampling of different components of the - momentum. - - When the length of pSdv is not the same as Length. - - - - Constructs a new Hybrid Monte Carlo sampler for a multivariate probability distribution. - The components of the momentum will be sampled from a normal distribution with standard deviation - 1 using the default random - number generator. A three point estimation will be used for differentiation. - This constructor will set the burn interval. - - The initial sample. - The log density of the distribution we want to sample from. - Number frog leap simulation steps. - Size of the frog leap simulation steps. - The number of iterations in between returning samples. - When the number of burnInterval iteration is negative. - - - - Constructs a new Hybrid Monte Carlo sampler for a multivariate probability distribution. - The components of the momentum will be sampled from a normal distribution with standard deviation - specified by pSdv using the default random - number generator. A three point estimation will be used for differentiation. - This constructor will set the burn interval. - - The initial sample. - The log density of the distribution we want to sample from. - Number frog leap simulation steps. - Size of the frog leap simulation steps. - The number of iterations in between returning samples. - The standard deviations of the normal distributions that are used to sample - the components of the momentum. - When the number of burnInterval iteration is negative. - - - - Constructs a new Hybrid Monte Carlo sampler for a multivariate probability distribution. - The components of the momentum will be sampled from a normal distribution with standard deviation - specified by pSdv using the a random number generator provided by the user. - A three point estimation will be used for differentiation. - This constructor will set the burn interval. - - The initial sample. - The log density of the distribution we want to sample from. - Number frog leap simulation steps. - Size of the frog leap simulation steps. - The number of iterations in between returning samples. - The standard deviations of the normal distributions that are used to sample - the components of the momentum. - Random number generator used for sampling the momentum. - When the number of burnInterval iteration is negative. - - - - Constructs a new Hybrid Monte Carlo sampler for a multivariate probability distribution. - The components of the momentum will be sampled from a normal distribution with standard deviations - given by pSdv. This constructor will set the burn interval, the method used for - numerical differentiation and the random number generator. - - The initial sample. - The log density of the distribution we want to sample from. - Number frog leap simulation steps. - Size of the frog leap simulation steps. - The number of iterations in between returning samples. - The standard deviations of the normal distributions that are used to sample - the components of the momentum. - Random number generator used for sampling the momentum. - The method used for numerical differentiation. - When the number of burnInterval iteration is negative. - When the length of pSdv is not the same as x0. - - - - Initialize parameters. - - The current location of the sampler. - - - - Checking that the location and the momentum are of the same dimension and that each component is positive. - - The standard deviations used for sampling the momentum. - When the length of pSdv is not the same as Length or if any - component is negative. - When pSdv is null. - - - - Use for copying objects in the Burn method. - - The source of copying. - A copy of the source object. - - - - Use for creating temporary objects in the Burn method. - - An object of type T. - - - - - - - - - - - - - Samples the momentum from a normal distribution. - - The momentum to be randomized. - - - - The default method used for computing the gradient. Uses a simple three point estimation. - - Function which the gradient is to be evaluated. - The location where the gradient is to be evaluated. - The gradient of the function at the point x. - - - - The Hybrid (also called Hamiltonian) Monte Carlo produces samples from distribution P using a set - of Hamiltonian equations to guide the sampling process. It uses the negative of the log density as - a potential energy, and a randomly generated momentum to set up a Hamiltonian system, which is then used - to sample the distribution. This can result in a faster convergence than the random walk Metropolis sampler - (). - - The type of samples this sampler produces. - - - - The delegate type that defines a derivative evaluated at a certain point. - - Function to be differentiated. - Value where the derivative is computed. - - - - Evaluates the energy function of the target distribution. - - - - - The current location of the sampler. - - - - - The number of burn iterations between two samples. - - - - - The size of each step in the Hamiltonian equation. - - - - - The number of iterations in the Hamiltonian equation. - - - - - The algorithm used for differentiation. - - - - - Gets or sets the number of iterations in between returning samples. - - When burn interval is negative. - - - - Gets or sets the number of iterations in the Hamiltonian equation. - - When frog leap steps is negative or zero. - - - - Gets or sets the size of each step in the Hamiltonian equation. - - When step size is negative or zero. - - - - Constructs a new Hybrid Monte Carlo sampler. - - The initial sample. - The log density of the distribution we want to sample from. - Number frog leap simulation steps. - Size of the frog leap simulation steps. - The number of iterations in between returning samples. - Random number generator used for sampling the momentum. - The method used for differentiation. - When the number of burnInterval iteration is negative. - When either x0, pdfLnP or diff is null. - - - - Returns a sample from the distribution P. - - - - - This method runs the sampler for a number of iterations without returning a sample - - - - - Method used to update the sample location. Used in the end of the loop. - - The old energy. - The old gradient/derivative of the energy. - The new sample. - The new gradient/derivative of the energy. - The new energy. - The difference between the old Hamiltonian and new Hamiltonian. Use to determine - if an update should take place. - - - - Use for creating temporary objects in the Burn method. - - An object of type T. - - - - Use for copying objects in the Burn method. - - The source of copying. - A copy of the source object. - - - - Method for doing dot product. - - First vector/scalar in the product. - Second vector/scalar in the product. - - - - Method for adding, multiply the second vector/scalar by factor and then - add it to the first vector/scalar. - - First vector/scalar. - Scalar factor multiplying by the second vector/scalar. - Second vector/scalar. - - - - Multiplying the second vector/scalar by factor and then subtract it from - the first vector/scalar. - - First vector/scalar. - Scalar factor to be multiplied to the second vector/scalar. - Second vector/scalar. - - - - Method for sampling a random momentum. - - Momentum to be randomized. - - - - The Hamiltonian equations that is used to produce the new sample. - - - - - Method to compute the Hamiltonian used in the method. - - The momentum. - The energy. - Hamiltonian=E+p.p/2 - - - - Method to check and set a quantity to a non-negative value. - - Proposed value to be checked. - Returns value if it is greater than or equal to zero. - Throws when value is negative. - - - - Method to check and set a quantity to a non-negative value. - - Proposed value to be checked. - Returns value if it is greater than to zero. - Throws when value is negative or zero. - - - - Method to check and set a quantity to a non-negative value. - - Proposed value to be checked. - Returns value if it is greater than zero. - Throws when value is negative or zero. - - - - Provides utilities to analysis the convergence of a set of samples from - a . - - - - - Computes the auto correlations of a series evaluated by a function f. - - The series for computing the auto correlation. - The lag in the series - The function used to evaluate the series. - The auto correlation. - Throws if lag is zero or if lag is - greater than or equal to the length of Series. - - - - Computes the effective size of the sample when evaluated by a function f. - - The samples. - The function use for evaluating the series. - The effective size when auto correlation is taken into account. - - - - A method which samples datapoints from a proposal distribution. The implementation of this sampler - is stateless: no variables are saved between two calls to Sample. This proposal is different from - in that it doesn't take any parameters; it samples random - variables from the whole domain. - - The type of the datapoints. - A sample from the proposal distribution. - - - - A method which samples datapoints from a proposal distribution given an initial sample. The implementation - of this sampler is stateless: no variables are saved between two calls to Sample. This proposal is different from - in that it samples locally around an initial point. In other words, it - makes a small local move rather than producing a global sample from the proposal. - - The type of the datapoints. - The initial sample. - A sample from the proposal distribution. - - - - A function which evaluates a density. - - The type of data the distribution is over. - The sample we want to evaluate the density for. - - - - A function which evaluates a log density. - - The type of data the distribution is over. - The sample we want to evaluate the log density for. - - - - A function which evaluates the log of a transition kernel probability. - - The type for the space over which this transition kernel is defined. - The new state in the transition. - The previous state in the transition. - The log probability of the transition. - - - - The interface which every sampler must implement. - - The type of samples this sampler produces. - - - - The random number generator for this class. - - - - - Keeps track of the number of accepted samples. - - - - - Keeps track of the number of calls to the proposal sampler. - - - - - Initializes a new instance of the class. - - Thread safe instances are two and half times slower than non-thread - safe classes. - - - - Gets or sets the random number generator. - - When the random number generator is null. - - - - Returns one sample. - - - - - Returns a number of samples. - - The number of samples we want. - An array of samples. - - - - Gets the acceptance rate of the sampler. - - - - - Metropolis-Hastings sampling produces samples from distribution P by sampling from a proposal distribution Q - and accepting/rejecting based on the density of P. Metropolis-Hastings sampling doesn't require that the - proposal distribution Q is symmetric in comparison to . It does need to - be able to evaluate the proposal sampler's log density though. All densities are required to be in log space. - - The Metropolis-Hastings sampler is a stateful sampler. It keeps track of where it currently is in the domain - of the distribution P. - - The type of samples this sampler produces. - - - - Evaluates the log density function of the target distribution. - - - - - Evaluates the log transition probability for the proposal distribution. - - - - - A function which samples from a proposal distribution. - - - - - The current location of the sampler. - - - - - The log density at the current location. - - - - - The number of burn iterations between two samples. - - - - - Constructs a new Metropolis-Hastings sampler using the default random number generator. This - constructor will set the burn interval. - - The initial sample. - The log density of the distribution we want to sample from. - The log transition probability for the proposal distribution. - A method that samples from the proposal distribution. - The number of iterations in between returning samples. - When the number of burnInterval iteration is negative. - - - - Gets or sets the number of iterations in between returning samples. - - When burn interval is negative. - - - - This method runs the sampler for a number of iterations without returning a sample - - - - - Returns a sample from the distribution P. - - - - - Metropolis sampling produces samples from distribution P by sampling from a proposal distribution Q - and accepting/rejecting based on the density of P. Metropolis sampling requires that the proposal - distribution Q is symmetric. All densities are required to be in log space. - - The Metropolis sampler is a stateful sampler. It keeps track of where it currently is in the domain - of the distribution P. - - The type of samples this sampler produces. - - - - Evaluates the log density function of the sampling distribution. - - - - - A function which samples from a proposal distribution. - - - - - The current location of the sampler. - - - - - The log density at the current location. - - - - - The number of burn iterations between two samples. - - - - - Constructs a new Metropolis sampler using the default random number generator. - - The initial sample. - The log density of the distribution we want to sample from. - A method that samples from the symmetric proposal distribution. - The number of iterations in between returning samples. - When the number of burnInterval iteration is negative. - - - - Gets or sets the number of iterations in between returning samples. - - When burn interval is negative. - - - - This method runs the sampler for a number of iterations without returning a sample - - - - - Returns a sample from the distribution P. - - - - - Rejection sampling produces samples from distribution P by sampling from a proposal distribution Q - and accepting/rejecting based on the density of P and Q. The density of P and Q don't need to - to be normalized, but we do need that for each x, P(x) < Q(x). - - The type of samples this sampler produces. - - - - Evaluates the density function of the sampling distribution. - - - - - Evaluates the density function of the proposal distribution. - - - - - A function which samples from a proposal distribution. - - - - - Constructs a new rejection sampler using the default random number generator. - - The density of the distribution we want to sample from. - The density of the proposal distribution. - A method that samples from the proposal distribution. - - - - Returns a sample from the distribution P. - - When the algorithms detects that the proposal - distribution doesn't upper bound the target distribution. - - - - A hybrid Monte Carlo sampler for univariate distributions. - - - - - Distribution to sample momentum from. - - - - - Standard deviations used in the sampling of the - momentum. - - - - - Gets or sets the standard deviation used in the sampling of the - momentum. - - When standard deviation is negative. - - - - Constructs a new Hybrid Monte Carlo sampler for a univariate probability distribution. - The momentum will be sampled from a normal distribution with standard deviation - specified by pSdv using the default random - number generator. A three point estimation will be used for differentiation. - This constructor will set the burn interval. - - The initial sample. - The log density of the distribution we want to sample from. - Number frog leap simulation steps. - Size of the frog leap simulation steps. - The number of iterations in between returning samples. - The standard deviation of the normal distribution that is used to sample - the momentum. - When the number of burnInterval iteration is negative. - - - - Constructs a new Hybrid Monte Carlo sampler for a univariate probability distribution. - The momentum will be sampled from a normal distribution with standard deviation - specified by pSdv using a random - number generator provided by the user. A three point estimation will be used for differentiation. - This constructor will set the burn interval. - - The initial sample. - The log density of the distribution we want to sample from. - Number frog leap simulation steps. - Size of the frog leap simulation steps. - The number of iterations in between returning samples. - The standard deviation of the normal distribution that is used to sample - the momentum. - Random number generator used to sample the momentum. - When the number of burnInterval iteration is negative. - - - - Constructs a new Hybrid Monte Carlo sampler for a multivariate probability distribution. - The momentum will be sampled from a normal distribution with standard deviation - given by pSdv using a random - number generator provided by the user. This constructor will set both the burn interval and the method used for - numerical differentiation. - - The initial sample. - The log density of the distribution we want to sample from. - Number frog leap simulation steps. - Size of the frog leap simulation steps. - The number of iterations in between returning samples. - The standard deviation of the normal distribution that is used to sample - the momentum. - The method used for numerical differentiation. - Random number generator used for sampling the momentum. - When the number of burnInterval iteration is negative. - - - - Use for copying objects in the Burn method. - - The source of copying. - A copy of the source object. - - - - Use for creating temporary objects in the Burn method. - - An object of type T. - - - - - - - - - - - - - Samples the momentum from a normal distribution. - - The momentum to be randomized. - - - - The default method used for computing the derivative. Uses a simple three point estimation. - - Function for which the derivative is to be evaluated. - The location where the derivative is to be evaluated. - The derivative of the function at the point x. - - - - Slice sampling produces samples from distribution P by uniformly sampling from under the pdf of P using - a technique described in "Slice Sampling", R. Neal, 2003. All densities are required to be in log space. - - The slice sampler is a stateful sampler. It keeps track of where it currently is in the domain - of the distribution P. - - - - - Evaluates the log density function of the target distribution. - - - - - The current location of the sampler. - - - - - The log density at the current location. - - - - - The number of burn iterations between two samples. - - - - - The scale of the slice sampler. - - - - - Constructs a new Slice sampler using the default random - number generator. The burn interval will be set to 0. - - The initial sample. - The density of the distribution we want to sample from. - The scale factor of the slice sampler. - When the scale of the slice sampler is not positive. - - - - Constructs a new slice sampler using the default random number generator. It - will set the number of burnInterval iterations and run a burnInterval phase. - - The initial sample. - The density of the distribution we want to sample from. - The number of iterations in between returning samples. - The scale factor of the slice sampler. - When the number of burnInterval iteration is negative. - When the scale of the slice sampler is not positive. - - - - Gets or sets the number of iterations in between returning samples. - - When burn interval is negative. - - - - Gets or sets the scale of the slice sampler. - - - - - This method runs the sampler for a number of iterations without returning a sample - - - - - Returns a sample from the distribution P. - - - - - Running statistics over a window of data, allows updating by adding values. - - - - - Gets the total number of samples. - - - - - Returns the minimum value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - - - - Returns the maximum value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - - - - Evaluates the sample mean, an estimate of the population mean. - Returns NaN if data is empty or if any entry is NaN. - - - - - Estimates the unbiased population variance from the provided samples. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - - - - Evaluates the variance from the provided full population. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - - - - Estimates the unbiased population standard deviation from the provided samples. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - - - - Evaluates the standard deviation from the provided full population. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - - - - Update the running statistics by adding another observed sample (in-place). - - - - - Update the running statistics by adding a sequence of observed sample (in-place). - - - - Replace ties with their mean (non-integer ranks). Default. - - - Replace ties with their minimum (typical sports ranking). - - - Replace ties with their maximum. - - - Permutation with increasing values at each index of ties. - - - - Running statistics accumulator, allows updating by adding values - or by combining two accumulators. - - - This type declares a DataContract for out of the box ephemeral serialization - with engines like DataContractSerializer, Protocol Buffers and FsPickler, - but does not guarantee any compatibility between versions. - It is not recommended to rely on this mechanism for durable persistence. - - - - - Gets the total number of samples. - - - - - Returns the minimum value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - - - - Returns the maximum value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - - - - Evaluates the sample mean, an estimate of the population mean. - Returns NaN if data is empty or if any entry is NaN. - - - - - Estimates the unbiased population variance from the provided samples. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - - - - Evaluates the variance from the provided full population. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - - - - Estimates the unbiased population standard deviation from the provided samples. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - - - - Evaluates the standard deviation from the provided full population. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - - - - Estimates the unbiased population skewness from the provided samples. - Uses a normalizer (Bessel's correction; type 2). - Returns NaN if data has less than three entries or if any entry is NaN. - - - - - Evaluates the population skewness from the full population. - Does not use a normalizer and would thus be biased if applied to a subset (type 1). - Returns NaN if data has less than two entries or if any entry is NaN. - - - - - Estimates the unbiased population excess kurtosis from the provided samples. - Uses a normalizer (Bessel's correction; type 2). - Returns NaN if data has less than four entries or if any entry is NaN. - - - - - Evaluates the population excess kurtosis from the full population. - Does not use a normalizer and would thus be biased if applied to a subset (type 1). - Returns NaN if data has less than three entries or if any entry is NaN. - - - - - Update the running statistics by adding another observed sample (in-place). - - - - - Update the running statistics by adding a sequence of observed sample (in-place). - - - - - Create a new running statistics over the combined samples of two existing running statistics. - - - - - Running weighted statistics accumulator, allows updating by adding values - or by combining two accumulators. Weights are reliability weights, not frequency weights. - - - This type declares a DataContract for out of the box ephemeral serialization - with engines like DataContractSerializer, Protocol Buffers and FsPickler, - but does not guarantee any compatibility between versions. - It is not recommended to rely on this mechanism for durable persistence. - - - - - Second moment - - - - - Third moment - - - - - Fourth moment - - - - - Total weight - - - - - Total of weights to the second power - - - - - Total of weights to the third power - - - - - Total of weights to the fourth power - - - - - The denominator in the variance calculation to perform a Bessel correction. - - - - - Gets the total number of samples with non-zero weight. - - - - - Returns the minimum value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - - - - Returns the maximum value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - - - - Evaluates the sample mean, an estimate of the population mean. - Returns NaN if data is empty or if any entry is NaN. - - - - - Estimates the unbiased population variance from the provided samples. - Will use the Bessel correction for reliability weighting. - Returns NaN if data has less than two entries or if any entry is NaN. - - - - - Evaluates the variance from the provided full population. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - - - - Estimates the unbiased population standard deviation from the provided samples. - Will use the Bessel correction for reliability weighting. - Returns NaN if data has less than two entries or if any entry is NaN. - - - - - Evaluates the standard deviation from the provided full population. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - - - - Estimates the unbiased population skewness from the provided samples. - Will use the Bessel correction for reliability weighting. - Returns NaN if data has less than three entries or if any entry is NaN. - - - - - Evaluates the population skewness from the full population. - Does not use a normalizer and would thus be biased if applied to a subset (type 1). - Returns NaN if data has less than two entries or if any entry is NaN. - - - - - Estimates the unbiased population excess kurtosis from the provided samples. - Will use the Bessel correction for reliability weighting. - Returns NaN if data has less than four entries or if any entry is NaN. - Equivalent formula for this for weighted distributions are unknown. - - - - - Evaluates the population excess kurtosis from the full population. - Does not use a normalizer and would thus be biased if applied to a subset (type 1). - Returns NaN if data has less than three entries or if any entry is NaN. - - - - - Evaluates the total weight of the population. - - - - - The Kish's Effective Sample Size - - - - - Update the running statistics by adding another observed sample (in-place). - - - - - Update the running statistics by adding a sequence of weighted observatopms (in-place). - - - - - Update the running statistics by adding a sequence of weighted observatopms (in-place). - - - - - Create a new running statistics over the combined samples of two existing running statistics. - - - - - Statistics operating on an array already sorted ascendingly. - - - - - - - - Returns the smallest value from the sorted data array (ascending). - - Sample array, must be sorted ascendingly. - - - - Returns the largest value from the sorted data array (ascending). - - Sample array, must be sorted ascendingly. - - - - Returns the order statistic (order 1..N) from the sorted data array (ascending). - - Sample array, must be sorted ascendingly. - One-based order of the statistic, must be between 1 and N (inclusive). - - - - Estimates the median value from the sorted data array (ascending). - Approximately median-unbiased regardless of the sample distribution (R8). - - Sample array, must be sorted ascendingly. - - - - Estimates the p-Percentile value from the sorted data array (ascending). - If a non-integer Percentile is needed, use Quantile instead. - Approximately median-unbiased regardless of the sample distribution (R8). - - Sample array, must be sorted ascendingly. - Percentile selector, between 0 and 100 (inclusive). - - - - Estimates the first quartile value from the sorted data array (ascending). - Approximately median-unbiased regardless of the sample distribution (R8). - - Sample array, must be sorted ascendingly. - - - - Estimates the third quartile value from the sorted data array (ascending). - Approximately median-unbiased regardless of the sample distribution (R8). - - Sample array, must be sorted ascendingly. - - - - Estimates the inter-quartile range from the sorted data array (ascending). - Approximately median-unbiased regardless of the sample distribution (R8). - - Sample array, must be sorted ascendingly. - - - - Estimates {min, lower-quantile, median, upper-quantile, max} from the sorted data array (ascending). - Approximately median-unbiased regardless of the sample distribution (R8). - - Sample array, must be sorted ascendingly. - - - - Estimates the tau-th quantile from the sorted data array (ascending). - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. - Approximately median-unbiased regardless of the sample distribution (R8). - - Sample array, must be sorted ascendingly. - Quantile selector, between 0.0 and 1.0 (inclusive). - - R-8, SciPy-(1/3,1/3): - Linear interpolation of the approximate medians for order statistics. - When tau < (2/3) / (N + 1/3), use x1. When tau >= (N - 1/3) / (N + 1/3), use xN. - - - - - Estimates the tau-th quantile from the sorted data array (ascending). - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified - by 4 parameters a, b, c and d, consistent with Mathematica. - - Sample array, must be sorted ascendingly. - Quantile selector, between 0.0 and 1.0 (inclusive). - a-parameter - b-parameter - c-parameter - d-parameter - - - - Estimates the tau-th quantile from the sorted data array (ascending). - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - - Sample array, must be sorted ascendingly. - Quantile selector, between 0.0 and 1.0 (inclusive). - Quantile definition, to choose what product/definition it should be consistent with - - - - Estimates the empirical cumulative distribution function (CDF) at x from the sorted data array (ascending). - - The data sample sequence. - The value where to estimate the CDF at. - - - - Estimates the quantile tau from the sorted data array (ascending). - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - - The data sample sequence. - Quantile value. - Rank definition, to choose how ties should be handled and what product/definition it should be consistent with - - - - Evaluates the rank of each entry of the sorted data array (ascending). - The rank definition can be specified to be compatible - with an existing system. - - - - - Returns the smallest value from the sorted data array (ascending). - - Sample array, must be sorted ascendingly. - - - - Returns the largest value from the sorted data array (ascending). - - Sample array, must be sorted ascendingly. - - - - Returns the order statistic (order 1..N) from the sorted data array (ascending). - - Sample array, must be sorted ascendingly. - One-based order of the statistic, must be between 1 and N (inclusive). - - - - Estimates the median value from the sorted data array (ascending). - Approximately median-unbiased regardless of the sample distribution (R8). - - Sample array, must be sorted ascendingly. - - - - Estimates the p-Percentile value from the sorted data array (ascending). - If a non-integer Percentile is needed, use Quantile instead. - Approximately median-unbiased regardless of the sample distribution (R8). - - Sample array, must be sorted ascendingly. - Percentile selector, between 0 and 100 (inclusive). - - - - Estimates the first quartile value from the sorted data array (ascending). - Approximately median-unbiased regardless of the sample distribution (R8). - - Sample array, must be sorted ascendingly. - - - - Estimates the third quartile value from the sorted data array (ascending). - Approximately median-unbiased regardless of the sample distribution (R8). - - Sample array, must be sorted ascendingly. - - - - Estimates the inter-quartile range from the sorted data array (ascending). - Approximately median-unbiased regardless of the sample distribution (R8). - - Sample array, must be sorted ascendingly. - - - - Estimates {min, lower-quantile, median, upper-quantile, max} from the sorted data array (ascending). - Approximately median-unbiased regardless of the sample distribution (R8). - - Sample array, must be sorted ascendingly. - - - - Estimates the tau-th quantile from the sorted data array (ascending). - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. - Approximately median-unbiased regardless of the sample distribution (R8). - - Sample array, must be sorted ascendingly. - Quantile selector, between 0.0 and 1.0 (inclusive). - - R-8, SciPy-(1/3,1/3): - Linear interpolation of the approximate medians for order statistics. - When tau < (2/3) / (N + 1/3), use x1. When tau >= (N - 1/3) / (N + 1/3), use xN. - - - - - Estimates the tau-th quantile from the sorted data array (ascending). - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified - by 4 parameters a, b, c and d, consistent with Mathematica. - - Sample array, must be sorted ascendingly. - Quantile selector, between 0.0 and 1.0 (inclusive). - a-parameter - b-parameter - c-parameter - d-parameter - - - - Estimates the tau-th quantile from the sorted data array (ascending). - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - - Sample array, must be sorted ascendingly. - Quantile selector, between 0.0 and 1.0 (inclusive). - Quantile definition, to choose what product/definition it should be consistent with - - - - Estimates the empirical cumulative distribution function (CDF) at x from the sorted data array (ascending). - - The data sample sequence. - The value where to estimate the CDF at. - - - - Estimates the quantile tau from the sorted data array (ascending). - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - - The data sample sequence. - Quantile value. - Rank definition, to choose how ties should be handled and what product/definition it should be consistent with - - - - Evaluates the rank of each entry of the sorted data array (ascending). - The rank definition can be specified to be compatible - with an existing system. - - - - - Extension methods to return basic statistics on set of data. - - - - - Returns the minimum value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - The sample data. - The minimum value in the sample data. - - - - Returns the minimum value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - The sample data. - The minimum value in the sample data. - - - - Returns the minimum value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - Null-entries are ignored. - - The sample data. - The minimum value in the sample data. - - - - Returns the maximum value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - The sample data. - The maximum value in the sample data. - - - - Returns the maximum value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - The sample data. - The maximum value in the sample data. - - - - Returns the maximum value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - Null-entries are ignored. - - The sample data. - The maximum value in the sample data. - - - - Returns the minimum absolute value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - The sample data. - The minimum value in the sample data. - - - - Returns the minimum absolute value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - The sample data. - The minimum value in the sample data. - - - - Returns the maximum absolute value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - The sample data. - The maximum value in the sample data. - - - - Returns the maximum absolute value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - The sample data. - The maximum value in the sample data. - - - - Returns the minimum magnitude and phase value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - The sample data. - The minimum value in the sample data. - - - - Returns the minimum magnitude and phase value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - The sample data. - The minimum value in the sample data. - - - - Returns the maximum magnitude and phase value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - The sample data. - The minimum value in the sample data. - - - - Returns the maximum magnitude and phase value in the sample data. - Returns NaN if data is empty or if any entry is NaN. - - The sample data. - The minimum value in the sample data. - - - - Evaluates the sample mean, an estimate of the population mean. - Returns NaN if data is empty or if any entry is NaN. - - The data to calculate the mean of. - The mean of the sample. - - - - Evaluates the sample mean, an estimate of the population mean. - Returns NaN if data is empty or if any entry is NaN. - - The data to calculate the mean of. - The mean of the sample. - - - - Evaluates the sample mean, an estimate of the population mean. - Returns NaN if data is empty or if any entry is NaN. - Null-entries are ignored. - - The data to calculate the mean of. - The mean of the sample. - - - - Evaluates the geometric mean. - Returns NaN if data is empty or if any entry is NaN. - - The data to calculate the geometric mean of. - The geometric mean of the sample. - - - - Evaluates the geometric mean. - Returns NaN if data is empty or if any entry is NaN. - - The data to calculate the geometric mean of. - The geometric mean of the sample. - - - - Evaluates the harmonic mean. - Returns NaN if data is empty or if any entry is NaN. - - The data to calculate the harmonic mean of. - The harmonic mean of the sample. - - - - Evaluates the harmonic mean. - Returns NaN if data is empty or if any entry is NaN. - - The data to calculate the harmonic mean of. - The harmonic mean of the sample. - - - - Estimates the unbiased population variance from the provided samples. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - A subset of samples, sampled from the full population. - - - - Estimates the unbiased population variance from the provided samples. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - A subset of samples, sampled from the full population. - - - - Estimates the unbiased population variance from the provided samples. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - Null-entries are ignored. - - A subset of samples, sampled from the full population. - - - - Evaluates the variance from the provided full population. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - The full population data. - - - - Evaluates the variance from the provided full population. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - The full population data. - - - - Evaluates the variance from the provided full population. - On a dataset of size N will use an N normalize and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - Null-entries are ignored. - - The full population data. - - - - Estimates the unbiased population standard deviation from the provided samples. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - A subset of samples, sampled from the full population. - - - - Estimates the unbiased population standard deviation from the provided samples. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - A subset of samples, sampled from the full population. - - - - Estimates the unbiased population standard deviation from the provided samples. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - Null-entries are ignored. - - A subset of samples, sampled from the full population. - - - - Evaluates the standard deviation from the provided full population. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - The full population data. - - - - Evaluates the standard deviation from the provided full population. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - The full population data. - - - - Evaluates the standard deviation from the provided full population. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - Null-entries are ignored. - - The full population data. - - - - Estimates the unbiased population skewness from the provided samples. - Uses a normalizer (Bessel's correction; type 2). - Returns NaN if data has less than three entries or if any entry is NaN. - - A subset of samples, sampled from the full population. - - - - Estimates the unbiased population skewness from the provided samples. - Uses a normalizer (Bessel's correction; type 2). - Returns NaN if data has less than three entries or if any entry is NaN. - Null-entries are ignored. - - A subset of samples, sampled from the full population. - - - - Evaluates the skewness from the full population. - Does not use a normalizer and would thus be biased if applied to a subset (type 1). - Returns NaN if data has less than two entries or if any entry is NaN. - - The full population data. - - - - Evaluates the skewness from the full population. - Does not use a normalizer and would thus be biased if applied to a subset (type 1). - Returns NaN if data has less than two entries or if any entry is NaN. - Null-entries are ignored. - - The full population data. - - - - Estimates the unbiased population kurtosis from the provided samples. - Uses a normalizer (Bessel's correction; type 2). - Returns NaN if data has less than four entries or if any entry is NaN. - - A subset of samples, sampled from the full population. - - - - Estimates the unbiased population kurtosis from the provided samples. - Uses a normalizer (Bessel's correction; type 2). - Returns NaN if data has less than four entries or if any entry is NaN. - Null-entries are ignored. - - A subset of samples, sampled from the full population. - - - - Evaluates the kurtosis from the full population. - Does not use a normalizer and would thus be biased if applied to a subset (type 1). - Returns NaN if data has less than three entries or if any entry is NaN. - - The full population data. - - - - Evaluates the kurtosis from the full population. - Does not use a normalizer and would thus be biased if applied to a subset (type 1). - Returns NaN if data has less than three entries or if any entry is NaN. - Null-entries are ignored. - - The full population data. - - - - Estimates the sample mean and the unbiased population variance from the provided samples. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN for mean if data is empty or if any entry is NaN and NaN for variance if data has less than two entries or if any entry is NaN. - - The data to calculate the mean of. - The mean of the sample. - - - - Estimates the sample mean and the unbiased population variance from the provided samples. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN for mean if data is empty or if any entry is NaN and NaN for variance if data has less than two entries or if any entry is NaN. - - The data to calculate the mean of. - The mean of the sample. - - - - Estimates the sample mean and the unbiased population standard deviation from the provided samples. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN for mean if data is empty or if any entry is NaN and NaN for standard deviation if data has less than two entries or if any entry is NaN. - - The data to calculate the mean of. - The mean of the sample. - - - - Estimates the sample mean and the unbiased population standard deviation from the provided samples. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN for mean if data is empty or if any entry is NaN and NaN for standard deviation if data has less than two entries or if any entry is NaN. - - The data to calculate the mean of. - The mean of the sample. - - - - Estimates the unbiased population skewness and kurtosis from the provided samples in a single pass. - Uses a normalizer (Bessel's correction; type 2). - - A subset of samples, sampled from the full population. - - - - Evaluates the skewness and kurtosis from the full population. - Does not use a normalizer and would thus be biased if applied to a subset (type 1). - - The full population data. - - - - Estimates the unbiased population covariance from the provided samples. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - A subset of samples, sampled from the full population. - A subset of samples, sampled from the full population. - - - - Estimates the unbiased population covariance from the provided samples. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - A subset of samples, sampled from the full population. - A subset of samples, sampled from the full population. - - - - Estimates the unbiased population covariance from the provided samples. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - Null-entries are ignored. - - A subset of samples, sampled from the full population. - A subset of samples, sampled from the full population. - - - - Evaluates the population covariance from the provided full populations. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - The full population data. - The full population data. - - - - Evaluates the population covariance from the provided full populations. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - The full population data. - The full population data. - - - - Evaluates the population covariance from the provided full populations. - On a dataset of size N will use an N normalize and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - Null-entries are ignored. - - The full population data. - The full population data. - - - - Evaluates the root mean square (RMS) also known as quadratic mean. - Returns NaN if data is empty or if any entry is NaN. - - The data to calculate the RMS of. - - - - Evaluates the root mean square (RMS) also known as quadratic mean. - Returns NaN if data is empty or if any entry is NaN. - - The data to calculate the RMS of. - - - - Evaluates the root mean square (RMS) also known as quadratic mean. - Returns NaN if data is empty or if any entry is NaN. - Null-entries are ignored. - - The data to calculate the mean of. - - - - Estimates the sample median from the provided samples (R8). - - The data sample sequence. - - - - Estimates the sample median from the provided samples (R8). - - The data sample sequence. - - - - Estimates the sample median from the provided samples (R8). - - The data sample sequence. - - - - Estimates the tau-th quantile from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - Quantile selector, between 0.0 and 1.0 (inclusive). - - - - Estimates the tau-th quantile from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - Quantile selector, between 0.0 and 1.0 (inclusive). - - - - Estimates the tau-th quantile from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - Quantile selector, between 0.0 and 1.0 (inclusive). - - - - Estimates the tau-th quantile from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Estimates the tau-th quantile from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Estimates the tau-th quantile from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Estimates the tau-th quantile from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - - The data sample sequence. - Quantile selector, between 0.0 and 1.0 (inclusive). - Quantile definition, to choose what product/definition it should be consistent with - - - - Estimates the tau-th quantile from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - - The data sample sequence. - Quantile selector, between 0.0 and 1.0 (inclusive). - Quantile definition, to choose what product/definition it should be consistent with - - - - Estimates the tau-th quantile from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - - The data sample sequence. - Quantile selector, between 0.0 and 1.0 (inclusive). - Quantile definition, to choose what product/definition it should be consistent with - - - - Estimates the tau-th quantile from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - - The data sample sequence. - Quantile definition, to choose what product/definition it should be consistent with - - - - Estimates the tau-th quantile from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - - The data sample sequence. - Quantile definition, to choose what product/definition it should be consistent with - - - - Estimates the tau-th quantile from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - - The data sample sequence. - Quantile definition, to choose what product/definition it should be consistent with - - - - Estimates the p-Percentile value from the provided samples. - If a non-integer Percentile is needed, use Quantile instead. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - Percentile selector, between 0 and 100 (inclusive). - - - - Estimates the p-Percentile value from the provided samples. - If a non-integer Percentile is needed, use Quantile instead. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - Percentile selector, between 0 and 100 (inclusive). - - - - Estimates the p-Percentile value from the provided samples. - If a non-integer Percentile is needed, use Quantile instead. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - Percentile selector, between 0 and 100 (inclusive). - - - - Estimates the p-Percentile value from the provided samples. - If a non-integer Percentile is needed, use Quantile instead. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Estimates the p-Percentile value from the provided samples. - If a non-integer Percentile is needed, use Quantile instead. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Estimates the p-Percentile value from the provided samples. - If a non-integer Percentile is needed, use Quantile instead. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Estimates the first quartile value from the provided samples. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Estimates the first quartile value from the provided samples. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Estimates the first quartile value from the provided samples. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Estimates the third quartile value from the provided samples. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Estimates the third quartile value from the provided samples. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Estimates the third quartile value from the provided samples. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Estimates the inter-quartile range from the provided samples. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Estimates the inter-quartile range from the provided samples. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Estimates the inter-quartile range from the provided samples. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Estimates {min, lower-quantile, median, upper-quantile, max} from the provided samples. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Estimates {min, lower-quantile, median, upper-quantile, max} from the provided samples. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Estimates {min, lower-quantile, median, upper-quantile, max} from the provided samples. - Approximately median-unbiased regardless of the sample distribution (R8). - - The data sample sequence. - - - - Returns the order statistic (order 1..N) from the provided samples. - - The data sample sequence. - One-based order of the statistic, must be between 1 and N (inclusive). - - - - Returns the order statistic (order 1..N) from the provided samples. - - The data sample sequence. - One-based order of the statistic, must be between 1 and N (inclusive). - - - - Returns the order statistic (order 1..N) from the provided samples. - - The data sample sequence. - - - - Returns the order statistic (order 1..N) from the provided samples. - - The data sample sequence. - - - - Evaluates the rank of each entry of the provided samples. - The rank definition can be specified to be compatible - with an existing system. - - The data sample sequence. - Rank definition, to choose how ties should be handled and what product/definition it should be consistent with - - - - Evaluates the rank of each entry of the provided samples. - The rank definition can be specified to be compatible - with an existing system. - - The data sample sequence. - Rank definition, to choose how ties should be handled and what product/definition it should be consistent with - - - - Evaluates the rank of each entry of the provided samples. - The rank definition can be specified to be compatible - with an existing system. - - The data sample sequence. - Rank definition, to choose how ties should be handled and what product/definition it should be consistent with - - - - Estimates the quantile tau from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - - The data sample sequence. - Quantile value. - Rank definition, to choose how ties should be handled and what product/definition it should be consistent with - - - - Estimates the quantile tau from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - - The data sample sequence. - Quantile value. - Rank definition, to choose how ties should be handled and what product/definition it should be consistent with - - - - Estimates the quantile tau from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - - The data sample sequence. - Quantile value. - Rank definition, to choose how ties should be handled and what product/definition it should be consistent with - - - - Estimates the quantile tau from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - - The data sample sequence. - Rank definition, to choose how ties should be handled and what product/definition it should be consistent with - - - - Estimates the quantile tau from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - - The data sample sequence. - Rank definition, to choose how ties should be handled and what product/definition it should be consistent with - - - - Estimates the quantile tau from the provided samples. - The tau-th quantile is the data value where the cumulative distribution - function crosses tau. The quantile definition can be specified to be compatible - with an existing system. - - The data sample sequence. - Rank definition, to choose how ties should be handled and what product/definition it should be consistent with - - - - Estimates the empirical cumulative distribution function (CDF) at x from the provided samples. - - The data sample sequence. - The value where to estimate the CDF at. - - - - Estimates the empirical cumulative distribution function (CDF) at x from the provided samples. - - The data sample sequence. - The value where to estimate the CDF at. - - - - Estimates the empirical cumulative distribution function (CDF) at x from the provided samples. - - The data sample sequence. - The value where to estimate the CDF at. - - - - Estimates the empirical cumulative distribution function (CDF) at x from the provided samples. - - The data sample sequence. - - - - Estimates the empirical cumulative distribution function (CDF) at x from the provided samples. - - The data sample sequence. - - - - Estimates the empirical cumulative distribution function (CDF) at x from the provided samples. - - The data sample sequence. - - - - Estimates the empirical inverse CDF at tau from the provided samples. - - The data sample sequence. - Quantile selector, between 0.0 and 1.0 (inclusive). - - - - Estimates the empirical inverse CDF at tau from the provided samples. - - The data sample sequence. - Quantile selector, between 0.0 and 1.0 (inclusive). - - - - Estimates the empirical inverse CDF at tau from the provided samples. - - The data sample sequence. - Quantile selector, between 0.0 and 1.0 (inclusive). - - - - Estimates the empirical inverse CDF at tau from the provided samples. - - The data sample sequence. - - - - Estimates the empirical inverse CDF at tau from the provided samples. - - The data sample sequence. - - - - Estimates the empirical inverse CDF at tau from the provided samples. - - The data sample sequence. - - - - Calculates the entropy of a stream of double values in bits. - Returns NaN if any of the values in the stream are NaN. - - The data sample sequence. - - - - Calculates the entropy of a stream of double values in bits. - Returns NaN if any of the values in the stream are NaN. - Null-entries are ignored. - - The data sample sequence. - - - - Evaluates the sample mean over a moving window, for each samples. - Returns NaN if no data is empty or if any entry is NaN. - - The sample stream to calculate the mean of. - The number of last samples to consider. - - - - Statistics operating on an IEnumerable in a single pass, without keeping the full data in memory. - Can be used in a streaming way, e.g. on large datasets not fitting into memory. - - - - - - - - Returns the smallest value from the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Returns the smallest value from the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Returns the largest value from the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Returns the largest value from the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Returns the smallest absolute value from the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Returns the smallest absolute value from the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Returns the largest absolute value from the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Returns the largest absolute value from the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Returns the smallest absolute value from the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Returns the smallest absolute value from the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Returns the largest absolute value from the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Returns the largest absolute value from the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Estimates the arithmetic sample mean from the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Estimates the arithmetic sample mean from the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Evaluates the geometric mean of the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Evaluates the geometric mean of the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Evaluates the harmonic mean of the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Evaluates the harmonic mean of the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Estimates the unbiased population variance from the provided samples as enumerable sequence, in a single pass without memoization. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Estimates the unbiased population variance from the provided samples as enumerable sequence, in a single pass without memoization. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Evaluates the population variance from the full population provided as enumerable sequence, in a single pass without memoization. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Evaluates the population variance from the full population provided as enumerable sequence, in a single pass without memoization. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Estimates the unbiased population standard deviation from the provided samples as enumerable sequence, in a single pass without memoization. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Estimates the unbiased population standard deviation from the provided samples as enumerable sequence, in a single pass without memoization. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Evaluates the population standard deviation from the full population provided as enumerable sequence, in a single pass without memoization. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Evaluates the population standard deviation from the full population provided as enumerable sequence, in a single pass without memoization. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Estimates the arithmetic sample mean and the unbiased population variance from the provided samples as enumerable sequence, in a single pass without memoization. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN for mean if data is empty or any entry is NaN, and NaN for variance if data has less than two entries or if any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Estimates the arithmetic sample mean and the unbiased population variance from the provided samples as enumerable sequence, in a single pass without memoization. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN for mean if data is empty or any entry is NaN, and NaN for variance if data has less than two entries or if any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Estimates the arithmetic sample mean and the unbiased population standard deviation from the provided samples as enumerable sequence, in a single pass without memoization. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN for mean if data is empty or any entry is NaN, and NaN for standard deviation if data has less than two entries or if any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Estimates the arithmetic sample mean and the unbiased population standard deviation from the provided samples as enumerable sequence, in a single pass without memoization. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN for mean if data is empty or any entry is NaN, and NaN for standard deviation if data has less than two entries or if any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Estimates the unbiased population covariance from the provided two sample enumerable sequences, in a single pass without memoization. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - First sample stream. - Second sample stream. - - - - Estimates the unbiased population covariance from the provided two sample enumerable sequences, in a single pass without memoization. - On a dataset of size N will use an N-1 normalizer (Bessel's correction). - Returns NaN if data has less than two entries or if any entry is NaN. - - First sample stream. - Second sample stream. - - - - Evaluates the population covariance from the full population provided as two enumerable sequences, in a single pass without memoization. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - First population stream. - Second population stream. - - - - Evaluates the population covariance from the full population provided as two enumerable sequences, in a single pass without memoization. - On a dataset of size N will use an N normalizer and would thus be biased if applied to a subset. - Returns NaN if data is empty or if any entry is NaN. - - First population stream. - Second population stream. - - - - Estimates the root mean square (RMS) also known as quadratic mean from the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Estimates the root mean square (RMS) also known as quadratic mean from the enumerable, in a single pass without memoization. - Returns NaN if data is empty or any entry is NaN. - - Sample stream, no sorting is assumed. - - - - Calculates the entropy of a stream of double values. - Returns NaN if any of the values in the stream are NaN. - - The input stream to evaluate. - - - - - Computes the basic statistics of data set. The class meets the - NIST standard of accuracy for mean, variance, and standard deviation - (the only statistics they provide exact values for) and exceeds them - in increased accuracy mode. - Recommendation: consider to use RunningWeightedStatistics instead. - - - This type declares a DataContract for out of the box ephemeral serialization - with engines like DataContractSerializer, Protocol Buffers and FsPickler, - but does not guarantee any compatibility between versions. - It is not recommended to rely on this mechanism for durable persistence. - - - - - Initializes a new instance of the class. - - The sample data. - - If set to true, increased accuracy mode used. - Increased accuracy mode uses types for internal calculations. - - - Don't use increased accuracy for data sets containing large values (in absolute value). - This may cause the calculations to overflow. - - - - - Initializes a new instance of the class. - - The sample data. - - If set to true, increased accuracy mode used. - Increased accuracy mode uses types for internal calculations. - - - Don't use increased accuracy for data sets containing large values (in absolute value). - This may cause the calculations to overflow. - - - - - Gets the size of the sample. - - The size of the sample. - - - - Gets the sample mean. - - The sample mean. - - - - Gets the unbiased population variance estimator (on a dataset of size N will use an N-1 normalizer). - - The sample variance. - - - - Gets the unbiased population standard deviation (on a dataset of size N will use an N-1 normalizer). - - The sample standard deviation. - - - - Gets the unbiased estimator of the population skewness. - - The sample skewness. - Returns zero if is less than three. - - - - Gets the unbiased estimator of the population excess kurtosis using the G_2 estimator. - - The sample kurtosis. - Returns zero if is less than four. - - - - Gets the maximum sample value. - - The maximum sample value. - - - - Gets the minimum sample value. - - The minimum sample value. - - - - Gets the total weight. When used with unweighted data, returns the number of samples. - - The total weight. - - - - The Kish's effective sample size https://en.wikipedia.org/wiki/Effective_sample_size - - The Kish's effective sample size. - - - - Computes descriptive statistics from a stream of data values and reliability weights. - - A sequence of datapoints. - - - - Computes descriptive statistics from a stream of data values and reliability weights. - - A sequence of datapoints. - - - - Internal use. Method use for setting the statistics. - - For setting Mean. - For setting Variance. - For setting Skewness. - For setting Kurtosis. - For setting Minimum. - For setting Maximum. - For setting Count. - - - - Used to simplify parallel code, particularly between the .NET 4.0 and Silverlight Code. - - - - - Executes a for loop in which iterations may run in parallel. - - The start index, inclusive. - The end index, exclusive. - The body to be invoked for each iteration range. - - - - Executes a for loop in which iterations may run in parallel. - - The start index, inclusive. - The end index, exclusive. - The partition size for splitting work into smaller pieces. - The body to be invoked for each iteration range. - - - - Executes each of the provided actions inside a discrete, asynchronous task. - - An array of actions to execute. - The actions array contains a null element. - At least one invocation of the actions threw an exception. - - - - Selects an item (such as Max or Min). - - Starting index of the loop. - Ending index of the loop - The function to select items over a subset. - The function to select the item of selection from the subsets. - The selected value. - - - - Selects an item (such as Max or Min). - - The array to iterate over. - The function to select items over a subset. - The function to select the item of selection from the subsets. - The selected value. - - - - Selects an item (such as Max or Min). - - Starting index of the loop. - Ending index of the loop - The function to select items over a subset. - The function to select the item of selection from the subsets. - Default result of the reduce function on an empty set. - The selected value. - - - - Selects an item (such as Max or Min). - - The array to iterate over. - The function to select items over a subset. - The function to select the item of selection from the subsets. - Default result of the reduce function on an empty set. - The selected value. - - - - Double-precision trigonometry toolkit. - - - - - Constant to convert a degree to grad. - - - - - Converts a degree (360-periodic) angle to a grad (400-periodic) angle. - - The degree to convert. - The converted grad angle. - - - - Converts a degree (360-periodic) angle to a radian (2*Pi-periodic) angle. - - The degree to convert. - The converted radian angle. - - - - Converts a grad (400-periodic) angle to a degree (360-periodic) angle. - - The grad to convert. - The converted degree. - - - - Converts a grad (400-periodic) angle to a radian (2*Pi-periodic) angle. - - The grad to convert. - The converted radian. - - - - Converts a radian (2*Pi-periodic) angle to a degree (360-periodic) angle. - - The radian to convert. - The converted degree. - - - - Converts a radian (2*Pi-periodic) angle to a grad (400-periodic) angle. - - The radian to convert. - The converted grad. - - - - Normalized Sinc function. sinc(x) = sin(pi*x)/(pi*x). - - - - - Trigonometric Sine of an angle in radian, or opposite / hypotenuse. - - The angle in radian. - The sine of the radian angle. - - - - Trigonometric Sine of a Complex number. - - The complex value. - The sine of the complex number. - - - - Trigonometric Cosine of an angle in radian, or adjacent / hypotenuse. - - The angle in radian. - The cosine of an angle in radian. - - - - Trigonometric Cosine of a Complex number. - - The complex value. - The cosine of a complex number. - - - - Trigonometric Tangent of an angle in radian, or opposite / adjacent. - - The angle in radian. - The tangent of the radian angle. - - - - Trigonometric Tangent of a Complex number. - - The complex value. - The tangent of the complex number. - - - - Trigonometric Cotangent of an angle in radian, or adjacent / opposite. Reciprocal of the tangent. - - The angle in radian. - The cotangent of an angle in radian. - - - - Trigonometric Cotangent of a Complex number. - - The complex value. - The cotangent of the complex number. - - - - Trigonometric Secant of an angle in radian, or hypotenuse / adjacent. Reciprocal of the cosine. - - The angle in radian. - The secant of the radian angle. - - - - Trigonometric Secant of a Complex number. - - The complex value. - The secant of the complex number. - - - - Trigonometric Cosecant of an angle in radian, or hypotenuse / opposite. Reciprocal of the sine. - - The angle in radian. - Cosecant of an angle in radian. - - - - Trigonometric Cosecant of a Complex number. - - The complex value. - The cosecant of a complex number. - - - - Trigonometric principal Arc Sine in radian - - The opposite for a unit hypotenuse (i.e. opposite / hypotenuse). - The angle in radian. - - - - Trigonometric principal Arc Sine of this Complex number. - - The complex value. - The arc sine of a complex number. - - - - Trigonometric principal Arc Cosine in radian - - The adjacent for a unit hypotenuse (i.e. adjacent / hypotenuse). - The angle in radian. - - - - Trigonometric principal Arc Cosine of this Complex number. - - The complex value. - The arc cosine of a complex number. - - - - Trigonometric principal Arc Tangent in radian - - The opposite for a unit adjacent (i.e. opposite / adjacent). - The angle in radian. - - - - Trigonometric principal Arc Tangent of this Complex number. - - The complex value. - The arc tangent of a complex number. - - - - Trigonometric principal Arc Cotangent in radian - - The adjacent for a unit opposite (i.e. adjacent / opposite). - The angle in radian. - - - - Trigonometric principal Arc Cotangent of this Complex number. - - The complex value. - The arc cotangent of a complex number. - - - - Trigonometric principal Arc Secant in radian - - The hypotenuse for a unit adjacent (i.e. hypotenuse / adjacent). - The angle in radian. - - - - Trigonometric principal Arc Secant of this Complex number. - - The complex value. - The arc secant of a complex number. - - - - Trigonometric principal Arc Cosecant in radian - - The hypotenuse for a unit opposite (i.e. hypotenuse / opposite). - The angle in radian. - - - - Trigonometric principal Arc Cosecant of this Complex number. - - The complex value. - The arc cosecant of a complex number. - - - - Hyperbolic Sine - - The hyperbolic angle, i.e. the area of the hyperbolic sector. - The hyperbolic sine of the angle. - - - - Hyperbolic Sine of a Complex number. - - The complex value. - The hyperbolic sine of a complex number. - - - - Hyperbolic Cosine - - The hyperbolic angle, i.e. the area of the hyperbolic sector. - The hyperbolic Cosine of the angle. - - - - Hyperbolic Cosine of a Complex number. - - The complex value. - The hyperbolic cosine of a complex number. - - - - Hyperbolic Tangent in radian - - The hyperbolic angle, i.e. the area of the hyperbolic sector. - The hyperbolic tangent of the angle. - - - - Hyperbolic Tangent of a Complex number. - - The complex value. - The hyperbolic tangent of a complex number. - - - - Hyperbolic Cotangent - - The hyperbolic angle, i.e. the area of the hyperbolic sector. - The hyperbolic cotangent of the angle. - - - - Hyperbolic Cotangent of a Complex number. - - The complex value. - The hyperbolic cotangent of a complex number. - - - - Hyperbolic Secant - - The hyperbolic angle, i.e. the area of the hyperbolic sector. - The hyperbolic secant of the angle. - - - - Hyperbolic Secant of a Complex number. - - The complex value. - The hyperbolic secant of a complex number. - - - - Hyperbolic Cosecant - - The hyperbolic angle, i.e. the area of the hyperbolic sector. - The hyperbolic cosecant of the angle. - - - - Hyperbolic Cosecant of a Complex number. - - The complex value. - The hyperbolic cosecant of a complex number. - - - - Hyperbolic Area Sine - - The real value. - The hyperbolic angle, i.e. the area of its hyperbolic sector. - - - - Hyperbolic Area Sine of this Complex number. - - The complex value. - The hyperbolic arc sine of a complex number. - - - - Hyperbolic Area Cosine - - The real value. - The hyperbolic angle, i.e. the area of its hyperbolic sector. - - - - Hyperbolic Area Cosine of this Complex number. - - The complex value. - The hyperbolic arc cosine of a complex number. - - - - Hyperbolic Area Tangent - - The real value. - The hyperbolic angle, i.e. the area of its hyperbolic sector. - - - - Hyperbolic Area Tangent of this Complex number. - - The complex value. - The hyperbolic arc tangent of a complex number. - - - - Hyperbolic Area Cotangent - - The real value. - The hyperbolic angle, i.e. the area of its hyperbolic sector. - - - - Hyperbolic Area Cotangent of this Complex number. - - The complex value. - The hyperbolic arc cotangent of a complex number. - - - - Hyperbolic Area Secant - - The real value. - The hyperbolic angle, i.e. the area of its hyperbolic sector. - - - - Hyperbolic Area Secant of this Complex number. - - The complex value. - The hyperbolic arc secant of a complex number. - - - - Hyperbolic Area Cosecant - - The real value. - The hyperbolic angle, i.e. the area of its hyperbolic sector. - - - - Hyperbolic Area Cosecant of this Complex number. - - The complex value. - The hyperbolic arc cosecant of a complex number. - - - - Hamming window. Named after Richard Hamming. - Symmetric version, useful e.g. for filter design purposes. - - - - - Hamming window. Named after Richard Hamming. - Periodic version, useful e.g. for FFT purposes. - - - - - Hann window. Named after Julius von Hann. - Symmetric version, useful e.g. for filter design purposes. - - - - - Hann window. Named after Julius von Hann. - Periodic version, useful e.g. for FFT purposes. - - - - - Cosine window. - Symmetric version, useful e.g. for filter design purposes. - - - - - Cosine window. - Periodic version, useful e.g. for FFT purposes. - - - - - Lanczos window. - Symmetric version, useful e.g. for filter design purposes. - - - - - Lanczos window. - Periodic version, useful e.g. for FFT purposes. - - - - - Gauss window. - - - - - Blackman window. - - - - - Blackman-Harris window. - - - - - Blackman-Nuttall window. - - - - - Bartlett window. - - - - - Bartlett-Hann window. - - - - - Nuttall window. - - - - - Flat top window. - - - - - Uniform rectangular (Dirichlet) window. - - - - - Triangular window. - - - - - Tukey tapering window. A rectangular window bounded - by half a cosine window on each side. - - Width of the window - Fraction of the window occupied by the cosine parts - -
    -
    diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Matrox.MatroxImagingLibrary.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Matrox.MatroxImagingLibrary.dll deleted file mode 100644 index c7eace9..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Matrox.MatroxImagingLibrary.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Matrox.MatroxImagingLibrary.v3.5.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Matrox.MatroxImagingLibrary.v3.5.dll deleted file mode 100644 index 0ac2482..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Matrox.MatroxImagingLibrary.v3.5.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Matrox.MatroxImagingLibrary.wpf.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Matrox.MatroxImagingLibrary.wpf.dll deleted file mode 100644 index 9f6645f..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Matrox.MatroxImagingLibrary.wpf.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Matrox.MatroxImagingLibrary.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/Matrox.MatroxImagingLibrary.xml deleted file mode 100644 index 219def7..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/Matrox.MatroxImagingLibrary.xml +++ /dev/null @@ -1,39904 +0,0 @@ - - - - Matrox.MatroxImagingLibrary - - - - Allocate a 3D display. - Specifies the system on which to allocate the 3D display. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to MIL_TEXT("M_DEFAULT"). - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D display identifier. - The returned value is the 3D display identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D display. - Specifies the system on which to allocate the 3D display. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to MIL_TEXT("M_DEFAULT"). - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D display identifier. - The returned value is the 3D display identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to control. - Specifies the new value to assign to the 3D display setting specified by the ControlType parameter. - - - Control a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to control. - Specifies the new value to assign to the 3D display setting specified by the ControlType parameter. - - - Control a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to control. - Specifies the new value to assign to the 3D display setting specified by the ControlType parameter. - - - Copy data to or from a 3D display. - Specifies the identifier of the source object. Note that if the source object is not a 3D display, the destination object must be. - Specifies the identifier of the destination object. Note that if the destination object is not a 3D display, the source object must be. - Specifies the type of copy operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a 3D display. - Specifies the identifier of a 3D display previously allocated with M3ddispAlloc. - - - Get information about the 3D display's view. - Specifies the identifier of the 3D display. - Specifies which aspect of the view to inquire. - Specifies the address of the variable in which to write either the X-coordinate, distance, azimuth, elevation, or roll. - Specifies the address of the variable in which to write either the Y-coordinate or elevation. - Specifies the address of the variable in which to write either the Z-coordinate or roll. - Reserved for future expansion and must be set to M_DEFAULT . - - - Get information about the 3D display's view. - Specifies the identifier of the 3D display. - Specifies which aspect of the view to inquire. - Specifies the address of the variable in which to write either the X-coordinate, distance, azimuth, elevation, or roll. - Specifies the address of the variable in which to write either the Y-coordinate or elevation. - Specifies the address of the variable in which to write either the Z-coordinate or roll. - Reserved for future expansion and must be set to M_DEFAULT . - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Add or remove a 3D-displayable container or fully-corrected depth map image buffer to/from the 3D display, and/or open or close the window associated with the 3D display. - Specifies the identifier of the 3D display, previously allocated using M3ddispAlloc. - Specifies the MIL identifier of the 3D-displayable container, or fully corrected depth map image buffer, to display. - Specifies the action to perform on the specified 3D display. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the point cloud container added to the 3D graphics list of the 3D display. - - - Select a 3D container to display in a user-defined window. - Specifies the identifier of the 3D display, previously allocated using M3ddispAlloc. - Specifies the MIL identifier of the 3D-displayable container, or fully corrected depth map image buffer, to display. - Specifies the action to perform on the specified 3D display. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the window handle of the user-defined window or child window. - Returns the label of the point cloud container added to the 3D graphics list of the 3D display. - - - Sets the display's view. - Specifies the identifier of the 3D display. - Specifies the mode used for setting the view. - Specifies the first parameter used to set the view. - Specifies the second parameter used to set the view. - Specifies the third parameter used to set the view. - Specifies if the 3D display should be refreshed. - - - Allocate a 3D geometry object or transformation matrix object. - Specifies the identifier of the system on which to allocate the 3D geometry object or transformation matrix object. - Specifies to allocate a 3D geometry object or transformation matrix object. This parameter must be set to one of the following: - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D geometry object or transformation matrix object identifier. - The returned value is the 3D geometry object or transformation matrix object identifier if allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D geometry object or transformation matrix object. - Specifies the identifier of the system on which to allocate the 3D geometry object or transformation matrix object. - Specifies to allocate a 3D geometry object or transformation matrix object. This parameter must be set to one of the following: - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D geometry object or transformation matrix object identifier. - The returned value is the 3D geometry object or transformation matrix object identifier if allocation is successful. If allocation fails, M_NULL is returned. - - - Define a 3D box geometry object. - Specifies the identifier of the 3D geometry object, previously allocated on the required system using M3dgeoAlloc with M_GEOMETRY. - Specifies how the box is defined. - Specifies the X-coordinate of the first point used to define the box. - Specifies the Y-coordinate of the first point used to define the box. - Specifies the Z-coordinate of the first point used to define the box. - Specifies the X-coordinate of the second point used to define the box, or the length of the box along the X-axis. - Specifies the Y-coordinate of the second point used to define the box, or the length of the box along the Y-axis. - Specifies the Z-coordinate of the second point used to define the box, or the length of the box along the Z-axis. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy attributes or settings to or from a 3D geometry object or transformation matrix object. - Specifies the identifier of the source object. Note that if the source object is not a predefined or user-defined 3D geometry object or transformation matrix object, the destination object must be. - Specifies the identifier of the destination object. Note that if the destination object is not a predefined or user-defined 3D geometry object or transformation matrix object, the source object must be. - Specifies the type of copy operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Define a 3D cylinder geometry object. - Specifies the identifier of the 3D geometry object, previously allocated on the required system using M3dgeoAlloc with M_GEOMETRY. - Specifies how the cylinder is defined. - Specifies the X-coordinate of a point on the cylinder's central axis. - Specifies the Y-coordinate of a point on the cylinder's central axis. - Specifies the Z-coordinate of a point on the cylinder's central axis. - Specifies the X-coordinate of the cylinder's second defining point, or the X-component of the cylinder's central axis vector. - Specifies the Y-coordinate of the cylinder's second defining point, or the Y-component of the cylinder's central axis vector. - Specifies the Z-coordinate of the cylinder's second defining point, or the Z-component of the cylinder's central axis vector. - Specifies the cylinder's radius. - Specifies to override the default cylinder length. - Reserved for future expansion and must be set to M_DEFAULT . - - - Draw the geometry, defined in the specified 3D geometry object, into a 3D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the identifier of the 3D geometry object to draw into the 3D graphics list. The 3D geometry object must have been previously allocated using M3dgeoAlloc with M_GEOMETRY, and defined using M3dgeoBox, M3dgeoCylinder, M3dgeoLine, M3dgeoPlane, or M3dgeoSphere. - Specifies the identifier of the 3D graphics list in which to draw. The 3D graphics list must have been previously allocated using M3dgraAlloc. - Specifies the label of the 3D graphic in the 3D graphics list to be used as the geometry's parent. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the 3D graphic added to the 3D graphics list. - - - Free a 3D geometry object or transformation matrix object. - Specifies the identifier of the 3D geometry object or transformation matrix object to free. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Define an arbitrary 3D line geometry object. - Specifies the identifier of the 3D geometry object, previously allocated on the required system using M3dgeoAlloc with M_GEOMETRY. - Specifies how the line is defined. - Specifies the X-coordinate of the first point used to define the line. - Specifies the Y-coordinate of the first point used to define the line. - Specifies the Z-coordinate of the first point used to define the line. - Specifies the X-coordinate of the second point used to define the line, or the X-component of the vector defining the line's direction and length (if Length is M_DEFAULT). - Specifies the Y-coordinate of the second point used to define the line, or the Y-component of the vector defining the line's direction and length (if Length is M_DEFAULT). - Specifies the Z-coordinate of the second point used to define the line, or the Z-component of the vector defining the line's direction and length (if Length is M_DEFAULT). - Specifies to override the default line length. - Reserved for future expansion and must be set to M_DEFAULT . - - - Get data from a transformation matrix object and place it in a user-supplied array. - Specifies the identifier of the source transformation matrix object. The transformation matrix object must have been previously allocated using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the user array in which to copy the data from the transformation matrix. - - - Get data from a transformation matrix object and place it in a user-supplied array. - Specifies the identifier of the source transformation matrix object. The transformation matrix object must have been previously allocated using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the user array in which to copy the data from the transformation matrix. - - - Get the translation, rotation, or scale defined by a given transformation matrix object. - Specifies the identifier of the transformation matrix object. The transformation matrix object must have been previously allocated using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Specifies the type of transformation to retrieve from the given transformation matrix object. - Specifies the first address in which to return information about the transformation required. - Specifies the second address in which to return information about the transformation required. - Specifies the third address in which to return information about the transformation required. - Specifies the fourth address in which to return information about the transformation required. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put data from a user-supplied array into a transformation matrix object. - Specifies the identifier of the transformation matrix object. The transformation matrix object must have been previously allocated using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the user array from which to copy the data into the transformation matrix object. - - - Put data from a user-supplied array into a transformation matrix object. - Specifies the identifier of the transformation matrix object. The transformation matrix object must have been previously allocated using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the user array from which to copy the data into the transformation matrix object. - - - Set the transformation values of a transformation matrix object. - Specifies the identifier of the transformation matrix object. The transformation matrix object must have been previously allocated using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Specifies the type of transformation to apply. - Specifies the first parameter used to define the transformation matrix. - Specifies the second parameter used to define the transformation matrix. - Specifies the third parameter used to define the transformation matrix. - Specifies the fourth parameter used to define the transformation matrix. - Specifies how to apply the transformation. - - - Defines a transformation matrix that can transform points from the working coordinate system into the specified coordinate system, or vice versa. - Specifies the identifier of the transformation matrix object, previously allocated on the required system using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Specifies which two axes to use to define the new coordinate system. The first letter determines the first axis, and the second letter determines the second axis. - Specifies the X-coordinate of the new coordinate system's origin, expressed in the working coordinate system. - Specifies the Y-coordinate of the new coordinate system's origin, expressed in the working coordinate system. - Specifies the Z-coordinate of the new coordinate system's origin, expressed in the working coordinate system. - Specifies the X-component of the vector aligned with the new coordinate system's first axis, expressed in the working coordinate system. - Specifies the Y-component of the vector aligned with the new coordinate system's first axis, expressed in the working coordinate system. - Specifies the Z-component of the vector aligned with the new coordinate system's first axis, expressed in the working coordinate system. - Specifies the approximate X-component of the vector aligned with the new coordinate system's second axis, expressed in the working coordinate system. - Specifies the approximate Y-component of the vector aligned with the new coordinate system's second axis, expressed in the working coordinate system. - Specifies the approximate Z-component of the vector aligned with the new coordinate system's second axis, expressed in the working coordinate system. - Reserved for future expansion and must be set to M_DEFAULT . - - - Define a 3D plane geometry object. - Specifies the identifier of the 3D geometry object, previously allocated on the required system using M3dgeoAlloc with M_GEOMETRY. - Specifies how the plane is defined. - Specifies the first parameter used to define the plane. - Specifies the second parameter used to define the plane. - Specifies the third parameter used to define the plane. - Specifies the fourth parameter used to define the plane. - Specifies the fifth parameter used to define the plane. - Specifies the sixth parameter used to define the plane. - Specifies the seventh parameter used to define the plane. - Specifies the eighth parameter used to define the plane. - Specifies the ninth parameter used to define the plane. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Restore a 3D geometry object or transformation matrix object from disk. - Specifies the name and path of the file from which to restore the 3D geometry object or transformation matrix object. - Specifies the system on which to restore the 3D geometry object or transformation matrix object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D geometry object or transformation matrix object identifier. - The returned value is the 3D geometry object or a transformation matrix object identifier. If allocation fails, M_NULL is returned. - - - Restore a 3D geometry object or transformation matrix object from disk. - Specifies the name and path of the file from which to restore the 3D geometry object or transformation matrix object. - Specifies the system on which to restore the 3D geometry object or transformation matrix object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D geometry object or transformation matrix object identifier. - The returned value is the 3D geometry object or a transformation matrix object identifier. If allocation fails, M_NULL is returned. - - - Save a 3D geometry object or transformation matrix object to a file. - Specifies the name and path of the file in which to save the 3D geometry object or transformation matrix object; it is recommended that you use the M3DGEO file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the 3D geometry object or transformation matrix object to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a 3D geometry object or transformation matrix object to a file. - Specifies the name and path of the file in which to save the 3D geometry object or transformation matrix object; it is recommended that you use the M3DGEO file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the 3D geometry object or transformation matrix object to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Define a 3D sphere geometry object. - Specifies the identifier of the 3D geometry object, previously allocated on the required system using M3dgeoAlloc with M_GEOMETRY. - Specifies the X-coordinate of the sphere's center. - Specifies the Y-coordinate of the sphere's center. - Specifies the Z-coordinate of the sphere's center. - Specifies the sphere's radius. This parameter cannot be set to a negative value. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Load, restore, or save a 3D geometry object or transformation matrix object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D geometry object or transformation matrix object. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D geometry object or transformation matrix object. - Specifies the MIL version of the 3D geometry object or transformation matrix object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D geometry object or transformation matrix object. - Specifies the address of the variable in which to write the size of the 3D geometry object or transformation matrix object, in bytes. - - - Load, restore, or save a 3D geometry object or transformation matrix object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D geometry object or transformation matrix object. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D geometry object or transformation matrix object. - Specifies the MIL version of the 3D geometry object or transformation matrix object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D geometry object or transformation matrix object. - Specifies the address of the variable in which to write the size of the 3D geometry object or transformation matrix object, in bytes. - - - Load, restore, or save a 3D geometry object or transformation matrix object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D geometry object or transformation matrix object. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D geometry object or transformation matrix object. - Specifies the MIL version of the 3D geometry object or transformation matrix object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D geometry object or transformation matrix object. - Specifies the address of the variable in which to write the size of the 3D geometry object or transformation matrix object, in bytes. - - - Load, restore, or save a 3D geometry object or transformation matrix object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D geometry object or transformation matrix object. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D geometry object or transformation matrix object. - Specifies the MIL version of the 3D geometry object or transformation matrix object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D geometry object or transformation matrix object. - Specifies the address of the variable in which to write the size of the 3D geometry object or transformation matrix object, in bytes. - - - Load, restore, or save a 3D geometry object or transformation matrix object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D geometry object or transformation matrix object. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D geometry object or transformation matrix object. - Specifies the MIL version of the 3D geometry object or transformation matrix object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D geometry object or transformation matrix object. - Specifies the address of the variable in which to write the size of the 3D geometry object or transformation matrix object, in bytes. - - - Load, restore, or save a 3D geometry object or transformation matrix object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D geometry object or transformation matrix object. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D geometry object or transformation matrix object. - Specifies the MIL version of the 3D geometry object or transformation matrix object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D geometry object or transformation matrix object. - Specifies the address of the variable in which to write the size of the 3D geometry object or transformation matrix object, in bytes. - - - Add a 3D-displayable point cloud container or fully corrected depth map image buffer to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the 3D-displayable point cloud container or fully corrected depth map image buffer. - Specifies the label of the parent of the 3D-displayable point cloud container or fully corrected depth map image buffer. - Specifies the identifier of the 3D-displayable point cloud container or fully corrected depth map image buffer to add to the 3D graphics list. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Returns the label of the 3D-displayable point cloud container or fully corrected depth map image buffer added to the 3D graphics list. - - - Allocate a 3D graphics list. - Specifies the system on which to allocate the 3D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D graphics list identifier. - The returned value is the 3D graphics list identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D graphics list. - Specifies the system on which to allocate the 3D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D graphics list identifier. - The returned value is the 3D graphics list identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Add a circular arc graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the arc graphic. - Specifies the label of the parent of the arc graphic in the 3D graphics list. - Specifies how the arc graphic is defined. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the X-coordinate of the first point used to define the arc. - Specifies the Y-coordinate of the first point used to define the arc. - Specifies the Z-coordinate of the first point used to define the arc. - Specifies the X-coordinate of the second point used to define the arc. - Specifies the Y-coordinate of the second point used to define the arc. - Specifies the Z-coordinate of the second point used to define the arc. - Specifies the X-coordinate of the third point used to define the arc. - Specifies the Y-coordinate of the third point used to define the arc. - Specifies the Z-coordinate of the third point used to define the arc. - Specifies the angle used to define the arc. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the arc graphic added to the 3D graphics list. - - - Add an axis graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the axis graphic. - Specifies the label of the parent of the axis graphic in the 3D graphics list. - Specifies the identifier of the transformation matrix that defines the axis graphic's position and orientation with respect to its parent's coordinate system. - Specifies the length of the axes. - Specifies an optional name for the axis graphic (for example, "Working coordinate system"). If this parameter is not empty, this creates a text graphic with the axis graphic as its parent, and the axis name as its text. - Specifies extra options for the appearance of the Name text graphic. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the axis graphic added to the 3D graphics list. - - - Add a box graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the box graphic. - Specifies the label of the parent of the box graphic in the 3D graphics list. - Specifies how the box graphic is defined. - Specifies the X-coordinate of the first point used to define the box graphic. - Specifies the Y-coordinate of the first point used to define the box graphic. - Specifies the Z-coordinate of the first point used to define the box graphic. - Specifies the X-coordinate of the second point used to define the box graphic, or the length of the box graphic along its coordinate system's X-axis. - Specifies the Y-coordinate of the second point used to define the box graphic, or the length of the box graphic along its coordinate system's Y-axis. - Specifies the Z-coordinate of the second point used to define the box graphic, or the length of the box graphic along its coordinate system's Z-axis. - Specifies the identifier of the transformation matrix that defines the box graphic's orientation with respect to its parent's coordinate system. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the box graphic added to the 3D graphics list. - - - Control the 3D graphics in a 3D graphics list, as well as their default settings. - Specifies the identifier of the 3D graphics list to control. - Specifies the label of the 3D graphic to control. You can also control the default settings of the 3D graphics list itself. - Specifies the type of setting to control. - Specifies the required value for the setting. - - - Control the 3D graphics in a 3D graphics list, as well as their default settings. - Specifies the identifier of the 3D graphics list to control. - Specifies the label of the 3D graphic to control. You can also control the default settings of the 3D graphics list itself. - Specifies the type of setting to control. - Specifies the required value for the setting. - - - Copy an object into or out of a 3D graphics list. - Specifies the identifier of the source object. - Specifies the label of the 3D graphic in SrcMilObjectId, when the source object is a 3D graphics list. - Specifies identifier of the destination object. - Specifies the label of the 3D graphic in DstMilObjectId, when the destination object is a 3D graphics list. - Specifies the type of copy operation. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the 3D graphic copied into the destination 3D graphics list. If the copy type does not return a new label in the destination 3D graphics list, this function returns M_NO_LABEL . - - - Add a cylinder graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the cylinder graphic. - Specifies the label of the parent of the cylinder graphic in the 3D graphics list. - Specifies how the cylinder graphic is defined. - Specifies the first parameter used to define the cylinder graphic. - Specifies the second parameter used to define the cylinder graphic. - Specifies the third parameter used to define the cylinder graphic. - Specifies the fourth parameter used to define the cylinder graphic. - Specifies the fifth parameter used to define the cylinder graphic. - Specifies the sixth parameter used to define the cylinder graphic. - Specifies the cylinder graphic's radius. - Specifies to override the default cylinder graphic's length. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the cylinder graphic added to the 3D graphics list. - - - Add a dots graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the dots graphic. - Specifies the label of the parent of the dots graphic in the 3D graphics list. - Specifies the number of points in the dots graphic. - Specifies the list of X-coordinates of the points in the dots graphic. - Specifies the list of Y-coordinates of the points in the dots graphic. - Specifies the list of Z-coordinates of the points in the dots graphic. - Specifies the list of red values of the color of the points in the dots graphic. - Specifies the list of green values of the color of the points in the dots graphic. - Specifies the list of blue values of the color of the points in the dots graphic. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the dots graphic added to the 3D graphics list. - - - Add a dots graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the dots graphic. - Specifies the label of the parent of the dots graphic in the 3D graphics list. - Specifies the number of points in the dots graphic. - Specifies the list of X-coordinates of the points in the dots graphic. - Specifies the list of Y-coordinates of the points in the dots graphic. - Specifies the list of Z-coordinates of the points in the dots graphic. - Specifies the list of red values of the color of the points in the dots graphic. - Specifies the list of green values of the color of the points in the dots graphic. - Specifies the list of blue values of the color of the points in the dots graphic. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the dots graphic added to the 3D graphics list. - - - Add a dots graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the dots graphic. - Specifies the label of the parent of the dots graphic in the 3D graphics list. - Specifies the number of points in the dots graphic. - Specifies the list of X-coordinates of the points in the dots graphic. - Specifies the list of Y-coordinates of the points in the dots graphic. - Specifies the list of Z-coordinates of the points in the dots graphic. - Specifies the list of red values of the color of the points in the dots graphic. - Specifies the list of green values of the color of the points in the dots graphic. - Specifies the list of blue values of the color of the points in the dots graphic. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the dots graphic added to the 3D graphics list. - - - Add a dots graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the dots graphic. - Specifies the label of the parent of the dots graphic in the 3D graphics list. - Specifies the number of points in the dots graphic. - Specifies the list of X-coordinates of the points in the dots graphic. - Specifies the list of Y-coordinates of the points in the dots graphic. - Specifies the list of Z-coordinates of the points in the dots graphic. - Specifies the list of red values of the color of the points in the dots graphic. - Specifies the list of green values of the color of the points in the dots graphic. - Specifies the list of blue values of the color of the points in the dots graphic. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the dots graphic added to the 3D graphics list. - - - Free a 3D graphics list. - Specifies the identifier of the 3D graphics list to free. - - - Add a grid graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the grid graphic. - Specifies the label of the parent of the grid graphic in the 3D graphics list. - Specifies how the grid graphic is defined. - Specifies the identifier of the transformation matrix that defines the grid graphic's position and orientation with respect to its parent's coordinate system. - Specifies the first parameter used to define the grid. - Specifies the second parameter used to define the grid. - Specifies the third parameter used to define the grid. - Specifies the fourth parameter used to define the grid. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the grid graphic added to the 3D graphics list. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Add a line graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the line graphic. - Specifies the label of the parent of the line graphic in the 3D graphics list. - Specifies how the line graphic is defined. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the first parameter used to define the line graphic. - Specifies the second parameter used to define the line graphic. - Specifies the third parameter used to define the line graphic. - Specifies the fourth parameter used to define the line graphic. - Specifies the fifth parameter used to define the line graphic. - Specifies the sixth parameter used to define the line graphic. - Specifies to override the default line graphic's length. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the line graphic added to the 3D graphics list. - - - Add a node to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the node. - Specifies the label of the parent of the node in the 3D graphics list. - Specifies the identifier of the transformation matrix that defines the node graphic's position and orientation with respect to its parent's coordinate system. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the node added to the 3D graphics list. - - - Add a plane graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the plane graphic. - Specifies the label of the parent of the plane graphic in the 3D graphics list. - Specifies how the plane graphic is defined. - Specifies the first parameter used to define the plane graphic. - Specifies the second parameter used to define the plane graphic. - Specifies the third parameter used to define the plane graphic. - Specifies the fourth parameter used to define the plane graphic. - Specifies the fifth parameter used to define the plane graphic. - Specifies the sixth parameter used to define the plane graphic. - Specifies the seventh parameter used to define the plane graphic. - Specifies the eighth parameter used to define the plane graphic. - Specifies the ninth parameter used to define the plane graphic. - Specifies the size of the plane graphic. Finite plane graphics are square-shaped. If the plane graphic is infinite, it is clipped using the 3D graphics list's clipping box, which results in a polygon with 3 to 6 edges. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Returns the label of the plane graphic added to the 3D graphics list. - - - Add a polygon graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the polygon graphic. - Specifies the label of the parent of the polygon graphic in the 3D graphics list. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the number of vertices in the polygon. - Specifies the list of X-coordinates of the vertices. - Specifies the list of Y-coordinates of the vertices. - Specifies the list of Z-coordinates of the vertices. - Specifies the list of X-coordinates of the points in the texture image that map to the specified vertices for the texture mapping. - Specifies the list of Y-coordinates of the points in the texture image that map to the specified vertices for the texture mapping. - Specifies the identifier of the image buffer to be used as a texture. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Returns the label of the polygon graphic added to the 3D graphics list. - - - Add a polygon graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the polygon graphic. - Specifies the label of the parent of the polygon graphic in the 3D graphics list. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the number of vertices in the polygon. - Specifies the list of X-coordinates of the vertices. - Specifies the list of Y-coordinates of the vertices. - Specifies the list of Z-coordinates of the vertices. - Specifies the list of X-coordinates of the points in the texture image that map to the specified vertices for the texture mapping. - Specifies the list of Y-coordinates of the points in the texture image that map to the specified vertices for the texture mapping. - Specifies the identifier of the image buffer to be used as a texture. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Returns the label of the polygon graphic added to the 3D graphics list. - - - Add a polygon graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the polygon graphic. - Specifies the label of the parent of the polygon graphic in the 3D graphics list. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the number of vertices in the polygon. - Specifies the list of X-coordinates of the vertices. - Specifies the list of Y-coordinates of the vertices. - Specifies the list of Z-coordinates of the vertices. - Specifies the list of X-coordinates of the points in the texture image that map to the specified vertices for the texture mapping. - Specifies the list of Y-coordinates of the points in the texture image that map to the specified vertices for the texture mapping. - Specifies the identifier of the image buffer to be used as a texture. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Returns the label of the polygon graphic added to the 3D graphics list. - - - Add a polygon graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the polygon graphic. - Specifies the label of the parent of the polygon graphic in the 3D graphics list. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the number of vertices in the polygon. - Specifies the list of X-coordinates of the vertices. - Specifies the list of Y-coordinates of the vertices. - Specifies the list of Z-coordinates of the vertices. - Specifies the list of X-coordinates of the points in the texture image that map to the specified vertices for the texture mapping. - Specifies the list of Y-coordinates of the points in the texture image that map to the specified vertices for the texture mapping. - Specifies the identifier of the image buffer to be used as a texture. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Returns the label of the polygon graphic added to the 3D graphics list. - - - Remove a 3D graphic from a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to remove the 3D graphic or node. - Specifies the label of the 3D graphic to remove. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a sphere graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the sphere graphic. - Specifies the label of the parent of the sphere graphic in the 3D graphics list. - Specifies the X-coordinate of the center of the sphere graphic. - Specifies the Y-coordinate of the center of the sphere graphic. - Specifies the Z-coordinate of the center of the sphere graphic. - Specifies the sphere graphic's radius. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the sphere graphic added to the 3D graphics list. - - - Add a text graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the text graphic. - Specifies the label of the parent of the text graphic in the 3D graphics list. - Specifies the address of the string containing the text that must be shown in the text graphic. - Specifies the identifier of the transformation matrix that defines the text graphic's position and orientation with respect to its parent's coordinate system. - Specifies extra options for the appearance of the text graphic. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the text graphic added to the 3D graphics list. - - - Allocate a 3D image processing context. - Specifies the identifier of the system on which to allocate the 3D image processing context. - Specifies the type of 3D image processing context to allocate. This parameter must be set to one of the following: - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D image processing context identifier. - The returned value is the 3D image processing context identifier if allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D image processing context. - Specifies the identifier of the system on which to allocate the 3D image processing context. - Specifies the type of 3D image processing context to allocate. This parameter must be set to one of the following: - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D image processing context identifier. - The returned value is the 3D image processing context identifier if allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D image processing result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D image processing result buffer identifier. - The returned value is the 3D image processing result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D image processing result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D image processing result buffer identifier. - The returned value is the 3D image processing result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Perform a point-to-point arithmetic operation on depth maps and 3D geometries. - Specifies the first source image buffer or 3D geometry object. - Specifies the second source image buffer or 3D geometry object. - Specifies the identifier of the destination image buffer in which to put the result of the arithmetic operation. - Specifies the identifier of the image buffer to use as a mask, if needed. - Specifies the operation to perform. - Specifies which Z-coordinate to select for geometries with more than 1 Z-coordinate for a given pair of X- and Y-coordinates. - Specifies how to handle the camera calibration information of the destination image buffer. - - - Estimate a recommended depth map image buffer size from a source container's point cloud. - Specifies a calculate map size 3D image processing context. - Specifies the identifier of the source container containing a 3D-processable point cloud. - Specifies the identifier of the axis-aligned 3D box geometry object to use to limit the calculation to points within the box. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the estimated depth map image buffer size in X. - Specifies the address of the variable in which to write the estimated depth map image buffer size in Y. - - - Calibrate an image buffer based on the bounding box of a container's point cloud or an axis-aligned 3D box geometry, to prepare the buffer to hold a depth or intensity map. - Specifies the identifier of the source point cloud container or 3D geometry object. - Specifies the identifier of the destination image buffer with which to associate the calibration information for a depth map. - Specifies the identifier of the destination image buffer with which to associate the calibration information for an intensity map. - Specifies the identifier of the MIL object that defines the relationship between the relative and absolute coordinate systems in the depth map. - Specifies how to adjust the X and Y pixel sizes. - Specifies the sign of the Z-scale. - Specifies where to place valid values in the depth map. - - - Control a 3D image processing context. - Specifies the identifier of the 3D image processing context to control. The context must have been previously allocated on the system using M3dimAlloc. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control a 3D image processing context. - Specifies the identifier of the 3D image processing context to control. The context must have been previously allocated on the system using M3dimAlloc. - Specifies the type of control to set. - Specifies the required value for the control. - - - Copy the extent box of a depth map into a 3D geometry. - Specifies the identifier of the source depth map image buffer. - Specifies the identifier of the destination 3D geometry object. - Specifies how to copy the depth map's extent box into the 3D geometry object. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy a group of results into a 3D geometry object or transformation matrix object. - Specifies the identifier of a 3D image processing result buffer. - Specifies the identifier of a 3D geometry object or transformation matrix object. - Specifies the type of copy operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Crop points in a point cloud based on a specified 3D geometry or calibrated mask image buffer. - Specifies the identifier of the source container containing a 3D-processable point cloud. - Specifies the identifier of the destination container in which to store the resulting point cloud. The container must have been previously allocated using MbufAllocContainer with M_PROC, and must not be a child container. - Specifies the identifier of the 3D geometry object or calibrated mask image buffer used to crop the points. - Reserved for future expansion and must be set to M_NULL . - Specifies how to organize the resulting point cloud. - Specifies which points to keep, relative to the cropping object set with ImageBufOrGeometry3dgeoId. - - - Fill gaps in a depth map and, optionally, an intensity map, according to gap filling context controls. - Specifies a fill gaps 3D image processing context. - Specifies the image buffer identifier of the depth map on which to fill gaps. - Specifies the image buffer identifier of the intensity map on which to fill gaps. The image buffer must be an 8-bit or 16-bit unsigned, 1-band or 3-band buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a 3D image processing context or result buffer. - Specifies the identifier of the 3D image processing context or result buffer to free. These must have been successfully allocated (using M3dimAlloc or M3dimAllocResult) prior to calling this function. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D image processing context. - Specifies the identifier of the 3D image processing context about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire about a 3D image processing context. - Specifies the identifier of the 3D image processing context about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire about a 3D image processing context. - Specifies the identifier of the 3D image processing context about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire about a 3D image processing context. - Specifies the identifier of the 3D image processing context about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire about a 3D image processing context. - Specifies the identifier of the 3D image processing context about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire about a 3D image processing context. - Specifies the identifier of the 3D image processing context about which to inquire information. - Specifies the setting to inquire. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire about a 3D image processing context. - Specifies the identifier of the 3D image processing context about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Apply the specified transformation matrix to the 3D points of a specified point cloud or to a 3D geometry. - Specifies the source point cloud container or 3D geometry object. - Specifies the destination container or 3D geometry object. - Specifies the identifier of the transformation matrix object. - Reserved for future expansion and must be set to M_DEFAULT . - - - Transform a list of 3D coordinates using the specified transformation matrix, and store the resulting coordinates in the specified destination arrays. - Specifies the identifier of the transformation matrix object. - Specifies the number of points in the arrays. - Specifies the address of the array that contains the source X-coordinates, or when ControlFlag is set to M_PACKED, the address of the array that contains a packed set of source X-, Y-, and Z-coordinates. - Specifies the address of the array that contains the source Y-coordinates. - Specifies the address of the array that contains the source Z-coordinates. - Specifies the address of the array in which to store the destination X-coordinates, or when ControlFlag is set to M_PACKED, the address of the array in which to store a packed set of destination X-, Y-, and Z-coordinates. - Specifies the address of the array in which to store the destination Y-coordinates. - Specifies the address of the array in which to store the destination Z-coordinates. - Specifies whether source or destination points are passed and/or returned in a packed format, or specifies to apply only rotation and scale transformations. - - - Transform a list of 3D coordinates using the specified transformation matrix, and store the resulting coordinates in the specified destination arrays. - Specifies the identifier of the transformation matrix object. - Specifies the number of points in the arrays. - Specifies the address of the array that contains the source X-coordinates, or when ControlFlag is set to M_PACKED, the address of the array that contains a packed set of source X-, Y-, and Z-coordinates. - Specifies the address of the array that contains the source Y-coordinates. - Specifies the address of the array that contains the source Z-coordinates. - Specifies the address of the array in which to store the destination X-coordinates, or when ControlFlag is set to M_PACKED, the address of the array in which to store a packed set of destination X-, Y-, and Z-coordinates. - Specifies the address of the array in which to store the destination Y-coordinates. - Specifies the address of the array in which to store the destination Z-coordinates. - Specifies whether source or destination points are passed and/or returned in a packed format, or specifies to apply only rotation and scale transformations. - - - Merge multiple point clouds into a single point cloud. - Specifies the address of the array that holds the identifiers of point cloud containers to merge. - Specifies the identifier of the destination container in which to store the resulting unorganized point cloud. The container must have been previously allocated using MbufAllocContainer with M_PROC, and must not be a child container. - Specifies the size of the array passed to SrcContainerBufIdArrayPtr. - Specifies the subsample 3D image processing context identifier, previously allocated using M3dimAlloc with M_SUBSAMPLE_CONTEXT. - Reserved for future expansion and must be set to M_DEFAULT . - - - Create a 3D mesh structure for a point cloud. - Specifies a mesh 3D image processing context. - Specifies the identifier of the 3D-processable point cloud container to use as the source. - Specifies the identifier of the destination container, previously allocated using MbufAllocContainer with M_PROC. - Reserved for future expansion and must be set to M_DEFAULT . - - - Compute a point cloud's unit normal vectors. - Specifies a normals 3D image processing context. - Specifies the identifier of the source container containing a 3D-processable point cloud. - Specifies the identifier of the destination container, previously allocated using MbufAllocContainer with M_PROC. - Reserved for future expansion and must be set to M_DEFAULT . - - - Takes the profile of a depth map or point cloud, along a specified slicing plane. - Specifies the identifier of the source point cloud container or depth map image buffer. - Specifies the identifier of the profile 3D image processing result buffer. The result buffer must have been allocated using M3dimAllocResult with M_PROFILE_RESULT. - Specifies the type of profile to generate. - Specifies the first parameter. Depends on ProfileType. - Specifies the second parameter. Depends on ProfileType. - Specifies the third parameter. Depends on ProfileType. - Specifies the fourth parameter. Depends on ProfileType. - Specifies the fifth parameter. Depends on ProfileType. - Reserved for future expansion and must be set to M_DEFAULT . - - - Project a point cloud or 3D geometry onto the XY (Z=0) plane to generate a fully corrected depth map. - Specifies a source container or 3D geometry object. - Specifies the identifier of the destination depth map image buffer, previously allocated using MbufAlloc2d. - Specifies the identifier of the destination intensity map image buffer. - Specifies the projection mode. - Specifies the overlap mode, which determines a pixel's gray level when multiple points correspond to the same destination depth map pixel. - Specifies additional options. - Reserved for future expansion and must be set to M_DEFAULT . - - - Remove 3D points from a point cloud, based on a specified condition. - Specifies the identifier of the source point cloud container, previously allocated using MbufAllocContainer with M_PROC. - Specifies the identifier of the destination container in which to place the modified point cloud. - Specifies which points to remove. - Reserved for future expansion and must be set to M_DEFAULT . - - - Restores a 3D image processing context from disk. - Specifies the name and path of the file from which to restore the 3D image processing context. - Specifies the system on which to restore the 3D image processing context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D image processing context identifier. - The returned value is the 3D image processing context identifier. If allocation fails, M_NULL is returned. - - - Restores a 3D image processing context from disk. - Specifies the name and path of the file from which to restore the 3D image processing context. - Specifies the system on which to restore the 3D image processing context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D image processing context identifier. - The returned value is the 3D image processing context identifier. If allocation fails, M_NULL is returned. - - - Rotate a specified point cloud or 3D geometry. - Specifies the source point cloud container or 3D geometry object. - Specifies the destination container or 3D geometry object. - Specifies the type of rotation to apply to the point cloud or 3D geometry. - Specifies an attribute of the rotation. - Specifies an attribute of the rotation. - Specifies an attribute of the rotation. - Specifies an attribute of the rotation. - Specifies the X-coordinate of the point around which the rotation is performed. - Specifies the Y-coordinate of the point around which the rotation is performed. - Specifies the Z-coordinate of the point around which the rotation is performed. - Reserved for future expansion and must be set to M_DEFAULT . - - - Subsample a point cloud to generate a less dense point cloud, or sample a meshed point cloud to generate a denser point cloud. - Specifies a subsample or surface sample 3D image processing context. - Specifies the identifier of the source container containing a 3D-processable point cloud. - Specifies the identifier of the destination container in which to place the generated point cloud. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a 3D image processing context to a file. - Specifies the name and path of the file in which to save the 3D image processing context; it is recommended that you use the M3DIM file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the 3D image processing context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a 3D image processing context to a file. - Specifies the name and path of the file in which to save the 3D image processing context; it is recommended that you use the M3DIM file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the 3D image processing context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Scale a specified point cloud or 3D geometry. - Specifies a source point cloud container or 3D geometry object. - Specifies the destination container or 3D geometry object. - Specifies the factor by which to scale in X. - Specifies the factor by which to scale in Y. - Specifies the factor by which to scale in Z. - Specifies the X-coordinate of the point that defines the center of the scaling operation. - Specifies the Y-coordinate of the point that defines the center of the scaling operation. - Specifies the Z-coordinate of the point that defines the center of the scaling operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Compute a variety of statistics on a point cloud or depth map. - Specifies a previously allocated statistics 3D image processing context (used to evaluate multiple statistical calculations), or a predefined statistics 3D image processing context (used to evaluate a single statistical calculation). - Specifies the identifier of the source container containing a 3D-processable point cloud, or specifies the identifier of the source depth map image buffer. - Specifies the identifier of the statistics 3D image processing result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a 3D image processing context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D image processing context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D image processing context. - Specifies the MIL version of the 3D image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D image processing context. - Specifies the address of the variable in which to write the size of the 3D image processing context, in bytes. - - - Load, restore, or save a 3D image processing context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D image processing context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D image processing context. - Specifies the MIL version of the 3D image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D image processing context. - Specifies the address of the variable in which to write the size of the 3D image processing context, in bytes. - - - Load, restore, or save a 3D image processing context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D image processing context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D image processing context. - Specifies the MIL version of the 3D image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D image processing context. - Specifies the address of the variable in which to write the size of the 3D image processing context, in bytes. - - - Load, restore, or save a 3D image processing context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D image processing context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D image processing context. - Specifies the MIL version of the 3D image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D image processing context. - Specifies the address of the variable in which to write the size of the 3D image processing context, in bytes. - - - Load, restore, or save a 3D image processing context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D image processing context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D image processing context. - Specifies the MIL version of the 3D image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D image processing context. - Specifies the address of the variable in which to write the size of the 3D image processing context, in bytes. - - - Load, restore, or save a 3D image processing context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D image processing context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D image processing context. - Specifies the MIL version of the 3D image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D image processing context. - Specifies the address of the variable in which to write the size of the 3D image processing context, in bytes. - - - Translate a specified point cloud or 3D geometry. - Specifies a source point cloud container or 3D geometry object. - Specifies the destination container or 3D geometry object. - Specifies the displacement in the X-direction. - Specifies the displacement in the Y-direction. - Specifies the displacement in the Z-direction. - Reserved for future expansion and must be set to M_DEFAULT . - - - Extract laser line data from an image and store this data in a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction context. - Specifies the identifier of the 3D reconstruction result buffer in which to store the laser line data. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_LASER_CALIBRATION_DATA, M_POINT_CLOUD_RESULT, or M_DEPTH_CORRECTED_DATA. - Specifies the identifier of the image buffer containing the grabbed image of the laser line. - Specifies the identifier of the image buffer containing the intensity map, if using a 3D camera. - Reserved for future expansion. This parameter must be set to M_NULL . - Specifies the label of the point cloud in the result buffer in which to add the laser line data, if the result buffer has been allocated using M3dmapAllocResult with M_POINT_CLOUD_RESULT. - Specifies the function's control flag. This parameter must be set to one of the following values: - - - Allocate a 3D reconstruction context or a 3D draw context. - Specifies the identifier of the system on which to allocate the 3D reconstruction context or 3D draw context. - Specifies to allocate a 3D reconstruction context or 3D draw context. This parameter must be set to one of the following: - Specifies the 3D reconstruction mode of the context, which determines how data is represented. - Specifies the address of the variable in which to write the 3D reconstruction context or 3D draw context. - The returned value is the 3D reconstruction context or 3D draw context identifier if allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D reconstruction context or a 3D draw context. - Specifies the identifier of the system on which to allocate the 3D reconstruction context or 3D draw context. - Specifies to allocate a 3D reconstruction context or 3D draw context. This parameter must be set to one of the following: - Specifies the 3D reconstruction mode of the context, which determines how data is represented. - Specifies the address of the variable in which to write the 3D reconstruction context or 3D draw context. - The returned value is the 3D reconstruction context or 3D draw context identifier if allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D reconstruction result buffer. - Specifies the identifier of the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. This parameter must be set to the following value: - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D reconstruction result buffer identifier. - The returned value is the 3D reconstruction result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D reconstruction result buffer. - Specifies the identifier of the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. This parameter must be set to the following value: - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D reconstruction result buffer identifier. - The returned value is the 3D reconstruction result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Calibrate a 3D reconstruction setup. - Specifies the identifier of the 3D reconstruction context used to extract the laser line from grabbed images. - Specifies the identifier of the 3D reconstruction result buffer that contains the laser line data required for calibration. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult and contain data for at least one laser line. - Specifies the identifier of the camera calibration context that contains the 3D camera calibration data or M_NULL . - Reserved for future expansion and must be set to M_DEFAULT . - - - Calibrate a 3D reconstruction setup that uses multiple camera-laser pairs. - Specifies the address of an array containing the identifiers of the 3D reconstruction context used to extract the laser line from grabbed images. - Specifies the address of an array containing the identifiers of the 3D reconstruction result buffers that contains the laser line data required for calibration. - Specifies the address of an array containing the identifiers of the camera calibration contexts of the cameras used to grab the laser lines. - Specifies the number of camera-laser pairs. - Specifies the function's control flag. - - - Clear a 3D reconstruction result buffer of some or all of its content. - Specifies the identifier of the 3D reconstruction result buffer to clear. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Control a profiling 3D reconstruction context, draw 3D reconstruction context, or 3D reconstruction result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or 3D reconstruction result buffer whose setting to modify. The profiling 3D reconstruction context or draw 3D reconstruction context must have been previously allocated using M3dmapAlloc with M_LASER or M_DRAW_3D_CONTEXT, respectively. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_DEPTH_CORRECTED_DATA, M_LASER_CALIBRATION_DATA, or M_POINT_CLOUD_RESULT. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, to control. - Specifies the type of setting to control. - Specifies the required value for the setting. - - - Control a profiling 3D reconstruction context, draw 3D reconstruction context, or 3D reconstruction result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or 3D reconstruction result buffer whose setting to modify. The profiling 3D reconstruction context or draw 3D reconstruction context must have been previously allocated using M3dmapAlloc with M_LASER or M_DRAW_3D_CONTEXT, respectively. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_DEPTH_CORRECTED_DATA, M_LASER_CALIBRATION_DATA, or M_POINT_CLOUD_RESULT. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, to control. - Specifies the type of setting to control. - Specifies the required value for the setting. - - - Copy one or more point clouds from one M_POINT_CLOUD_RESULT result buffer to another. - Specifies the identifier of the 3D reconstruction result buffer containing the source point clouds to copy/move. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_RESULT. - Specifies the point cloud(s) to copy/move from the source M_POINT_CLOUD_RESULT result buffer. - Specifies the identifier of the 3D reconstruction result buffer in which to copy/move the source point cloud(s). The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_RESULT. You can specify the same identifier as the SrcResult3dmapId identifier, but the label to assign the copied/moved point cloud must be different. - Specifies a new label in the destination M_POINT_CLOUD_RESULT result buffer in which to copy/move the source point cloud(s). - Specifies the type of operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy a group of results from a 3D reconstruction result buffer into a container or an image buffer. - Specifies the identifier of the 3D reconstruction result buffer containing point cloud or laser line data. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer to copy. - Specifies the identifier of the destination container or image buffer in which to save the copied information. - Specifies the type of copy operation to perform. - Specifies whether to copy reflectance values, when the SrcResult3dmapId parameter is set to an M_POINT_CLOUD_RESULT result buffer. - - - Generate an image from a 3D reconstruction context or result buffer. - Specifies the identifier of the 2D graphics context to use. This parameter must be set to one of the following values: - Specifies the identifier of a 3D reconstruction context or result buffer. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies what to draw in the destination image buffer or 2D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - - - Draw 3D annotations based on a laser line profiling 3D reconstruction context. - Specifies the identifier of the 3D draw context that specifies the annotations to draw and how to draw them. This parameter must be set to one of the following values: - Specifies the identifier of the laser line profiling 3D reconstruction context, previously allocated using M3dmapAlloc with M_LASER and M_CALIBRATED_CAMERA_LINEAR_MOTION. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the identifier of the 3D graphics list in which to draw. You can specify a 3D graphics list that you have previously allocated using M3dgraAlloc, or you can specify the identifier of the 3D display's internal graphics list (inquired using M3ddispInquire with M_3D_GRAPHIC_LIST_ID). - Specifies the label of the 3D graphic in the 3D graphics list to be used as the annotation's parent. - Specifies the identifier of the image buffer containing the texture image, which you can apply to the drawn laser plane to enhance its visibility. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the parent label of the graphics added to the graphics list. - - - Free a 3D reconstruction context or a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction context or 3D reconstruction result buffer to free. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Restore a 3D object from disk. - Specifies the name and directory of the file from which to restore the 3D object. - Specifies the system on which to restore the 3D object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D object identifier. - The returned value is the 3D object identifier. If allocation fails, M_NULL is returned. - - - Restore a 3D object from disk. - Specifies the name and directory of the file from which to restore the 3D object. - Specifies the system on which to restore the 3D object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D object identifier. - The returned value is the 3D object identifier. If allocation fails, M_NULL is returned. - - - Save a 3D object to a file. - Specifies the name and directory of the file in which to save the 3D object. The recommended extension is M3D. - Specifies the identifier of the 3D object to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a 3D object to a file. - Specifies the name and directory of the file in which to save the 3D object. The recommended extension is M3D. - Specifies the identifier of the 3D object to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a 3D object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D object. - Specifies the operation to perform on the 3D object. - Specifies the type of stream in which to store/from which to restore the 3D object. - Specifies the MIL version of the 3D object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D object. - Specifies the address of the variable in which to write the size of the 3D object, in bytes. - - - Load, restore, or save a 3D object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D object. - Specifies the operation to perform on the 3D object. - Specifies the type of stream in which to store/from which to restore the 3D object. - Specifies the MIL version of the 3D object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D object. - Specifies the address of the variable in which to write the size of the 3D object, in bytes. - - - Load, restore, or save a 3D object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D object. - Specifies the operation to perform on the 3D object. - Specifies the type of stream in which to store/from which to restore the 3D object. - Specifies the MIL version of the 3D object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D object. - Specifies the address of the variable in which to write the size of the 3D object, in bytes. - - - Load, restore, or save a 3D object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D object. - Specifies the operation to perform on the 3D object. - Specifies the type of stream in which to store/from which to restore the 3D object. - Specifies the MIL version of the 3D object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D object. - Specifies the address of the variable in which to write the size of the 3D object, in bytes. - - - Load, restore, or save a 3D object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D object. - Specifies the operation to perform on the 3D object. - Specifies the type of stream in which to store/from which to restore the 3D object. - Specifies the MIL version of the 3D object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D object. - Specifies the address of the variable in which to write the size of the 3D object, in bytes. - - - Load, restore, or save a 3D object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D object. - Specifies the operation to perform on the 3D object. - Specifies the type of stream in which to store/from which to restore the 3D object. - Specifies the MIL version of the 3D object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D object. - Specifies the address of the variable in which to write the size of the 3D object, in bytes. - - - Perform stereo vision triangulation to find the 3D world coordinates of points from their pixel location in the image plane of two or more cameras. - Specifies the address of an array containing the identifiers of the camera calibration contexts for each of the camera setups. - Specifies the address of the array containing the X-pixel coordinates of the common points in the image plane of each camera. - Specifies the address of the array containing the Y-pixel coordinates of the common points in the image plane of each camera. This array must have a size equal to ( NumCalibrations x NumPoints). - Specifies the address of an array in which to write the calculated X-world coordinates. - Specifies the address of the array in which to write the calculated Y-world coordinates. - Specifies the address of the array in which to write the calculated Z-world coordinates. - Specifies the address of the array in which to write the root mean square (RMS) error for the calculated world coordinates of each point. - Specifies the number of camera calibration contexts. This should correspond to the number of cameras. This parameter must be greater or equal to 2. - Specifies the number of points to compute using stereo vision triangulation. This parameter must be greater or equal to 1. - Specifies the world coordinate system that is common to all the specified camera calibration contexts. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform stereo vision triangulation to find the 3D world coordinates of points from their pixel location in the image plane of two or more cameras. - Specifies the address of an array containing the identifiers of the camera calibration contexts for each of the camera setups. - Specifies the address of the array containing the X-pixel coordinates of the common points in the image plane of each camera. - Specifies the address of the array containing the Y-pixel coordinates of the common points in the image plane of each camera. This array must have a size equal to ( NumCalibrations x NumPoints). - Specifies the address of an array in which to write the calculated X-world coordinates. - Specifies the address of the array in which to write the calculated Y-world coordinates. - Specifies the address of the array in which to write the calculated Z-world coordinates. - Specifies the address of the array in which to write the root mean square (RMS) error for the calculated world coordinates of each point. - Specifies the number of camera calibration contexts. This should correspond to the number of cameras. This parameter must be greater or equal to 2. - Specifies the number of points to compute using stereo vision triangulation. This parameter must be greater or equal to 1. - Specifies the world coordinate system that is common to all the specified camera calibration contexts. - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate a 3D metrology context. - Specifies the system on which to allocate the 3D metrology context. - Specifies the type of 3D metrology context to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the identifier of the 3D metrology context, if allocation is successful. Since M3dmetAlloc also returns the 3D metrology context identifier, you can set this parameter to M_NULL . - The returned value is the 3D metrology context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D metrology context. - Specifies the system on which to allocate the 3D metrology context. - Specifies the type of 3D metrology context to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the identifier of the 3D metrology context, if allocation is successful. Since M3dmetAlloc also returns the 3D metrology context identifier, you can set this parameter to M_NULL . - The returned value is the 3D metrology context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocates a 3D metrology result buffer. - Specifies the identifier of the system on which to allocate the 3D metrology result buffer. - Specifies the type of 3D metrology result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D metrology result buffer identifier, if allocation is successful. Since M3dmetAllocResult also returns the 3D metrology result buffer identifier, you can set this parameter to M_NULL . - The returned value is the 3D metrology result buffer's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocates a 3D metrology result buffer. - Specifies the identifier of the system on which to allocate the 3D metrology result buffer. - Specifies the type of 3D metrology result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D metrology result buffer identifier, if allocation is successful. Since M3dmetAllocResult also returns the 3D metrology result buffer identifier, you can set this parameter to M_NULL . - The returned value is the 3D metrology result buffer's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a setting for a 3D metrology context. - Specifies the identifier of the fit 3D metrology context or statistics 3D metrology context to control. - Specifies the setting to control. - Specifies the value needed for the control. - - - Control a setting for a 3D metrology context. - Specifies the identifier of the fit 3D metrology context or statistics 3D metrology context to control. - Specifies the setting to control. - Specifies the value needed for the control. - - - Copy a 3D geometry into, or out of, a fit 3D metrology context. - Specifies the MIL object from which to copy the 3D geometry. - Specifies the identifier of the MIL object in which to copy the 3D geometry. - Specifies the type of copy operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy a group of results from a fit 3D metrology result buffer into an image buffer, 3D geometry object, or a transformation matrix. - Specifies the identifier of the fit 3D metrology result buffer from which to copy results. The fit 3D metrology context must have been allocated using M3dmetAllocResult with M_FIT_RESULT, and must contain the results of a call to M3dmetFit. - Specifies the identifier of the image buffer, 3D geometry object, or transformation matrix object into which the results will be copied. - Specifies the type of copy operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Calculates the distance between a point cloud or depth map, and a point cloud, depth map, or 3D geometry object. - Specifies the source point cloud container or depth map image buffer. - Specifies the reference object with respect to which distances will be measured. - Specifies the identifier of the buffer in which to store the calculated distances. - Specifies the type of distance to calculate. - Specifies an optional maximum distance for which to complete calculations when the reference MIL object is a point cloud container. - Reserved for future expansion and must be set to M_DEFAULT . - - - Draw the result of a fit operation into a 3D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the identifier of the fit 3D metrology result buffer. - Specifies the identifier of the 3D graphics list in which to draw. - Specifies the label of the 3D graphic in the 3D graphics list to use as the geometry's parent. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the 3D graphic added to the 3D graphics list. - - - Fits a 3D geometry to a point cloud or depth map. - Specifies the fit 3D metrology context. - Specifies the point cloud or depth map to which to fit the 3D geometry. - Specifies the type of 3D geometry object to use in the fit operation. Note that 3D box geometry objects are not supported. - Specifies the identifier of the fit 3D metrology result buffer in which to store the results of the fit operation. - Specifies the distance from the 3D geometry, beyond which points are considered outliers and will be ignored during the fit operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a 3D metrology context or result buffer. - Specifies the identifier of the 3D metrology context or result buffer to free. These must have been successfully allocated using M3dmetAlloc or M3dmetAllocResult prior to calling this function. - - - Get the specified type of result(s) from a 3D metrology result buffer. - Specifies the identifier of a fit 3D metrology result buffer or statistics 3D metrology result buffer, from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result(s) from a 3D metrology result buffer. - Specifies the identifier of a fit 3D metrology result buffer or statistics 3D metrology result buffer, from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result(s) from a 3D metrology result buffer. - Specifies the identifier of a fit 3D metrology result buffer or statistics 3D metrology result buffer, from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result(s) from a 3D metrology result buffer. - Specifies the identifier of a fit 3D metrology result buffer or statistics 3D metrology result buffer, from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result(s) from a 3D metrology result buffer. - Specifies the identifier of a fit 3D metrology result buffer or statistics 3D metrology result buffer, from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D metrology context. - Specifies the identifier of the 3D metrology context to inquire. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire information about a 3D metrology context. - Specifies the identifier of the 3D metrology context to inquire. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire information about a 3D metrology context. - Specifies the identifier of the 3D metrology context to inquire. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire information about a 3D metrology context. - Specifies the identifier of the 3D metrology context to inquire. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire information about a 3D metrology context. - Specifies the identifier of the 3D metrology context to inquire. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire information about a 3D metrology context. - Specifies the identifier of the 3D metrology context to inquire. - Specifies the type of information about which to inquire. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire information about a 3D metrology context. - Specifies the identifier of the 3D metrology context to inquire. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Restore a 3D metrology context from disk. - Specifies the name and path of the file from which to restore the 3D metrology context. - Specifies the system on which to restore the 3D metrology context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D metrology context identifier. - The returned value is the 3D metrology context identifier. If allocation fails, M_NULL is returned. - - - Restore a 3D metrology context from disk. - Specifies the name and path of the file from which to restore the 3D metrology context. - Specifies the system on which to restore the 3D metrology context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D metrology context identifier. - The returned value is the 3D metrology context identifier. If allocation fails, M_NULL is returned. - - - Save a 3D metrology context to a file. - Specifies the name and path of the file in which to save the 3D metrology context; it is recommended that you use the M3DMET file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the 3D metrology context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a 3D metrology context to a file. - Specifies the name and path of the file in which to save the 3D metrology context; it is recommended that you use the M3DMET file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the 3D metrology context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Compute a variety of statistics on the distances between a point cloud or depth map, and a point cloud, depth map, or 3D geometry. - Specifies a previously allocated statistics 3D metrology context (used to evaluate multiple statistical calculations), or a predefined statistics 3D metrology context (used to evaluate a single statistical calculation). - Specifies the source point cloud container or depth map image buffer. - Specifies the identifier of the reference MIL object, with respect to which distances will be measured. - Specifies the identifier of the statistics 3D metrology result buffer in which to store the results. The result buffer must have been allocated using M3dmetAllocResult with M_STATISTICS_RESULT. - Specifies the type of distance to calculate. - Specifies the condition for which distance measurements will be used in statistics calculations. - Specifies the lower limit of the selected condition. - Specifies the upper limit of the selected condition. - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a 3D metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D metrology context. - Specifies the MIL version of the 3D metrology context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D metrology context. - Specifies the address of the variable in which to write the size of the 3D metrology context, in bytes. - - - Load, restore, or save a 3D metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D metrology context. - Specifies the MIL version of the 3D metrology context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D metrology context. - Specifies the address of the variable in which to write the size of the 3D metrology context, in bytes. - - - Load, restore, or save a 3D metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D metrology context. - Specifies the MIL version of the 3D metrology context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D metrology context. - Specifies the address of the variable in which to write the size of the 3D metrology context, in bytes. - - - Load, restore, or save a 3D metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D metrology context. - Specifies the MIL version of the 3D metrology context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D metrology context. - Specifies the address of the variable in which to write the size of the 3D metrology context, in bytes. - - - Load, restore, or save a 3D metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D metrology context. - Specifies the MIL version of the 3D metrology context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D metrology context. - Specifies the address of the variable in which to write the size of the 3D metrology context, in bytes. - - - Load, restore, or save a 3D metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D metrology context. - Specifies the MIL version of the 3D metrology context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D metrology context. - Specifies the address of the variable in which to write the size of the 3D metrology context, in bytes. - - - Computes the volume of a point cloud's mesh or of a depth map, delimited optionally by a specified reference object. - Specifies the point cloud or depth map for which to calculate the volume. - Specifies the reference MIL object to use to define a closed 3D shape whose volume to calculate. - Specifies how to calculate the total volume, given the position of the source MIL object relative to the reference object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the calculated volume. - Specifies the address of the variable in which to write the status of the volume calculation. - The returned value is the computed volume, if successful. If the volume calculation fails, M_NULL is returned. - - - Computes the volume of a point cloud's mesh or of a depth map, delimited optionally by a specified reference object. - Specifies the point cloud or depth map for which to calculate the volume. - Specifies the reference MIL object to use to define a closed 3D shape whose volume to calculate. - Specifies how to calculate the total volume, given the position of the source MIL object relative to the reference object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the calculated volume. - Specifies the address of the variable in which to write the status of the volume calculation. - The returned value is the computed volume, if successful. If the volume calculation fails, M_NULL is returned. - - - Computes the volume of a point cloud's mesh or of a depth map, delimited optionally by a specified reference object. - Specifies the point cloud or depth map for which to calculate the volume. - Specifies the reference MIL object to use to define a closed 3D shape whose volume to calculate. - Specifies how to calculate the total volume, given the position of the source MIL object relative to the reference object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the calculated volume. - Specifies the address of the variable in which to write the status of the volume calculation. - The returned value is the computed volume, if successful. If the volume calculation fails, M_NULL is returned. - - - Computes the volume of a point cloud's mesh or of a depth map, delimited optionally by a specified reference object. - Specifies the point cloud or depth map for which to calculate the volume. - Specifies the reference MIL object to use to define a closed 3D shape whose volume to calculate. - Specifies how to calculate the total volume, given the position of the source MIL object relative to the reference object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the calculated volume. - Specifies the address of the variable in which to write the status of the volume calculation. - The returned value is the computed volume, if successful. If the volume calculation fails, M_NULL is returned. - - - Allocate a 3D registration context. - Specifies the identifier of the system on which to allocate the 3D registration context. - Specifies the type of 3D registration context to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the pairwise 3D registration context identifier. - The returned value is the context's identifier. If allocation fails, M_NULL is returned. - - - Allocate a 3D registration context. - Specifies the identifier of the system on which to allocate the 3D registration context. - Specifies the type of 3D registration context to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the pairwise 3D registration context identifier. - The returned value is the context's identifier. If allocation fails, M_NULL is returned. - - - Allocate a 3D registration result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D registration result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D registration result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D registration result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Perform the registration operation on the given point clouds and write the resulting transformation matrices into the pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration context to use for the registration operation. The context must have been previously allocated using M3dregAlloc. - Specifies the address of the array containing the identifiers of the point cloud containers. The point clouds must be 3D-processable; use MbufInquireContainer with M_3D_PROCESSABLE to ensure that the containers contain 3D-processable point clouds. The number of containers supplied in the array should be less than or equal to the number of registration elements in the registration context. - Specifies the size of the array passed to ContainerBufIdArrayPtr. - Specifies the pairwise 3D registration result buffer identifier in which to store results. The result buffer must have been previously allocated using M3dregAllocResult. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform the registration operation on the given point clouds and write the resulting transformation matrices into the pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration context to use for the registration operation. The context must have been previously allocated using M3dregAlloc. - Specifies the address of the array containing the identifiers of the point cloud containers. The point clouds must be 3D-processable; use MbufInquireContainer with M_3D_PROCESSABLE to ensure that the containers contain 3D-processable point clouds. The number of containers supplied in the array should be less than or equal to the number of registration elements in the registration context. - Specifies the size of the array passed to ContainerBufIdArrayPtr. - Specifies the pairwise 3D registration result buffer identifier in which to store results. The result buffer must have been previously allocated using M3dregAllocResult. - Reserved for future expansion and must be set to M_DEFAULT . - - - Control a pairwise 3D registration context or a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration context or a pairwise 3D registration result buffer to control. - Specifies what to control. Set this parameter to one of the following values: - Specifies the setting to change. - Specifies the setting's new value. - - - Control a pairwise 3D registration context or a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration context or a pairwise 3D registration result buffer to control. - Specifies what to control. Set this parameter to one of the following values: - Specifies the setting to change. - Specifies the setting's new value. - - - Copy a preregistration transformation matrix from a 3D registration context into a transformation matrix object. - Specifies the identifier of the 3D registration context. The context must have been previously allocated using M3dregAlloc with M_PAIRWISE_REGISTRATION_CONTEXT. - Specifies the index of the registration element in the context. - Specifies the identifier of a transformation matrix. The transformation matrix must have been previously allocated using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the type of copy operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy a transformation matrix from a 3D registration result buffer to a transformation matrix object. - Specifies the identifier of the pairwise 3D registration result buffer. The pairwise 3D registration result buffer must have been previously allocated using M3dregAllocResult. - Specifies the index of the registration result element associated with the source point cloud. - Specifies relative to which coordinate system (the global coordinate system or that of a point cloud) to retrieve the copied transformation matrix. - Specifies the identifier of the destination transformation matrix object. The transformation matrix object must have been previously allocated using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Specifies the type of copy operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a 3D registration context or a 3D registration result buffer. - Specifies the identifier of the 3D registration context or 3D registration result buffer to free. These must have been successfully allocated (using M3dregAlloc or M3dregAllocResult) prior to calling this function. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire information about a pairwise 3D registration context or a pairwise 3D registration result buffer. - Specifies the identifier of the 3D pairwise registration context or a pairwise 3D registration result buffer to inquire. - Specifies to inquire a pairwise 3D registration context, an individual registration element (or all registration elements), or a pairwise 3D registration result buffer. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a pairwise 3D registration context or a pairwise 3D registration result buffer. - Specifies the identifier of the 3D pairwise registration context or a pairwise 3D registration result buffer to inquire. - Specifies to inquire a pairwise 3D registration context, an individual registration element (or all registration elements), or a pairwise 3D registration result buffer. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a pairwise 3D registration context or a pairwise 3D registration result buffer. - Specifies the identifier of the 3D pairwise registration context or a pairwise 3D registration result buffer to inquire. - Specifies to inquire a pairwise 3D registration context, an individual registration element (or all registration elements), or a pairwise 3D registration result buffer. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a pairwise 3D registration context or a pairwise 3D registration result buffer. - Specifies the identifier of the 3D pairwise registration context or a pairwise 3D registration result buffer to inquire. - Specifies to inquire a pairwise 3D registration context, an individual registration element (or all registration elements), or a pairwise 3D registration result buffer. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a pairwise 3D registration context or a pairwise 3D registration result buffer. - Specifies the identifier of the 3D pairwise registration context or a pairwise 3D registration result buffer to inquire. - Specifies to inquire a pairwise 3D registration context, an individual registration element (or all registration elements), or a pairwise 3D registration result buffer. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a pairwise 3D registration context or a pairwise 3D registration result buffer. - Specifies the identifier of the 3D pairwise registration context or a pairwise 3D registration result buffer to inquire. - Specifies to inquire a pairwise 3D registration context, an individual registration element (or all registration elements), or a pairwise 3D registration result buffer. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a pairwise 3D registration context or a pairwise 3D registration result buffer. - Specifies the identifier of the 3D pairwise registration context or a pairwise 3D registration result buffer to inquire. - Specifies to inquire a pairwise 3D registration context, an individual registration element (or all registration elements), or a pairwise 3D registration result buffer. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a pairwise 3D registration context or a pairwise 3D registration result buffer. - Specifies the identifier of the 3D pairwise registration context or a pairwise 3D registration result buffer to inquire. - Specifies to inquire a pairwise 3D registration context, an individual registration element (or all registration elements), or a pairwise 3D registration result buffer. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Merge point clouds using the results of a previous call to M3dregCalculate. - Specifies the identifier of the pairwise 3D registration result buffer. The pairwise 3D registration result buffer must have been successfully allocated using M3dregAllocResult, and contain the result of a successful call to M3dregCalculate. - Specifies the address of the array containing the identifiers of the point cloud containers. The point clouds must be 3D-processable. You can check that the point clouds are 3D-processable using MbufInquireContainer with M_3D_PROCESSABLE. You can set some entries in the array to M_NULL to merge a subset of the point clouds. - Specifies the size of the array passed to ContainerBufIdArrayPtr. - Specifies the identifier of the destination container in which to store the transformed and merged point clouds. The container must have been previously allocated using MbufAllocContainer with M_PROC. - Specifies the identifier of a 3D image processing subsampling context. This context is used to subsample the resulting point cloud after the merging is complete. - Reserved for future expansion and must be set to M_DEFAULT . - - - Merge point clouds using the results of a previous call to M3dregCalculate. - Specifies the identifier of the pairwise 3D registration result buffer. The pairwise 3D registration result buffer must have been successfully allocated using M3dregAllocResult, and contain the result of a successful call to M3dregCalculate. - Specifies the address of the array containing the identifiers of the point cloud containers. The point clouds must be 3D-processable. You can check that the point clouds are 3D-processable using MbufInquireContainer with M_3D_PROCESSABLE. You can set some entries in the array to M_NULL to merge a subset of the point clouds. - Specifies the size of the array passed to ContainerBufIdArrayPtr. - Specifies the identifier of the destination container in which to store the transformed and merged point clouds. The container must have been previously allocated using MbufAllocContainer with M_PROC. - Specifies the identifier of a 3D image processing subsampling context. This context is used to subsample the resulting point cloud after the merging is complete. - Reserved for future expansion and must be set to M_DEFAULT . - - - Restore a 3D registration context or result buffer from disk. - Specifies the name and path of the file from which to restore the 3D registration context or 3D registration result buffer. - Specifies the system on which to restore the 3D registration context or 3D registration result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D registration context or 3D registration result buffer identifier. - The returned value is the registration context or result buffer identifier. If allocation fails, M_NULL is returned. - - - Restore a 3D registration context or result buffer from disk. - Specifies the name and path of the file from which to restore the 3D registration context or 3D registration result buffer. - Specifies the system on which to restore the 3D registration context or 3D registration result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D registration context or 3D registration result buffer identifier. - The returned value is the registration context or result buffer identifier. If allocation fails, M_NULL is returned. - - - Save a 3D registration context or 3D registration result buffer to a file. - Specifies the name and path of the file in which to save the 3D registration context or 3D registration result buffer. It is recommended that you use the M3DREG file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the 3D registration context or 3D registration result buffer to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a 3D registration context or 3D registration result buffer to a file. - Specifies the name and path of the file in which to save the 3D registration context or 3D registration result buffer. It is recommended that you use the M3DREG file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the 3D registration context or 3D registration result buffer to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Sets the rough location of the working coordinate system of a point cloud with respect to either the working coordinate system of another point cloud, or the global coordinate system. - Specifies the identifier of the pairwise 3D registration context in which to store the rough location. - Specifies the index of the registration element in the pairwise 3D registration context to set. - Specifies the reference of the registration element in Context3dregId. - Specifies the identifier of the MIL object from which to copy the rough location. - Specifies the index of the registration element or registration result element in the MIL object passed to the ParamId parameter. - Specifies an attribute of the transformation that specifies a rough location. - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a 3D registration context or result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D registration context or 3D registration result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the pairwise 3D registration context or pairwise 3D registration result buffer. - Specifies the MIL version of the 3D registration context or result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D registration context or result buffer. - Specifies the address of the variable in which to write the size of the 3D registration context or result buffer, in bytes. - - - Load, restore, or save a 3D registration context or result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D registration context or 3D registration result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the pairwise 3D registration context or pairwise 3D registration result buffer. - Specifies the MIL version of the 3D registration context or result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D registration context or result buffer. - Specifies the address of the variable in which to write the size of the 3D registration context or result buffer, in bytes. - - - Load, restore, or save a 3D registration context or result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D registration context or 3D registration result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the pairwise 3D registration context or pairwise 3D registration result buffer. - Specifies the MIL version of the 3D registration context or result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D registration context or result buffer. - Specifies the address of the variable in which to write the size of the 3D registration context or result buffer, in bytes. - - - Load, restore, or save a 3D registration context or result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D registration context or 3D registration result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the pairwise 3D registration context or pairwise 3D registration result buffer. - Specifies the MIL version of the 3D registration context or result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D registration context or result buffer. - Specifies the address of the variable in which to write the size of the 3D registration context or result buffer, in bytes. - - - Load, restore, or save a 3D registration context or result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D registration context or 3D registration result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the pairwise 3D registration context or pairwise 3D registration result buffer. - Specifies the MIL version of the 3D registration context or result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D registration context or result buffer. - Specifies the address of the variable in which to write the size of the 3D registration context or result buffer, in bytes. - - - Load, restore, or save a 3D registration context or result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D registration context or 3D registration result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the pairwise 3D registration context or pairwise 3D registration result buffer. - Specifies the MIL version of the 3D registration context or result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D registration context or result buffer. - Specifies the address of the variable in which to write the size of the 3D registration context or result buffer, in bytes. - - - Allocate a MIL application context. - Specifies the computer name or IP address of the cluster manager. - Specifies the type of initialization to perform on the MIL application context. - Specifies the address of the variable in which to write the application context identifier. - The returned value is the application context identifier. If allocation fails, M_NULL is returned. - - - Allocate a MIL application context. - Specifies the computer name or IP address of the cluster manager. - Specifies the type of initialization to perform on the MIL application context. - Specifies the address of the variable in which to write the application context identifier. - The returned value is the application context identifier. If allocation fails, M_NULL is returned. - - - Allocate a MIL application context. - Specifies the computer name or IP address of the cluster manager. - Specifies the type of initialization to perform on the MIL application context. - Specifies the address of the variable in which to write the application context identifier. - The returned value is the application context identifier. If allocation fails, M_NULL is returned. - - - Allocate a MIL application context. - Specifies the computer name or IP address of the cluster manager. - Specifies the type of initialization to perform on the MIL application context. - Specifies the address of the variable in which to write the application context identifier. - The returned value is the application context identifier. If allocation fails, M_NULL is returned. - - - Closes a connection to a remote MIL application. - Specifies the remote application to disconnect from. - - - Control an application environment setting. - Specifies the identifier of the application context to use. - Specifies the type of application environment setting to control. - Specifies the setting's new value. - - - Control a MIL multi-core processing application environment setting. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the type of multi-core processing application environment setting to control. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the setting's new value. - Specifies the address which contains more information about the setting's new value. - - - Control a MIL multi-core processing application environment setting. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the type of multi-core processing application environment setting to control. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the setting's new value. - Specifies the address which contains more information about the setting's new value. - - - Perform a file operation on a local or a remote computer. - Specifies the identifier of the application context to use. - Specifies the file on the target or source computer to use for the operation. - Specifies the destination application in which to copy the file specified using Comp1FileName during the M_FILE_COPY or M_FILE_COPY_MIL_DLL operation. - Specifies the directory (and optionally a new file name) in computer 2 in which to copy the file specified using Comp1FileName. - Specifies the operation to perform on the specified file. - Reserved for future expansion. - Specifies the address of the user data that used by some operations. - - - Perform a file operation on a local or a remote computer. - Specifies the identifier of the application context to use. - Specifies the file on the target or source computer to use for the operation. - Specifies the destination application in which to copy the file specified using Comp1FileName during the M_FILE_COPY or M_FILE_COPY_MIL_DLL operation. - Specifies the directory (and optionally a new file name) in computer 2 in which to copy the file specified using Comp1FileName. - Specifies the operation to perform on the specified file. - Reserved for future expansion. - Specifies the address of the user data that used by some operations. - - - Perform a file operation on a local or a remote computer. - Specifies the identifier of the application context to use. - Specifies the file on the target or source computer to use for the operation. - Specifies the destination application in which to copy the file specified using Comp1FileName during the M_FILE_COPY or M_FILE_COPY_MIL_DLL operation. - Specifies the directory (and optionally a new file name) in computer 2 in which to copy the file specified using Comp1FileName. - Specifies the operation to perform on the specified file. - Reserved for future expansion. - Specifies the address of the user data that used by some operations. - - - Perform a file operation on a local or a remote computer. - Specifies the identifier of the application context to use. - Specifies the file on the target or source computer to use for the operation. - Specifies the destination application in which to copy the file specified using Comp1FileName during the M_FILE_COPY or M_FILE_COPY_MIL_DLL operation. - Specifies the directory (and optionally a new file name) in computer 2 in which to copy the file specified using Comp1FileName. - Specifies the operation to perform on the specified file. - Reserved for future expansion. - Specifies the address of the user data that used by some operations. - - - Free a MIL application. - Specifies the application to free. - - - Get error codes and related information. - Specifies the identifier of the application context to use. - Specifies the type of error information to read. - Specifies the address in which to write the requested information. - The returned value is the requested error/function code. If the error code is read and it is equal to M_NULL_ERROR , no error has occurred. - - - Get error codes and related information. - Specifies the identifier of the application context to use. - Specifies the type of error information to read. - Specifies the address in which to write the requested information. - The returned value is the requested error/function code. If the error code is read and it is equal to M_NULL_ERROR , no error has occurred. - - - Get error codes and related information. - Specifies the identifier of the application context to use. - Specifies the type of error information to read. - Specifies the address in which to write the requested information. - The returned value is the requested error/function code. If the error code is read and it is equal to M_NULL_ERROR , no error has occurred. - - - Get information about a hooked event. - Specifies the identifier of the application context to use. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hooked event. - Specifies the identifier of the application context to use. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hooked event. - Specifies the identifier of the application context to use. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hooked event. - Specifies the identifier of the application context to use. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hooked event. - Specifies the identifier of the application context to use. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hooked event. - Specifies the identifier of the application context to use. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hooked event. - Specifies the identifier of the application context to use. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Hook a function to an event. - Specifies the identifier of the application context to use. - Specifies the event type. - Specifies the address of the function that should be called when an event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Hook a function to an event. - Specifies the identifier of the application context to use. - Specifies the event type. - Specifies the address of the function that should be called when an event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Inquire about an application setting. - Specifies the identifier of the application context to use. - Specifies the type of application setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an application setting. - Specifies the identifier of the application context to use. - Specifies the type of application setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an application setting. - Specifies the identifier of the application context to use. - Specifies the type of application setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an application setting. - Specifies the identifier of the application context to use. - Specifies the type of application setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an application setting. - Specifies the identifier of the application context to use. - Specifies the type of application setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an application setting. - Specifies the identifier of the application context to use. - Specifies the type of application setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about published MIL objects on a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the type of Distributed MIL connection setting about which to inquire. - Specifies an attribute of the inquire operation to perform. - Specifies an attribute of the inquire operation to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about published MIL objects on a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the type of Distributed MIL connection setting about which to inquire. - Specifies an attribute of the inquire operation to perform. - Specifies an attribute of the inquire operation to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about published MIL objects on a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the type of Distributed MIL connection setting about which to inquire. - Specifies an attribute of the inquire operation to perform. - Specifies an attribute of the inquire operation to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about published MIL objects on a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the type of Distributed MIL connection setting about which to inquire. - Specifies an attribute of the inquire operation to perform. - Specifies an attribute of the inquire operation to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about published MIL objects on a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the type of Distributed MIL connection setting about which to inquire. - Specifies an attribute of the inquire operation to perform. - Specifies an attribute of the inquire operation to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about published MIL objects on a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the type of Distributed MIL connection setting about which to inquire. - Specifies an attribute of the inquire operation to perform. - Specifies an attribute of the inquire operation to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL multi-core processing application environment setting. - Specifies the identifier of the application context to use. - Specifies the type of multi-core processing application environment setting about which to inquire. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies additional information regarding the inquired setting. This parameter must be set to M_DEFAULT if not used. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. The return value is undefined for M_CORE_AFFINITY_MASK, M_CORE_AFFINITY_MASK_PROCESS, M_MEMORY_BANK_AFFINITY_MASK, and M_MEMORY_BANK_CORE_AFFINITY_MASK. - - - Inquire about a MIL multi-core processing application environment setting. - Specifies the identifier of the application context to use. - Specifies the type of multi-core processing application environment setting about which to inquire. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies additional information regarding the inquired setting. This parameter must be set to M_DEFAULT if not used. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. The return value is undefined for M_CORE_AFFINITY_MASK, M_CORE_AFFINITY_MASK_PROCESS, M_MEMORY_BANK_AFFINITY_MASK, and M_MEMORY_BANK_CORE_AFFINITY_MASK. - - - Inquire about a MIL multi-core processing application environment setting. - Specifies the identifier of the application context to use. - Specifies the type of multi-core processing application environment setting about which to inquire. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies additional information regarding the inquired setting. This parameter must be set to M_DEFAULT if not used. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. The return value is undefined for M_CORE_AFFINITY_MASK, M_CORE_AFFINITY_MASK_PROCESS, M_MEMORY_BANK_AFFINITY_MASK, and M_MEMORY_BANK_CORE_AFFINITY_MASK. - - - Inquire about a MIL multi-core processing application environment setting. - Specifies the identifier of the application context to use. - Specifies the type of multi-core processing application environment setting about which to inquire. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies additional information regarding the inquired setting. This parameter must be set to M_DEFAULT if not used. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. The return value is undefined for M_CORE_AFFINITY_MASK, M_CORE_AFFINITY_MASK_PROCESS, M_MEMORY_BANK_AFFINITY_MASK, and M_MEMORY_BANK_CORE_AFFINITY_MASK. - - - Connect to a Distributed MIL publishing application. - Specifies the computer to which to connect, and if necessary the listening port of the publishing application. - Reserved for future expansion. - Reserved for future expansion. - Specifies the address in which to write the remote application identifier returned by this function. - - - Control or inquire a MIL timer's setting or value. - Specifies the identifier of the application context to use. - Specifies the control to exert on the MIL timer. - Specifies the address of the variable in which to store the timer information produced by M_TIMER_READ or M_TIMER_RESOLUTION. - The returned value, for M_TIMER_READ and M_TIMER_RESOLUTION, is the requested information cast to a MIL_DOUBLE. For M_TIMER_RESET and M_TIMER_WAIT, this function returns 0.0. - - - Control or inquire a MIL timer's setting or value. - Specifies the identifier of the application context to use. - Specifies the control to exert on the MIL timer. - The returned value, for M_TIMER_READ and M_TIMER_RESOLUTION, is the requested information cast to a MIL_DOUBLE. For M_TIMER_RESET and M_TIMER_WAIT, this function returns 0.0. - - - Control or inquire a MIL timer's setting or value. - Specifies the identifier of the application context to use. - Specifies the control to exert on the MIL timer. - Specifies the address of the variable in which to store the timer information produced by M_TIMER_READ or M_TIMER_RESOLUTION. - The returned value, for M_TIMER_READ and M_TIMER_RESOLUTION, is the requested information cast to a MIL_DOUBLE. For M_TIMER_RESET and M_TIMER_WAIT, this function returns 0.0. - - - Create a user MIL trace marker or section in a trace log. - Specifies the identifier of the application context to use. - Specifies the type of trace marker to create. - Specifies a value that identifies this trace marker or section. - Specifies a value relevant to the trace marker or section, or relevant to the surrounding code. - Specifies a string relevant to the trace marker or section, or relevant to the surrounding code. - - - Create a user MIL trace marker or section in a trace log. - Specifies the identifier of the application context to use. - Specifies the type of trace marker to create. - Specifies a value that identifies this trace marker or section. - Specifies a value relevant to the trace marker or section, or relevant to the surrounding code. - Specifies a string relevant to the trace marker or section, or relevant to the surrounding code. - - - Allocate a bead context. - Specifies the identifier of the system on which to allocate the bead context. - Specifies the strategy with which to extract and analyze beads. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the bead context identifier. - The returned value is the bead context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a bead context. - Specifies the identifier of the system on which to allocate the bead context. - Specifies the strategy with which to extract and analyze beads. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the bead context identifier. - The returned value is the bead context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a bead result buffer. - Specifies the identifier of the system on which to allocate the result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the bead result buffer identifier. - The returned value is the bead result buffer's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a bead result buffer. - Specifies the identifier of the system on which to allocate the result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the bead result buffer identifier. - The returned value is the bead result buffer's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a bead context or template setting. - Specifies the identifier of the bead context to control. - Specifies the bead template (one or all) to control, or specifies that you are controlling a global setting of the bead context. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control a bead context or template setting. - Specifies the identifier of the bead context to control. - Specifies the bead template (one or all) to control, or specifies that you are controlling a global setting of the bead context. - Specifies the type of control to set. - Specifies the required value for the control. - - - Draw specific features of a bead context or of a bead result. - Specifies the identifier of the 2D graphics context to use. This parameter must be set to one of the following values: - Specifies the identifier of the bead context or bead result buffer that this function will use to perform the drawing operation. The context or result buffer must have been previously allocated on the system using MbeadAlloc or MbeadAllocResult, respectively. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the drawing operation to perform. - Specifies the type of points that this function will use to perform the drawing operation. - Specifies the templates (one or all) that this function will use to perform the drawing operation, or specifies that you are performing a general type of drawing operation. - Specifies the set of template points (one or all) for which to perform the drawing operation, or specifies that you are performing a general type of drawing operation. - Specifies whether MIL performs drawings with fail-type points differently than drawings with other types of points. - - - Free a bead context or a bead result buffer. - Specifies the identifier of the bead context or bead result buffer to free. These must have been successfully allocated (with MbeadAlloc or MbeadAllocResult) prior to calling this function. - - - Get the template and/or vertex closest to a source point. - Specifies the identifier of the bead context. - Specifies the bead template in which the closest vertex is expected to be located. - Specifies the source point's X-position. - Specifies the source point's Y-position. - Specifies the address of the variable in which to write the label of the closest template. - Specifies the address of the variable in which to write the index of the closest vertex. - Specifies whether to retrieve the closest template and/or the closest vertex. - - - Get the template and/or vertex closest to a source point. - Specifies the identifier of the bead context. - Specifies the bead template in which the closest vertex is expected to be located. - Specifies the source point's X-position. - Specifies the source point's Y-position. - Specifies the address of the variable in which to write the label of the closest template. - Specifies the address of the variable in which to write the index of the closest vertex. - Specifies whether to retrieve the closest template and/or the closest vertex. - - - Get the template and/or vertex closest to a source point. - Specifies the identifier of the bead context. - Specifies the bead template in which the closest vertex is expected to be located. - Specifies the source point's X-position. - Specifies the source point's Y-position. - Specifies the address of the variable in which to write the label of the closest template. - Specifies the address of the variable in which to write the index of the closest vertex. - Specifies whether to retrieve the closest template and/or the closest vertex. - - - Get the template and/or vertex closest to a source point. - Specifies the identifier of the bead context. - Specifies the bead template in which the closest vertex is expected to be located. - Specifies the source point's X-position. - Specifies the source point's Y-position. - Specifies the address of the variable in which to write the label of the closest template. - Specifies the address of the variable in which to write the index of the closest vertex. - Specifies whether to retrieve the closest template and/or the closest vertex. - - - Get results from a bead result buffer. - Specifies the identifier of the bead result buffer from which to get results. - Specifies the label or index of the template for which to get results, or specifies that you are getting general results related to all templates. - Specifies the trained points (one or all) for which to get results or specifies that you are getting general results. - Specifies the result to get. - Specifies the address in which to write the requested information. - - - Get results from a bead result buffer. - Specifies the identifier of the bead result buffer from which to get results. - Specifies the label or index of the template for which to get results, or specifies that you are getting general results related to all templates. - Specifies the trained points (one or all) for which to get results or specifies that you are getting general results. - Specifies the result to get. - Specifies the address in which to write the requested information. - - - Get results from a bead result buffer. - Specifies the identifier of the bead result buffer from which to get results. - Specifies the label or index of the template for which to get results, or specifies that you are getting general results related to all templates. - Specifies the trained points (one or all) for which to get results or specifies that you are getting general results. - Specifies the result to get. - Specifies the address in which to write the requested information. - - - Get results from a bead result buffer. - Specifies the identifier of the bead result buffer from which to get results. - Specifies the label or index of the template for which to get results, or specifies that you are getting general results related to all templates. - Specifies the trained points (one or all) for which to get results or specifies that you are getting general results. - Specifies the result to get. - Specifies the address in which to write the requested information. - - - Get results from a bead result buffer. - Specifies the identifier of the bead result buffer from which to get results. - Specifies the label or index of the template for which to get results, or specifies that you are getting general results related to all templates. - Specifies the trained points (one or all) for which to get results or specifies that you are getting general results. - Specifies the result to get. - Specifies the address in which to write the requested information. - - - Get results from a bead result buffer. - Specifies the identifier of the bead result buffer from which to get results. - Specifies the label or index of the template for which to get results, or specifies that you are getting general results related to all templates. - Specifies the trained points (one or all) for which to get results or specifies that you are getting general results. - Specifies the result to get. - Specifies the address in which to write the requested information. - - - Get results from a bead result buffer. - Specifies the identifier of the bead result buffer from which to get results. - Specifies the label or index of the template for which to get results, or specifies that you are getting general results related to all templates. - Specifies the trained points (one or all) for which to get results or specifies that you are getting general results. - Specifies the result to get. - Specifies the address in which to write the requested information. - - - Get results from a bead result buffer. - Specifies the identifier of the bead result buffer from which to get results. - Specifies the label or index of the template for which to get results, or specifies that you are getting general results related to all templates. - Specifies the trained points (one or all) for which to get results or specifies that you are getting general results. - Specifies the result to get. - Specifies the address in which to write the requested information. - - - Get results from a bead result buffer. - Specifies the identifier of the bead result buffer from which to get results. - Specifies the label or index of the template for which to get results, or specifies that you are getting general results related to all templates. - Specifies the trained points (one or all) for which to get results or specifies that you are getting general results. - Specifies the result to get. - Specifies the address in which to write the requested information. - - - Get results from a bead result buffer. - Specifies the identifier of the bead result buffer from which to get results. - Specifies the label or index of the template for which to get results, or specifies that you are getting general results related to all templates. - Specifies the trained points (one or all) for which to get results or specifies that you are getting general results. - Specifies the result to get. - Specifies the address in which to write the requested information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Restore a bead context from disk. - Specifies the name and path of the file from which to restore the bead context. - Specifies the identifier of the system on which to restore the bead context. - Specifies whether to restore the camera calibration context that was saved with the bead context. - Specifies the address of the variable in which to write the bead context identifier. - The returned value is the bead context identifier. If allocation fails, M_NULL is returned. - - - Save a bead context to a file. - Specifies the name and path of the file in which to save the bead context. - Specifies the identifier of the bead context to save. - Specifies whether to save the camera calibration context associated with the training image. - - - Load, restore, or save a MIL bead context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the bead context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the bead context. - Specifies the MIL version of the bead context. - Specifies whether to restore the camera calibration context from the bead context, or save the camera calibration context with the bead context. - Specifies the address of the variable in which to write or from which to read the identifier of the bead context. - Specifies the address of the variable in which to write the size of the bead context, in bytes. - - - Load, restore, or save a MIL bead context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the bead context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the bead context. - Specifies the MIL version of the bead context. - Specifies whether to restore the camera calibration context from the bead context, or save the camera calibration context with the bead context. - Specifies the address of the variable in which to write or from which to read the identifier of the bead context. - Specifies the address of the variable in which to write the size of the bead context, in bytes. - - - Load, restore, or save a MIL bead context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the bead context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the bead context. - Specifies the MIL version of the bead context. - Specifies whether to restore the camera calibration context from the bead context, or save the camera calibration context with the bead context. - Specifies the address of the variable in which to write or from which to read the identifier of the bead context. - Specifies the address of the variable in which to write the size of the bead context, in bytes. - - - Load, restore, or save a MIL bead context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the bead context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the bead context. - Specifies the MIL version of the bead context. - Specifies whether to restore the camera calibration context from the bead context, or save the camera calibration context with the bead context. - Specifies the address of the variable in which to write or from which to read the identifier of the bead context. - Specifies the address of the variable in which to write the size of the bead context, in bytes. - - - Load, restore, or save a MIL bead context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the bead context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the bead context. - Specifies the MIL version of the bead context. - Specifies whether to restore the camera calibration context from the bead context, or save the camera calibration context with the bead context. - Specifies the address of the variable in which to write or from which to read the identifier of the bead context. - Specifies the address of the variable in which to write the size of the bead context, in bytes. - - - Load, restore, or save a MIL bead context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the bead context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the bead context. - Specifies the MIL version of the bead context. - Specifies whether to restore the camera calibration context from the bead context, or save the camera calibration context with the bead context. - Specifies the address of the variable in which to write or from which to read the identifier of the bead context. - Specifies the address of the variable in which to write the size of the bead context, in bytes. - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Train the templates in a bead context. - Specifies the identifier of the bead context that contains the templates to train. - Specifies the identifier of the image buffer containing the training image with which to train the templates, or specifies to train the templates without a training image (or with a previously saved training image). - Specifies whether to save the training image ( TrainingImageBufId). - - - Verify beads in the target image according to their corresponding template. - Specifies the identifier of the bead context that contains the templates with which to validate the beads in the target image. - Specifies the identifier of the target image buffer that contains the beads that must be verified, according the templates contained within the bead context. The image buffer must be a 1-band 8-bit unsigned buffer. - Specifies the identifier of the bead result buffer in which to write the results of the verification. - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate a Blob Analysis context. - Specifies the system on which to allocate the context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write the identifier of the Blob Analysis context. - The returned value is the Blob Analysis context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Blob Analysis context. - Specifies the system on which to allocate the context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write the identifier of the Blob Analysis context. - The returned value is the Blob Analysis context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Blob Analysis result buffer. - Specifies the system on which to allocate the result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write the identifier of the Blob Analysis result buffer. - The returned value is the result buffer's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Blob Analysis result buffer. - Specifies the system on which to allocate the result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write the identifier of the Blob Analysis result buffer. - The returned value is the result buffer's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Perform blob analysis calculations. - Specifies the identifier of the Blob Analysis context, that specifies the feature(s) to calculate, and other settings related to the blob analysis operation. - Specifies the identifier of the image buffer to use as the blob identifier image. This image is used to distinguish blob pixels from background pixels and which pixels belong to which blob. - Specifies the identifier of the image buffer to use as the grayscale image. This image is used to supply the intensity of blob pixels when calculating features with a grayscale definition. - Specifies the identifier of a Blob Analysis result buffer, in which to store calculated results. - - - Control a blob analysis setting. - Specifies the identifier of the Blob Analysis context or result buffer. - Specifies the setting to change. - Specifies the setting's new value. - - - Control a blob analysis setting. - Specifies the identifier of the Blob Analysis context or result buffer. - Specifies the setting to change. - Specifies the setting's new value. - - - Draw specific blob features in the destination image buffer or 2D graphics list. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the identifier of the Blob Analysis result buffer from which to retrieve the features to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Specifies the label or index of the blob or blobs whose information to draw. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free the Blob Analysis context or result buffer. - Specifies the identifier of the Blob Analysis context or result buffer to free. The buffer must have been successfully allocated, using MblobAllocResult or MblobAlloc, prior to calling this function. - - - Get the label value of a blob at a specified position. - Specifies the identifier of the Blob Analysis result buffer where the labels are stored. Note, this function cannot obtain the label values of blobs that have been deleted from the result buffer with MblobSelect. - Specifies the X-coordinate of the blob. - Specifies the Y-coordinate of the blob. - Specifies the address of the variable in which to write the label value. If there is no blob at the specified location, the blob has been deleted, or if the blob's XPos and YPos lie outside the original identifier image, M_NULL is returned instead of the label value. Also, since MblobGetLabel returns the label value, you can set this parameter to M_NULL . - The returned value is the label value of the specified blob. - - - Get the label value of a blob at a specified position. - Specifies the identifier of the Blob Analysis result buffer where the labels are stored. Note, this function cannot obtain the label values of blobs that have been deleted from the result buffer with MblobSelect. - Specifies the X-coordinate of the blob. - Specifies the Y-coordinate of the blob. - Specifies the address of the variable in which to write the label value. If there is no blob at the specified location, the blob has been deleted, or if the blob's XPos and YPos lie outside the original identifier image, M_NULL is returned instead of the label value. Also, since MblobGetLabel returns the label value, you can set this parameter to M_NULL . - The returned value is the label value of the specified blob. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Inquire about a Blob Analysis setting. - Specifies the identifier of a Blob Analysis context or result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a Blob Analysis setting. - Specifies the identifier of a Blob Analysis context or result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a Blob Analysis setting. - Specifies the identifier of a Blob Analysis context or result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a Blob Analysis setting. - Specifies the identifier of a Blob Analysis context or result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a Blob Analysis setting. - Specifies the identifier of a Blob Analysis context or result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a Blob Analysis setting. - Specifies the identifier of a Blob Analysis context or result buffer. - Specifies the type of setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a Blob Analysis setting. - Specifies the identifier of a Blob Analysis context or result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Draw a labeled image. - Specifies the identifier of the blob analysis result buffer. - Specifies the identifier of the destination (labeled) image buffer. This must be a single band, 8 or 16-bit unsigned buffer. - Specifies whether or not to clear the destination image buffer before drawing the labeled image into it. - - - Merge the results of two blob result buffers. - Specifies the identifier of the first source result buffer. SrcResultBlobId1 and SrcResultBlobId2 cannot be the same. - Specifies the identifier of the second source result buffer. SrcResultBlobId1 and SrcResultBlobId2 cannot be the same. - Specifies the identifier of the destination result buffer. DstResultBlobId cannot be the same as SrcResultBlobId1 or SrcResultBlobId2. - Specifies the control settings for the merge operation. This parameter can be set to any of the following. - - - Reconstruct blobs (or blob holes) in an image buffer. - Specifies the identifier of the source image buffer. - Specifies the identifier of the image buffer to use as a seed image. - Specifies the identifier of the destination (processed blobs) image buffer. - Specifies the type of operation to perform. - Specifies the processing mode to use. - - - Restore a blob context from disk. - Specifies the name and path of the file from which to restore the blob context. - Specifies the identifier of the system on which to restore the blob context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the blob context identifier. - The returned value is the blob context identifier. If allocation fails, M_NULL is returned. - - - Save a blob context to a file. - Specifies the name and path of the file in which to save the blob context. - Specifies the identifier of the blob context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a blob context to a file. - Specifies the name and path of the file in which to save the blob context. - Specifies the identifier of the blob context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Select blobs for calculations and result retrieval. - Specifies the identifier of the Blob Analysis result buffer to use in the blob selection process. - Specifies the operation to perform on the specified blobs. This parameter can be set to one of the following. - Specifies the feature to use as part of the selection criterion or the status of the blobs to affect. - Specifies the condition for the blob selection. - Specifies the lower limit of the selected condition. - Specifies the upper limit of the selected condition. - - - Load, restore, or save a MIL blob context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the blob context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the blob context. - Specifies the MIL version of the blob context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the blob context. - Specifies the address of the variable in which to write the size of the blob context, in bytes. - - - Load, restore, or save a MIL blob context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the blob context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the blob context. - Specifies the MIL version of the blob context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the blob context. - Specifies the address of the variable in which to write the size of the blob context, in bytes. - - - Load, restore, or save a MIL blob context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the blob context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the blob context. - Specifies the MIL version of the blob context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the blob context. - Specifies the address of the variable in which to write the size of the blob context, in bytes. - - - Load, restore, or save a MIL blob context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the blob context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the blob context. - Specifies the MIL version of the blob context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the blob context. - Specifies the address of the variable in which to write the size of the blob context, in bytes. - - - Load, restore, or save a MIL blob context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the blob context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the blob context. - Specifies the MIL version of the blob context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the blob context. - Specifies the address of the variable in which to write the size of the blob context, in bytes. - - - Load, restore, or save a MIL blob context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the blob context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the blob context. - Specifies the MIL version of the blob context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the blob context. - Specifies the address of the variable in which to write the size of the blob context, in bytes. - - - Perform a transformation/modification on blob analysis results. - Specifies the identifier of the source result buffer. - Specifies the identifier of the destination result buffer. DstResultBlobId must be set to the same result buffer as SrcResultBlobId(that is, the transformation is done in-place). - Specifies the operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate a 1D data buffer. - Specifies the MIL system on which to allocate the buffer. - Specifies the buffer width. The units are determined by the selected buffer attribute. - Specifies a combination of two values: the depth and type of the data. - Specifies the buffer usage. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a 1D data buffer. - Specifies the MIL system on which to allocate the buffer. - Specifies the buffer width. The units are determined by the selected buffer attribute. - Specifies a combination of two values: the depth and type of the data. - Specifies the buffer usage. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a 2D data buffer. - Specifies the MIL system on which to allocate the buffer. - Specifies the buffer width. The units are determined by the selected buffer attribute. - Specifies the buffer height. The units are determined by the selected buffer attribute. - Specifies a combination of two values: the depth and type of the data. - Specifies the buffer usage. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a 2D data buffer. - Specifies the MIL system on which to allocate the buffer. - Specifies the buffer width. The units are determined by the selected buffer attribute. - Specifies the buffer height. The units are determined by the selected buffer attribute. - Specifies a combination of two values: the depth and type of the data. - Specifies the buffer usage. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a color data buffer. - Specifies the MIL system on which to allocate the buffer. - Specifies the number of (x,y) surfaces (also called color bands) to allocate to the buffer. - Specifies the buffer width. The units are determined by the selected buffer attribute. - Specifies the buffer height. The units are determined by the selected buffer attribute. - Specifies a combination of two values: data type and data depth per band. - Specifies the buffer usage. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a color data buffer. - Specifies the MIL system on which to allocate the buffer. - Specifies the number of (x,y) surfaces (also called color bands) to allocate to the buffer. - Specifies the buffer width. The units are determined by the selected buffer attribute. - Specifies the buffer height. The units are determined by the selected buffer attribute. - Specifies a combination of two values: data type and data depth per band. - Specifies the buffer usage. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a buffer and add it as a component of a container. - Specifies the MIL identifier of the container to which to add the component. - Specifies the number of (x,y) surfaces (also called bands) to allocate to the buffer. - Specifies the buffer width. The units are determined by the selected buffer attribute. - Specifies the buffer height. The units are determined by the selected buffer attribute. - Specifies a combination of two values: data type and data depth per band. - Specifies the buffer usage. - Specifies the component type, which identifies what kind of information the component stores. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a buffer and add it as a component of a container. - Specifies the MIL identifier of the container to which to add the component. - Specifies the number of (x,y) surfaces (also called bands) to allocate to the buffer. - Specifies the buffer width. The units are determined by the selected buffer attribute. - Specifies the buffer height. The units are determined by the selected buffer attribute. - Specifies a combination of two values: data type and data depth per band. - Specifies the buffer usage. - Specifies the component type, which identifies what kind of information the component stores. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a container. - Specifies the MIL system on which to allocate the container. - Specifies the container usage. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the container identifier. - The returned value is the container identifier. If allocation fails, M_NULL is returned. - - - Allocate a container. - Specifies the MIL system on which to allocate the container. - Specifies the container usage. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the container identifier. - The returned value is the container identifier. If allocation fails, M_NULL is returned. - - - Allocate an image buffer or a container (automatically determined by MIL) with settings appropriate for grabbing using the specified digitizer. - Specifies the MIL system on which to allocate the image buffer or the container. This parameter should be set to one of the following values: - Specifies the digitizer to use as a reference for determining the settings of the image buffer or container to allocate. - Specifies the usage of the image buffer or container. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the image buffer or container identifier. - The returned value is the identifier of the image buffer or container. If allocation fails, M_NULL is returned. - - - Decode the color information of a single-band, Bayer color-encoded image. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies whether white balancing and gamma correction are performed, and the coefficients and exponents used to perform these corrections, respectively. - Specifies the Bayer pattern to use in the conversion, and whether the white balancing coefficients will be calculated. - - - Allocate a 1D child data buffer within a specific region of the first row of a parent data buffer. - Specifies the identifier of the parent buffer. - Specifies the offset of the child buffer relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a 1D child data buffer within a specific region of the first row of a parent data buffer. - Specifies the identifier of the parent buffer. - Specifies the offset of the child buffer relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a child buffer within a specific region of a parent buffer. - Specifies the identifier of the parent buffer. - Specifies the horizontal pixel offset of the child buffer's top-left pixel, relative to the parent buffer's top-left pixel. - Specifies the vertical pixel offset of the child buffer's top-left pixel, relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the height of the child buffer. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a child buffer within a specific region of a parent buffer. - Specifies the identifier of the parent buffer. - Specifies the horizontal pixel offset of the child buffer's top-left pixel, relative to the parent buffer's top-left pixel. - Specifies the vertical pixel offset of the child buffer's top-left pixel, relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the height of the child buffer. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a color-band child data buffer within a color parent buffer. - Specifies the identifier of the parent buffer. - Specifies the band or bands of the parent data buffer from which to allocate the child data buffer. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a color-band child data buffer within a color parent buffer. - Specifies the identifier of the parent buffer. - Specifies the band or bands of the parent data buffer from which to allocate the child data buffer. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a child data buffer within a color parent buffer. - Specifies the identifier of the parent buffer. - Specifies the color band of the parent data buffer from which to allocate the child data buffer. - Specifies the horizontal offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the vertical offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the height of the child buffer. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a child data buffer within a color parent buffer. - Specifies the identifier of the parent buffer. - Specifies the color band of the parent data buffer from which to allocate the child data buffer. - Specifies the horizontal offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the vertical offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the height of the child buffer. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a child data buffer within a color parent buffer and, if necessary, performs a clipping operation. - Specifies the identifier of the parent buffer. - Specifies the color band of the parent data buffer from which to allocate the child data buffer. - Specifies the horizontal offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the vertical offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the height of the child buffer. - Specifies the address of the variable in which the clipping status is written. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a child data buffer within a color parent buffer and, if necessary, performs a clipping operation. - Specifies the identifier of the parent buffer. - Specifies the color band of the parent data buffer from which to allocate the child data buffer. - Specifies the horizontal offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the vertical offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the height of the child buffer. - Specifies the address of the variable in which the clipping status is written. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a child data buffer within a color parent buffer and, if necessary, performs a clipping operation. - Specifies the identifier of the parent buffer. - Specifies the color band of the parent data buffer from which to allocate the child data buffer. - Specifies the horizontal offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the vertical offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the height of the child buffer. - Specifies the address of the variable in which the clipping status is written. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a child data buffer within a color parent buffer and, if necessary, performs a clipping operation. - Specifies the identifier of the parent buffer. - Specifies the color band of the parent data buffer from which to allocate the child data buffer. - Specifies the horizontal offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the vertical offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the height of the child buffer. - Specifies the address of the variable in which the clipping status is written. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a child container. - Specifies the identifier of the parent container. - Specifies the number of elements in the array of criteria that will be applied to the parent container. - Specifies the address of an array of criteria that will be used to determine which components from the parent container to make part of the child container. - Specifies whether to have the child container contain the components that meet at least one of the criteria, or only the components that meet all of the criteria. - Specifies the address of the variable in which to write the identifier of the child container. - The returned value is the child container identifier, if successful. If allocation fails, M_NULL is returned. - - - Move and resize a child buffer within the parent buffer. - Specifies the identifier of the child buffer to move and/or resize. - Specifies the new X-offset of the child buffer relative to the parent buffer's top-left pixel. - Specifies the new Y-offset of the child buffer relative to the parent's top-left pixel. - Specifies the new width of the child buffer. - Specifies the new height of the child buffer. - Specifies the function's control flag. - - - Clears a buffer, or the components of a container, to a specified color. - Specifies the identifier of the buffer or container to clear. - Specifies the color value with which to clear the buffer. - - - Conditionally clears a buffer to a specified color. - Specifies the identifier of the data buffer to conditionally clear. - Specifies the red component of the clear color, or, if DstBufId is a single band, this value is used as the clear color. - Specifies the green component of the clear color. - Specifies the blue component of the clear color. - Specifies the identifier of the condition buffer. - Specifies the condition for which the condition buffer is tested. - Specifies the color value for the specified condition. - - - Clones a data buffer or container. - Specifies the identifier of the source buffer or container to clone. - Specifies the system on which to allocate the clone. - Specifies the width of the clone. If the source is a container, this must be set to M_DEFAULT. - Specifies the height of the clone. If the source is a container, this must be set to M_DEFAULT. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the attributes of the clone. For both buffers and containers you can specify that the clone will retain the same attributes as the source by setting this parameter to M_DEFAULT. - Specifies the control settings for the cloning operation. - Specifies the address of the variable in which to write the buffer or container identifier. - The returned value is the buffer or container identifier. If allocation fails, M_NULL is returned. - - - Clones a data buffer or container. - Specifies the identifier of the source buffer or container to clone. - Specifies the system on which to allocate the clone. - Specifies the width of the clone. If the source is a container, this must be set to M_DEFAULT. - Specifies the height of the clone. If the source is a container, this must be set to M_DEFAULT. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the attributes of the clone. For both buffers and containers you can specify that the clone will retain the same attributes as the source by setting this parameter to M_DEFAULT. - Specifies the control settings for the cloning operation. - Specifies the address of the variable in which to write the buffer or container identifier. - The returned value is the buffer or container identifier. If allocation fails, M_NULL is returned. - - - Control a specified data buffer setting. - Specifies the identifier of the buffer to control. - Specifies the buffer setting to control. - Specifies the value needed for the setting. - - - Control a specified data buffer setting. - Specifies the identifier of the buffer to control. - Specifies the buffer setting to control. - Specifies the value needed for the setting. - - - Control a specified area of a buffer. - Specifies the identifier of the buffer to control. - Specifies the horizontal pixel offset of the area. - Specifies the vertical pixel offset of the area. - Specifies the width of the area, in pixels. - Specifies the height of the area, in pixels. - Specifies the band of the area. This parameter can be set to one of the following values. - Specifies the type of buffer setting to control. - Specifies the value required for the setting. - - - Control a setting of the specified container, or one of its components. - Specifies the identifier of the container to control, or of which to control a component. - Specifies what to control; either the container itself, or a component of the container. - Specifies the setting to control. - Specifies the value needed for the setting. - - - Control a setting of the specified container, or one of its components. - Specifies the identifier of the container to control, or of which to control a component. - Specifies what to control; either the container itself, or a component of the container. - Specifies the setting to control. - Specifies the value needed for the setting. - - - Converts 3D data to a format that is 3D-processable and/or 3D-displayable. - Specifies the identifier of the source container or fully corrected depth map image buffer to convert. - Specifies the identifier of the destination container or image buffer in which to store the converted data. - Specifies the identifier of a 1-band, 1D M_ARRAY buffer containing the Y-axis value for each row of coordinates stored in the range or disparity component of the source container. - Specifies which operations to apply to the data during conversion. - Specifies whether to generate an error when there is missing or ambiguous information in the source, or to compensate by making assumptions about the missing information. - - - Copy data from one buffer to another. - Specifies the identifier of the source data buffer. - Specifies the identifier of the destination data buffer. - - - Copy buffer, clipping data outside the destination buffer. - Specifies the identifier of the source data buffer. - Specifies the identifier of the destination data buffer. - Specifies the horizontal pixel offset of the destination buffer area at which to start copying data. - Specifies the vertical pixel offset of the destination buffer area at which to start copying data. - - - Copy one or all bands of an image buffer. - Specifies the identifiers of the source data buffer. - Specifies the identifiers of the destination data buffer. - Specifies the color band to copy. Set Band to one of the following values: - - - Copy a two-dimensional region of one or all bands of an image buffer to another buffer. - Specifies the identifier of the source data buffer. - Specifies the identifier of the destination data buffer. - Specifies the source color band from which to copy. SrcBand can be set to one of the following values: - Specifies the horizontal pixel offset of the region to read relative to the source buffer starting coordinate. - Specifies the vertical pixel offset of the region to read relative to the source buffer starting coordinate. - Specifies the destination color band in which to copy. - Specifies the horizontal pixel offset of the region to write relative to the destination buffer starting coordinate. - Specifies the vertical pixel offset of the region to write relative to the destination buffer starting coordinate. - Specifies the width of the region to be copied, starting from the specified offset ( SrcOffX, DstOffX). - Specifies the height of the region to be copied, starting from the specified offset ( SrcOffY, DstOffY). - - - Copy a data buffer, or components of a container, to components of a destination container. - Specifies the identifier of the source data buffer or container. - Specifies the identifier of the destination container. - Specifies the criterion which will be used to determine which components of the source container to copy. If the source is a data buffer, this parameter must be set to M_DEFAULT . - Specifies how to copy the source buffer or component(s) to the destination container. - Specifies whether to copy the data, settings, and attributes. - - - Copy conditionally the source buffer to the destination buffer. - Specifies the identifier of the source data buffer. - Specifies the identifier of the destination data buffer. - Specifies the identifier of the condition buffer. - Specifies the condition for which the condition buffer is tested. - Specifies the color value for the specified condition. - - - Copy buffer with mask. - Specifies the identifier of the source data buffer. Note that the source data buffer cannot be of type floating-point. - Specifies the identifier of the destination data buffer. Note that the destination data buffer cannot be of type floating-point. - Specifies the mask value. - - - Create a two-dimensional data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data type and data depth. - Specifies the buffer usage. - Specifies the physical nature of the buffer. - Specifies the size of the pitch. - Specifies the MIL identifier of the buffer, or a pointer to the data array, on which to map the created MIL buffer. - Specifies the address of the variable in which the buffer identifier is to be written. - The returned value is the buffer identifier. If allocation fails, an identifier of 0 is returned. - - - Create a two-dimensional data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data type and data depth. - Specifies the buffer usage. - Specifies the physical nature of the buffer. - Specifies the size of the pitch. - Specifies the MIL identifier of the buffer, or a pointer to the data array, on which to map the created MIL buffer. - Specifies the address of the variable in which the buffer identifier is to be written. - The returned value is the buffer identifier. If allocation fails, an identifier of 0 is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a component in the specified container. - Specifies the MIL identifier of the container in which to create the buffer component. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the component type, which identifies what kind of information the buffer component stores. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Inquire about the data in a file. - Specifies the file that contains the data. - Specifies the type of file setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information is not available, M_INVALID is returned. If an AVI file is specified but its codec is not known, M_AVI_CODEC_UNSUPPORTED is returned. - - - Inquire about the data in a file. - Specifies the file that contains the data. - Specifies the type of file setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information is not available, M_INVALID is returned. If an AVI file is specified but its codec is not known, M_AVI_CODEC_UNSUPPORTED is returned. - - - Inquire about the data in a file. - Specifies the file that contains the data. - Specifies the type of file setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information is not available, M_INVALID is returned. If an AVI file is specified but its codec is not known, M_AVI_CODEC_UNSUPPORTED is returned. - - - Inquire about the data in a file. - Specifies the file that contains the data. - Specifies the type of file setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information is not available, M_INVALID is returned. If an AVI file is specified but its codec is not known, M_AVI_CODEC_UNSUPPORTED is returned. - - - Inquire about the data in a file. - Specifies the file that contains the data. - Specifies the type of file setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information is not available, M_INVALID is returned. If an AVI file is specified but its codec is not known, M_AVI_CODEC_UNSUPPORTED is returned. - - - Export a data buffer or container to a file. - Specifies the name and path of the file in which to save the data buffer or container. - Specifies the file format. - Specifies the identifier of the data buffer or container to save. - - - Export a data buffer or container to a file. - Specifies the name and path of the file in which to save the data buffer or container. - Specifies the file format. - Specifies the identifier of the data buffer or container to save. - - - Export a sequence of image buffers to an AVI file. - Specifies the name and path of the AVI file. - Specifies the format of the file. - Specifies the image buffers to export or, when opening or closing ( M_OPEN, M_OPEN + M_APPEND, or M_CLOSE) a file on a remote computer, a MIL system allocated on the remote computer. - Specifies the number of MIL identifiers passed to the BufArrayPtrOrSystemIdPtr parameter (image buffers or system identifiers). - Specifies the frame rate (number of images/sec) of the sequence. - Specifies whether to write, overwrite, or append the image buffers to the AVI file. - - - Export a sequence of image buffers to an AVI file. - Specifies the name and path of the AVI file. - Specifies the format of the file. - Specifies the image buffers to export or, when opening or closing ( M_OPEN, M_OPEN + M_APPEND, or M_CLOSE) a file on a remote computer, a MIL system allocated on the remote computer. - Specifies the number of MIL identifiers passed to the BufArrayPtrOrSystemIdPtr parameter (image buffers or system identifiers). - Specifies the frame rate (number of images/sec) of the sequence. - Specifies whether to write, overwrite, or append the image buffers to the AVI file. - - - Export a sequence of image buffers to an AVI file. - Specifies the name and path of the AVI file. - Specifies the format of the file. - Specifies the image buffers to export or, when opening or closing ( M_OPEN, M_OPEN + M_APPEND, or M_CLOSE) a file on a remote computer, a MIL system allocated on the remote computer. - Specifies the number of MIL identifiers passed to the BufArrayPtrOrSystemIdPtr parameter (image buffers or system identifiers). - Specifies the frame rate (number of images/sec) of the sequence. - Specifies whether to write, overwrite, or append the image buffers to the AVI file. - - - Export a sequence of image buffers to an AVI file. - Specifies the name and path of the AVI file. - Specifies the format of the file. - Specifies the image buffers to export or, when opening or closing ( M_OPEN, M_OPEN + M_APPEND, or M_CLOSE) a file on a remote computer, a MIL system allocated on the remote computer. - Specifies the number of MIL identifiers passed to the BufArrayPtrOrSystemIdPtr parameter (image buffers or system identifiers). - Specifies the frame rate (number of images/sec) of the sequence. - Specifies whether to write, overwrite, or append the image buffers to the AVI file. - - - Free a data buffer or container. - Specifies the identifier of the data buffer or container to deallocate. - - - Free one or more buffer components of a specified container. - Specifies the MIL identifier of the container which contains the component(s) to be freed. - Specifies the criterion used to determine which component(s) will be freed from the container. - Reserved for future expansion and must be set to M_DEFAULT . - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a one-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a one-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a one-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a one-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a one-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a one-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a one-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get information about a hook event. - Specifies the buffer or container event identifier received by the hook-handler function (see MbufHookFunction). - Specifies the event type and the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hook event. - Specifies the buffer or container event identifier received by the hook-handler function (see MbufHookFunction). - Specifies the event type and the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hook event. - Specifies the buffer or container event identifier received by the hook-handler function (see MbufHookFunction). - Specifies the event type and the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hook event. - Specifies the buffer or container event identifier received by the hook-handler function (see MbufHookFunction). - Specifies the event type and the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hook event. - Specifies the buffer or container event identifier received by the hook-handler function (see MbufHookFunction). - Specifies the event type and the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Hook a function to a buffer or container event. - Specifies the identifier of the buffer or container. - Specifies the buffer event to which to hook the function. - Specifies the address of the function that should be called when the specified event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Import data from a file into a data buffer or container. - Specifies the name and path of the file from which to import the data. - Specifies the file format. - Specifies the import operation. - Specifies the system on which to allocate the buffer or container for an M_RESTORE operation. For an M_LOAD operation, this parameter should be set to M_NULL . - Specifies the address of the variable containing the buffer or container identifier, for an M_LOAD operation, or the address of the variable in which to store the new buffer or container identifier, for an M_RESTORE operation. - The returned value is the buffer or container identifier (for an M_RESTORE operation only). If allocation fails, M_NULL is returned. - - - Import data from a file into a data buffer or container. - Specifies the name and path of the file from which to import the data. - Specifies the file format. - Specifies the import operation. - Specifies the system on which to allocate the buffer or container for an M_RESTORE operation. For an M_LOAD operation, this parameter should be set to M_NULL . - Specifies the address of the variable containing the buffer or container identifier, for an M_LOAD operation, or the address of the variable in which to store the new buffer or container identifier, for an M_RESTORE operation. - The returned value is the buffer or container identifier (for an M_RESTORE operation only). If allocation fails, M_NULL is returned. - - - Import data from a file into a data buffer or container. - Specifies the name and path of the file from which to import the data. - Specifies the file format. - Specifies the import operation. - Specifies the system on which to allocate the buffer or container for an M_RESTORE operation. For an M_LOAD operation, this parameter should be set to M_NULL . - Specifies the address of the variable containing the buffer or container identifier, for an M_LOAD operation, or the address of the variable in which to store the new buffer or container identifier, for an M_RESTORE operation. - The returned value is the buffer or container identifier (for an M_RESTORE operation only). If allocation fails, M_NULL is returned. - - - Import data from a file into a data buffer or container. - Specifies the name and path of the file from which to import the data. - Specifies the file format. - Specifies the import operation. - Specifies the system on which to allocate the buffer or container for an M_RESTORE operation. For an M_LOAD operation, this parameter should be set to M_NULL . - Specifies the address of the variable containing the buffer or container identifier, for an M_LOAD operation, or the address of the variable in which to store the new buffer or container identifier, for an M_RESTORE operation. - The returned value is the buffer or container identifier (for an M_RESTORE operation only). If allocation fails, M_NULL is returned. - - - Import a sequence of images from an AVI file into separate image buffers. - Specifies the name and path of the AVI file. - Specifies the format of the file. - Specifies whether to import the specified sequence of images into automatically allocated buffers or previously allocated buffers. - Specifies the system on which to allocate the buffers for an M_RESTORE operation. In other cases, this parameter should be set to M_NULL . - Specifies the address of the array containing the buffer identifiers for an M_LOAD operation, or the address of the array in which to store the new buffer identifiers for an M_RESTORE operation. - Specifies the frame number of the image from which to begin importing. - Specifies the number of images, starting at StartImage, to import. - Specifies the function's control flag. This parameter can be set to one of the following: - - - Import a sequence of images from an AVI file into separate image buffers. - Specifies the name and path of the AVI file. - Specifies the format of the file. - Specifies whether to import the specified sequence of images into automatically allocated buffers or previously allocated buffers. - Specifies the system on which to allocate the buffers for an M_RESTORE operation. In other cases, this parameter should be set to M_NULL . - Specifies the address of the array containing the buffer identifiers for an M_LOAD operation, or the address of the array in which to store the new buffer identifiers for an M_RESTORE operation. - Specifies the frame number of the image from which to begin importing. - Specifies the number of images, starting at StartImage, to import. - Specifies the function's control flag. This parameter can be set to one of the following: - - - Import a sequence of images from an AVI file into separate image buffers. - Specifies the name and path of the AVI file. - Specifies the format of the file. - Specifies whether to import the specified sequence of images into automatically allocated buffers or previously allocated buffers. - Specifies the system on which to allocate the buffers for an M_RESTORE operation. In other cases, this parameter should be set to M_NULL . - Specifies the address of the array containing the buffer identifiers for an M_LOAD operation, or the address of the array in which to store the new buffer identifiers for an M_RESTORE operation. - Specifies the frame number of the image from which to begin importing. - Specifies the number of images, starting at StartImage, to import. - Specifies the function's control flag. This parameter can be set to one of the following: - - - Import a sequence of images from an AVI file into separate image buffers. - Specifies the name and path of the AVI file. - Specifies the format of the file. - Specifies whether to import the specified sequence of images into automatically allocated buffers or previously allocated buffers. - Specifies the system on which to allocate the buffers for an M_RESTORE operation. In other cases, this parameter should be set to M_NULL . - Specifies the address of the array containing the buffer identifiers for an M_LOAD operation, or the address of the array in which to store the new buffer identifiers for an M_RESTORE operation. - Specifies the frame number of the image from which to begin importing. - Specifies the number of images, starting at StartImage, to import. - Specifies the function's control flag. This parameter can be set to one of the following: - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL container or component setting. - Specifies the identifier of the source container. The container must have been previously allocated on the required system using MbufAllocContainer. - Specifies the component to inquire. - Specifies the setting to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information cannot be retrieved, M_ERROR is returned. - - - Inquire about a MIL container or component setting. - Specifies the identifier of the source container. The container must have been previously allocated on the required system using MbufAllocContainer. - Specifies the component to inquire. - Specifies the setting to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information cannot be retrieved, M_ERROR is returned. - - - Inquire about a MIL container or component setting. - Specifies the identifier of the source container. The container must have been previously allocated on the required system using MbufAllocContainer. - Specifies the component to inquire. - Specifies the setting to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information cannot be retrieved, M_ERROR is returned. - - - Inquire about a MIL container or component setting. - Specifies the identifier of the source container. The container must have been previously allocated on the required system using MbufAllocContainer. - Specifies the component to inquire. - Specifies the setting to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information cannot be retrieved, M_ERROR is returned. - - - Inquire about a MIL container or component setting. - Specifies the identifier of the source container. The container must have been previously allocated on the required system using MbufAllocContainer. - Specifies the component to inquire. - Specifies the setting to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information cannot be retrieved, M_ERROR is returned. - - - Inquire about a MIL container or component setting. - Specifies the identifier of the source container. The container must have been previously allocated on the required system using MbufAllocContainer. - Specifies the component to inquire. - Specifies the setting to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information cannot be retrieved, M_ERROR is returned. - - - Inquire about a MIL container or component setting. - Specifies the identifier of the source container. The container must have been previously allocated on the required system using MbufAllocContainer. - Specifies the component to inquire. - Specifies the setting to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information cannot be retrieved, M_ERROR is returned. - - - Link one buffer or container to another. - Specifies the identifier of the source buffer or container. - Specifies the identifier of the target buffer or container. - Specifies the link operation to perform. - Specifies whether to convert 3D information copied from the source container. - - - Load data from a file into a data buffer. - Specifies the name and path of the file from which to load the data. - Specifies the identifier of the destination buffer. - - - Load data from a file into a data buffer. - Specifies the name and path of the file from which to load the data. - Specifies the identifier of the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a one-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a one-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a one-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a one-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a one-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a one-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a one-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Restore data from disk into an automatically allocated data buffer. - Specifies the name and path of the file from which to restore the data buffer. - Specifies the system on which to allocate the buffer. - Specifies the address of the variable in which the buffer identifier is to be written. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Restore data from disk into an automatically allocated data buffer. - Specifies the name and path of the file from which to restore the data buffer. - Specifies the system on which to allocate the buffer. - Specifies the address of the variable in which the buffer identifier is to be written. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Save a data buffer or container in a file, using a MIL output file format. - Specifies the name and path of the file in which to save the file. - Specifies the identifier of the data buffer or container to save. - - - Save a data buffer or container in a file, using a MIL output file format. - Specifies the name and path of the file in which to save the file. - Specifies the identifier of the data buffer or container to save. - - - Set the region of interest (ROI) of an image buffer. - Specifies the identifier of the image buffer for which to set the ROI. - Specifies the identifier of the image buffer or 2D graphics list that contains the data to use to set the ROI. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the type of operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a buffer or container from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the buffer or container. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the buffer or container. - Specifies the MIL version of the buffer or container. - Specifies the control flag for the operation. Set this parameter to M_DEFAULT if not used. - Specifies the address of the variable in which to write, or from which to read, the buffer or container identifier. - Specifies the address of the variable in which to write the size of the buffer or container, in bytes. - - - Load, restore, or save a buffer or container from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the buffer or container. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the buffer or container. - Specifies the MIL version of the buffer or container. - Specifies the control flag for the operation. Set this parameter to M_DEFAULT if not used. - Specifies the address of the variable in which to write, or from which to read, the buffer or container identifier. - Specifies the address of the variable in which to write the size of the buffer or container, in bytes. - - - Load, restore, or save a buffer or container from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the buffer or container. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the buffer or container. - Specifies the MIL version of the buffer or container. - Specifies the control flag for the operation. Set this parameter to M_DEFAULT if not used. - Specifies the address of the variable in which to write, or from which to read, the buffer or container identifier. - Specifies the address of the variable in which to write the size of the buffer or container, in bytes. - - - Load, restore, or save a buffer or container from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the buffer or container. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the buffer or container. - Specifies the MIL version of the buffer or container. - Specifies the control flag for the operation. Set this parameter to M_DEFAULT if not used. - Specifies the address of the variable in which to write, or from which to read, the buffer or container identifier. - Specifies the address of the variable in which to write the size of the buffer or container, in bytes. - - - Load, restore, or save a buffer or container from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the buffer or container. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the buffer or container. - Specifies the MIL version of the buffer or container. - Specifies the control flag for the operation. Set this parameter to M_DEFAULT if not used. - Specifies the address of the variable in which to write, or from which to read, the buffer or container identifier. - Specifies the address of the variable in which to write the size of the buffer or container, in bytes. - - - Load, restore, or save a buffer or container from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the buffer or container. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the buffer or container. - Specifies the MIL version of the buffer or container. - Specifies the control flag for the operation. Set this parameter to M_DEFAULT if not used. - Specifies the address of the variable in which to write, or from which to read, the buffer or container identifier. - Specifies the address of the variable in which to write the size of the buffer or container, in bytes. - - - Copy a two-dimensional region of one or all bands from the source buffer into a two-dimensional region of one or all bands in the destination buffer, using a specified transfer function and transfer type. - Specifies the identifier of the source buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the source region, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the source region, relative to the top-left coordinate of the source buffer. - Specifies the width of the source region. - Specifies the height of the source region. - Specifies the color band of the region from which to copy. This parameter can be set to one of the following values: - Specifies the horizontal offset of the destination region, relative to the top-left coordinate of the destination buffer. - Specifies the vertical offset of the destination region, relative to the top-left coordinate of the destination buffer. - Specifies the width of the destination region. - Specifies the height of the destination region. - Specifies the color band of the destination region in which to copy. - Specifies the function to use in the transfer. This parameter can be set to one of the following: - Specifies the type of transfer. - Specifies the color value that is passed to the transfer function. - Specifies a pointer to the MIL identifier of the overlay buffer, if applicable. - - - Copy a two-dimensional region of one or all bands from the source buffer into a two-dimensional region of one or all bands in the destination buffer, using a specified transfer function and transfer type. - Specifies the identifier of the source buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the source region, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the source region, relative to the top-left coordinate of the source buffer. - Specifies the width of the source region. - Specifies the height of the source region. - Specifies the color band of the region from which to copy. This parameter can be set to one of the following values: - Specifies the horizontal offset of the destination region, relative to the top-left coordinate of the destination buffer. - Specifies the vertical offset of the destination region, relative to the top-left coordinate of the destination buffer. - Specifies the width of the destination region. - Specifies the height of the destination region. - Specifies the color band of the destination region in which to copy. - Specifies the function to use in the transfer. This parameter can be set to one of the following: - Specifies the type of transfer. - Specifies the color value that is passed to the transfer function. - Specifies a pointer to the MIL identifier of the overlay buffer, if applicable. - - - Allocate a camera calibration context, a fixturing offset object, or a 3D draw calibration context. - Specifies the system on which to allocate the camera calibration context, fixturing offset object, or 3D draw calibration context. - Specifies the camera calibration mode, if allocating a camera calibration context. Otherwise, specifies to allocate a fixturing offset or a 3D draw calibration context. - Specifies the function's operation flag. - Specifies the address in which to return the identifier of the camera calibration context, fixturing offset object, or 3D draw calibration context. Since McalAlloc also returns the identifier, you can set this parameter to M_NULL . - The returned value is the context's or fixturing offset object's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a camera calibration context, a fixturing offset object, or a 3D draw calibration context. - Specifies the system on which to allocate the camera calibration context, fixturing offset object, or 3D draw calibration context. - Specifies the camera calibration mode, if allocating a camera calibration context. Otherwise, specifies to allocate a fixturing offset or a 3D draw calibration context. - Specifies the function's operation flag. - Specifies the address in which to return the identifier of the camera calibration context, fixturing offset object, or 3D draw calibration context. Since McalAlloc also returns the identifier, you can set this parameter to M_NULL . - The returned value is the context's or fixturing offset object's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Associate/disassociate a camera calibration context with/from an image or digitizer. - Specifies the camera calibration context to associate. This parameter can be set to one of the following. If an image buffer, digitizer or result buffer is passed to this parameter, the camera calibration context associated with that object is used; camera calibration settings saved with the image, digitizer or result are also copied. - Specifies the identifier of the image or digitizer with which to associate the camera calibration context. - Specifies the function's control flag. - - - Control the camera calibration information of a camera calibration context, calibrated image, or 3D draw calibration context. - Specifies the identifier of the camera calibration context, calibrated image, or 3D draw calibration context. - Specifies the setting to change. - Specifies the setting's new value. - - - Control the camera calibration information of a camera calibration context, calibrated image, or 3D draw calibration context. - Specifies the identifier of the camera calibration context, calibrated image, or 3D draw calibration context. - Specifies the setting to change. - Specifies the setting's new value. - - - Control the camera calibration information of a camera calibration context, calibrated image, or 3D draw calibration context. - Specifies the identifier of the camera calibration context, calibrated image, or 3D draw calibration context. - Specifies the setting to change. - Specifies the setting's new value. - - - Draw specific features of results obtained from a camera calibration operation. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the camera calibration context, calibrated image, corrected image, or fixturing offset object from which to extract the information to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. If a buffer is specified, it must be an unsigned 8-bit image buffer. - Specifies the type of operation to perform. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which the calibration points or fiducial box should be drawn. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Draw 3D annotations based on a calibrated or corrected image. - Specifies the identifier of the 3D draw calibration context that specifies the annotations to draw and how to draw them. This parameter must be set to one of the following values: - Specifies the identifier of the camera calibration context or calibrated image. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the identifier of the 3D graphics list in which to draw. You can specify a 3D graphics list that you have previously allocated using M3dgraAlloc, or you can specify the identifier of the 3D display's internal graphics list (inquired using M3ddispInquire with M_3D_GRAPHIC_LIST_ID). - Specifies the label of the 3D graphic in the 3D graphics list to be used as the annotation's parent. - Specifies the identifier of the image buffer containing the texture image, which you can apply to the relative XY plane to enhance its visibility. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the parent label of the graphics added to the graphics list. - - - Move the relative coordinate system or learn the fixturing offset. - Specifies the identifier of the destination camera calibration context, 3D transformation matrix object, the 3D reconstruction result buffer, or the image for which to displace the relative coordinate system. - Specifies the identifier of the fixturing offset object to set up ( M_LEARN_OFFSET) or to apply to the reference location when moving the relative coordinate system ( M_MOVE_RELATIVE). - Specifies the operation to perform. - Specifies how the location used for the operation is specified. - Specifies the identifier of the MIL object containing the location for the operation, or containing the coordinate system in which the location is expressed. - Specifies information about the location used for the operation. Its definition is dependent on the specified operation and the location type. - Specifies information about the location used for the operation. Its definition is dependent on the specified operation and the location type. - Specifies information about the location used for the operation. Its definition is dependent on the specified operation and the location type. - Specifies information about the location used for the operation. Its definition is dependent on the specified operation and the location type. - - - Free a camera calibration context or a fixturing offset object. - Specifies the identifier of the camera calibration context or fixturing offset object. - - - Return the position and orientation of a coordinate system. - Specifies the identifier of a camera calibration context, a 3D reconstruction context of type M_CALIBRATED_CAMERA_LINEAR_MOTION, a 3D reconstruction result buffer of type M_POINT_CLOUD_RESULT, or any object that has camera calibration information, such as an image or a result buffer. - Specifies the coordinate system for which to inquire about its position and orientation. - Specifies the coordinate system that will be used as a reference for calculations. All returned coordinates or angles will be calculated relative to this coordinate system. - Specifies the type of transformation to use to return the location of the target coordinate system with respect to the reference coordinate system. - Specifies the identifier of the destination MIL array buffer or transformation matrix object in which to return the matrix representation of the transformation required to cause the reference coordinate system to align with the target coordinate system. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - - - Return the position and orientation of a coordinate system. - Specifies the identifier of a camera calibration context, a 3D reconstruction context of type M_CALIBRATED_CAMERA_LINEAR_MOTION, a 3D reconstruction result buffer of type M_POINT_CLOUD_RESULT, or any object that has camera calibration information, such as an image or a result buffer. - Specifies the coordinate system for which to inquire about its position and orientation. - Specifies the coordinate system that will be used as a reference for calculations. All returned coordinates or angles will be calculated relative to this coordinate system. - Specifies the type of transformation to use to return the location of the target coordinate system with respect to the reference coordinate system. - Specifies the identifier of the destination MIL array buffer or transformation matrix object in which to return the matrix representation of the transformation required to cause the reference coordinate system to align with the target coordinate system. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - - - Return the position and orientation of a coordinate system. - Specifies the identifier of a camera calibration context, a 3D reconstruction context of type M_CALIBRATED_CAMERA_LINEAR_MOTION, a 3D reconstruction result buffer of type M_POINT_CLOUD_RESULT, or any object that has camera calibration information, such as an image or a result buffer. - Specifies the coordinate system for which to inquire about its position and orientation. - Specifies the coordinate system that will be used as a reference for calculations. All returned coordinates or angles will be calculated relative to this coordinate system. - Specifies the type of transformation to use to return the location of the target coordinate system with respect to the reference coordinate system. - Specifies the identifier of the destination MIL array buffer or transformation matrix object in which to return the matrix representation of the transformation required to cause the reference coordinate system to align with the target coordinate system. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - - - Calibrate your camera setup using a grid. - Specifies the identifier of the camera calibration context. - Specifies the identifier of the image buffer containing the grid. - Specifies the X-coordinate of the grid's reference calibration point, in the real world. - Specifies the Y-coordinate of the grid's reference calibration point, in the real world. - Specifies the Z-coordinate of the grid's reference calibration point, in the real world. - Specifies the number of rows in the camera calibration grid. - Specifies the number of columns in the camera calibration grid. - Specifies the number of world units between rows. - Specifies the number of world units between columns. - Specifies the camera calibration operation to perform. - Specifies the type of grid used. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Calibrate your camera setup using a list of coordinates. - Specifies the identifier of the camera calibration context. - Specifies the address of the array containing the X-pixel coordinates. - Specifies the address of the array containing the Y-pixel coordinates. - Specifies the address of the array containing the X-world coordinates in the camera calibration-plane coordinate system. - Specifies the address of the array containing the Y-world coordinates in the camera calibration-plane coordinate system. - Specifies the address of the array containing the Z-world coordinates. - Specifies the number of coordinates in the supplied arrays. - Specifies the camera calibration operation to perform. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Calibrate your camera setup using a list of coordinates. - Specifies the identifier of the camera calibration context. - Specifies the address of the array containing the X-pixel coordinates. - Specifies the address of the array containing the Y-pixel coordinates. - Specifies the address of the array containing the X-world coordinates in the camera calibration-plane coordinate system. - Specifies the address of the array containing the Y-world coordinates in the camera calibration-plane coordinate system. - Specifies the address of the array containing the Z-world coordinates. - Specifies the number of coordinates in the supplied arrays. - Specifies the camera calibration operation to perform. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Calibrate your camera setup using a list of coordinates. - Specifies the identifier of the camera calibration context. - Specifies the address of the array containing the X-pixel coordinates. - Specifies the address of the array containing the Y-pixel coordinates. - Specifies the address of the array containing the X-world coordinates in the camera calibration-plane coordinate system. - Specifies the address of the array containing the Y-world coordinates in the camera calibration-plane coordinate system. - Specifies the address of the array containing the Z-world coordinates. - Specifies the number of coordinates in the supplied arrays. - Specifies the camera calibration operation to perform. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Change the origin and/or orientation of the relative coordinate system. - Specifies the identifier of the camera calibration context or calibrated image. - Specifies the X-offset of the relative coordinate system origin from the reference coordinate system, in world-units. - Specifies the Y-offset of the relative coordinate system origin from the reference coordinate system, in world-units. - Specifies the Z-offset of the relative coordinate system origin from the reference coordinate system, in world-units. - Specifies the angle, in degrees, at which to rotate the relative coordinate system around the Z-axis of the reference coordinate system. A positive angle will rotate the relative coordinate system in the direction from the positive X-axis to the negative Y-axis of the reference coordinate system. - Specifies how to apply the transformation. This establishes the reference coordinate system. - - - Restore a camera or 3D draw calibration context from disk. - Specifies the name and path of the file from which to restore the camera or 3D draw calibration context. - Specifies the system on which to restore the camera or 3D draw calibration context. - Specifies the function's control flag. - Specifies the address in which to return the identifier of the camera or 3D draw calibration context. - The returned value is the identifier of the camera or 3D draw calibration context if the operation was successful; M_NULL if the operation failed. - - - Restore a camera or 3D draw calibration context from disk. - Specifies the name and path of the file from which to restore the camera or 3D draw calibration context. - Specifies the system on which to restore the camera or 3D draw calibration context. - Specifies the function's control flag. - Specifies the address in which to return the identifier of the camera or 3D draw calibration context. - The returned value is the identifier of the camera or 3D draw calibration context if the operation was successful; M_NULL if the operation failed. - - - Save a camera or 3D draw calibration context to a file. - Specifies the name and path of the file in which to save the camera or 3D draw calibration context. - Specifies the camera or 3D draw calibration context to save. - Specifies the function's control flag. - - - Save a camera or 3D draw calibration context to a file. - Specifies the name and path of the file in which to save the camera or 3D draw calibration context. - Specifies the camera or 3D draw calibration context to save. - Specifies the function's control flag. - - - Change the position and orientation of a coordinate system. - Specifies the identifier of a camera calibration context, 3D reconstruction result buffer of type M_POINT_CLOUD_RESULT, or a calibrated image. - Specifies the coordinate system on which to apply the transformation. - Specifies the reference coordinate system. The reference coordinate system must be defined before calling this function. - Specifies the type of transformation to apply to the target coordinate system. - Specifies the identifier of a MIL array buffer that contains the transformation matrix to use, or specifies the identifier of a transformation matrix object. The expected transformation matrix is dependent on the type of transformation selected. - Specifies an attribute of the transformation. Its definition is dependent on the type of transformation selected. - Specifies an attribute of the transformation. Its definition is dependent on the type of transformation selected. - Specifies an attribute of the transformation. Its definition is dependent on the type of transformation selected. - Specifies an attribute of the transformation. Its definition is dependent on the type of transformation selected. - - - Load, restore, or save a camera calibration context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the camera calibration context. - Specifies the operation to perform on the camera calibration context. - Specifies the type of stream in which to store/from which to restore the camera calibration context. - Specifies the MIL version of the camera calibration context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the camera calibration context. - Specifies the address of the variable in which to write the size of the camera calibration context, in bytes. - - - Load, restore, or save a camera calibration context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the camera calibration context. - Specifies the operation to perform on the camera calibration context. - Specifies the type of stream in which to store/from which to restore the camera calibration context. - Specifies the MIL version of the camera calibration context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the camera calibration context. - Specifies the address of the variable in which to write the size of the camera calibration context, in bytes. - - - Load, restore, or save a camera calibration context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the camera calibration context. - Specifies the operation to perform on the camera calibration context. - Specifies the type of stream in which to store/from which to restore the camera calibration context. - Specifies the MIL version of the camera calibration context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the camera calibration context. - Specifies the address of the variable in which to write the size of the camera calibration context, in bytes. - - - Load, restore, or save a camera calibration context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the camera calibration context. - Specifies the operation to perform on the camera calibration context. - Specifies the type of stream in which to store/from which to restore the camera calibration context. - Specifies the MIL version of the camera calibration context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the camera calibration context. - Specifies the address of the variable in which to write the size of the camera calibration context, in bytes. - - - Load, restore, or save a camera calibration context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the camera calibration context. - Specifies the operation to perform on the camera calibration context. - Specifies the type of stream in which to store/from which to restore the camera calibration context. - Specifies the MIL version of the camera calibration context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the camera calibration context. - Specifies the address of the variable in which to write the size of the camera calibration context, in bytes. - - - Load, restore, or save a camera calibration context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the camera calibration context. - Specifies the operation to perform on the camera calibration context. - Specifies the type of stream in which to store/from which to restore the camera calibration context. - Specifies the MIL version of the camera calibration context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the camera calibration context. - Specifies the address of the variable in which to write the size of the camera calibration context, in bytes. - - - Convert coordinates between their world and pixel values. - Specifies the identifier of the camera calibration context, calibrated image, or corrected image. - Specifies whether to perform a pixel-to-world or world-to-pixel conversion. - Specifies the X-coordinate of the input. - Specifies the Y-coordinate of the input. - Specifies the address of the variable in which to place the returned value of the X-coordinate. - Specifies the addres of the variable in which to place the returned value of the Y-coordinate. - - - Convert a list of coordinates, including 3D coordinates, between two coordinate systems. - Specifies the identifier of a camera calibration context, 3D reconstruction context, calibrated image, corrected image, or 3d reconstruction result buffer of type M_POINT_CLOUD_RESULT. When an identifier of an image buffer is specified, the transformation uses the camera calibration information associated with this image. - Specifies the coordinate system of the source coordinates. - Specifies the coordinate system in which to return the coordinates. - Specifies the number of points to convert. - Specifies the address of the array containing the X-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array containing the Y-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array containing the Z-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array in which to return the X-coordinates of the resulting points or the X-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the address of the array in which to return the Y-coordinates of the resulting points or the Y-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the address of the array in which to return the Z-coordinates of the resulting points or the Z-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the mode of transformation and how to deal with invalid points. - - - Convert a list of coordinates, including 3D coordinates, between two coordinate systems. - Specifies the identifier of a camera calibration context, 3D reconstruction context, calibrated image, corrected image, or 3d reconstruction result buffer of type M_POINT_CLOUD_RESULT. When an identifier of an image buffer is specified, the transformation uses the camera calibration information associated with this image. - Specifies the coordinate system of the source coordinates. - Specifies the coordinate system in which to return the coordinates. - Specifies the number of points to convert. - Specifies the address of the array containing the X-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array containing the Y-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array containing the Z-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array in which to return the X-coordinates of the resulting points or the X-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the address of the array in which to return the Y-coordinates of the resulting points or the Y-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the address of the array in which to return the Z-coordinates of the resulting points or the Z-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the mode of transformation and how to deal with invalid points. - - - Convert a list of coordinates, including 3D coordinates, between two coordinate systems. - Specifies the identifier of a camera calibration context, 3D reconstruction context, calibrated image, corrected image, or 3d reconstruction result buffer of type M_POINT_CLOUD_RESULT. When an identifier of an image buffer is specified, the transformation uses the camera calibration information associated with this image. - Specifies the coordinate system of the source coordinates. - Specifies the coordinate system in which to return the coordinates. - Specifies the number of points to convert. - Specifies the address of the array containing the X-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array containing the Y-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array containing the Z-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array in which to return the X-coordinates of the resulting points or the X-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the address of the array in which to return the Y-coordinates of the resulting points or the Y-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the address of the array in which to return the Z-coordinates of the resulting points or the Z-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the mode of transformation and how to deal with invalid points. - - - Convert a list of coordinates, including 3D coordinates, between two coordinate systems. - Specifies the identifier of a camera calibration context, 3D reconstruction context, calibrated image, corrected image, or 3d reconstruction result buffer of type M_POINT_CLOUD_RESULT. When an identifier of an image buffer is specified, the transformation uses the camera calibration information associated with this image. - Specifies the coordinate system of the source coordinates. - Specifies the coordinate system in which to return the coordinates. - Specifies the number of points to convert. - Specifies the address of the array containing the X-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array containing the Y-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array containing the Z-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array in which to return the X-coordinates of the resulting points or the X-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the address of the array in which to return the Y-coordinates of the resulting points or the Y-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the address of the array in which to return the Z-coordinates of the resulting points or the Z-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the mode of transformation and how to deal with invalid points. - - - Convert a list of coordinates between their world and pixel values. - Specifies the identifier of the camera calibration context, calibrated image, or corrected image. When an identifier of an image buffer is specified, the transformation uses the camera calibration context associated with this image. - Specifies whether to perform a pixel-to-world or world-to-pixel conversion. - Specifies the number of points in the coordinate list. - Specifies the address of the array of the input X-coordinates. - Specifies the address of the array of the input Y-coordinates. - Specifies the address of the array in which to place the output X-coordinates. - Specifies the address of the array in which to place the output Y-coordinates. - - - Convert a list of coordinates between their world and pixel values. - Specifies the identifier of the camera calibration context, calibrated image, or corrected image. When an identifier of an image buffer is specified, the transformation uses the camera calibration context associated with this image. - Specifies whether to perform a pixel-to-world or world-to-pixel conversion. - Specifies the number of points in the coordinate list. - Specifies the address of the array of the input X-coordinates. - Specifies the address of the array of the input Y-coordinates. - Specifies the address of the array in which to place the output X-coordinates. - Specifies the address of the array in which to place the output Y-coordinates. - - - Convert a list of coordinates between their world and pixel values. - Specifies the identifier of the camera calibration context, calibrated image, or corrected image. When an identifier of an image buffer is specified, the transformation uses the camera calibration context associated with this image. - Specifies whether to perform a pixel-to-world or world-to-pixel conversion. - Specifies the number of points in the coordinate list. - Specifies the address of the array of the input X-coordinates. - Specifies the address of the array of the input Y-coordinates. - Specifies the address of the array in which to place the output X-coordinates. - Specifies the address of the array in which to place the output Y-coordinates. - - - Convert a list of coordinates between their world and pixel values. - Specifies the identifier of the camera calibration context, calibrated image, or corrected image. When an identifier of an image buffer is specified, the transformation uses the camera calibration context associated with this image. - Specifies whether to perform a pixel-to-world or world-to-pixel conversion. - Specifies the number of points in the coordinate list. - Specifies the address of the array of the input X-coordinates. - Specifies the address of the array of the input Y-coordinates. - Specifies the address of the array in which to place the output X-coordinates. - Specifies the address of the array in which to place the output Y-coordinates. - - - Physically transform an image by removing distortions, or create LUTs that can be used to do the same. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer or LUT buffer. - Specifies the camera calibration context with which to transform the image. - Specifies the interpolation mode to use when associating destination pixels with source points. - Specifies the function's operation type. - Specifies the function's control flag. - - - Convert a result between its world and pixel value. - Specifies the identifier of the camera calibration context, calibrated image, or corrected image. - Specifies whether to perform a pixel-to-world or world-to-pixel conversion. - Specifies the type of result the given input value represents. - Specifies the input value. - Specifies the address in which to place the output value. - - - Convert a result, taken at a specific position, between its world and pixel value. - Specifies the identifier of the camera calibration context or image. - Specifies whether to perform a pixel-to-world or world-to-pixel conversion. - Specifies the type of result to convert. - Specifies the X-coordinate of the position at which to convert the result, in the units of the source coordinate system. - Specifies the Y-coordinate of the position at which to convert the result, in the units of the source coordinate system. - Specifies the result to convert at the specified position. This result must be of the type specified using ResultType. - Specifies the address in which to place the converted result. - - - Calibrate an image or a camera calibration context by specifying the translation, scale and offset of the absolute world coordinate system. - Specifies the identifier of the camera calibration context or of the image to calibrate. - Specifies the X-position in the absolute coordinate system of the center of the top-left pixel of the image. - Specifies the Y-position in the absolute coordinate system of the center of the top-left pixel of the image. - Specifies the scale between the world and pixel units in the X-direction. - Specifies the scale between the world and pixel units in the Y-direction. - Specifies the angle of the X-axis of the pixel coordinate system measured in the absolute coordinate system, in degrees. - Specifies the function's control flag. - - - Define the mapping characteristics of a camera calibration context according to an existing camera calibration context. - Specifies the identifier of the camera calibration context, calibrated image, or corrected image From which the source mapping is taken. - Specifies the identifier of the destination camera calibration context or image buffer. - Specifies the buffer containing the matrix of coefficients or the LUT buffer from which source X-coordinates are determined. - Specifies the LUT buffer from which source Y-coordinates are determined. - Specifies the X pixel coordinate of the top-left calibration point. - Specifies the Y pixel coordinate of the top-left calibration point. - Specifies the width of the grid of calibration points, in pixels. - Specifies the height of the grid of calibration points, in pixels. - Specifies the number of rows of calibration points to be used for camera calibration. - Specifies the number of columns of calibration points to be used for camera calibration. - Specifies the type of transformation. This parameter must be set to one of the following values. - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate a classifier context, a dataset context, or a training context. - Specifies the identifier of the system on which to allocate the context. - Specifies the type of context to allocate. - Specifies which predefined CNN classifier context to use. - Specifies the address of the variable in which to write the context identifier. - The returned value is the context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a classifier context, a dataset context, or a training context. - Specifies the identifier of the system on which to allocate the context. - Specifies the type of context to allocate. - Specifies which predefined CNN classifier context to use. - Specifies the address of the variable in which to write the context identifier. - The returned value is the context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a classification result buffer to hold training or prediction results. - Specifies the identifier of the system on which to allocate the result buffer. - Specifies the type of classification result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the classification result buffer identifier. - The returned value is the classification result buffer's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a classification result buffer to hold training or prediction results. - Specifies the identifier of the system on which to allocate the result buffer. - Specifies the type of classification result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the classification result buffer identifier. - The returned value is the classification result buffer's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a classifier context, a dataset context, class definitions, a training context, a training result buffer, or a prediction result buffer. - Specifies the identifier of a context or result buffer to control. - Specifies what to control. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control a classifier context, a dataset context, class definitions, a training context, a training result buffer, or a prediction result buffer. - Specifies the identifier of a context or result buffer to control. - Specifies what to control. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control a classifier context, a dataset context, class definitions, a training context, a training result buffer, or a prediction result buffer. - Specifies the identifier of a context or result buffer to control. - Specifies what to control. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control a classifier context, a dataset context, class definitions, a training context, a training result buffer, or a prediction result buffer. - Specifies the identifier of a context or result buffer to control. - Specifies what to control. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control an entry in a dataset context. - Specifies the dataset on which to control settings. - Specifies the entry to control, using the entry's index. - Specifies the entry to control, using the entry's unique key (UUID). - Specifies to control the entry, or to control the entry's region. - Specifies the type of control to set. - Specifies the value for the control. - Specifies the address of the variable which contains information for the type of control to set. - Specifies the number of elements in ControlValuePtr. - - - Control an entry in a dataset context. - Specifies the dataset on which to control settings. - Specifies the entry to control, using the entry's index. - Specifies the entry to control, using the entry's unique key (UUID). - Specifies to control the entry, or to control the entry's region. - Specifies the type of control to set. - Specifies the value for the control. - Specifies the address of the variable which contains information for the type of control to set. - Specifies the number of elements in ControlValuePtr. - - - Control an entry in a dataset context. - Specifies the dataset on which to control settings. - Specifies the entry to control, using the entry's index. - Specifies the entry to control, using the entry's unique key (UUID). - Specifies to control the entry, or to control the entry's region. - Specifies the type of control to set. - Specifies the value for the control. - Specifies the address of the variable which contains information for the type of control to set. - Specifies the number of elements in ControlValuePtr. - - - Control an entry in a dataset context. - Specifies the dataset on which to control settings. - Specifies the entry to control, using the entry's index. - Specifies the entry to control, using the entry's unique key (UUID). - Specifies to control the entry, or to control the entry's region. - Specifies the type of control to set. - Specifies the value for the control. - Specifies the address of the variable which contains information for the type of control to set. - Specifies the number of elements in ControlValuePtr. - - - Control an entry in a dataset context. - Specifies the dataset on which to control settings. - Specifies the entry to control, using the entry's index. - Specifies the entry to control, using the entry's unique key (UUID). - Specifies to control the entry, or to control the entry's region. - Specifies the type of control to set. - Specifies the value for the control. - Specifies the address of the variable which contains information for the type of control to set. - Specifies the number of elements in ControlValuePtr. - - - Copy data from one classification context to another. - Specifies the identifier of the source classification context from which to copy. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the identifier of the destination classification context in which to copy. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the type of copy operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy data from a classification result buffer to a classifier or dataset context. - Specifies the identifier of the source classification result buffer from which to copy. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the identifier of the destination classifier or dataset context in which to copy. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the type of copy operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Draw specific features of a predefined CNN classifier context, a dataset context, or a CNN prediction result buffer. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the identifier of the predefined CNN classifier context, dataset context, or CNN prediction result buffer from which to draw. - Specifies the identifier of the destination image buffer or LUT buffer in which to draw. - Specifies the drawing operation to perform. - Specifies what to use to perform the drawing operation. - Specifies how to control the drawing operation. - - - Export data from a dataset context or training result buffer to a file. - Specifies the name and path of the file in which to export. - Specifies the format of the file in which to export. - Specifies the identifier of the dataset context or a training result from which to export. - Specifies the trees (one or all) to export from a tree ensemble result buffer used for training. - Specifies the type of export operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a classifier context, a dataset context, a training context, a training result buffer, or a prediction result buffer. - Specifies the identifier of the classifier context, dataset context, training context, training result buffer, or prediction result buffer to free. - - - Get information about a hooked classification object event. - Specifies the classification object event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hooked classification object event. - Specifies the classification object event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hooked classification object event. - Specifies the classification object event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hooked classification object event. - Specifies the classification object event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hooked classification object event. - Specifies the classification object event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hooked classification object event. - Specifies the classification object event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hooked classification object event. - Specifies the classification object event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hooked classification object event. - Specifies the classification object event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hooked classification object event. - Specifies the classification object event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Hook a function to an event that occurs using classification objects. - Specifies the identifier of the classification object (classifier context or training context) onto which to attach a hook handler. - Specifies the event type. - Specifies the address of the function that should be called when an event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Import data from a CSV file to a dataset context. - Specifies the name and path of the file from which to import. - Specifies the format of the file from which to import. - Specifies the identifier of the dataset context in which to import. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the type of import operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Predict the class to which the target belongs. - Specifies the identifier of the trained classifier context to use for the prediction operation. - Specifies the identifier of the target to classify. - Specifies the identifier of the result buffer or dataset in which to write the results of the prediction operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Preprocess a classification context. - Specifies the identifier of the classification context to preprocess. - Specifies whether to preprocess the classification context. - - - Restore a classification context (classifier, training, or dataset) from disk. - Specifies the name and path of the file from which to restore the classification context (classifier, training, or dataset). - Specifies the identifier of the system on which to restore the classification context (classifier, training, or dataset) to disk. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the classification context identifier. - The returned value is the classification context identifier. If this fails, M_NULL is returned. - - - Save a MIL Classification context (classifier, training, or dataset) to a file. - Specifies the name and path of the file in which to save the classification context (that is, a classifier context, a training context, or a dataset context). - Specifies the identifier of the classification context to save (that is, a classifier context, a training context, or a dataset context). - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a MIL Classification context (classifier, training, or dataset) to a file. - Specifies the name and path of the file in which to save the classification context (that is, a classifier context, a training context, or a dataset context). - Specifies the identifier of the classification context to save (that is, a classifier context, a training context, or a dataset context). - Reserved for future expansion and must be set to M_DEFAULT . - - - Split the source dataset context into two destination dataset contexts. - Specifies the predefined split classification context. - Specifies the identifier of the source dataset context. - Specifies the identifier of the first destination dataset context. - Specifies the identifier of the second destination dataset context. - Specifies the percentage of entries in the source dataset context that should be in the first destination dataset context. - Reserved for future expansion and must be set to M_NULL . - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a MIL Classification context (classifier, training, or dataset) from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the classification context. - Specifies the operation to perform on the classification context. - Specifies the type of stream in which to store/from which to restore the classification context. - Specifies the MIL version of the classification context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the classification context (that is, a classifier context, a training context, or a dataset context). - Specifies the address of the variable in which to write the size of the classification context, in bytes. - - - Load, restore, or save a MIL Classification context (classifier, training, or dataset) from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the classification context. - Specifies the operation to perform on the classification context. - Specifies the type of stream in which to store/from which to restore the classification context. - Specifies the MIL version of the classification context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the classification context (that is, a classifier context, a training context, or a dataset context). - Specifies the address of the variable in which to write the size of the classification context, in bytes. - - - Load, restore, or save a MIL Classification context (classifier, training, or dataset) from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the classification context. - Specifies the operation to perform on the classification context. - Specifies the type of stream in which to store/from which to restore the classification context. - Specifies the MIL version of the classification context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the classification context (that is, a classifier context, a training context, or a dataset context). - Specifies the address of the variable in which to write the size of the classification context, in bytes. - - - Load, restore, or save a MIL Classification context (classifier, training, or dataset) from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the classification context. - Specifies the operation to perform on the classification context. - Specifies the type of stream in which to store/from which to restore the classification context. - Specifies the MIL version of the classification context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the classification context (that is, a classifier context, a training context, or a dataset context). - Specifies the address of the variable in which to write the size of the classification context, in bytes. - - - Load, restore, or save a MIL Classification context (classifier, training, or dataset) from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the classification context. - Specifies the operation to perform on the classification context. - Specifies the type of stream in which to store/from which to restore the classification context. - Specifies the MIL version of the classification context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the classification context (that is, a classifier context, a training context, or a dataset context). - Specifies the address of the variable in which to write the size of the classification context, in bytes. - - - Load, restore, or save a MIL Classification context (classifier, training, or dataset) from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the classification context. - Specifies the operation to perform on the classification context. - Specifies the type of stream in which to store/from which to restore the classification context. - Specifies the MIL version of the classification context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the classification context (that is, a classifier context, a training context, or a dataset context). - Specifies the address of the variable in which to write the size of the classification context, in bytes. - - - Train a classifier context. - Specifies the identifier of the training context with which to train the classifier context. - Specifies the identifier of the classifier context to train. - Specifies the identifier of the training dataset context with which to train the classifier context. This parameter cannot be null. - Specifies the identifier of the development dataset with which to evaluate the performance of the classifier context's training. - Specifies the identifier of the classification result buffer in which to write the results of the training operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate a code context. - Specifies the system on which to allocate the context. - Specifies the context type. - Specifies the initial configuration for the code context. - Specifies the address in which to return the identifier of the code context. - The returned value is the code context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a code context. - Specifies the system on which to allocate the context. - Specifies the context type. - Specifies the initial configuration for the code context. - Specifies the address in which to return the identifier of the code context. - The returned value is the code context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a code result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. This parameter must be set to one of the following: - Specifies the address of the variable in which to write the code result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a code result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. This parameter must be set to one of the following: - Specifies the address of the variable in which to write the code result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a code context, code model, or code result buffer setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting to change. - Specifies the setting's new value. - - - Control a code context, code model, or code result buffer setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting to change. - Specifies the setting's new value. - - - Detect 1D code occurrences in an image. - Specifies the identifier of an image buffer that contains the code occurrences to detect. The image buffer must be an 8-bit unsigned 1-band buffer. - Specifies the size of the array passed to CodeTypeArrayPtr. - Specifies the address of an array listing the possible code types to detect in the image. - Specifies the total number of code occurrences to detect in the image, regardless of their code type. - Specifies the timeout period, in msec. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the code detect result buffer in which to write the results. The result buffer must have been allocated using McodeAllocResult with M_CODE_DETECT_RESULT. - - - Detect 1D code occurrences in an image. - Specifies the identifier of an image buffer that contains the code occurrences to detect. The image buffer must be an 8-bit unsigned 1-band buffer. - Specifies the size of the array passed to CodeTypeArrayPtr. - Specifies the address of an array listing the possible code types to detect in the image. - Specifies the total number of code occurrences to detect in the image, regardless of their code type. - Specifies the timeout period, in msec. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the code detect result buffer in which to write the results. The result buffer must have been allocated using McodeAllocResult with M_CODE_DETECT_RESULT. - - - Detect 1D code occurrences in an image. - Specifies the identifier of an image buffer that contains the code occurrences to detect. The image buffer must be an 8-bit unsigned 1-band buffer. - Specifies the size of the array passed to CodeTypeArrayPtr. - Specifies the address of an array listing the possible code types to detect in the image. - Specifies the total number of code occurrences to detect in the image, regardless of their code type. - Specifies the timeout period, in msec. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the code detect result buffer in which to write the results. The result buffer must have been allocated using McodeAllocResult with M_CODE_DETECT_RESULT. - - - Draw specific features of results obtained from an McodeRead, McodeGrade, or McodeDetect operation. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the identifier of the code read, grade, or detect result buffer from which to extract features to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw specific features of results. - Specifies the type of drawing operation to perform. - Specifies the code occurrence for which to draw results. - Specifies the scan line(s) for which to draw results. - Specifies the function's control flag. Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Free a code context or a code result buffer. - Specifies the identifier of the code context or code result buffer to free. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Grade the code occurrence(s) in an image. - Specifies the identifier of the code context, allocated using McodeAlloc. - Specifies the identifier of the image buffer containing the code occurrence(s) to be graded. - Specifies a source code result buffer from which to retrieve McodeRead results. The result buffer must have previously been allocated using McodeAllocResult with M_DEFAULT. - Specifies the index of the code model (in the code context) or the result occurrence (in the source code result buffer) to use when grading. - Specifies the result buffer in which to write the resulting grading information. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Add, find, or delete a code model within a code context. - Specifies the code context in which to add, find, or delete the code model. - Specifies the operation to perform within the specified code context. - Specifies the code type of the code model to add or find from the code context. Note that if the Operation parameter is set to M_DELETE, set this parameter to M_NULL . - Specifies the instance of the code model to find in the context. Note that if the Operation parameter is set to M_ADD or M_DELETE, set this parameter to M_NULL . - Specifies the function's control flag. Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address in which to return the code model identifier for M_ADD and M_FIND operations. For a M_DELETE operation, ModelCodeIdPtr specifies the identifier of the model to be deleted. - The returned value is the identifier of the code model for a successful M_ADD operation; if the model could not be added, M_NULL is returned. The returned value is the identifier of the code model for a successful M_FIND operation; M_NULL is returned if no code model is found. The returned value is M_NULL for an M_DELETE operation. - - - Add, find, or delete a code model within a code context. - Specifies the code context in which to add, find, or delete the code model. - Specifies the operation to perform within the specified code context. - Specifies the code type of the code model to add or find from the code context. Note that if the Operation parameter is set to M_DELETE, set this parameter to M_NULL . - Specifies the instance of the code model to find in the context. Note that if the Operation parameter is set to M_ADD or M_DELETE, set this parameter to M_NULL . - Specifies the function's control flag. Reserved for future expansion. This parameter must be set to M_DEFAULT . - The returned value is the identifier of the code model for a successful M_ADD operation; if the model could not be added, M_NULL is returned. The returned value is the identifier of the code model for a successful M_FIND operation; M_NULL is returned if no code model is found. The returned value is M_NULL for an M_DELETE operation. - - - Add, find, or delete a code model within a code context. - Specifies the code context in which to add, find, or delete the code model. - Specifies the operation to perform within the specified code context. - Specifies the code type of the code model to add or find from the code context. Note that if the Operation parameter is set to M_DELETE, set this parameter to M_NULL . - Specifies the instance of the code model to find in the context. Note that if the Operation parameter is set to M_ADD or M_DELETE, set this parameter to M_NULL . - Specifies the function's control flag. Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address in which to return the code model identifier for M_ADD and M_FIND operations. For a M_DELETE operation, ModelCodeIdPtr specifies the identifier of the model to be deleted. - The returned value is the identifier of the code model for a successful M_ADD operation; if the model could not be added, M_NULL is returned. The returned value is the identifier of the code model for a successful M_FIND operation; M_NULL is returned if no code model is found. The returned value is M_NULL for an M_DELETE operation. - - - Read the code occurrence(s) in an image. - Specifies the identifier of the code context. - Specifies the 8-bit unsigned 1-band image buffer in which to search. - Specifies the result buffer in which to write the results of the read. - - - Restore a code context from disk. - Specifies the path and name of the file from which to restore the code context (for example, "C:\mydirectory\myfile"). - Specifies the system on which to allocate the context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to return the identifier of the code context. - The returned value is the code context identifier. If allocation fails, M_NULL is returned. - - - Restore a code context from disk. - Specifies the path and name of the file from which to restore the code context (for example, "C:\mydirectory\myfile"). - Specifies the system on which to allocate the context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to return the identifier of the code context. - The returned value is the code context identifier. If allocation fails, M_NULL is returned. - - - Save the specified code context in a file. - Specifies the name and path of the file in which to save the code context. - Specifies the identifier of the data buffer to save. - Specifies the function's control flag. - - - Save the specified code context in a file. - Specifies the name and path of the file in which to save the code context. - Specifies the identifier of the data buffer to save. - Specifies the function's control flag. - - - Load, restore, or save a code context from/to a file or a memory stream, or save a gradingreport to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the code context. - Specifies the operation to perform on the code context. - Specifies the type of stream in which to store/from which to restore the code context. - Specifies the MIL version of the code context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the code context. In the case of an M_SAVE_REPORT operation, this parameter specifies the address of the variable from which to read the identifier of the code result buffer. - Specifies the address of the variable in which to write the size of the code context, in bytes. - - - Load, restore, or save a code context from/to a file or a memory stream, or save a gradingreport to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the code context. - Specifies the operation to perform on the code context. - Specifies the type of stream in which to store/from which to restore the code context. - Specifies the MIL version of the code context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the code context. In the case of an M_SAVE_REPORT operation, this parameter specifies the address of the variable from which to read the identifier of the code result buffer. - Specifies the address of the variable in which to write the size of the code context, in bytes. - - - Load, restore, or save a code context from/to a file or a memory stream, or save a gradingreport to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the code context. - Specifies the operation to perform on the code context. - Specifies the type of stream in which to store/from which to restore the code context. - Specifies the MIL version of the code context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the code context. In the case of an M_SAVE_REPORT operation, this parameter specifies the address of the variable from which to read the identifier of the code result buffer. - Specifies the address of the variable in which to write the size of the code context, in bytes. - - - Load, restore, or save a code context from/to a file or a memory stream, or save a gradingreport to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the code context. - Specifies the operation to perform on the code context. - Specifies the type of stream in which to store/from which to restore the code context. - Specifies the MIL version of the code context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the code context. In the case of an M_SAVE_REPORT operation, this parameter specifies the address of the variable from which to read the identifier of the code result buffer. - Specifies the address of the variable in which to write the size of the code context, in bytes. - - - Load, restore, or save a code context from/to a file or a memory stream, or save a gradingreport to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the code context. - Specifies the operation to perform on the code context. - Specifies the type of stream in which to store/from which to restore the code context. - Specifies the MIL version of the code context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the code context. In the case of an M_SAVE_REPORT operation, this parameter specifies the address of the variable from which to read the identifier of the code result buffer. - Specifies the address of the variable in which to write the size of the code context, in bytes. - - - Load, restore, or save a code context from/to a file or a memory stream, or save a gradingreport to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the code context. - Specifies the operation to perform on the code context. - Specifies the type of stream in which to store/from which to restore the code context. - Specifies the MIL version of the code context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the code context. In the case of an M_SAVE_REPORT operation, this parameter specifies the address of the variable from which to read the identifier of the code result buffer. - Specifies the address of the variable in which to write the size of the code context, in bytes. - - - Train the control type settings of a code context and its code models so that they are optimized for the specified set of sample images. - Specifies the identifier of the code context to train. - Specifies the number of training images passed to ImageArrayPtr. - Specifies the address of the array containing the buffer identifiers of the training images. The image buffers must be 1-band, 8-bit unsigned buffers. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the train result buffer identifier. The result buffer must have been allocated using McodeAllocResult with M_CODE_TRAIN_RESULT. - - - Train the control type settings of a code context and its code models so that they are optimized for the specified set of sample images. - Specifies the identifier of the code context to train. - Specifies the number of training images passed to ImageArrayPtr. - Specifies the address of the array containing the buffer identifiers of the training images. The image buffers must be 1-band, 8-bit unsigned buffers. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the train result buffer identifier. The result buffer must have been allocated using McodeAllocResult with M_CODE_TRAIN_RESULT. - - - Encode an ASCII string into a symbol. - Specifies the identifier of the code model. - Specifies the 8-bit unsigned 1-band image buffer in which to write the symbol. - Specifies the address of the string to be encoded. - Specifies the function's control flag. - Specifies the identifier of the code write result buffer. The result buffer must have been allocated using McodeAllocResult with M_CODE_WRITE_RESULT. - - - Allocate a color matching context or a relative color calibration context. - Specifies the system on which to allocate the context. - Specifies the type of context. - Specifies the source color space of the context. In general, all color data required for the color operation should be the same as the source color space. For example, if you specify an M_RGB source color space, color-samples ( McolDefine) and target or source images ( McolMatch or McolTransform) should also typically be RGB. - Specifies the context's color space profile. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the context identifier. - The returned value is the context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a color matching context or a relative color calibration context. - Specifies the system on which to allocate the context. - Specifies the type of context. - Specifies the source color space of the context. In general, all color data required for the color operation should be the same as the source color space. For example, if you specify an M_RGB source color space, color-samples ( McolDefine) and target or source images ( McolMatch or McolTransform) should also typically be RGB. - Specifies the context's color space profile. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the context identifier. - The returned value is the context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a color matching result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the color matching result identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a color matching result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the color matching result identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a color matching context, its color-samples, or the color-samples of a relative color calibration context. - Specifies the identifier of the color matching or relative color calibration context. - Specifies what to control. - Specifies the setting to change. - Specifies the setting's new value. - - - Control a color matching context, its color-samples, or the color-samples of a relative color calibration context. - Specifies the identifier of the color matching or relative color calibration context. - Specifies what to control. - Specifies the setting to change. - Specifies the setting's new value. - - - Define or delete a color-sample or color element. - Specifies the identifier of the context in which to add or delete a color-sample. - Specifies the identifier of the source image buffer to use to define or add elements to a color-sample. If you are defining or adding elements to a color-sample from three explicit color component values, or if you are deleting color-samples or color elements, set this parameter to M_NULL . - Specifies a color-sample. - Specifies the type of the color-sample or color element. - Specifies an attribute of the color-sample or color element. - Specifies an attribute of the color-sample or color element. - Specifies an attribute of the color-sample or color element. - Specifies an attribute of the color-sample or color element. - - - Calculate the distance between colors. - Specifies the identifier of the first source image buffer. - Specifies the identifier of the second source buffer, which can be either an image or a MIL array buffer. - Specifies the identifier of the destination image buffer in which to write the results of the distance calculation. - Specifies the identifier of the image buffer used to identify the masked (non-zero) pixels. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the type of distance operation to perform. - Specifies the factor with which to normalize the resulting distances. - Reserved for future expansion and must be set to M_DEFAULT . - - - Draw specific features of a color-sample, color element, or color matching result. - Specifies the identifier of the 2D graphics context to use when drawing. Set this parameter to one of the following values: - Specifies the context or result buffer for which to perform the drawing operation. - Specifies the identifier of the destination image buffer in which to draw. - Specifies the type of drawing operation to perform. - Specifies the label of the target area for which to perform the drawing operation, for color matching contexts. - Specifies the color-sample or color element therein for which to perform the drawing operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a color matching context, a relative color calibration context, or a color matching result buffer. - Specifies the identifier of the context or result buffer to free. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Inquire information about a color matching or relative color calibration context, color-sample, color element, or a color matching result. - Specifies the identifier of the context or result buffer about which to inquire information. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a color matching or relative color calibration context, color-sample, color element, or a color matching result. - Specifies the identifier of the context or result buffer about which to inquire information. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a color matching or relative color calibration context, color-sample, color element, or a color matching result. - Specifies the identifier of the context or result buffer about which to inquire information. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a color matching or relative color calibration context, color-sample, color element, or a color matching result. - Specifies the identifier of the context or result buffer about which to inquire information. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a color matching or relative color calibration context, color-sample, color element, or a color matching result. - Specifies the identifier of the context or result buffer about which to inquire information. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a color matching or relative color calibration context, color-sample, color element, or a color matching result. - Specifies the identifier of the context or result buffer about which to inquire information. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a color matching or relative color calibration context, color-sample, color element, or a color matching result. - Specifies the identifier of the context or result buffer about which to inquire information. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a color matching or relative color calibration context, color-sample, color element, or a color matching result. - Specifies the identifier of the context or result buffer about which to inquire information. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a color matching or relative color calibration context, color-sample, color element, or a color matching result. - Specifies the identifier of the context or result buffer about which to inquire information. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Mask regions of a color element in a specified color-sample. - Specifies the context in which the color-sample containing the color element to be masked is located. - Specifies the color element for which to create a mask. - Specifies the identifier of the buffer to use to identify the masked (non-zero) pixels in the color element. - Specifies the type of mask to employ. - Reserved for future expansion and must be set to M_DEFAULT . - - - Match target areas with color-samples. - Specifies the identifier of the color matching context. - Specifies the identifier of the target image buffer with which to match the color-samples. - Specifies the identifier of the target image's reference color space. - Specifies the identifier of the image buffer containing the target area labels. - Specifies the identifier of the image buffer or result buffer in which to write the results of the color matching operation. - Specifies the results to produce. - - - Preprocess a relative color calibration or color matching context. - Specifies the identifier of the context to preprocess. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Perform a color projection. - Specifies the identifier of the source image buffer on which to perform the projection transformation. - Specifies the identifier of an image buffer or MIL array buffer that controls how the source pixels are interpreted. - Specifies the identifier of the destination buffer in which to write the color projection (transformation) results. - Specifies the identifier of the destination mask image. - Specifies the color projection operation. - Specifies the dynamic range on which the resulting projection is mapped. - Specifies the address of the variable in which to write the status of the color projection operation. - - - Perform a color projection. - Specifies the identifier of the source image buffer on which to perform the projection transformation. - Specifies the identifier of an image buffer or MIL array buffer that controls how the source pixels are interpreted. - Specifies the identifier of the destination buffer in which to write the color projection (transformation) results. - Specifies the identifier of the destination mask image. - Specifies the color projection operation. - Specifies the dynamic range on which the resulting projection is mapped. - Specifies the address of the variable in which to write the status of the color projection operation. - - - Restore a color matching or relative color calibration context from disk. - Specifies the name and path of the file from which to restore the context. - Specifies the system on which to restore the context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the context identifier. - The returned value is the context identifier. If allocation fails, M_NULL is returned. - - - Restore a color matching or relative color calibration context from disk. - Specifies the name and path of the file from which to restore the context. - Specifies the system on which to restore the context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the context identifier. - The returned value is the context identifier. If allocation fails, M_NULL is returned. - - - Save a color matching or relative color calibration context to a file. - Specifies the name and path of the file in which to save the context. - Specifies the identifier of the context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a color matching or relative color calibration context to a file. - Specifies the name and path of the file in which to save the context. - Specifies the identifier of the context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Set the color matching or relative color calibration strategy. - Specifies the identifier of the color matching or relative color calibration context. - Specifies the operation. - Specifies the type of distance (for color matching) or color calibration intent (for relative color calibration) that the operation uses. - Specifies the conversion mode (for color matching) or compute option (for relative color calibration) that the operation uses. - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a MIL color matching or relative color calibration context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the context. - Specifies the MIL version of the context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the context. - Specifies the address of the variable in which to write the size of the context, in bytes. - - - Load, restore, or save a MIL color matching or relative color calibration context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the context. - Specifies the MIL version of the context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the context. - Specifies the address of the variable in which to write the size of the context, in bytes. - - - Load, restore, or save a MIL color matching or relative color calibration context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the context. - Specifies the MIL version of the context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the context. - Specifies the address of the variable in which to write the size of the context, in bytes. - - - Load, restore, or save a MIL color matching or relative color calibration context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the context. - Specifies the MIL version of the context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the context. - Specifies the address of the variable in which to write the size of the context, in bytes. - - - Load, restore, or save a MIL color matching or relative color calibration context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the context. - Specifies the MIL version of the context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the context. - Specifies the address of the variable in which to write the size of the context, in bytes. - - - Load, restore, or save a MIL color matching or relative color calibration context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the context. - Specifies the MIL version of the context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the context. - Specifies the address of the variable in which to write the size of the context, in bytes. - - - Transform color data using relative color calibration. - Specifies the identifier of the relative color calibration context containing the color-sample and its associated mapping. - Specifies the index or label of a color-sample in the specified relative color calibration context. - Specifies the identifier of the source image with which to perform the relative color calibration. - Specifies the identifier of destination image in which to write the transformed color. - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate an Industrial Communication context. - Specifies the system on which to allocate the Industrial Communication context. - Specifies the type of protocol to use. - Specifies the description of the device with which to communicate. - Specifies how to initialize the Industrial Communication context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address in which to return the identifier of the Industrial Communication context. Since McomAlloc also returns the identifier, you can set this parameter to M_NULL . - The returned value is the Industrial Communication context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an Industrial Communication context. - Specifies the system on which to allocate the Industrial Communication context. - Specifies the type of protocol to use. - Specifies the description of the device with which to communicate. - Specifies how to initialize the Industrial Communication context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address in which to return the identifier of the Industrial Communication context. Since McomAlloc also returns the identifier, you can set this parameter to M_NULL . - The returned value is the Industrial Communication context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the Industrial Communication setting to control. - Specifies the setting's new value. - - - Control an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the Industrial Communication setting to control. - Specifies the setting's new value. - - - Control an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the Industrial Communication setting to control. - Specifies the setting's new value. - - - Free an Industrial Communication context. - Specifies the identifier of the Industrial Communication context. - - - Inquire about an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the setting about which to inquire. - Specifies the address of the variable in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the setting about which to inquire. - Specifies the address of the variable in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the setting about which to inquire. - Specifies the address of the variable in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the setting about which to inquire. - Specifies the address of the variable in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the setting about which to inquire. - Specifies the address of the variable in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the setting about which to inquire. - Specifies the address of the variable in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Read data from a device that uses the specified communication protocol. - Specifies the identifier of the Industrial Communication context that specifies the protocol of the device with which to communicate. - Specifies the location from which to read the data. This location is protocol specific. - Specifies the offset from which to start reading the data in the specified module/data table/assembly. - Specifies the amount of the data to read. - Specifies the address of the array in which to write the data. - - - Read data from a device that uses the specified communication protocol. - Specifies the identifier of the Industrial Communication context that specifies the protocol of the device with which to communicate. - Specifies the location from which to read the data. This location is protocol specific. - Specifies the offset from which to start reading the data in the specified module/data table/assembly. - Specifies the amount of the data to read. - Specifies the address of the array in which to write the data. - - - Sends a position to the robot. This does not move the robot, but simply sends a found position to the robot controller. - Specifies the identifier of the Industrial Communication context. - Specifies the operation code (opcode) of the command. - Specifies the status code to send to the robot controller. - Specifies the user identifier associated with the object at the specified position. - Specifies the X-position to the robot controller. - Specifies the Y-position to the robot controller. - Specifies the Z-position to the robot controller. - Specifies the rotation around the positional X-axis to the robot controller. - Specifies the rotation around the positional Y-axis to the robot controller. - Specifies the rotation around the positional Z-axis to the robot controller. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - - - Waits to receive a robot's request for a new position. - Specifies the identifier of the Industrial Communication context. - Specifies the address of the variable in which to write the operation code (opcode) received from the robot controller. - Specifies the address of the variable in which to write the status code received from the robot controller. - Specifies the address of the variable in which to write the user identifier associated with the object on which to perform the specified operation; the identifier is established and received from the robot-side software. - Specifies the address of the variable in which to write the current X-position of the robot. - Specifies the address of the variable in which to write the current Y-position of the robot. - Specifies the address of the variable in which to write the current Z-position of the robot. - Specifies the address of the variable in which to write the rotation around the positional X-axis of the robot. - Specifies the address of the variable in which to write the rotation around the positional Y-axis of the robot. - Specifies the address of the variable in which to write the rotation around the positional Z-axis of the robot. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - - - Write data to a device that uses the specified communication protocol. - Specifies the identifier of the Industrial Communication context that specifies the protocol of the device with which to communicate. - Specifies the location in which to write the data. This location is protocol specific. - Specifies the offset from which to start writing the data in the specified module/data table/assembly. - Specifies the size of the data to be written, in bytes. - Specifies the address of the array containing the data. - - - Write data to a device that uses the specified communication protocol. - Specifies the identifier of the Industrial Communication context that specifies the protocol of the device with which to communicate. - Specifies the location in which to write the data. This location is protocol specific. - Specifies the offset from which to start writing the data in the specified module/data table/assembly. - Specifies the size of the data to be written, in bytes. - Specifies the address of the array containing the data. - - - Allocate a digitizer. - Specifies the identifier of the system on which to allocate the digitizer. - Specifies the number or string to identify the device to allocate for the digitizer. - Specifies the name of the digitizer configuration format (DCF) appropriate for your camera. - Specifies the type of initialization to perform on the digitizer. - Specifies the address of the variable in which to write the digitizer identifier. - The returned value is the digitizer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a digitizer. - Specifies the identifier of the system on which to allocate the digitizer. - Specifies the number or string to identify the device to allocate for the digitizer. - Specifies the name of the digitizer configuration format (DCF) appropriate for your camera. - Specifies the type of initialization to perform on the digitizer. - Specifies the address of the variable in which to write the digitizer identifier. - The returned value is the digitizer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a digitizer. - Specifies the identifier of the system on which to allocate the digitizer. - Specifies the number or string to identify the device to allocate for the digitizer. - Specifies the name of the digitizer configuration format (DCF) appropriate for your camera. - Specifies the type of initialization to perform on the digitizer. - Specifies the address of the variable in which to write the digitizer identifier. - The returned value is the digitizer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a digitizer. - Specifies the identifier of the system on which to allocate the digitizer. - Specifies the number or string to identify the device to allocate for the digitizer. - Specifies the name of the digitizer configuration format (DCF) appropriate for your camera. - Specifies the type of initialization to perform on the digitizer. - Specifies the address of the variable in which to write the digitizer identifier. - The returned value is the digitizer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to control. - Specifies the value to assign to the digitizer setting. - - - Control a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to control. - Specifies the value to assign to the digitizer setting. - - - Control a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to control. - Specifies the value to assign to the digitizer setting. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Adjust a camera's lens motor to a position that produces optimum focus, or only calculate the focus quality of a specified image or an image grabbed at the current lens motor position. - Specifies the identifier of the digitizer. - Specifies the identifier of the buffer that contains the image to analyze or in which to grab. - Specifies the identifier of a child buffer of the destination buffer. - Specifies the address of the user-defined function to call before each grab. - Specifies the address of the data that you want to make available to the user-defined function. When only calculating the focus indicator (that is, using the M_EVALUATE operation mode), this parameter is not used, and must be set to M_NULL. - Specifies the minimum focus position of the search. - Specifies the starting focus position of the search. - Specifies the maximum focus position of the search. - Specifies the positional increment to use in the search. - Specifies the operation mode used by this function. - Specifies the address in which to return the resulting value from the focusing operation. - - - Adjust a camera's lens motor to a position that produces optimum focus, or only calculate the focus quality of a specified image or an image grabbed at the current lens motor position. - Specifies the identifier of the digitizer. - Specifies the identifier of the buffer that contains the image to analyze or in which to grab. - Specifies the identifier of a child buffer of the destination buffer. - Specifies the address of the user-defined function to call before each grab. - Specifies the address of the data that you want to make available to the user-defined function. When only calculating the focus indicator (that is, using the M_EVALUATE operation mode), this parameter is not used, and must be set to M_NULL. - Specifies the minimum focus position of the search. - Specifies the starting focus position of the search. - Specifies the maximum focus position of the search. - Specifies the positional increment to use in the search. - Specifies the operation mode used by this function. - Specifies the address in which to return the resulting value from the focusing operation. - - - Free a digitizer. - Specifies the identifier of the digitizer. - - - Get information about a digitizer hook event. - Specifies the digitizer event identifier received by the hook-handler function (see MdigProcess and MdigHookFunction). - Specifies the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a digitizer hook event. - Specifies the digitizer event identifier received by the hook-handler function (see MdigProcess and MdigHookFunction). - Specifies the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a digitizer hook event. - Specifies the digitizer event identifier received by the hook-handler function (see MdigProcess and MdigHookFunction). - Specifies the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a digitizer hook event. - Specifies the digitizer event identifier received by the hook-handler function (see MdigProcess and MdigHookFunction). - Specifies the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a digitizer hook event. - Specifies the digitizer event identifier received by the hook-handler function (see MdigProcess and MdigHookFunction). - Specifies the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Grab data from a camera into a buffer or container. - Specifies the identifier of the digitizer. - Specifies the identifier of the destination image buffer or container. - - - Grab data continuously from a camera. - Specifies the identifier of the digitizer. - Specifies the identifier of the destination image buffer or container. - - - Wait for the end of the grab in progress. - Specifies the identifier of the digitizer. - Specifies the function's control flag. - - - Halt a continuous grab from an input device. - Specifies the identifier of the digitizer. - - - Hook a function to a digitizer event. - Specifies the identifier of the digitizer. - Specifies the digitizer event to which to hook the function. - Specifies the address of the function that should be called when the specified event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Inquire about a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquires a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to inquire. - Specifies the data type of the variable in which to return the requested information (pointed to by the UserVarPtr parameter). - Specifies the name of the camera feature to inquire. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to return the requested information. - - - Inquires a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to inquire. - Specifies the data type of the variable in which to return the requested information (pointed to by the UserVarPtr parameter). - Specifies the name of the camera feature to inquire. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to return the requested information. - - - Inquires a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to inquire. - Specifies the data type of the variable in which to return the requested information (pointed to by the UserVarPtr parameter). - Specifies the name of the camera feature to inquire. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to return the requested information. - - - Inquires a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to inquire. - Specifies the data type of the variable in which to return the requested information (pointed to by the UserVarPtr parameter). - Specifies the name of the camera feature to inquire. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to return the requested information. - - - Inquires a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to inquire. - Specifies the data type of the variable in which to return the requested information (pointed to by the UserVarPtr parameter). - Specifies the name of the camera feature to inquire. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to return the requested information. - - - Inquires a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to inquire. - Specifies the data type of the variable in which to return the requested information (pointed to by the UserVarPtr parameter). - Specifies the name of the camera feature to inquire. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to return the requested information. - - - Grab frames of data sequentially into a list of image buffers or containers, and process them with a user-defined function as they are grabbed. - Specifies the identifier of the digitizer to be used to perform the grabs. - Specifies the address of the array containing the identifiers of the image buffers or containers in which to place the grabbed frames of data. Image buffers should be of an appropriate type and depth to hold the grabbed frames of data. - Specifies the number of buffers or containers in the array. - Specifies the type of operation to perform. - Specifies more information about the synchronization and triggering of the grab. - Specifies the address of the function that is called when a buffer/container is modified in the array of destination image buffers/containers. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Grab frames of data sequentially into a list of image buffers or containers, and process them with a user-defined function as they are grabbed. - Specifies the identifier of the digitizer to be used to perform the grabs. - Specifies the address of the array containing the identifiers of the image buffers or containers in which to place the grabbed frames of data. Image buffers should be of an appropriate type and depth to hold the grabbed frames of data. - Specifies the number of buffers or containers in the array. - Specifies the type of operation to perform. - Specifies more information about the synchronization and triggering of the grab. - Specifies the address of the function that is called when a buffer/container is modified in the array of destination image buffers/containers. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Allocate a display. - Specifies the system on which to allocate the display. - Specifies the device to use for image display. - Specifies the format of the display. - Specifies your display's type. - Specifies the address of the variable in which to write the display identifier. - The returned value is the display identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a display. - Specifies the system on which to allocate the display. - Specifies the device to use for image display. - Specifies the format of the display. - Specifies your display's type. - Specifies the address of the variable in which to write the display identifier. - The returned value is the display identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a MIL display setting. - Specifies the identifier of the target display. - Specifies the type of display setting to control. - Specifies the new value to assign to the display setting specified by the ControlType parameter. - - - Control a MIL display setting. - Specifies the identifier of the target display. - Specifies the type of display setting to control. - Specifies the new value to assign to the display setting specified by the ControlType parameter. - - - Control a MIL display setting. - Specifies the identifier of the target display. - Specifies the type of display setting to control. - Specifies the new value to assign to the display setting specified by the ControlType parameter. - - - Free a display. - Specifies the identifier of the display. - - - Get information about a display hook event. - Specifies the display event identifier received by the hook-handler function (see MdispHookFunction). - Specifies the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a display hook event. - Specifies the display event identifier received by the hook-handler function (see MdispHookFunction). - Specifies the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a display hook event. - Specifies the display event identifier received by the hook-handler function (see MdispHookFunction). - Specifies the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Hook a function to a display event. - Specifies the identifier of the target display. - Specifies the display event type. - Specifies the address of the function that should be called when the specified event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Inquire about a display setting. - Specifies the identifier of the display. - Specifies the type of display setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a display setting. - Specifies the identifier of the display. - Specifies the type of display setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a display setting. - Specifies the identifier of the display. - Specifies the type of display setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a display setting. - Specifies the identifier of the display. - Specifies the type of display setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a display setting. - Specifies the identifier of the display. - Specifies the type of display setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a display setting. - Specifies the identifier of the display. - Specifies the type of display setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a display setting. - Specifies the identifier of the display. - Specifies the type of display setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Associate a LUT buffer with a display. - Specifies the identifier of the display with which to associate the LUT buffer. - Specifies a LUT buffer. - - - Pan (scroll) a display. - Specifies the identifier of the display. - Specifies the number of image pixels by which to pan an image buffer horizontally when it is displayed. - Specifies the number of image pixels by which to pan an image buffer vertically when it is displayed. - - - Select an image buffer to display. - Specifies the identifier of the display. - Specifies the identifier of the image buffer to display. - - - Select an image buffer to display in a user-defined window. - Specifies the identifier of the display. - Specifies the image buffer to display. - Specifies the window handle of the user-defined window or child window. - - - Zoom a display. - Specifies the identifier of the display. - Specifies the zoom factor for the X-direction of the display. - Specifies the zoom factor for the Y-direction of the display. - - - Allocate a SureDotOCR context. - Specifies the identifier of the system on which to allocate the SureDotOCR context. - Specifies the type of context to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the SureDotOCR context identifier. - The returned value is the SureDotOCR context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a SureDotOCR context. - Specifies the identifier of the system on which to allocate the SureDotOCR context. - Specifies the type of context to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the SureDotOCR context identifier. - The returned value is the SureDotOCR context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a SureDotOCR result buffer. - Specifies the identifier of the system on which to allocate the SureDotOCR result buffer. - Specifies the type of result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the SureDotOCR result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a SureDotOCR result buffer. - Specifies the identifier of the system on which to allocate the SureDotOCR result buffer. - Specifies the type of result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the SureDotOCR result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a SureDotOCR context or result buffer. - Specifies the identifier of the SureDotOCR context or result buffer to control. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control a SureDotOCR context or result buffer. - Specifies the identifier of the SureDotOCR context or result buffer to control. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a SureDotOCR string model, or control a position (constraint) in a string model. - Specifies the identifier of the SureDotOCR context that contains the string model to control. - Specifies the string model (one or all) to control. - Specifies how to control the string model. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the second required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a SureDotOCR string model, or control a position (constraint) in a string model. - Specifies the identifier of the SureDotOCR context that contains the string model to control. - Specifies the string model (one or all) to control. - Specifies how to control the string model. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the second required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a SureDotOCR string model, or control a position (constraint) in a string model. - Specifies the identifier of the SureDotOCR context that contains the string model to control. - Specifies the string model (one or all) to control. - Specifies how to control the string model. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the second required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a SureDotOCR string model, or control a position (constraint) in a string model. - Specifies the identifier of the SureDotOCR context that contains the string model to control. - Specifies the string model (one or all) to control. - Specifies how to control the string model. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the second required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Draw specific features of a SureDotOCR result buffer. - Specifies the identifier of the 2D graphics context to use when drawing. Set this parameter to one of the values below. - Specifies the identifier of the SureDotOCR result buffer from which to extract the features to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the drawing operation to perform. - Specifies the string result (one or all) for which to perform the drawing operation. - Specifies the character (one or all) in the string result for which to perform the drawing operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Export a font from a SureDotOCR context. - Specifies the name and path of the SureDotOCR font file in which to export the font. - Specifies the format of the file in which to export the font. - Specifies the identifier of the SureDotOCR context from which to export the font. - Specifies the label or index of the font to export from the SureDotOCR context. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a SureDotOCR context or a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR context or SureDotOCR result buffer to free. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Import characters from a font file into a new or existing font of a SureDotOCR context. - Specifies the name and path of the SureDotOCR font file (MDMRF) from which to import the font. - Specifies the format of the file from which to import the font. - Specifies the identifier of the SureDotOCR context to which you are importing the characters. - Specifies the label or index of an already existing font, or the addition of a new font. - Specifies the characters to import from the SureDotOCR font file. - Specifies how to handle importing characters that have the same name as characters already in the font. - - - Import characters from a font file into a new or existing font of a SureDotOCR context. - Specifies the name and path of the SureDotOCR font file (MDMRF) from which to import the font. - Specifies the format of the file from which to import the font. - Specifies the identifier of the SureDotOCR context to which you are importing the characters. - Specifies the label or index of an already existing font, or the addition of a new font. - Specifies the characters to import from the SureDotOCR font file. - Specifies how to handle importing characters that have the same name as characters already in the font. - - - Inquire about a SureDotOCR context or result buffer setting. - Specifies the identifier of the SureDotOCR context or result buffer about which to inquire. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a SureDotOCR context or result buffer setting. - Specifies the identifier of the SureDotOCR context or result buffer about which to inquire. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a SureDotOCR context or result buffer setting. - Specifies the identifier of the SureDotOCR context or result buffer about which to inquire. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a SureDotOCR context or result buffer setting. - Specifies the identifier of the SureDotOCR context or result buffer about which to inquire. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a SureDotOCR context or result buffer setting. - Specifies the identifier of the SureDotOCR context or result buffer about which to inquire. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a SureDotOCR context or result buffer setting. - Specifies the identifier of the SureDotOCR context or result buffer about which to inquire. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a SureDotOCR string model, or inquire about a position (constraint) in a string model. - Specifies the identifier of the SureDotOCR context that contains the string model about which to inquire. - Specifies the string model about which to inquire. - Specifies how to inquire about the string model. - Specifies the permitted character about which to inquire. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a SureDotOCR string model, or inquire about a position (constraint) in a string model. - Specifies the identifier of the SureDotOCR context that contains the string model about which to inquire. - Specifies the string model about which to inquire. - Specifies how to inquire about the string model. - Specifies the permitted character about which to inquire. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a SureDotOCR string model, or inquire about a position (constraint) in a string model. - Specifies the identifier of the SureDotOCR context that contains the string model about which to inquire. - Specifies the string model about which to inquire. - Specifies how to inquire about the string model. - Specifies the permitted character about which to inquire. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a SureDotOCR string model, or inquire about a position (constraint) in a string model. - Specifies the identifier of the SureDotOCR context that contains the string model about which to inquire. - Specifies the string model about which to inquire. - Specifies how to inquire about the string model. - Specifies the permitted character about which to inquire. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Perform name operations for fonts and string models. - Specifies the identifier of the SureDotOCR context containing the font or string model with which to perform the name operation. - Specifies the name operation to perform. - Specifies the label or index value of the font or string model with which to perform the name operation. - Specifies the name. - Specifies the address at which to write the information requested by the name operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform name operations for fonts and string models. - Specifies the identifier of the SureDotOCR context containing the font or string model with which to perform the name operation. - Specifies the name operation to perform. - Specifies the label or index value of the font or string model with which to perform the name operation. - Specifies the name. - Specifies the address at which to write the information requested by the name operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform name operations for fonts and string models. - Specifies the identifier of the SureDotOCR context containing the font or string model with which to perform the name operation. - Specifies the name operation to perform. - Specifies the label or index value of the font or string model with which to perform the name operation. - Specifies the name. - Specifies the address at which to write the information requested by the name operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform name operations for fonts and string models. - Specifies the identifier of the SureDotOCR context containing the font or string model with which to perform the name operation. - Specifies the name operation to perform. - Specifies the label or index value of the font or string model with which to perform the name operation. - Specifies the name. - Specifies the address at which to write the information requested by the name operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Preprocess a SureDotOCR context. - Specifies the identifier of the SureDotOCR context to preprocess. - Specifies whether to preprocess the SureDotOCR context. - - - Read dot-matrix strings from a target image. - Specifies the identifier of the SureDotOCR context to use for the read operation. - Specifies the identifier of the target image buffer which contains the dot-matrix strings to read. - Specifies the identifier of the SureDotOCR result buffer in which to write the results of the read operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Restore a SureDotOCR context from disk. - Specifies the name and path of the file from which to restore the SureDotOCR context. - Specifies the identifier of the system on which to restore the SureDotOCR context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the SureDotOCR context identifier. - The returned value is the SureDotOCR context identifier. If this fails, M_NULL is returned. - - - Save a SureDotOCR context to a file. - Specifies the name and path of the file in which to save the SureDotOCR context. - Specifies the identifier of the SureDotOCR context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a SureDotOCR context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the SureDotOCR context. - Specifies the operation to perform on the SureDotOCR context. - Specifies the type of stream in which to store/from which to restore the SureDotOCR context. - Specifies the MIL version of the SureDotOCR context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the SureDotOCR context. - Specifies the address of the variable in which to write the size of the SureDotOCR context, in bytes. - - - Load, restore, or save a SureDotOCR context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the SureDotOCR context. - Specifies the operation to perform on the SureDotOCR context. - Specifies the type of stream in which to store/from which to restore the SureDotOCR context. - Specifies the MIL version of the SureDotOCR context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the SureDotOCR context. - Specifies the address of the variable in which to write the size of the SureDotOCR context, in bytes. - - - Load, restore, or save a SureDotOCR context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the SureDotOCR context. - Specifies the operation to perform on the SureDotOCR context. - Specifies the type of stream in which to store/from which to restore the SureDotOCR context. - Specifies the MIL version of the SureDotOCR context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the SureDotOCR context. - Specifies the address of the variable in which to write the size of the SureDotOCR context, in bytes. - - - Load, restore, or save a SureDotOCR context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the SureDotOCR context. - Specifies the operation to perform on the SureDotOCR context. - Specifies the type of stream in which to store/from which to restore the SureDotOCR context. - Specifies the MIL version of the SureDotOCR context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the SureDotOCR context. - Specifies the address of the variable in which to write the size of the SureDotOCR context, in bytes. - - - Load, restore, or save a SureDotOCR context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the SureDotOCR context. - Specifies the operation to perform on the SureDotOCR context. - Specifies the type of stream in which to store/from which to restore the SureDotOCR context. - Specifies the MIL version of the SureDotOCR context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the SureDotOCR context. - Specifies the address of the variable in which to write the size of the SureDotOCR context, in bytes. - - - Load, restore, or save a SureDotOCR context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the SureDotOCR context. - Specifies the operation to perform on the SureDotOCR context. - Specifies the type of stream in which to store/from which to restore the SureDotOCR context. - Specifies the MIL version of the SureDotOCR context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the SureDotOCR context. - Specifies the address of the variable in which to write the size of the SureDotOCR context, in bytes. - - - Allocate an Edge Finder context. - Specifies the system on which to allocate the Edge Finder context. - Specifies the type of Edge Finder context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Edge Finder context identifier. - The returned value is the Edge Finder context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an Edge Finder context. - Specifies the system on which to allocate the Edge Finder context. - Specifies the type of Edge Finder context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Edge Finder context identifier. - The returned value is the Edge Finder context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an Edge Finder result buffer. - Specifies the system on which to allocate the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Edge Finder result buffer identifier. - The returned value is the result identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an Edge Finder result buffer. - Specifies the system on which to allocate the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Edge Finder result buffer identifier. - The returned value is the result identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Perform edge extraction and feature calculations. - Specifies the Edge Finder context to use for the extraction. - Specifies the source image buffer from which to extract edges. - Specifies the X-source derivative image buffer used to extract edges. - Specifies the Y-source derivative image buffer used to extract edges. - Specifies the source cross-derivative image buffer used to extract edges. - Specifies the Edge Finder result buffer in which to write the results of the extraction. - Specifies whether optimal performance during Edge Finder calculations is ensured. - - - Control an Edge Finder context or an Edge Finder result buffer setting. - Specifies either the Edge Finder context or the Edge Finder result buffer whose settings you want to modify. - Specifies the setting to change. - Specifies the setting's new value. - - - Control an Edge Finder context or an Edge Finder result buffer setting. - Specifies either the Edge Finder context or the Edge Finder result buffer whose settings you want to modify. - Specifies the setting to change. - Specifies the setting's new value. - - - Draw specific edge results in the destination image buffer or 2D graphics list. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the identifier of the Edge Finder result buffer from which to extract the results to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Specifies the edge(s) to draw. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free an Edge Finder context or an Edge Finder result buffer. - Specifies the identifier of the Edge Finder context or Edge Finder result buffer to free. - - - Get edgels from an Edge Finder result buffer that are the closest neighbors to a list of user-specified point coordinates. - Specifies the identifier of the Edge Finder result buffer from which to search for edgel candidates. - Specifies the number of points provided. - Specifies the address of the array containing the X-coordinate(s) of the source point(s). - Specifies the address of the array containing the Y-coordinate(s) of the source point(s). - Specifies the address of the array containing the constraint angle(s) used to refine the search for edgel candidates. - Specifies the address of the array in which the X-coordinate(s) of the edgel(s) found in the Edge Finder result buffer are to be written. - Specifies the address of the array in which the Y-coordinate(s) of the edgel(s) found in the Edge Finder result buffer is to be written. - Specifies the address of the array in which the index of the edgel(s) found in the Edge Finder result buffer is to be written. - Specifies the address of the array in which the label of the edgel's edge found in the Edge Finder result buffer is to be written. - Specifies the accuracy with which to return edgels. - - - Get edgels from an Edge Finder result buffer that are the closest neighbors to a list of user-specified point coordinates. - Specifies the identifier of the Edge Finder result buffer from which to search for edgel candidates. - Specifies the number of points provided. - Specifies the address of the array containing the X-coordinate(s) of the source point(s). - Specifies the address of the array containing the Y-coordinate(s) of the source point(s). - Specifies the address of the array containing the constraint angle(s) used to refine the search for edgel candidates. - Specifies the address of the array in which the X-coordinate(s) of the edgel(s) found in the Edge Finder result buffer are to be written. - Specifies the address of the array in which the Y-coordinate(s) of the edgel(s) found in the Edge Finder result buffer is to be written. - Specifies the address of the array in which the index of the edgel(s) found in the Edge Finder result buffer is to be written. - Specifies the address of the array in which the label of the edgel's edge found in the Edge Finder result buffer is to be written. - Specifies the accuracy with which to return edgels. - - - Get edgels from an Edge Finder result buffer that are the closest neighbors to a list of user-specified point coordinates. - Specifies the identifier of the Edge Finder result buffer from which to search for edgel candidates. - Specifies the number of points provided. - Specifies the address of the array containing the X-coordinate(s) of the source point(s). - Specifies the address of the array containing the Y-coordinate(s) of the source point(s). - Specifies the address of the array containing the constraint angle(s) used to refine the search for edgel candidates. - Specifies the address of the array in which the X-coordinate(s) of the edgel(s) found in the Edge Finder result buffer are to be written. - Specifies the address of the array in which the Y-coordinate(s) of the edgel(s) found in the Edge Finder result buffer is to be written. - Specifies the address of the array in which the index of the edgel(s) found in the Edge Finder result buffer is to be written. - Specifies the address of the array in which the label of the edgel's edge found in the Edge Finder result buffer is to be written. - Specifies the accuracy with which to return edgels. - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Inquire about an Edge Finder context or an Edge Finder result buffer. - Specifies either the Edge Finder context or the Edge Finder result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Edge Finder context or an Edge Finder result buffer. - Specifies either the Edge Finder context or the Edge Finder result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Edge Finder context or an Edge Finder result buffer. - Specifies either the Edge Finder context or the Edge Finder result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Edge Finder context or an Edge Finder result buffer. - Specifies either the Edge Finder context or the Edge Finder result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Edge Finder context or an Edge Finder result buffer. - Specifies either the Edge Finder context or the Edge Finder result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Edge Finder context or an Edge Finder result buffer. - Specifies either the Edge Finder context or the Edge Finder result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Edge Finder context or an Edge Finder result buffer. - Specifies either the Edge Finder context or the Edge Finder result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Mask regions of the Edge Finder context. - Specifies the Edge Finder context in which to set the mask. - Specifies the identifier of the image buffer used to identify the masked pixels in the Edge Finder context. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edge chains from user-supplied arrays into an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer in which to put user-supplied data. - Specifies the number of edgels to add to the Edge Finder result buffer. - Specifies the address of the array containing the indices of the edgels' edges to add to the Edge Finder result buffer. - Specifies the address of the array containing the X-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the Y-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the orientation of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the magnitude of the edgel(s) to add to the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edge chains from user-supplied arrays into an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer in which to put user-supplied data. - Specifies the number of edgels to add to the Edge Finder result buffer. - Specifies the address of the array containing the indices of the edgels' edges to add to the Edge Finder result buffer. - Specifies the address of the array containing the X-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the Y-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the orientation of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the magnitude of the edgel(s) to add to the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edge chains from user-supplied arrays into an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer in which to put user-supplied data. - Specifies the number of edgels to add to the Edge Finder result buffer. - Specifies the address of the array containing the indices of the edgels' edges to add to the Edge Finder result buffer. - Specifies the address of the array containing the X-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the Y-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the orientation of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the magnitude of the edgel(s) to add to the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edge chains from user-supplied arrays into an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer in which to put user-supplied data. - Specifies the number of edgels to add to the Edge Finder result buffer. - Specifies the address of the array containing the indices of the edgels' edges to add to the Edge Finder result buffer. - Specifies the address of the array containing the X-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the Y-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the orientation of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the magnitude of the edgel(s) to add to the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edge chains from user-supplied arrays into an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer in which to put user-supplied data. - Specifies the number of edgels to add to the Edge Finder result buffer. - Specifies the address of the array containing the indices of the edgels' edges to add to the Edge Finder result buffer. - Specifies the address of the array containing the X-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the Y-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the orientation of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the magnitude of the edgel(s) to add to the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edge chains from user-supplied arrays into an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer in which to put user-supplied data. - Specifies the number of edgels to add to the Edge Finder result buffer. - Specifies the address of the array containing the indices of the edgels' edges to add to the Edge Finder result buffer. - Specifies the address of the array containing the X-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the Y-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the orientation of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the magnitude of the edgel(s) to add to the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edge chains from user-supplied arrays into an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer in which to put user-supplied data. - Specifies the number of edgels to add to the Edge Finder result buffer. - Specifies the address of the array containing the indices of the edgels' edges to add to the Edge Finder result buffer. - Specifies the address of the array containing the X-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the Y-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the orientation of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the magnitude of the edgel(s) to add to the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edge chains from user-supplied arrays into an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer in which to put user-supplied data. - Specifies the number of edgels to add to the Edge Finder result buffer. - Specifies the address of the array containing the indices of the edgels' edges to add to the Edge Finder result buffer. - Specifies the address of the array containing the X-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the Y-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the orientation of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the magnitude of the edgel(s) to add to the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Restore an Edge Finder context from disk. - Specifies the name and path of the file from which to restore the Edge Finder context. - Specifies the system on which to restore the Edge Finder context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Edge Finder context identifier. - The returned value is the Edge Finder context identifier. If allocation fails, M_NULL is returned. - - - Restore an Edge Finder context from disk. - Specifies the name and path of the file from which to restore the Edge Finder context. - Specifies the system on which to restore the Edge Finder context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Edge Finder context identifier. - The returned value is the Edge Finder context identifier. If allocation fails, M_NULL is returned. - - - Save an Edge Finder context to a file, or save edge chains and/or edge approximations from an Edge Finder result buffer to a CAD (Computer-Aided Design) file. - Specifies the name and path of the file in which to save the Edge Finder context, or the destination CAD file. - Specifies either the identifier of the Edge Finder context to save, or the identifier of the Edge Finder result buffer from which to save to a CAD file. - Specifies whether to save edge chains or edge approximations to the DXF CAD file for Edge Finder result buffers. - - - Save an Edge Finder context to a file, or save edge chains and/or edge approximations from an Edge Finder result buffer to a CAD (Computer-Aided Design) file. - Specifies the name and path of the file in which to save the Edge Finder context, or the destination CAD file. - Specifies either the identifier of the Edge Finder context to save, or the identifier of the Edge Finder result buffer from which to save to a CAD file. - Specifies whether to save edge chains or edge approximations to the DXF CAD file for Edge Finder result buffers. - - - Select edges for calculations and result retrieval. - Specifies the identifier of the Edge Finder result buffer to be used in the edge selection process. - Specifies the operation to perform on the specified edges. - Specifies on what the selection criterion will be based. - Specifies the condition for the edge selection. - Specifies a value that is dependent on the feature and condition chosen. - Specifies a value that is dependent on the feature and condition chosen. - - - Load, restore, or save an Edge Finder context from/to a file or memory stream, or save calculated edges from an Edge Finder result buffer to a file or memory stream in CAD DXF format. - Specifies the file or memory stream. - Specifies the system on which to restore the Edge Finder context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the Edge Finder context or calculated edges. - Specifies the MIL version of the Edge Finder context. - Specifies the function's control flag. - Specifies the address of the variable in which to write or from which to read the identifier of the Edge Finder context or the Edge Finder result buffer. - Specifies the address of the variable in which to write the size of the Edge Finder context or calculated edges, in bytes. - - - Load, restore, or save an Edge Finder context from/to a file or memory stream, or save calculated edges from an Edge Finder result buffer to a file or memory stream in CAD DXF format. - Specifies the file or memory stream. - Specifies the system on which to restore the Edge Finder context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the Edge Finder context or calculated edges. - Specifies the MIL version of the Edge Finder context. - Specifies the function's control flag. - Specifies the address of the variable in which to write or from which to read the identifier of the Edge Finder context or the Edge Finder result buffer. - Specifies the address of the variable in which to write the size of the Edge Finder context or calculated edges, in bytes. - - - Load, restore, or save an Edge Finder context from/to a file or memory stream, or save calculated edges from an Edge Finder result buffer to a file or memory stream in CAD DXF format. - Specifies the file or memory stream. - Specifies the system on which to restore the Edge Finder context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the Edge Finder context or calculated edges. - Specifies the MIL version of the Edge Finder context. - Specifies the function's control flag. - Specifies the address of the variable in which to write or from which to read the identifier of the Edge Finder context or the Edge Finder result buffer. - Specifies the address of the variable in which to write the size of the Edge Finder context or calculated edges, in bytes. - - - Load, restore, or save an Edge Finder context from/to a file or memory stream, or save calculated edges from an Edge Finder result buffer to a file or memory stream in CAD DXF format. - Specifies the file or memory stream. - Specifies the system on which to restore the Edge Finder context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the Edge Finder context or calculated edges. - Specifies the MIL version of the Edge Finder context. - Specifies the function's control flag. - Specifies the address of the variable in which to write or from which to read the identifier of the Edge Finder context or the Edge Finder result buffer. - Specifies the address of the variable in which to write the size of the Edge Finder context or calculated edges, in bytes. - - - Load, restore, or save an Edge Finder context from/to a file or memory stream, or save calculated edges from an Edge Finder result buffer to a file or memory stream in CAD DXF format. - Specifies the file or memory stream. - Specifies the system on which to restore the Edge Finder context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the Edge Finder context or calculated edges. - Specifies the MIL version of the Edge Finder context. - Specifies the function's control flag. - Specifies the address of the variable in which to write or from which to read the identifier of the Edge Finder context or the Edge Finder result buffer. - Specifies the address of the variable in which to write the size of the Edge Finder context or calculated edges, in bytes. - - - Load, restore, or save an Edge Finder context from/to a file or memory stream, or save calculated edges from an Edge Finder result buffer to a file or memory stream in CAD DXF format. - Specifies the file or memory stream. - Specifies the system on which to restore the Edge Finder context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the Edge Finder context or calculated edges. - Specifies the MIL version of the Edge Finder context. - Specifies the function's control flag. - Specifies the address of the variable in which to write or from which to read the identifier of the Edge Finder context or the Edge Finder result buffer. - Specifies the address of the variable in which to write the size of the Edge Finder context or calculated edges, in bytes. - - - Allocate an FPGA command context for a PU in the FPGA configuration loaded in a Processing FPGA on a target system. - Specifies the identifier of the system that has the required Processing FPGA. - Specifies the Processing FPGA for which to allocate the command context. - Specifies the function identifier of the required PU. - Specifies the subfunction identifier of the required PU. - Specifies the PU to use when two or more instances, with the same function identifier and subfunction identifier, are present in a FPGA configuration loaded in a Processing FPGA. - Specifies how the processing operation should be issued on the system command queue. - Reserved for future expansion. - Specifies the address of the variable in which to write the handle of the FPGA command context. - The returned value is M_VALID if allocation is successful. If allocation fails, M_NULL is returned. - - - Control a specified FPGA command context setting. - Specifies the handle of the FPGA command context associated with the PU. - Specifies the FPGA command context setting to control. - Specifies the address of the variable which contains the value to assign to the command context setting. - - - Control a specified FPGA command context setting. - Specifies the handle of the FPGA command context associated with the PU. - Specifies the FPGA command context setting to control. - Specifies the address of the variable which contains the value to assign to the command context setting. - - - Free an FPGA command context. - Specifies the handle of the FPGA command context to deallocate. The command context must have been previously allocated on the system using MfpgaCommandAlloc. - Reserved for future expansion. Set this parameter to M_DEFAULT . - The returned value is M_VALID if deallocation is successful. If deallocation fails, M_NULL is returned. - - - Inquire about a specified FPGA command context setting. - Specifies the handle of the FPGA command context associated with the PU. - Specifies the type of setting about which to inquire. These inquire types correspond to register fields of the PU associated with the specified FPGA command context. - Specifies the address in which to write the requested information. - - - Inquire about a specified FPGA command context setting. - Specifies the handle of the FPGA command context associated with the PU. - Specifies the type of setting about which to inquire. These inquire types correspond to register fields of the PU associated with the specified FPGA command context. - Specifies the address in which to write the requested information. - - - Put an FPGA command on the system command queue of the current thread. - Specifies the handle of the FPGA command context associated with the PU, which defines the command. - Specifies when the processing operation will be tagged as completed. This parameter can be set to one of the following values. - Specifies whether MfpgaCommandQueue should load the current command (or complex command) into hardware or store it into a complex command. - - - Controls a global setting of a specified Processing FPGA. - Specifies the identifier of the system that has the required Processing FPGA. - Specifies the Processing FPGA on the system to control. This parameter must be set to the following value: - Specifies the Processing FPGA setting to control. - Specifies the value to assign to the Processing FPGA setting. - The returned value is M_VALID if successful. If the operation fails, M_NULL is returned. - - - Controls a global setting of a specified Processing FPGA. - Specifies the identifier of the system that has the required Processing FPGA. - Specifies the Processing FPGA on the system to control. This parameter must be set to the following value: - Specifies the Processing FPGA setting to control. - Specifies the value to assign to the Processing FPGA setting. - The returned value is M_VALID if successful. If the operation fails, M_NULL is returned. - - - Get information about a PU hook event. - Specifies the PU event identifier received by the hook-handler function (see MfpgaHookFunction). - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a PU hook event. - Specifies the PU event identifier received by the hook-handler function (see MfpgaHookFunction). - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a PU hook event. - Specifies the PU event identifier received by the hook-handler function (see MfpgaHookFunction). - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Set up a request to read registers of a PU. - Specifies the handle of the FPGA command context associated with the PU. - Specifies the section of the PU's register space to access. - Specifies the offset from the start of the specified register section, from which to begin reading, in bytes. The offset must be a multiple of 4 bytes. - Specifies how many bytes of the register to read. The length must be a multiple of 4 bytes. - Specifies the address of the variable in which to write the value read from the register. This address must remain valid for the duration of the operation, otherwise a memory corruption will occur. - Specifies when the register read access must take place. - - - Hook a function to an event generated by a PU on a target system. - Specifies the identifier of the system that has the required Processing FPGA. - Specifies the Processing FPGA on the system which has the required PU. This parameter must be set to the following value: - Specifies the function identifier of the PU. - Specifies the subfunction identifier of the PU. - Specifies the specific PU instance on which to hook a function if two or more instances are present in the FPGA configuration, loaded on the Processing FPGA. - Specifies the Processing FPGA event type. - Specifies the address of the function that should be called when an event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Hook a function to an event generated by a PU on a target system. - Specifies the identifier of the system that has the required Processing FPGA. - Specifies the Processing FPGA on the system which has the required PU. This parameter must be set to the following value: - Specifies the function identifier of the PU. - Specifies the subfunction identifier of the PU. - Specifies the specific PU instance on which to hook a function if two or more instances are present in the FPGA configuration, loaded on the Processing FPGA. - Specifies the Processing FPGA event type. - Specifies the address of the function that should be called when an event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Inquire global information about a specified Processing FPGA. - Specifies the identifier of the system that has the required Processing FPGA. - Specifies the Processing FPGA to inquire. - Specifies the information about which to inquire. - Specifies the address at which to write the requested information. - The returned value is M_VALID if successful. If the operation fails, M_NULL is returned. - - - Inquire global information about a specified Processing FPGA. - Specifies the identifier of the system that has the required Processing FPGA. - Specifies the Processing FPGA to inquire. - Specifies the information about which to inquire. - Specifies the address at which to write the requested information. - The returned value is M_VALID if successful. If the operation fails, M_NULL is returned. - - - Load a new FPGA configuration into a Processing FPGA on a target system. - Specifies the identifier of the system that has the required Processing FPGA. - Specifies the rank of the Processing FPGA into which to load the new FPGA configuration. This parameter must be set to the following value: - Specifies the name and path of the file from which to load the FPGA configuration. - Reserved for future expansion. Set this parameter to M_DEFAULT . - The returned value is M_VALID if successful. If the operation fails, M_NULL is returned. - - - Specify a destination buffer for the FPGA processing operation. - Specifies the handle of the FPGA command context associated with the PU. - Specifies the handle of the destination buffer. - Specifies the stream output port whose data will be routed to the destination buffer. - Reserved for future expansion. - - - Cascade the PUs of two commands, such that a stream output of one PU is routed to a stream input port of the other PU. - Specifies the handle of the FPGA command context to use in the link. - Specifies the stream output port of the PU associated with the source command context. - Specifies the handle of the destination command context to use in the link. - Specifies the stream input port of the PU associated with the destination command context. - Reserved for future expansion. Set this parameter to M_DEFAULT . - - - Set the contents of one or more FPGA registers. - Specifies the handle of the FPGA command context associated with the PU. - Specifies the section of the PU's register space to access. - Specifies the offset from the start of the specified register section, from which to begin writing, in bytes. The offset must be a multiple of 4 bytes. - Specifies the number of bytes to write in the register. The length must be a multiple of 4 bytes. - Specifies the address of the variable in which to write the value to be sent to the register. - Specifies when the register write access must take place. - - - Specify a source buffer for the FPGA processing operation. - Specifies the handle of the FPGA command context associated with the PU. - Specifies the handle of the source buffer. - Specifies the stream input port to which to route data from the source buffer. - Reserved for future expansion. - - - Allocate a MIL function context for your user-defined function. - Specifies the name of the user-defined function. - Specifies the number of parameters passed to the current user-defined function. Note that the number of parameters should not exceed 16. - Specifies the address of the slave function. - Specifies the name of the library file which contains the slave function's code. - Specifies the name of the slave function to export from the library file. - Specifies the opcode to use to locate the slave function when an application executes the user-defined MIL function. The slave function's opcode also serves to identify which user-defined module, if any, the user-defined function belongs to. - Specifies more information about the user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier provided for the user-defined function. Since the MfuncAlloc function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL function context for your user-defined function. - Specifies the name of the user-defined function. - Specifies the number of parameters passed to the current user-defined function. Note that the number of parameters should not exceed 16. - Specifies the address of the slave function. - Specifies the name of the library file which contains the slave function's code. - Specifies the name of the slave function to export from the library file. - Specifies the opcode to use to locate the slave function when an application executes the user-defined MIL function. The slave function's opcode also serves to identify which user-defined module, if any, the user-defined function belongs to. - Specifies more information about the user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier provided for the user-defined function. Since the MfuncAlloc function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL function context for your user-defined function. - Specifies the name of the user-defined function. - Specifies the number of parameters passed to the current user-defined function. Note that the number of parameters should not exceed 16. - Specifies the address of the slave function. - Specifies the name of the library file which contains the slave function's code. - Specifies the name of the slave function to export from the library file. - Specifies the opcode to use to locate the slave function when an application executes the user-defined MIL function. The slave function's opcode also serves to identify which user-defined module, if any, the user-defined function belongs to. - Specifies more information about the user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier provided for the user-defined function. Since the MfuncAlloc function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL function context for your user-defined function. - Specifies the name of the user-defined function. - Specifies the number of parameters passed to the current user-defined function. Note that the number of parameters should not exceed 16. - Specifies the address of the slave function. - Specifies the name of the library file which contains the slave function's code. - Specifies the name of the slave function to export from the library file. - Specifies the opcode to use to locate the slave function when an application executes the user-defined MIL function. The slave function's opcode also serves to identify which user-defined module, if any, the user-defined function belongs to. - Specifies more information about the user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier provided for the user-defined function. Since the MfuncAlloc function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL function context for your user-defined function. - Specifies the name of the user-defined function. - Specifies the number of parameters passed to the current user-defined function. Note that the number of parameters should not exceed 16. - Specifies the address of the slave function. - Specifies the name of the library file which contains the slave function's code. - Specifies the name of the slave function to export from the library file. - Specifies the opcode to use to locate the slave function when an application executes the user-defined MIL function. The slave function's opcode also serves to identify which user-defined module, if any, the user-defined function belongs to. - Specifies more information about the user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier provided for the user-defined function. Since the MfuncAlloc function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL function context for your user-defined function. - Specifies the name of the user-defined function. - Specifies the number of parameters passed to the current user-defined function. Note that the number of parameters should not exceed 16. - Specifies the address of the slave function. - Specifies the name of the library file which contains the slave function's code. - Specifies the name of the slave function to export from the library file. - Specifies the opcode to use to locate the slave function when an application executes the user-defined MIL function. The slave function's opcode also serves to identify which user-defined module, if any, the user-defined function belongs to. - Specifies more information about the user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier provided for the user-defined function. Since the MfuncAlloc function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL function context for your user-defined function. - Specifies the name of the user-defined function. - Specifies the number of parameters passed to the current user-defined function. Note that the number of parameters should not exceed 16. - Specifies the address of the slave function. - Specifies the name of the library file which contains the slave function's code. - Specifies the name of the slave function to export from the library file. - Specifies the opcode to use to locate the slave function when an application executes the user-defined MIL function. The slave function's opcode also serves to identify which user-defined module, if any, the user-defined function belongs to. - Specifies more information about the user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier provided for the user-defined function. Since the MfuncAlloc function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL function context for your user-defined function. - Specifies the name of the user-defined function. - Specifies the number of parameters passed to the current user-defined function. Note that the number of parameters should not exceed 16. - Specifies the address of the slave function. - Specifies the name of the library file which contains the slave function's code. - Specifies the name of the slave function to export from the library file. - Specifies the opcode to use to locate the slave function when an application executes the user-defined MIL function. The slave function's opcode also serves to identify which user-defined module, if any, the user-defined function belongs to. - Specifies more information about the user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier provided for the user-defined function. Since the MfuncAlloc function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Associate a MIL identifier with a user-defined object. - Specifies a MIL function identifier. - Specifies the MIL type of the user-defined object to be associated with a MIL identifier. - Specifies the address of the user-defined object that is to be associated with a MIL identifier. - The returned value is the MIL identifier associated with the object if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL function context for your script-based user-defined MIL function. - Specifies the name of the script-based user-defined MIL function. - Specifies the number of parameters to be registered for the current user-defined function. - Specifies the language and language version in which the script is written. - Specifies the name and path of the file containing the user-defined script. The script file must be accessible to the computer executing the script. - Specifies the name of the function to export from the script file. - Specifies the opcode to use to locate the script-based user-defined MIL function when an application calls the function. The opcode also serves to identify the module in which to group the function, if any. - Specifies more information about the script-based user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier of the allocated MIL function context. Since the MfuncAllocScript function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the MIL function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Return the MIL identifier of the ancestor buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the MIL identifier of the specified MIL buffer's ancestor buffer. - - - Return the band offset relative to the ancestor buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the band offset of the specified MIL buffer relative to its ancestor buffer. - - - Return the bit offset relative to the ancestor buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the bit offset of the specified MIL buffer relative its ancestor buffer. - - - Return the X-offset relative to the ancestor buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the X-offset of the specified MIL buffer relative its ancestor buffer. - - - Return the Y-offset relative to the ancestor buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the Y-offset of the specified MIL buffer relative its ancestor buffer. - - - Return the requested format of the specified buffer as set using MbufAlloc...() with Attribute. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is a bit-encoded value that specifies the buffer's attributes, set at allocation. - - - Return the actual format of the specified buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is a bit-encoded value that specifies the buffer's current formatting. - - - Returns the Host address of the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - - - Returns the Host address of a band of the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - Specifies which band's address to return. - - - Return the MIL identifier of the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the MIL identifier of the specified MIL buffer. - - - Return the maximum pixel value possible in the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the maximum pixel value possible in the specified MIL buffer. - - - Return the minimum pixel value possible in the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the minimum pixel value possible in the specified MIL buffer. - - - Return the MIL identifier of the system on which the buffer has been allocated. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the MIL identifier of the system on which the specified MIL buffer has been allocated. - - - Return the type of system on which the buffer has been allocated. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the type of system on which the specified MIL buffer has been allocated. - - - Return the MIL identifier of the parent buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the MIL identifier of the specified MIL buffers' parent buffer. - - - Return the band offset relative to the parent buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the band offset of the specified MIL buffer relative to its parent buffer. - - - Return the X-offset relative to the parent buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the X-offset of the specified MIL buffer relative its parent buffer. - - - Return the Y-offset relative to the parent buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the Y-offset of the specified MIL buffer relative its ancestor buffer. - - - Return the physical address of the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the physical address of the specified MIL buffer. - - - Returns the physical address of a band of the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - Specifies which band's address to return. - The returned value is the physical address of a band of the specified MIL buffer. - - - Return the number of pixels between the beginnings of any two adjacent lines of the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the number of pixels between the beginnings of any two adjacent lines of the specified MIL buffer. - - - Return the number of bytes between the beginnings of any two adjacent lines of the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the number of bytes between the beginnings of any two adjacent lines of the specified MIL buffer. - - - Return the number of buffer color bands. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the number of color bands in the specified MIL buffer. - - - Return the depth per band, in bits. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the depth per band, in bits, of the specified MIL buffer. - - - Return the width of the buffer, in pixels. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the width, in pixels, of the specified MIL buffer. - - - Return the height of the buffer, in pixels. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the height, in pixels, of the specified MIL buffer. - - - Return the buffer data type and depth. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the buffer data type and depth, in bits, of the specified MIL buffer. - - - Execute the slave function. - Specifies the identifier of the user-defined MIL function. - The returned value is M_NULL if an error occurred; otherwise, not null. - - - Control a user-defined MIL function context. - Specifies the identifier of the user-defined MIL function context. Depending on the control type, the context must have been allocated using a specific MIL allocation function. - Specifies the user-defined MIL function context setting to control. - Specifies the setting's new value. - - - Control a user-defined MIL function context. - Specifies the identifier of the user-defined MIL function context. Depending on the control type, the context must have been allocated using a specific MIL allocation function. - Specifies the user-defined MIL function context setting to control. - Specifies the setting's new value. - - - Report an error message. - Specifies the MIL function identifier. This parameter can be set to the following values: - Specifies a numeric code to the user-defined MIL function's group of error messages. - Specifies the text of your error message to report. - Specifies the text of your first error sub-message to report. - Specifies the text of your second error sub-message to report. - Specifies the text of your third error sub-message to report. - The returned value is M_NULL if an error occurred during the error log operation; otherwise, not M_NULL . - - - Report an error message. - Specifies the MIL function identifier. This parameter can be set to the following values: - Specifies a numeric code to the user-defined MIL function's group of error messages. - Specifies the text of your error message to report. - Specifies the text of your first error sub-message to report. - Specifies the text of your second error sub-message to report. - Specifies the text of your third error sub-message to report. - The returned value is M_NULL if an error occurred during the error log operation; otherwise, not M_NULL . - - - Report an error message. - Specifies the MIL function identifier. This parameter can be set to the following values: - Specifies a numeric code to the user-defined MIL function's group of error messages. - Specifies the text of your error message to report. - Specifies the text of your first error sub-message to report. - Specifies the text of your second error sub-message to report. - Specifies the text of your third error sub-message to report. - The returned value is M_NULL if an error occurred during the error log operation; otherwise, not M_NULL . - - - Report an error message. - Specifies the MIL function identifier. This parameter can be set to the following values: - Specifies a numeric code to the user-defined MIL function's group of error messages. - Specifies the text of your error message to report. - Specifies the text of your first error sub-message to report. - Specifies the text of your second error sub-message to report. - Specifies the text of your third error sub-message to report. - The returned value is M_NULL if an error occurred during the error log operation; otherwise, not M_NULL . - - - Report an error message. - Specifies the MIL function identifier. This parameter can be set to the following values: - Specifies a numeric code to the user-defined MIL function's group of error messages. - Specifies the text of your error message to report. - Specifies the text of your first error sub-message to report. - Specifies the text of your second error sub-message to report. - Specifies the text of your third error sub-message to report. - The returned value is M_NULL if an error occurred during the error log operation; otherwise, not M_NULL . - - - Free a MIL function context. - Specifies the identifier of the user-defined MIL function whose function context you want to free. - - - Free the MIL identifier associated with a user-defined MIL object. - Specifies a MIL function identifier. This parameter can be set to the following values: - Specifies the MIL identifier of the user-defined MIL object to free. - - - Retrieve information about a MIL object. - Specifies the identifier of the MIL object. Depending on the inquire type, this object must have been allocated using a specific MIL allocation function. - Specifies the MIL object feature about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Retrieve information about a MIL object. - Specifies the identifier of the MIL object. Depending on the inquire type, this object must have been allocated using a specific MIL allocation function. - Specifies the MIL object feature about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Retrieve information about a MIL object. - Specifies the identifier of the MIL object. Depending on the inquire type, this object must have been allocated using a specific MIL allocation function. - Specifies the MIL object feature about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Retrieve information about a MIL object. - Specifies the identifier of the MIL object. Depending on the inquire type, this object must have been allocated using a specific MIL allocation function. - Specifies the MIL object feature about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Retrieve information about a MIL object. - Specifies the identifier of the MIL object. Depending on the inquire type, this object must have been allocated using a specific MIL allocation function. - Specifies the MIL object feature about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the parameter type of the parameter in the user-defined MIL function. - Specifies the size of the data pointed to by the ParamValuePtr parameter. - Specifies the type of the MIL object when the data type of the parameter of the user-defined function is MIL_ID. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies the type of the MIL object when the data type of the parameter of the user-defined function is MIL_ID. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies the type of the MIL object when the data type of the parameter of the user-defined function is MIL_ID. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_UINT64parameter. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the length of the string in characters, including the null terminator. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the size of the data, in bytes, pointed to by ParamValuePtr. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the size of the data, in bytes, pointed to by ParamValuePtr. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the size of the data, in bytes, pointed to by ParamValuePtr. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the size of the data, in bytes, pointed to by ParamValuePtr. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the size of the data, in bytes, pointed to by ParamValuePtr. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the length of the string in characters, including the null terminator. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_DOUBLEparameter. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_IDparameter. - Specifies the type of the MIL object when the data type of the parameter of the user-defined function is MIL_ID. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_INTparameter. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_INT32parameter. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_INT64parameter. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the length of the string in characters, including the null terminator. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the length of the string in characters, including the null terminator. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_UINTparameter. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_UINT32parameter. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_UINT64parameter. - - - Verify whether parameter checking is required. - Specifies the identifier of the user-defined MIL function. - The returned value is M_NULL if no parameter checking is required; otherwise, checking is required. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Generate data into a LUT buffer using a specified standard mathematical function, or a specified colormap (pseudo-color palette). - Specifies the identifier of the LUT in which to generate values. - Specifies the mathematical function or colormap to use for calculations. - Specifies the constant a for the specified mathematical function, or specifies a replacement value for the color assigned to index 0 of the LUT, if filling the LUT with a colormap. - Specifies the constant b for the specified mathematical function, or specifies a replacement value for the color assigned to the highest index of the LUT, if filling the LUT with a colormap. - Specifies the constant c for the specified mathematical function, if applicable. If filling the LUT with a colormap, set this to M_DEFAULT. - Specifies the first LUT index entry for which to generate values. - Specifies the initial value of x in the mathematical function. If filling the LUT with a colormap, set this to M_DEFAULT. - Specifies the last LUT index entry for which to generate values. - - - Generate ramp data into a LUT buffer. - Specifies the identifier of the LUT in which to generate values. - Specifies the first LUT index for which to generate a value. - Specifies the starting value from which the increment is calculated; that is, the first LUT entry. - Specifies the last LUT index for which to generate a value. - Specifies the ending value from which the increment is calculated; that is, the last LUT entry. - - - Generate 2D ramp data into a buffer. - Specifies the identifier of the buffer in which to generate values. - Specifies the factor by which to scale in X. - Specifies the factor by which to scale in Y. - Specifies the offset. This corresponds to the value placed in the first location of the buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Generate coefficients or LUTs used to warp an image. - Specifies the input buffer from which to generate coefficients or LUT entries. - Specifies the buffer in which to place generated coefficients or X-LUT entries. - Specifies the buffer in which to place Y-LUT entries. - Specifies the mode of operation. - Specifies the type of first-order polynomial warping for which to generate coefficients. If you are not generating coefficients for a first-order polynomial warping ( M_WARP_POLYNOMIAL), set the this parameter to M_DEFAULT . - Specifies the first transform constant. - Specifies the second transform constant. - - - Allocate a 2D graphics context. - Specifies the system on which to allocate the 2D graphics context. - Specifies the address of the variable in which the 2D graphics context identifier is to be written. - The returned value is the 2D graphics context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 2D graphics context. - Specifies the system on which to allocate the 2D graphics context. - Specifies the address of the variable in which the 2D graphics context identifier is to be written. - The returned value is the 2D graphics context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 2D graphics list. - Specifies the system on which to allocate the 2D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 2D graphics list identifier. - The returned value is the 2D graphics list identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 2D graphics list. - Specifies the system on which to allocate the 2D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 2D graphics list identifier. - The returned value is the 2D graphics list identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Draw an arc in an image without rotation or fill color, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer in which to draw the arc or the identifier of a valid 2D graphics list in which to add the arc. - Specifies the X-coordinate of the center of the ellipse from which the arc is defined, in the input coordinate system. - Specifies the Y-coordinate of the center of the ellipse from which the arc is defined, in the input coordinate system. - Specifies the radius of the ellipse from which the arc is defined, along the X-axis of the input coordinate system. - Specifies the radius of the ellipse from which the arc is defined, along the Y-axis of the input coordinate system. - Specifies the angle at which to start drawing the arc, in degrees, relative to the input coordinate system. - Specifies the angle at which to end drawing the arc, in degrees, relative to the input coordinate system. - - - Draw an arc in an image without rotation or fill color, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer in which to draw the arc or the identifier of a valid 2D graphics list in which to add the arc. - Specifies the X-coordinate of the center of the ellipse from which the arc is defined, in the input coordinate system. - Specifies the Y-coordinate of the center of the ellipse from which the arc is defined, in the input coordinate system. - Specifies the radius of the ellipse from which the arc is defined, along the X-axis of the input coordinate system. - Specifies the radius of the ellipse from which the arc is defined, along the Y-axis of the input coordinate system. - Specifies the angle at which to start drawing the arc, in degrees, relative to the input coordinate system. - Specifies the angle at which to end drawing the arc, in degrees, relative to the input coordinate system. - - - Draw an arc or sector in an image, with optional rotation and fill color, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer in which to draw the arc or sector, or the identifier of a valid 2D graphics list in which to add the arc or sector. - Specifies the X-coordinate of the center of the ellipse from which the arc or sector is defined, in the input coordinate system. - Specifies the Y-coordinate of the center of the ellipse from which the arc or sector is defined, in the input coordinate system. - Specifies the radius of the ellipse from which the arc or sector is defined, along the X-axis in the input coordinate system. - Specifies the radius of the ellipse from which the arc or sector is defined, along the Y-axis in the input coordinate system. - Specifies the angle at which to start drawing the arc or sector, in degrees, relative to the input coordinate system. - Specifies the angle at which to end drawing the arc or sector, in degrees, relative to the input coordinate system. - Specifies the amount to rotate the ellipse used to define the arc or sector, in degrees, relative to the input coordinate system. - Specifies whether to draw an arc or sector. This parameter must be set to one of the following values: - - - Draw an arc or sector in an image, with optional rotation and fill color, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer in which to draw the arc or sector, or the identifier of a valid 2D graphics list in which to add the arc or sector. - Specifies the X-coordinate of the center of the ellipse from which the arc or sector is defined, in the input coordinate system. - Specifies the Y-coordinate of the center of the ellipse from which the arc or sector is defined, in the input coordinate system. - Specifies the radius of the ellipse from which the arc or sector is defined, along the X-axis in the input coordinate system. - Specifies the radius of the ellipse from which the arc or sector is defined, along the Y-axis in the input coordinate system. - Specifies the angle at which to start drawing the arc or sector, in degrees, relative to the input coordinate system. - Specifies the angle at which to end drawing the arc or sector, in degrees, relative to the input coordinate system. - Specifies the amount to rotate the ellipse used to define the arc or sector, in degrees, relative to the input coordinate system. - Specifies whether to draw an arc or sector. This parameter must be set to one of the following values: - - - Draw a filled arc (sector) in an image without rotation, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer in which to draw the arc or the identifier of a valid 2D graphics list in which to add the arc. - Specifies the X-coordinate of the center of the ellipse from which the arc is defined, in the input coordinate system. - Specifies the Y-coordinate of the center of the ellipse from which the arc is defined, in the input coordinate system. - Specifies the radius of the ellipse from which the arc is defined, along the X-axis of the input coordinate system. - Specifies the radius of the ellipse from which the arc is defined, along the Y-axis of the input coordinate system. - Specifies the angle at which to start drawing the arc, in degrees, relative to the input coordinate system. - Specifies the angle at which to end drawing the arc, in degrees, relative to the input coordinate system. - - - Draw a filled arc (sector) in an image without rotation, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer in which to draw the arc or the identifier of a valid 2D graphics list in which to add the arc. - Specifies the X-coordinate of the center of the ellipse from which the arc is defined, in the input coordinate system. - Specifies the Y-coordinate of the center of the ellipse from which the arc is defined, in the input coordinate system. - Specifies the radius of the ellipse from which the arc is defined, along the X-axis of the input coordinate system. - Specifies the radius of the ellipse from which the arc is defined, along the Y-axis of the input coordinate system. - Specifies the angle at which to start drawing the arc, in degrees, relative to the input coordinate system. - Specifies the angle at which to end drawing the arc, in degrees, relative to the input coordinate system. - - - Sets the background color of the 2D graphics context. - Specifies the identifier of the 2D graphics context in which to set the background color. This parameter must be set to one of the following values: - Specifies the background color of a specified 2D graphics context. - - - Clear an image buffer to a specified foreground color, or remove graphics from a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer to clear or the identifier of a valid 2D graphics list to empty. - - - Sets the foreground color of the 2D graphics context. - Specifies the identifier of the 2D graphics context in which to set the foreground color. This parameter must be set to one of the following values: - Specifies the foreground color of a specified 2D graphics context. - - - Control a specified 2D graphics context setting. - Specifies the identifier of the 2D graphics context to control. This parameter must be set to one of the following: - Specifies the 2D graphics context setting to control. - Specifies the value to assign to the 2D graphics context setting. - - - Control a specified 2D graphics context setting. - Specifies the identifier of the 2D graphics context to control. This parameter must be set to one of the following: - Specifies the 2D graphics context setting to control. - Specifies the value to assign to the 2D graphics context setting. - - - Control the graphics contained within the 2D graphics list. - Specifies the identifier of the 2D graphics list to control. The 2D graphics list must have been previously allocated on the required system using MgraAllocList. - Specifies the graphic (one or all) to control. - Specifies the index of the sub-element of the graphic on which to apply the control setting. If this information is not required or supported, set this parameter to M_DEFAULT. - Specifies the 2D graphics list setting to control. - Specifies the value to assign to the 2D graphics list setting. - - - Control the graphics contained within the 2D graphics list. - Specifies the identifier of the 2D graphics list to control. The 2D graphics list must have been previously allocated on the required system using MgraAllocList. - Specifies the graphic (one or all) to control. - Specifies the index of the sub-element of the graphic on which to apply the control setting. If this information is not required or supported, set this parameter to M_DEFAULT. - Specifies the 2D graphics list setting to control. - Specifies the value to assign to the 2D graphics list setting. - - - Control the graphics contained within the 2D graphics list. - Specifies the identifier of the 2D graphics list to control. The 2D graphics list must have been previously allocated on the required system using MgraAllocList. - Specifies the graphic (one or all) to control. - Specifies the index of the sub-element of the graphic on which to apply the control setting. If this information is not required or supported, set this parameter to M_DEFAULT. - Specifies the 2D graphics list setting to control. - Specifies the value to assign to the 2D graphics list setting. - - - Copy one or more graphics from one 2D graphics list to another. - Specifies the identifier of a valid 2D graphics list from which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the identifier of a valid 2D graphics list in which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the type of copy operation to perform. - Specifies the location inside the destination 2D graphics list at which to insert the graphics. - Specifies the number of graphics to copy or move. - Specifies the address of the array containing the indices or labels of the graphics to copy from the source 2D graphics list. - Specifies the address of the array in which to write the labels that have been automatically given to the copied or moved graphics in the destination 2D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy one or more graphics from one 2D graphics list to another. - Specifies the identifier of a valid 2D graphics list from which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the identifier of a valid 2D graphics list in which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the type of copy operation to perform. - Specifies the location inside the destination 2D graphics list at which to insert the graphics. - Specifies the number of graphics to copy or move. - Specifies the address of the array containing the indices or labels of the graphics to copy from the source 2D graphics list. - Specifies the address of the array in which to write the labels that have been automatically given to the copied or moved graphics in the destination 2D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy one or more graphics from one 2D graphics list to another. - Specifies the identifier of a valid 2D graphics list from which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the identifier of a valid 2D graphics list in which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the type of copy operation to perform. - Specifies the location inside the destination 2D graphics list at which to insert the graphics. - Specifies the number of graphics to copy or move. - Specifies the address of the array containing the indices or labels of the graphics to copy from the source 2D graphics list. - Specifies the address of the array in which to write the labels that have been automatically given to the copied or moved graphics in the destination 2D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy one or more graphics from one 2D graphics list to another. - Specifies the identifier of a valid 2D graphics list from which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the identifier of a valid 2D graphics list in which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the type of copy operation to perform. - Specifies the location inside the destination 2D graphics list at which to insert the graphics. - Specifies the number of graphics to copy or move. - Specifies the address of the array containing the indices or labels of the graphics to copy from the source 2D graphics list. - Specifies the address of the array in which to write the labels that have been automatically given to the copied or moved graphics in the destination 2D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy one or more graphics from one 2D graphics list to another. - Specifies the identifier of a valid 2D graphics list from which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the identifier of a valid 2D graphics list in which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the type of copy operation to perform. - Specifies the location inside the destination 2D graphics list at which to insert the graphics. - Specifies the number of graphics to copy or move. - Specifies the address of the array containing the indices or labels of the graphics to copy from the source 2D graphics list. - Specifies the address of the array in which to write the labels that have been automatically given to the copied or moved graphics in the destination 2D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - - - Draw a dot in an image or add a dot to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the dot or the identifier of a valid 2D graphics list in which to add the dot. - Specifies the X-coordinate of the dot in the input coordinate system. - Specifies the Y-coordinate of the dot in the input coordinate system. - - - Draw a dot in an image or add a dot to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the dot or the identifier of a valid 2D graphics list in which to add the dot. - Specifies the X-coordinate of the dot in the input coordinate system. - Specifies the Y-coordinate of the dot in the input coordinate system. - - - Draw one or more dots in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the dots or the identifier of a valid 2D graphics list in which to add the dots. - Specifies the number of dots to draw. - Specifies the address of the array containing the X-coordinate(s) of the dots to be drawn in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the dots to be drawn in the input coordinate system. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Draw one or more dots in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the dots or the identifier of a valid 2D graphics list in which to add the dots. - Specifies the number of dots to draw. - Specifies the address of the array containing the X-coordinate(s) of the dots to be drawn in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the dots to be drawn in the input coordinate system. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Draw one or more dots in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the dots or the identifier of a valid 2D graphics list in which to add the dots. - Specifies the number of dots to draw. - Specifies the address of the array containing the X-coordinate(s) of the dots to be drawn in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the dots to be drawn in the input coordinate system. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Draw one or more dots in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the dots or the identifier of a valid 2D graphics list in which to add the dots. - Specifies the number of dots to draw. - Specifies the address of the array containing the X-coordinate(s) of the dots to be drawn in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the dots to be drawn in the input coordinate system. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Draw graphics, contained in a 2D graphics list, in an image. - Specifies the identifier of the 2D graphics list containing the graphics to destructively draw in the image. - Specifies the identifier of the destination image buffer in which to draw. - Specifies whether to also draw the annotations that indicate whether a graphic is selected, such as the selection box and handles. - - - Perform a boundary-type seed fill. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to perform the filling operation. - Specifies the X-coordinate of the seed position in the input coordinate system. - Specifies the Y-coordinate of the seed position in the input coordinate system. - - - Perform a boundary-type seed fill. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to perform the filling operation. - Specifies the X-coordinate of the seed position in the input coordinate system. - Specifies the Y-coordinate of the seed position in the input coordinate system. - - - Associate a text font with a 2D graphics context. - Specifies the identifier of the 2D graphics context with which to associate the character font. This parameter must be set to one of the following values: - Specifies the font with which to write text. - - - Associate a text font with a 2D graphics context. - Specifies the identifier of the 2D graphics context with which to associate the character font. This parameter must be set to one of the following values: - Specifies the font with which to write text. - - - Set the font scale of a 2D graphics context. - Specifies the identifier of the 2D graphics context for which to set the font scale. - Specifies the X-scale-factor by which to multiply the width of the font characters. - Specifies the Y-scale-factor by which to multiply the height of the font characters. - - - Free a 2D graphics context or a 2D graphics list. - Specifies the identifier of the 2D graphics context or 2D graphics list to deallocate. If M_DEFAULT is specified, an error will occur. - - - Get information about a 2D graphics list event. - Specifies the 2D graphics list event identifier received by the hook-handler function (see MgraHookFunction). - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a 2D graphics list event. - Specifies the 2D graphics list event identifier received by the hook-handler function (see MgraHookFunction). - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a 2D graphics list event. - Specifies the 2D graphics list event identifier received by the hook-handler function (see MgraHookFunction). - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a 2D graphics list event. - Specifies the 2D graphics list event identifier received by the hook-handler function (see MgraHookFunction). - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a 2D graphics list event. - Specifies the 2D graphics list event identifier received by the hook-handler function (see MgraHookFunction). - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Hook a function to a 2D graphics list event. - Specifies the identifier of the 2D graphics list to which to hook a function. - Specifies the 2D graphics list event to which to hook the function. - Specifies the address of the function that should be called when the specified event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Inquire information about a 2D graphics context. - Specifies the identifier of the 2D graphics context about which to inquire information. This parameter must be set to one of the following values: - Specifies the 2D graphics context setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics context. - Specifies the identifier of the 2D graphics context about which to inquire information. This parameter must be set to one of the following values: - Specifies the 2D graphics context setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics context. - Specifies the identifier of the 2D graphics context about which to inquire information. This parameter must be set to one of the following values: - Specifies the 2D graphics context setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics context. - Specifies the identifier of the 2D graphics context about which to inquire information. This parameter must be set to one of the following values: - Specifies the 2D graphics context setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics context. - Specifies the identifier of the 2D graphics context about which to inquire information. This parameter must be set to one of the following values: - Specifies the 2D graphics context setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics context. - Specifies the identifier of the 2D graphics context about which to inquire information. This parameter must be set to one of the following values: - Specifies the 2D graphics context setting to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics context. - Specifies the identifier of the 2D graphics context about which to inquire information. This parameter must be set to one of the following values: - Specifies the 2D graphics context setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics list or a graphic contained within the 2D graphics list. - Specifies the identifier of the 2D graphics list about which to inquire information. - Specifies the graphic about which to inquire, or specifies to inquire about the 2D graphics list itself. - Specifies the index of the sub-element of the graphic about which to inquire. If this information is not required or supported, set this parameter to M_DEFAULT. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics list or a graphic contained within the 2D graphics list. - Specifies the identifier of the 2D graphics list about which to inquire information. - Specifies the graphic about which to inquire, or specifies to inquire about the 2D graphics list itself. - Specifies the index of the sub-element of the graphic about which to inquire. If this information is not required or supported, set this parameter to M_DEFAULT. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics list or a graphic contained within the 2D graphics list. - Specifies the identifier of the 2D graphics list about which to inquire information. - Specifies the graphic about which to inquire, or specifies to inquire about the 2D graphics list itself. - Specifies the index of the sub-element of the graphic about which to inquire. If this information is not required or supported, set this parameter to M_DEFAULT. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics list or a graphic contained within the 2D graphics list. - Specifies the identifier of the 2D graphics list about which to inquire information. - Specifies the graphic about which to inquire, or specifies to inquire about the 2D graphics list itself. - Specifies the index of the sub-element of the graphic about which to inquire. If this information is not required or supported, set this parameter to M_DEFAULT. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics list or a graphic contained within the 2D graphics list. - Specifies the identifier of the 2D graphics list about which to inquire information. - Specifies the graphic about which to inquire, or specifies to inquire about the 2D graphics list itself. - Specifies the index of the sub-element of the graphic about which to inquire. If this information is not required or supported, set this parameter to M_DEFAULT. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics list or a graphic contained within the 2D graphics list. - Specifies the identifier of the 2D graphics list about which to inquire information. - Specifies the graphic about which to inquire, or specifies to inquire about the 2D graphics list itself. - Specifies the index of the sub-element of the graphic about which to inquire. If this information is not required or supported, set this parameter to M_DEFAULT. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Change the state of interactivity of graphics in a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid 2D graphics list whose state of interactivity must be changed. - Specifies the type of graphic to define interactively and add to the 2D graphics list, or specifies to cancel or stop the 2D graphics list's state of interactivity. - Specifies optional behavior when defining the graphic in the display. If this behavior is not required or supported, set this parameter to M_DEFAULT . - Specifies how to interactively define the graphic. - - - Draw a line in an image or add a line to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the line or the identifier of a valid 2D graphics list in which to add the line. - Specifies the X-coordinate of the start of the line in the input coordinate system. - Specifies the Y-coordinate of the start of the line in the input coordinate system. - Specifies the X-coordinate of the end of the line in the input coordinate system. - Specifies the Y-coordinate of the end of the line in the input coordinate system. - - - Draw a line in an image or add a line to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the line or the identifier of a valid 2D graphics list in which to add the line. - Specifies the X-coordinate of the start of the line in the input coordinate system. - Specifies the Y-coordinate of the start of the line in the input coordinate system. - Specifies the X-coordinate of the end of the line in the input coordinate system. - Specifies the Y-coordinate of the end of the line in the input coordinate system. - - - Draw one or more lines, a polyline, or a polygon in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the lines, polyline, or polygon or the identifier of a valid 2D graphics list in which to add the lines, polyline, or polygon. - Specifies the number of lines to draw or add ( M_LINE_LIST), or the number of vertices in the polyline or polygon to draw or add ( M_POLYGON or M_POLYLINE), according to the array parameters ( XPtr, YPtr, X2Ptr, and Y2Ptr). - Specifies the address of the array containing the X-coordinate(s) of the start of the lines, or containing the X-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the start of the lines, or containing the Y-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the X-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the type of line to draw in the image or to add to the 2D graphics list. - - - Draw one or more lines, a polyline, or a polygon in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the lines, polyline, or polygon or the identifier of a valid 2D graphics list in which to add the lines, polyline, or polygon. - Specifies the number of lines to draw or add ( M_LINE_LIST), or the number of vertices in the polyline or polygon to draw or add ( M_POLYGON or M_POLYLINE), according to the array parameters ( XPtr, YPtr, X2Ptr, and Y2Ptr). - Specifies the address of the array containing the X-coordinate(s) of the start of the lines, or containing the X-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the start of the lines, or containing the Y-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the X-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the type of line to draw in the image or to add to the 2D graphics list. - - - Draw one or more lines, a polyline, or a polygon in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the lines, polyline, or polygon or the identifier of a valid 2D graphics list in which to add the lines, polyline, or polygon. - Specifies the number of lines to draw or add ( M_LINE_LIST), or the number of vertices in the polyline or polygon to draw or add ( M_POLYGON or M_POLYLINE), according to the array parameters ( XPtr, YPtr, X2Ptr, and Y2Ptr). - Specifies the address of the array containing the X-coordinate(s) of the start of the lines, or containing the X-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the start of the lines, or containing the Y-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the X-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the type of line to draw in the image or to add to the 2D graphics list. - - - Draw one or more lines, a polyline, or a polygon in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the lines, polyline, or polygon or the identifier of a valid 2D graphics list in which to add the lines, polyline, or polygon. - Specifies the number of lines to draw or add ( M_LINE_LIST), or the number of vertices in the polyline or polygon to draw or add ( M_POLYGON or M_POLYLINE), according to the array parameters ( XPtr, YPtr, X2Ptr, and Y2Ptr). - Specifies the address of the array containing the X-coordinate(s) of the start of the lines, or containing the X-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the start of the lines, or containing the Y-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the X-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the type of line to draw in the image or to add to the 2D graphics list. - - - Draw one or more lines, a polyline, or a polygon in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the lines, polyline, or polygon or the identifier of a valid 2D graphics list in which to add the lines, polyline, or polygon. - Specifies the number of lines to draw or add ( M_LINE_LIST), or the number of vertices in the polyline or polygon to draw or add ( M_POLYGON or M_POLYLINE), according to the array parameters ( XPtr, YPtr, X2Ptr, and Y2Ptr). - Specifies the address of the array containing the X-coordinate(s) of the start of the lines, or containing the X-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the start of the lines, or containing the Y-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the X-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the type of line to draw in the image or to add to the 2D graphics list. - - - Draw one or more lines, a polyline, or a polygon in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the lines, polyline, or polygon or the identifier of a valid 2D graphics list in which to add the lines, polyline, or polygon. - Specifies the number of lines to draw or add ( M_LINE_LIST), or the number of vertices in the polyline or polygon to draw or add ( M_POLYGON or M_POLYLINE), according to the array parameters ( XPtr, YPtr, X2Ptr, and Y2Ptr). - Specifies the address of the array containing the X-coordinate(s) of the start of the lines, or containing the X-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the start of the lines, or containing the Y-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the X-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the type of line to draw in the image or to add to the 2D graphics list. - - - Draw one or more lines, a polyline, or a polygon in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the lines, polyline, or polygon or the identifier of a valid 2D graphics list in which to add the lines, polyline, or polygon. - Specifies the number of lines to draw or add ( M_LINE_LIST), or the number of vertices in the polyline or polygon to draw or add ( M_POLYGON or M_POLYLINE), according to the array parameters ( XPtr, YPtr, X2Ptr, and Y2Ptr). - Specifies the address of the array containing the X-coordinate(s) of the start of the lines, or containing the X-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the start of the lines, or containing the Y-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the X-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the type of line to draw in the image or to add to the 2D graphics list. - - - Draw one or more lines, a polyline, or a polygon in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the lines, polyline, or polygon or the identifier of a valid 2D graphics list in which to add the lines, polyline, or polygon. - Specifies the number of lines to draw or add ( M_LINE_LIST), or the number of vertices in the polyline or polygon to draw or add ( M_POLYGON or M_POLYLINE), according to the array parameters ( XPtr, YPtr, X2Ptr, and Y2Ptr). - Specifies the address of the array containing the X-coordinate(s) of the start of the lines, or containing the X-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the start of the lines, or containing the Y-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the X-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the type of line to draw in the image or to add to the 2D graphics list. - - - Draw a rectangle in an image without rotation or fill color, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the rectangle or the identifier of a valid 2D graphics list in which to add the rectangle. - Specifies the X-coordinate of the top-left corner of the rectangle in the input coordinate system. - Specifies the Y-coordinate of the top-left corner of the rectangle in the input coordinate system. - Specifies the X-coordinate of the bottom-right corner of the rectangle in the input coordinate system. - Specifies the Y-coordinate of the bottom-right corner of the rectangle in the input coordinate system. - - - Draw a rectangle in an image without rotation or fill color, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the rectangle or the identifier of a valid 2D graphics list in which to add the rectangle. - Specifies the X-coordinate of the top-left corner of the rectangle in the input coordinate system. - Specifies the Y-coordinate of the top-left corner of the rectangle in the input coordinate system. - Specifies the X-coordinate of the bottom-right corner of the rectangle in the input coordinate system. - Specifies the Y-coordinate of the bottom-right corner of the rectangle in the input coordinate system. - - - Draw a rectangle in an image with optional rotation and fill color, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the rectangle or the identifier of a valid 2D graphics list in which to add the rectangle. - Specifies the X-coordinate of the rectangle's position in the input coordinate system. - Specifies the Y-coordinate of the rectangle's position in the input coordinate system. - Specifies the width of the rectangle, relative to the input coordinate system. - Specifies the height of the rectangle, relative to the input coordinate system. - Specifies the angle with which to rotate the rectangle, in degrees, relative to the input coordinate system. - Specifies how to draw the rectangle in the image or add the rectangle to the 2D graphics list. - - - Draw a rectangle in an image with optional rotation and fill color, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the rectangle or the identifier of a valid 2D graphics list in which to add the rectangle. - Specifies the X-coordinate of the rectangle's position in the input coordinate system. - Specifies the Y-coordinate of the rectangle's position in the input coordinate system. - Specifies the width of the rectangle, relative to the input coordinate system. - Specifies the height of the rectangle, relative to the input coordinate system. - Specifies the angle with which to rotate the rectangle, in degrees, relative to the input coordinate system. - Specifies how to draw the rectangle in the image or add the rectangle to the 2D graphics list. - - - Draw a filled rectangle in an image without rotation, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the filled rectangle or the identifier of a valid 2D graphics list in which to add the filled rectangle. - Specifies the X-coordinate of the top-left corner of the filled rectangle in the input coordinate system. - Specifies the Y-coordinate of the top-left corner of the filled rectangle in the input coordinate system. - Specifies the X-coordinate of the bottom-right corner of the filled rectangle in the input coordinate system. - Specifies the Y-coordinate of the bottom-right corner of the filled rectangle in the input coordinate system. - - - Draw a filled rectangle in an image without rotation, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the filled rectangle or the identifier of a valid 2D graphics list in which to add the filled rectangle. - Specifies the X-coordinate of the top-left corner of the filled rectangle in the input coordinate system. - Specifies the Y-coordinate of the top-left corner of the filled rectangle in the input coordinate system. - Specifies the X-coordinate of the bottom-right corner of the filled rectangle in the input coordinate system. - Specifies the Y-coordinate of the bottom-right corner of the filled rectangle in the input coordinate system. - - - Draw text in an image or add text to a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer in which to draw the graphic or the identifier of a valid 2D graphics list in which to add the graphic. - Specifies the X-coordinate at which to start drawing the top-left corner of the first character in the input coordinate system. - Specifies the Y-coordinate at which to start drawing the top-left corner of the first character in the input coordinate system. - Specifies the address of the string containing the text to draw in the destination buffer. - - - Draw text in an image or add text to a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer in which to draw the graphic or the identifier of a valid 2D graphics list in which to add the graphic. - Specifies the X-coordinate at which to start drawing the top-left corner of the first character in the input coordinate system. - Specifies the Y-coordinate at which to start drawing the top-left corner of the first character in the input coordinate system. - Specifies the address of the string containing the text to draw in the destination buffer. - - - Draw vectors at arbitrary positions in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the vectors or the identifier of a valid 2D graphics list in which to add the vectors. - Specifies the number of vectors to draw. - Specifies the address of the array containing the X-coordinates of the starting points of the vectors to draw. - Specifies the address of the array containing the Y-coordinates of the starting points of the vectors to draw. - Specifies the address of the array containing the displacements, in the X-direction, of the vectors to draw. - Specifies the address of the array containing the displacements, in the Y-direction, of the vectors to draw. - Specifies how to use the scale value ( ScaleValue) to scale the vectors. - Specifies the value by which to scale the vectors, according to the specified mode ( ScaleMode). - Specifies how to configure the arrowheads of the vectors, and how to handle null vectors. - - - Draw vectors at arbitrary positions in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the vectors or the identifier of a valid 2D graphics list in which to add the vectors. - Specifies the number of vectors to draw. - Specifies the address of the array containing the X-coordinates of the starting points of the vectors to draw. - Specifies the address of the array containing the Y-coordinates of the starting points of the vectors to draw. - Specifies the address of the array containing the displacements, in the X-direction, of the vectors to draw. - Specifies the address of the array containing the displacements, in the Y-direction, of the vectors to draw. - Specifies how to use the scale value ( ScaleValue) to scale the vectors. - Specifies the value by which to scale the vectors, according to the specified mode ( ScaleMode). - Specifies how to configure the arrowheads of the vectors, and how to handle null vectors. - - - Draw vectors at arbitrary positions in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the vectors or the identifier of a valid 2D graphics list in which to add the vectors. - Specifies the number of vectors to draw. - Specifies the address of the array containing the X-coordinates of the starting points of the vectors to draw. - Specifies the address of the array containing the Y-coordinates of the starting points of the vectors to draw. - Specifies the address of the array containing the displacements, in the X-direction, of the vectors to draw. - Specifies the address of the array containing the displacements, in the Y-direction, of the vectors to draw. - Specifies how to use the scale value ( ScaleValue) to scale the vectors. - Specifies the value by which to scale the vectors, according to the specified mode ( ScaleMode). - Specifies how to configure the arrowheads of the vectors, and how to handle null vectors. - - - Draw vectors at arbitrary positions in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the vectors or the identifier of a valid 2D graphics list in which to add the vectors. - Specifies the number of vectors to draw. - Specifies the address of the array containing the X-coordinates of the starting points of the vectors to draw. - Specifies the address of the array containing the Y-coordinates of the starting points of the vectors to draw. - Specifies the address of the array containing the displacements, in the X-direction, of the vectors to draw. - Specifies the address of the array containing the displacements, in the Y-direction, of the vectors to draw. - Specifies how to use the scale value ( ScaleValue) to scale the vectors. - Specifies the value by which to scale the vectors, according to the specified mode ( ScaleMode). - Specifies how to configure the arrowheads of the vectors, and how to handle null vectors. - - - Draw vectors at equally spaced positions in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the vectors or the identifier of a valid 2D graphics list in which to add the vectors. - Specifies the identifier of a valid image buffer containing the values corresponding to the displacements, in the X-direction, of the vectors to draw. - Specifies the identifier of a valid image buffer containing the values corresponding to the displacements, in the Y-direction, of the vectors to draw. - Specifies a value that establishes the positions for which vectors are drawn. MIL always draws a vector for the first position (0,0), and then draws subsequent vectors that are a multiple of the specified stride, in both the X- and Y-direction. For example, if you specify a stride of 2, a vector is drawn for position (0,0), and for every second position after that, in the X-direction and in the Y-direction. Specifying a stride of 1 draws a vector for every position. Increasing the stride increases the space between the vectors drawn. - Specifies how to use the scale value ( ScaleValue) to scale the vectors. - Specifies the value by which to scale the vectors, according to the specified mode ( ScaleMode). - Specifies how to configure the arrowheads of the vectors, and how to handle null vectors. - - - Allocate an image processing context. - Specifies the system on which to allocate the context. - Specifies the type of image processing context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the image processing context identifier. - The returned value is the image processing context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an image processing context. - Specifies the system on which to allocate the context. - Specifies the type of image processing context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the image processing context identifier. - The returned value is the image processing context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an image processing result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the number of buffer entries to allocate for the specified result buffer. - Specifies the type of data that will be stored in this result buffer. - Specifies the address of the variable in which to write the image processing result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an image processing result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the number of buffer entries to allocate for the specified result buffer. - Specifies the type of data that will be stored in this result buffer. - Specifies the address of the variable in which to write the image processing result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Perform a point-to-point arithmetic operation. - Specifies the data source of the first operand. - Specifies the data source of the second operand. - Specifies the identifier of the destination of the results. - Specifies the operation to perform. - - - Perform a point-to-point arithmetic operation using multiple source images. - Specifies the data source of the first operand; this parameter must be given an image buffer identifier. - Specifies the data source of the second operand; this parameter can be given an image buffer identifier or a constant. - Specifies the data source of the third operand; this parameter can be given an image buffer identifier or a constant. - Specifies the data source of the fourth operand; this parameter must be given a constant. - Specifies the data source of the fifth operand; this parameter must be given a constant. - Specifies the identifier of the destination of the results; this parameter must be given an image buffer identifier. - Specifies the operation to perform. - Reserved for future expansion. Must be set to M_DEFAULT . - - - Perform an augmentation operation on an image. - Specifies the identifier of the augmentation context. The context must have been allocated using MimAlloc with M_AUGMENTATION_CONTEXT. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination in which to write the result of the augmentation transformation. - Specifies the initial value that will generate the randomized settings for the image processing operations used to perform the augmentation. - Specifies whether MimAugment should perform the augmentation, or should explicitly preprocess the augmentation context. - - - Perform a point-to-point binary threshold operation. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination image buffer in which to write the results. - Specifies the condition, as well as the threshold mode to use to establish the threshold value(s) of the condition. - Specifies either the lower limit of the selected condition or the minimum value to use when establishing the threshold. - Specifies either the upper limit of the selected condition or the maximum value to use when establishing the threshold. - When DstImageBufId is given an image buffer identifier, this function returns the specified value of the LowParam parameter. When DstImageBufId is set to M_NULL and the ConditionAndThreshMode parameter is set to one of the automatic threshold modes (M_BIMODAL, M_TRIANGLE_BISECTION_DARK, or M_TRIANGLE_BISECTION_BRIGHT), this function returns the automatically calculated threshold value. If the ConditionAndThreshMode parameter is set to M_PERCENTILE_VALUE, this function returns the threshold value established from the specified lower limit. When dealing with floating-point source buffers, the returned threshold is truncated to an integer value. Therefore, the returned threshold and the actual threshold used to binarize can differ. - - - Perform a point-to-point adaptive binarization on an image. - Specifies the identifier of the adaptive binarization context. - Specifies the identifier of the source image buffer with which to perform the adaptive binarization. - Specifies the identifier of the image buffer to use as the first seed image. - Specifies the identifier of the image buffer to use as the second seed image. - Specifies the identifier of the image buffer in which to put the result of the adaptive binarization operation. - Specifies the identifier of the image buffer in which to put the resulting threshold values with which to binarize the source image. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform a point-to-point clipping operation. - Specifies the identifier of the image data source. - Specifies the identifier of the destination image buffer. - Specifies the clipping condition. - Specifies the lower clipping point of the selected condition. - Specifies the upper clipping point of the selected condition. - Specifies the value to write to the destination buffer when a pixel satisfies the specified low clipping condition. - Specifies the value to write to the destination buffer when a pixel satisfies the specified high clipping condition. - - - Perform a binary or grayscale closing-type morphological operation. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the resulting image. - Specifies the number of times to iterate the operation. - Specifies the processing mode to use. - - - Perform a 3x3 binary connectivity mapping. - Specifies the identifier of the source of the operation. - Specifies the identifier of the destination of the results. - Specifies the identifier of the LUT buffer. - - - Control an image processing context or result buffer setting. - Specifies the identifier of the image processing context or result buffer. The image processing context or result buffer must have been previously allocated on the system using MimAlloc or MimAllocResult, respectively. - Specifies the processing feature to control. - Specifies the value needed for the control. - - - Control an image processing context or result buffer setting. - Specifies the identifier of the image processing context or result buffer. The image processing context or result buffer must have been previously allocated on the system using MimAlloc or MimAllocResult, respectively. - Specifies the processing feature to control. - Specifies the value needed for the control. - - - Perform a color conversion. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the type of conversion to perform. - - - Perform a general convolution operation. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the results. - Specifies the filter to use. - - - Count the number of pixels that differ in each image. - Specifies the identifier of the first image data source. - Specifies the identifier of the second image data source. - Specifies the identifier of the buffer in which to store the differences. - The returned value is the number of differences between the two specified source buffers. - - - Correct dead pixels in an image. - Specifies the identifier of the dead pixels image processing context. The context must have been allocated using MimAlloc with M_DEAD_PIXEL_CONTEXT. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the control flag. This parameter must be set to one of the following: - - - Produce a sequence of deinterlaced images from a sequence of images acquired from an interlaced camera. - Specifies the identifier of the image processing context to be used for deinterlacing. The image processing context must have been previously allocated on the system using MimAlloc. - Specifies an array containing the identifiers of the buffers of the images to deinterlace. - Specifies an array containing the identifiers of the buffers of the images in which to save the deinterlaced images. - Specifies the number of images in the source sequence. - Specifies the number of deinterlaced images in the destination sequence. - Reserved for future use. Should be set to M_DEFAULT . - - - Produce a sequence of deinterlaced images from a sequence of images acquired from an interlaced camera. - Specifies the identifier of the image processing context to be used for deinterlacing. The image processing context must have been previously allocated on the system using MimAlloc. - Specifies an array containing the identifiers of the buffers of the images to deinterlace. - Specifies an array containing the identifiers of the buffers of the images in which to save the deinterlaced images. - Specifies the number of images in the source sequence. - Specifies the number of deinterlaced images in the destination sequence. - Reserved for future use. Should be set to M_DEFAULT . - - - Produce a sequence of deinterlaced images from a sequence of images acquired from an interlaced camera. - Specifies the identifier of the image processing context to be used for deinterlacing. The image processing context must have been previously allocated on the system using MimAlloc. - Specifies an array containing the identifiers of the buffers of the images to deinterlace. - Specifies an array containing the identifiers of the buffers of the images in which to save the deinterlaced images. - Specifies the number of images in the source sequence. - Specifies the number of deinterlaced images in the destination sequence. - Reserved for future use. Should be set to M_DEFAULT . - - - Perform a differential operation. - Specifies the identifier of an image buffer that stores a derivative, or a linear IIR filter context. - Specifies the identifier of an image buffer that stores the source image, or a derivative. - Specifies the identifier an image buffer that stores the source image (for a sharpenig operation), or a derivative. - Reserved for future expansion and must be set to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies the identifier of the first destination image buffer. - Specifies the identifier of the second destination image buffer. - Specifies an attribute of the operation to perform. - Specifies the differential operation to perform. - Specifies a control setting for the operation to perform. - - - Perform a binary or grayscale dilation-type morphological operation. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the number of times to iterate the operation. - Specifies the processing mode to use. - - - Perform a distance transformation. - Specifies the identifier of the source of the operation. - Specifies the identifier of the destination of the resulting image. - Specifies the way in which the minimum distance from blob pixel to background pixel is calculated. - - - Draw the settings of an image processing context or the results of an image processing operation. - Specifies the identifier of the 2D graphics context to use. This parameter must be set to one of the following: - Specifies the identifier of the primary source image buffer, result buffer, or image processing context from which to extract the results to draw. - Specifies the identifier of the secondary source image buffer for the drawing operation. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Specifies an attribute of the operation to perform. - Specifies an attribute of the operation to perform. - Specifies drawing constraints. - - - Perform a specific edge detection operation and produce a gradient intensity and/or gradient angle image. - Specifies the identifier of the source of the operation. - Specifies the identifier of the destination buffer for the resulting gradient intensity image. - Specifies the identifier of the destination buffer for the resulting gradient angle image. - Specifies the filter to use. - Specifies how to perform the operation. - Specifies the threshold value for calculating the gradient angle. - - - Perform a binary or grayscale erosion-type morphological operation. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the number of times to iterate the operation. - Specifies the processing mode to use. - - - Perform adaptive filtering. - Specifies the predefined adaptive filter context to use. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies an attribute of the operation to perform. - Specifies an attribute of the operation to perform. - Specifies an attribute of the operation to perform. - Specifies how to determine the new value for a pixel determined to be noise. - - - Find an image buffer's extremes (minimum and/or maximum pixel values). - Specifies the identifier of the data source of the operation. - Specifies the identifier of the buffer in which to store the extreme values. - Specifies the type of extreme(s) to find. - - - Find the dominant orientations of an image buffer. - Specifies the find orientation image processing context. - Specifies the identifier of the source image. - Specifies the identifier of the find orientation result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Applies a flat-field correction to remove artifacts from the specified source image. - Specifies the identifier of a flat-field image processing context, previously allocated using MimAlloc with M_FLAT_FIELD_CONTEXT. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the operation to perform. This parameter must be set to one of the following values. - - - Perform a horizontal or vertical image-flipping operation. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the operation to perform. - Reserved for future expansion. Must be set to M_DEFAULT . - - - Free an image processing context or result buffer. - Specifies the identifier of the image processing context or result buffer to free. These must have been successfully allocated (with MimAlloc or MimAllocResult) prior to calling this function. - - - Gets arrays of values from an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the array in which to store the first set of values. - Specifies the address of the array in which to store the second set of values. - Reserved for future expansion and must be set to M_DEFAULT . - The returned value is the number of entries in the array(s). If Param1Ptr and Param2Ptr are both set to M_NULL, MimGet returns the size of the required arrays. - - - Gets arrays of values from an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the array in which to store the first set of values. - Specifies the address of the array in which to store the second set of values. - Reserved for future expansion and must be set to M_DEFAULT . - The returned value is the number of entries in the array(s). If Param1Ptr and Param2Ptr are both set to M_NULL, MimGet returns the size of the required arrays. - - - Gets arrays of values from an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the array in which to store the first set of values. - Specifies the address of the array in which to store the second set of values. - Reserved for future expansion and must be set to M_DEFAULT . - The returned value is the number of entries in the array(s). If Param1Ptr and Param2Ptr are both set to M_NULL, MimGet returns the size of the required arrays. - - - Gets arrays of values from an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the array in which to store the first set of values. - Specifies the address of the array in which to store the second set of values. - Reserved for future expansion and must be set to M_DEFAULT . - The returned value is the number of entries in the array(s). If Param1Ptr and Param2Ptr are both set to M_NULL, MimGet returns the size of the required arrays. - - - Gets arrays of values from an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the array in which to store the first set of values. - Specifies the address of the array in which to store the second set of values. - Reserved for future expansion and must be set to M_DEFAULT . - The returned value is the number of entries in the array(s). If Param1Ptr and Param2Ptr are both set to M_NULL, MimGet returns the size of the required arrays. - - - Gets arrays of values from an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the array in which to store the first set of values. - Specifies the address of the array in which to store the second set of values. - Reserved for future expansion and must be set to M_DEFAULT . - The returned value is the number of entries in the array(s). If Param1Ptr and Param2Ptr are both set to M_NULL, MimGet returns the size of the required arrays. - - - Gets arrays of values from an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the array in which to store the first set of values. - Specifies the address of the array in which to store the second set of values. - Reserved for future expansion and must be set to M_DEFAULT . - The returned value is the number of entries in the array(s). If Param1Ptr and Param2Ptr are both set to M_NULL, MimGet returns the size of the required arrays. - - - Gets arrays of values from an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the array in which to store the first set of values. - Specifies the address of the array in which to store the second set of values. - Reserved for future expansion and must be set to M_DEFAULT . - The returned value is the number of entries in the array(s). If Param1Ptr and Param2Ptr are both set to M_NULL, MimGet returns the size of the required arrays. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get data from a statistics result buffer, and place it in a user-supplied array. - Specifies the identifier of the statistics image processing result buffer from which to get results. - Specifies the X-offset of the region for which to retrieve results. - Specifies the Y-offset of the region for which to retrieve results. - Specifies the width (X-size) of the region for which to retrieve results. - Specifies the height (Y-size) of the region for which to retrieve results. - Specifies the type of result(s) to retrieve. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the user-specified array in which to write the results read from the multiple statistics result buffer. - - - Get data from a statistics result buffer, and place it in a user-supplied array. - Specifies the identifier of the statistics image processing result buffer from which to get results. - Specifies the X-offset of the region for which to retrieve results. - Specifies the Y-offset of the region for which to retrieve results. - Specifies the width (X-size) of the region for which to retrieve results. - Specifies the height (Y-size) of the region for which to retrieve results. - Specifies the type of result(s) to retrieve. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the user-specified array in which to write the results read from the multiple statistics result buffer. - - - Get data from a statistics result buffer, and place it in a user-supplied array. - Specifies the identifier of the statistics image processing result buffer from which to get results. - Specifies the X-offset of the region for which to retrieve results. - Specifies the Y-offset of the region for which to retrieve results. - Specifies the width (X-size) of the region for which to retrieve results. - Specifies the height (Y-size) of the region for which to retrieve results. - Specifies the type of result(s) to retrieve. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the user-specified array in which to write the results read from the multiple statistics result buffer. - - - Get data from a statistics result buffer, and place it in a user-supplied array. - Specifies the identifier of the statistics image processing result buffer from which to get results. - Specifies the X-offset of the region for which to retrieve results. - Specifies the Y-offset of the region for which to retrieve results. - Specifies the width (X-size) of the region for which to retrieve results. - Specifies the height (Y-size) of the region for which to retrieve results. - Specifies the type of result(s) to retrieve. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the user-specified array in which to write the results read from the multiple statistics result buffer. - - - Get data from a statistics result buffer, and place it in a user-supplied array. - Specifies the identifier of the statistics image processing result buffer from which to get results. - Specifies the X-offset of the region for which to retrieve results. - Specifies the Y-offset of the region for which to retrieve results. - Specifies the width (X-size) of the region for which to retrieve results. - Specifies the height (Y-size) of the region for which to retrieve results. - Specifies the type of result(s) to retrieve. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the user-specified array in which to write the results read from the multiple statistics result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Generate the intensity histogram of an image. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination for the histogram results. - - - Perform a histogram equalization of an image. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the results. - Specifies the equalization operation to perform. This parameter can be set to one of the following values. Note that the cumulative probability distribution, P(f) , of the input image is approximated by its cumulative histogram: - Specifies the value to use for alpha ( α ) in the equations for M_EXPONENTIAL and M_RAYLEIGH. - Specifies the lowest pixel value to equalize. - Specifies the highest pixel value to equalize. - - - Perform an adaptive histogram equalization on an image. - Specifies the identifier of the adaptive histogram equalization context. The context must have been allocated using MimAlloc with M_HISTOGRAM_EQUALIZE_ADAPTIVE_CONTEXT. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Inquire about an image processing context or result buffer setting. - Specifies the identifier of the image processing context or result buffer about which to inquire information. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire about an image processing context or result buffer setting. - Specifies the identifier of the image processing context or result buffer about which to inquire information. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire about an image processing context or result buffer setting. - Specifies the identifier of the image processing context or result buffer about which to inquire information. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire about an image processing context or result buffer setting. - Specifies the identifier of the image processing context or result buffer about which to inquire information. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire about an image processing context or result buffer setting. - Specifies the identifier of the image processing context or result buffer about which to inquire information. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire about an image processing context or result buffer setting. - Specifies the identifier of the image processing context or result buffer about which to inquire information. - Specifies the type of information about which to inquire. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire about an image processing context or result buffer setting. - Specifies the identifier of the image processing context or result buffer about which to inquire information. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Label objects in an image buffer. - Specifies identifier of the data source of the operation. - Specifies the identifier of the destination of the results. - Specifies the type of connectivity (lattice) to use for processing. - - - Find pixel coordinates or values that satisfy a specified condition. - Specifies the identifier of the source image for the operation. - Specifies the identifier of the buffer in which to store the event results. - Specifies the condition under which pixel values are considered an event. - Specifies the lower limit of the selected condition. - Specifies the upper limit of the selected condition. - The returned value is the number of pixels that satisfy the specified condition in the specified source image. - - - Performs peak intensity detection in every lane (row or column) of the source image. - Specifies the identifier of the image processing context. - Specifies the identifier of the source image buffer. - Specifies the identifier of the image processing result buffer in which to store results. - Specifies the nominal (expected average) width of the peak neighborhood. - Specifies the number of pixels that can be added to or subtracted from the nominal width, when determining the range of allowable widths of the peak neighborhood. - Specifies the minimum contrast (difference) between the intensity of the local background and the minimum acceptable intensity of pixels in the peak neighborhood. - Specifies whether to explicitly preprocess the image processing result buffer; or specifies a frame index for which to extract peaks. - Specifies the required value for the ControlFlag setting. - - - Perform a point-to-point LUT mapping operation. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the results. - Specifies the LUT through which to map source input values. - - - Generates a series of correlation values between the source image and a model image. - Specifies the identifier of the match image processing context. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the operation to perform. This parameter must be set to one of the following values. - - - Perform a morphological transformation using a user-defined or predefined structuring element. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the structuring element to use. For all operations except area opening and area closing operations, you must specify the identifier of the structuring element buffer which defines the required structuring element. - Specifies the operation to perform. - Specifies a value that is dependent on the morphological operation chosen. - Specifies the processing mode to use. This parameter can be set to one of the following: - - - Perform a binary or grayscale opening-type morphological operation. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the resulting image. - Specifies the number of times to iterate the operation. - Specifies the processing mode to use. - - - Perform a polar-to-rectangular or rectangular-to-polar transformation on an image or generate LUTs used to perform the transformation. - Specifies the identifier of the source image buffer or the destination X-coordinate LUT buffer. - Specifies the identifier of the destination image buffer or the Y-coordinate LUT buffer. - Specifies the X-coordinate of the circle's center in the rectangular image. - Specifies the Y-coordinate of the circle's center in the rectangular image. - Specifies the start radius of the zone of interest in the circle, in pixels. - Specifies the end radius of the zone of interest in the circle, in pixels. - Specifies the start angle of the zone of interest. The scan starts at this angle. - Specifies the end angle of the zone of interest. The scan ends at this angle. - Specifies the transform to perform. - Specifies the interpolation mode and overscan used when transforming the source image. When generating the LUTs to perform the transformation, this parameter is ignored and should be set to M_DEFAULT. - Specifies the address of the variable in which the required width of the destination buffer is written. - Specifies the address of the variable in which the required height of the destination buffer is written. - - - Perform a polar-to-rectangular or rectangular-to-polar transformation on an image or generate LUTs used to perform the transformation. - Specifies the identifier of the source image buffer or the destination X-coordinate LUT buffer. - Specifies the identifier of the destination image buffer or the Y-coordinate LUT buffer. - Specifies the X-coordinate of the circle's center in the rectangular image. - Specifies the Y-coordinate of the circle's center in the rectangular image. - Specifies the start radius of the zone of interest in the circle, in pixels. - Specifies the end radius of the zone of interest in the circle, in pixels. - Specifies the start angle of the zone of interest. The scan starts at this angle. - Specifies the end angle of the zone of interest. The scan ends at this angle. - Specifies the transform to perform. - Specifies the interpolation mode and overscan used when transforming the source image. When generating the LUTs to perform the transformation, this parameter is ignored and should be set to M_DEFAULT. - Specifies the address of the variable in which the required width of the destination buffer is written. - Specifies the address of the variable in which the required height of the destination buffer is written. - - - Perform a polar-to-rectangular or rectangular-to-polar transformation on an image or generate LUTs used to perform the transformation. - Specifies the identifier of the source image buffer or the destination X-coordinate LUT buffer. - Specifies the identifier of the destination image buffer or the Y-coordinate LUT buffer. - Specifies the X-coordinate of the circle's center in the rectangular image. - Specifies the Y-coordinate of the circle's center in the rectangular image. - Specifies the start radius of the zone of interest in the circle, in pixels. - Specifies the end radius of the zone of interest in the circle, in pixels. - Specifies the start angle of the zone of interest. The scan starts at this angle. - Specifies the end angle of the zone of interest. The scan ends at this angle. - Specifies the transform to perform. - Specifies the interpolation mode and overscan used when transforming the source image. When generating the LUTs to perform the transformation, this parameter is ignored and should be set to M_DEFAULT. - Specifies the address of the variable in which the required width of the destination buffer is written. - Specifies the address of the variable in which the required height of the destination buffer is written. - - - Perform a polar-to-rectangular or rectangular-to-polar transformation on an image or generate LUTs used to perform the transformation. - Specifies the identifier of the source image buffer or the destination X-coordinate LUT buffer. - Specifies the identifier of the destination image buffer or the Y-coordinate LUT buffer. - Specifies the X-coordinate of the circle's center in the rectangular image. - Specifies the Y-coordinate of the circle's center in the rectangular image. - Specifies the start radius of the zone of interest in the circle, in pixels. - Specifies the end radius of the zone of interest in the circle, in pixels. - Specifies the start angle of the zone of interest. The scan starts at this angle. - Specifies the end angle of the zone of interest. The scan ends at this angle. - Specifies the transform to perform. - Specifies the interpolation mode and overscan used when transforming the source image. When generating the LUTs to perform the transformation, this parameter is ignored and should be set to M_DEFAULT. - Specifies the address of the variable in which the required width of the destination buffer is written. - Specifies the address of the variable in which the required height of the destination buffer is written. - - - Project a 2D image into 1D. - Specifies the identifier of the source image buffer. - Specifies the destination buffer in which to write the projection results. - Specifies the angle of the projection axis. Lanes are perpendicular to this angle. This parameter can be set to one of the following: - Specifies the operation to perform. - Reserved for future expansion. This parameter must be set to M_NULL . - - - Puts arrays of values into an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the first array of values. - Specifies the address of the second array of values. - Reserved for future expansion and must be set to M_DEFAULT . - - - Puts arrays of values into an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the first array of values. - Specifies the address of the second array of values. - Reserved for future expansion and must be set to M_DEFAULT . - - - Puts arrays of values into an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the first array of values. - Specifies the address of the second array of values. - Reserved for future expansion and must be set to M_DEFAULT . - - - Puts arrays of values into an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the first array of values. - Specifies the address of the second array of values. - Reserved for future expansion and must be set to M_DEFAULT . - - - Puts arrays of values into an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the first array of values. - Specifies the address of the second array of values. - Reserved for future expansion and must be set to M_DEFAULT . - - - Puts arrays of values into an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the first array of values. - Specifies the address of the second array of values. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform a rank filter on the pixels in an image. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the resulting image. - Specifies the identifier of the structuring element buffer to use as a mask. - Specifies which of the pixel values to select after valid neighborhood values are sorted in increasing order; valid neighborhood pixel values are those that are not masked-out. - Specifies the processing mode to use. - - - Copies specified areas of a source buffer to the specified areas of a destination buffer. - Specifies the identifier of the rearrangement image processing context that indicates how to perform the operation and the locations to copy. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the operation to perform. This parameter must be set to one of the following values. - - - Remap source pixels to destination pixels according to the specified mode. - Specifies the identifier of a remap image processing context. This parameter must be set to M_DEFAULT , which indicates a linear remapping from source pixel to corresponding destination pixel. - Specifies the identifier of the source image buffer. The image buffer must be a 1-band or 3-band float, signed, or unsigned buffer. - Specifies the identifier of the destination image buffer. - Specifies the remapping mode. - - - Resize an image by the specified X- and Y-scale factors or generate the matrix to perform the transformation. - Specifies the source image to resize if performing the transformation. This parameter can be set to one of the following values: - Specifies the destination image buffer or array buffer, depending on whether performing the transformation. This parameter can be set to one of the following values: - Specifies the horizontal scaling factor. - Specifies the vertical scaling factor. - Specifies the interpolation mode when resizing the source image. - - - Restore an image processing context from disk. - Specifies the name and path of the file from which to restore the image processing context. - Specifies the system on which to restore the image processing context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the image processing context identifier. - The returned value is the image processing context identifier. If allocation fails, M_NULL is returned. - - - Restore an image processing context from disk. - Specifies the name and path of the file from which to restore the image processing context. - Specifies the system on which to restore the image processing context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the image processing context identifier. - The returned value is the image processing context identifier. If allocation fails, M_NULL is returned. - - - Rotate an image by a specified angle of rotation or generate the matrix to perform the transformation. - Specifies the source image to rotate if performing the transformation. This parameter can be set to one of the following values: - Specifies the destination image buffer or array buffer, depending on whether performing the transformation. This parameter can be set to one of the following values: - Specifies the angle of rotation. - Specifies the X-coordinate to use as the center of rotation in the source image. - Specifies the Y-coordinate to use as the center of rotation in the source image. - Specifies the X-coordinate in the destination buffer to which the specified center of the rotated source image will be mapped. - Specifies the Y-coordinate in the destination buffer to which the specified center of the rotated source image will be mapped. - Specifies the interpolation mode when rotating the source image. - - - Save an image processing context to a file. - Specifies the name and path of the file in which to save the image processing context; it is recommended that you use the MIC file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the image processing context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save an image processing context to a file. - Specifies the name and path of the file in which to save the image processing context; it is recommended that you use the MIC file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the image processing context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform a point-to-point bit shift. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the results. - Specifies the number of bits to shift. - - - Calculates and stores a variety of statistics from the specified source image(s). - Specifies the identifier of the image processing context that specifies the statistics to calculate. - Specifies the identifier of the source image buffer. - Specifies the identifier of the result buffer. - Specifies the operation to perform on the source image. - - - Load, restore, or save an image processing context from/to a file or a memory stream, or save an augmentation report to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the image processing context. - Specifies the operation to perform on the image processing context. - Specifies the type of stream in which to store/from which to restore the image processing context. - Specifies the MIL version of the image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the image processing context. - Specifies the address of the variable in which to write the size of the image processing context, in bytes. - - - Load, restore, or save an image processing context from/to a file or a memory stream, or save an augmentation report to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the image processing context. - Specifies the operation to perform on the image processing context. - Specifies the type of stream in which to store/from which to restore the image processing context. - Specifies the MIL version of the image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the image processing context. - Specifies the address of the variable in which to write the size of the image processing context, in bytes. - - - Load, restore, or save an image processing context from/to a file or a memory stream, or save an augmentation report to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the image processing context. - Specifies the operation to perform on the image processing context. - Specifies the type of stream in which to store/from which to restore the image processing context. - Specifies the MIL version of the image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the image processing context. - Specifies the address of the variable in which to write the size of the image processing context, in bytes. - - - Load, restore, or save an image processing context from/to a file or a memory stream, or save an augmentation report to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the image processing context. - Specifies the operation to perform on the image processing context. - Specifies the type of stream in which to store/from which to restore the image processing context. - Specifies the MIL version of the image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the image processing context. - Specifies the address of the variable in which to write the size of the image processing context, in bytes. - - - Load, restore, or save an image processing context from/to a file or a memory stream, or save an augmentation report to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the image processing context. - Specifies the operation to perform on the image processing context. - Specifies the type of stream in which to store/from which to restore the image processing context. - Specifies the MIL version of the image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the image processing context. - Specifies the address of the variable in which to write the size of the image processing context, in bytes. - - - Load, restore, or save an image processing context from/to a file or a memory stream, or save an augmentation report to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the image processing context. - Specifies the operation to perform on the image processing context. - Specifies the type of stream in which to store/from which to restore the image processing context. - Specifies the MIL version of the image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the image processing context. - Specifies the address of the variable in which to write the size of the image processing context, in bytes. - - - Perform a binary or grayscale thickening operation on an image. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the resulting image. - Specifies the number of times to iterate the operation. - Specifies the processing mode to use. - - - Perform a binary or grayscale thinning operation on an image. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the resulting image. - Specifies the number of times to iterate the operation. - Specifies the processing mode to use. - - - Perform a Fast Fourier transform (FFT), a Discrete Cosine transform (DCT), or a polar-cartesian coordinates transformation. - Specifies the identifier of the source buffer for the real component of the image. - Specifies the identifier of the source buffer for the imaginary component of the image. - Specifies the identifier of the destination buffer for the real component of the image. - Specifies the identifier of the destination buffer for the imaginary component of the image. - Specifies the type of transform to perform on the image. - Specifies if the transform is a forward transform or a reverse transform. - - - Translate an image by a specified X- and/or Y-displacement, or generate the matrix to perform the transformation. - Specifies the source image to translate if performing the transformation. This parameter can be set to one of the following values: - Specifies the destination image buffer or array buffer, depending on whether performing the transformation. This parameter can be set to one of the following values: - Specifies the amount, in pixel units, by which to displace the source image in the X-direction. - Specifies the amount, in pixel units, by which to displace the source image in the Y-direction. - Specifies the interpolation mode when translating the source image. When only generating the matrix, this parameter is ignored and should be set to M_DEFAULT. - - - Perform a warping. - Specifies the buffer on which to perform the warping. - Specifies the buffer in which to place the results of the warping. - Specifies the buffer containing the matrix coefficients or the LUT buffer from which x s is determined. - Specifies the LUT buffer from which y s is determined. - Specifies the mode of operation. - Specifies the interpolation mode. - - - Applies a warping matrix to a list of coordinates. - Specifies the buffer containing the warp matrix coefficients. - Specifies the transformation type to perform the warping. - Specifies the number of points in the arrays. - Specifies the address of the array that contains the source X-coordinates. - Specifies the address of the array that contains the source Y-coordinates. - Specifies the address of the array in which to store the destination X-coordinates. - Specifies the address of the array in which to store the destination Y-coordinates. - Reserved for future expansion. - - - Perform a watershed transformation. - Specifies the buffer on which to perform the transform. - Specifies the buffer to use as a marker image. - Specifies the buffer in which to place the results of the transformation. - Specifies the minimum variation of gray-level of a catchment basin. - Specifies how to perform the transformation. - - - Perform a wavelet denoising. - Specifies the identifier of a wavelet image processing context, when performing a wavelet denoising of an image. - Specifies the identifier of the source with which to perform the wavelet denoising. - Specifies the identifier of the destination with which to perform the wavelet denoising. - Specifies the transformation level at which to perform the denoising. - Specifies the type of wavelet process with which to perform the denoising. - Reserved for future expansion and must be set to M_DEFAULT . - - - Set wavelet filters for a custom wavelet context. - Specifies the identifier of a custom wavelet image processing context allocated using MimAlloc with M_WAVELET_TRANSFORM_CUSTOM_CONTEXT. - Specifies the identifier of the kernel buffer containing the real part of the complex numbers used for the low-pass filter of a forward wavelet transformation. - Specifies the identifier of the kernel buffer containing the real part of the complex numbers used for the high-pass filter of a forward wavelet transformation. - Specifies the identifier of the kernel buffer containing the real part of the complex numbers used for the low-pass filter of a reverse wavelet transformation. - Specifies the identifier of the kernel buffer containing the real part of the complex numbers used for the high-pass filter of a reverse wavelet transformation. - Specifies the identifier of the kernel buffer containing the imaginary part of the complex numbers used for the low-pass filter of a forward wavelet transformation. - Specifies the identifier of the kernel buffer containing the imaginary part of the complex numbers used for the high-pass filter of a forward wavelet transformation. - Specifies the identifier of the kernel buffer containing the imaginary part of the complex numbers used for the low-pass filter of a reverse wavelet transformation. - Specifies the identifier of the kernel buffer containing the imaginary part of the complex numbers used for the high-pass filter of a reverse wavelet transformation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform a wavelet transformation. - Specifies the identifier of a wavelet image processing context. The context must have been allocated using MimAlloc with M_WAVELET_TRANSFORM_CONTEXT or M_WAVELET_TRANSFORM_CUSTOM_CONTEXT. - Specifies the identifier of the source with which to perform the wavelet transformation. - Specifies the identifier of the destination in which to write the result of the wavelet transformation. - Specifies the type of wavelet transformation to perform. - Specifies the number of transformation levels with which to calculate results. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform a zone of influence detection. - Specifies the identifier of the source of the operation. - Specifies the identifier of the destination of the resulting image. - Specifies the type of 3x3 distance matrix used for the operation. - - - Allocate a measurement context. - Specifies the system on which the to allocate the measurement context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which the measurement context identifier is to be written. - The returned value is the measurement context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a measurement context. - Specifies the system on which the to allocate the measurement context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which the measurement context identifier is to be written. - The returned value is the measurement context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a measurement marker buffer. - Specifies the system on which to allocate the marker buffer. - Specifies the type of marker buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the marker buffer identifier. - The returned value is the marker buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a measurement marker buffer. - Specifies the system on which to allocate the marker buffer. - Specifies the type of marker buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the marker buffer identifier. - The returned value is the marker buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a measurement result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. - Specifies the address of the variable in which the measurement result identifier is to be written. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a measurement result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. - Specifies the address of the variable in which the measurement result identifier is to be written. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Calculate measurements between two markers. - Specifies the measurement context to use. - Specifies the identifier of the first marker buffer to use for calculating measurements. - Specifies the identifier of the second marker buffer to use for calculating measurements. - Specifies the identifier of the result buffer in which to place results. - Specifies which measurement(s) to calculate. - - - Control a measurement context or result buffer setting. - Specifies the identifier of the measurement context or result buffer. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control a measurement context or result buffer setting. - Specifies the identifier of the measurement context or result buffer. - Specifies the type of control to set. - Specifies the required value for the control. - - - Draw expected marker characteristics or the characteristics of marker occurrences, or draw calculation results, in the destination image buffer or 2D graphics list. - Specifies the 2D graphics context to use. This parameter must be set to one of the following values: - Specifies the identifier of a measurement marker buffer or the identifier of a measurement result buffer. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Specifies the index of the result to draw from a measurement marker buffer or from a measurement result buffer. - Specifies whether to perform the drawing operation on the expected marker characteristics, the actual marker characteristics found in the target image, or the results of the measurement calculation. - - - Find a marker in a target image and take the specified measurements. - Specifies the identifier of the measurement context. - Specifies the identifier of the target image buffer in which to locate the marker. - Specifies the identifier of the marker to be located in the image. - Specifies the measurements to perform. - - - Free a measurement context, marker buffer, or result buffer. - Specifies the measurement identifier to free. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Retrieves information about the specified score characteristic. - Specifies the identifier of the measurement marker buffer. - Specifies the score characteristic about which to get information. - Specifies the index of the occurrence of a multiple-occurrence marker. This parameter must be set to one of the following values: - Specifies the address of the variable in which to write either the characteristic's resulting value (when using M_RESULT) or the characteristic's minimum acceptable limit, as indicated using MmeasSetScore with the Min parameter (when using M_MARKER). - Specifies the address of the variable in which to write either the characteristic's resulting score (when using M_RESULT) or the characteristic's lowest acceptable limit, as indicated using MmeasSetScore with the Low parameter (when using M_MARKER). - Specifies the address of the variable in which to write either the greatest value that MIL considers theoretically possible for the characteristic (when using M_RESULT) or the characteristic's highest acceptable limit, as indicated using MmeasSetScore with the High parameter (when using M_MARKER). - Specifies the address of the variable in which to write the characteristic's maximum acceptable limit, as indicated using MmeasSetScore with the Max parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Specifies the address of the variable in which to write the characteristic's score-offset, as indicated using MmeasSetScore with the ScoreOffset parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Specifies the address of the variable in which to write the characteristic's input units, as indicated using MmeasSetScore with the InputUnits parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Reserved for future expansion and must be set to M_DEFAULT . - - - Retrieves information about the specified score characteristic. - Specifies the identifier of the measurement marker buffer. - Specifies the score characteristic about which to get information. - Specifies the index of the occurrence of a multiple-occurrence marker. This parameter must be set to one of the following values: - Specifies the address of the variable in which to write either the characteristic's resulting value (when using M_RESULT) or the characteristic's minimum acceptable limit, as indicated using MmeasSetScore with the Min parameter (when using M_MARKER). - Specifies the address of the variable in which to write either the characteristic's resulting score (when using M_RESULT) or the characteristic's lowest acceptable limit, as indicated using MmeasSetScore with the Low parameter (when using M_MARKER). - Specifies the address of the variable in which to write either the greatest value that MIL considers theoretically possible for the characteristic (when using M_RESULT) or the characteristic's highest acceptable limit, as indicated using MmeasSetScore with the High parameter (when using M_MARKER). - Specifies the address of the variable in which to write the characteristic's maximum acceptable limit, as indicated using MmeasSetScore with the Max parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Specifies the address of the variable in which to write the characteristic's score-offset, as indicated using MmeasSetScore with the ScoreOffset parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Specifies the address of the variable in which to write the characteristic's input units, as indicated using MmeasSetScore with the InputUnits parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Reserved for future expansion and must be set to M_DEFAULT . - - - Retrieves information about the specified score characteristic. - Specifies the identifier of the measurement marker buffer. - Specifies the score characteristic about which to get information. - Specifies the index of the occurrence of a multiple-occurrence marker. This parameter must be set to one of the following values: - Specifies the address of the variable in which to write either the characteristic's resulting value (when using M_RESULT) or the characteristic's minimum acceptable limit, as indicated using MmeasSetScore with the Min parameter (when using M_MARKER). - Specifies the address of the variable in which to write either the characteristic's resulting score (when using M_RESULT) or the characteristic's lowest acceptable limit, as indicated using MmeasSetScore with the Low parameter (when using M_MARKER). - Specifies the address of the variable in which to write either the greatest value that MIL considers theoretically possible for the characteristic (when using M_RESULT) or the characteristic's highest acceptable limit, as indicated using MmeasSetScore with the High parameter (when using M_MARKER). - Specifies the address of the variable in which to write the characteristic's maximum acceptable limit, as indicated using MmeasSetScore with the Max parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Specifies the address of the variable in which to write the characteristic's score-offset, as indicated using MmeasSetScore with the ScoreOffset parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Specifies the address of the variable in which to write the characteristic's input units, as indicated using MmeasSetScore with the InputUnits parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Reserved for future expansion and must be set to M_DEFAULT . - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Restore a marker from disk. - Specifies the name and path of the file from which to restore the marker. - Specifies the system on which to restore the measurement marker. - Reserved for future expansion, and must be set to M_DEFAULT . - Specifies the address of the variable in which the marker identifier is to be written. - The returned value is the marker identifier. If allocation fails, M_NULL is returned. - - - Restore a marker from disk. - Specifies the name and path of the file from which to restore the marker. - Specifies the system on which to restore the measurement marker. - Reserved for future expansion, and must be set to M_DEFAULT . - Specifies the address of the variable in which the marker identifier is to be written. - The returned value is the marker identifier. If allocation fails, M_NULL is returned. - - - Save a marker to disk. - Specifies the name and path of the file in which to save the marker. - Specifies the identifier of the marker to save. - Reserved for future expansion, and must be set to M_DEFAULT . - - - Save a marker to disk. - Specifies the name and path of the file in which to save the marker. - Specifies the identifier of the marker to save. - Reserved for future expansion, and must be set to M_DEFAULT . - - - Set an essential characteristic of a marker. - Specifies the identifier of the marker. - Specifies the type of characteristic to set. - Specifies the first value to assign to the characteristic. - Specifies the second value to assign to the characteristic. - - - Set an essential characteristic of a marker. - Specifies the identifier of the marker. - Specifies the type of characteristic to set. - Specifies the first value to assign to the characteristic. - Specifies the second value to assign to the characteristic. - - - Set a score characteristic of a marker. - Specifies the identifier of the measurement marker for which to set the score characteristic. - Specifies the score characteristic to set. - Specifies the minimum limit, which MIL uses to calculate the characteristic's score. - Specifies the low limit, which MIL uses to calculate the characteristic's score. - Specifies the high limit, which MIL uses to calculate the characteristic's score. - Specifies the maximum limit, which MIL uses to calculate the characteristic's score. - Specifies the characteristic's score-offset. - Specifies the units with which to interpret the Min, Low, High, and Max parameter values, when applicable. - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a marker from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the measurement marker. - Specifies the operation to perform on the measurement marker. - Specifies the type of stream in which to store/from which to restore the measurement marker. - Specifies the MIL version of the marker object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the marker. - Specifies the address of the variable in which to write the size of the measurement marker, in bytes. - - - Load, restore, or save a marker from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the measurement marker. - Specifies the operation to perform on the measurement marker. - Specifies the type of stream in which to store/from which to restore the measurement marker. - Specifies the MIL version of the marker object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the marker. - Specifies the address of the variable in which to write the size of the measurement marker, in bytes. - - - Load, restore, or save a marker from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the measurement marker. - Specifies the operation to perform on the measurement marker. - Specifies the type of stream in which to store/from which to restore the measurement marker. - Specifies the MIL version of the marker object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the marker. - Specifies the address of the variable in which to write the size of the measurement marker, in bytes. - - - Load, restore, or save a marker from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the measurement marker. - Specifies the operation to perform on the measurement marker. - Specifies the type of stream in which to store/from which to restore the measurement marker. - Specifies the MIL version of the marker object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the marker. - Specifies the address of the variable in which to write the size of the measurement marker, in bytes. - - - Load, restore, or save a marker from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the measurement marker. - Specifies the operation to perform on the measurement marker. - Specifies the type of stream in which to store/from which to restore the measurement marker. - Specifies the MIL version of the marker object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the marker. - Specifies the address of the variable in which to write the size of the measurement marker, in bytes. - - - Load, restore, or save a marker from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the measurement marker. - Specifies the operation to perform on the measurement marker. - Specifies the type of stream in which to store/from which to restore the measurement marker. - Specifies the MIL version of the marker object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the marker. - Specifies the address of the variable in which to write the size of the measurement marker, in bytes. - - - Add a feature to, or modify a feature of, the metrology template of a metrology context. - Specifies the identifier of the metrology context containing the template. - Specifies the type of feature to add ( M_CONSTRUCTED or M_MEASURED) or specifies to modify a feature ( M_MODIFY). - Specifies the geometric shape of the feature to add. - Specifies the label of the feature. - Specifies the operation to use to build the feature. - Specifies the array that holds the label of every feature to use to construct the feature. - Specifies the array that holds the index of every subfeature to use to construct the feature. - Specifies the size of the arrays that hold the information that will be used to construct the feature ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a feature to, or modify a feature of, the metrology template of a metrology context. - Specifies the identifier of the metrology context containing the template. - Specifies the type of feature to add ( M_CONSTRUCTED or M_MEASURED) or specifies to modify a feature ( M_MODIFY). - Specifies the geometric shape of the feature to add. - Specifies the label of the feature. - Specifies the operation to use to build the feature. - Specifies the array that holds the label of every feature to use to construct the feature. - Specifies the array that holds the index of every subfeature to use to construct the feature. - Specifies the size of the arrays that hold the information that will be used to construct the feature ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a feature to, or modify a feature of, the metrology template of a metrology context. - Specifies the identifier of the metrology context containing the template. - Specifies the type of feature to add ( M_CONSTRUCTED or M_MEASURED) or specifies to modify a feature ( M_MODIFY). - Specifies the geometric shape of the feature to add. - Specifies the label of the feature. - Specifies the operation to use to build the feature. - Specifies the array that holds the label of every feature to use to construct the feature. - Specifies the array that holds the index of every subfeature to use to construct the feature. - Specifies the size of the arrays that hold the information that will be used to construct the feature ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a feature to, or modify a feature of, the metrology template of a metrology context. - Specifies the identifier of the metrology context containing the template. - Specifies the type of feature to add ( M_CONSTRUCTED or M_MEASURED) or specifies to modify a feature ( M_MODIFY). - Specifies the geometric shape of the feature to add. - Specifies the label of the feature. - Specifies the operation to use to build the feature. - Specifies the array that holds the label of every feature to use to construct the feature. - Specifies the array that holds the index of every subfeature to use to construct the feature. - Specifies the size of the arrays that hold the information that will be used to construct the feature ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a feature to, or modify a feature of, the metrology template of a metrology context. - Specifies the identifier of the metrology context containing the template. - Specifies the type of feature to add ( M_CONSTRUCTED or M_MEASURED) or specifies to modify a feature ( M_MODIFY). - Specifies the geometric shape of the feature to add. - Specifies the label of the feature. - Specifies the operation to use to build the feature. - Specifies the array that holds the label of every feature to use to construct the feature. - Specifies the array that holds the index of every subfeature to use to construct the feature. - Specifies the size of the arrays that hold the information that will be used to construct the feature ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a feature to, or modify a feature of, the metrology template of a metrology context. - Specifies the identifier of the metrology context containing the template. - Specifies the type of feature to add ( M_CONSTRUCTED or M_MEASURED) or specifies to modify a feature ( M_MODIFY). - Specifies the geometric shape of the feature to add. - Specifies the label of the feature. - Specifies the operation to use to build the feature. - Specifies the array that holds the label of every feature to use to construct the feature. - Specifies the array that holds the index of every subfeature to use to construct the feature. - Specifies the size of the arrays that hold the information that will be used to construct the feature ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a feature to, or modify a feature of, the metrology template of a metrology context. - Specifies the identifier of the metrology context containing the template. - Specifies the type of feature to add ( M_CONSTRUCTED or M_MEASURED) or specifies to modify a feature ( M_MODIFY). - Specifies the geometric shape of the feature to add. - Specifies the label of the feature. - Specifies the operation to use to build the feature. - Specifies the array that holds the label of every feature to use to construct the feature. - Specifies the array that holds the index of every subfeature to use to construct the feature. - Specifies the size of the arrays that hold the information that will be used to construct the feature ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a feature to, or modify a feature of, the metrology template of a metrology context. - Specifies the identifier of the metrology context containing the template. - Specifies the type of feature to add ( M_CONSTRUCTED or M_MEASURED) or specifies to modify a feature ( M_MODIFY). - Specifies the geometric shape of the feature to add. - Specifies the label of the feature. - Specifies the operation to use to build the feature. - Specifies the array that holds the label of every feature to use to construct the feature. - Specifies the array that holds the index of every subfeature to use to construct the feature. - Specifies the size of the arrays that hold the information that will be used to construct the feature ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a feature to, or modify a feature of, the metrology template of a metrology context. - Specifies the identifier of the metrology context containing the template. - Specifies the type of feature to add ( M_CONSTRUCTED or M_MEASURED) or specifies to modify a feature ( M_MODIFY). - Specifies the geometric shape of the feature to add. - Specifies the label of the feature. - Specifies the operation to use to build the feature. - Specifies the array that holds the label of every feature to use to construct the feature. - Specifies the array that holds the index of every subfeature to use to construct the feature. - Specifies the size of the arrays that hold the information that will be used to construct the feature ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a geometric tolerance to or modify a geometric tolerance of the metrology template of the metrology context. - Specifies the identifier of the metrology context. - Specifies the type of geometric tolerance to add. - Specifies the label of the target tolerance. - Specifies the minimum value of the geometric tolerance. - Specifies the maximum value of the geometric tolerance. - Specifies the array that holds the label values of the features whose relationship to validate. - Specifies the array that holds the index values of the multiple features' subfeatures whose relationship the added tolerance will validate. - Specifies the size of the arrays that hold the information that will be used to add the geometric tolerance ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a geometric tolerance to or modify a geometric tolerance of the metrology template of the metrology context. - Specifies the identifier of the metrology context. - Specifies the type of geometric tolerance to add. - Specifies the label of the target tolerance. - Specifies the minimum value of the geometric tolerance. - Specifies the maximum value of the geometric tolerance. - Specifies the array that holds the label values of the features whose relationship to validate. - Specifies the array that holds the index values of the multiple features' subfeatures whose relationship the added tolerance will validate. - Specifies the size of the arrays that hold the information that will be used to add the geometric tolerance ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a geometric tolerance to or modify a geometric tolerance of the metrology template of the metrology context. - Specifies the identifier of the metrology context. - Specifies the type of geometric tolerance to add. - Specifies the label of the target tolerance. - Specifies the minimum value of the geometric tolerance. - Specifies the maximum value of the geometric tolerance. - Specifies the array that holds the label values of the features whose relationship to validate. - Specifies the array that holds the index values of the multiple features' subfeatures whose relationship the added tolerance will validate. - Specifies the size of the arrays that hold the information that will be used to add the geometric tolerance ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a geometric tolerance to or modify a geometric tolerance of the metrology template of the metrology context. - Specifies the identifier of the metrology context. - Specifies the type of geometric tolerance to add. - Specifies the label of the target tolerance. - Specifies the minimum value of the geometric tolerance. - Specifies the maximum value of the geometric tolerance. - Specifies the array that holds the label values of the features whose relationship to validate. - Specifies the array that holds the index values of the multiple features' subfeatures whose relationship the added tolerance will validate. - Specifies the size of the arrays that hold the information that will be used to add the geometric tolerance ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a geometric tolerance to or modify a geometric tolerance of the metrology template of the metrology context. - Specifies the identifier of the metrology context. - Specifies the type of geometric tolerance to add. - Specifies the label of the target tolerance. - Specifies the minimum value of the geometric tolerance. - Specifies the maximum value of the geometric tolerance. - Specifies the array that holds the label values of the features whose relationship to validate. - Specifies the array that holds the index values of the multiple features' subfeatures whose relationship the added tolerance will validate. - Specifies the size of the arrays that hold the information that will be used to add the geometric tolerance ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a geometric tolerance to or modify a geometric tolerance of the metrology template of the metrology context. - Specifies the identifier of the metrology context. - Specifies the type of geometric tolerance to add. - Specifies the label of the target tolerance. - Specifies the minimum value of the geometric tolerance. - Specifies the maximum value of the geometric tolerance. - Specifies the array that holds the label values of the features whose relationship to validate. - Specifies the array that holds the index values of the multiple features' subfeatures whose relationship the added tolerance will validate. - Specifies the size of the arrays that hold the information that will be used to add the geometric tolerance ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a geometric tolerance to or modify a geometric tolerance of the metrology template of the metrology context. - Specifies the identifier of the metrology context. - Specifies the type of geometric tolerance to add. - Specifies the label of the target tolerance. - Specifies the minimum value of the geometric tolerance. - Specifies the maximum value of the geometric tolerance. - Specifies the array that holds the label values of the features whose relationship to validate. - Specifies the array that holds the index values of the multiple features' subfeatures whose relationship the added tolerance will validate. - Specifies the size of the arrays that hold the information that will be used to add the geometric tolerance ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a geometric tolerance to or modify a geometric tolerance of the metrology template of the metrology context. - Specifies the identifier of the metrology context. - Specifies the type of geometric tolerance to add. - Specifies the label of the target tolerance. - Specifies the minimum value of the geometric tolerance. - Specifies the maximum value of the geometric tolerance. - Specifies the array that holds the label values of the features whose relationship to validate. - Specifies the array that holds the index values of the multiple features' subfeatures whose relationship the added tolerance will validate. - Specifies the size of the arrays that hold the information that will be used to add the geometric tolerance ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a geometric tolerance to or modify a geometric tolerance of the metrology template of the metrology context. - Specifies the identifier of the metrology context. - Specifies the type of geometric tolerance to add. - Specifies the label of the target tolerance. - Specifies the minimum value of the geometric tolerance. - Specifies the maximum value of the geometric tolerance. - Specifies the array that holds the label values of the features whose relationship to validate. - Specifies the array that holds the index values of the multiple features' subfeatures whose relationship the added tolerance will validate. - Specifies the size of the arrays that hold the information that will be used to add the geometric tolerance ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate a metrology context or a derived metrology region object. - Specifies the system on which to allocate the metrology context or the derived metrology region object. - Specifies whether to allocate a metrology context or a derived metrology region object. - Specifies the address of the variable in which to write the identifier of the metrology context or the derived metrology region object. - The returned value is the identifier of the metrology context or the derived metrology region object if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a metrology context or a derived metrology region object. - Specifies the system on which to allocate the metrology context or the derived metrology region object. - Specifies whether to allocate a metrology context or a derived metrology region object. - Specifies the address of the variable in which to write the identifier of the metrology context or the derived metrology region object. - The returned value is the identifier of the metrology context or the derived metrology region object if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a metrology result buffer. - Specifies the system on which to allocate the metrology result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the metrology result buffer identifier. - The returned value is the metrology result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a metrology result buffer. - Specifies the system on which to allocate the metrology result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the metrology result buffer identifier. - The returned value is the metrology result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Calculate features and validate geometric tolerances. - Specifies the identifier of the metrology context. - Specifies the identifier of the target image buffer from which to extract edges to calculate physically measured features and validate geometric tolerances. - Specifies the metrology result buffer in which to write the results of the calculation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Control a setting for a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer whose settings you want to control. - Specifies to control the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control a setting for a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer whose settings you want to control. - Specifies to control the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of control to set. - Specifies the required value for the control. - - - Draw specific features or tolerances of a metrology context or of a metrology result. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the metrology result buffer or context from which to extract the features to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of drawing operation to perform. This parameter can be set to the following values: - Specifies the label or index of the result in the metrology result buffer for which to perform the drawing operation, or specifies that you are performing a general drawing operation for the metrology context. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a metrology context, a derived metrology region object, or a metrology result buffer. - Specifies the identifier of the metrology context, derived metrology region object, or metrology result buffer to free. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Set or retrieve the name of a feature or tolerance, or retrieve the label or index of a specified feature or tolerance. - Specifies the identifier of the metrology context or result buffer containing the feature or tolerance to read or modify. The metrology context or the metrology result buffer must have been previously allocated on the required system using MmetAlloc or MmetAllocResult, respectively. - Specifies the type of operation to perform. - Specifies the label or index value of the metrology feature or tolerance. - Specifies the name to set or retrieve, depending on the Operation parameter. - Specifies the address at which to write the requested information. - Reserved for future expansion and must be set to M_DEFAULT . - - - Set or retrieve the name of a feature or tolerance, or retrieve the label or index of a specified feature or tolerance. - Specifies the identifier of the metrology context or result buffer containing the feature or tolerance to read or modify. The metrology context or the metrology result buffer must have been previously allocated on the required system using MmetAlloc or MmetAllocResult, respectively. - Specifies the type of operation to perform. - Specifies the label or index value of the metrology feature or tolerance. - Specifies the name to set or retrieve, depending on the Operation parameter. - Specifies the address at which to write the requested information. - Reserved for future expansion and must be set to M_DEFAULT . - - - Set or retrieve the name of a feature or tolerance, or retrieve the label or index of a specified feature or tolerance. - Specifies the identifier of the metrology context or result buffer containing the feature or tolerance to read or modify. The metrology context or the metrology result buffer must have been previously allocated on the required system using MmetAlloc or MmetAllocResult, respectively. - Specifies the type of operation to perform. - Specifies the label or index value of the metrology feature or tolerance. - Specifies the name to set or retrieve, depending on the Operation parameter. - Specifies the address at which to write the requested information. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Restore a metrology context from disk. - Specifies the name and path of the file from which to restore the metrology context. - Specifies the system on which to restore the metrology context. - Specifies whether to restore, from the metrology context, the camera calibration context associated with the template reference. - Specifies the address of the variable in which to write the metrology context identifier. - The returned value is the metrology context identifier. If allocation fails, M_NULL is returned. - - - Restore a metrology context from disk. - Specifies the name and path of the file from which to restore the metrology context. - Specifies the system on which to restore the metrology context. - Specifies whether to restore, from the metrology context, the camera calibration context associated with the template reference. - Specifies the address of the variable in which to write the metrology context identifier. - The returned value is the metrology context identifier. If allocation fails, M_NULL is returned. - - - Save a metrology context to a file. - Specifies the name and path of the file in which to save the metrology context. - Specifies the identifier of the metrology context to save. - Specifies whether to save, with the metrology context, the camera calibration context associated with the template reference. - - - Save a metrology context to a file. - Specifies the name and path of the file in which to save the metrology context. - Specifies the identifier of the metrology context to save. - Specifies whether to save, with the metrology context, the camera calibration context associated with the template reference. - - - Set the position of a feature. - Specifies the identifier of the metrology context. - Specifies the label or index of the feature you want to position. Set this parameter to one of the following values. - Specifies the type of transformation that will be used to set the new position of the feature. - Specifies an attribute of the position to set. - Specifies an attribute of the position to set. - Specifies an attribute of the position to set. - Specifies an attribute of the position to set. - Reserved for future expansion and must be set to M_DEFAULT . - - - Set the position of a feature. - Specifies the identifier of the metrology context. - Specifies the label or index of the feature you want to position. Set this parameter to one of the following values. - Specifies the type of transformation that will be used to set the new position of the feature. - Specifies an attribute of the position to set. - Specifies an attribute of the position to set. - Specifies an attribute of the position to set. - Specifies an attribute of the position to set. - Reserved for future expansion and must be set to M_DEFAULT . - - - Set the metrology region that delimits the area from which to establish the feature. - Specifies the identifier of the metrology context containing the template in which to set the metrology region. - Specifies the label or index of the feature that will be established from the area delimited by the metrology region. Set this parameter to one of the following values. - Specifies the label or index of the reference frame feature of the feature for which you are specifying a metrology region. - Specifies the geometric shape of the metrology region. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - - - Set the metrology region that delimits the area from which to establish the feature. - Specifies the identifier of the metrology context containing the template in which to set the metrology region. - Specifies the label or index of the feature that will be established from the area delimited by the metrology region. Set this parameter to one of the following values. - Specifies the label or index of the reference frame feature of the feature for which you are specifying a metrology region. - Specifies the geometric shape of the metrology region. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - - - Load, restore, or save a MIL metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the metrology context. - Specifies the MIL version of the metrology context. - Specifies whether to restore, from the file or memory stream, the camera calibration context associated with the template reference, or specifies to save, with the metrology context, the camera calibration context associated with the template reference. - Specifies the address of the variable in which to write or from which to read the identifier of the metrology context. - Specifies the address of the variable in which to write the size of the metrology context, in bytes. - - - Load, restore, or save a MIL metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the metrology context. - Specifies the MIL version of the metrology context. - Specifies whether to restore, from the file or memory stream, the camera calibration context associated with the template reference, or specifies to save, with the metrology context, the camera calibration context associated with the template reference. - Specifies the address of the variable in which to write or from which to read the identifier of the metrology context. - Specifies the address of the variable in which to write the size of the metrology context, in bytes. - - - Load, restore, or save a MIL metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the metrology context. - Specifies the MIL version of the metrology context. - Specifies whether to restore, from the file or memory stream, the camera calibration context associated with the template reference, or specifies to save, with the metrology context, the camera calibration context associated with the template reference. - Specifies the address of the variable in which to write or from which to read the identifier of the metrology context. - Specifies the address of the variable in which to write the size of the metrology context, in bytes. - - - Load, restore, or save a MIL metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the metrology context. - Specifies the MIL version of the metrology context. - Specifies whether to restore, from the file or memory stream, the camera calibration context associated with the template reference, or specifies to save, with the metrology context, the camera calibration context associated with the template reference. - Specifies the address of the variable in which to write or from which to read the identifier of the metrology context. - Specifies the address of the variable in which to write the size of the metrology context, in bytes. - - - Load, restore, or save a MIL metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the metrology context. - Specifies the MIL version of the metrology context. - Specifies whether to restore, from the file or memory stream, the camera calibration context associated with the template reference, or specifies to save, with the metrology context, the camera calibration context associated with the template reference. - Specifies the address of the variable in which to write or from which to read the identifier of the metrology context. - Specifies the address of the variable in which to write the size of the metrology context, in bytes. - - - Load, restore, or save a MIL metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the metrology context. - Specifies the MIL version of the metrology context. - Specifies whether to restore, from the file or memory stream, the camera calibration context associated with the template reference, or specifies to save, with the metrology context, the camera calibration context associated with the template reference. - Specifies the address of the variable in which to write or from which to read the identifier of the metrology context. - Specifies the address of the variable in which to write the size of the metrology context, in bytes. - - - Allocate a Model Finder context. - Specifies the system on which to allocate the context. This parameter should be set to one of the following values: - Specifies the type of Model Finder context. This parameter must be set to one of the following values: - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Model Finder context identifier. - The returned value is the Model Finder context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Model Finder context. - Specifies the system on which to allocate the context. This parameter should be set to one of the following values: - Specifies the type of Model Finder context. This parameter must be set to one of the following values: - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Model Finder context identifier. - The returned value is the Model Finder context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Model Finder result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. This parameter should be set to one of the following values: - Specifies the address of the variable in which to write the Model Finder result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Model Finder result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. This parameter should be set to one of the following values: - Specifies the address of the variable in which to write the Model Finder result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a Model Finder context, individual model setting, or Model Finder result buffer setting. - Specifies the Model Finder context or Model Finder result buffer whose settings you want to modify. - Specifies that the Model Finder context, an individual model, or a Model Finder result buffer is controlled. - Specifies the setting to change. - Specifies the setting's new value. - - - Control a Model Finder context, individual model setting, or Model Finder result buffer setting. - Specifies the Model Finder context or Model Finder result buffer whose settings you want to modify. - Specifies that the Model Finder context, an individual model, or a Model Finder result buffer is controlled. - Specifies the setting to change. - Specifies the setting's new value. - - - Add a model to, or delete a model from, a Model Finder context. - Specifies the Model Finder context to which to add, or from which to delete, the model. - Specifies the type of model to define when adding models to the context, or specifies to delete a model from the Model Finder context. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - - - Add a model to, or delete a model from, a Model Finder context. - Specifies the Model Finder context to which to add, or from which to delete, the model. - Specifies the type of model to define when adding models to the context, or specifies to delete a model from the Model Finder context. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - - - Defines a model from a file and adds it to a Model Finder context. - Specifies the identifier of the Model Finder context. - Specifies the type of file from which to define the model. - Specifies the name and path of the file from which to define the model. - Reserved for future expansion. Set this parameter to M_DEFAULT . - - - Draw specific features of models or result occurrences an image buffer or 2D graphics list. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the Model Finder context or result buffer from which to extract the features to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Specifies the index of the model in the specified Model Finder context, or of the result occurrence. - Specifies where in the destination image buffer to draw. - - - Search for the model(s) that are in the specified Model Finder context in a target image buffer, Edge Finder result buffer, or M_SHAPE_SEGMENT Model Finder result buffer. - Specifies the Model Finder context to use for the search. - Specifies the target image, Edge Finder result buffer, or M_SHAPE_SEGMENT Model Finder result buffer in which to search for the model(s). - Specifies the result buffer in which to write the results of the search. If you are using an M_SHAPE_... type of Model Finder context, you need to specify a corresponding M_SHAPE_... type of Model Finder result buffer. - - - Free a Model Finder context or a result buffer. - Specifies the identifier of the Model Finder context or result buffer to free. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Mask regions of a model. - Specifies the Model Finder context of the model to mask. - Specifies the individual model for which to create a mask. - Specifies the identifier of the image buffer used to identify the masked pixels in the model. - Specifies which type of mask to employ. - Reserved for future expansion and must be set to M_DEFAULT . - - - Preprocess a Model Finder context. - Specifies the Model Finder context of the model to preprocess. - Specifies whether to perform or undo the preprocessing of the model context. - - - Restore a Model Finder context from disk. - Specifies the name and path of the file from which to restore the Model Finder context. - Specifies the system on which to restore the Model Finder context. - Specifies whether to restore, from the Model Finder context, the camera calibration contexts associated with the models. - Specifies the address of the variable in which to write the Model Finder context identifier. - The returned value is the Model Finder context identifier. If allocation fails, M_NULL is returned. - - - Restore a Model Finder context from disk. - Specifies the name and path of the file from which to restore the Model Finder context. - Specifies the system on which to restore the Model Finder context. - Specifies whether to restore, from the Model Finder context, the camera calibration contexts associated with the models. - Specifies the address of the variable in which to write the Model Finder context identifier. - The returned value is the Model Finder context identifier. If allocation fails, M_NULL is returned. - - - Save a Model Finder context to a file. - Specifies the name and path of the file in which to save the Model Finder context; it is recommended that you use the MMF file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the Model Finder context to save. - Specifies whether to save, with the Model Finder context, the camera calibration contexts associated with the models. - - - Save a Model Finder context to a file. - Specifies the name and path of the file in which to save the Model Finder context; it is recommended that you use the MMF file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the Model Finder context to save. - Specifies whether to save, with the Model Finder context, the camera calibration contexts associated with the models. - - - Load, restore, or save a Model Finder context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Model Finder context. - Specifies the operation to perform on the Model Finder context. - Specifies the type of stream in which to store/from which to restore the Model Finder context. - Specifies the MIL version of the Model Finder context. - Specifies whether to restore, from the file or memory stream, the camera calibration contexts associated with the models, or specifies to save, with the Model Finder context, the camera calibration contexts associated with the models. - Specifies the address of the variable in which to write or from which to read the identifier of the Model Finder context. - Specifies the address of the variable in which to write the size of the Model Finder context, in bytes. - - - Load, restore, or save a Model Finder context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Model Finder context. - Specifies the operation to perform on the Model Finder context. - Specifies the type of stream in which to store/from which to restore the Model Finder context. - Specifies the MIL version of the Model Finder context. - Specifies whether to restore, from the file or memory stream, the camera calibration contexts associated with the models, or specifies to save, with the Model Finder context, the camera calibration contexts associated with the models. - Specifies the address of the variable in which to write or from which to read the identifier of the Model Finder context. - Specifies the address of the variable in which to write the size of the Model Finder context, in bytes. - - - Load, restore, or save a Model Finder context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Model Finder context. - Specifies the operation to perform on the Model Finder context. - Specifies the type of stream in which to store/from which to restore the Model Finder context. - Specifies the MIL version of the Model Finder context. - Specifies whether to restore, from the file or memory stream, the camera calibration contexts associated with the models, or specifies to save, with the Model Finder context, the camera calibration contexts associated with the models. - Specifies the address of the variable in which to write or from which to read the identifier of the Model Finder context. - Specifies the address of the variable in which to write the size of the Model Finder context, in bytes. - - - Load, restore, or save a Model Finder context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Model Finder context. - Specifies the operation to perform on the Model Finder context. - Specifies the type of stream in which to store/from which to restore the Model Finder context. - Specifies the MIL version of the Model Finder context. - Specifies whether to restore, from the file or memory stream, the camera calibration contexts associated with the models, or specifies to save, with the Model Finder context, the camera calibration contexts associated with the models. - Specifies the address of the variable in which to write or from which to read the identifier of the Model Finder context. - Specifies the address of the variable in which to write the size of the Model Finder context, in bytes. - - - Load, restore, or save a Model Finder context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Model Finder context. - Specifies the operation to perform on the Model Finder context. - Specifies the type of stream in which to store/from which to restore the Model Finder context. - Specifies the MIL version of the Model Finder context. - Specifies whether to restore, from the file or memory stream, the camera calibration contexts associated with the models, or specifies to save, with the Model Finder context, the camera calibration contexts associated with the models. - Specifies the address of the variable in which to write or from which to read the identifier of the Model Finder context. - Specifies the address of the variable in which to write the size of the Model Finder context, in bytes. - - - Load, restore, or save a Model Finder context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Model Finder context. - Specifies the operation to perform on the Model Finder context. - Specifies the type of stream in which to store/from which to restore the Model Finder context. - Specifies the MIL version of the Model Finder context. - Specifies whether to restore, from the file or memory stream, the camera calibration contexts associated with the models, or specifies to save, with the Model Finder context, the camera calibration contexts associated with the models. - Specifies the address of the variable in which to write or from which to read the identifier of the Model Finder context. - Specifies the address of the variable in which to write the size of the Model Finder context, in bytes. - - - Allocate a MIL utility object for a Distributed MIL publishing application. - Specifies the system on which to allocate the MIL utility object. - Specifies the type of MIL utility object to allocate. - Specifies the initialization of the MIL utility object. - Specifies the address in which to return the identifier of the allocated MIL utility object. Since MobjAlloc also returns the identifier, you can set this parameter to M_NULL . - The returned value is the MIL utility object identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL utility object for a Distributed MIL publishing application. - Specifies the system on which to allocate the MIL utility object. - Specifies the type of MIL utility object to allocate. - Specifies the initialization of the MIL utility object. - Specifies the address in which to return the identifier of the allocated MIL utility object. Since MobjAlloc also returns the identifier, you can set this parameter to M_NULL . - The returned value is the MIL utility object identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a MIL object's settings and associate information with a MIL object. - Specifies the identifier of the MIL object to control. The MIL object can be a MIL utility object (allocated using MobjAlloc) or any other MIL object, except for MIL objects allocated using MfuncAlloc. - Specifies the type of MIL object setting to control. - Specifies the MIL object setting's new value. - - - Control a MIL object's settings and associate information with a MIL object. - Specifies the identifier of the MIL object to control. The MIL object can be a MIL utility object (allocated using MobjAlloc) or any other MIL object, except for MIL objects allocated using MfuncAlloc. - Specifies the type of MIL object setting to control. - Specifies the MIL object setting's new value. - - - Control a MIL object's settings and associate information with a MIL object. - Specifies the identifier of the MIL object to control. The MIL object can be a MIL utility object (allocated using MobjAlloc) or any other MIL object, except for MIL objects allocated using MfuncAlloc. - Specifies the type of MIL object setting to control. - Specifies the MIL object setting's new value. - - - Free an object. - Specifies the identifier of the object. - - - Get information about a hook event. - Specifies the object-related event identifier received by the hook-handler function (see MobjHookFunction). - Specifies the type of information about which to inquire. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Hook a function to an object-related event. - Specifies the identifier of the object on which to hook a function. - Specifies the object-related event on which to hook the function. - Specifies the address of the function that should be called when the specified event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Inquire about a MIL object setting or information associated with the MIL object. - Specifies the identifier of the MIL object about which to inquire. The MIL object can be a MIL utility object (allocated using MobjAlloc) or any other MIL object, except for MIL objects allocated using MfuncAlloc. - Specifies the MIL object setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL object setting or information associated with the MIL object. - Specifies the identifier of the MIL object about which to inquire. The MIL object can be a MIL utility object (allocated using MobjAlloc) or any other MIL object, except for MIL objects allocated using MfuncAlloc. - Specifies the MIL object setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL object setting or information associated with the MIL object. - Specifies the identifier of the MIL object about which to inquire. The MIL object can be a MIL utility object (allocated using MobjAlloc) or any other MIL object, except for MIL objects allocated using MfuncAlloc. - Specifies the MIL object setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL object setting or information associated with the MIL object. - Specifies the identifier of the MIL object about which to inquire. The MIL object can be a MIL utility object (allocated using MobjAlloc) or any other MIL object, except for MIL objects allocated using MfuncAlloc. - Specifies the MIL object setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL object setting or information associated with the MIL object. - Specifies the identifier of the MIL object about which to inquire. The MIL object can be a MIL utility object (allocated using MobjAlloc) or any other MIL object, except for MIL objects allocated using MfuncAlloc. - Specifies the MIL object setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Reads data from a message sent to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable in which the message is to be written. - Specifies the size of the array pointed to by MessagePtr, in bytes. - Specifies the address of the variable in which the size of the message to be read will be written. - Specifies the address of the variable in which the message tag associated with the message will be written. - Specifies the address of the variable in which the status of the read operation will be written. - Specifies additional options for the read operation. - The returned value is the same as the value written in MessageOutSizePtr. - - - Reads data from a message sent to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable in which the message is to be written. - Specifies the size of the array pointed to by MessagePtr, in bytes. - Specifies the address of the variable in which the size of the message to be read will be written. - Specifies the address of the variable in which the message tag associated with the message will be written. - Specifies the address of the variable in which the status of the read operation will be written. - Specifies additional options for the read operation. - The returned value is the same as the value written in MessageOutSizePtr. - - - Reads data from a message sent to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable in which the message is to be written. - Specifies the size of the array pointed to by MessagePtr, in bytes. - Specifies the address of the variable in which the size of the message to be read will be written. - Specifies the address of the variable in which the message tag associated with the message will be written. - Specifies the address of the variable in which the status of the read operation will be written. - Specifies additional options for the read operation. - The returned value is the same as the value written in MessageOutSizePtr. - - - Reads data from a message sent to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable in which the message is to be written. - Specifies the size of the array pointed to by MessagePtr, in bytes. - Specifies the address of the variable in which the size of the message to be read will be written. - Specifies the address of the variable in which the message tag associated with the message will be written. - Specifies the address of the variable in which the status of the read operation will be written. - Specifies additional options for the read operation. - The returned value is the same as the value written in MessageOutSizePtr. - - - Reads data from a message sent to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable in which the message is to be written. - Specifies the size of the array pointed to by MessagePtr, in bytes. - Specifies the address of the variable in which the size of the message to be read will be written. - Specifies the address of the variable in which the message tag associated with the message will be written. - Specifies the address of the variable in which the status of the read operation will be written. - Specifies additional options for the read operation. - The returned value is the same as the value written in MessageOutSizePtr. - - - Reads data from a message sent to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable in which the message is to be written. - Specifies the size of the array pointed to by MessagePtr, in bytes. - Specifies the address of the variable in which the size of the message to be read will be written. - Specifies the address of the variable in which the message tag associated with the message will be written. - Specifies the address of the variable in which the status of the read operation will be written. - Specifies additional options for the read operation. - The returned value is the same as the value written in MessageOutSizePtr. - - - Reads data from a message sent to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable in which the message is to be written. - Specifies the size of the array pointed to by MessagePtr, in bytes. - Specifies the address of the variable in which the size of the message to be read will be written. - Specifies the address of the variable in which the message tag associated with the message will be written. - Specifies the address of the variable in which the status of the read operation will be written. - Specifies additional options for the read operation. - The returned value is the same as the value written in MessageOutSizePtr. - - - Reads data from a message sent to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable in which the message is to be written. - Specifies the size of the array pointed to by MessagePtr, in bytes. - Specifies the address of the variable in which the size of the message to be read will be written. - Specifies the address of the variable in which the message tag associated with the message will be written. - Specifies the address of the variable in which the status of the read operation will be written. - Specifies additional options for the read operation. - The returned value is the same as the value written in MessageOutSizePtr. - - - Writes a message to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable of the user message to write. - Specifies the length of the message to write, in Bytes. - Specifies a user-defined tag to send with the message. - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate an OCR font context. - Specifies the system on which to allocate the OCR font context. - Specifies the OCR font context type and the type of its font. - Specifies how many characters can be stored in the OCR font context. - Specifies the width of the characters in the OCR font context, in pixels. - Specifies the height of the characters in the OCR font context, in pixels. - Specifies the distance between the edge of each character and their surrounding cell, along the X-axis, in pixels. - Specifies the distance between the edge of each character and their surrounding cell, along the Y-axis, in pixels. - Specifies the width of the widest character in the font without its surrounding cell, in pixels. - Specifies the height of the tallest character in the font without its surrounding cell, in pixels. - Specifies the maximum thickness (stroke width) of the characters in the OCR font context. - Specifies the maximum length of the string that can be read or verified using the OCR font context. - Specifies whether the characters are brighter than the background. - Specifies the address of the variable to which the OCR font context identifier is to be written. - The returned value is the OCR font context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an OCR font context. - Specifies the system on which to allocate the OCR font context. - Specifies the OCR font context type and the type of its font. - Specifies how many characters can be stored in the OCR font context. - Specifies the width of the characters in the OCR font context, in pixels. - Specifies the height of the characters in the OCR font context, in pixels. - Specifies the distance between the edge of each character and their surrounding cell, along the X-axis, in pixels. - Specifies the distance between the edge of each character and their surrounding cell, along the Y-axis, in pixels. - Specifies the width of the widest character in the font without its surrounding cell, in pixels. - Specifies the height of the tallest character in the font without its surrounding cell, in pixels. - Specifies the maximum thickness (stroke width) of the characters in the OCR font context. - Specifies the maximum length of the string that can be read or verified using the OCR font context. - Specifies whether the characters are brighter than the background. - Specifies the address of the variable to which the OCR font context identifier is to be written. - The returned value is the OCR font context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an OCR result buffer. - Specifies the system on which to allocate the OCR result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable to which the OCR result buffer identifier is to be written. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an OCR result buffer. - Specifies the system on which to allocate the OCR result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable to which the OCR result buffer identifier is to be written. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Calibrate the OCR font context's character size and target spacing to match the characters in a sample target image. - Specifies the identifier of the sample target image buffer. - Specifies the identifier of the OCR font context to be calibrated. - Specifies the character string present in the sample target image. This string must be null-terminated. - Specifies the minimum width of the characters in the sample target image, in pixels. - Specifies the maximum width of the characters in the sample target image, in pixels. - Specifies the increment to use when searching for the character width between TargetCharSizeXMin and TargetCharSizeXMax. Note that very small step sizes should only be used within small ranges, otherwise application performance can be adversely affected. - Specifies the minimum height of the characters in the sample target image, in pixels. - Specifies the maximum height of the characters in the sample target image, in pixels. - Specifies the increment to use when searching for the character height between TargetCharSizeYMin and TargetCharSizeYMax. Note that very small step sizes should only be used within small ranges, otherwise application performance can be adversely affected. - Specifies the operation to be performed. - - - Control an OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer to control. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control an OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer to control. - Specifies the type of control to set. - Specifies the required value for the control. - - - Copy a font character to or from an image buffer. - Specifies the identifier of the image buffer to/from which characters are copied. - Specifies the identifier of the OCR font context to/from which the characters are copied. - Specifies the direction of the copy operation. - Specifies a string containing the list of characters to be copied. - - - Copy a font character to or from an image buffer. - Specifies the identifier of the image buffer to/from which characters are copied. - Specifies the identifier of the OCR font context to/from which the characters are copied. - Specifies the direction of the copy operation. - - - Copy a font character to or from an image buffer. - Specifies the identifier of the image buffer to/from which characters are copied. - Specifies the identifier of the OCR font context to/from which the characters are copied. - Specifies the direction of the copy operation. - Specifies a string containing the list of characters to be copied. - - - Draw specific features of OCR fonts or OCR result occurrences in an image buffer or 2D graphics list. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the OCR Font context or result buffer from which to extract the features to draw. The OCR Font context or result buffer must have been previously allocated using MocrAllocFont or MocrAllocResult. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies a string containing a list of valid characters to draw when drawing an OCR font. To draw all the characters in the font or to draw results, this parameter should be set to M_NULL . - Reserved for future expansion and must be set to M_DEFAULT . - - - Draw specific features of OCR fonts or OCR result occurrences in an image buffer or 2D graphics list. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the OCR Font context or result buffer from which to extract the features to draw. The OCR Font context or result buffer must have been previously allocated using MocrAllocFont or MocrAllocResult. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies a string containing a list of valid characters to draw when drawing an OCR font. To draw all the characters in the font or to draw results, this parameter should be set to M_NULL . - Reserved for future expansion and must be set to M_DEFAULT . - - - Free an OCR font or result buffer. - Specifies the identifier of the OCR font context, or result buffer to free. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Hook a function to an event. - Specifies the identifier of the font. - Specifies the event type. - Specifies the address of the function that should be called when the event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - This function returns a NULLpointer. - - - Import character representations into an OCR font context. - Specifies the name and path of the file from which to import the character representation. - Specifies how the data is stored in the file. This parameter can be set to one of the following values: - Specifies the type of import operation to be performed. This parameter must be set to the following value: - Specifies the ASCII characters to associate with the font character representations in the file. This parameter can be set to one of the following values: - Specifies the identifier of the OCR font context. - - - Import character representations into an OCR font context. - Specifies the name and path of the file from which to import the character representation. - Specifies how the data is stored in the file. This parameter can be set to one of the following values: - Specifies the type of import operation to be performed. This parameter must be set to the following value: - Specifies the ASCII characters to associate with the font character representations in the file. This parameter can be set to one of the following values: - Specifies the identifier of the OCR font context. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Invert or resize the font of an OCR font context to match the target image characters. - Specifies the identifier of the OCR font context to modify. - Specifies the type of operation to perform. - Specifies the interpolation mode for the function. - - - Preprocess an OCR font context. - Specifies the OCR font context identifier. - Specifies the type of operation to perform. This parameter must be set to the following value. - - - Read an unknown string from a target image. - Specifies the identifier of the image which contains the string to be read. - Specifies the identifier of the OCR font context to use to read the string from the target image. - Specifies the OCR result buffer in which to place results of the read operation. - - - Restore an OCR font context, font constraint data, or control data from file. - Specifies the path and name of the file from which to restore the MIL OCR font context (for example, "C:\mydirectory\myfile"). - Specifies which type of OCR font context data to restore. - Specifies the system on which the OCR font context is allocated. - Specifies the address of the variable to/from which the font identifier is to be written/read. - Returns the identifier of the existing or newly allocated OCR font context. If allocation fails, M_NULL is returned as the identifier. - - - Restore an OCR font context, font constraint data, or control data from file. - Specifies the path and name of the file from which to restore the MIL OCR font context (for example, "C:\mydirectory\myfile"). - Specifies which type of OCR font context data to restore. - Specifies the system on which the OCR font context is allocated. - Specifies the address of the variable to/from which the font identifier is to be written/read. - Returns the identifier of the existing or newly allocated OCR font context. If allocation fails, M_NULL is returned as the identifier. - - - Save an existing OCR font context to disk. - Specifies the name and path of the file in which to save the font data. - Specifies which data to save to disk. - Specifies the OCR font context to be saved. - - - Save an existing OCR font context to disk. - Specifies the name and path of the file in which to save the font data. - Specifies which data to save to disk. - Specifies the OCR font context to be saved. - - - Set character position constraints. - Specifies the OCR font context identifier with which to associate the constraints. - Specifies the character position in the string for which a constraint is being set. - Specifies the type of character that can appear at the specified string position. - Specifies that any character matching the given CharPosType will be accepted as valid, or explicitly lists valid characters for the specified position. - - - Set character position constraints. - Specifies the OCR font context identifier with which to associate the constraints. - Specifies the character position in the string for which a constraint is being set. - Specifies the type of character that can appear at the specified string position. - - - Set character position constraints. - Specifies the OCR font context identifier with which to associate the constraints. - Specifies the character position in the string for which a constraint is being set. - Specifies the type of character that can appear at the specified string position. - Specifies that any character matching the given CharPosType will be accepted as valid, or explicitly lists valid characters for the specified position. - - - Load, restore, or save an OCR font context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the OCR font context. - Specifies the operation to perform on the OCR font context. - Specifies the type of stream in which to store/from which to restore the OCR font context. - Specifies the MIL version of the OCR font context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the OCR font context. - Specifies the address of the variable in which to write the size of the OCR font context, in bytes. - - - Load, restore, or save an OCR font context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the OCR font context. - Specifies the operation to perform on the OCR font context. - Specifies the type of stream in which to store/from which to restore the OCR font context. - Specifies the MIL version of the OCR font context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the OCR font context. - Specifies the address of the variable in which to write the size of the OCR font context, in bytes. - - - Load, restore, or save an OCR font context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the OCR font context. - Specifies the operation to perform on the OCR font context. - Specifies the type of stream in which to store/from which to restore the OCR font context. - Specifies the MIL version of the OCR font context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the OCR font context. - Specifies the address of the variable in which to write the size of the OCR font context, in bytes. - - - Load, restore, or save an OCR font context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the OCR font context. - Specifies the operation to perform on the OCR font context. - Specifies the type of stream in which to store/from which to restore the OCR font context. - Specifies the MIL version of the OCR font context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the OCR font context. - Specifies the address of the variable in which to write the size of the OCR font context, in bytes. - - - Load, restore, or save an OCR font context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the OCR font context. - Specifies the operation to perform on the OCR font context. - Specifies the type of stream in which to store/from which to restore the OCR font context. - Specifies the MIL version of the OCR font context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the OCR font context. - Specifies the address of the variable in which to write the size of the OCR font context, in bytes. - - - Load, restore, or save an OCR font context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the OCR font context. - Specifies the operation to perform on the OCR font context. - Specifies the type of stream in which to store/from which to restore the OCR font context. - Specifies the MIL version of the OCR font context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the OCR font context. - Specifies the address of the variable in which to write the size of the OCR font context, in bytes. - - - Verify a known string in an image. - Specifies the identifier of the target image containing the string to be verified. - Specifies the identifier of the OCR font context to use to verify the string in the target image. - Specifies the character string to be verified in the sample target image. - Specifies the OCR result buffer in which to place the verification results. - - - Allocate a Pattern Matching context. - Specifies the system on which to allocate the Pattern Matching context. - Specifies the type of Pattern Matching context. - Reserved for future expansion. - Specifies the address in which to write the Pattern Matching context identifier. - The returned value is the Pattern Matching context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Pattern Matching context. - Specifies the system on which to allocate the Pattern Matching context. - Specifies the type of Pattern Matching context. - Reserved for future expansion. - Specifies the address in which to write the Pattern Matching context identifier. - The returned value is the Pattern Matching context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Pattern Matching result buffer. - Specifies the system on which to allocate the result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Pattern Matching result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Pattern Matching result buffer. - Specifies the system on which to allocate the result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Pattern Matching result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a setting of a Pattern Matching context, one or all models, or Pattern Matching result buffer. - Specifies the Pattern Matching context or Pattern Matching result buffer whose settings you want to modify. - Specifies to control a Pattern Matching context, an individual model, or a Pattern Matching result buffer. - Specifies the setting to change. - Specifies the setting's new value. - - - Control a setting of a Pattern Matching context, one or all models, or Pattern Matching result buffer. - Specifies the Pattern Matching context or Pattern Matching result buffer whose settings you want to modify. - Specifies to control a Pattern Matching context, an individual model, or a Pattern Matching result buffer. - Specifies the setting to change. - Specifies the setting's new value. - - - Add one or more models to, or delete a model from, a Pattern Matching context. - Specifies the Pattern Matching context to which to add, or from which to delete, the model. - Specifies the type of the model to define when adding models to the context, or specifies to delete a model from the Pattern Matching context. - Specifies the identifier of the image buffer from which to define the models, or the Pattern Matching context from which to copy a model. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies the speed of the allocation or the interpolation mode to use, depending on the model type chosen. - - - Draw specific features of the model or result occurrence in an image buffer or 2D graphics list. - Specifies the identifier of the 2D graphics context to use. This parameter must be set to one of the following values: - Specifies the Pattern Matching context or result buffer identifier from which to extract the features to draw. - Specifies the identifier of the destination image buffer or 2D graphics list into which to draw. - Specifies the type of operation to perform. - Specifies whether to draw a specific result occurrence or model, or to draw all of them. - Specifies where to draw a model. - - - Find a pattern matching model(s) in the target image buffer. - Specifies the Pattern Matching context identifier to use when finding the search model in the target image. - Specifies the identifier of the target image. - Specifies the identifier of the pattern matching result buffer in which to store results. - - - Free a Pattern Matching context or a result buffer. - Specifies the identifier of the Pattern Matching context or result buffer to free. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies that information will be inquired about the Pattern Matching context, an individual model, or a Pattern Matching result buffer. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies that information will be inquired about the Pattern Matching context, an individual model, or a Pattern Matching result buffer. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies that information will be inquired about the Pattern Matching context, an individual model, or a Pattern Matching result buffer. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies that information will be inquired about the Pattern Matching context, an individual model, or a Pattern Matching result buffer. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies that information will be inquired about the Pattern Matching context, an individual model, or a Pattern Matching result buffer. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies that information will be inquired about the Pattern Matching context, an individual model, or a Pattern Matching result buffer. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Mask areas of a model in a Pattern Matching context. - Specifies the identifier of the Pattern Matching context containing the model to mask. - Specifies the individual model on which to apply the mask. - Specifies the identifier of the image buffer to use as a mask. - Specifies which type of mask to employ. - Reserved for future expansion. - - - Preprocess a Pattern Matching context. - Specifies the identifier of the Pattern Matching context to preprocess. - Reserved for future expansion. Set this parameter to M_DEFAULT . - Specifies the identifier of a typical target image. - - - Restore a Pattern Matching context from disk. - Specifies the name and path of the file from which to restore the model. - Specifies the system on which to restore the model. - Reserved for future expansion. - Specifies the address of the variable in which to write the Pattern Matching context identifier. - The returned value is the Pattern Matching context identifier. If allocation fails, M_NULL is returned. - - - Restore a Pattern Matching context from disk. - Specifies the name and path of the file from which to restore the model. - Specifies the system on which to restore the model. - Reserved for future expansion. - Specifies the address of the variable in which to write the Pattern Matching context identifier. - The returned value is the Pattern Matching context identifier. If allocation fails, M_NULL is returned. - - - Save a Pattern Matching context to disk. - Specifies the name and path of the file in which to save the model. - Specifies the identifier of the Pattern Matching context to save. - Reserved for future expansion. - - - Save a Pattern Matching context to disk. - Specifies the name and path of the file in which to save the model. - Specifies the identifier of the Pattern Matching context to save. - Reserved for future expansion. - - - Load, restore, or save a Pattern Matching context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Pattern Matching context. - Specifies the operation to perform on the Pattern Matching context. - Specifies the type of stream in which to store/from which to restore the Pattern Matching context. - Specifies the MIL version of the Pattern Matching context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the Pattern Matching context. - Specifies the address of the variable in which to write the size of the Pattern Matching context, in bytes. - - - Load, restore, or save a Pattern Matching context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Pattern Matching context. - Specifies the operation to perform on the Pattern Matching context. - Specifies the type of stream in which to store/from which to restore the Pattern Matching context. - Specifies the MIL version of the Pattern Matching context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the Pattern Matching context. - Specifies the address of the variable in which to write the size of the Pattern Matching context, in bytes. - - - Load, restore, or save a Pattern Matching context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Pattern Matching context. - Specifies the operation to perform on the Pattern Matching context. - Specifies the type of stream in which to store/from which to restore the Pattern Matching context. - Specifies the MIL version of the Pattern Matching context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the Pattern Matching context. - Specifies the address of the variable in which to write the size of the Pattern Matching context, in bytes. - - - Load, restore, or save a Pattern Matching context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Pattern Matching context. - Specifies the operation to perform on the Pattern Matching context. - Specifies the type of stream in which to store/from which to restore the Pattern Matching context. - Specifies the MIL version of the Pattern Matching context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the Pattern Matching context. - Specifies the address of the variable in which to write the size of the Pattern Matching context, in bytes. - - - Load, restore, or save a Pattern Matching context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Pattern Matching context. - Specifies the operation to perform on the Pattern Matching context. - Specifies the type of stream in which to store/from which to restore the Pattern Matching context. - Specifies the MIL version of the Pattern Matching context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the Pattern Matching context. - Specifies the address of the variable in which to write the size of the Pattern Matching context, in bytes. - - - Load, restore, or save a Pattern Matching context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Pattern Matching context. - Specifies the operation to perform on the Pattern Matching context. - Specifies the type of stream in which to store/from which to restore the Pattern Matching context. - Specifies the MIL version of the Pattern Matching context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the Pattern Matching context. - Specifies the address of the variable in which to write the size of the Pattern Matching context, in bytes. - - - Allocate a registration context. - Specifies the system on which to allocate the context. - Specifies the type of registration context. This parameter defines the registration operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the registration context identifier. - The returned value is the registration context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a registration context. - Specifies the system on which to allocate the context. - Specifies the type of registration context. This parameter defines the registration operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the registration context identifier. - The returned value is the registration context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a registration result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. This parameter should be set to one of the following values. - Specifies the address of the variable in which to write the registration result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a registration result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. This parameter should be set to one of the following values. - Specifies the address of the variable in which to write the registration result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Perform the registration operation specified by the registration context on the input images. - Specifies the context to use for the registration; this establishes the operation to perform. The context must have been allocated using MregAlloc. - Specifies the address of the array containing the buffer identifiers of the input images. - Specifies the identifier of the registration result buffer or image buffer in which to write the results of the registration operation. - Specifies the size of the specified image array. - Specifies the operation mode. - - - Perform the registration operation specified by the registration context on the input images. - Specifies the context to use for the registration; this establishes the operation to perform. The context must have been allocated using MregAlloc. - Specifies the address of the array containing the buffer identifiers of the input images. - Specifies the identifier of the registration result buffer or image buffer in which to write the results of the registration operation. - Specifies the size of the specified image array. - Specifies the operation mode. - - - Control a registration context, registration element, or registration result buffer setting. - Specifies the identifier of the registration context or registration result buffer whose settings you can modify; you can only control settings of correlation-stitching or photometric stereo types of registration result buffers. - Specifies that a registration context, an individual registration element (of a correlation-stitching or photometric stereo registration context), or a registration result buffer is controlled. - Specifies the setting to change. - Specifies the setting's new value. - - - Control a registration context, registration element, or registration result buffer setting. - Specifies the identifier of the registration context or registration result buffer whose settings you can modify; you can only control settings of correlation-stitching or photometric stereo types of registration result buffers. - Specifies that a registration context, an individual registration element (of a correlation-stitching or photometric stereo registration context), or a registration result buffer is controlled. - Specifies the setting to change. - Specifies the setting's new value. - - - Draw specific features of the registration results in an image buffer or 2D graphics list. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values. Note that while this parameter is required for calling MregDraw, when using an M_EXTENDED_DEPTH_OF_FIELD_RESULT result buffer, this parameter will not affect the function. - Specifies the identifier of the registration result buffer from which to extract the results to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. This parameter can be set to one of the following: - Specifies the registration element that is associated with the image whose features you want to draw when drawing results of an M_STITCHING_RESULT registration result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a registration context or a registration result buffer. - Specifies the identifier of the registration context or registration result buffer to free. - - - Get the specified type of result(s) from a registration result buffer. - Specifies the identifier of the registration result buffer from which to retrieve results. - Specifies which results to get. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - - - Get the specified type of result(s) from a registration result buffer. - Specifies the identifier of the registration result buffer from which to retrieve results. - Specifies which results to get. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - - - Get the specified type of result(s) from a registration result buffer. - Specifies the identifier of the registration result buffer from which to retrieve results. - Specifies which results to get. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - - - Get the specified type of result(s) from a registration result buffer. - Specifies the identifier of the registration result buffer from which to retrieve results. - Specifies which results to get. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - - - Get the specified type of result(s) from a registration result buffer. - Specifies the identifier of the registration result buffer from which to retrieve results. - Specifies which results to get. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - - - Get the specified type of result(s) from a registration result buffer. - Specifies the identifier of the registration result buffer from which to retrieve results. - Specifies which results to get. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - - - Get the specified type of result(s) from a registration result buffer. - Specifies the identifier of the registration result buffer from which to retrieve results. - Specifies which results to get. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - - - Get the specified type of result(s) from a registration result buffer. - Specifies the identifier of the registration result buffer from which to retrieve results. - Specifies which results to get. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - - - Get the specified type of result(s) from a registration result buffer. - Specifies the identifier of the registration result buffer from which to retrieve results. - Specifies which results to get. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - - - Get the specified type of result(s) from a registration result buffer. - Specifies the identifier of the registration result buffer from which to retrieve results. - Specifies which results to get. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - - - Inquire about a registration context, registration element, or registration result buffer setting. - Specifies the identifier of the registration context or registration result buffer about which to inquire. - Specifies that a registration context, an individual registration element (of a correlation-stitching or photometric stereo registration context), or a registration result buffer is inquired. - Specifies the setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a registration context, registration element, or registration result buffer setting. - Specifies the identifier of the registration context or registration result buffer about which to inquire. - Specifies that a registration context, an individual registration element (of a correlation-stitching or photometric stereo registration context), or a registration result buffer is inquired. - Specifies the setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a registration context, registration element, or registration result buffer setting. - Specifies the identifier of the registration context or registration result buffer about which to inquire. - Specifies that a registration context, an individual registration element (of a correlation-stitching or photometric stereo registration context), or a registration result buffer is inquired. - Specifies the setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a registration context, registration element, or registration result buffer setting. - Specifies the identifier of the registration context or registration result buffer about which to inquire. - Specifies that a registration context, an individual registration element (of a correlation-stitching or photometric stereo registration context), or a registration result buffer is inquired. - Specifies the setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a registration context, registration element, or registration result buffer setting. - Specifies the identifier of the registration context or registration result buffer about which to inquire. - Specifies that a registration context, an individual registration element (of a correlation-stitching or photometric stereo registration context), or a registration result buffer is inquired. - Specifies the setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a registration context, registration element, or registration result buffer setting. - Specifies the identifier of the registration context or registration result buffer about which to inquire. - Specifies that a registration context, an individual registration element (of a correlation-stitching or photometric stereo registration context), or a registration result buffer is inquired. - Specifies the setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a registration context, registration element, or registration result buffer setting. - Specifies the identifier of the registration context or registration result buffer about which to inquire. - Specifies that a registration context, an individual registration element (of a correlation-stitching or photometric stereo registration context), or a registration result buffer is inquired. - Specifies the setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Restore a registration context or result buffer from disk. - Specifies the name and path of the file from which to restore the registration context. - Specifies the system on which to restore the registration context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the registration context or result buffer identifier. - The returned value is the registration context or result buffer identifier. If allocation fails, M_NULL is returned. - - - Restore a registration context or result buffer from disk. - Specifies the name and path of the file from which to restore the registration context. - Specifies the system on which to restore the registration context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the registration context or result buffer identifier. - The returned value is the registration context or result buffer identifier. If allocation fails, M_NULL is returned. - - - Save a registration context or an M_STITCHING_RESULT result buffer to a file. - Specifies the name and path of the file in which to save the registration context or the contents of the registration result buffer. - Specifies either the identifier of the registration context or the M_STITCHING_RESULT result buffer to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a registration context or an M_STITCHING_RESULT result buffer to a file. - Specifies the name and path of the file in which to save the registration context or the contents of the registration result buffer. - Specifies either the identifier of the registration context or the M_STITCHING_RESULT result buffer to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Sets the rough location of the specified registration element's image with respect to another registration element's image or the global pixel coordinate system. - Specifies the registration context of the registration element to affect. - Specifies the index of the registration element. - Specifies the reference of the registration element's image. The coordinate system associated with this reference is used as the reference coordinate system. - Specifies the type of transformation to use to set the location of the registration element's image. - Specifies an attribute of the transformation. Its definition depends on the value of ParamType. - Specifies an attribute of the transformation. Its definition depends on the value of ParamType. - Specifies an attribute of the transformation. Its definition depends on the value of ParamType. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - - - Sets the rough location of the specified registration element's image with respect to another registration element's image or the global pixel coordinate system. - Specifies the registration context of the registration element to affect. - Specifies the index of the registration element. - Specifies the reference of the registration element's image. The coordinate system associated with this reference is used as the reference coordinate system. - Specifies the type of transformation to use to set the location of the registration element's image. - Specifies an attribute of the transformation. Its definition depends on the value of ParamType. - Specifies an attribute of the transformation. Its definition depends on the value of ParamType. - Specifies an attribute of the transformation. Its definition depends on the value of ParamType. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a registration context or an M_STITCHING_RESULT result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the registration context or M_STITCHING_RESULT result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the registration context or the M_STITCHING_RESULT result buffer. - Specifies the MIL version of the registration context or M_STITCHING_RESULT result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the registration context or the M_STITCHING_RESULT result buffer. - Specifies the address of the variable in which to write the size of the registration context or M_STITCHING_RESULT result buffer, in bytes. - - - Load, restore, or save a registration context or an M_STITCHING_RESULT result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the registration context or M_STITCHING_RESULT result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the registration context or the M_STITCHING_RESULT result buffer. - Specifies the MIL version of the registration context or M_STITCHING_RESULT result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the registration context or the M_STITCHING_RESULT result buffer. - Specifies the address of the variable in which to write the size of the registration context or M_STITCHING_RESULT result buffer, in bytes. - - - Load, restore, or save a registration context or an M_STITCHING_RESULT result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the registration context or M_STITCHING_RESULT result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the registration context or the M_STITCHING_RESULT result buffer. - Specifies the MIL version of the registration context or M_STITCHING_RESULT result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the registration context or the M_STITCHING_RESULT result buffer. - Specifies the address of the variable in which to write the size of the registration context or M_STITCHING_RESULT result buffer, in bytes. - - - Load, restore, or save a registration context or an M_STITCHING_RESULT result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the registration context or M_STITCHING_RESULT result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the registration context or the M_STITCHING_RESULT result buffer. - Specifies the MIL version of the registration context or M_STITCHING_RESULT result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the registration context or the M_STITCHING_RESULT result buffer. - Specifies the address of the variable in which to write the size of the registration context or M_STITCHING_RESULT result buffer, in bytes. - - - Load, restore, or save a registration context or an M_STITCHING_RESULT result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the registration context or M_STITCHING_RESULT result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the registration context or the M_STITCHING_RESULT result buffer. - Specifies the MIL version of the registration context or M_STITCHING_RESULT result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the registration context or the M_STITCHING_RESULT result buffer. - Specifies the address of the variable in which to write the size of the registration context or M_STITCHING_RESULT result buffer, in bytes. - - - Load, restore, or save a registration context or an M_STITCHING_RESULT result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the registration context or M_STITCHING_RESULT result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the registration context or the M_STITCHING_RESULT result buffer. - Specifies the MIL version of the registration context or M_STITCHING_RESULT result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the registration context or the M_STITCHING_RESULT result buffer. - Specifies the address of the variable in which to write the size of the registration context or M_STITCHING_RESULT result buffer, in bytes. - - - Convert a pair of coordinates between two of the following coordinate systems: the global pixel coordinate system, any registered image's pixel coordinate system, and the mosaic's coordinate system. - Specifies the registration result buffer that contains the information that will be used to transform the coordinates. - Specifies the source coordinate system. - Specifies the destination coordinate system. - Specifies the X-coordinate in the source coordinate system. - Specifies the Y-coordinate in the source coordinate system. - Specifies the address in which to write the resulting X-coordinate. - Specifies the address in which to write the resulting Y-coordinate. - Reserved for future expansion and must be set to M_DEFAULT . - - - Convert a list of coordinates between two of the following coordinate systems: the global pixel coordinate system, any registered image's pixel coordinate system, and the mosaic's coordinate system. - Specifies the registration result buffer that contains the information that will be used to transform the coordinates. - Specifies the source coordinate system. - Specifies the destination coordinate system. - Specifies the number of points in the coordinate list. - Specifies the address of the array of the X-coordinates in the source coordinate system. - Specifies the address of the array of the Y-coordinates in the source coordinate system. - Specifies the address in which to write the resulting X-coordinate. - Specifies the address in which to write the resulting Y-coordinate. - Reserved for future expansion and must be set to M_DEFAULT . - - - Composes a mosaic from the specified source images and stores it in the destination image buffer. - Specifies the identifier of the registration result buffer with which to perform the mosaicing operation. - Specifies the address of the array containing the identifiers of the image buffers. To omit images from the mosaic, replace their identifiers with M_NULL in the array. - Specifies the destination image buffer that will contain the mosaic after the MregTransformImage operation is performed. - Specifies the number of images in the image array. - Specifies the interpolation mode. - Reserved for future expansion and must be set to M_DEFAULT . - - - Composes a mosaic from the specified source images and stores it in the destination image buffer. - Specifies the identifier of the registration result buffer with which to perform the mosaicing operation. - Specifies the address of the array containing the identifiers of the image buffers. To omit images from the mosaic, replace their identifiers with M_NULL in the array. - Specifies the destination image buffer that will contain the mosaic after the MregTransformImage operation is performed. - Specifies the number of images in the image array. - Specifies the interpolation mode. - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate a sequence context. - Specifies the system on which to allocate the sequence context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the operation that the sequence processing session should perform. - Specifies the format to use to create the internal output buffer. - Specifies the underlying hardware or software used for the operation. - Specifies the address of the variable in which to write the sequence context identifier. - The returned value is the sequence context's identifier. If allocation fails, M_NULL is returned. - - - Allocate a sequence context. - Specifies the system on which to allocate the sequence context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the operation that the sequence processing session should perform. - Specifies the format to use to create the internal output buffer. - Specifies the underlying hardware or software used for the operation. - Specifies the address of the variable in which to write the sequence context identifier. - The returned value is the sequence context's identifier. If allocation fails, M_NULL is returned. - - - Control a sequence context or an individual source or destination setting. - Specifies the identifier of the sequence context to control. The sequence context must have been previously allocated using MseqAlloc. - Specifies that the sequence context, the source of an input, or a destination of an output is controlled. Set this parameter to one of the following values: - Specifies the setting to control. - Specifies the value needed for the setting. - - - Control a sequence context or an individual source or destination setting. - Specifies the identifier of the sequence context to control. The sequence context must have been previously allocated using MseqAlloc. - Specifies that the sequence context, the source of an input, or a destination of an output is controlled. Set this parameter to one of the following values: - Specifies the setting to control. - Specifies the value needed for the setting. - - - Define, or redefine, a source or destination of an input or output of the sequence operation, respectively. - Specifies the identifier of the sequence context. The sequence context must have been previously allocated using MseqAlloc. - Specifies whether to define, or redefine, the source of an input or one of the destinations of an output for the sequence operation of the specified sequence context. - Specifies the type of source or destination to define. - Specifies an attribute of the source or destination to define. Its definition is dependent on the sequence type chosen. - Specifies an attribute of the source or destination to define. Its definition is dependent on the sequence type chosen. - - - Define, or redefine, a source or destination of an input or output of the sequence operation, respectively. - Specifies the identifier of the sequence context. The sequence context must have been previously allocated using MseqAlloc. - Specifies whether to define, or redefine, the source of an input or one of the destinations of an output for the sequence operation of the specified sequence context. - Specifies the type of source or destination to define. - Specifies an attribute of the source or destination to define. Its definition is dependent on the sequence type chosen. - Specifies an attribute of the source or destination to define. Its definition is dependent on the sequence type chosen. - - - Queue an image on which to operate. - Specifies the identifier of the sequence context. The sequence context must have been previously allocated using MseqAlloc. - Specifies the identifier of the buffer containing the image to be queued for the sequence processing operation. - Reserved for future use. Set this parameter to M_DEFAULT . - - - Free a sequence context. - Specifies the identifier of the sequence context to deallocate. The sequence context must have been previously allocated using MseqAlloc. - - - Get information about a sequence hook event. - Specifies the sequence event identifier received by the hook-handler function. See MseqHookFunction for more information. - Specifies a combination of two values: the event type and the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Hook a function to a sequence event. - Specifies the identifier of the sequence context. The sequence context must have been previously allocated using MseqAlloc. - Specifies the sequence event to which to hook the function. - Specifies the address of the function that should be called when the specified event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Inquire information about a sequence context or an individual source or destination setting. - Specifies the sequence context about which to inquire information. The sequence context must have been previously allocated using MseqAlloc. - Specifies that the sequence context, the source of an input, or a destination of an output is inquired. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a sequence context or an individual source or destination setting. - Specifies the sequence context about which to inquire information. The sequence context must have been previously allocated using MseqAlloc. - Specifies that the sequence context, the source of an input, or a destination of an output is inquired. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a sequence context or an individual source or destination setting. - Specifies the sequence context about which to inquire information. The sequence context must have been previously allocated using MseqAlloc. - Specifies that the sequence context, the source of an input, or a destination of an output is inquired. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a sequence context or an individual source or destination setting. - Specifies the sequence context about which to inquire information. The sequence context must have been previously allocated using MseqAlloc. - Specifies that the sequence context, the source of an input, or a destination of an output is inquired. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a sequence context or an individual source or destination setting. - Specifies the sequence context about which to inquire information. The sequence context must have been previously allocated using MseqAlloc. - Specifies that the sequence context, the source of an input, or a destination of an output is inquired. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Starts or stops a sequence processing session. - Specifies the identifier of the sequence context. The sequence context must have been previously allocated using MseqAlloc. - Specifies the command to give the sequence processing session. - Specifies the synchronization state of the sequence processing session. - - - Allocate a String Reader context. - Specifies the system on which to allocate the String Reader context. - Specifies the type of String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the String Reader context identifier. - The returned value is the String Reader context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a String Reader context. - Specifies the system on which to allocate the String Reader context. - Specifies the type of String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the String Reader context identifier. - The returned value is the String Reader context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a String Reader result buffer. - Specifies the system on which to allocate the String Reader result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the String Reader result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a String Reader result buffer. - Specifies the system on which to allocate the String Reader result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the String Reader result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a String Reader context, result buffer, a specific string model, or a specific font. - Specifies the String Reader context or result buffer whose settings to modify. - Specifies that the String Reader context, a specific font, a specific string model, or a result buffer is controlled. - Specifies the setting to change. - Specifies the setting's new value. - - - Control a String Reader context, result buffer, a specific string model, or a specific font. - Specifies the String Reader context or result buffer whose settings to modify. - Specifies that the String Reader context, a specific font, a specific string model, or a result buffer is controlled. - Specifies the setting to change. - Specifies the setting's new value. - - - Draw specific features of the String Reader context or String Reader results. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the String Reader context or String Reader result buffer from which to extract the features to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Specifies the index of the font feature or result feature to draw. - Specifies an explicit list of valid characters to draw, at the specified position. This is an optional, null-terminated string. - Specifies where in the destination image buffer to draw. - - - Draw specific features of the String Reader context or String Reader results. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the String Reader context or String Reader result buffer from which to extract the features to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Specifies the index of the font feature or result feature to draw. - Specifies an explicit list of valid characters to draw, at the specified position. This is an optional, null-terminated string. - Specifies where in the destination image buffer to draw. - - - Draw specific features of the String Reader context or String Reader results. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the String Reader context or String Reader result buffer from which to extract the features to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Specifies the index of the font feature or result feature to draw. - Specifies where in the destination image buffer to draw. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - - - Makes a diagnosis of the String Reader context and reports configuration problems. - Specifies the identifier of the String Reader context. - Specifies the identifier of the image to analyze. - Specifies the identifier of the string to locate. - Specifies the number of images to analyze. - Specifies the identifier of the String Reader result buffer in which to save the results of MstrExpert. - Specifies the type of analysis to perform with MstrExpert. - - - Makes a diagnosis of the String Reader context and reports configuration problems. - Specifies the identifier of the String Reader context. - Specifies the identifier of the image to analyze. - Specifies the identifier of the string to locate. - Specifies the number of images to analyze. - Specifies the identifier of the String Reader result buffer in which to save the results of MstrExpert. - Specifies the type of analysis to perform with MstrExpert. - - - Makes a diagnosis of the String Reader context and reports configuration problems. - Specifies the identifier of the String Reader context. - Specifies the identifier of the image to analyze. - Specifies the identifier of the string to locate. - Specifies the number of images to analyze. - Specifies the identifier of the String Reader result buffer in which to save the results of MstrExpert. - Specifies the type of analysis to perform with MstrExpert. - - - Free a String Reader context or a String Reader result buffer. - Specifies the identifier of the String Reader context or String Reader result buffer to free. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Preprocess a String Reader context. - Specifies the String Reader context to preprocess. - Specifies whether to preprocess the String Reader context. - - - Read strings from a target image. - Specifies the String Reader context to use for the read operation. - Specifies the target image in which to read the strings. - Specifies the result buffer in which to write the results of the read operation. - - - Restore a String Reader context from disk. - Specifies the path and name of the file from which to restore the String Reader context (for example, "C:\mydirectory\myfile"). - Specifies the system on which to restore the String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the String Reader context identifier. - The returned value is the String Reader context identifier. If allocation fails, M_NULL is returned. - - - Restore a String Reader context from disk. - Specifies the path and name of the file from which to restore the String Reader context (for example, "C:\mydirectory\myfile"). - Specifies the system on which to restore the String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the String Reader context identifier. - The returned value is the String Reader context identifier. If allocation fails, M_NULL is returned. - - - Save a String Reader context to a file. - Specifies the name and path of the file in which to save the String Reader context. - Specifies the identifier of the String Reader context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a String Reader context to a file. - Specifies the name and path of the file in which to save the String Reader context. - Specifies the identifier of the String Reader context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Set character constraints. - Specifies the String Reader context with which to associate the constraint. The String Reader context must have been previously allocated on the required system using MstrAlloc. - Specifies the string(s) in the String Reader context to affect. - Specifies the character position in the string for which to set the constraint. - Specifies the type of constraint to set. - Specifies an explicit list of valid characters, at the specified position. This is an optional, null-terminated string. - - - Set character constraints. - Specifies the String Reader context with which to associate the constraint. The String Reader context must have been previously allocated on the required system using MstrAlloc. - Specifies the string(s) in the String Reader context to affect. - Specifies the character position in the string for which to set the constraint. - Specifies the type of constraint to set. - Specifies an explicit list of valid characters, at the specified position. This is an optional, null-terminated string. - - - Load, restore, or save a String Reader context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the String Reader context. - Specifies the operation to perform on the String Reader context. - Specifies the type of stream in which to store/from which to restore the String Reader context. - Specifies the MIL version of the String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the String Reader context. - Specifies the address of the variable in which to write the size of the String Reader context, in bytes. - - - Load, restore, or save a String Reader context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the String Reader context. - Specifies the operation to perform on the String Reader context. - Specifies the type of stream in which to store/from which to restore the String Reader context. - Specifies the MIL version of the String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the String Reader context. - Specifies the address of the variable in which to write the size of the String Reader context, in bytes. - - - Load, restore, or save a String Reader context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the String Reader context. - Specifies the operation to perform on the String Reader context. - Specifies the type of stream in which to store/from which to restore the String Reader context. - Specifies the MIL version of the String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the String Reader context. - Specifies the address of the variable in which to write the size of the String Reader context, in bytes. - - - Load, restore, or save a String Reader context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the String Reader context. - Specifies the operation to perform on the String Reader context. - Specifies the type of stream in which to store/from which to restore the String Reader context. - Specifies the MIL version of the String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the String Reader context. - Specifies the address of the variable in which to write the size of the String Reader context, in bytes. - - - Load, restore, or save a String Reader context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the String Reader context. - Specifies the operation to perform on the String Reader context. - Specifies the type of stream in which to store/from which to restore the String Reader context. - Specifies the MIL version of the String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the String Reader context. - Specifies the address of the variable in which to write the size of the String Reader context, in bytes. - - - Load, restore, or save a String Reader context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the String Reader context. - Specifies the operation to perform on the String Reader context. - Specifies the type of stream in which to store/from which to restore the String Reader context. - Specifies the MIL version of the String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the String Reader context. - Specifies the address of the variable in which to write the size of the String Reader context, in bytes. - - - Allocate a MIL system. - Specifies the identifier of the application context to use. - Specifies the type of system to allocate. Set this parameter to one of the following values: - Specifies the number (rank) or user-defined name of the target board of the specified system type. - Specifies how to perform the allocation. - Specifies the address of the variable in which to write the system identifier. - The returned value is the system identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL system. - Specifies the identifier of the application context to use. - Specifies the type of system to allocate. Set this parameter to one of the following values: - Specifies the number (rank) or user-defined name of the target board of the specified system type. - Specifies how to perform the allocation. - Specifies the address of the variable in which to write the system identifier. - The returned value is the system identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a system setting. - Specifies the system identifier. - Specifies the type of setting to control. - Specifies the new value to assign to the system setting specified by the ControlType parameter. - - - Control a system setting. - Specifies the system identifier. - Specifies the type of setting to control. - Specifies the new value to assign to the system setting specified by the ControlType parameter. - - - Control a system setting. - Specifies the system identifier. - Specifies the type of setting to control. - Specifies the new value to assign to the system setting specified by the ControlType parameter. - - - Free a system. - Specifies the identifier of the system to free. - - - Get information about a hook event. - Specifies the identifier of the system. - Specifies the system event identifier received by the hook-handler function (see MsysHookFunction). - Specifies the type of information about which to inquire. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hook event. - Specifies the identifier of the system. - Specifies the system event identifier received by the hook-handler function (see MsysHookFunction). - Specifies the type of information about which to inquire. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hook event. - Specifies the identifier of the system. - Specifies the system event identifier received by the hook-handler function (see MsysHookFunction). - Specifies the type of information about which to inquire. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Hook a function to a system event. - Specifies the identifier of the system on which to hook a function. - Specifies the system event to which to hook the function. - Specifies the address of the function that should be called when the specified event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Inquire about a system setting. - Specifies the system identifier. This parameter should be set to one of the following values: - Specifies the type of system setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a system setting. - Specifies the system identifier. This parameter should be set to one of the following values: - Specifies the type of system setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a system setting. - Specifies the system identifier. This parameter should be set to one of the following values: - Specifies the type of system setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a system setting. - Specifies the system identifier. This parameter should be set to one of the following values: - Specifies the type of system setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a system setting. - Specifies the system identifier. This parameter should be set to one of the following values: - Specifies the type of system setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a system setting. - Specifies the system identifier. This parameter should be set to one of the following values: - Specifies the type of system setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Allocate a MIL I/O command list. - Specifies the identifier of the MIL system on which to allocate the I/O command list. - Specifies the index of the I/O command list to allocate. - Specifies the type of I/O command list to allocate. - Specifies the signal to use as the counter source. - Specifies the address of the variable in which to write the I/O command list identifier. - The returned value is the I/O command list identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL I/O command list. - Specifies the identifier of the MIL system on which to allocate the I/O command list. - Specifies the index of the I/O command list to allocate. - Specifies the type of I/O command list to allocate. - Specifies the signal to use as the counter source. - Specifies the address of the variable in which to write the I/O command list identifier. - The returned value is the I/O command list identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Add a command to change the state of a bit of the I/O command register at a specified time or counter value. - Specifies the identifier of the I/O command list in which to add a command. - Specifies the command to add to the I/O command list to change the state of the specified I/O command register bit. - Specifies the reference time or counter value to which the delay is added. - Specifies the delay to add to the reference time or counter value; the sum of the two establishes the specific moment that the command is executed. - Specifies the duration of the pulse if the command specified with Operation is M_PULSE_HIGH or M_PULSE_LOW. - Specifies the bit of the I/O command register to affect with the command. - Specifies the address in which to write whether the command was successfully added to the list. - The returned value is M_NULL if the function successfully scheduled the command, M_INVALID if the moment at which to execute the command had elapsed when the function was executed, and M_UNKNOWN if the function encountered an error or if the CommandStatusPtr parameter was set to M_NULL . - - - Add a command to change the state of a bit of the I/O command register at a specified time or counter value. - Specifies the identifier of the I/O command list in which to add a command. - Specifies the command to add to the I/O command list to change the state of the specified I/O command register bit. - Specifies the reference time or counter value to which the delay is added. - Specifies the delay to add to the reference time or counter value; the sum of the two establishes the specific moment that the command is executed. - Specifies the duration of the pulse if the command specified with Operation is M_PULSE_HIGH or M_PULSE_LOW. - Specifies the bit of the I/O command register to affect with the command. - Specifies the address in which to write whether the command was successfully added to the list. - The returned value is M_NULL if the function successfully scheduled the command, M_INVALID if the moment at which to execute the command had elapsed when the function was executed, and M_UNKNOWN if the function encountered an error or if the CommandStatusPtr parameter was set to M_NULL . - - - Add a command to change the state of a bit of the I/O command register at a specified time or counter value. - Specifies the identifier of the I/O command list in which to add a command. - Specifies the command to add to the I/O command list to change the state of the specified I/O command register bit. - Specifies the reference time or counter value to which the delay is added. - Specifies the delay to add to the reference time or counter value; the sum of the two establishes the specific moment that the command is executed. - Specifies the duration of the pulse if the command specified with Operation is M_PULSE_HIGH or M_PULSE_LOW. - Specifies the bit of the I/O command register to affect with the command. - Specifies the address in which to write whether the command was successfully added to the list. - The returned value is M_NULL if the function successfully scheduled the command, M_INVALID if the moment at which to execute the command had elapsed when the function was executed, and M_UNKNOWN if the function encountered an error or if the CommandStatusPtr parameter was set to M_NULL . - - - Control an I/O command list setting. - Specifies the identifier of the I/O command list. - Specifies the type of I/O command list setting to control. - Specifies the new value to assign to the I/O command list setting specified by the ControlType parameter. - - - Control an I/O command list setting. - Specifies the identifier of the I/O command list. - Specifies the type of I/O command list setting to control. - Specifies the new value to assign to the I/O command list setting specified by the ControlType parameter. - - - Free the specified I/O command list. - Specifies the identifier of the I/O command list to free. - - - Inquire about an I/O command list setting. - Specifies the identifier of the I/O command list. - Specifies the type of I/O command list setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an I/O command list setting. - Specifies the identifier of the I/O command list. - Specifies the type of I/O command list setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an I/O command list setting. - Specifies the identifier of the I/O command list. - Specifies the type of I/O command list setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an I/O command list setting. - Specifies the identifier of the I/O command list. - Specifies the type of I/O command list setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an I/O command list setting. - Specifies the identifier of the I/O command list. - Specifies the type of I/O command list setting about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an I/O command list setting. - Specifies the identifier of the I/O command list. - Specifies the type of I/O command list setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Allocate a MIL thread context, event, or mutex. - Specifies the identifier of the system on which to allocate a MIL thread context, event, or mutex. - Specifies the type of object to allocate. - Specifies the initialization state of the MIL thread context, event, mutex, or the identifier of an existing MIL event. - Specifies the address of the function that will be executed by the new thread ( M_THREAD). - Specifies the address of user data necessary to execute theFunctionToCallfunction of the new thread ( M_THREAD). - Specifies the address of the variable in which to write the MIL identifier of the MIL thread context, event, or mutex. - The returned value is the identifier of the MIL thread, event, or mutex if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL thread context, event, or mutex. - Specifies the identifier of the system on which to allocate a MIL thread context, event, or mutex. - Specifies the type of object to allocate. - Specifies the initialization state of the MIL thread context, event, mutex, or the identifier of an existing MIL event. - Specifies the address of the function that will be executed by the new thread ( M_THREAD). - Specifies the address of user data necessary to execute theFunctionToCallfunction of the new thread ( M_THREAD). - Specifies the address of the variable in which to write the MIL identifier of the MIL thread context, event, or mutex. - The returned value is the identifier of the MIL thread, event, or mutex if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL thread context, event, or mutex. - Specifies the identifier of the system on which to allocate a MIL thread context, event, or mutex. - Specifies the type of object to allocate. - Specifies the initialization state of the MIL thread context, event, mutex, or the identifier of an existing MIL event. - Specifies the address of the function that will be executed by the new thread ( M_THREAD). - Specifies the address of user data necessary to execute theFunctionToCallfunction of the new thread ( M_THREAD). - Specifies the address of the variable in which to write the MIL identifier of the MIL thread context, event, or mutex. - The returned value is the identifier of the MIL thread, event, or mutex if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL thread context, event, or mutex. - Specifies the identifier of the system on which to allocate a MIL thread context, event, or mutex. - Specifies the type of object to allocate. - Specifies the initialization state of the MIL thread context, event, mutex, or the identifier of an existing MIL event. - Specifies the address of the function that will be executed by the new thread ( M_THREAD). - Specifies the address of user data necessary to execute theFunctionToCallfunction of the new thread ( M_THREAD). - Specifies the address of the variable in which to write the MIL identifier of the MIL thread context, event, or mutex. - The returned value is the identifier of the MIL thread, event, or mutex if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL thread context, event, or mutex. - Specifies the identifier of the system on which to allocate a MIL thread context, event, or mutex. - Specifies the type of object to allocate. - Specifies the initialization state of the MIL thread context, event, mutex, or the identifier of an existing MIL event. - Specifies the address of the function that will be executed by the new thread ( M_THREAD). - Specifies the address of user data necessary to execute theFunctionToCallfunction of the new thread ( M_THREAD). - Specifies the address of the variable in which to write the MIL identifier of the MIL thread context, event, or mutex. - The returned value is the identifier of the MIL thread, event, or mutex if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL thread context, event, or mutex. - Specifies the identifier of the system on which to allocate a MIL thread context, event, or mutex. - Specifies the type of object to allocate. - Specifies the initialization state of the MIL thread context, event, mutex, or the identifier of an existing MIL event. - Specifies the address of the function that will be executed by the new thread ( M_THREAD). - Specifies the address of user data necessary to execute theFunctionToCallfunction of the new thread ( M_THREAD). - Specifies the address of the variable in which to write the MIL identifier of the MIL thread context, event, or mutex. - The returned value is the identifier of the MIL thread, event, or mutex if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a MIL thread context, MIL event, or MIL mutex setting. - Specifies the identifier of a user-allocated MIL thread context, event, or mutex, allocated using MthrAlloc. This parameter can also be set to the MIL identifier of a system. - Specifies the type of setting to control. - Specifies the new value to assign to the setting specified by the ControlType parameter. - - - Control a MIL thread context, MIL event, or MIL mutex setting. - Specifies the identifier of a user-allocated MIL thread context, event, or mutex, allocated using MthrAlloc. This parameter can also be set to the MIL identifier of a system. - Specifies the type of setting to control. - Specifies the new value to assign to the setting specified by the ControlType parameter. - - - Control a MIL multi-core processing setting of a thread context. - Specifies the identifier of a user-allocated MIL thread context allocated using MthrAlloc. - Specifies the type of multi-core processing setting to control. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the setting's new value. - Specifies the address which contains more information about the setting's new value. - - - Control a MIL multi-core processing setting of a thread context. - Specifies the identifier of a user-allocated MIL thread context allocated using MthrAlloc. - Specifies the type of multi-core processing setting to control. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the setting's new value. - Specifies the address which contains more information about the setting's new value. - - - Free a MIL thread context, event, or mutex. - Specifies the identifier of the MIL thread context/event/mutex to free. - - - Inquire about a MIL thread context, event, or mutex setting. - Specifies the identifier of a user-allocated MIL thread context, event, or mutex, allocated using MthrAlloc. - Specifies the type of information about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL thread context, event, or mutex setting. - Specifies the identifier of a user-allocated MIL thread context, event, or mutex, allocated using MthrAlloc. - Specifies the type of information about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL thread context, event, or mutex setting. - Specifies the identifier of a user-allocated MIL thread context, event, or mutex, allocated using MthrAlloc. - Specifies the type of information about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL thread context, event, or mutex setting. - Specifies the identifier of a user-allocated MIL thread context, event, or mutex, allocated using MthrAlloc. - Specifies the type of information about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquires about a MIL multi-core processing setting of a thread context. - Specifies the identifier of a user-allocated MIL thread context allocated using MthrAlloc. - Specifies the type of multi-core processing setting about which to inquire. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address in which to write the requested information. - The returned value is the requested information cast to a MIL_INT, except for M_CORE_AFFINITY_MASK. In this case, the returned value is undefined. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquires about a MIL multi-core processing setting of a thread context. - Specifies the identifier of a user-allocated MIL thread context allocated using MthrAlloc. - Specifies the type of multi-core processing setting about which to inquire. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address in which to write the requested information. - The returned value is the requested information cast to a MIL_INT, except for M_CORE_AFFINITY_MASK. In this case, the returned value is undefined. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquires about a MIL multi-core processing setting of a thread context. - Specifies the identifier of a user-allocated MIL thread context allocated using MthrAlloc. - Specifies the type of multi-core processing setting about which to inquire. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address in which to write the requested information. - The returned value is the requested information cast to a MIL_INT, except for M_CORE_AFFINITY_MASK. In this case, the returned value is undefined. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Perform a wait operation on a MIL thread or event. - Specifies the identifier of the MIL thread context or event with which to be synchronized. - Specifies the wait option. - Specifies the address of the variable in which to write the state of the specified thread or event. - The returned value for M_THREAD_END_WAIT, M_THREAD_WAIT, and M_EVENT_WAIT is M_SIGNALED if the specified thread has successfully completed or if the state of the specified event has changed; it is M_TIMEOUT if the thread or event on which the current thread was waiting timed out. For M_EVENT_SYNCHRONIZE, the returned value is M_UNKNOWN . - - - Perform a wait operation on a MIL thread or event. - Specifies the identifier of the MIL thread context or event with which to be synchronized. - Specifies the wait option. - The returned value for M_THREAD_END_WAIT, M_THREAD_WAIT, and M_EVENT_WAIT is M_SIGNALED if the specified thread has successfully completed or if the state of the specified event has changed; it is M_TIMEOUT if the thread or event on which the current thread was waiting timed out. For M_EVENT_SYNCHRONIZE, the returned value is M_UNKNOWN . - - - Perform a wait operation on a MIL thread or event. - Specifies the identifier of the MIL thread context or event with which to be synchronized. - Specifies the wait option. - Specifies the address of the variable in which to write the state of the specified thread or event. - The returned value for M_THREAD_END_WAIT, M_THREAD_WAIT, and M_EVENT_WAIT is M_SIGNALED if the specified thread has successfully completed or if the state of the specified event has changed; it is M_TIMEOUT if the thread or event on which the current thread was waiting timed out. For M_EVENT_SYNCHRONIZE, the returned value is M_UNKNOWN . - - - Perform a wait operation on multiple MIL events. - Specifies the address of a user-supplied array that contains the identifiers of the MIL events for which to wait. - Specifies the number of events in the user-supplied array. - Specifies the wait option. - Specifies the address in which to write the returned value. - The returned value for M_EVENT_WAIT is the index of the event that changed to the M_SIGNALED state, or M_TIMEOUT if none of the events in the array changed state before the time out interval is reached. For M_EVENT_WAIT + M_ALL_OBJECTS, the returned value is M_SIGNALED if all the events specified in the array changed state, or M_TIMEOUT if the time out interval is reached before all the events in the array have changed state. For M_EVENT_SYNCHRONIZE, the returned value is M_UNKNOWN . - - - Perform a wait operation on multiple MIL events. - Specifies the address of a user-supplied array that contains the identifiers of the MIL events for which to wait. - Specifies the number of events in the user-supplied array. - Specifies the wait option. - Specifies the address in which to write the returned value. - The returned value for M_EVENT_WAIT is the index of the event that changed to the M_SIGNALED state, or M_TIMEOUT if none of the events in the array changed state before the time out interval is reached. For M_EVENT_WAIT + M_ALL_OBJECTS, the returned value is M_SIGNALED if all the events specified in the array changed state, or M_TIMEOUT if the time out interval is reached before all the events in the array have changed state. For M_EVENT_SYNCHRONIZE, the returned value is M_UNKNOWN . - - - Perform a wait operation on multiple MIL events. - Specifies the address of a user-supplied array that contains the identifiers of the MIL events for which to wait. - Specifies the number of events in the user-supplied array. - Specifies the wait option. - Specifies the address in which to write the returned value. - The returned value for M_EVENT_WAIT is the index of the event that changed to the M_SIGNALED state, or M_TIMEOUT if none of the events in the array changed state before the time out interval is reached. For M_EVENT_WAIT + M_ALL_OBJECTS, the returned value is M_SIGNALED if all the events specified in the array changed state, or M_TIMEOUT if the time out interval is reached before all the events in the array have changed state. For M_EVENT_SYNCHRONIZE, the returned value is M_UNKNOWN . - - - Perform a wait operation on multiple MIL events. - Specifies the address of a user-supplied array that contains the identifiers of the MIL events for which to wait. - Specifies the number of events in the user-supplied array. - Specifies the wait option. - Specifies the address in which to write the returned value. - The returned value for M_EVENT_WAIT is the index of the event that changed to the M_SIGNALED state, or M_TIMEOUT if none of the events in the array changed state before the time out interval is reached. For M_EVENT_WAIT + M_ALL_OBJECTS, the returned value is M_SIGNALED if all the events specified in the array changed state, or M_TIMEOUT if the time out interval is reached before all the events in the array have changed state. For M_EVENT_SYNCHRONIZE, the returned value is M_UNKNOWN . - - - Allocate a MIL application. - Specifies the type of initialization to perform on the MIL application. - Specifies the address of the variable in which to write the application identifier. - The returned value is the application identifier. If allocation fails, M_NULL is returned. - - - Allocate a MIL application. - Specifies the type of initialization to perform on the MIL application. - Specifies the address of the variable in which to write the application identifier. - The returned value is the application identifier. If allocation fails, M_NULL is returned. - - - Allocate default MIL objects. - Specifies the type of initialization setup to perform and is used principally to initialize the default system. - Specifies the address of the variable in which to write the application identifier. - Specifies the address of the variable in which to write the system identifier. - Specifies the address of the variable in which to write the identifier of the default display. - Specifies the address of the variable in which to write the identifier of the default digitizer. - Specifies the address of the variable in which to write the identifier of the default image buffer. - - - Free default MIL objects. - Specifies the identifier of the application to free. - Specifies the address of the variable in which to write the application identifier. - Specifies the address of the variable in which to write the system identifier. - Specifies the address of the variable in which to write the identifier of the default display. - Specifies the address of the variable in which to write the identifier of the default digitizer. - Must be set to M_NULL - - - Allocate default MIL objects. - Specifies the type of initialization setup to perform and is used principally to initialize the default system. - Specifies the address of the variable in which to write the application identifier. - Specifies the address of the variable in which to write the system identifier. - Specifies the address of the variable in which to write the identifier of the default display. - Must be set to M_NULL. - Specifies the address of the variable in which to write the identifier of the default image buffer. - - - Allocate default MIL objects. - Specifies the type of initialization setup to perform and is used principally to initialize the default system. - Specifies the address of the variable in which to write the application identifier. - Specifies the address of the variable in which to write the system identifier. - Must be set to M_NULL. - Specifies the address of the variable in which to write the identifier of the default digitizer. - Specifies the address of the variable in which to write the identifier of the default image buffer. - - - Allocate default MIL objects. - Specifies the type of initialization setup to perform and is used principally to initialize the default system. - Specifies the address of the variable in which to write the application identifier. - Specifies the address of the variable in which to write the system identifier. - Specifies the address of the variable in which to write the identifier of the default display. - Must be set to M_NULL. - Must be set to M_NULL. - - - Allocate default MIL objects. - Specifies the type of initialization setup to perform and is used principally to initialize the default system. - Specifies the address of the variable in which to write the application identifier. - Specifies the address of the variable in which to write the system identifier. - Must be set to M_NULL. - Must be set to M_NULL. - Specifies the address of the variable in which to write the identifier of the default image buffer. - - - Allocate default MIL objects. - Specifies the type of initialization setup to perform and is used principally to initialize the default system. - Specifies the address of the variable in which to write the application identifier. - Specifies the address of the variable in which to write the system identifier. - Must be set to M_NULL. - Specifies the address of the variable in which to write the identifier of the default digitizer. - Must be set to M_NULL. - - - Allocate default MIL objects. - Specifies the type of initialization setup to perform and is used principally to initialize the default system. - Specifies the address of the variable in which to write the application identifier. - Specifies the address of the variable in which to write the system identifier. - Must be set to M_NULL. - Must be set to M_NULL. - Must be set to M_NULL. - - - Control an application environment setting. - Specifies the type of application environment setting to control. - Specifies the setting's new value. - - - Control an application environment setting. - Specifies the identifier of the application context to use. - Specifies the type of application environment setting to control. - Specifies the setting's new value. - - - Control a MIL object setting for a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the identifier of the MIL object to control. - Specifies the type of MIL object setting to control. - Specifies the MIL object setting's new value. - - - Control a MIL object setting for a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the identifier of the MIL object to control. - Specifies the type of MIL object setting to control. - Specifies the MIL object setting's new value. - - - Control a MIL object setting for a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the identifier of the MIL object to control. - Specifies the type of MIL object setting to control. - Specifies the MIL object setting's new value. - - - Free default MIL objects. - Specifies the identifier of the application to free. - Specifies the identifier of the application to free. - Specifies the identifier of the application to free. - Specifies the identifier of the application to free. - Specifies the identifier of the application to free. - - - Get error codes and related information. - Specifies the type of error information to read. - Specifies the address in which to write the requested information. - The returned value is the requested error/function code. If the error code is read and it is equal to M_NULL_ERROR, no error has occurred. - - - Get error codes and related information. - Specifies the type of error information to read. - Specifies the address in which to write the requested information. - The returned value is the requested error/function code. If the error code is read and it is equal to M_NULL_ERROR, no error has occurred. - - - Get error codes and related information. - Specifies the type of error information to read. - The returned value is the requested error/function code. If the error code is read and it is equal to M_NULL_ERROR, no error has occurred. - - - Get error codes and related information. - Specifies the type of error information to read. - Specifies the address in which to write the requested information. - The returned value is the requested error/function code. If the error code is read and it is equal to M_NULL_ERROR, no error has occurred. - - - Get error codes and related information. - Specifies the type of error information to read. - Specifies the address in which to write the requested information. - The returned value is the requested error/function code. If the error code is read and it is equal to M_NULL_ERROR , no error has occurred. [DeprecatedVersion(900)] - - - Get error codes and related information. - Specifies the identifier of the application context to use. - Specifies the type of error information to read. - Specifies the address in which to write the requested information. - The returned value is the requested error/function code. If the error code is read and it is equal to M_NULL_ERROR , no error has occurred. - - - Get information about a hooked event. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful; a non M_NULL value on error, without logging any errors in the application. - - - Get information about a hooked event. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful; a non M_NULL value on error, without logging any errors in the application. - - - Get information about a hooked event. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful; a non M_NULL value on error, without logging any errors in the application. - - - Get information about a hooked event. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful; a non M_NULL value on error, without logging any errors in the application. - - - Get information about a hooked event. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful; a non M_NULL value on error, without logging any errors in the application. - - - Get information about a hooked event. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful; a non M_NULL value on error, without logging any errors in the application. - - - Get information about a hooked event. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful; a non M_NULL value on error, without logging any errors in the application. - - - Get information about a hooked event. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hooked event. - Specifies the identifier of the application context to use. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Hook a function to an event. - Specifies the event type. - Specifies the address of the function that should be called when an event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Hook a function to an event. - Specifies the event type. - Specifies the address of the function that should be called when an event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Inquire about an application setting. - Specifies the type of application setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested system information cast to MIL_INT. - - - Inquire about an application setting. - Specifies the type of application setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested system information cast to MIL_INT. - - - Inquire about an application setting. - Specifies the type of application setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested system information cast to MIL_INT. - - - Inquire about an application setting. - Specifies the type of application setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested system information cast to MIL_INT. - - - Inquire about an application setting. - Specifies the type of application setting about which to inquire. - The returned value is the requested system information cast to MIL_INT. - - - Inquire about an application setting. - Specifies the type of application setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested system information cast to MIL_INT. - - - Inquire about an application setting. - Specifies the type of application setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information does not fit into aMIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an application setting. - Specifies the identifier of the application context to use. - Specifies the type of application setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information does not fit into aMIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL object setting in a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the identifier of the MIL object about which to inquire. - Specifies the MIL object setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information is not a single value, this function will return M_NULL . - - - Inquire about a MIL object setting in a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the identifier of the MIL object about which to inquire. - Specifies the MIL object setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information is not a single value, this function will return M_NULL . - - - Inquire about a MIL object setting in a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the identifier of the MIL object about which to inquire. - Specifies the MIL object setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information is not a single value, this function will return M_NULL . - - - Control a setting of a MIL timer and read the MIL timer. - Specifies the control to exert on the MIL timer. - Specifies the address of the variable in which to store the timer information produced by the M_TIMER_READ or M_TIMER_RESOLUTION controls. - For M_TIMER_READ and M_TIMER_RESOLUTION , the returned value is cast to MIL_DOUBLE. For M_TIMER_RESET and M_TIMER_WAIT , this function returns 0.0. - - - Control a setting of a MIL timer and read the MIL timer. - Specifies the control to exert on the MIL timer. - For M_TIMER_READ and M_TIMER_RESOLUTION , the returned value is cast to MIL_DOUBLE. For M_TIMER_RESET and M_TIMER_WAIT , this function returns 0.0. - - - Control a setting of a MIL timer and read the MIL timer. - Specifies the control to exert on the MIL timer. - Specifies the address of the variable in which to store the timer information produced by the M_TIMER_READ or M_TIMER_RESOLUTION controls. - For M_TIMER_READ and M_TIMER_RESOLUTION , the returned value is cast to MIL_DOUBLE. For M_TIMER_RESET and M_TIMER_WAIT , this function returns 0.0. - - - Allocate a blob analysis feature list. - Specifies the system on which to allocate the feature list. - Specifies the address of the variable in which the feature list identifier will be written. - The returned value is the feature list identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a blob analysis feature list. - Specifies the system on which to allocate the feature list. - Specifies the address of the variable in which the feature list identifier will be written. - The returned value is the feature list identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a blob analysis result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the address of the variable in which the blob analysis result buffer identifier is to be written. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a blob analysis result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the address of the variable in which the blob analysis result buffer identifier is to be written. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Draw blobs that meet a specified fill criterion. - Specifies the identifier of the blob analysis result buffer. - Specifies the identifier of the destination image buffer. - Specifies which blobs to draw with the specified value. - Specifies the value with which to fill the blobs that meet the specified criterion. If the destination buffer is binary, this value must be 0 or 1. - - - Get the number of currently included blobs. - Specifies the identifier of the blob analysis result buffer. - Specifies the address of the variable in which to write the count. Since MblobGetNumber also returns the number of selected blobs, you can set this parameter to M_NULL . - The returned value is the number of included blobs in the specified result buffer. - - - Get the number of currently included blobs. - Specifies the identifier of the blob analysis result buffer. - Specifies the address of the variable in which to write the count. Since MblobGetNumber also returns the number of selected blobs, you can set this parameter to M_NULL . - The returned value is the number of included blobs in the specified result buffer. - - - Get the number of currently included blobs. - Specifies the identifier of the blob analysis result buffer. - Specifies the address of the variable in which to write the count. Since MblobGetNumber also returns the number of selected blobs, you can set this parameter to M_NULL . - The returned value is the number of included blobs in the specified result buffer. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of a single blob. - Specifies the identifier of the blob analysis result buffer from which to get the result. - Specifies the label value of the blob for which to get the result. The label value can be obtained, using MblobGetLabel or MblobGetResult . Note, you cannot obtain results for blobs that have been deleted from the result buffer, using MblobSelect . - Specifies the feature for which to retrieve results. - Specifies the address in which to write the result retrieved from the blob analysis result buffer. - - - Get results for a feature of a single blob. - Specifies the identifier of the blob analysis result buffer from which to get the result. - Specifies the label value of the blob for which to get the result. The label value can be obtained, using MblobGetLabel or MblobGetResult . Note, you cannot obtain results for blobs that have been deleted from the result buffer, using MblobSelect . - Specifies the feature for which to retrieve results. - Specifies the address in which to write the result retrieved from the blob analysis result buffer. - - - Get results for a feature of a single blob. - Specifies the identifier of the blob analysis result buffer from which to get the result. - Specifies the label value of the blob for which to get the result. The label value can be obtained, using MblobGetLabel or MblobGetResult . Note, you cannot obtain results for blobs that have been deleted from the result buffer, using MblobSelect . - Specifies the feature for which to retrieve results. - Specifies the address in which to write the result retrieved from the blob analysis result buffer. - - - Get results for a feature of a single blob. - Specifies the identifier of the blob analysis result buffer from which to get the result. - Specifies the label value of the blob for which to get the result. The label value can be obtained, using MblobGetLabel or MblobGetResult . Note, you cannot obtain results for blobs that have been deleted from the result buffer, using MblobSelect . - Specifies the feature for which to retrieve results. - Specifies the address in which to write the result retrieved from the blob analysis result buffer. - - - Get results for a feature of a single blob. - Specifies the identifier of the blob analysis result buffer from which to get the result. - Specifies the label value of the blob for which to get the result. The label value can be obtained, using MblobGetLabel or MblobGetResult . Note, you cannot obtain results for blobs that have been deleted from the result buffer, using MblobSelect . - Specifies the feature for which to retrieve results. - Specifies the address in which to write the result retrieved from the blob analysis result buffer. - - - Get results for a feature of a single blob. - Specifies the identifier of the blob analysis result buffer from which to get the result. - Specifies the label value of the blob for which to get the result. The label value can be obtained, using MblobGetLabel or MblobGetResult . Note, you cannot obtain results for blobs that have been deleted from the result buffer, using MblobSelect . - Specifies the feature for which to retrieve results. - Specifies the address in which to write the result retrieved from the blob analysis result buffer. - - - Get results for a feature of a single blob. - Specifies the identifier of the blob analysis result buffer from which to get the result. - Specifies the label value of the blob for which to get the result. The label value can be obtained, using MblobGetLabel or MblobGetResult . Note, you cannot obtain results for blobs that have been deleted from the result buffer, using MblobSelect . - Specifies the feature for which to retrieve results. - Specifies the address in which to write the result retrieved from the blob analysis result buffer. - - - Get results for a feature of a single blob. - Specifies the identifier of the blob analysis result buffer from which to get the result. - Specifies the label value of the blob for which to get the result. The label value can be obtained, using MblobGetLabel or MblobGetResult . Note, you cannot obtain results for blobs that have been deleted from the result buffer, using MblobSelect . - Specifies the feature for which to retrieve results. - Specifies the address in which to write the result retrieved from the blob analysis result buffer. - - - Get results for a feature of a single blob. - Specifies the identifier of the blob analysis result buffer from which to get the result. - Specifies the label value of the blob for which to get the result. The label value can be obtained, using MblobGetLabel or MblobGetResult . Note, you cannot obtain results for blobs that have been deleted from the result buffer, using MblobSelect . - Specifies the feature for which to retrieve results. - Specifies the address in which to write the result retrieved from the blob analysis result buffer. - - - Get the blob run-length encoding information. - Specifies the identifier of the blob analysis result buffer. - Specifies the blob(s) for which to get run length encoding information. - Specifies the type of the arrays in which the coordinate and length of the runs for a blob will be returned. - Specifies the address of the array in which to write the X-coordinate of the start (left-most pixel) of each run in the specified blob. - Specifies the address of the array in which to write the Y-coordinate of the start of each run in the specified blob. - Specifies the address of the array in which to write the length of each run in the specified blob. - - - Get the blob run-length encoding information. - Specifies the identifier of the blob analysis result buffer. - Specifies the blob(s) for which to get run length encoding information. - Specifies the type of the arrays in which the coordinate and length of the runs for a blob will be returned. - Specifies the address of the array in which to write the X-coordinate of the start (left-most pixel) of each run in the specified blob. - Specifies the address of the array in which to write the Y-coordinate of the start of each run in the specified blob. - Specifies the address of the array in which to write the length of each run in the specified blob. - - - Get the blob run-length encoding information. - Specifies the identifier of the blob analysis result buffer. - Specifies the blob(s) for which to get run length encoding information. - Specifies the type of the arrays in which the coordinate and length of the runs for a blob will be returned. - Specifies the address of the array in which to write the X-coordinate of the start (left-most pixel) of each run in the specified blob. - Specifies the address of the array in which to write the Y-coordinate of the start of each run in the specified blob. - Specifies the address of the array in which to write the length of each run in the specified blob. - - - Get the blob run-length encoding information. - Specifies the identifier of the blob analysis result buffer. - Specifies the blob(s) for which to get run length encoding information. - Specifies the type of the arrays in which the coordinate and length of the runs for a blob will be returned. - Specifies the address of the array in which to write the X-coordinate of the start (left-most pixel) of each run in the specified blob. - Specifies the address of the array in which to write the Y-coordinate of the start of each run in the specified blob. - Specifies the address of the array in which to write the length of each run in the specified blob. - - - Get the blob run-length encoding information. - Specifies the identifier of the blob analysis result buffer. - Specifies the blob(s) for which to get run length encoding information. - Specifies the type of the arrays in which the coordinate and length of the runs for a blob will be returned. - Specifies the address of the array in which to write the X-coordinate of the start (left-most pixel) of each run in the specified blob. - Specifies the address of the array in which to write the Y-coordinate of the start of each run in the specified blob. - Specifies the address of the array in which to write the length of each run in the specified blob. - - - Select feature(s) to be calculated. - Specifies the identifier of the feature list buffer. - Specifies the feature to add to the feature list. - - - Add Feret angle to the feature list. - Specifies the identifier of the feature list buffer. - Specifies the angle, in degrees, to be used for calculating the general Feret. - - - Add specified moment to the feature list. - Specifies the identifier of the feature list buffer. - Specifies the moment type. - Specifies the X-order of the moment. - Specifies the Y-order of the moment. - - - Change an operation control type setting of a kernel buffer or structuring element buffer. - Specifies the identifier of the kernel buffer or structuring element buffer. - Specifies the operation to perform during a neighborhood operation when using the specified buffer. - Specifies the new value to assign to the operation setting specified by the OperationControlType parameter. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information cannot be retrieved, M_ERROR is returned. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset setting, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, or digitizer. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to aMIL_INT. If the requested information does not fit into aMIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset setting, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, or digitizer. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to aMIL_INT. If the requested information does not fit into aMIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classification context. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - To inquire about a single entry of a data set. - Specifies the data set on which to control settings. - Specifies the index of the entry to control. - Specifies the key of the entry to control. - Specifies which region in an entry to control. - Specifies the type of control to set. - Specifies the required value for the control. - - - Draw specific features of results obtained from an McodeRead, McodeGrade, or McodeDetect operation. - Specifies the identifier of the graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the identifier of the code read, grade, or detect result buffer from which to extract features to draw. - Specifies the identifier of the destination image buffer or graphics list in which to write specific features of results. - Specifies the type of drawing operation to perform. - Specifies from which code occurrence or scan reflectance profile to draw results. - Specifies the function's control flag. Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to RowOrScanIndex M_GENERAL . - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for all occurrences of all code models read or graded, using a code read or grading operation, respectively. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for a single code model read or graded, using a code read or grading operation. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence or scan reflectance profile from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for a specified code occurrence, or in the case of an McodeTrain operation, for a specified code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence/code model, scan reflectance profile, or code row from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for a specified code occurrence, or in the case of an McodeTrain operation, for a specified code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence/code model, scan reflectance profile, or code row from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for a specified code occurrence, or in the case of an McodeTrain operation, for a specified code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence/code model, scan reflectance profile, or code row from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for a specified code occurrence, or in the case of an McodeTrain operation, for a specified code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence/code model, scan reflectance profile, or code row from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for a specified code occurrence, or in the case of an McodeTrain operation, for a specified code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence/code model, scan reflectance profile, or code row from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for a specified code occurrence, or in the case of an McodeTrain operation, for a specified code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence/code model, scan reflectance profile, or code row from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for a specified code occurrence, or in the case of an McodeTrain operation, for a specified code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence/code model, scan reflectance profile, or code row from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for a specified code occurrence, or in the case of an McodeTrain operation, for a specified code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence/code model, scan reflectance profile, or code row from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for a specified code occurrence, or in the case of an McodeTrain operation, for a specified code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence/code model, scan reflectance profile, or code row from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Compute the different quality-grades of the code in the specified source image. - Specifies the identifier of the code context. - Specifies the identifier of the image buffer containing the string to be verified. - Reserved for future expansion and must be set to M_NULL. - Specifies the result buffer in which to write the results of the verify operation. - - - Compute the different quality-grades of the code in the specified source image. - Specifies the identifier of the code context. - Specifies the identifier of the image buffer containing the string to be verified. - Reserved for future expansion and must be set to M_NULL. - Specifies the result buffer in which to write the results of the verify operation. - - - Encode an ASCII string into a symbol. - Specifies the identifier of the code model. - Specifies the 8-bit unsigned 1-band image buffer in which to write the symbol. - Specifies the address of the string to be encoded. - Specifies the function's control flag. - - - Inquire about an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the setting about which to inquire. - Specifies the address of the variable in which to return the value of the inquired setting. - The returned value is the requested information, cast to aMIL_INT. If the requested information does not fit into aMIL_INT, this function will return M_NULL or truncate the information. - - - Select the active input data or synchronization channel of a digitizer. - Specifies the identifier of the digitizer. - Specifies the channel on which the digitizer is to acquire data. - - - Get information about a digitizer hook event. - Specifies the digitizer event identifier received by the hook-handler function (see MdigProcess and MdigHookFunction ). - Specifies the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a digitizer hook event. - Specifies the digitizer event identifier received by the hook-handler function (see MdigProcess and MdigHookFunction). - Specifies the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Inquire about a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information does not fit into aMIL_INT, this function will return M_NULL or truncate the information. - - - Inquires a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to inquire. - Specifies the data type of the variable in which to return the requested information (pointed to by the UserVarPtr parameter). - Specifies the name of the camera feature to inquire. - Specifies the data type of the variable in which to return the requested information (pointed to by the UserVarPtr parameter). - Specifies the address of the variable in which to return the requested information. - - - Copy a LUT buffer to a digitizer's physical LUT. - Specifies the identifier of the digitizer. - Specifies the LUT buffer identifier. - - - Select a digitization reference level. - Specifies the identifier of the digitizer on which to set the reference level. - Specifies the reference level type to adjust for the specified digitizer. - Specifies the level of reference. - - - Inquire about a display setting. - Specifies the identifier of the display. - Specifies the type of display setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information does not fit into aMIL_INT, this function will return M_NULL or truncate the information. - This overload will adjust the size of the StringBuilder object - - - - Select an image buffer to display in a window. - - Specifies the identifier of the display. - Specifies the image buffer to display. - Specifies the to display the buffer into. - - - - Gets the parameters from the function context and executes the slave function. - - The of the slave function context. - - - - - - - - - - - Get the specified type of result(s) from a Dot Matrix Reader result buffer. - Specifies the identifier of the Dot Matrix Reader result buffer from which to retrieve results. - Specifies to get string results (one or all) or to get general results. - Specifies the character (one or all) for which to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Inquire about a Dot Matrix Reader font. - Specifies the identifier of the Dot Matrix Reader context that contains the font about which to inquire. - Specifies the font (one or all) about which to inquire. - Specifies the index of a character in the font. - Specifies the name (symbol) of a character in the font. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information does not fit into aMIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a Dot Matrix Reader font. - Specifies the identifier of the Dot Matrix Reader context that contains the font about which to inquire. - Specifies the font (one or all) about which to inquire. - Specifies the index of a character in the font. - Specifies the name (symbol) of a character in the font. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information does not fit into aMIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a Dot Matrix Reader string model. - Specifies the identifier of the Dot Matrix Reader context that contains the string model about which to inquire. - Specifies the string model (one or all) about which to inquire. - Specifies how to apply the inquire to the string model. - Specifies the index entry of the permitted character constraint (control) about which to inquire. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information does not fit into aMIL_INT, this function will return M_NULL or truncate the information. - - - Set or retrieve the name of a font or string model in a Dot Matrix Reader context or a Dot Matrix Reader result buffer. - Specifies the identifier of the Dot Matrix Reader context or Dot Matrix Reader result buffer containing the font or string model with which to perform the name operation. - Specifies the type of name operation to perform. - Specifies the label or index value of the font or string model with which to perform the name operation. - Specifies the name. - Specifies the address at which to write the requested information. - Reserved for future expansion and must be set to M_DEFAULT . - - - Inquire global information about a specified Processing FPGA. - Specifies the identifier of the system that has the required Processing FPGA. - Specifies the Processing FPGA to inquire. - Specifies the information about which to inquire. - Specifies the address at which to write the requested information. - The returned value is M_VALID if successful. If the operation fails, M_NULL is returned. - - - Retrieve information about a MIL object. - Specifies the identifier of the MIL object. Depending on the inquire type, this object must have been allocated using a specific MIL allocation function. - Specifies the MIL object feature about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information does not fit into aMIL_INT, this function will return M_NULL or truncate the information. - - - Register a MIL_ID parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the MIL_ID of the MIL object passed to the MIL_ID parameter. - Specifies the type of the MIL object. - Specifies whether the MIL object will be used for input or output. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the length of the string in characters, including the null terminator. - Specifies whether the parameter will be used for data input or to store new data. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - - MimDataAugment - - Id of the data augment context to use. - Id of the source buffer. - Id of the destination buffer. - Seed value for the random generator. - Operation controlFlag - - - Project a 2D image into 1D. - Specifies the identifier of the data source of the image. - Specifies the identifier of the destination of the projection results or a destination image buffer. - Specifies the angle of projection, in degrees. - - - Calculate a variety of statistics on the source image. - Specifies the identifier of the source image for the operation. This parameter must be given a 1-band image buffer identifier. - Specifies the identifier of the destination result buffer for the operation. - Specifies the type of statistic to compute. - Specifies the condition for the statistical computation. - Specifies the lower limit of the selected condition. - Specifies the upper limit of the selected condition. - - - Calculates and stores a variety of statistics from the specified source images. - Specifies the identifier of the image processing context that specifies the statistics to calculate. - Specifies the identifier of the source image buffer. - Specifies the identifier of the result buffer. - Specifies the operation to perform on the source image. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target display. - Specifies the type of display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - This overload will adjust the size of the StringBuilder object - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Compute the transformation that aligns two point clouds. - Specifies the identifier of a pairwise 3D alignment context, allocated using M3dmapAlloc with M_PAIRWISE_ALIGNMENT_CONTEXT. - Specifies the 3D reconstruction result buffer of type M_POINT_CLOUD_CONTAINER that contains the model point cloud(s). - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, that represents the model. - Specifies the 3D reconstruction result buffer of type M_POINT_CLOUD_CONTAINER that contains the scene point cloud(s). - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, that represents the scene. - Specifies a transformation matrix in a pairwise 3D alignment result buffer or 4x4 MIL array buffer, which is used to prealign the model before the pairwise 3D alignment process begins. - Specifies a pairwise 3D alignment result buffer or 4x4 MIL array buffer used to store the results from the pairwise 3D alignment process. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D alignment status of the alignment operation. - - - Perform a point-to-point arithmetic operation on depth maps and geometry objects. - Specifies the data source of the first operand. - Specifies the data source of the second operand. - Specifies the identifier of the destination image buffer in which to put the result of the arithmetic operation. - Specifies the identifier of the image buffer used as a mask. - Specifies the operation to perform. - Specifies how to handle the camera calibration information of the destination buffer. - - - Copy a single point cloud from one M_POINT_CLOUD_CONTAINER result buffer to another, according to the specified condition. - Specifies the identifier of the 3D reconstruction result buffer containing the source point cloud to copy. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud to copy from the source M_POINT_CLOUD_CONTAINER result buffer. - Specifies the identifier of the 3D reconstruction result buffer in which to copy the source point cloud. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. You can specify the same identifier as the SrcResult3dmapId identifier, but the label to assign the copied point cloud must be different. - Specifies a new label in the destination M_POINT_CLOUD_CONTAINER result buffer in which to copy the source point cloud. - Specifies the attribute on which the condition is based. - Specifies the identifier of the image buffer to use as an input condition. - Specifies the condition under which pixel values are considered true for copying the corresponding point in a point cloud. - Specifies the lower limit of the selected condition. - Specifies the upper limit of the selected condition. - Reserved for future expansion and must be set to M_DEFAULT . - - - Exports one or more point clouds from an M_POINT_CLOUD_CONTAINER result buffer to a CAD file. - Specifies the name and path of the CAD file in which to save the data buffer. - Specifies the file format of the CAD file. - Specifies the identifier of the 3D reconstruction result buffer containing the point clouds to export. - Specifies the label or index of a specific point cloud in the M_POINT_CLOUD_CONTAINER result buffer. - Specifies which points of the point cloud(s) to export. - Specifies to cast the position coordinates into the specified data type and depth. - Specifies whether to export the intensity values and, if exporting, specifies the data type and depth to which to cast the intensity values. - Reserved for future expansion and must be set to M_DEFAULT . - - - Generate a depth map image and, optionally, an intensity map image from data stored in a 3D reconstruction result buffer. - Specifies the identifier of the result buffer which contains the laser line data. - Specifies the identifier of the image buffer in which to store the depth map. The image buffer must be a 1-band, 8-bit or 16-bit unsigned buffer. - Specifies the identifier of the intensity image buffer. - Specifies the type of operation to perform. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer from which to create a fully corrected depth map. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Import a computer-aided design (CAD) file as a new point cloud. - Specifies the name and path of the file from which to import the point cloud. - Specifies the file format of the file to import. - Specifies the identifier of the 3D reconstruction result buffer, allocated using M3dmapAllocResult, into which to import the CAD file information. - Specifies a label for the point cloud in the specified result buffer into which the CAD file information is imported. - Specifies a calibrated MIL object whose relative coordinate system is used to interpret the given 3D points. - Reserved for future expansion and must be set to M_DEFAULT . - - - Calculates a distance between a source point cloud and a source geometry object. - Specifies the identifier of a 3D reconstruction result buffer containing the source point cloud. - Specifies a point cloud in the source M_POINT_CLOUD_CONTAINER result buffer. - Specifies the identifier of a geometry object or, if set to M_NULL , indicates the calculated metric applies to the source point cloud only. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the identifier of the destination image buffer in which to put the result of the calculate operation. - Specifies the operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Store world points inside a new or existing unorganized point cloud. - Specifies the identifier of the 3D reconstruction result buffer in which to store the points. - Specifies the label or index of the point cloud in which to add or replace point data. - Specifies the type of data (position or intensity) to overwrite/add to the point cloud. - Specifies a combination of two values: the data type and depth of the data in the arrays. - Specifies the number of elements in each specified array. - Specifies the address of an array containing the X-coordinates or the intensities of the points, or a packed array containing all the data of the points. - Specifies the address of an array containing the Y-coordinates of the points. - Specifies the address of an array containing the Z-coordinates of the points. - Specifies a calibrated MIL object whose relative coordinate system is used to express the given 3D points. - Specifies if points are added to the point cloud, or features are changed. - - - Store world points inside a new or existing unorganized point cloud. - Specifies the identifier of the 3D reconstruction result buffer in which to store the points. - Specifies the label or index of the point cloud in which to add or replace point data. - Specifies the type of data (position or intensity) to overwrite/add to the point cloud. - Specifies a combination of two values: the data type and depth of the data in the arrays. - Specifies the number of elements in each specified array. - Specifies the address of an array containing the X-coordinates or the intensities of the points, or a packed array containing all the data of the points. - Specifies the address of an array containing the Y-coordinates of the points. - Specifies the address of an array containing the Z-coordinates of the points. - Specifies a calibrated MIL object whose relative coordinate system is used to express the given 3D points. - Specifies if points are added to the point cloud, or features are changed. - - - Store world points inside a new or existing unorganized point cloud. - Specifies the identifier of the 3D reconstruction result buffer in which to store the points. - Specifies the label or index of the point cloud in which to add or replace point data. - Specifies the type of data (position or intensity) to overwrite/add to the point cloud. - Specifies a combination of two values: the data type and depth of the data in the arrays. - Specifies the number of elements in each specified array. - Specifies the address of an array containing the X-coordinates or the intensities of the points, or a packed array containing all the data of the points. - Specifies the address of an array containing the Y-coordinates of the points. - Specifies the address of an array containing the Z-coordinates of the points. - Specifies a calibrated MIL object whose relative coordinate system is used to express the given 3D points. - Specifies if points are added to the point cloud, or features are changed. - - - Store world points inside a new or existing unorganized point cloud. - Specifies the identifier of the 3D reconstruction result buffer in which to store the points. - Specifies the label or index of the point cloud in which to add or replace point data. - Specifies the type of data (position or intensity) to overwrite/add to the point cloud. - Specifies a combination of two values: the data type and depth of the data in the arrays. - Specifies the number of elements in each specified array. - Specifies the address of an array containing the X-coordinates or the intensities of the points, or a packed array containing all the data of the points. - Specifies the address of an array containing the Y-coordinates of the points. - Specifies the address of an array containing the Z-coordinates of the points. - Specifies a calibrated MIL object whose relative coordinate system is used to express the given 3D points. - Specifies if points are added to the point cloud, or features are changed. - - - Store world points inside a new or existing unorganized point cloud. - Specifies the identifier of the 3D reconstruction result buffer in which to store the points. - Specifies the label or index of the point cloud in which to add or replace point data. - Specifies the type of data (position or intensity) to overwrite/add to the point cloud. - Specifies a combination of two values: the data type and depth of the data in the arrays. - Specifies the number of elements in each specified array. - Specifies the address of an array containing the X-coordinates or the intensities of the points, or a packed array containing all the data of the points. - Specifies the address of an array containing the Y-coordinates of the points. - Specifies the address of an array containing the Z-coordinates of the points. - Specifies a calibrated MIL object whose relative coordinate system is used to express the given 3D points. - Specifies if points are added to the point cloud, or features are changed. - - - Store world points inside a new or existing unorganized point cloud. - Specifies the identifier of the 3D reconstruction result buffer in which to store the points. - Specifies the label or index of the point cloud in which to add or replace point data. - Specifies the type of data (position or intensity) to overwrite/add to the point cloud. - Specifies a combination of two values: the data type and depth of the data in the arrays. - Specifies the number of elements in each specified array. - Specifies the address of an array containing the X-coordinates or the intensities of the points, or a packed array containing all the data of the points. - Specifies the address of an array containing the Y-coordinates of the points. - Specifies the address of an array containing the Z-coordinates of the points. - Specifies a calibrated MIL object whose relative coordinate system is used to express the given 3D points. - Specifies if points are added to the point cloud, or features are changed. - - - Store world points inside a new or existing unorganized point cloud. - Specifies the identifier of the 3D reconstruction result buffer in which to store the points. - Specifies the label or index of the point cloud in which to add or replace point data. - Specifies the type of data (position or intensity) to overwrite/add to the point cloud. - Specifies a combination of two values: the data type and depth of the data in the arrays. - Specifies the number of elements in each specified array. - Specifies the address of an array containing the X-coordinates or the intensities of the points, or a packed array containing all the data of the points. - Specifies the address of an array containing the Y-coordinates of the points. - Specifies the address of an array containing the Z-coordinates of the points. - Specifies a calibrated MIL object whose relative coordinate system is used to express the given 3D points. - Specifies if points are added to the point cloud, or features are changed. - - - Store world points inside a new or existing unorganized point cloud. - Specifies the identifier of the 3D reconstruction result buffer in which to store the points. - Specifies the label or index of the point cloud in which to add or replace point data. - Specifies the type of data (position or intensity) to overwrite/add to the point cloud. - Specifies a combination of two values: the data type and depth of the data in the arrays. - Specifies the number of elements in each specified array. - Specifies the address of an array containing the X-coordinates or the intensities of the points, or a packed array containing all the data of the points. - Specifies the address of an array containing the Y-coordinates of the points. - Specifies the address of an array containing the Z-coordinates of the points. - Specifies a calibrated MIL object whose relative coordinate system is used to express the given 3D points. - Specifies if points are added to the point cloud, or features are changed. - - - Set the extraction box used for depth map extraction. - Specifies the identifier of the 3D reconstruction result buffer for which to specify the extraction box. The 3D reconstruction result buffer must be a point cloud container, which means it must have been allocated on the required system using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the type of box to set. - Specifies how the extraction box is defined. - Specifies the X-coordinate of the first point used to define the extraction box, or specifies a MIL identifier used to define the extraction box. - Specifies the Y-coordinate of the first point used to define the extraction box. - Specifies the Z-coordinate of the first point used to define the extraction box. - Specifies the X-coordinate of the second point used to define the extraction box, or the length of the extraction box along the X-axis. - Specifies the Y-coordinate of the second point used to define the extraction box, or the length of the extraction box along the Y-axis. - Specifies the Z-coordinate of the second point used to define the extraction box, or the length of the extraction box along the Z-axis. - - - Define a geometry object, either parametrically or by fitting it to a depth map or point cloud. - Specifies the identifier of a geometry object. - Specifies the type of geometry object to define. - Specifies whether to define the geometry object by providing explicit values for the geometry's equation or by applying a best-fit geometry operation on the depth map or point cloud. - Specifies information about the geometry object used for the operation. - Specifies information about the geometry object used for the operation. - Specifies information about the geometry object used for the operation. - Specifies information about the geometry object used for the operation. - Specifies information about the geometry object used for the operation. - - - Compute a variety of statistics on a depth map. - Specifies the image buffer identifier of the depth map on which to compute statistics. - Specifies what will be used as reference level for statistics computation. - Specifies the identifier of the image buffer to use as a mask, if needed. - Specifies the result buffer identifier, if needed. - Specifies what statistics to compute. - Specifies the outlier distance to use to exclude pixels from the statistics. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies where to write the results, if needed. - - - Compute a variety of statistics on a depth map. - Specifies the image buffer identifier of the depth map on which to compute statistics. - Specifies what will be used as reference level for statistics computation. - Specifies the identifier of the image buffer to use as a mask, if needed. - Specifies the result buffer identifier, if needed. - Specifies what statistics to compute. - Specifies the outlier distance to use to exclude pixels from the statistics. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies where to write the results, if needed. - - - Set or retrieve the name of a feature or tolerance, or retrieve the label or index of a specified feature or tolerance. - Specifies the identifier of the metrology context or result buffer containing the feature or tolerance to read or modify. The metrology context or the metrology result buffer must have been previously allocated on the required system using MmetAlloc or MmetAllocResult, respectively. - Specifies the type of operation to perform. - Specifies the label or index value of the metrology feature or tolerance. - Specifies the name to set or retrieve, depending on the Operation parameter. - Specifies the address at which to write the requested information. - Reserved for future expansion and must be set to M_DEFAULT . - - - Inquire about a MIL object setting in a Distributed MIL publishing application. - Specifies the identifier of the MIL object about which to inquire. - Specifies the MIL object setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information does not fit into aMIL_INT, this function will return M_NULL or truncate the information. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information does not fit into aMIL_INT, this function will return M_NULL or truncate the information. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies the parameter about which to inquire. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Save a Pattern Matching context to disk. - Specifies the name and path of the file in which to save the model. - Specifies the identifier of the Pattern Matching context to save. - - - Save a Pattern Matching context to disk. - Specifies the name and path of the file in which to save the model. - Specifies the identifier of the Pattern Matching context to save. - - - Automatically allocate unique pattern matching models of the specified type, from a source image. - Specifies the system on which to allocate the models. - Specifies the identifier of the image buffer from which to extract the models. - Specifies the width of the required models. - Specifies the height of the required models. - Specifies the maximum displacement (shift) expected between the reference position of the models in the source image and their position when found in the target images in the horizontal direction. - Specifies the maximum displacement (shift) expected between the reference position of the models in the source image and their position when found in the target images in the vertical direction. - Specifies the type of the model. - Specifies the speed of the allocation process. - Specifies the address of the array in which to write the model identifiers. - The returned value is the model identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Automatically allocate unique pattern matching models of the specified type, from a source image. - Specifies the system on which to allocate the models. - Specifies the identifier of the image buffer from which to extract the models. - Specifies the width of the required models. - Specifies the height of the required models. - Specifies the maximum displacement (shift) expected between the reference position of the models in the source image and their position when found in the target images in the horizontal direction. - Specifies the maximum displacement (shift) expected between the reference position of the models in the source image and their position when found in the target images in the vertical direction. - Specifies the type of the model. - Specifies the speed of the allocation process. - Specifies the address of the array in which to write the model identifiers. - The returned value is the model identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Automatically allocate unique pattern matching models of the specified type, from a source image. - Specifies the system on which to allocate the models. - Specifies the identifier of the image buffer from which to extract the models. - Specifies the width of the required models. - Specifies the height of the required models. - Specifies the maximum displacement (shift) expected between the reference position of the models in the source image and their position when found in the target images in the horizontal direction. - Specifies the maximum displacement (shift) expected between the reference position of the models in the source image and their position when found in the target images in the vertical direction. - Specifies the type of the model. - Specifies the speed of the allocation process. - Specifies the address of the array in which to write the model identifiers. - The returned value is the model identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a pattern matching model from a source image. - Specifies the system on which to allocate the model. - Specifies the identifier of the image buffer from which to extract the model (that is, the model's source image). This function currently supports only 8-bit unsigned grayscale images. - Specifies the coordinates of the model origin in the source image ( SrcImageBufId ). - Specifies the coordinates of the model origin in the source image ( SrcImageBufId ). - Specifies the width of the model. - Specifies the height of the model. - Specifies the type of the model. - Specifies the address of the variable in which to write the model identifier. - The returned value is the model identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a pattern matching model from a source image. - Specifies the system on which to allocate the model. - Specifies the identifier of the image buffer from which to extract the model (that is, the model's source image). This function currently supports only 8-bit unsigned grayscale images. - Specifies the coordinates of the model origin in the source image ( SrcImageBufId ). - Specifies the coordinates of the model origin in the source image ( SrcImageBufId ). - Specifies the width of the model. - Specifies the height of the model. - Specifies the type of the model. - Specifies the address of the variable in which to write the model identifier. - The returned value is the model identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Rotate a pattern matching model. - Specifies the system on which to allocate the rotated model. - Specifies the identifier of the source model. - Specifies the angle at which to rotate the model in a counter-clockwise direction. - Specifies the mode of interpolation. - Specifies the type of the new model. - Specifies the address of the variable in which to write the rotated model identifier. - The returned value is the model identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Rotate a pattern matching model. - Specifies the system on which to allocate the rotated model. - Specifies the identifier of the source model. - Specifies the angle at which to rotate the model in a counter-clockwise direction. - Specifies the mode of interpolation. - Specifies the type of the new model. - Specifies the address of the variable in which to write the rotated model identifier. - The returned value is the model identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Copy a pattern matching model to an image buffer. - Specifies the identifier of the model that you want copied to the image buffer. - Specifies the identifier of the destination image buffer in which to place the model. - Specifies how the model will be copied. - - - Find a pattern matching model in the target image buffer. - Specifies the identifier of the target image. - Specifies the identifier of the model for which to search in the specified target image buffer. - Specifies the identifier of the pattern matching result buffer in which to store results. - - - Find multiple pattern matching models in the target image buffer. - Specifies the identifier of the target image buffer. - Specifies the address of the one-dimensional array that contains the identifiers of the models for which to search in the specified target image buffer. - Specifies the address of the one-dimensional array that contains the identifiers of the pattern matching result buffers in which to store results. - Specifies the number of models. - Specifies the search mode. - - - Find multiple pattern matching models in the target image buffer. - Specifies the identifier of the target image buffer. - Specifies the address of the one-dimensional array that contains the identifiers of the models for which to search in the specified target image buffer. - Specifies the address of the one-dimensional array that contains the identifiers of the pattern matching result buffers in which to store results. - Specifies the number of models. - Specifies the search mode. - - - Get the number of model occurrences found in the target image. - Specifies the identifier of the pattern matching result buffer that was used to store results obtained by MpatFindModel . - Specifies the address of the variable in which to write the number of occurrences. - The returned value is the number of occurrences of the model that were found and that were greater than or equal to the acceptance level. - - - Get the number of model occurrences found in the target image. - Specifies the identifier of the pattern matching result buffer that was used to store results obtained by MpatFindModel . - The returned value is the number of occurrences of the model that were found and that were greater than or equal to the acceptance level. - - - Get the number of model occurrences found in the target image. - Specifies the identifier of the pattern matching result buffer that was used to store results obtained by MpatFindModel . - Specifies the address of the variable in which to write the number of occurrences. - The returned value is the number of occurrences of the model that were found and that were greater than or equal to the acceptance level. - - - Preprocess a pattern matching model. - Specifies the identifier of a typical target image. - Specifies the identifier of the model to preprocess. - Specifies the preprocessing mode. Set this parameter to M_DEFAULT. - - - Restore a pattern matching model from disk. - Specifies the system on which to restore the model. - Specifies the name and path of the file from which to restore the model. - Specifies the address of the variable in which to write the model identifier. - The returned value is the model identifier. If allocation fails, M_NULL is returned. - - - Restore a pattern matching model from disk. - Specifies the system on which to restore the model. - Specifies the name and path of the file from which to restore the model. - Specifies the address of the variable in which to write the model identifier. - The returned value is the model identifier. If allocation fails, M_NULL is returned. - - - Set the acceptance level of a model. - Specifies the identifier of the model for which to change the acceptance threshold search parameter. - Specifies the acceptance level, as a percentage. - - - Set the positional accuracy of a model. - Specifies the identifier of the model for which to change the positional accuracy search parameter. - Specifies the required positional accuracy for the search. - - - Set the angular search parameters of a model. - Specifies the identifier of the model for which to change the angular search parameter. - Specifies the type of control to set. - Specifies the value to which to set the control. - - - Set the reference position of a model. - Specifies the identifier of the model for which to change the reference position. - Specifies the X-offset of the new model's reference position relative to the model origin. - Specifies the Y-offset of the new model's reference position relative to the model origin. - - - Set the certainty level of a model. - Specifies the identifier of the model for which to change the certainty threshold search parameter. - Specifies the certainty level, as a percentage. - - - Set the "don't care" pixels in a model. - Specifies the identifier of the model in which to set "don't care" pixels. - Specifies the identifier of the image buffer used to identify which pixels in the model will be set to "don't care". - Specifies the X-offset from the upper-left corner of the specified image buffer to the upper-left corner of the pixel-value comparison area. - Specifies the Y-offset from the upper-left corner of the specified image buffer to the upper-left corner of the pixel-value comparison area. - Specifies the pixel value in the image buffer that determine the corresponding "don't care" pixels. - - - Set the expected number of occurrences of a model. - Specifies the identifier of the model for which to set the expected number of occurrences. - Specifies the maximum number of occurrences for which to look in the target image. - - - Set the search region of a model. - Specifies the identifier of the model for which to change the search region. - Specifies the X-coordinate of the top-left corner of the search region in the target image. - Specifies the Y-coordinate of the top-left corner of the search region in the target image. - Specifies the width of the search region. - Specifies the height of the search region. - - - Set the internal search parameters of a model. - Specifies the identifier of the model whose search parameter to change, or of the result buffer. - Specifies the search parameter to set. - Specifies the value to which to set the specified parameter. - - - Set search speed of a model. - Specifies the identifier of the model for which to change the speed parameter. - Specifies the search speed. Set this parameter to one of the values below. - - - Inquire information about a sequence context or an individual source or destination setting. - Specifies the sequence context about which to inquire information. The sequence context must have been previously allocated using MseqAlloc . - Specifies that the sequence context, the source of an input, or a destination of an output is inquired. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information does not fit into aMIL_INT, this function will return M_NULL or truncate the information. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert . - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into aMIL_INT, this function will return M_NULL or truncate the information. - - - Allocate a MIL system. - Specifies the type of system to allocate. Set this parameter to one of the following values: - Specifies the number (or rank) of the target board of the specified system type. - Specifies the type of initialization to perform on the selected system. - Specifies the address of the variable in which to write the system identifier. - The returned value is the system identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL system. - Specifies the type of system to allocate. Set this parameter to one of the following values: - Specifies the number (or rank) of the target board of the specified system type. - Specifies the type of initialization to perform on the selected system. - Specifies the address of the variable in which to write the system identifier. - The returned value is the system identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a system setting. - Specifies the system identifier. - Specifies the type of setting to control. - Specifies the new value to assign to the system setting specified by the ControlType parameter. - - - Get information about a hook event. - Specifies the identifier of the system. - Specifies the system event identifier received by the hook-handler function (see MsysHookFunction ). - Specifies the type of information about which to inquire. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Inquire about a system setting. - Specifies the system identifier. This parameter should be set to one of the following values: - Specifies the type of system setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information does not fit into aMIL_INT, this function will return M_NULL or truncate the information. - - - Allocate a 3D display. - Specifies the system on which to allocate the 3D display. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to MIL_TEXT("M_DEFAULT"). - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D display identifier. - The returned value is the 3D display identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D display. - Specifies the system on which to allocate the 3D display. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to MIL_TEXT("M_DEFAULT"). - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D display identifier. - The returned value is the 3D display identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to control. - Specifies the new value to assign to the 3D display setting specified by the ControlType parameter. - - - Control a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to control. - Specifies the new value to assign to the 3D display setting specified by the ControlType parameter. - - - Copy data to or from a 3D display. - Specifies the identifier of the source object. Note that if the source object is not a 3D display, the destination object must be. - Specifies the identifier of the destination object. Note that if the destination object is not a 3D display, the source object must be. - Specifies the type of copy operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a 3D display. - Specifies the identifier of a 3D display previously allocated with M3ddispAlloc. - - - Get information about the 3D display's view. - Specifies the identifier of the 3D display. - Specifies which aspect of the view to inquire. - Specifies the address of the variable in which to write either the X-coordinate, distance, azimuth, elevation, or roll. - Specifies the address of the variable in which to write either the Y-coordinate or elevation. - Specifies the address of the variable in which to write either the Z-coordinate or roll. - Reserved for future expansion and must be set to M_DEFAULT . - - - Get information about the 3D display's view. - Specifies the identifier of the 3D display. - Specifies which aspect of the view to inquire. - Specifies the address of the variable in which to write either the X-coordinate, distance, azimuth, elevation, or roll. - Specifies the address of the variable in which to write either the Y-coordinate or elevation. - Specifies the address of the variable in which to write either the Z-coordinate or roll. - Reserved for future expansion and must be set to M_DEFAULT . - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire a MIL 3D display setting. - Specifies the identifier of the target 3D display, previously allocated using M3ddispAlloc. - Specifies the type of 3D display setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Add or remove a 3D-displayable container or fully-corrected depth map image buffer to/from the 3D display, and/or open or close the window associated with the 3D display. - Specifies the identifier of the 3D display, previously allocated using M3ddispAlloc. - Specifies the MIL identifier of the 3D-displayable container, or fully corrected depth map image buffer, to display. - Specifies the action to perform on the specified 3D display. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the point cloud container added to the 3D graphics list of the 3D display. - - - Select a 3D container to display in a user-defined window. - Specifies the identifier of the 3D display, previously allocated using M3ddispAlloc. - Specifies the MIL identifier of the 3D-displayable container, or fully corrected depth map image buffer, to display. - Specifies the action to perform on the specified 3D display. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the window handle of the user-defined window or child window. - Returns the label of the point cloud container added to the 3D graphics list of the 3D display. - - - Sets the display's view. - Specifies the identifier of the 3D display. - Specifies the mode used for setting the view. - Specifies the first parameter used to set the view. - Specifies the second parameter used to set the view. - Specifies the third parameter used to set the view. - Specifies if the 3D display should be refreshed. - - - Allocate a 3D geometry object or transformation matrix object. - Specifies the identifier of the system on which to allocate the 3D geometry object or transformation matrix object. - Specifies to allocate a 3D geometry object or transformation matrix object. This parameter must be set to one of the following: - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D geometry object or transformation matrix object identifier. - The returned value is the 3D geometry object or transformation matrix object identifier if allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D geometry object or transformation matrix object. - Specifies the identifier of the system on which to allocate the 3D geometry object or transformation matrix object. - Specifies to allocate a 3D geometry object or transformation matrix object. This parameter must be set to one of the following: - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D geometry object or transformation matrix object identifier. - The returned value is the 3D geometry object or transformation matrix object identifier if allocation is successful. If allocation fails, M_NULL is returned. - - - Define a 3D box geometry object. - Specifies the identifier of the 3D geometry object, previously allocated on the required system using M3dgeoAlloc with M_GEOMETRY. - Specifies how the box is defined. - Specifies the X-coordinate of the first point used to define the box. - Specifies the Y-coordinate of the first point used to define the box. - Specifies the Z-coordinate of the first point used to define the box. - Specifies the X-coordinate of the second point used to define the box, or the length of the box along the X-axis. - Specifies the Y-coordinate of the second point used to define the box, or the length of the box along the Y-axis. - Specifies the Z-coordinate of the second point used to define the box, or the length of the box along the Z-axis. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy attributes or settings to or from a 3D geometry object or transformation matrix object. - Specifies the identifier of the source object. Note that if the source object is not a predefined or user-defined 3D geometry object or transformation matrix object, the destination object must be. - Specifies the identifier of the destination object. Note that if the destination object is not a predefined or user-defined 3D geometry object or transformation matrix object, the source object must be. - Specifies the type of copy operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Define a 3D cylinder geometry object. - Specifies the identifier of the 3D geometry object, previously allocated on the required system using M3dgeoAlloc with M_GEOMETRY. - Specifies how the cylinder is defined. - Specifies the X-coordinate of a point on the cylinder's central axis. - Specifies the Y-coordinate of a point on the cylinder's central axis. - Specifies the Z-coordinate of a point on the cylinder's central axis. - Specifies the X-coordinate of the cylinder's second defining point, or the X-component of the cylinder's central axis vector. - Specifies the Y-coordinate of the cylinder's second defining point, or the Y-component of the cylinder's central axis vector. - Specifies the Z-coordinate of the cylinder's second defining point, or the Z-component of the cylinder's central axis vector. - Specifies the cylinder's radius. - Specifies to override the default cylinder length. - Reserved for future expansion and must be set to M_DEFAULT . - - - Draw the geometry, defined in the specified 3D geometry object, into a 3D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the identifier of the 3D geometry object to draw into the 3D graphics list. The 3D geometry object must have been previously allocated using M3dgeoAlloc with M_GEOMETRY, and defined using M3dgeoBox, M3dgeoCylinder, M3dgeoLine, M3dgeoPlane, or M3dgeoSphere. - Specifies the identifier of the 3D graphics list in which to draw. The 3D graphics list must have been previously allocated using M3dgraAlloc. - Specifies the label of the 3D graphic in the 3D graphics list to be used as the geometry's parent. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the 3D graphic added to the 3D graphics list. - - - Free a 3D geometry object or transformation matrix object. - Specifies the identifier of the 3D geometry object or transformation matrix object to free. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D geometry object setting or transformation matrix object setting. - Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Define an arbitrary 3D line geometry object. - Specifies the identifier of the 3D geometry object, previously allocated on the required system using M3dgeoAlloc with M_GEOMETRY. - Specifies how the line is defined. - Specifies the X-coordinate of the first point used to define the line. - Specifies the Y-coordinate of the first point used to define the line. - Specifies the Z-coordinate of the first point used to define the line. - Specifies the X-coordinate of the second point used to define the line, or the X-component of the vector defining the line's direction and length (if Length is M_DEFAULT). - Specifies the Y-coordinate of the second point used to define the line, or the Y-component of the vector defining the line's direction and length (if Length is M_DEFAULT). - Specifies the Z-coordinate of the second point used to define the line, or the Z-component of the vector defining the line's direction and length (if Length is M_DEFAULT). - Specifies to override the default line length. - Reserved for future expansion and must be set to M_DEFAULT . - - - Get data from a transformation matrix object and place it in a user-supplied array. - Specifies the identifier of the source transformation matrix object. The transformation matrix object must have been previously allocated using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the user array in which to copy the data from the transformation matrix. - - - Get data from a transformation matrix object and place it in a user-supplied array. - Specifies the identifier of the source transformation matrix object. The transformation matrix object must have been previously allocated using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the user array in which to copy the data from the transformation matrix. - - - Get the translation, rotation, or scale defined by a given transformation matrix object. - Specifies the identifier of the transformation matrix object. The transformation matrix object must have been previously allocated using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Specifies the type of transformation to retrieve from the given transformation matrix object. - Specifies the first address in which to return information about the transformation required. - Specifies the second address in which to return information about the transformation required. - Specifies the third address in which to return information about the transformation required. - Specifies the fourth address in which to return information about the transformation required. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put data from a user-supplied array into a transformation matrix object. - Specifies the identifier of the transformation matrix object. The transformation matrix object must have been previously allocated using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the user array from which to copy the data into the transformation matrix object. - - - Put data from a user-supplied array into a transformation matrix object. - Specifies the identifier of the transformation matrix object. The transformation matrix object must have been previously allocated using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the user array from which to copy the data into the transformation matrix object. - - - Set the transformation values of a transformation matrix object. - Specifies the identifier of the transformation matrix object. The transformation matrix object must have been previously allocated using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Specifies the type of transformation to apply. - Specifies the first parameter used to define the transformation matrix. - Specifies the second parameter used to define the transformation matrix. - Specifies the third parameter used to define the transformation matrix. - Specifies the fourth parameter used to define the transformation matrix. - Specifies how to apply the transformation. - - - Defines a transformation matrix that can transform points from the working coordinate system into the specified coordinate system, or vice versa. - Specifies the identifier of the transformation matrix object, previously allocated on the required system using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Specifies which two axes to use to define the new coordinate system. The first letter determines the first axis, and the second letter determines the second axis. - Specifies the X-coordinate of the new coordinate system's origin, expressed in the working coordinate system. - Specifies the Y-coordinate of the new coordinate system's origin, expressed in the working coordinate system. - Specifies the Z-coordinate of the new coordinate system's origin, expressed in the working coordinate system. - Specifies the X-component of the vector aligned with the new coordinate system's first axis, expressed in the working coordinate system. - Specifies the Y-component of the vector aligned with the new coordinate system's first axis, expressed in the working coordinate system. - Specifies the Z-component of the vector aligned with the new coordinate system's first axis, expressed in the working coordinate system. - Specifies the approximate X-component of the vector aligned with the new coordinate system's second axis, expressed in the working coordinate system. - Specifies the approximate Y-component of the vector aligned with the new coordinate system's second axis, expressed in the working coordinate system. - Specifies the approximate Z-component of the vector aligned with the new coordinate system's second axis, expressed in the working coordinate system. - Reserved for future expansion and must be set to M_DEFAULT . - - - Define a 3D plane geometry object. - Specifies the identifier of the 3D geometry object, previously allocated on the required system using M3dgeoAlloc with M_GEOMETRY. - Specifies how the plane is defined. - Specifies the first parameter used to define the plane. - Specifies the second parameter used to define the plane. - Specifies the third parameter used to define the plane. - Specifies the fourth parameter used to define the plane. - Specifies the fifth parameter used to define the plane. - Specifies the sixth parameter used to define the plane. - Specifies the seventh parameter used to define the plane. - Specifies the eighth parameter used to define the plane. - Specifies the ninth parameter used to define the plane. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Restore a 3D geometry object or transformation matrix object from disk. - Specifies the name and path of the file from which to restore the 3D geometry object or transformation matrix object. - Specifies the system on which to restore the 3D geometry object or transformation matrix object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D geometry object or transformation matrix object identifier. - The returned value is the 3D geometry object or a transformation matrix object identifier. If allocation fails, M_NULL is returned. - - - Restore a 3D geometry object or transformation matrix object from disk. - Specifies the name and path of the file from which to restore the 3D geometry object or transformation matrix object. - Specifies the system on which to restore the 3D geometry object or transformation matrix object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D geometry object or transformation matrix object identifier. - The returned value is the 3D geometry object or a transformation matrix object identifier. If allocation fails, M_NULL is returned. - - - Save a 3D geometry object or transformation matrix object to a file. - Specifies the name and path of the file in which to save the 3D geometry object or transformation matrix object; it is recommended that you use the M3DGEO file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the 3D geometry object or transformation matrix object to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a 3D geometry object or transformation matrix object to a file. - Specifies the name and path of the file in which to save the 3D geometry object or transformation matrix object; it is recommended that you use the M3DGEO file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the 3D geometry object or transformation matrix object to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Define a 3D sphere geometry object. - Specifies the identifier of the 3D geometry object, previously allocated on the required system using M3dgeoAlloc with M_GEOMETRY. - Specifies the X-coordinate of the sphere's center. - Specifies the Y-coordinate of the sphere's center. - Specifies the Z-coordinate of the sphere's center. - Specifies the sphere's radius. This parameter cannot be set to a negative value. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Load, restore, or save a 3D geometry object or transformation matrix object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D geometry object or transformation matrix object. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D geometry object or transformation matrix object. - Specifies the MIL version of the 3D geometry object or transformation matrix object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D geometry object or transformation matrix object. - Specifies the address of the variable in which to write the size of the 3D geometry object or transformation matrix object, in bytes. - - - Load, restore, or save a 3D geometry object or transformation matrix object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D geometry object or transformation matrix object. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D geometry object or transformation matrix object. - Specifies the MIL version of the 3D geometry object or transformation matrix object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D geometry object or transformation matrix object. - Specifies the address of the variable in which to write the size of the 3D geometry object or transformation matrix object, in bytes. - - - Load, restore, or save a 3D geometry object or transformation matrix object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D geometry object or transformation matrix object. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D geometry object or transformation matrix object. - Specifies the MIL version of the 3D geometry object or transformation matrix object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D geometry object or transformation matrix object. - Specifies the address of the variable in which to write the size of the 3D geometry object or transformation matrix object, in bytes. - - - Load, restore, or save a 3D geometry object or transformation matrix object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D geometry object or transformation matrix object. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D geometry object or transformation matrix object. - Specifies the MIL version of the 3D geometry object or transformation matrix object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D geometry object or transformation matrix object. - Specifies the address of the variable in which to write the size of the 3D geometry object or transformation matrix object, in bytes. - - - Load, restore, or save a 3D geometry object or transformation matrix object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D geometry object or transformation matrix object. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D geometry object or transformation matrix object. - Specifies the MIL version of the 3D geometry object or transformation matrix object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D geometry object or transformation matrix object. - Specifies the address of the variable in which to write the size of the 3D geometry object or transformation matrix object, in bytes. - - - Load, restore, or save a 3D geometry object or transformation matrix object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D geometry object or transformation matrix object. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D geometry object or transformation matrix object. - Specifies the MIL version of the 3D geometry object or transformation matrix object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D geometry object or transformation matrix object. - Specifies the address of the variable in which to write the size of the 3D geometry object or transformation matrix object, in bytes. - - - Add a 3D-displayable point cloud container or fully corrected depth map image buffer to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the 3D-displayable point cloud container or fully corrected depth map image buffer. - Specifies the label of the parent of the 3D-displayable point cloud container or fully corrected depth map image buffer. - Specifies the identifier of the 3D-displayable point cloud container or fully corrected depth map image buffer to add to the 3D graphics list. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Returns the label of the 3D-displayable point cloud container or fully corrected depth map image buffer added to the 3D graphics list. - - - Allocate a 3D graphics list. - Specifies the system on which to allocate the 3D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D graphics list identifier. - The returned value is the 3D graphics list identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D graphics list. - Specifies the system on which to allocate the 3D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D graphics list identifier. - The returned value is the 3D graphics list identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Add a circular arc graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the arc graphic. - Specifies the label of the parent of the arc graphic in the 3D graphics list. - Specifies how the arc graphic is defined. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the X-coordinate of the first point used to define the arc. - Specifies the Y-coordinate of the first point used to define the arc. - Specifies the Z-coordinate of the first point used to define the arc. - Specifies the X-coordinate of the second point used to define the arc. - Specifies the Y-coordinate of the second point used to define the arc. - Specifies the Z-coordinate of the second point used to define the arc. - Specifies the X-coordinate of the third point used to define the arc. - Specifies the Y-coordinate of the third point used to define the arc. - Specifies the Z-coordinate of the third point used to define the arc. - Specifies the angle used to define the arc. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the arc graphic added to the 3D graphics list. - - - Add an axis graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the axis graphic. - Specifies the label of the parent of the axis graphic in the 3D graphics list. - Specifies the identifier of the transformation matrix that defines the axis graphic's position and orientation with respect to its parent's coordinate system. - Specifies the length of the axes. - Specifies an optional name for the axis graphic (for example, "Working coordinate system"). If this parameter is not empty, this creates a text graphic with the axis graphic as its parent, and the axis name as its text. - Specifies extra options for the appearance of the Name text graphic. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the axis graphic added to the 3D graphics list. - - - Add a box graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the box graphic. - Specifies the label of the parent of the box graphic in the 3D graphics list. - Specifies how the box graphic is defined. - Specifies the X-coordinate of the first point used to define the box graphic. - Specifies the Y-coordinate of the first point used to define the box graphic. - Specifies the Z-coordinate of the first point used to define the box graphic. - Specifies the X-coordinate of the second point used to define the box graphic, or the length of the box graphic along its coordinate system's X-axis. - Specifies the Y-coordinate of the second point used to define the box graphic, or the length of the box graphic along its coordinate system's Y-axis. - Specifies the Z-coordinate of the second point used to define the box graphic, or the length of the box graphic along its coordinate system's Z-axis. - Specifies the identifier of the transformation matrix that defines the box graphic's orientation with respect to its parent's coordinate system. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the box graphic added to the 3D graphics list. - - - Control the 3D graphics in a 3D graphics list, as well as their default settings. - Specifies the identifier of the 3D graphics list to control. - Specifies the label of the 3D graphic to control. You can also control the default settings of the 3D graphics list itself. - Specifies the type of setting to control. - Specifies the required value for the setting. - - - Control the 3D graphics in a 3D graphics list, as well as their default settings. - Specifies the identifier of the 3D graphics list to control. - Specifies the label of the 3D graphic to control. You can also control the default settings of the 3D graphics list itself. - Specifies the type of setting to control. - Specifies the required value for the setting. - - - Copy an object into or out of a 3D graphics list. - Specifies the identifier of the source object. - Specifies the label of the 3D graphic in SrcMilObjectId, when the source object is a 3D graphics list. - Specifies identifier of the destination object. - Specifies the label of the 3D graphic in DstMilObjectId, when the destination object is a 3D graphics list. - Specifies the type of copy operation. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the 3D graphic copied into the destination 3D graphics list. If the copy type does not return a new label in the destination 3D graphics list, this function returns M_NO_LABEL . - - - Add a cylinder graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the cylinder graphic. - Specifies the label of the parent of the cylinder graphic in the 3D graphics list. - Specifies how the cylinder graphic is defined. - Specifies the first parameter used to define the cylinder graphic. - Specifies the second parameter used to define the cylinder graphic. - Specifies the third parameter used to define the cylinder graphic. - Specifies the fourth parameter used to define the cylinder graphic. - Specifies the fifth parameter used to define the cylinder graphic. - Specifies the sixth parameter used to define the cylinder graphic. - Specifies the cylinder graphic's radius. - Specifies to override the default cylinder graphic's length. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the cylinder graphic added to the 3D graphics list. - - - Add a dots graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the dots graphic. - Specifies the label of the parent of the dots graphic in the 3D graphics list. - Specifies the number of points in the dots graphic. - Specifies the list of X-coordinates of the points in the dots graphic. - Specifies the list of Y-coordinates of the points in the dots graphic. - Specifies the list of Z-coordinates of the points in the dots graphic. - Specifies the list of red values of the color of the points in the dots graphic. - Specifies the list of green values of the color of the points in the dots graphic. - Specifies the list of blue values of the color of the points in the dots graphic. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the dots graphic added to the 3D graphics list. - - - Add a dots graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the dots graphic. - Specifies the label of the parent of the dots graphic in the 3D graphics list. - Specifies the number of points in the dots graphic. - Specifies the list of X-coordinates of the points in the dots graphic. - Specifies the list of Y-coordinates of the points in the dots graphic. - Specifies the list of Z-coordinates of the points in the dots graphic. - Specifies the list of red values of the color of the points in the dots graphic. - Specifies the list of green values of the color of the points in the dots graphic. - Specifies the list of blue values of the color of the points in the dots graphic. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the dots graphic added to the 3D graphics list. - - - Add a dots graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the dots graphic. - Specifies the label of the parent of the dots graphic in the 3D graphics list. - Specifies the number of points in the dots graphic. - Specifies the list of X-coordinates of the points in the dots graphic. - Specifies the list of Y-coordinates of the points in the dots graphic. - Specifies the list of Z-coordinates of the points in the dots graphic. - Specifies the list of red values of the color of the points in the dots graphic. - Specifies the list of green values of the color of the points in the dots graphic. - Specifies the list of blue values of the color of the points in the dots graphic. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the dots graphic added to the 3D graphics list. - - - Add a dots graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the dots graphic. - Specifies the label of the parent of the dots graphic in the 3D graphics list. - Specifies the number of points in the dots graphic. - Specifies the list of X-coordinates of the points in the dots graphic. - Specifies the list of Y-coordinates of the points in the dots graphic. - Specifies the list of Z-coordinates of the points in the dots graphic. - Specifies the list of red values of the color of the points in the dots graphic. - Specifies the list of green values of the color of the points in the dots graphic. - Specifies the list of blue values of the color of the points in the dots graphic. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the dots graphic added to the 3D graphics list. - - - Free a 3D graphics list. - Specifies the identifier of the 3D graphics list to free. - - - Add a grid graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the grid graphic. - Specifies the label of the parent of the grid graphic in the 3D graphics list. - Specifies how the grid graphic is defined. - Specifies the identifier of the transformation matrix that defines the grid graphic's position and orientation with respect to its parent's coordinate system. - Specifies the first parameter used to define the grid. - Specifies the second parameter used to define the grid. - Specifies the third parameter used to define the grid. - Specifies the fourth parameter used to define the grid. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the grid graphic added to the 3D graphics list. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D graphic in a 3D graphics list. - Specifies the identifier of the 3D graphics list containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself. - Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself. - Specifies the type of setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Add a line graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the line graphic. - Specifies the label of the parent of the line graphic in the 3D graphics list. - Specifies how the line graphic is defined. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the first parameter used to define the line graphic. - Specifies the second parameter used to define the line graphic. - Specifies the third parameter used to define the line graphic. - Specifies the fourth parameter used to define the line graphic. - Specifies the fifth parameter used to define the line graphic. - Specifies the sixth parameter used to define the line graphic. - Specifies to override the default line graphic's length. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the line graphic added to the 3D graphics list. - - - Add a node to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the node. - Specifies the label of the parent of the node in the 3D graphics list. - Specifies the identifier of the transformation matrix that defines the node graphic's position and orientation with respect to its parent's coordinate system. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the node added to the 3D graphics list. - - - Add a plane graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the plane graphic. - Specifies the label of the parent of the plane graphic in the 3D graphics list. - Specifies how the plane graphic is defined. - Specifies the first parameter used to define the plane graphic. - Specifies the second parameter used to define the plane graphic. - Specifies the third parameter used to define the plane graphic. - Specifies the fourth parameter used to define the plane graphic. - Specifies the fifth parameter used to define the plane graphic. - Specifies the sixth parameter used to define the plane graphic. - Specifies the seventh parameter used to define the plane graphic. - Specifies the eighth parameter used to define the plane graphic. - Specifies the ninth parameter used to define the plane graphic. - Specifies the size of the plane graphic. Finite plane graphics are square-shaped. If the plane graphic is infinite, it is clipped using the 3D graphics list's clipping box, which results in a polygon with 3 to 6 edges. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Returns the label of the plane graphic added to the 3D graphics list. - - - Add a polygon graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the polygon graphic. - Specifies the label of the parent of the polygon graphic in the 3D graphics list. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the number of vertices in the polygon. - Specifies the list of X-coordinates of the vertices. - Specifies the list of Y-coordinates of the vertices. - Specifies the list of Z-coordinates of the vertices. - Specifies the list of X-coordinates of the points in the texture image that map to the specified vertices for the texture mapping. - Specifies the list of Y-coordinates of the points in the texture image that map to the specified vertices for the texture mapping. - Specifies the identifier of the image buffer to be used as a texture. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Returns the label of the polygon graphic added to the 3D graphics list. - - - Add a polygon graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the polygon graphic. - Specifies the label of the parent of the polygon graphic in the 3D graphics list. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the number of vertices in the polygon. - Specifies the list of X-coordinates of the vertices. - Specifies the list of Y-coordinates of the vertices. - Specifies the list of Z-coordinates of the vertices. - Specifies the list of X-coordinates of the points in the texture image that map to the specified vertices for the texture mapping. - Specifies the list of Y-coordinates of the points in the texture image that map to the specified vertices for the texture mapping. - Specifies the identifier of the image buffer to be used as a texture. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Returns the label of the polygon graphic added to the 3D graphics list. - - - Add a polygon graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the polygon graphic. - Specifies the label of the parent of the polygon graphic in the 3D graphics list. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the number of vertices in the polygon. - Specifies the list of X-coordinates of the vertices. - Specifies the list of Y-coordinates of the vertices. - Specifies the list of Z-coordinates of the vertices. - Specifies the list of X-coordinates of the points in the texture image that map to the specified vertices for the texture mapping. - Specifies the list of Y-coordinates of the points in the texture image that map to the specified vertices for the texture mapping. - Specifies the identifier of the image buffer to be used as a texture. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Returns the label of the polygon graphic added to the 3D graphics list. - - - Add a polygon graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the polygon graphic. - Specifies the label of the parent of the polygon graphic in the 3D graphics list. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the number of vertices in the polygon. - Specifies the list of X-coordinates of the vertices. - Specifies the list of Y-coordinates of the vertices. - Specifies the list of Z-coordinates of the vertices. - Specifies the list of X-coordinates of the points in the texture image that map to the specified vertices for the texture mapping. - Specifies the list of Y-coordinates of the points in the texture image that map to the specified vertices for the texture mapping. - Specifies the identifier of the image buffer to be used as a texture. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Returns the label of the polygon graphic added to the 3D graphics list. - - - Remove a 3D graphic from a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to remove the 3D graphic or node. - Specifies the label of the 3D graphic to remove. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a sphere graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the sphere graphic. - Specifies the label of the parent of the sphere graphic in the 3D graphics list. - Specifies the X-coordinate of the center of the sphere graphic. - Specifies the Y-coordinate of the center of the sphere graphic. - Specifies the Z-coordinate of the center of the sphere graphic. - Specifies the sphere graphic's radius. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the sphere graphic added to the 3D graphics list. - - - Add a text graphic to a 3D graphics list. - Specifies the identifier of the 3D graphics list in which to add the text graphic. - Specifies the label of the parent of the text graphic in the 3D graphics list. - Specifies the address of the string containing the text that must be shown in the text graphic. - Specifies the identifier of the transformation matrix that defines the text graphic's position and orientation with respect to its parent's coordinate system. - Specifies extra options for the appearance of the text graphic. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the text graphic added to the 3D graphics list. - - - Allocate a 3D image processing context. - Specifies the identifier of the system on which to allocate the 3D image processing context. - Specifies the type of 3D image processing context to allocate. This parameter must be set to one of the following: - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D image processing context identifier. - The returned value is the 3D image processing context identifier if allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D image processing context. - Specifies the identifier of the system on which to allocate the 3D image processing context. - Specifies the type of 3D image processing context to allocate. This parameter must be set to one of the following: - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D image processing context identifier. - The returned value is the 3D image processing context identifier if allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D image processing result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D image processing result buffer identifier. - The returned value is the 3D image processing result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D image processing result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D image processing result buffer identifier. - The returned value is the 3D image processing result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Perform a point-to-point arithmetic operation on depth maps and 3D geometries. - Specifies the first source image buffer or 3D geometry object. - Specifies the second source image buffer or 3D geometry object. - Specifies the identifier of the destination image buffer in which to put the result of the arithmetic operation. - Specifies the identifier of the image buffer to use as a mask, if needed. - Specifies the operation to perform. - Specifies which Z-coordinate to select for geometries with more than 1 Z-coordinate for a given pair of X- and Y-coordinates. - Specifies how to handle the camera calibration information of the destination image buffer. - - - Estimate a recommended depth map image buffer size from a source container's point cloud. - Specifies a calculate map size 3D image processing context. - Specifies the identifier of the source container containing a 3D-processable point cloud. - Specifies the identifier of the axis-aligned 3D box geometry object to use to limit the calculation to points within the box. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the estimated depth map image buffer size in X. - Specifies the address of the variable in which to write the estimated depth map image buffer size in Y. - - - Calibrate an image buffer based on the bounding box of a container's point cloud or an axis-aligned 3D box geometry, to prepare the buffer to hold a depth or intensity map. - Specifies the identifier of the source point cloud container or 3D geometry object. - Specifies the identifier of the destination image buffer with which to associate the calibration information for a depth map. - Specifies the identifier of the destination image buffer with which to associate the calibration information for an intensity map. - Specifies the identifier of the MIL object that defines the relationship between the relative and absolute coordinate systems in the depth map. - Specifies how to adjust the X and Y pixel sizes. - Specifies the sign of the Z-scale. - Specifies where to place valid values in the depth map. - - - Control a 3D image processing context. - Specifies the identifier of the 3D image processing context to control. The context must have been previously allocated on the system using M3dimAlloc. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control a 3D image processing context. - Specifies the identifier of the 3D image processing context to control. The context must have been previously allocated on the system using M3dimAlloc. - Specifies the type of control to set. - Specifies the required value for the control. - - - Copy the extent box of a depth map into a 3D geometry. - Specifies the identifier of the source depth map image buffer. - Specifies the identifier of the destination 3D geometry object. - Specifies how to copy the depth map's extent box into the 3D geometry object. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy a group of results into a 3D geometry object or transformation matrix object. - Specifies the identifier of a 3D image processing result buffer. - Specifies the identifier of a 3D geometry object or transformation matrix object. - Specifies the type of copy operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Crop points in a point cloud based on a specified 3D geometry or calibrated mask image buffer. - Specifies the identifier of the source container containing a 3D-processable point cloud. - Specifies the identifier of the destination container in which to store the resulting point cloud. The container must have been previously allocated using MbufAllocContainer with M_PROC, and must not be a child container. - Specifies the identifier of the 3D geometry object or calibrated mask image buffer used to crop the points. - Reserved for future expansion and must be set to M_NULL . - Specifies how to organize the resulting point cloud. - Specifies which points to keep, relative to the cropping object set with ImageBufOrGeometry3dgeoId. - - - Fill gaps in a depth map and, optionally, an intensity map, according to gap filling context controls. - Specifies a fill gaps 3D image processing context. - Specifies the image buffer identifier of the depth map on which to fill gaps. - Specifies the image buffer identifier of the intensity map on which to fill gaps. The image buffer must be an 8-bit or 16-bit unsigned, 1-band or 3-band buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a 3D image processing context or result buffer. - Specifies the identifier of the 3D image processing context or result buffer to free. These must have been successfully allocated (using M3dimAlloc or M3dimAllocResult) prior to calling this function. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a 3D image processing result buffer. - Specifies the identifier of the 3D image processing result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire about a 3D image processing context. - Specifies the identifier of the 3D image processing context about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire about a 3D image processing context. - Specifies the identifier of the 3D image processing context about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire about a 3D image processing context. - Specifies the identifier of the 3D image processing context about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire about a 3D image processing context. - Specifies the identifier of the 3D image processing context about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire about a 3D image processing context. - Specifies the identifier of the 3D image processing context about which to inquire information. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Apply the specified transformation matrix to the 3D points of a specified point cloud or to a 3D geometry. - Specifies the source point cloud container or 3D geometry object. - Specifies the destination container or 3D geometry object. - Specifies the identifier of the transformation matrix object. - Reserved for future expansion and must be set to M_DEFAULT . - - - Transform a list of 3D coordinates using the specified transformation matrix, and store the resulting coordinates in the specified destination arrays. - Specifies the identifier of the transformation matrix object. - Specifies the number of points in the arrays. - Specifies the address of the array that contains the source X-coordinates, or when ControlFlag is set to M_PACKED, the address of the array that contains a packed set of source X-, Y-, and Z-coordinates. - Specifies the address of the array that contains the source Y-coordinates. - Specifies the address of the array that contains the source Z-coordinates. - Specifies the address of the array in which to store the destination X-coordinates, or when ControlFlag is set to M_PACKED, the address of the array in which to store a packed set of destination X-, Y-, and Z-coordinates. - Specifies the address of the array in which to store the destination Y-coordinates. - Specifies the address of the array in which to store the destination Z-coordinates. - Specifies whether source or destination points are passed and/or returned in a packed format, or specifies to apply only rotation and scale transformations. - - - Transform a list of 3D coordinates using the specified transformation matrix, and store the resulting coordinates in the specified destination arrays. - Specifies the identifier of the transformation matrix object. - Specifies the number of points in the arrays. - Specifies the address of the array that contains the source X-coordinates, or when ControlFlag is set to M_PACKED, the address of the array that contains a packed set of source X-, Y-, and Z-coordinates. - Specifies the address of the array that contains the source Y-coordinates. - Specifies the address of the array that contains the source Z-coordinates. - Specifies the address of the array in which to store the destination X-coordinates, or when ControlFlag is set to M_PACKED, the address of the array in which to store a packed set of destination X-, Y-, and Z-coordinates. - Specifies the address of the array in which to store the destination Y-coordinates. - Specifies the address of the array in which to store the destination Z-coordinates. - Specifies whether source or destination points are passed and/or returned in a packed format, or specifies to apply only rotation and scale transformations. - - - Merge multiple point clouds into a single point cloud. - Specifies the address of the array that holds the identifiers of point cloud containers to merge. - Specifies the identifier of the destination container in which to store the resulting unorganized point cloud. The container must have been previously allocated using MbufAllocContainer with M_PROC, and must not be a child container. - Specifies the size of the array passed to SrcContainerBufIdArrayPtr. - Specifies the subsample 3D image processing context identifier, previously allocated using M3dimAlloc with M_SUBSAMPLE_CONTEXT. - Reserved for future expansion and must be set to M_DEFAULT . - - - Create a 3D mesh structure for a point cloud. - Specifies a mesh 3D image processing context. - Specifies the identifier of the 3D-processable point cloud container to use as the source. - Specifies the identifier of the destination container, previously allocated using MbufAllocContainer with M_PROC. - Reserved for future expansion and must be set to M_DEFAULT . - - - Compute a point cloud's unit normal vectors. - Specifies a normals 3D image processing context. - Specifies the identifier of the source container containing a 3D-processable point cloud. - Specifies the identifier of the destination container, previously allocated using MbufAllocContainer with M_PROC. - Reserved for future expansion and must be set to M_DEFAULT . - - - Takes the profile of a depth map or point cloud, along a specified slicing plane. - Specifies the identifier of the source point cloud container or depth map image buffer. - Specifies the identifier of the profile 3D image processing result buffer. The result buffer must have been allocated using M3dimAllocResult with M_PROFILE_RESULT. - Specifies the type of profile to generate. - Specifies the first parameter. Depends on ProfileType. - Specifies the second parameter. Depends on ProfileType. - Specifies the third parameter. Depends on ProfileType. - Specifies the fourth parameter. Depends on ProfileType. - Specifies the fifth parameter. Depends on ProfileType. - Reserved for future expansion and must be set to M_DEFAULT . - - - Project a point cloud or 3D geometry onto the XY (Z=0) plane to generate a fully corrected depth map. - Specifies a source container or 3D geometry object. - Specifies the identifier of the destination depth map image buffer, previously allocated using MbufAlloc2d. - Specifies the identifier of the destination intensity map image buffer. - Specifies the projection mode. - Specifies the overlap mode, which determines a pixel's gray level when multiple points correspond to the same destination depth map pixel. - Specifies additional options. - Reserved for future expansion and must be set to M_DEFAULT . - - - Remove 3D points from a point cloud, based on a specified condition. - Specifies the identifier of the source point cloud container, previously allocated using MbufAllocContainer with M_PROC. - Specifies the identifier of the destination container in which to place the modified point cloud. - Specifies which points to remove. - Reserved for future expansion and must be set to M_DEFAULT . - - - Restores a 3D image processing context from disk. - Specifies the name and path of the file from which to restore the 3D image processing context. - Specifies the system on which to restore the 3D image processing context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D image processing context identifier. - The returned value is the 3D image processing context identifier. If allocation fails, M_NULL is returned. - - - Restores a 3D image processing context from disk. - Specifies the name and path of the file from which to restore the 3D image processing context. - Specifies the system on which to restore the 3D image processing context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D image processing context identifier. - The returned value is the 3D image processing context identifier. If allocation fails, M_NULL is returned. - - - Rotate a specified point cloud or 3D geometry. - Specifies the source point cloud container or 3D geometry object. - Specifies the destination container or 3D geometry object. - Specifies the type of rotation to apply to the point cloud or 3D geometry. - Specifies an attribute of the rotation. - Specifies an attribute of the rotation. - Specifies an attribute of the rotation. - Specifies an attribute of the rotation. - Specifies the X-coordinate of the point around which the rotation is performed. - Specifies the Y-coordinate of the point around which the rotation is performed. - Specifies the Z-coordinate of the point around which the rotation is performed. - Reserved for future expansion and must be set to M_DEFAULT . - - - Subsample a point cloud to generate a less dense point cloud, or sample a meshed point cloud to generate a denser point cloud. - Specifies a subsample or surface sample 3D image processing context. - Specifies the identifier of the source container containing a 3D-processable point cloud. - Specifies the identifier of the destination container in which to place the generated point cloud. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a 3D image processing context to a file. - Specifies the name and path of the file in which to save the 3D image processing context; it is recommended that you use the M3DIM file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the 3D image processing context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a 3D image processing context to a file. - Specifies the name and path of the file in which to save the 3D image processing context; it is recommended that you use the M3DIM file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the 3D image processing context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Scale a specified point cloud or 3D geometry. - Specifies a source point cloud container or 3D geometry object. - Specifies the destination container or 3D geometry object. - Specifies the factor by which to scale in X. - Specifies the factor by which to scale in Y. - Specifies the factor by which to scale in Z. - Specifies the X-coordinate of the point that defines the center of the scaling operation. - Specifies the Y-coordinate of the point that defines the center of the scaling operation. - Specifies the Z-coordinate of the point that defines the center of the scaling operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Compute a variety of statistics on a point cloud or depth map. - Specifies a previously allocated statistics 3D image processing context (used to evaluate multiple statistical calculations), or a predefined statistics 3D image processing context (used to evaluate a single statistical calculation). - Specifies the identifier of the source container containing a 3D-processable point cloud, or specifies the identifier of the source depth map image buffer. - Specifies the identifier of the statistics 3D image processing result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a 3D image processing context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D image processing context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D image processing context. - Specifies the MIL version of the 3D image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D image processing context. - Specifies the address of the variable in which to write the size of the 3D image processing context, in bytes. - - - Load, restore, or save a 3D image processing context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D image processing context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D image processing context. - Specifies the MIL version of the 3D image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D image processing context. - Specifies the address of the variable in which to write the size of the 3D image processing context, in bytes. - - - Load, restore, or save a 3D image processing context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D image processing context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D image processing context. - Specifies the MIL version of the 3D image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D image processing context. - Specifies the address of the variable in which to write the size of the 3D image processing context, in bytes. - - - Load, restore, or save a 3D image processing context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D image processing context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D image processing context. - Specifies the MIL version of the 3D image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D image processing context. - Specifies the address of the variable in which to write the size of the 3D image processing context, in bytes. - - - Load, restore, or save a 3D image processing context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D image processing context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D image processing context. - Specifies the MIL version of the 3D image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D image processing context. - Specifies the address of the variable in which to write the size of the 3D image processing context, in bytes. - - - Load, restore, or save a 3D image processing context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D image processing context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D image processing context. - Specifies the MIL version of the 3D image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D image processing context. - Specifies the address of the variable in which to write the size of the 3D image processing context, in bytes. - - - Translate a specified point cloud or 3D geometry. - Specifies a source point cloud container or 3D geometry object. - Specifies the destination container or 3D geometry object. - Specifies the displacement in the X-direction. - Specifies the displacement in the Y-direction. - Specifies the displacement in the Z-direction. - Reserved for future expansion and must be set to M_DEFAULT . - - - Extract laser line data from an image and store this data in a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction context. - Specifies the identifier of the 3D reconstruction result buffer in which to store the laser line data. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_LASER_CALIBRATION_DATA, M_POINT_CLOUD_RESULT, or M_DEPTH_CORRECTED_DATA. - Specifies the identifier of the image buffer containing the grabbed image of the laser line. - Specifies the identifier of the image buffer containing the intensity map, if using a 3D camera. - Reserved for future expansion. This parameter must be set to M_NULL . - Specifies the label of the point cloud in the result buffer in which to add the laser line data, if the result buffer has been allocated using M3dmapAllocResult with M_POINT_CLOUD_RESULT. - Specifies the function's control flag. This parameter must be set to one of the following values: - - - Allocate a 3D reconstruction context or a 3D draw context. - Specifies the identifier of the system on which to allocate the 3D reconstruction context or 3D draw context. - Specifies to allocate a 3D reconstruction context or 3D draw context. This parameter must be set to one of the following: - Specifies the 3D reconstruction mode of the context, which determines how data is represented. - Specifies the address of the variable in which to write the 3D reconstruction context or 3D draw context. - The returned value is the 3D reconstruction context or 3D draw context identifier if allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D reconstruction context or a 3D draw context. - Specifies the identifier of the system on which to allocate the 3D reconstruction context or 3D draw context. - Specifies to allocate a 3D reconstruction context or 3D draw context. This parameter must be set to one of the following: - Specifies the 3D reconstruction mode of the context, which determines how data is represented. - Specifies the address of the variable in which to write the 3D reconstruction context or 3D draw context. - The returned value is the 3D reconstruction context or 3D draw context identifier if allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D reconstruction result buffer. - Specifies the identifier of the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. This parameter must be set to the following value: - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D reconstruction result buffer identifier. - The returned value is the 3D reconstruction result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D reconstruction result buffer. - Specifies the identifier of the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. This parameter must be set to the following value: - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D reconstruction result buffer identifier. - The returned value is the 3D reconstruction result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Calibrate a 3D reconstruction setup. - Specifies the identifier of the 3D reconstruction context used to extract the laser line from grabbed images. - Specifies the identifier of the 3D reconstruction result buffer that contains the laser line data required for calibration. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult and contain data for at least one laser line. - Specifies the identifier of the camera calibration context that contains the 3D camera calibration data or M_NULL . - Reserved for future expansion and must be set to M_DEFAULT . - - - Calibrate a 3D reconstruction setup that uses multiple camera-laser pairs. - Specifies the address of an array containing the identifiers of the 3D reconstruction context used to extract the laser line from grabbed images. - Specifies the address of an array containing the identifiers of the 3D reconstruction result buffers that contains the laser line data required for calibration. - Specifies the address of an array containing the identifiers of the camera calibration contexts of the cameras used to grab the laser lines. - Specifies the number of camera-laser pairs. - Specifies the function's control flag. - - - Clear a 3D reconstruction result buffer of some or all of its content. - Specifies the identifier of the 3D reconstruction result buffer to clear. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Control a profiling 3D reconstruction context, draw 3D reconstruction context, or 3D reconstruction result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or 3D reconstruction result buffer whose setting to modify. The profiling 3D reconstruction context or draw 3D reconstruction context must have been previously allocated using M3dmapAlloc with M_LASER or M_DRAW_3D_CONTEXT, respectively. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_DEPTH_CORRECTED_DATA, M_LASER_CALIBRATION_DATA, or M_POINT_CLOUD_RESULT. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, to control. - Specifies the type of setting to control. - Specifies the required value for the setting. - - - Control a profiling 3D reconstruction context, draw 3D reconstruction context, or 3D reconstruction result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or 3D reconstruction result buffer whose setting to modify. The profiling 3D reconstruction context or draw 3D reconstruction context must have been previously allocated using M3dmapAlloc with M_LASER or M_DRAW_3D_CONTEXT, respectively. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_DEPTH_CORRECTED_DATA, M_LASER_CALIBRATION_DATA, or M_POINT_CLOUD_RESULT. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, to control. - Specifies the type of setting to control. - Specifies the required value for the setting. - - - Copy one or more point clouds from one M_POINT_CLOUD_RESULT result buffer to another. - Specifies the identifier of the 3D reconstruction result buffer containing the source point clouds to copy/move. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_RESULT. - Specifies the point cloud(s) to copy/move from the source M_POINT_CLOUD_RESULT result buffer. - Specifies the identifier of the 3D reconstruction result buffer in which to copy/move the source point cloud(s). The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_RESULT. You can specify the same identifier as the SrcResult3dmapId identifier, but the label to assign the copied/moved point cloud must be different. - Specifies a new label in the destination M_POINT_CLOUD_RESULT result buffer in which to copy/move the source point cloud(s). - Specifies the type of operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy a group of results from a 3D reconstruction result buffer into a container or an image buffer. - Specifies the identifier of the 3D reconstruction result buffer containing point cloud or laser line data. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer to copy. - Specifies the identifier of the destination container or image buffer in which to save the copied information. - Specifies the type of copy operation to perform. - Specifies whether to copy reflectance values, when the SrcResult3dmapId parameter is set to an M_POINT_CLOUD_RESULT result buffer. - - - Generate an image from a 3D reconstruction context or result buffer. - Specifies the identifier of the 2D graphics context to use. This parameter must be set to one of the following values: - Specifies the identifier of a 3D reconstruction context or result buffer. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies what to draw in the destination image buffer or 2D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - - - Draw 3D annotations based on a laser line profiling 3D reconstruction context. - Specifies the identifier of the 3D draw context that specifies the annotations to draw and how to draw them. This parameter must be set to one of the following values: - Specifies the identifier of the laser line profiling 3D reconstruction context, previously allocated using M3dmapAlloc with M_LASER and M_CALIBRATED_CAMERA_LINEAR_MOTION. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the identifier of the 3D graphics list in which to draw. You can specify a 3D graphics list that you have previously allocated using M3dgraAlloc, or you can specify the identifier of the 3D display's internal graphics list (inquired using M3ddispInquire with M_3D_GRAPHIC_LIST_ID). - Specifies the label of the 3D graphic in the 3D graphics list to be used as the annotation's parent. - Specifies the identifier of the image buffer containing the texture image, which you can apply to the drawn laser plane to enhance its visibility. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the parent label of the graphics added to the graphics list. - - - Free a 3D reconstruction context or a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction context or 3D reconstruction result buffer to free. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from a 3D reconstruction result buffer. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve results. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, from which to get results. - Specifies the type of result to get. - Specifies the address in which to write the results. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer. - Specifies the identifier of the profiling 3D reconstruction context, draw 3D reconstruction context, or result buffer about which to inquire information. - Specifies the point cloud(s) in the result buffer about which to inquire, or specifies the entire result buffer itself. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Restore a 3D object from disk. - Specifies the name and directory of the file from which to restore the 3D object. - Specifies the system on which to restore the 3D object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D object identifier. - The returned value is the 3D object identifier. If allocation fails, M_NULL is returned. - - - Restore a 3D object from disk. - Specifies the name and directory of the file from which to restore the 3D object. - Specifies the system on which to restore the 3D object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D object identifier. - The returned value is the 3D object identifier. If allocation fails, M_NULL is returned. - - - Save a 3D object to a file. - Specifies the name and directory of the file in which to save the 3D object. The recommended extension is M3D. - Specifies the identifier of the 3D object to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a 3D object to a file. - Specifies the name and directory of the file in which to save the 3D object. The recommended extension is M3D. - Specifies the identifier of the 3D object to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a 3D object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D object. - Specifies the operation to perform on the 3D object. - Specifies the type of stream in which to store/from which to restore the 3D object. - Specifies the MIL version of the 3D object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D object. - Specifies the address of the variable in which to write the size of the 3D object, in bytes. - - - Load, restore, or save a 3D object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D object. - Specifies the operation to perform on the 3D object. - Specifies the type of stream in which to store/from which to restore the 3D object. - Specifies the MIL version of the 3D object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D object. - Specifies the address of the variable in which to write the size of the 3D object, in bytes. - - - Load, restore, or save a 3D object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D object. - Specifies the operation to perform on the 3D object. - Specifies the type of stream in which to store/from which to restore the 3D object. - Specifies the MIL version of the 3D object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D object. - Specifies the address of the variable in which to write the size of the 3D object, in bytes. - - - Load, restore, or save a 3D object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D object. - Specifies the operation to perform on the 3D object. - Specifies the type of stream in which to store/from which to restore the 3D object. - Specifies the MIL version of the 3D object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D object. - Specifies the address of the variable in which to write the size of the 3D object, in bytes. - - - Load, restore, or save a 3D object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D object. - Specifies the operation to perform on the 3D object. - Specifies the type of stream in which to store/from which to restore the 3D object. - Specifies the MIL version of the 3D object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D object. - Specifies the address of the variable in which to write the size of the 3D object, in bytes. - - - Load, restore, or save a 3D object from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D object. - Specifies the operation to perform on the 3D object. - Specifies the type of stream in which to store/from which to restore the 3D object. - Specifies the MIL version of the 3D object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D object. - Specifies the address of the variable in which to write the size of the 3D object, in bytes. - - - Perform stereo vision triangulation to find the 3D world coordinates of points from their pixel location in the image plane of two or more cameras. - Specifies the address of an array containing the identifiers of the camera calibration contexts for each of the camera setups. - Specifies the address of the array containing the X-pixel coordinates of the common points in the image plane of each camera. - Specifies the address of the array containing the Y-pixel coordinates of the common points in the image plane of each camera. This array must have a size equal to ( NumCalibrations x NumPoints). - Specifies the address of an array in which to write the calculated X-world coordinates. - Specifies the address of the array in which to write the calculated Y-world coordinates. - Specifies the address of the array in which to write the calculated Z-world coordinates. - Specifies the address of the array in which to write the root mean square (RMS) error for the calculated world coordinates of each point. - Specifies the number of camera calibration contexts. This should correspond to the number of cameras. This parameter must be greater or equal to 2. - Specifies the number of points to compute using stereo vision triangulation. This parameter must be greater or equal to 1. - Specifies the world coordinate system that is common to all the specified camera calibration contexts. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform stereo vision triangulation to find the 3D world coordinates of points from their pixel location in the image plane of two or more cameras. - Specifies the address of an array containing the identifiers of the camera calibration contexts for each of the camera setups. - Specifies the address of the array containing the X-pixel coordinates of the common points in the image plane of each camera. - Specifies the address of the array containing the Y-pixel coordinates of the common points in the image plane of each camera. This array must have a size equal to ( NumCalibrations x NumPoints). - Specifies the address of an array in which to write the calculated X-world coordinates. - Specifies the address of the array in which to write the calculated Y-world coordinates. - Specifies the address of the array in which to write the calculated Z-world coordinates. - Specifies the address of the array in which to write the root mean square (RMS) error for the calculated world coordinates of each point. - Specifies the number of camera calibration contexts. This should correspond to the number of cameras. This parameter must be greater or equal to 2. - Specifies the number of points to compute using stereo vision triangulation. This parameter must be greater or equal to 1. - Specifies the world coordinate system that is common to all the specified camera calibration contexts. - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate a 3D metrology context. - Specifies the system on which to allocate the 3D metrology context. - Specifies the type of 3D metrology context to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the identifier of the 3D metrology context, if allocation is successful. Since M3dmetAlloc also returns the 3D metrology context identifier, you can set this parameter to M_NULL . - The returned value is the 3D metrology context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D metrology context. - Specifies the system on which to allocate the 3D metrology context. - Specifies the type of 3D metrology context to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the identifier of the 3D metrology context, if allocation is successful. Since M3dmetAlloc also returns the 3D metrology context identifier, you can set this parameter to M_NULL . - The returned value is the 3D metrology context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocates a 3D metrology result buffer. - Specifies the identifier of the system on which to allocate the 3D metrology result buffer. - Specifies the type of 3D metrology result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D metrology result buffer identifier, if allocation is successful. Since M3dmetAllocResult also returns the 3D metrology result buffer identifier, you can set this parameter to M_NULL . - The returned value is the 3D metrology result buffer's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocates a 3D metrology result buffer. - Specifies the identifier of the system on which to allocate the 3D metrology result buffer. - Specifies the type of 3D metrology result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D metrology result buffer identifier, if allocation is successful. Since M3dmetAllocResult also returns the 3D metrology result buffer identifier, you can set this parameter to M_NULL . - The returned value is the 3D metrology result buffer's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a setting for a 3D metrology context. - Specifies the identifier of the fit 3D metrology context or statistics 3D metrology context to control. - Specifies the setting to control. - Specifies the value needed for the control. - - - Control a setting for a 3D metrology context. - Specifies the identifier of the fit 3D metrology context or statistics 3D metrology context to control. - Specifies the setting to control. - Specifies the value needed for the control. - - - Copy a 3D geometry into, or out of, a fit 3D metrology context. - Specifies the MIL object from which to copy the 3D geometry. - Specifies the identifier of the MIL object in which to copy the 3D geometry. - Specifies the type of copy operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy a group of results from a fit 3D metrology result buffer into an image buffer, 3D geometry object, or a transformation matrix. - Specifies the identifier of the fit 3D metrology result buffer from which to copy results. The fit 3D metrology context must have been allocated using M3dmetAllocResult with M_FIT_RESULT, and must contain the results of a call to M3dmetFit. - Specifies the identifier of the image buffer, 3D geometry object, or transformation matrix object into which the results will be copied. - Specifies the type of copy operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Calculates the distance between a point cloud or depth map, and a point cloud, depth map, or 3D geometry object. - Specifies the source point cloud container or depth map image buffer. - Specifies the reference object with respect to which distances will be measured. - Specifies the identifier of the buffer in which to store the calculated distances. - Specifies the type of distance to calculate. - Specifies an optional maximum distance for which to complete calculations when the reference MIL object is a point cloud container. - Reserved for future expansion and must be set to M_DEFAULT . - - - Draw the result of a fit operation into a 3D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the identifier of the fit 3D metrology result buffer. - Specifies the identifier of the 3D graphics list in which to draw. - Specifies the label of the 3D graphic in the 3D graphics list to use as the geometry's parent. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the label of the 3D graphic added to the 3D graphics list. - - - Fits a 3D geometry to a point cloud or depth map. - Specifies the fit 3D metrology context. - Specifies the point cloud or depth map to which to fit the 3D geometry. - Specifies the type of 3D geometry object to use in the fit operation. Note that 3D box geometry objects are not supported. - Specifies the identifier of the fit 3D metrology result buffer in which to store the results of the fit operation. - Specifies the distance from the 3D geometry, beyond which points are considered outliers and will be ignored during the fit operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a 3D metrology context or result buffer. - Specifies the identifier of the 3D metrology context or result buffer to free. These must have been successfully allocated using M3dmetAlloc or M3dmetAllocResult prior to calling this function. - - - Get the specified type of result(s) from a 3D metrology result buffer. - Specifies the identifier of a fit 3D metrology result buffer or statistics 3D metrology result buffer, from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result(s) from a 3D metrology result buffer. - Specifies the identifier of a fit 3D metrology result buffer or statistics 3D metrology result buffer, from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result(s) from a 3D metrology result buffer. - Specifies the identifier of a fit 3D metrology result buffer or statistics 3D metrology result buffer, from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result(s) from a 3D metrology result buffer. - Specifies the identifier of a fit 3D metrology result buffer or statistics 3D metrology result buffer, from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire information about a 3D metrology context. - Specifies the identifier of the 3D metrology context to inquire. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire information about a 3D metrology context. - Specifies the identifier of the 3D metrology context to inquire. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire information about a 3D metrology context. - Specifies the identifier of the 3D metrology context to inquire. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire information about a 3D metrology context. - Specifies the identifier of the 3D metrology context to inquire. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire information about a 3D metrology context. - Specifies the identifier of the 3D metrology context to inquire. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Restore a 3D metrology context from disk. - Specifies the name and path of the file from which to restore the 3D metrology context. - Specifies the system on which to restore the 3D metrology context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D metrology context identifier. - The returned value is the 3D metrology context identifier. If allocation fails, M_NULL is returned. - - - Restore a 3D metrology context from disk. - Specifies the name and path of the file from which to restore the 3D metrology context. - Specifies the system on which to restore the 3D metrology context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D metrology context identifier. - The returned value is the 3D metrology context identifier. If allocation fails, M_NULL is returned. - - - Save a 3D metrology context to a file. - Specifies the name and path of the file in which to save the 3D metrology context; it is recommended that you use the M3DMET file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the 3D metrology context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a 3D metrology context to a file. - Specifies the name and path of the file in which to save the 3D metrology context; it is recommended that you use the M3DMET file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the 3D metrology context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Compute a variety of statistics on the distances between a point cloud or depth map, and a point cloud, depth map, or 3D geometry. - Specifies a previously allocated statistics 3D metrology context (used to evaluate multiple statistical calculations), or a predefined statistics 3D metrology context (used to evaluate a single statistical calculation). - Specifies the source point cloud container or depth map image buffer. - Specifies the identifier of the reference MIL object, with respect to which distances will be measured. - Specifies the identifier of the statistics 3D metrology result buffer in which to store the results. The result buffer must have been allocated using M3dmetAllocResult with M_STATISTICS_RESULT. - Specifies the type of distance to calculate. - Specifies the condition for which distance measurements will be used in statistics calculations. - Specifies the lower limit of the selected condition. - Specifies the upper limit of the selected condition. - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a 3D metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D metrology context. - Specifies the MIL version of the 3D metrology context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D metrology context. - Specifies the address of the variable in which to write the size of the 3D metrology context, in bytes. - - - Load, restore, or save a 3D metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D metrology context. - Specifies the MIL version of the 3D metrology context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D metrology context. - Specifies the address of the variable in which to write the size of the 3D metrology context, in bytes. - - - Load, restore, or save a 3D metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D metrology context. - Specifies the MIL version of the 3D metrology context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D metrology context. - Specifies the address of the variable in which to write the size of the 3D metrology context, in bytes. - - - Load, restore, or save a 3D metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D metrology context. - Specifies the MIL version of the 3D metrology context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D metrology context. - Specifies the address of the variable in which to write the size of the 3D metrology context, in bytes. - - - Load, restore, or save a 3D metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D metrology context. - Specifies the MIL version of the 3D metrology context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D metrology context. - Specifies the address of the variable in which to write the size of the 3D metrology context, in bytes. - - - Load, restore, or save a 3D metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the 3D metrology context. - Specifies the MIL version of the 3D metrology context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D metrology context. - Specifies the address of the variable in which to write the size of the 3D metrology context, in bytes. - - - Computes the volume of a point cloud's mesh or of a depth map, delimited optionally by a specified reference object. - Specifies the point cloud or depth map for which to calculate the volume. - Specifies the reference MIL object to use to define a closed 3D shape whose volume to calculate. - Specifies how to calculate the total volume, given the position of the source MIL object relative to the reference object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the calculated volume. - Specifies the address of the variable in which to write the status of the volume calculation. - The returned value is the computed volume, if successful. If the volume calculation fails, M_NULL is returned. - - - Computes the volume of a point cloud's mesh or of a depth map, delimited optionally by a specified reference object. - Specifies the point cloud or depth map for which to calculate the volume. - Specifies the reference MIL object to use to define a closed 3D shape whose volume to calculate. - Specifies how to calculate the total volume, given the position of the source MIL object relative to the reference object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the calculated volume. - Specifies the address of the variable in which to write the status of the volume calculation. - The returned value is the computed volume, if successful. If the volume calculation fails, M_NULL is returned. - - - Computes the volume of a point cloud's mesh or of a depth map, delimited optionally by a specified reference object. - Specifies the point cloud or depth map for which to calculate the volume. - Specifies the reference MIL object to use to define a closed 3D shape whose volume to calculate. - Specifies how to calculate the total volume, given the position of the source MIL object relative to the reference object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the calculated volume. - Specifies the address of the variable in which to write the status of the volume calculation. - The returned value is the computed volume, if successful. If the volume calculation fails, M_NULL is returned. - - - Computes the volume of a point cloud's mesh or of a depth map, delimited optionally by a specified reference object. - Specifies the point cloud or depth map for which to calculate the volume. - Specifies the reference MIL object to use to define a closed 3D shape whose volume to calculate. - Specifies how to calculate the total volume, given the position of the source MIL object relative to the reference object. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the calculated volume. - Specifies the address of the variable in which to write the status of the volume calculation. - The returned value is the computed volume, if successful. If the volume calculation fails, M_NULL is returned. - - - Allocate a 3D registration context. - Specifies the identifier of the system on which to allocate the 3D registration context. - Specifies the type of 3D registration context to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the pairwise 3D registration context identifier. - The returned value is the context's identifier. If allocation fails, M_NULL is returned. - - - Allocate a 3D registration context. - Specifies the identifier of the system on which to allocate the 3D registration context. - Specifies the type of 3D registration context to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the pairwise 3D registration context identifier. - The returned value is the context's identifier. If allocation fails, M_NULL is returned. - - - Allocate a 3D registration result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D registration result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 3D registration result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D registration result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Perform the registration operation on the given point clouds and write the resulting transformation matrices into the pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration context to use for the registration operation. The context must have been previously allocated using M3dregAlloc. - Specifies the address of the array containing the identifiers of the point cloud containers. The point clouds must be 3D-processable; use MbufInquireContainer with M_3D_PROCESSABLE to ensure that the containers contain 3D-processable point clouds. The number of containers supplied in the array should be less than or equal to the number of registration elements in the registration context. - Specifies the size of the array passed to ContainerBufIdArrayPtr. - Specifies the pairwise 3D registration result buffer identifier in which to store results. The result buffer must have been previously allocated using M3dregAllocResult. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform the registration operation on the given point clouds and write the resulting transformation matrices into the pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration context to use for the registration operation. The context must have been previously allocated using M3dregAlloc. - Specifies the address of the array containing the identifiers of the point cloud containers. The point clouds must be 3D-processable; use MbufInquireContainer with M_3D_PROCESSABLE to ensure that the containers contain 3D-processable point clouds. The number of containers supplied in the array should be less than or equal to the number of registration elements in the registration context. - Specifies the size of the array passed to ContainerBufIdArrayPtr. - Specifies the pairwise 3D registration result buffer identifier in which to store results. The result buffer must have been previously allocated using M3dregAllocResult. - Reserved for future expansion and must be set to M_DEFAULT . - - - Control a pairwise 3D registration context or a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration context or a pairwise 3D registration result buffer to control. - Specifies what to control. Set this parameter to one of the following values: - Specifies the setting to change. - Specifies the setting's new value. - - - Control a pairwise 3D registration context or a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration context or a pairwise 3D registration result buffer to control. - Specifies what to control. Set this parameter to one of the following values: - Specifies the setting to change. - Specifies the setting's new value. - - - Copy a preregistration transformation matrix from a 3D registration context into a transformation matrix object. - Specifies the identifier of the 3D registration context. The context must have been previously allocated using M3dregAlloc with M_PAIRWISE_REGISTRATION_CONTEXT. - Specifies the index of the registration element in the context. - Specifies the identifier of a transformation matrix. The transformation matrix must have been previously allocated using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the type of copy operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy a transformation matrix from a 3D registration result buffer to a transformation matrix object. - Specifies the identifier of the pairwise 3D registration result buffer. The pairwise 3D registration result buffer must have been previously allocated using M3dregAllocResult. - Specifies the index of the registration result element associated with the source point cloud. - Specifies relative to which coordinate system (the global coordinate system or that of a point cloud) to retrieve the copied transformation matrix. - Specifies the identifier of the destination transformation matrix object. The transformation matrix object must have been previously allocated using M3dgeoAlloc with M_TRANSFORMATION_MATRIX. - Specifies the type of copy operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a 3D registration context or a 3D registration result buffer. - Specifies the identifier of the 3D registration context or 3D registration result buffer to free. These must have been successfully allocated (using M3dregAlloc or M3dregAllocResult) prior to calling this function. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Get the specified type of result from a pairwise 3D registration result buffer. - Specifies the identifier of the pairwise 3D registration result buffer, previously allocated using M3dregAllocResult with M_PAIRWISE_REGISTRATION_RESULT. - Specifies the registration result element for which to retrieve results. - Specifies the type of result to get. - Specifies the address in which to write the results. - The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information. - - - Inquire information about a pairwise 3D registration context or a pairwise 3D registration result buffer. - Specifies the identifier of the 3D pairwise registration context or a pairwise 3D registration result buffer to inquire. - Specifies to inquire a pairwise 3D registration context, an individual registration element (or all registration elements), or a pairwise 3D registration result buffer. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a pairwise 3D registration context or a pairwise 3D registration result buffer. - Specifies the identifier of the 3D pairwise registration context or a pairwise 3D registration result buffer to inquire. - Specifies to inquire a pairwise 3D registration context, an individual registration element (or all registration elements), or a pairwise 3D registration result buffer. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a pairwise 3D registration context or a pairwise 3D registration result buffer. - Specifies the identifier of the 3D pairwise registration context or a pairwise 3D registration result buffer to inquire. - Specifies to inquire a pairwise 3D registration context, an individual registration element (or all registration elements), or a pairwise 3D registration result buffer. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a pairwise 3D registration context or a pairwise 3D registration result buffer. - Specifies the identifier of the 3D pairwise registration context or a pairwise 3D registration result buffer to inquire. - Specifies to inquire a pairwise 3D registration context, an individual registration element (or all registration elements), or a pairwise 3D registration result buffer. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Inquire information about a pairwise 3D registration context or a pairwise 3D registration result buffer. - Specifies the identifier of the 3D pairwise registration context or a pairwise 3D registration result buffer to inquire. - Specifies to inquire a pairwise 3D registration context, an individual registration element (or all registration elements), or a pairwise 3D registration result buffer. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT64. If the requested information does not fit into a MIL_INT64, this function will return M_NULL or truncate the information. - - - Merge point clouds using the results of a previous call to M3dregCalculate. - Specifies the identifier of the pairwise 3D registration result buffer. The pairwise 3D registration result buffer must have been successfully allocated using M3dregAllocResult, and contain the result of a successful call to M3dregCalculate. - Specifies the address of the array containing the identifiers of the point cloud containers. The point clouds must be 3D-processable. You can check that the point clouds are 3D-processable using MbufInquireContainer with M_3D_PROCESSABLE. You can set some entries in the array to M_NULL to merge a subset of the point clouds. - Specifies the size of the array passed to ContainerBufIdArrayPtr. - Specifies the identifier of the destination container in which to store the transformed and merged point clouds. The container must have been previously allocated using MbufAllocContainer with M_PROC. - Specifies the identifier of a 3D image processing subsampling context. This context is used to subsample the resulting point cloud after the merging is complete. - Reserved for future expansion and must be set to M_DEFAULT . - - - Merge point clouds using the results of a previous call to M3dregCalculate. - Specifies the identifier of the pairwise 3D registration result buffer. The pairwise 3D registration result buffer must have been successfully allocated using M3dregAllocResult, and contain the result of a successful call to M3dregCalculate. - Specifies the address of the array containing the identifiers of the point cloud containers. The point clouds must be 3D-processable. You can check that the point clouds are 3D-processable using MbufInquireContainer with M_3D_PROCESSABLE. You can set some entries in the array to M_NULL to merge a subset of the point clouds. - Specifies the size of the array passed to ContainerBufIdArrayPtr. - Specifies the identifier of the destination container in which to store the transformed and merged point clouds. The container must have been previously allocated using MbufAllocContainer with M_PROC. - Specifies the identifier of a 3D image processing subsampling context. This context is used to subsample the resulting point cloud after the merging is complete. - Reserved for future expansion and must be set to M_DEFAULT . - - - Restore a 3D registration context or result buffer from disk. - Specifies the name and path of the file from which to restore the 3D registration context or 3D registration result buffer. - Specifies the system on which to restore the 3D registration context or 3D registration result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D registration context or 3D registration result buffer identifier. - The returned value is the registration context or result buffer identifier. If allocation fails, M_NULL is returned. - - - Restore a 3D registration context or result buffer from disk. - Specifies the name and path of the file from which to restore the 3D registration context or 3D registration result buffer. - Specifies the system on which to restore the 3D registration context or 3D registration result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D registration context or 3D registration result buffer identifier. - The returned value is the registration context or result buffer identifier. If allocation fails, M_NULL is returned. - - - Save a 3D registration context or 3D registration result buffer to a file. - Specifies the name and path of the file in which to save the 3D registration context or 3D registration result buffer. It is recommended that you use the M3DREG file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the 3D registration context or 3D registration result buffer to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a 3D registration context or 3D registration result buffer to a file. - Specifies the name and path of the file in which to save the 3D registration context or 3D registration result buffer. It is recommended that you use the M3DREG file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the 3D registration context or 3D registration result buffer to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Sets the rough location of the working coordinate system of a point cloud with respect to either the working coordinate system of another point cloud, or the global coordinate system. - Specifies the identifier of the pairwise 3D registration context in which to store the rough location. - Specifies the index of the registration element in the pairwise 3D registration context to set. - Specifies the reference of the registration element in Context3dregId. - Specifies the identifier of the MIL object from which to copy the rough location. - Specifies the index of the registration element or registration result element in the MIL object passed to the ParamId parameter. - Specifies an attribute of the transformation that specifies a rough location. - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a 3D registration context or result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D registration context or 3D registration result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the pairwise 3D registration context or pairwise 3D registration result buffer. - Specifies the MIL version of the 3D registration context or result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D registration context or result buffer. - Specifies the address of the variable in which to write the size of the 3D registration context or result buffer, in bytes. - - - Load, restore, or save a 3D registration context or result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D registration context or 3D registration result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the pairwise 3D registration context or pairwise 3D registration result buffer. - Specifies the MIL version of the 3D registration context or result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D registration context or result buffer. - Specifies the address of the variable in which to write the size of the 3D registration context or result buffer, in bytes. - - - Load, restore, or save a 3D registration context or result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D registration context or 3D registration result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the pairwise 3D registration context or pairwise 3D registration result buffer. - Specifies the MIL version of the 3D registration context or result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D registration context or result buffer. - Specifies the address of the variable in which to write the size of the 3D registration context or result buffer, in bytes. - - - Load, restore, or save a 3D registration context or result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D registration context or 3D registration result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the pairwise 3D registration context or pairwise 3D registration result buffer. - Specifies the MIL version of the 3D registration context or result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D registration context or result buffer. - Specifies the address of the variable in which to write the size of the 3D registration context or result buffer, in bytes. - - - Load, restore, or save a 3D registration context or result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D registration context or 3D registration result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the pairwise 3D registration context or pairwise 3D registration result buffer. - Specifies the MIL version of the 3D registration context or result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D registration context or result buffer. - Specifies the address of the variable in which to write the size of the 3D registration context or result buffer, in bytes. - - - Load, restore, or save a 3D registration context or result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the 3D registration context or 3D registration result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the pairwise 3D registration context or pairwise 3D registration result buffer. - Specifies the MIL version of the 3D registration context or result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the 3D registration context or result buffer. - Specifies the address of the variable in which to write the size of the 3D registration context or result buffer, in bytes. - - - Allocate a MIL application context. - Specifies the computer name or IP address of the cluster manager. - Specifies the type of initialization to perform on the MIL application context. - Specifies the address of the variable in which to write the application context identifier. - The returned value is the application context identifier. If allocation fails, M_NULL is returned. - - - Allocate a MIL application context. - Specifies the computer name or IP address of the cluster manager. - Specifies the type of initialization to perform on the MIL application context. - Specifies the address of the variable in which to write the application context identifier. - The returned value is the application context identifier. If allocation fails, M_NULL is returned. - - - Allocate a MIL application context. - Specifies the computer name or IP address of the cluster manager. - Specifies the type of initialization to perform on the MIL application context. - Specifies the address of the variable in which to write the application context identifier. - The returned value is the application context identifier. If allocation fails, M_NULL is returned. - - - Allocate a MIL application context. - Specifies the computer name or IP address of the cluster manager. - Specifies the type of initialization to perform on the MIL application context. - Specifies the address of the variable in which to write the application context identifier. - The returned value is the application context identifier. If allocation fails, M_NULL is returned. - - - Closes a connection to a remote MIL application. - Specifies the remote application to disconnect from. - - - Control an application environment setting. - Specifies the identifier of the application context to use. - Specifies the type of application environment setting to control. - Specifies the setting's new value. - - - Control an application environment setting. - Specifies the identifier of the application context to use. - Specifies the type of application environment setting to control. - Specifies the setting's new value. - - - Control a MIL multi-core processing application environment setting. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the type of multi-core processing application environment setting to control. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the setting's new value. - Specifies the address which contains more information about the setting's new value. - - - Control a MIL multi-core processing application environment setting. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the type of multi-core processing application environment setting to control. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the setting's new value. - Specifies the address which contains more information about the setting's new value. - - - Perform a file operation on a local or a remote computer. - Specifies the identifier of the application context to use. - Specifies the file on the target or source computer to use for the operation. - Specifies the destination application in which to copy the file specified using Comp1FileName during the M_FILE_COPY or M_FILE_COPY_MIL_DLL operation. - Specifies the directory (and optionally a new file name) in computer 2 in which to copy the file specified using Comp1FileName. - Specifies the operation to perform on the specified file. - Reserved for future expansion. - Specifies the address of the user data that used by some operations. - - - Perform a file operation on a local or a remote computer. - Specifies the identifier of the application context to use. - Specifies the file on the target or source computer to use for the operation. - Specifies the destination application in which to copy the file specified using Comp1FileName during the M_FILE_COPY or M_FILE_COPY_MIL_DLL operation. - Specifies the directory (and optionally a new file name) in computer 2 in which to copy the file specified using Comp1FileName. - Specifies the operation to perform on the specified file. - Reserved for future expansion. - Specifies the address of the user data that used by some operations. - - - Perform a file operation on a local or a remote computer. - Specifies the identifier of the application context to use. - Specifies the file on the target or source computer to use for the operation. - Specifies the destination application in which to copy the file specified using Comp1FileName during the M_FILE_COPY or M_FILE_COPY_MIL_DLL operation. - Specifies the directory (and optionally a new file name) in computer 2 in which to copy the file specified using Comp1FileName. - Specifies the operation to perform on the specified file. - Reserved for future expansion. - Specifies the address of the user data that used by some operations. - - - Free a MIL application. - Specifies the application to free. - - - Get error codes and related information. - Specifies the identifier of the application context to use. - Specifies the type of error information to read. - Specifies the address in which to write the requested information. - The returned value is the requested error/function code. If the error code is read and it is equal to M_NULL_ERROR , no error has occurred. - - - Get error codes and related information. - Specifies the identifier of the application context to use. - Specifies the type of error information to read. - Specifies the address in which to write the requested information. - The returned value is the requested error/function code. If the error code is read and it is equal to M_NULL_ERROR , no error has occurred. - - - Get error codes and related information. - Specifies the identifier of the application context to use. - Specifies the type of error information to read. - Specifies the address in which to write the requested information. - The returned value is the requested error/function code. If the error code is read and it is equal to M_NULL_ERROR , no error has occurred. - - - Get information about a hooked event. - Specifies the identifier of the application context to use. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hooked event. - Specifies the identifier of the application context to use. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hooked event. - Specifies the identifier of the application context to use. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hooked event. - Specifies the identifier of the application context to use. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hooked event. - Specifies the identifier of the application context to use. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hooked event. - Specifies the identifier of the application context to use. - Specifies the application event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Hook a function to an event. - Specifies the identifier of the application context to use. - Specifies the event type. - Specifies the address of the function that should be called when an event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Hook a function to an event. - Specifies the identifier of the application context to use. - Specifies the event type. - Specifies the address of the function that should be called when an event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Inquire about an application setting. - Specifies the identifier of the application context to use. - Specifies the type of application setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an application setting. - Specifies the identifier of the application context to use. - Specifies the type of application setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an application setting. - Specifies the identifier of the application context to use. - Specifies the type of application setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an application setting. - Specifies the identifier of the application context to use. - Specifies the type of application setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about published MIL objects on a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the type of Distributed MIL connection setting about which to inquire. - Specifies an attribute of the inquire operation to perform. - Specifies an attribute of the inquire operation to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about published MIL objects on a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the type of Distributed MIL connection setting about which to inquire. - Specifies an attribute of the inquire operation to perform. - Specifies an attribute of the inquire operation to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL multi-core processing application environment setting. - Specifies the identifier of the application context to use. - Specifies the type of multi-core processing application environment setting about which to inquire. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies additional information regarding the inquired setting. This parameter must be set to M_DEFAULT if not used. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. The return value is undefined for M_CORE_AFFINITY_MASK, M_CORE_AFFINITY_MASK_PROCESS, M_MEMORY_BANK_AFFINITY_MASK, and M_MEMORY_BANK_CORE_AFFINITY_MASK. - - - Inquire about a MIL multi-core processing application environment setting. - Specifies the identifier of the application context to use. - Specifies the type of multi-core processing application environment setting about which to inquire. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies additional information regarding the inquired setting. This parameter must be set to M_DEFAULT if not used. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. The return value is undefined for M_CORE_AFFINITY_MASK, M_CORE_AFFINITY_MASK_PROCESS, M_MEMORY_BANK_AFFINITY_MASK, and M_MEMORY_BANK_CORE_AFFINITY_MASK. - - - Inquire about a MIL multi-core processing application environment setting. - Specifies the identifier of the application context to use. - Specifies the type of multi-core processing application environment setting about which to inquire. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies additional information regarding the inquired setting. This parameter must be set to M_DEFAULT if not used. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. The return value is undefined for M_CORE_AFFINITY_MASK, M_CORE_AFFINITY_MASK_PROCESS, M_MEMORY_BANK_AFFINITY_MASK, and M_MEMORY_BANK_CORE_AFFINITY_MASK. - - - Connect to a Distributed MIL publishing application. - Specifies the computer to which to connect, and if necessary the listening port of the publishing application. - Reserved for future expansion. - Reserved for future expansion. - Specifies the address in which to write the remote application identifier returned by this function. - - - Control or inquire a MIL timer's setting or value. - Specifies the identifier of the application context to use. - Specifies the control to exert on the MIL timer. - Specifies the address of the variable in which to store the timer information produced by M_TIMER_READ or M_TIMER_RESOLUTION. - The returned value, for M_TIMER_READ and M_TIMER_RESOLUTION, is the requested information cast to a MIL_DOUBLE. For M_TIMER_RESET and M_TIMER_WAIT, this function returns 0.0. - - - Control or inquire a MIL timer's setting or value. - Specifies the identifier of the application context to use. - Specifies the control to exert on the MIL timer. - Specifies the address of the variable in which to store the timer information produced by M_TIMER_READ or M_TIMER_RESOLUTION. - The returned value, for M_TIMER_READ and M_TIMER_RESOLUTION, is the requested information cast to a MIL_DOUBLE. For M_TIMER_RESET and M_TIMER_WAIT, this function returns 0.0. - - - Create a user MIL trace marker or section in a trace log. - Specifies the identifier of the application context to use. - Specifies the type of trace marker to create. - Specifies a value that identifies this trace marker or section. - Specifies a value relevant to the trace marker or section, or relevant to the surrounding code. - Specifies a string relevant to the trace marker or section, or relevant to the surrounding code. - - - Create a user MIL trace marker or section in a trace log. - Specifies the identifier of the application context to use. - Specifies the type of trace marker to create. - Specifies a value that identifies this trace marker or section. - Specifies a value relevant to the trace marker or section, or relevant to the surrounding code. - Specifies a string relevant to the trace marker or section, or relevant to the surrounding code. - - - Allocate a bead context. - Specifies the identifier of the system on which to allocate the bead context. - Specifies the strategy with which to extract and analyze beads. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the bead context identifier. - The returned value is the bead context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a bead context. - Specifies the identifier of the system on which to allocate the bead context. - Specifies the strategy with which to extract and analyze beads. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the bead context identifier. - The returned value is the bead context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a bead result buffer. - Specifies the identifier of the system on which to allocate the result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the bead result buffer identifier. - The returned value is the bead result buffer's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a bead result buffer. - Specifies the identifier of the system on which to allocate the result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the bead result buffer identifier. - The returned value is the bead result buffer's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a bead context or template setting. - Specifies the identifier of the bead context to control. - Specifies the bead template (one or all) to control, or specifies that you are controlling a global setting of the bead context. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control a bead context or template setting. - Specifies the identifier of the bead context to control. - Specifies the bead template (one or all) to control, or specifies that you are controlling a global setting of the bead context. - Specifies the type of control to set. - Specifies the required value for the control. - - - Draw specific features of a bead context or of a bead result. - Specifies the identifier of the 2D graphics context to use. This parameter must be set to one of the following values: - Specifies the identifier of the bead context or bead result buffer that this function will use to perform the drawing operation. The context or result buffer must have been previously allocated on the system using MbeadAlloc or MbeadAllocResult, respectively. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the drawing operation to perform. - Specifies the type of points that this function will use to perform the drawing operation. - Specifies the templates (one or all) that this function will use to perform the drawing operation, or specifies that you are performing a general type of drawing operation. - Specifies the set of template points (one or all) for which to perform the drawing operation, or specifies that you are performing a general type of drawing operation. - Specifies whether MIL performs drawings with fail-type points differently than drawings with other types of points. - - - Free a bead context or a bead result buffer. - Specifies the identifier of the bead context or bead result buffer to free. These must have been successfully allocated (with MbeadAlloc or MbeadAllocResult) prior to calling this function. - - - Get the template and/or vertex closest to a source point. - Specifies the identifier of the bead context. - Specifies the bead template in which the closest vertex is expected to be located. - Specifies the source point's X-position. - Specifies the source point's Y-position. - Specifies the address of the variable in which to write the label of the closest template. - Specifies the address of the variable in which to write the index of the closest vertex. - Specifies whether to retrieve the closest template and/or the closest vertex. - - - Get the template and/or vertex closest to a source point. - Specifies the identifier of the bead context. - Specifies the bead template in which the closest vertex is expected to be located. - Specifies the source point's X-position. - Specifies the source point's Y-position. - Specifies the address of the variable in which to write the label of the closest template. - Specifies the address of the variable in which to write the index of the closest vertex. - Specifies whether to retrieve the closest template and/or the closest vertex. - - - Get the template and/or vertex closest to a source point. - Specifies the identifier of the bead context. - Specifies the bead template in which the closest vertex is expected to be located. - Specifies the source point's X-position. - Specifies the source point's Y-position. - Specifies the address of the variable in which to write the label of the closest template. - Specifies the address of the variable in which to write the index of the closest vertex. - Specifies whether to retrieve the closest template and/or the closest vertex. - - - Get the template and/or vertex closest to a source point. - Specifies the identifier of the bead context. - Specifies the bead template in which the closest vertex is expected to be located. - Specifies the source point's X-position. - Specifies the source point's Y-position. - Specifies the address of the variable in which to write the label of the closest template. - Specifies the address of the variable in which to write the index of the closest vertex. - Specifies whether to retrieve the closest template and/or the closest vertex. - - - Get results from a bead result buffer. - Specifies the identifier of the bead result buffer from which to get results. - Specifies the label or index of the template for which to get results, or specifies that you are getting general results related to all templates. - Specifies the trained points (one or all) for which to get results or specifies that you are getting general results. - Specifies the result to get. - Specifies the address in which to write the requested information. - - - Get results from a bead result buffer. - Specifies the identifier of the bead result buffer from which to get results. - Specifies the label or index of the template for which to get results, or specifies that you are getting general results related to all templates. - Specifies the trained points (one or all) for which to get results or specifies that you are getting general results. - Specifies the result to get. - Specifies the address in which to write the requested information. - - - Get results from a bead result buffer. - Specifies the identifier of the bead result buffer from which to get results. - Specifies the label or index of the template for which to get results, or specifies that you are getting general results related to all templates. - Specifies the trained points (one or all) for which to get results or specifies that you are getting general results. - Specifies the result to get. - Specifies the address in which to write the requested information. - - - Get results from a bead result buffer. - Specifies the identifier of the bead result buffer from which to get results. - Specifies the label or index of the template for which to get results, or specifies that you are getting general results related to all templates. - Specifies the trained points (one or all) for which to get results or specifies that you are getting general results. - Specifies the result to get. - Specifies the address in which to write the requested information. - - - Get results from a bead result buffer. - Specifies the identifier of the bead result buffer from which to get results. - Specifies the label or index of the template for which to get results, or specifies that you are getting general results related to all templates. - Specifies the trained points (one or all) for which to get results or specifies that you are getting general results. - Specifies the result to get. - Specifies the address in which to write the requested information. - - - Get results from a bead result buffer. - Specifies the identifier of the bead result buffer from which to get results. - Specifies the label or index of the template for which to get results, or specifies that you are getting general results related to all templates. - Specifies the trained points (one or all) for which to get results or specifies that you are getting general results. - Specifies the result to get. - Specifies the address in which to write the requested information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a bead context, template, or result. - Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. - Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Restore a bead context from disk. - Specifies the name and path of the file from which to restore the bead context. - Specifies the identifier of the system on which to restore the bead context. - Specifies whether to restore the camera calibration context that was saved with the bead context. - Specifies the address of the variable in which to write the bead context identifier. - The returned value is the bead context identifier. If allocation fails, M_NULL is returned. - - - Save a bead context to a file. - Specifies the name and path of the file in which to save the bead context. - Specifies the identifier of the bead context to save. - Specifies whether to save the camera calibration context associated with the training image. - - - Load, restore, or save a MIL bead context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the bead context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the bead context. - Specifies the MIL version of the bead context. - Specifies whether to restore the camera calibration context from the bead context, or save the camera calibration context with the bead context. - Specifies the address of the variable in which to write or from which to read the identifier of the bead context. - Specifies the address of the variable in which to write the size of the bead context, in bytes. - - - Load, restore, or save a MIL bead context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the bead context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the bead context. - Specifies the MIL version of the bead context. - Specifies whether to restore the camera calibration context from the bead context, or save the camera calibration context with the bead context. - Specifies the address of the variable in which to write or from which to read the identifier of the bead context. - Specifies the address of the variable in which to write the size of the bead context, in bytes. - - - Load, restore, or save a MIL bead context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the bead context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the bead context. - Specifies the MIL version of the bead context. - Specifies whether to restore the camera calibration context from the bead context, or save the camera calibration context with the bead context. - Specifies the address of the variable in which to write or from which to read the identifier of the bead context. - Specifies the address of the variable in which to write the size of the bead context, in bytes. - - - Load, restore, or save a MIL bead context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the bead context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the bead context. - Specifies the MIL version of the bead context. - Specifies whether to restore the camera calibration context from the bead context, or save the camera calibration context with the bead context. - Specifies the address of the variable in which to write or from which to read the identifier of the bead context. - Specifies the address of the variable in which to write the size of the bead context, in bytes. - - - Load, restore, or save a MIL bead context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the bead context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the bead context. - Specifies the MIL version of the bead context. - Specifies whether to restore the camera calibration context from the bead context, or save the camera calibration context with the bead context. - Specifies the address of the variable in which to write or from which to read the identifier of the bead context. - Specifies the address of the variable in which to write the size of the bead context, in bytes. - - - Load, restore, or save a MIL bead context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the bead context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the bead context. - Specifies the MIL version of the bead context. - Specifies whether to restore the camera calibration context from the bead context, or save the camera calibration context with the bead context. - Specifies the address of the variable in which to write or from which to read the identifier of the bead context. - Specifies the address of the variable in which to write the size of the bead context, in bytes. - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Add, delete, or modify a bead template. - Specifies the identifier of a bead context. - Specifies to add a new bead template to a bead context, or specifies another operation to perform with a template that is already in a context. - Specifies the type of the new bead template to add to a bead context, or specifies that the type information is not required. - Specifies a unique label for a new bead template to add to a bead context, or specifies the index or label of a template in a context (or all templates in a context) with which to perform the operation. - Specifies information required for the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Specifies an attribute of the operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Train the templates in a bead context. - Specifies the identifier of the bead context that contains the templates to train. - Specifies the identifier of the image buffer containing the training image with which to train the templates, or specifies to train the templates without a training image (or with a previously saved training image). - Specifies whether to save the training image ( TrainingImageBufId). - - - Verify beads in the target image according to their corresponding template. - Specifies the identifier of the bead context that contains the templates with which to validate the beads in the target image. - Specifies the identifier of the target image buffer that contains the beads that must be verified, according the templates contained within the bead context. The image buffer must be a 1-band 8-bit unsigned buffer. - Specifies the identifier of the bead result buffer in which to write the results of the verification. - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate a Blob Analysis context. - Specifies the system on which to allocate the context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write the identifier of the Blob Analysis context. - The returned value is the Blob Analysis context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Blob Analysis context. - Specifies the system on which to allocate the context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write the identifier of the Blob Analysis context. - The returned value is the Blob Analysis context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Blob Analysis result buffer. - Specifies the system on which to allocate the result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write the identifier of the Blob Analysis result buffer. - The returned value is the result buffer's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Blob Analysis result buffer. - Specifies the system on which to allocate the result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write the identifier of the Blob Analysis result buffer. - The returned value is the result buffer's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Perform blob analysis calculations. - Specifies the identifier of the Blob Analysis context, that specifies the feature(s) to calculate, and other settings related to the blob analysis operation. - Specifies the identifier of the image buffer to use as the blob identifier image. This image is used to distinguish blob pixels from background pixels and which pixels belong to which blob. - Specifies the identifier of the image buffer to use as the grayscale image. This image is used to supply the intensity of blob pixels when calculating features with a grayscale definition. - Specifies the identifier of a Blob Analysis result buffer, in which to store calculated results. - - - Control a blob analysis setting. - Specifies the identifier of the Blob Analysis context or result buffer. - Specifies the setting to change. - Specifies the setting's new value. - - - Control a blob analysis setting. - Specifies the identifier of the Blob Analysis context or result buffer. - Specifies the setting to change. - Specifies the setting's new value. - - - Draw specific blob features in the destination image buffer or 2D graphics list. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the identifier of the Blob Analysis result buffer from which to retrieve the features to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Specifies the label or index of the blob or blobs whose information to draw. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free the Blob Analysis context or result buffer. - Specifies the identifier of the Blob Analysis context or result buffer to free. The buffer must have been successfully allocated, using MblobAllocResult or MblobAlloc, prior to calling this function. - - - Get the label value of a blob at a specified position. - Specifies the identifier of the Blob Analysis result buffer where the labels are stored. Note, this function cannot obtain the label values of blobs that have been deleted from the result buffer with MblobSelect. - Specifies the X-coordinate of the blob. - Specifies the Y-coordinate of the blob. - Specifies the address of the variable in which to write the label value. If there is no blob at the specified location, the blob has been deleted, or if the blob's XPos and YPos lie outside the original identifier image, M_NULL is returned instead of the label value. Also, since MblobGetLabel returns the label value, you can set this parameter to M_NULL . - The returned value is the label value of the specified blob. - - - Get the label value of a blob at a specified position. - Specifies the identifier of the Blob Analysis result buffer where the labels are stored. Note, this function cannot obtain the label values of blobs that have been deleted from the result buffer with MblobSelect. - Specifies the X-coordinate of the blob. - Specifies the Y-coordinate of the blob. - Specifies the address of the variable in which to write the label value. If there is no blob at the specified location, the blob has been deleted, or if the blob's XPos and YPos lie outside the original identifier image, M_NULL is returned instead of the label value. Also, since MblobGetLabel returns the label value, you can set this parameter to M_NULL . - The returned value is the label value of the specified blob. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the label or index of the blob for which to get results, or specifies that you are getting general results related to all blobs. This parameter must be set to one of the following values: - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Inquire about a Blob Analysis setting. - Specifies the identifier of a Blob Analysis context or result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a Blob Analysis setting. - Specifies the identifier of a Blob Analysis context or result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a Blob Analysis setting. - Specifies the identifier of a Blob Analysis context or result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a Blob Analysis setting. - Specifies the identifier of a Blob Analysis context or result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Draw a labeled image. - Specifies the identifier of the blob analysis result buffer. - Specifies the identifier of the destination (labeled) image buffer. This must be a single band, 8 or 16-bit unsigned buffer. - Specifies whether or not to clear the destination image buffer before drawing the labeled image into it. - - - Merge the results of two blob result buffers. - Specifies the identifier of the first source result buffer. SrcResultBlobId1 and SrcResultBlobId2 cannot be the same. - Specifies the identifier of the second source result buffer. SrcResultBlobId1 and SrcResultBlobId2 cannot be the same. - Specifies the identifier of the destination result buffer. DstResultBlobId cannot be the same as SrcResultBlobId1 or SrcResultBlobId2. - Specifies the control settings for the merge operation. This parameter can be set to any of the following. - - - Reconstruct blobs (or blob holes) in an image buffer. - Specifies the identifier of the source image buffer. - Specifies the identifier of the image buffer to use as a seed image. - Specifies the identifier of the destination (processed blobs) image buffer. - Specifies the type of operation to perform. - Specifies the processing mode to use. - - - Restore a blob context from disk. - Specifies the name and path of the file from which to restore the blob context. - Specifies the identifier of the system on which to restore the blob context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the blob context identifier. - The returned value is the blob context identifier. If allocation fails, M_NULL is returned. - - - Save a blob context to a file. - Specifies the name and path of the file in which to save the blob context. - Specifies the identifier of the blob context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a blob context to a file. - Specifies the name and path of the file in which to save the blob context. - Specifies the identifier of the blob context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Select blobs for calculations and result retrieval. - Specifies the identifier of the Blob Analysis result buffer to use in the blob selection process. - Specifies the operation to perform on the specified blobs. This parameter can be set to one of the following. - Specifies the feature to use as part of the selection criterion or the status of the blobs to affect. - Specifies the condition for the blob selection. - Specifies the lower limit of the selected condition. - Specifies the upper limit of the selected condition. - - - Load, restore, or save a MIL blob context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the blob context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the blob context. - Specifies the MIL version of the blob context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the blob context. - Specifies the address of the variable in which to write the size of the blob context, in bytes. - - - Load, restore, or save a MIL blob context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the blob context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the blob context. - Specifies the MIL version of the blob context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the blob context. - Specifies the address of the variable in which to write the size of the blob context, in bytes. - - - Load, restore, or save a MIL blob context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the blob context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the blob context. - Specifies the MIL version of the blob context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the blob context. - Specifies the address of the variable in which to write the size of the blob context, in bytes. - - - Load, restore, or save a MIL blob context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the blob context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the blob context. - Specifies the MIL version of the blob context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the blob context. - Specifies the address of the variable in which to write the size of the blob context, in bytes. - - - Load, restore, or save a MIL blob context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the blob context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the blob context. - Specifies the MIL version of the blob context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the blob context. - Specifies the address of the variable in which to write the size of the blob context, in bytes. - - - Load, restore, or save a MIL blob context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the blob context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the blob context. - Specifies the MIL version of the blob context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the blob context. - Specifies the address of the variable in which to write the size of the blob context, in bytes. - - - Perform a transformation/modification on blob analysis results. - Specifies the identifier of the source result buffer. - Specifies the identifier of the destination result buffer. DstResultBlobId must be set to the same result buffer as SrcResultBlobId(that is, the transformation is done in-place). - Specifies the operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate a 1D data buffer. - Specifies the MIL system on which to allocate the buffer. - Specifies the buffer width. The units are determined by the selected buffer attribute. - Specifies a combination of two values: the depth and type of the data. - Specifies the buffer usage. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a 1D data buffer. - Specifies the MIL system on which to allocate the buffer. - Specifies the buffer width. The units are determined by the selected buffer attribute. - Specifies a combination of two values: the depth and type of the data. - Specifies the buffer usage. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a 2D data buffer. - Specifies the MIL system on which to allocate the buffer. - Specifies the buffer width. The units are determined by the selected buffer attribute. - Specifies the buffer height. The units are determined by the selected buffer attribute. - Specifies a combination of two values: the depth and type of the data. - Specifies the buffer usage. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a 2D data buffer. - Specifies the MIL system on which to allocate the buffer. - Specifies the buffer width. The units are determined by the selected buffer attribute. - Specifies the buffer height. The units are determined by the selected buffer attribute. - Specifies a combination of two values: the depth and type of the data. - Specifies the buffer usage. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a color data buffer. - Specifies the MIL system on which to allocate the buffer. - Specifies the number of (x,y) surfaces (also called color bands) to allocate to the buffer. - Specifies the buffer width. The units are determined by the selected buffer attribute. - Specifies the buffer height. The units are determined by the selected buffer attribute. - Specifies a combination of two values: data type and data depth per band. - Specifies the buffer usage. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a color data buffer. - Specifies the MIL system on which to allocate the buffer. - Specifies the number of (x,y) surfaces (also called color bands) to allocate to the buffer. - Specifies the buffer width. The units are determined by the selected buffer attribute. - Specifies the buffer height. The units are determined by the selected buffer attribute. - Specifies a combination of two values: data type and data depth per band. - Specifies the buffer usage. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a buffer and add it as a component of a container. - Specifies the MIL identifier of the container to which to add the component. - Specifies the number of (x,y) surfaces (also called bands) to allocate to the buffer. - Specifies the buffer width. The units are determined by the selected buffer attribute. - Specifies the buffer height. The units are determined by the selected buffer attribute. - Specifies a combination of two values: data type and data depth per band. - Specifies the buffer usage. - Specifies the component type, which identifies what kind of information the component stores. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a buffer and add it as a component of a container. - Specifies the MIL identifier of the container to which to add the component. - Specifies the number of (x,y) surfaces (also called bands) to allocate to the buffer. - Specifies the buffer width. The units are determined by the selected buffer attribute. - Specifies the buffer height. The units are determined by the selected buffer attribute. - Specifies a combination of two values: data type and data depth per band. - Specifies the buffer usage. - Specifies the component type, which identifies what kind of information the component stores. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a container. - Specifies the MIL system on which to allocate the container. - Specifies the container usage. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the container identifier. - The returned value is the container identifier. If allocation fails, M_NULL is returned. - - - Allocate a container. - Specifies the MIL system on which to allocate the container. - Specifies the container usage. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the container identifier. - The returned value is the container identifier. If allocation fails, M_NULL is returned. - - - Allocate an image buffer or a container (automatically determined by MIL) with settings appropriate for grabbing using the specified digitizer. - Specifies the MIL system on which to allocate the image buffer or the container. This parameter should be set to one of the following values: - Specifies the digitizer to use as a reference for determining the settings of the image buffer or container to allocate. - Specifies the usage of the image buffer or container. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the image buffer or container identifier. - The returned value is the identifier of the image buffer or container. If allocation fails, M_NULL is returned. - - - Decode the color information of a single-band, Bayer color-encoded image. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies whether white balancing and gamma correction are performed, and the coefficients and exponents used to perform these corrections, respectively. - Specifies the Bayer pattern to use in the conversion, and whether the white balancing coefficients will be calculated. - - - Allocate a 1D child data buffer within a specific region of the first row of a parent data buffer. - Specifies the identifier of the parent buffer. - Specifies the offset of the child buffer relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a 1D child data buffer within a specific region of the first row of a parent data buffer. - Specifies the identifier of the parent buffer. - Specifies the offset of the child buffer relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a child buffer within a specific region of a parent buffer. - Specifies the identifier of the parent buffer. - Specifies the horizontal pixel offset of the child buffer's top-left pixel, relative to the parent buffer's top-left pixel. - Specifies the vertical pixel offset of the child buffer's top-left pixel, relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the height of the child buffer. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a child buffer within a specific region of a parent buffer. - Specifies the identifier of the parent buffer. - Specifies the horizontal pixel offset of the child buffer's top-left pixel, relative to the parent buffer's top-left pixel. - Specifies the vertical pixel offset of the child buffer's top-left pixel, relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the height of the child buffer. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier. If allocation fails, M_NULL is returned. - - - Allocate a color-band child data buffer within a color parent buffer. - Specifies the identifier of the parent buffer. - Specifies the band or bands of the parent data buffer from which to allocate the child data buffer. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a color-band child data buffer within a color parent buffer. - Specifies the identifier of the parent buffer. - Specifies the band or bands of the parent data buffer from which to allocate the child data buffer. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a child data buffer within a color parent buffer. - Specifies the identifier of the parent buffer. - Specifies the color band of the parent data buffer from which to allocate the child data buffer. - Specifies the horizontal offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the vertical offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the height of the child buffer. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a child data buffer within a color parent buffer. - Specifies the identifier of the parent buffer. - Specifies the color band of the parent data buffer from which to allocate the child data buffer. - Specifies the horizontal offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the vertical offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the height of the child buffer. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a child data buffer within a color parent buffer and, if necessary, performs a clipping operation. - Specifies the identifier of the parent buffer. - Specifies the color band of the parent data buffer from which to allocate the child data buffer. - Specifies the horizontal offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the vertical offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the height of the child buffer. - Specifies the address of the variable in which the clipping status is written. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a child data buffer within a color parent buffer and, if necessary, performs a clipping operation. - Specifies the identifier of the parent buffer. - Specifies the color band of the parent data buffer from which to allocate the child data buffer. - Specifies the horizontal offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the vertical offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the height of the child buffer. - Specifies the address of the variable in which the clipping status is written. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a child data buffer within a color parent buffer and, if necessary, performs a clipping operation. - Specifies the identifier of the parent buffer. - Specifies the color band of the parent data buffer from which to allocate the child data buffer. - Specifies the horizontal offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the vertical offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the height of the child buffer. - Specifies the address of the variable in which the clipping status is written. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a child data buffer within a color parent buffer and, if necessary, performs a clipping operation. - Specifies the identifier of the parent buffer. - Specifies the color band of the parent data buffer from which to allocate the child data buffer. - Specifies the horizontal offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the vertical offset of the child buffer, relative to the parent buffer's top-left pixel. - Specifies the width of the child buffer. - Specifies the height of the child buffer. - Specifies the address of the variable in which the clipping status is written. - Specifies the address of the variable in which the child buffer identifier is to be written. - The returned value is the child buffer identifier, if successful. If allocation fails, M_NULL is returned. - - - Allocate a child container. - Specifies the identifier of the parent container. - Specifies the number of elements in the array of criteria that will be applied to the parent container. - Specifies the address of an array of criteria that will be used to determine which components from the parent container to make part of the child container. - Specifies whether to have the child container contain the components that meet at least one of the criteria, or only the components that meet all of the criteria. - Specifies the address of the variable in which to write the identifier of the child container. - The returned value is the child container identifier, if successful. If allocation fails, M_NULL is returned. - - - Move and resize a child buffer within the parent buffer. - Specifies the identifier of the child buffer to move and/or resize. - Specifies the new X-offset of the child buffer relative to the parent buffer's top-left pixel. - Specifies the new Y-offset of the child buffer relative to the parent's top-left pixel. - Specifies the new width of the child buffer. - Specifies the new height of the child buffer. - Specifies the function's control flag. - - - Clears a buffer, or the components of a container, to a specified color. - Specifies the identifier of the buffer or container to clear. - Specifies the color value with which to clear the buffer. - - - Conditionally clears a buffer to a specified color. - Specifies the identifier of the data buffer to conditionally clear. - Specifies the red component of the clear color, or, if DstBufId is a single band, this value is used as the clear color. - Specifies the green component of the clear color. - Specifies the blue component of the clear color. - Specifies the identifier of the condition buffer. - Specifies the condition for which the condition buffer is tested. - Specifies the color value for the specified condition. - - - Clones a data buffer or container. - Specifies the identifier of the source buffer or container to clone. - Specifies the system on which to allocate the clone. - Specifies the width of the clone. If the source is a container, this must be set to M_DEFAULT. - Specifies the height of the clone. If the source is a container, this must be set to M_DEFAULT. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the attributes of the clone. For both buffers and containers you can specify that the clone will retain the same attributes as the source by setting this parameter to M_DEFAULT. - Specifies the control settings for the cloning operation. - Specifies the address of the variable in which to write the buffer or container identifier. - The returned value is the buffer or container identifier. If allocation fails, M_NULL is returned. - - - Clones a data buffer or container. - Specifies the identifier of the source buffer or container to clone. - Specifies the system on which to allocate the clone. - Specifies the width of the clone. If the source is a container, this must be set to M_DEFAULT. - Specifies the height of the clone. If the source is a container, this must be set to M_DEFAULT. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the attributes of the clone. For both buffers and containers you can specify that the clone will retain the same attributes as the source by setting this parameter to M_DEFAULT. - Specifies the control settings for the cloning operation. - Specifies the address of the variable in which to write the buffer or container identifier. - The returned value is the buffer or container identifier. If allocation fails, M_NULL is returned. - - - Control a specified data buffer setting. - Specifies the identifier of the buffer to control. - Specifies the buffer setting to control. - Specifies the value needed for the setting. - - - Control a specified data buffer setting. - Specifies the identifier of the buffer to control. - Specifies the buffer setting to control. - Specifies the value needed for the setting. - - - Control a specified area of a buffer. - Specifies the identifier of the buffer to control. - Specifies the horizontal pixel offset of the area. - Specifies the vertical pixel offset of the area. - Specifies the width of the area, in pixels. - Specifies the height of the area, in pixels. - Specifies the band of the area. This parameter can be set to one of the following values. - Specifies the type of buffer setting to control. - Specifies the value required for the setting. - - - Control a setting of the specified container, or one of its components. - Specifies the identifier of the container to control, or of which to control a component. - Specifies what to control; either the container itself, or a component of the container. - Specifies the setting to control. - Specifies the value needed for the setting. - - - Control a setting of the specified container, or one of its components. - Specifies the identifier of the container to control, or of which to control a component. - Specifies what to control; either the container itself, or a component of the container. - Specifies the setting to control. - Specifies the value needed for the setting. - - - Converts 3D data to a format that is 3D-processable and/or 3D-displayable. - Specifies the identifier of the source container or fully corrected depth map image buffer to convert. - Specifies the identifier of the destination container or image buffer in which to store the converted data. - Specifies the identifier of a 1-band, 1D M_ARRAY buffer containing the Y-axis value for each row of coordinates stored in the range or disparity component of the source container. - Specifies which operations to apply to the data during conversion. - Specifies whether to generate an error when there is missing or ambiguous information in the source, or to compensate by making assumptions about the missing information. - - - Copy data from one buffer to another. - Specifies the identifier of the source data buffer. - Specifies the identifier of the destination data buffer. - - - Copy buffer, clipping data outside the destination buffer. - Specifies the identifier of the source data buffer. - Specifies the identifier of the destination data buffer. - Specifies the horizontal pixel offset of the destination buffer area at which to start copying data. - Specifies the vertical pixel offset of the destination buffer area at which to start copying data. - - - Copy one or all bands of an image buffer. - Specifies the identifiers of the source data buffer. - Specifies the identifiers of the destination data buffer. - Specifies the color band to copy. Set Band to one of the following values: - - - Copy a two-dimensional region of one or all bands of an image buffer to another buffer. - Specifies the identifier of the source data buffer. - Specifies the identifier of the destination data buffer. - Specifies the source color band from which to copy. SrcBand can be set to one of the following values: - Specifies the horizontal pixel offset of the region to read relative to the source buffer starting coordinate. - Specifies the vertical pixel offset of the region to read relative to the source buffer starting coordinate. - Specifies the destination color band in which to copy. - Specifies the horizontal pixel offset of the region to write relative to the destination buffer starting coordinate. - Specifies the vertical pixel offset of the region to write relative to the destination buffer starting coordinate. - Specifies the width of the region to be copied, starting from the specified offset ( SrcOffX, DstOffX). - Specifies the height of the region to be copied, starting from the specified offset ( SrcOffY, DstOffY). - - - Copy a data buffer, or components of a container, to components of a destination container. - Specifies the identifier of the source data buffer or container. - Specifies the identifier of the destination container. - Specifies the criterion which will be used to determine which components of the source container to copy. If the source is a data buffer, this parameter must be set to M_DEFAULT . - Specifies how to copy the source buffer or component(s) to the destination container. - Specifies whether to copy the data, settings, and attributes. - - - Copy conditionally the source buffer to the destination buffer. - Specifies the identifier of the source data buffer. - Specifies the identifier of the destination data buffer. - Specifies the identifier of the condition buffer. - Specifies the condition for which the condition buffer is tested. - Specifies the color value for the specified condition. - - - Copy buffer with mask. - Specifies the identifier of the source data buffer. Note that the source data buffer cannot be of type floating-point. - Specifies the identifier of the destination data buffer. Note that the destination data buffer cannot be of type floating-point. - Specifies the mask value. - - - Create a two-dimensional data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data type and data depth. - Specifies the buffer usage. - Specifies the physical nature of the buffer. - Specifies the size of the pitch. - Specifies the MIL identifier of the buffer, or a pointer to the data array, on which to map the created MIL buffer. - Specifies the address of the variable in which the buffer identifier is to be written. - The returned value is the buffer identifier. If allocation fails, an identifier of 0 is returned. - - - Create a two-dimensional data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data type and data depth. - Specifies the buffer usage. - Specifies the physical nature of the buffer. - Specifies the size of the pitch. - Specifies the MIL identifier of the buffer, or a pointer to the data array, on which to map the created MIL buffer. - Specifies the address of the variable in which the buffer identifier is to be written. - The returned value is the buffer identifier. If allocation fails, an identifier of 0 is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a color data buffer. - Specifies the MIL system on which to create the buffer. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Create a component in the specified container. - Specifies the MIL identifier of the container in which to create the buffer component. - Specifies the number of (x,y) surfaces (also called color bands) that the buffer should have to contain each color component of the data. - Specifies the buffer width. - Specifies the buffer height. - Specifies a combination of two values: data depth and data type, per band. - Specifies the buffer usage. - Specifies the physical nature of the buffer. This parameter can be set to one of the values below. - Specifies the size of the pitch. - Specifies one or more data pointers that address the memory to which to map the created MIL buffer. - Specifies the component type, which identifies what kind of information the buffer component stores. - Specifies the address of the variable in which to write the buffer identifier. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Inquire about the data in a file. - Specifies the file that contains the data. - Specifies the type of file setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information is not available, M_INVALID is returned. If an AVI file is specified but its codec is not known, M_AVI_CODEC_UNSUPPORTED is returned. - - - Inquire about the data in a file. - Specifies the file that contains the data. - Specifies the type of file setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information is not available, M_INVALID is returned. If an AVI file is specified but its codec is not known, M_AVI_CODEC_UNSUPPORTED is returned. - - - Inquire about the data in a file. - Specifies the file that contains the data. - Specifies the type of file setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information is not available, M_INVALID is returned. If an AVI file is specified but its codec is not known, M_AVI_CODEC_UNSUPPORTED is returned. - - - Export a data buffer or container to a file. - Specifies the name and path of the file in which to save the data buffer or container. - Specifies the file format. - Specifies the identifier of the data buffer or container to save. - - - Export a data buffer or container to a file. - Specifies the name and path of the file in which to save the data buffer or container. - Specifies the file format. - Specifies the identifier of the data buffer or container to save. - - - Export a sequence of image buffers to an AVI file. - Specifies the name and path of the AVI file. - Specifies the format of the file. - Specifies the image buffers to export or, when opening or closing ( M_OPEN, M_OPEN + M_APPEND, or M_CLOSE) a file on a remote computer, a MIL system allocated on the remote computer. - Specifies the number of MIL identifiers passed to the BufArrayPtrOrSystemIdPtr parameter (image buffers or system identifiers). - Specifies the frame rate (number of images/sec) of the sequence. - Specifies whether to write, overwrite, or append the image buffers to the AVI file. - - - Export a sequence of image buffers to an AVI file. - Specifies the name and path of the AVI file. - Specifies the format of the file. - Specifies the image buffers to export or, when opening or closing ( M_OPEN, M_OPEN + M_APPEND, or M_CLOSE) a file on a remote computer, a MIL system allocated on the remote computer. - Specifies the number of MIL identifiers passed to the BufArrayPtrOrSystemIdPtr parameter (image buffers or system identifiers). - Specifies the frame rate (number of images/sec) of the sequence. - Specifies whether to write, overwrite, or append the image buffers to the AVI file. - - - Export a sequence of image buffers to an AVI file. - Specifies the name and path of the AVI file. - Specifies the format of the file. - Specifies the image buffers to export or, when opening or closing ( M_OPEN, M_OPEN + M_APPEND, or M_CLOSE) a file on a remote computer, a MIL system allocated on the remote computer. - Specifies the number of MIL identifiers passed to the BufArrayPtrOrSystemIdPtr parameter (image buffers or system identifiers). - Specifies the frame rate (number of images/sec) of the sequence. - Specifies whether to write, overwrite, or append the image buffers to the AVI file. - - - Export a sequence of image buffers to an AVI file. - Specifies the name and path of the AVI file. - Specifies the format of the file. - Specifies the image buffers to export or, when opening or closing ( M_OPEN, M_OPEN + M_APPEND, or M_CLOSE) a file on a remote computer, a MIL system allocated on the remote computer. - Specifies the number of MIL identifiers passed to the BufArrayPtrOrSystemIdPtr parameter (image buffers or system identifiers). - Specifies the frame rate (number of images/sec) of the sequence. - Specifies whether to write, overwrite, or append the image buffers to the AVI file. - - - Free a data buffer or container. - Specifies the identifier of the data buffer or container to deallocate. - - - Free one or more buffer components of a specified container. - Specifies the MIL identifier of the container which contains the component(s) to be freed. - Specifies the criterion used to determine which component(s) will be freed from the container. - Reserved for future expansion and must be set to M_DEFAULT . - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a one-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a one-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a one-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a one-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a one-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a one-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a one-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from a two-dimensional area of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the horizontal offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the required area, relative to the top-left coordinate of the source buffer. - Specifies the width of the required area of the source buffer. - Specifies the height of the required area of the source buffer. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values, and coordinates, in user-defined arrays. - Specifies the identifier of a single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. - Specifies the radius along the Y-axis. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - Specifies the address of the user array in which to store the pixel values from the image buffer. - Specifies the address of the user array in which to store the X-coordinates of the points along the arc, from the image buffer. - Specifies the address of the user array in which to store the Y-coordinates of the points along the arc, from the image buffer. - The returned value is the number of pixels found along the arc. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the address of the user array in which to copy data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get data from an area of one or all bands of a buffer and place it in a user-supplied array. - Specifies the identifier of the source buffer. - Specifies the data format to use to save the data in the user array. - Specifies the index of the band to copy. - Specifies the horizontal offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the vertical offset (relative to the top-left source buffer coordinate) of the source buffer area from which to get the data. - Specifies the width of the source buffer area from which to get the data. - Specifies the height of the source buffer area from which to get the data. - Specifies the address of the user array in which to copy the data from the source buffer. - - - Get information about a hook event. - Specifies the buffer or container event identifier received by the hook-handler function (see MbufHookFunction). - Specifies the event type and the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hook event. - Specifies the buffer or container event identifier received by the hook-handler function (see MbufHookFunction). - Specifies the event type and the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hook event. - Specifies the buffer or container event identifier received by the hook-handler function (see MbufHookFunction). - Specifies the event type and the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a hook event. - Specifies the buffer or container event identifier received by the hook-handler function (see MbufHookFunction). - Specifies the event type and the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the pixels along a specified theoretical line, count the pixels, and store either their values or coordinates in a user-defined array. - Specifies the identifier of the source image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the source buffer. - Specifies the horizontal pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the vertical pixel offset of the finishing position of the line, relative to the top-left pixel of the source buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array in which to store the pixels or the coordinates from the image buffer. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Read the values in the source buffer, at the specified positions, and place their values in a user-defined array. - Specifies the identifier of the source buffer. - Specifies the number of values to get. - Specifies the address of an array containing the X-position corresponding to the pixels to get. - Specifies the address of an array containing the Y-position corresponding to the pixels to get. - Specifies the interpolation mode. The specified mode controls how the function behaves with non-integer positions. - Specifies the address of a user-defined array in which the values are placed. - - - Hook a function to a buffer or container event. - Specifies the identifier of the buffer or container. - Specifies the buffer event to which to hook the function. - Specifies the address of the function that should be called when the specified event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Import data from a file into a data buffer or container. - Specifies the name and path of the file from which to import the data. - Specifies the file format. - Specifies the import operation. - Specifies the system on which to allocate the buffer or container for an M_RESTORE operation. For an M_LOAD operation, this parameter should be set to M_NULL . - Specifies the address of the variable containing the buffer or container identifier, for an M_LOAD operation, or the address of the variable in which to store the new buffer or container identifier, for an M_RESTORE operation. - The returned value is the buffer or container identifier (for an M_RESTORE operation only). If allocation fails, M_NULL is returned. - - - Import data from a file into a data buffer or container. - Specifies the name and path of the file from which to import the data. - Specifies the file format. - Specifies the import operation. - Specifies the system on which to allocate the buffer or container for an M_RESTORE operation. For an M_LOAD operation, this parameter should be set to M_NULL . - Specifies the address of the variable containing the buffer or container identifier, for an M_LOAD operation, or the address of the variable in which to store the new buffer or container identifier, for an M_RESTORE operation. - The returned value is the buffer or container identifier (for an M_RESTORE operation only). If allocation fails, M_NULL is returned. - - - Import data from a file into a data buffer or container. - Specifies the name and path of the file from which to import the data. - Specifies the file format. - Specifies the import operation. - Specifies the system on which to allocate the buffer or container for an M_RESTORE operation. For an M_LOAD operation, this parameter should be set to M_NULL . - Specifies the address of the variable containing the buffer or container identifier, for an M_LOAD operation, or the address of the variable in which to store the new buffer or container identifier, for an M_RESTORE operation. - The returned value is the buffer or container identifier (for an M_RESTORE operation only). If allocation fails, M_NULL is returned. - - - Import data from a file into a data buffer or container. - Specifies the name and path of the file from which to import the data. - Specifies the file format. - Specifies the import operation. - Specifies the system on which to allocate the buffer or container for an M_RESTORE operation. For an M_LOAD operation, this parameter should be set to M_NULL . - Specifies the address of the variable containing the buffer or container identifier, for an M_LOAD operation, or the address of the variable in which to store the new buffer or container identifier, for an M_RESTORE operation. - The returned value is the buffer or container identifier (for an M_RESTORE operation only). If allocation fails, M_NULL is returned. - - - Import a sequence of images from an AVI file into separate image buffers. - Specifies the name and path of the AVI file. - Specifies the format of the file. - Specifies whether to import the specified sequence of images into automatically allocated buffers or previously allocated buffers. - Specifies the system on which to allocate the buffers for an M_RESTORE operation. In other cases, this parameter should be set to M_NULL . - Specifies the address of the array containing the buffer identifiers for an M_LOAD operation, or the address of the array in which to store the new buffer identifiers for an M_RESTORE operation. - Specifies the frame number of the image from which to begin importing. - Specifies the number of images, starting at StartImage, to import. - Specifies the function's control flag. This parameter can be set to one of the following: - - - Import a sequence of images from an AVI file into separate image buffers. - Specifies the name and path of the AVI file. - Specifies the format of the file. - Specifies whether to import the specified sequence of images into automatically allocated buffers or previously allocated buffers. - Specifies the system on which to allocate the buffers for an M_RESTORE operation. In other cases, this parameter should be set to M_NULL . - Specifies the address of the array containing the buffer identifiers for an M_LOAD operation, or the address of the array in which to store the new buffer identifiers for an M_RESTORE operation. - Specifies the frame number of the image from which to begin importing. - Specifies the number of images, starting at StartImage, to import. - Specifies the function's control flag. This parameter can be set to one of the following: - - - Import a sequence of images from an AVI file into separate image buffers. - Specifies the name and path of the AVI file. - Specifies the format of the file. - Specifies whether to import the specified sequence of images into automatically allocated buffers or previously allocated buffers. - Specifies the system on which to allocate the buffers for an M_RESTORE operation. In other cases, this parameter should be set to M_NULL . - Specifies the address of the array containing the buffer identifiers for an M_LOAD operation, or the address of the array in which to store the new buffer identifiers for an M_RESTORE operation. - Specifies the frame number of the image from which to begin importing. - Specifies the number of images, starting at StartImage, to import. - Specifies the function's control flag. This parameter can be set to one of the following: - - - Import a sequence of images from an AVI file into separate image buffers. - Specifies the name and path of the AVI file. - Specifies the format of the file. - Specifies whether to import the specified sequence of images into automatically allocated buffers or previously allocated buffers. - Specifies the system on which to allocate the buffers for an M_RESTORE operation. In other cases, this parameter should be set to M_NULL . - Specifies the address of the array containing the buffer identifiers for an M_LOAD operation, or the address of the array in which to store the new buffer identifiers for an M_RESTORE operation. - Specifies the frame number of the image from which to begin importing. - Specifies the number of images, starting at StartImage, to import. - Specifies the function's control flag. This parameter can be set to one of the following: - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL data buffer setting. - Specifies the identifier of the source data buffer. The buffer must have been previously allocated on the required system using a function of the Buffer module (for example, MbufAllocColor or MbufImport). - Specifies the type of buffer setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL container or component setting. - Specifies the identifier of the source container. The container must have been previously allocated on the required system using MbufAllocContainer. - Specifies the component to inquire. - Specifies the setting to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information cannot be retrieved, M_ERROR is returned. - - - Inquire about a MIL container or component setting. - Specifies the identifier of the source container. The container must have been previously allocated on the required system using MbufAllocContainer. - Specifies the component to inquire. - Specifies the setting to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information cannot be retrieved, M_ERROR is returned. - - - Inquire about a MIL container or component setting. - Specifies the identifier of the source container. The container must have been previously allocated on the required system using MbufAllocContainer. - Specifies the component to inquire. - Specifies the setting to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information cannot be retrieved, M_ERROR is returned. - - - Inquire about a MIL container or component setting. - Specifies the identifier of the source container. The container must have been previously allocated on the required system using MbufAllocContainer. - Specifies the component to inquire. - Specifies the setting to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information cannot be retrieved, M_ERROR is returned. - - - Inquire about a MIL container or component setting. - Specifies the identifier of the source container. The container must have been previously allocated on the required system using MbufAllocContainer. - Specifies the component to inquire. - Specifies the setting to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. If the requested information cannot be retrieved, M_ERROR is returned. - - - Link one buffer or container to another. - Specifies the identifier of the source buffer or container. - Specifies the identifier of the target buffer or container. - Specifies the link operation to perform. - Specifies whether to convert 3D information copied from the source container. - - - Load data from a file into a data buffer. - Specifies the name and path of the file from which to load the data. - Specifies the identifier of the destination buffer. - - - Load data from a file into a data buffer. - Specifies the name and path of the file from which to load the data. - Specifies the identifier of the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a data buffer. - Specifies the identifier of the destination buffer. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a one-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a one-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a one-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a one-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a one-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a one-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a one-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the address of the user array from which to put data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into a two-dimensional area of a buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left pixel. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Put data from a user-supplied array into an area of one or all bands of a data buffer. - Specifies the identifier of the destination buffer. - Specifies the data format of the user-supplied array. - Specifies the index of the band in which to copy. - Specifies the horizontal offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the vertical offset of the destination buffer area in which to put the data, relative to the destination buffer's top-left coordinate. - Specifies the width of the destination buffer area in which to put the data. - Specifies the height of the destination buffer area in which to put the data. - Specifies the address of the user array from which to copy data into the destination buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Write a specified series of values along a specified theoretical line in an image. - Specifies the identifier of the destination image buffer. - Specifies the horizontal pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the starting position of the line, relative to the top-left pixel of the destination buffer. - Specifies the horizontal pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the vertical pixel offset of the finishing position on the line, relative to the top-left pixel of the destination buffer. - Specifies the operation mode. - Specifies the address of the variable in which to write the number of pixels found along the theoretical line. - Specifies the address of the user array containing the pixels to write to the image buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Overwrite the values in the destination buffer at the specified positions, with values from a user-defined array. - Specifies the identifier of the destination buffer. - Specifies the number of values to put into the destination buffer. - Specifies the address of an array containing the X-coordinate of the positions in the buffer to overwrite. - Specifies the address of an array containing the Y-coordinate of the positions in the buffer to overwrite. - Specifies the overscan mode. This specified mode controls how the function behaves with positions that fall outside the destination buffer. - Specifies the address of a user-defined array which contains values to write into the destination buffer. - - - Restore data from disk into an automatically allocated data buffer. - Specifies the name and path of the file from which to restore the data buffer. - Specifies the system on which to allocate the buffer. - Specifies the address of the variable in which the buffer identifier is to be written. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Restore data from disk into an automatically allocated data buffer. - Specifies the name and path of the file from which to restore the data buffer. - Specifies the system on which to allocate the buffer. - Specifies the address of the variable in which the buffer identifier is to be written. - The returned value is the buffer identifier. If allocation fails, M_NULL is returned. - - - Save a data buffer or container in a file, using a MIL output file format. - Specifies the name and path of the file in which to save the file. - Specifies the identifier of the data buffer or container to save. - - - Save a data buffer or container in a file, using a MIL output file format. - Specifies the name and path of the file in which to save the file. - Specifies the identifier of the data buffer or container to save. - - - Set the region of interest (ROI) of an image buffer. - Specifies the identifier of the image buffer for which to set the ROI. - Specifies the identifier of the image buffer or 2D graphics list that contains the data to use to set the ROI. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the type of operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a buffer or container from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the buffer or container. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the buffer or container. - Specifies the MIL version of the buffer or container. - Specifies the control flag for the operation. Set this parameter to M_DEFAULT if not used. - Specifies the address of the variable in which to write, or from which to read, the buffer or container identifier. - Specifies the address of the variable in which to write the size of the buffer or container, in bytes. - - - Load, restore, or save a buffer or container from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the buffer or container. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the buffer or container. - Specifies the MIL version of the buffer or container. - Specifies the control flag for the operation. Set this parameter to M_DEFAULT if not used. - Specifies the address of the variable in which to write, or from which to read, the buffer or container identifier. - Specifies the address of the variable in which to write the size of the buffer or container, in bytes. - - - Load, restore, or save a buffer or container from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the buffer or container. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the buffer or container. - Specifies the MIL version of the buffer or container. - Specifies the control flag for the operation. Set this parameter to M_DEFAULT if not used. - Specifies the address of the variable in which to write, or from which to read, the buffer or container identifier. - Specifies the address of the variable in which to write the size of the buffer or container, in bytes. - - - Load, restore, or save a buffer or container from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the buffer or container. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the buffer or container. - Specifies the MIL version of the buffer or container. - Specifies the control flag for the operation. Set this parameter to M_DEFAULT if not used. - Specifies the address of the variable in which to write, or from which to read, the buffer or container identifier. - Specifies the address of the variable in which to write the size of the buffer or container, in bytes. - - - Load, restore, or save a buffer or container from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the buffer or container. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the buffer or container. - Specifies the MIL version of the buffer or container. - Specifies the control flag for the operation. Set this parameter to M_DEFAULT if not used. - Specifies the address of the variable in which to write, or from which to read, the buffer or container identifier. - Specifies the address of the variable in which to write the size of the buffer or container, in bytes. - - - Load, restore, or save a buffer or container from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the buffer or container. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the buffer or container. - Specifies the MIL version of the buffer or container. - Specifies the control flag for the operation. Set this parameter to M_DEFAULT if not used. - Specifies the address of the variable in which to write, or from which to read, the buffer or container identifier. - Specifies the address of the variable in which to write the size of the buffer or container, in bytes. - - - Copy a two-dimensional region of one or all bands from the source buffer into a two-dimensional region of one or all bands in the destination buffer, using a specified transfer function and transfer type. - Specifies the identifier of the source buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the source region, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the source region, relative to the top-left coordinate of the source buffer. - Specifies the width of the source region. - Specifies the height of the source region. - Specifies the color band of the region from which to copy. This parameter can be set to one of the following values: - Specifies the horizontal offset of the destination region, relative to the top-left coordinate of the destination buffer. - Specifies the vertical offset of the destination region, relative to the top-left coordinate of the destination buffer. - Specifies the width of the destination region. - Specifies the height of the destination region. - Specifies the color band of the destination region in which to copy. - Specifies the function to use in the transfer. This parameter can be set to one of the following: - Specifies the type of transfer. - Specifies the color value that is passed to the transfer function. - Specifies a pointer to the MIL identifier of the overlay buffer, if applicable. - - - Copy a two-dimensional region of one or all bands from the source buffer into a two-dimensional region of one or all bands in the destination buffer, using a specified transfer function and transfer type. - Specifies the identifier of the source buffer. - Specifies the identifier of the destination buffer. - Specifies the horizontal offset of the source region, relative to the top-left coordinate of the source buffer. - Specifies the vertical offset of the source region, relative to the top-left coordinate of the source buffer. - Specifies the width of the source region. - Specifies the height of the source region. - Specifies the color band of the region from which to copy. This parameter can be set to one of the following values: - Specifies the horizontal offset of the destination region, relative to the top-left coordinate of the destination buffer. - Specifies the vertical offset of the destination region, relative to the top-left coordinate of the destination buffer. - Specifies the width of the destination region. - Specifies the height of the destination region. - Specifies the color band of the destination region in which to copy. - Specifies the function to use in the transfer. This parameter can be set to one of the following: - Specifies the type of transfer. - Specifies the color value that is passed to the transfer function. - Specifies a pointer to the MIL identifier of the overlay buffer, if applicable. - - - Allocate a camera calibration context, a fixturing offset object, or a 3D draw calibration context. - Specifies the system on which to allocate the camera calibration context, fixturing offset object, or 3D draw calibration context. - Specifies the camera calibration mode, if allocating a camera calibration context. Otherwise, specifies to allocate a fixturing offset or a 3D draw calibration context. - Specifies the function's operation flag. - Specifies the address in which to return the identifier of the camera calibration context, fixturing offset object, or 3D draw calibration context. Since McalAlloc also returns the identifier, you can set this parameter to M_NULL . - The returned value is the context's or fixturing offset object's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a camera calibration context, a fixturing offset object, or a 3D draw calibration context. - Specifies the system on which to allocate the camera calibration context, fixturing offset object, or 3D draw calibration context. - Specifies the camera calibration mode, if allocating a camera calibration context. Otherwise, specifies to allocate a fixturing offset or a 3D draw calibration context. - Specifies the function's operation flag. - Specifies the address in which to return the identifier of the camera calibration context, fixturing offset object, or 3D draw calibration context. Since McalAlloc also returns the identifier, you can set this parameter to M_NULL . - The returned value is the context's or fixturing offset object's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Associate/disassociate a camera calibration context with/from an image or digitizer. - Specifies the camera calibration context to associate. This parameter can be set to one of the following. If an image buffer, digitizer or result buffer is passed to this parameter, the camera calibration context associated with that object is used; camera calibration settings saved with the image, digitizer or result are also copied. - Specifies the identifier of the image or digitizer with which to associate the camera calibration context. - Specifies the function's control flag. - - - Control the camera calibration information of a camera calibration context, calibrated image, or 3D draw calibration context. - Specifies the identifier of the camera calibration context, calibrated image, or 3D draw calibration context. - Specifies the setting to change. - Specifies the setting's new value. - - - Control the camera calibration information of a camera calibration context, calibrated image, or 3D draw calibration context. - Specifies the identifier of the camera calibration context, calibrated image, or 3D draw calibration context. - Specifies the setting to change. - Specifies the setting's new value. - - - Draw specific features of results obtained from a camera calibration operation. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the camera calibration context, calibrated image, corrected image, or fixturing offset object from which to extract the information to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. If a buffer is specified, it must be an unsigned 8-bit image buffer. - Specifies the type of operation to perform. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which the calibration points or fiducial box should be drawn. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Draw 3D annotations based on a calibrated or corrected image. - Specifies the identifier of the 3D draw calibration context that specifies the annotations to draw and how to draw them. This parameter must be set to one of the following values: - Specifies the identifier of the camera calibration context or calibrated image. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the identifier of the 3D graphics list in which to draw. You can specify a 3D graphics list that you have previously allocated using M3dgraAlloc, or you can specify the identifier of the 3D display's internal graphics list (inquired using M3ddispInquire with M_3D_GRAPHIC_LIST_ID). - Specifies the label of the 3D graphic in the 3D graphics list to be used as the annotation's parent. - Specifies the identifier of the image buffer containing the texture image, which you can apply to the relative XY plane to enhance its visibility. - Reserved for future expansion and must be set to M_DEFAULT . - Returns the parent label of the graphics added to the graphics list. - - - Move the relative coordinate system or learn the fixturing offset. - Specifies the identifier of the destination camera calibration context, 3D transformation matrix object, the 3D reconstruction result buffer, or the image for which to displace the relative coordinate system. - Specifies the identifier of the fixturing offset object to set up ( M_LEARN_OFFSET) or to apply to the reference location when moving the relative coordinate system ( M_MOVE_RELATIVE). - Specifies the operation to perform. - Specifies how the location used for the operation is specified. - Specifies the identifier of the MIL object containing the location for the operation, or containing the coordinate system in which the location is expressed. - Specifies information about the location used for the operation. Its definition is dependent on the specified operation and the location type. - Specifies information about the location used for the operation. Its definition is dependent on the specified operation and the location type. - Specifies information about the location used for the operation. Its definition is dependent on the specified operation and the location type. - Specifies information about the location used for the operation. Its definition is dependent on the specified operation and the location type. - - - Free a camera calibration context or a fixturing offset object. - Specifies the identifier of the camera calibration context or fixturing offset object. - - - Return the position and orientation of a coordinate system. - Specifies the identifier of a camera calibration context, a 3D reconstruction context of type M_CALIBRATED_CAMERA_LINEAR_MOTION, a 3D reconstruction result buffer of type M_POINT_CLOUD_RESULT, or any object that has camera calibration information, such as an image or a result buffer. - Specifies the coordinate system for which to inquire about its position and orientation. - Specifies the coordinate system that will be used as a reference for calculations. All returned coordinates or angles will be calculated relative to this coordinate system. - Specifies the type of transformation to use to return the location of the target coordinate system with respect to the reference coordinate system. - Specifies the identifier of the destination MIL array buffer or transformation matrix object in which to return the matrix representation of the transformation required to cause the reference coordinate system to align with the target coordinate system. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - - - Return the position and orientation of a coordinate system. - Specifies the identifier of a camera calibration context, a 3D reconstruction context of type M_CALIBRATED_CAMERA_LINEAR_MOTION, a 3D reconstruction result buffer of type M_POINT_CLOUD_RESULT, or any object that has camera calibration information, such as an image or a result buffer. - Specifies the coordinate system for which to inquire about its position and orientation. - Specifies the coordinate system that will be used as a reference for calculations. All returned coordinates or angles will be calculated relative to this coordinate system. - Specifies the type of transformation to use to return the location of the target coordinate system with respect to the reference coordinate system. - Specifies the identifier of the destination MIL array buffer or transformation matrix object in which to return the matrix representation of the transformation required to cause the reference coordinate system to align with the target coordinate system. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - - - Return the position and orientation of a coordinate system. - Specifies the identifier of a camera calibration context, a 3D reconstruction context of type M_CALIBRATED_CAMERA_LINEAR_MOTION, a 3D reconstruction result buffer of type M_POINT_CLOUD_RESULT, or any object that has camera calibration information, such as an image or a result buffer. - Specifies the coordinate system for which to inquire about its position and orientation. - Specifies the coordinate system that will be used as a reference for calculations. All returned coordinates or angles will be calculated relative to this coordinate system. - Specifies the type of transformation to use to return the location of the target coordinate system with respect to the reference coordinate system. - Specifies the identifier of the destination MIL array buffer or transformation matrix object in which to return the matrix representation of the transformation required to cause the reference coordinate system to align with the target coordinate system. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - Specifies the address in which to return information about the transformation required to cause the reference coordinate system to overlap or align with the target coordinate system, depending on which is requested. - - - Calibrate your camera setup using a grid. - Specifies the identifier of the camera calibration context. - Specifies the identifier of the image buffer containing the grid. - Specifies the X-coordinate of the grid's reference calibration point, in the real world. - Specifies the Y-coordinate of the grid's reference calibration point, in the real world. - Specifies the Z-coordinate of the grid's reference calibration point, in the real world. - Specifies the number of rows in the camera calibration grid. - Specifies the number of columns in the camera calibration grid. - Specifies the number of world units between rows. - Specifies the number of world units between columns. - Specifies the camera calibration operation to perform. - Specifies the type of grid used. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a camera calibration context, a calibrated image, a calibrated result buffer, a fixturing offset object, a 3D draw calibration context, or about the camera calibration state of an image, digitizer, or result buffer. - Specifies the identifier of the camera calibration context, image buffer, result buffer, digitizer, fixturing offset object, or 3D draw calibration context. - Specifies the setting about which to inquire. The setting for InquireType depends on whether you are inquiring about a camera calibration context, image, result buffer, or digitizer. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a single pose in a sequence of poses taken during camera calibration. - Specifies the identifier of the camera calibration context. - Specifies the index of the pose of a M_3D_ROBOTICS camera calibration context from which settings should be inquired. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Calibrate your camera setup using a list of coordinates. - Specifies the identifier of the camera calibration context. - Specifies the address of the array containing the X-pixel coordinates. - Specifies the address of the array containing the Y-pixel coordinates. - Specifies the address of the array containing the X-world coordinates in the camera calibration-plane coordinate system. - Specifies the address of the array containing the Y-world coordinates in the camera calibration-plane coordinate system. - Specifies the address of the array containing the Z-world coordinates. - Specifies the number of coordinates in the supplied arrays. - Specifies the camera calibration operation to perform. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Calibrate your camera setup using a list of coordinates. - Specifies the identifier of the camera calibration context. - Specifies the address of the array containing the X-pixel coordinates. - Specifies the address of the array containing the Y-pixel coordinates. - Specifies the address of the array containing the X-world coordinates in the camera calibration-plane coordinate system. - Specifies the address of the array containing the Y-world coordinates in the camera calibration-plane coordinate system. - Specifies the address of the array containing the Z-world coordinates. - Specifies the number of coordinates in the supplied arrays. - Specifies the camera calibration operation to perform. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Calibrate your camera setup using a list of coordinates. - Specifies the identifier of the camera calibration context. - Specifies the address of the array containing the X-pixel coordinates. - Specifies the address of the array containing the Y-pixel coordinates. - Specifies the address of the array containing the X-world coordinates in the camera calibration-plane coordinate system. - Specifies the address of the array containing the Y-world coordinates in the camera calibration-plane coordinate system. - Specifies the address of the array containing the Z-world coordinates. - Specifies the number of coordinates in the supplied arrays. - Specifies the camera calibration operation to perform. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Change the origin and/or orientation of the relative coordinate system. - Specifies the identifier of the camera calibration context or calibrated image. - Specifies the X-offset of the relative coordinate system origin from the reference coordinate system, in world-units. - Specifies the Y-offset of the relative coordinate system origin from the reference coordinate system, in world-units. - Specifies the Z-offset of the relative coordinate system origin from the reference coordinate system, in world-units. - Specifies the angle, in degrees, at which to rotate the relative coordinate system around the Z-axis of the reference coordinate system. A positive angle will rotate the relative coordinate system in the direction from the positive X-axis to the negative Y-axis of the reference coordinate system. - Specifies how to apply the transformation. This establishes the reference coordinate system. - - - Restore a camera or 3D draw calibration context from disk. - Specifies the name and path of the file from which to restore the camera or 3D draw calibration context. - Specifies the system on which to restore the camera or 3D draw calibration context. - Specifies the function's control flag. - Specifies the address in which to return the identifier of the camera or 3D draw calibration context. - The returned value is the identifier of the camera or 3D draw calibration context if the operation was successful; M_NULL if the operation failed. - - - Restore a camera or 3D draw calibration context from disk. - Specifies the name and path of the file from which to restore the camera or 3D draw calibration context. - Specifies the system on which to restore the camera or 3D draw calibration context. - Specifies the function's control flag. - Specifies the address in which to return the identifier of the camera or 3D draw calibration context. - The returned value is the identifier of the camera or 3D draw calibration context if the operation was successful; M_NULL if the operation failed. - - - Save a camera or 3D draw calibration context to a file. - Specifies the name and path of the file in which to save the camera or 3D draw calibration context. - Specifies the camera or 3D draw calibration context to save. - Specifies the function's control flag. - - - Save a camera or 3D draw calibration context to a file. - Specifies the name and path of the file in which to save the camera or 3D draw calibration context. - Specifies the camera or 3D draw calibration context to save. - Specifies the function's control flag. - - - Change the position and orientation of a coordinate system. - Specifies the identifier of a camera calibration context, 3D reconstruction result buffer of type M_POINT_CLOUD_RESULT, or a calibrated image. - Specifies the coordinate system on which to apply the transformation. - Specifies the reference coordinate system. The reference coordinate system must be defined before calling this function. - Specifies the type of transformation to apply to the target coordinate system. - Specifies the identifier of a MIL array buffer that contains the transformation matrix to use, or specifies the identifier of a transformation matrix object. The expected transformation matrix is dependent on the type of transformation selected. - Specifies an attribute of the transformation. Its definition is dependent on the type of transformation selected. - Specifies an attribute of the transformation. Its definition is dependent on the type of transformation selected. - Specifies an attribute of the transformation. Its definition is dependent on the type of transformation selected. - Specifies an attribute of the transformation. Its definition is dependent on the type of transformation selected. - - - Load, restore, or save a camera calibration context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the camera calibration context. - Specifies the operation to perform on the camera calibration context. - Specifies the type of stream in which to store/from which to restore the camera calibration context. - Specifies the MIL version of the camera calibration context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the camera calibration context. - Specifies the address of the variable in which to write the size of the camera calibration context, in bytes. - - - Load, restore, or save a camera calibration context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the camera calibration context. - Specifies the operation to perform on the camera calibration context. - Specifies the type of stream in which to store/from which to restore the camera calibration context. - Specifies the MIL version of the camera calibration context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the camera calibration context. - Specifies the address of the variable in which to write the size of the camera calibration context, in bytes. - - - Load, restore, or save a camera calibration context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the camera calibration context. - Specifies the operation to perform on the camera calibration context. - Specifies the type of stream in which to store/from which to restore the camera calibration context. - Specifies the MIL version of the camera calibration context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the camera calibration context. - Specifies the address of the variable in which to write the size of the camera calibration context, in bytes. - - - Load, restore, or save a camera calibration context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the camera calibration context. - Specifies the operation to perform on the camera calibration context. - Specifies the type of stream in which to store/from which to restore the camera calibration context. - Specifies the MIL version of the camera calibration context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the camera calibration context. - Specifies the address of the variable in which to write the size of the camera calibration context, in bytes. - - - Load, restore, or save a camera calibration context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the camera calibration context. - Specifies the operation to perform on the camera calibration context. - Specifies the type of stream in which to store/from which to restore the camera calibration context. - Specifies the MIL version of the camera calibration context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the camera calibration context. - Specifies the address of the variable in which to write the size of the camera calibration context, in bytes. - - - Load, restore, or save a camera calibration context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the camera calibration context. - Specifies the operation to perform on the camera calibration context. - Specifies the type of stream in which to store/from which to restore the camera calibration context. - Specifies the MIL version of the camera calibration context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the camera calibration context. - Specifies the address of the variable in which to write the size of the camera calibration context, in bytes. - - - Convert coordinates between their world and pixel values. - Specifies the identifier of the camera calibration context, calibrated image, or corrected image. - Specifies whether to perform a pixel-to-world or world-to-pixel conversion. - Specifies the X-coordinate of the input. - Specifies the Y-coordinate of the input. - Specifies the address of the variable in which to place the returned value of the X-coordinate. - Specifies the addres of the variable in which to place the returned value of the Y-coordinate. - - - Convert a list of coordinates, including 3D coordinates, between two coordinate systems. - Specifies the identifier of a camera calibration context, 3D reconstruction context, calibrated image, corrected image, or 3d reconstruction result buffer of type M_POINT_CLOUD_RESULT. When an identifier of an image buffer is specified, the transformation uses the camera calibration information associated with this image. - Specifies the coordinate system of the source coordinates. - Specifies the coordinate system in which to return the coordinates. - Specifies the number of points to convert. - Specifies the address of the array containing the X-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array containing the Y-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array containing the Z-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array in which to return the X-coordinates of the resulting points or the X-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the address of the array in which to return the Y-coordinates of the resulting points or the Y-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the address of the array in which to return the Z-coordinates of the resulting points or the Z-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the mode of transformation and how to deal with invalid points. - - - Convert a list of coordinates, including 3D coordinates, between two coordinate systems. - Specifies the identifier of a camera calibration context, 3D reconstruction context, calibrated image, corrected image, or 3d reconstruction result buffer of type M_POINT_CLOUD_RESULT. When an identifier of an image buffer is specified, the transformation uses the camera calibration information associated with this image. - Specifies the coordinate system of the source coordinates. - Specifies the coordinate system in which to return the coordinates. - Specifies the number of points to convert. - Specifies the address of the array containing the X-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array containing the Y-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array containing the Z-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array in which to return the X-coordinates of the resulting points or the X-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the address of the array in which to return the Y-coordinates of the resulting points or the Y-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the address of the array in which to return the Z-coordinates of the resulting points or the Z-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the mode of transformation and how to deal with invalid points. - - - Convert a list of coordinates, including 3D coordinates, between two coordinate systems. - Specifies the identifier of a camera calibration context, 3D reconstruction context, calibrated image, corrected image, or 3d reconstruction result buffer of type M_POINT_CLOUD_RESULT. When an identifier of an image buffer is specified, the transformation uses the camera calibration information associated with this image. - Specifies the coordinate system of the source coordinates. - Specifies the coordinate system in which to return the coordinates. - Specifies the number of points to convert. - Specifies the address of the array containing the X-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array containing the Y-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array containing the Z-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array in which to return the X-coordinates of the resulting points or the X-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the address of the array in which to return the Y-coordinates of the resulting points or the Y-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the address of the array in which to return the Z-coordinates of the resulting points or the Z-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the mode of transformation and how to deal with invalid points. - - - Convert a list of coordinates, including 3D coordinates, between two coordinate systems. - Specifies the identifier of a camera calibration context, 3D reconstruction context, calibrated image, corrected image, or 3d reconstruction result buffer of type M_POINT_CLOUD_RESULT. When an identifier of an image buffer is specified, the transformation uses the camera calibration information associated with this image. - Specifies the coordinate system of the source coordinates. - Specifies the coordinate system in which to return the coordinates. - Specifies the number of points to convert. - Specifies the address of the array containing the X-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array containing the Y-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array containing the Z-coordinates of the source points. These coordinates must be expressed in the source coordinate system. - Specifies the address of the array in which to return the X-coordinates of the resulting points or the X-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the address of the array in which to return the Y-coordinates of the resulting points or the Y-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the address of the array in which to return the Z-coordinates of the resulting points or the Z-components of the calculated unit direction vectors, depending on the transformation mode ( ModeFlag). These coordinates are expressed in the destination coordinate system. - Specifies the mode of transformation and how to deal with invalid points. - - - Convert a list of coordinates between their world and pixel values. - Specifies the identifier of the camera calibration context, calibrated image, or corrected image. When an identifier of an image buffer is specified, the transformation uses the camera calibration context associated with this image. - Specifies whether to perform a pixel-to-world or world-to-pixel conversion. - Specifies the number of points in the coordinate list. - Specifies the address of the array of the input X-coordinates. - Specifies the address of the array of the input Y-coordinates. - Specifies the address of the array in which to place the output X-coordinates. - Specifies the address of the array in which to place the output Y-coordinates. - - - Convert a list of coordinates between their world and pixel values. - Specifies the identifier of the camera calibration context, calibrated image, or corrected image. When an identifier of an image buffer is specified, the transformation uses the camera calibration context associated with this image. - Specifies whether to perform a pixel-to-world or world-to-pixel conversion. - Specifies the number of points in the coordinate list. - Specifies the address of the array of the input X-coordinates. - Specifies the address of the array of the input Y-coordinates. - Specifies the address of the array in which to place the output X-coordinates. - Specifies the address of the array in which to place the output Y-coordinates. - - - Convert a list of coordinates between their world and pixel values. - Specifies the identifier of the camera calibration context, calibrated image, or corrected image. When an identifier of an image buffer is specified, the transformation uses the camera calibration context associated with this image. - Specifies whether to perform a pixel-to-world or world-to-pixel conversion. - Specifies the number of points in the coordinate list. - Specifies the address of the array of the input X-coordinates. - Specifies the address of the array of the input Y-coordinates. - Specifies the address of the array in which to place the output X-coordinates. - Specifies the address of the array in which to place the output Y-coordinates. - - - Convert a list of coordinates between their world and pixel values. - Specifies the identifier of the camera calibration context, calibrated image, or corrected image. When an identifier of an image buffer is specified, the transformation uses the camera calibration context associated with this image. - Specifies whether to perform a pixel-to-world or world-to-pixel conversion. - Specifies the number of points in the coordinate list. - Specifies the address of the array of the input X-coordinates. - Specifies the address of the array of the input Y-coordinates. - Specifies the address of the array in which to place the output X-coordinates. - Specifies the address of the array in which to place the output Y-coordinates. - - - Physically transform an image by removing distortions, or create LUTs that can be used to do the same. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer or LUT buffer. - Specifies the camera calibration context with which to transform the image. - Specifies the interpolation mode to use when associating destination pixels with source points. - Specifies the function's operation type. - Specifies the function's control flag. - - - Convert a result between its world and pixel value. - Specifies the identifier of the camera calibration context, calibrated image, or corrected image. - Specifies whether to perform a pixel-to-world or world-to-pixel conversion. - Specifies the type of result the given input value represents. - Specifies the input value. - Specifies the address in which to place the output value. - - - Convert a result, taken at a specific position, between its world and pixel value. - Specifies the identifier of the camera calibration context or image. - Specifies whether to perform a pixel-to-world or world-to-pixel conversion. - Specifies the type of result to convert. - Specifies the X-coordinate of the position at which to convert the result, in the units of the source coordinate system. - Specifies the Y-coordinate of the position at which to convert the result, in the units of the source coordinate system. - Specifies the result to convert at the specified position. This result must be of the type specified using ResultType. - Specifies the address in which to place the converted result. - - - Calibrate an image or a camera calibration context by specifying the translation, scale and offset of the absolute world coordinate system. - Specifies the identifier of the camera calibration context or of the image to calibrate. - Specifies the X-position in the absolute coordinate system of the center of the top-left pixel of the image. - Specifies the Y-position in the absolute coordinate system of the center of the top-left pixel of the image. - Specifies the scale between the world and pixel units in the X-direction. - Specifies the scale between the world and pixel units in the Y-direction. - Specifies the angle of the X-axis of the pixel coordinate system measured in the absolute coordinate system, in degrees. - Specifies the function's control flag. - - - Define the mapping characteristics of a camera calibration context according to an existing camera calibration context. - Specifies the identifier of the camera calibration context, calibrated image, or corrected image From which the source mapping is taken. - Specifies the identifier of the destination camera calibration context or image buffer. - Specifies the buffer containing the matrix of coefficients or the LUT buffer from which source X-coordinates are determined. - Specifies the LUT buffer from which source Y-coordinates are determined. - Specifies the X pixel coordinate of the top-left calibration point. - Specifies the Y pixel coordinate of the top-left calibration point. - Specifies the width of the grid of calibration points, in pixels. - Specifies the height of the grid of calibration points, in pixels. - Specifies the number of rows of calibration points to be used for camera calibration. - Specifies the number of columns of calibration points to be used for camera calibration. - Specifies the type of transformation. This parameter must be set to one of the following values. - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate a classifier context, a dataset context, or a training context. - Specifies the identifier of the system on which to allocate the context. - Specifies the type of context to allocate. - Specifies which predefined CNN classifier context to use. - Specifies the address of the variable in which to write the context identifier. - The returned value is the context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a classifier context, a dataset context, or a training context. - Specifies the identifier of the system on which to allocate the context. - Specifies the type of context to allocate. - Specifies which predefined CNN classifier context to use. - Specifies the address of the variable in which to write the context identifier. - The returned value is the context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a classification result buffer to hold training or prediction results. - Specifies the identifier of the system on which to allocate the result buffer. - Specifies the type of classification result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the classification result buffer identifier. - The returned value is the classification result buffer's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a classification result buffer to hold training or prediction results. - Specifies the identifier of the system on which to allocate the result buffer. - Specifies the type of classification result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the classification result buffer identifier. - The returned value is the classification result buffer's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a classifier context, a dataset context, class definitions, a training context, a training result buffer, or a prediction result buffer. - Specifies the identifier of a context or result buffer to control. - Specifies what to control. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control a classifier context, a dataset context, class definitions, a training context, a training result buffer, or a prediction result buffer. - Specifies the identifier of a context or result buffer to control. - Specifies what to control. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control a classifier context, a dataset context, class definitions, a training context, a training result buffer, or a prediction result buffer. - Specifies the identifier of a context or result buffer to control. - Specifies what to control. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control an entry in a dataset context. - Specifies the dataset on which to control settings. - Specifies the entry to control, using the entry's index. - Specifies the entry to control, using the entry's unique key (UUID). - Specifies to control the entry, or to control the entry's region. - Specifies the type of control to set. - Specifies the value for the control. - Specifies the address of the variable which contains information for the type of control to set. - Specifies the number of elements in ControlValuePtr. - - - Control an entry in a dataset context. - Specifies the dataset on which to control settings. - Specifies the entry to control, using the entry's index. - Specifies the entry to control, using the entry's unique key (UUID). - Specifies to control the entry, or to control the entry's region. - Specifies the type of control to set. - Specifies the value for the control. - Specifies the address of the variable which contains information for the type of control to set. - Specifies the number of elements in ControlValuePtr. - - - Control an entry in a dataset context. - Specifies the dataset on which to control settings. - Specifies the entry to control, using the entry's index. - Specifies the entry to control, using the entry's unique key (UUID). - Specifies to control the entry, or to control the entry's region. - Specifies the type of control to set. - Specifies the value for the control. - Specifies the address of the variable which contains information for the type of control to set. - Specifies the number of elements in ControlValuePtr. - - - Control an entry in a dataset context. - Specifies the dataset on which to control settings. - Specifies the entry to control, using the entry's index. - Specifies the entry to control, using the entry's unique key (UUID). - Specifies to control the entry, or to control the entry's region. - Specifies the type of control to set. - Specifies the value for the control. - Specifies the address of the variable which contains information for the type of control to set. - Specifies the number of elements in ControlValuePtr. - - - Control an entry in a dataset context. - Specifies the dataset on which to control settings. - Specifies the entry to control, using the entry's index. - Specifies the entry to control, using the entry's unique key (UUID). - Specifies to control the entry, or to control the entry's region. - Specifies the type of control to set. - Specifies the value for the control. - Specifies the address of the variable which contains information for the type of control to set. - Specifies the number of elements in ControlValuePtr. - - - Copy data from one classification context to another. - Specifies the identifier of the source classification context from which to copy. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the identifier of the destination classification context in which to copy. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the type of copy operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy data from a classification result buffer to a classifier or dataset context. - Specifies the identifier of the source classification result buffer from which to copy. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the identifier of the destination classifier or dataset context in which to copy. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the type of copy operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Draw specific features of a predefined CNN classifier context, a dataset context, or a CNN prediction result buffer. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the identifier of the predefined CNN classifier context, dataset context, or CNN prediction result buffer from which to draw. - Specifies the identifier of the destination image buffer or LUT buffer in which to draw. - Specifies the drawing operation to perform. - Specifies what to use to perform the drawing operation. - Specifies how to control the drawing operation. - - - Export data from a dataset context or training result buffer to a file. - Specifies the name and path of the file in which to export. - Specifies the format of the file in which to export. - Specifies the identifier of the dataset context or a training result from which to export. - Specifies the trees (one or all) to export from a tree ensemble result buffer used for training. - Specifies the type of export operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a classifier context, a dataset context, a training context, a training result buffer, or a prediction result buffer. - Specifies the identifier of the classifier context, dataset context, training context, training result buffer, or prediction result buffer to free. - - - Get information about a hooked classification object event. - Specifies the classification object event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hooked classification object event. - Specifies the classification object event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hooked classification object event. - Specifies the classification object event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hooked classification object event. - Specifies the classification object event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hooked classification object event. - Specifies the classification object event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hooked classification object event. - Specifies the classification object event identifier received by the hook-handler function. - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results from a classification result buffer. - Specifies the identifier of the classification result buffer from which to retrieve results. - Specifies what to retrieve. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Hook a function to an event that occurs using classification objects. - Specifies the identifier of the classification object (classifier context or training context) onto which to attach a hook handler. - Specifies the event type. - Specifies the address of the function that should be called when an event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Import data from a CSV file to a dataset context. - Specifies the name and path of the file from which to import. - Specifies the format of the file from which to import. - Specifies the identifier of the dataset context in which to import. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the type of import operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a classifier context, a dataset context, a training context, class definitions, or the source layer of a predefined CNN. - Specifies the identifier of the classification context about which to inquire. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an entry in a dataset context. - Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc with M_DATASET_IMAGES or M_DATASET_FEATURES. - Specifies the index of the entry about which to inquire. - Specifies the key (MIL_UUID) of the entry about which to inquire. - Specifies which region in an entry to inquire. - Specifies the type of inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Predict the class to which the target belongs. - Specifies the identifier of the trained classifier context to use for the prediction operation. - Specifies the identifier of the target to classify. - Specifies the identifier of the result buffer or dataset in which to write the results of the prediction operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Preprocess a classification context. - Specifies the identifier of the classification context to preprocess. - Specifies whether to preprocess the classification context. - - - Restore a classification context (classifier, training, or dataset) from disk. - Specifies the name and path of the file from which to restore the classification context (classifier, training, or dataset). - Specifies the identifier of the system on which to restore the classification context (classifier, training, or dataset) to disk. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the classification context identifier. - The returned value is the classification context identifier. If this fails, M_NULL is returned. - - - Save a MIL Classification context (classifier, training, or dataset) to a file. - Specifies the name and path of the file in which to save the classification context (that is, a classifier context, a training context, or a dataset context). - Specifies the identifier of the classification context to save (that is, a classifier context, a training context, or a dataset context). - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a MIL Classification context (classifier, training, or dataset) to a file. - Specifies the name and path of the file in which to save the classification context (that is, a classifier context, a training context, or a dataset context). - Specifies the identifier of the classification context to save (that is, a classifier context, a training context, or a dataset context). - Reserved for future expansion and must be set to M_DEFAULT . - - - Split the source dataset context into two destination dataset contexts. - Specifies the predefined split classification context. - Specifies the identifier of the source dataset context. - Specifies the identifier of the first destination dataset context. - Specifies the identifier of the second destination dataset context. - Specifies the percentage of entries in the source dataset context that should be in the first destination dataset context. - Reserved for future expansion and must be set to M_NULL . - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a MIL Classification context (classifier, training, or dataset) from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the classification context. - Specifies the operation to perform on the classification context. - Specifies the type of stream in which to store/from which to restore the classification context. - Specifies the MIL version of the classification context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the classification context (that is, a classifier context, a training context, or a dataset context). - Specifies the address of the variable in which to write the size of the classification context, in bytes. - - - Load, restore, or save a MIL Classification context (classifier, training, or dataset) from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the classification context. - Specifies the operation to perform on the classification context. - Specifies the type of stream in which to store/from which to restore the classification context. - Specifies the MIL version of the classification context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the classification context (that is, a classifier context, a training context, or a dataset context). - Specifies the address of the variable in which to write the size of the classification context, in bytes. - - - Load, restore, or save a MIL Classification context (classifier, training, or dataset) from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the classification context. - Specifies the operation to perform on the classification context. - Specifies the type of stream in which to store/from which to restore the classification context. - Specifies the MIL version of the classification context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the classification context (that is, a classifier context, a training context, or a dataset context). - Specifies the address of the variable in which to write the size of the classification context, in bytes. - - - Load, restore, or save a MIL Classification context (classifier, training, or dataset) from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the classification context. - Specifies the operation to perform on the classification context. - Specifies the type of stream in which to store/from which to restore the classification context. - Specifies the MIL version of the classification context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the classification context (that is, a classifier context, a training context, or a dataset context). - Specifies the address of the variable in which to write the size of the classification context, in bytes. - - - Load, restore, or save a MIL Classification context (classifier, training, or dataset) from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the classification context. - Specifies the operation to perform on the classification context. - Specifies the type of stream in which to store/from which to restore the classification context. - Specifies the MIL version of the classification context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the classification context (that is, a classifier context, a training context, or a dataset context). - Specifies the address of the variable in which to write the size of the classification context, in bytes. - - - Load, restore, or save a MIL Classification context (classifier, training, or dataset) from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the classification context. - Specifies the operation to perform on the classification context. - Specifies the type of stream in which to store/from which to restore the classification context. - Specifies the MIL version of the classification context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the classification context (that is, a classifier context, a training context, or a dataset context). - Specifies the address of the variable in which to write the size of the classification context, in bytes. - - - Train a classifier context. - Specifies the identifier of the training context with which to train the classifier context. - Specifies the identifier of the classifier context to train. - Specifies the identifier of the training dataset context with which to train the classifier context. This parameter cannot be null. - Specifies the identifier of the development dataset with which to evaluate the performance of the classifier context's training. - Specifies the identifier of the classification result buffer in which to write the results of the training operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate a code context. - Specifies the system on which to allocate the context. - Specifies the context type. - Specifies the initial configuration for the code context. - Specifies the address in which to return the identifier of the code context. - The returned value is the code context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a code context. - Specifies the system on which to allocate the context. - Specifies the context type. - Specifies the initial configuration for the code context. - Specifies the address in which to return the identifier of the code context. - The returned value is the code context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a code result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. This parameter must be set to one of the following: - Specifies the address of the variable in which to write the code result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a code result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. This parameter must be set to one of the following: - Specifies the address of the variable in which to write the code result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a code context, code model, or code result buffer setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting to change. - Specifies the setting's new value. - - - Control a code context, code model, or code result buffer setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting to change. - Specifies the setting's new value. - - - Detect 1D code occurrences in an image. - Specifies the identifier of an image buffer that contains the code occurrences to detect. The image buffer must be an 8-bit unsigned 1-band buffer. - Specifies the size of the array passed to CodeTypeArrayPtr. - Specifies the address of an array listing the possible code types to detect in the image. - Specifies the total number of code occurrences to detect in the image, regardless of their code type. - Specifies the timeout period, in msec. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the code detect result buffer in which to write the results. The result buffer must have been allocated using McodeAllocResult with M_CODE_DETECT_RESULT. - - - Detect 1D code occurrences in an image. - Specifies the identifier of an image buffer that contains the code occurrences to detect. The image buffer must be an 8-bit unsigned 1-band buffer. - Specifies the size of the array passed to CodeTypeArrayPtr. - Specifies the address of an array listing the possible code types to detect in the image. - Specifies the total number of code occurrences to detect in the image, regardless of their code type. - Specifies the timeout period, in msec. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the code detect result buffer in which to write the results. The result buffer must have been allocated using McodeAllocResult with M_CODE_DETECT_RESULT. - - - Detect 1D code occurrences in an image. - Specifies the identifier of an image buffer that contains the code occurrences to detect. The image buffer must be an 8-bit unsigned 1-band buffer. - Specifies the size of the array passed to CodeTypeArrayPtr. - Specifies the address of an array listing the possible code types to detect in the image. - Specifies the total number of code occurrences to detect in the image, regardless of their code type. - Specifies the timeout period, in msec. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the code detect result buffer in which to write the results. The result buffer must have been allocated using McodeAllocResult with M_CODE_DETECT_RESULT. - - - Draw specific features of results obtained from an McodeRead, McodeGrade, or McodeDetect operation. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the identifier of the code read, grade, or detect result buffer from which to extract features to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw specific features of results. - Specifies the type of drawing operation to perform. - Specifies the code occurrence for which to draw results. - Specifies the scan line(s) for which to draw results. - Specifies the function's control flag. Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Free a code context or a code result buffer. - Specifies the identifier of the code context or code result buffer to free. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain operation, for the specified code model(s), from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence(s) or code model(s) for which to retrieve results. - Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Grade the code occurrence(s) in an image. - Specifies the identifier of the code context, allocated using McodeAlloc. - Specifies the identifier of the image buffer containing the code occurrence(s) to be graded. - Specifies a source code result buffer from which to retrieve McodeRead results. The result buffer must have previously been allocated using McodeAllocResult with M_DEFAULT. - Specifies the index of the code model (in the code context) or the result occurrence (in the source code result buffer) to use when grading. - Specifies the result buffer in which to write the resulting grading information. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a code context, code model, or code result setting. - Specifies the identifier of the code context, code model, or code result buffer. - Specifies the setting about which to inquire. - Specifies the address in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Add, find, or delete a code model within a code context. - Specifies the code context in which to add, find, or delete the code model. - Specifies the operation to perform within the specified code context. - Specifies the code type of the code model to add or find from the code context. Note that if the Operation parameter is set to M_DELETE, set this parameter to M_NULL . - Specifies the instance of the code model to find in the context. Note that if the Operation parameter is set to M_ADD or M_DELETE, set this parameter to M_NULL . - Specifies the function's control flag. Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address in which to return the code model identifier for M_ADD and M_FIND operations. For a M_DELETE operation, ModelCodeIdPtr specifies the identifier of the model to be deleted. - The returned value is the identifier of the code model for a successful M_ADD operation; if the model could not be added, M_NULL is returned. The returned value is the identifier of the code model for a successful M_FIND operation; M_NULL is returned if no code model is found. The returned value is M_NULL for an M_DELETE operation. - - - Add, find, or delete a code model within a code context. - Specifies the code context in which to add, find, or delete the code model. - Specifies the operation to perform within the specified code context. - Specifies the code type of the code model to add or find from the code context. Note that if the Operation parameter is set to M_DELETE, set this parameter to M_NULL . - Specifies the instance of the code model to find in the context. Note that if the Operation parameter is set to M_ADD or M_DELETE, set this parameter to M_NULL . - Specifies the function's control flag. Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address in which to return the code model identifier for M_ADD and M_FIND operations. For a M_DELETE operation, ModelCodeIdPtr specifies the identifier of the model to be deleted. - The returned value is the identifier of the code model for a successful M_ADD operation; if the model could not be added, M_NULL is returned. The returned value is the identifier of the code model for a successful M_FIND operation; M_NULL is returned if no code model is found. The returned value is M_NULL for an M_DELETE operation. - - - Read the code occurrence(s) in an image. - Specifies the identifier of the code context. - Specifies the 8-bit unsigned 1-band image buffer in which to search. - Specifies the result buffer in which to write the results of the read. - - - Restore a code context from disk. - Specifies the path and name of the file from which to restore the code context (for example, "C:\mydirectory\myfile"). - Specifies the system on which to allocate the context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to return the identifier of the code context. - The returned value is the code context identifier. If allocation fails, M_NULL is returned. - - - Restore a code context from disk. - Specifies the path and name of the file from which to restore the code context (for example, "C:\mydirectory\myfile"). - Specifies the system on which to allocate the context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to return the identifier of the code context. - The returned value is the code context identifier. If allocation fails, M_NULL is returned. - - - Save the specified code context in a file. - Specifies the name and path of the file in which to save the code context. - Specifies the identifier of the data buffer to save. - Specifies the function's control flag. - - - Save the specified code context in a file. - Specifies the name and path of the file in which to save the code context. - Specifies the identifier of the data buffer to save. - Specifies the function's control flag. - - - Load, restore, or save a code context from/to a file or a memory stream, or save a gradingreport to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the code context. - Specifies the operation to perform on the code context. - Specifies the type of stream in which to store/from which to restore the code context. - Specifies the MIL version of the code context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the code context. In the case of an M_SAVE_REPORT operation, this parameter specifies the address of the variable from which to read the identifier of the code result buffer. - Specifies the address of the variable in which to write the size of the code context, in bytes. - - - Load, restore, or save a code context from/to a file or a memory stream, or save a gradingreport to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the code context. - Specifies the operation to perform on the code context. - Specifies the type of stream in which to store/from which to restore the code context. - Specifies the MIL version of the code context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the code context. In the case of an M_SAVE_REPORT operation, this parameter specifies the address of the variable from which to read the identifier of the code result buffer. - Specifies the address of the variable in which to write the size of the code context, in bytes. - - - Load, restore, or save a code context from/to a file or a memory stream, or save a gradingreport to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the code context. - Specifies the operation to perform on the code context. - Specifies the type of stream in which to store/from which to restore the code context. - Specifies the MIL version of the code context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the code context. In the case of an M_SAVE_REPORT operation, this parameter specifies the address of the variable from which to read the identifier of the code result buffer. - Specifies the address of the variable in which to write the size of the code context, in bytes. - - - Load, restore, or save a code context from/to a file or a memory stream, or save a gradingreport to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the code context. - Specifies the operation to perform on the code context. - Specifies the type of stream in which to store/from which to restore the code context. - Specifies the MIL version of the code context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the code context. In the case of an M_SAVE_REPORT operation, this parameter specifies the address of the variable from which to read the identifier of the code result buffer. - Specifies the address of the variable in which to write the size of the code context, in bytes. - - - Load, restore, or save a code context from/to a file or a memory stream, or save a gradingreport to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the code context. - Specifies the operation to perform on the code context. - Specifies the type of stream in which to store/from which to restore the code context. - Specifies the MIL version of the code context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the code context. In the case of an M_SAVE_REPORT operation, this parameter specifies the address of the variable from which to read the identifier of the code result buffer. - Specifies the address of the variable in which to write the size of the code context, in bytes. - - - Load, restore, or save a code context from/to a file or a memory stream, or save a gradingreport to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the code context. - Specifies the operation to perform on the code context. - Specifies the type of stream in which to store/from which to restore the code context. - Specifies the MIL version of the code context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the code context. In the case of an M_SAVE_REPORT operation, this parameter specifies the address of the variable from which to read the identifier of the code result buffer. - Specifies the address of the variable in which to write the size of the code context, in bytes. - - - Train the control type settings of a code context and its code models so that they are optimized for the specified set of sample images. - Specifies the identifier of the code context to train. - Specifies the number of training images passed to ImageArrayPtr. - Specifies the address of the array containing the buffer identifiers of the training images. The image buffers must be 1-band, 8-bit unsigned buffers. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the train result buffer identifier. The result buffer must have been allocated using McodeAllocResult with M_CODE_TRAIN_RESULT. - - - Train the control type settings of a code context and its code models so that they are optimized for the specified set of sample images. - Specifies the identifier of the code context to train. - Specifies the number of training images passed to ImageArrayPtr. - Specifies the address of the array containing the buffer identifiers of the training images. The image buffers must be 1-band, 8-bit unsigned buffers. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the train result buffer identifier. The result buffer must have been allocated using McodeAllocResult with M_CODE_TRAIN_RESULT. - - - Encode an ASCII string into a symbol. - Specifies the identifier of the code model. - Specifies the 8-bit unsigned 1-band image buffer in which to write the symbol. - Specifies the address of the string to be encoded. - Specifies the function's control flag. - Specifies the identifier of the code write result buffer. The result buffer must have been allocated using McodeAllocResult with M_CODE_WRITE_RESULT. - - - Allocate a color matching context or a relative color calibration context. - Specifies the system on which to allocate the context. - Specifies the type of context. - Specifies the source color space of the context. In general, all color data required for the color operation should be the same as the source color space. For example, if you specify an M_RGB source color space, color-samples ( McolDefine) and target or source images ( McolMatch or McolTransform) should also typically be RGB. - Specifies the context's color space profile. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the context identifier. - The returned value is the context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a color matching context or a relative color calibration context. - Specifies the system on which to allocate the context. - Specifies the type of context. - Specifies the source color space of the context. In general, all color data required for the color operation should be the same as the source color space. For example, if you specify an M_RGB source color space, color-samples ( McolDefine) and target or source images ( McolMatch or McolTransform) should also typically be RGB. - Specifies the context's color space profile. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the context identifier. - The returned value is the context's identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a color matching result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the color matching result identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a color matching result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the color matching result identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a color matching context, its color-samples, or the color-samples of a relative color calibration context. - Specifies the identifier of the color matching or relative color calibration context. - Specifies what to control. - Specifies the setting to change. - Specifies the setting's new value. - - - Control a color matching context, its color-samples, or the color-samples of a relative color calibration context. - Specifies the identifier of the color matching or relative color calibration context. - Specifies what to control. - Specifies the setting to change. - Specifies the setting's new value. - - - Define or delete a color-sample or color element. - Specifies the identifier of the context in which to add or delete a color-sample. - Specifies the identifier of the source image buffer to use to define or add elements to a color-sample. If you are defining or adding elements to a color-sample from three explicit color component values, or if you are deleting color-samples or color elements, set this parameter to M_NULL . - Specifies a color-sample. - Specifies the type of the color-sample or color element. - Specifies an attribute of the color-sample or color element. - Specifies an attribute of the color-sample or color element. - Specifies an attribute of the color-sample or color element. - Specifies an attribute of the color-sample or color element. - - - Calculate the distance between colors. - Specifies the identifier of the first source image buffer. - Specifies the identifier of the second source buffer, which can be either an image or a MIL array buffer. - Specifies the identifier of the destination image buffer in which to write the results of the distance calculation. - Specifies the identifier of the image buffer used to identify the masked (non-zero) pixels. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the type of distance operation to perform. - Specifies the factor with which to normalize the resulting distances. - Reserved for future expansion and must be set to M_DEFAULT . - - - Draw specific features of a color-sample, color element, or color matching result. - Specifies the identifier of the 2D graphics context to use when drawing. Set this parameter to one of the following values: - Specifies the context or result buffer for which to perform the drawing operation. - Specifies the identifier of the destination image buffer in which to draw. - Specifies the type of drawing operation to perform. - Specifies the label of the target area for which to perform the drawing operation, for color matching contexts. - Specifies the color-sample or color element therein for which to perform the drawing operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a color matching context, a relative color calibration context, or a color matching result buffer. - Specifies the identifier of the context or result buffer to free. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a color matching result buffer. - Specifies the identifier of the color matching result buffer from which to get results. - Specifies the label of the target area(s) for which to get results. - Specifies the color-sample(s) for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Inquire information about a color matching or relative color calibration context, color-sample, color element, or a color matching result. - Specifies the identifier of the context or result buffer about which to inquire information. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a color matching or relative color calibration context, color-sample, color element, or a color matching result. - Specifies the identifier of the context or result buffer about which to inquire information. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a color matching or relative color calibration context, color-sample, color element, or a color matching result. - Specifies the identifier of the context or result buffer about which to inquire information. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a color matching or relative color calibration context, color-sample, color element, or a color matching result. - Specifies the identifier of the context or result buffer about which to inquire information. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a color matching or relative color calibration context, color-sample, color element, or a color matching result. - Specifies the identifier of the context or result buffer about which to inquire information. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a color matching or relative color calibration context, color-sample, color element, or a color matching result. - Specifies the identifier of the context or result buffer about which to inquire information. - Specifies what to inquire. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Mask regions of a color element in a specified color-sample. - Specifies the context in which the color-sample containing the color element to be masked is located. - Specifies the color element for which to create a mask. - Specifies the identifier of the buffer to use to identify the masked (non-zero) pixels in the color element. - Specifies the type of mask to employ. - Reserved for future expansion and must be set to M_DEFAULT . - - - Match target areas with color-samples. - Specifies the identifier of the color matching context. - Specifies the identifier of the target image buffer with which to match the color-samples. - Specifies the identifier of the target image's reference color space. - Specifies the identifier of the image buffer containing the target area labels. - Specifies the identifier of the image buffer or result buffer in which to write the results of the color matching operation. - Specifies the results to produce. - - - Preprocess a relative color calibration or color matching context. - Specifies the identifier of the context to preprocess. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Perform a color projection. - Specifies the identifier of the source image buffer on which to perform the projection transformation. - Specifies the identifier of an image buffer or MIL array buffer that controls how the source pixels are interpreted. - Specifies the identifier of the destination buffer in which to write the color projection (transformation) results. - Specifies the identifier of the destination mask image. - Specifies the color projection operation. - Specifies the dynamic range on which the resulting projection is mapped. - Specifies the address of the variable in which to write the status of the color projection operation. - - - Perform a color projection. - Specifies the identifier of the source image buffer on which to perform the projection transformation. - Specifies the identifier of an image buffer or MIL array buffer that controls how the source pixels are interpreted. - Specifies the identifier of the destination buffer in which to write the color projection (transformation) results. - Specifies the identifier of the destination mask image. - Specifies the color projection operation. - Specifies the dynamic range on which the resulting projection is mapped. - Specifies the address of the variable in which to write the status of the color projection operation. - - - Restore a color matching or relative color calibration context from disk. - Specifies the name and path of the file from which to restore the context. - Specifies the system on which to restore the context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the context identifier. - The returned value is the context identifier. If allocation fails, M_NULL is returned. - - - Restore a color matching or relative color calibration context from disk. - Specifies the name and path of the file from which to restore the context. - Specifies the system on which to restore the context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the context identifier. - The returned value is the context identifier. If allocation fails, M_NULL is returned. - - - Save a color matching or relative color calibration context to a file. - Specifies the name and path of the file in which to save the context. - Specifies the identifier of the context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a color matching or relative color calibration context to a file. - Specifies the name and path of the file in which to save the context. - Specifies the identifier of the context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Set the color matching or relative color calibration strategy. - Specifies the identifier of the color matching or relative color calibration context. - Specifies the operation. - Specifies the type of distance (for color matching) or color calibration intent (for relative color calibration) that the operation uses. - Specifies the conversion mode (for color matching) or compute option (for relative color calibration) that the operation uses. - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a MIL color matching or relative color calibration context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the context. - Specifies the MIL version of the context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the context. - Specifies the address of the variable in which to write the size of the context, in bytes. - - - Load, restore, or save a MIL color matching or relative color calibration context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the context. - Specifies the MIL version of the context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the context. - Specifies the address of the variable in which to write the size of the context, in bytes. - - - Load, restore, or save a MIL color matching or relative color calibration context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the context. - Specifies the MIL version of the context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the context. - Specifies the address of the variable in which to write the size of the context, in bytes. - - - Load, restore, or save a MIL color matching or relative color calibration context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the context. - Specifies the MIL version of the context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the context. - Specifies the address of the variable in which to write the size of the context, in bytes. - - - Load, restore, or save a MIL color matching or relative color calibration context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the context. - Specifies the MIL version of the context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the context. - Specifies the address of the variable in which to write the size of the context, in bytes. - - - Load, restore, or save a MIL color matching or relative color calibration context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the context. - Specifies the MIL version of the context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the context. - Specifies the address of the variable in which to write the size of the context, in bytes. - - - Transform color data using relative color calibration. - Specifies the identifier of the relative color calibration context containing the color-sample and its associated mapping. - Specifies the index or label of a color-sample in the specified relative color calibration context. - Specifies the identifier of the source image with which to perform the relative color calibration. - Specifies the identifier of destination image in which to write the transformed color. - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate an Industrial Communication context. - Specifies the system on which to allocate the Industrial Communication context. - Specifies the type of protocol to use. - Specifies the description of the device with which to communicate. - Specifies how to initialize the Industrial Communication context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address in which to return the identifier of the Industrial Communication context. Since McomAlloc also returns the identifier, you can set this parameter to M_NULL . - The returned value is the Industrial Communication context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an Industrial Communication context. - Specifies the system on which to allocate the Industrial Communication context. - Specifies the type of protocol to use. - Specifies the description of the device with which to communicate. - Specifies how to initialize the Industrial Communication context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address in which to return the identifier of the Industrial Communication context. Since McomAlloc also returns the identifier, you can set this parameter to M_NULL . - The returned value is the Industrial Communication context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the Industrial Communication setting to control. - Specifies the setting's new value. - - - Control an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the Industrial Communication setting to control. - Specifies the setting's new value. - - - Control an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the Industrial Communication setting to control. - Specifies the setting's new value. - - - Free an Industrial Communication context. - Specifies the identifier of the Industrial Communication context. - - - Inquire about an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the setting about which to inquire. - Specifies the address of the variable in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the setting about which to inquire. - Specifies the address of the variable in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the setting about which to inquire. - Specifies the address of the variable in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the setting about which to inquire. - Specifies the address of the variable in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Industrial Communication context setting. - Specifies the identifier of the Industrial Communication context. - Specifies the setting about which to inquire. - Specifies the address of the variable in which to return the value of the inquired setting. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Read data from a device that uses the specified communication protocol. - Specifies the identifier of the Industrial Communication context that specifies the protocol of the device with which to communicate. - Specifies the location from which to read the data. This location is protocol specific. - Specifies the offset from which to start reading the data in the specified module/data table/assembly. - Specifies the amount of the data to read. - Specifies the address of the array in which to write the data. - - - Read data from a device that uses the specified communication protocol. - Specifies the identifier of the Industrial Communication context that specifies the protocol of the device with which to communicate. - Specifies the location from which to read the data. This location is protocol specific. - Specifies the offset from which to start reading the data in the specified module/data table/assembly. - Specifies the amount of the data to read. - Specifies the address of the array in which to write the data. - - - Sends a position to the robot. This does not move the robot, but simply sends a found position to the robot controller. - Specifies the identifier of the Industrial Communication context. - Specifies the operation code (opcode) of the command. - Specifies the status code to send to the robot controller. - Specifies the user identifier associated with the object at the specified position. - Specifies the X-position to the robot controller. - Specifies the Y-position to the robot controller. - Specifies the Z-position to the robot controller. - Specifies the rotation around the positional X-axis to the robot controller. - Specifies the rotation around the positional Y-axis to the robot controller. - Specifies the rotation around the positional Z-axis to the robot controller. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - - - Waits to receive a robot's request for a new position. - Specifies the identifier of the Industrial Communication context. - Specifies the address of the variable in which to write the operation code (opcode) received from the robot controller. - Specifies the address of the variable in which to write the status code received from the robot controller. - Specifies the address of the variable in which to write the user identifier associated with the object on which to perform the specified operation; the identifier is established and received from the robot-side software. - Specifies the address of the variable in which to write the current X-position of the robot. - Specifies the address of the variable in which to write the current Y-position of the robot. - Specifies the address of the variable in which to write the current Z-position of the robot. - Specifies the address of the variable in which to write the rotation around the positional X-axis of the robot. - Specifies the address of the variable in which to write the rotation around the positional Y-axis of the robot. - Specifies the address of the variable in which to write the rotation around the positional Z-axis of the robot. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - - - Write data to a device that uses the specified communication protocol. - Specifies the identifier of the Industrial Communication context that specifies the protocol of the device with which to communicate. - Specifies the location in which to write the data. This location is protocol specific. - Specifies the offset from which to start writing the data in the specified module/data table/assembly. - Specifies the size of the data to be written, in bytes. - Specifies the address of the array containing the data. - - - Write data to a device that uses the specified communication protocol. - Specifies the identifier of the Industrial Communication context that specifies the protocol of the device with which to communicate. - Specifies the location in which to write the data. This location is protocol specific. - Specifies the offset from which to start writing the data in the specified module/data table/assembly. - Specifies the size of the data to be written, in bytes. - Specifies the address of the array containing the data. - - - Allocate a digitizer. - Specifies the identifier of the system on which to allocate the digitizer. - Specifies the number or string to identify the device to allocate for the digitizer. - Specifies the name of the digitizer configuration format (DCF) appropriate for your camera. - Specifies the type of initialization to perform on the digitizer. - Specifies the address of the variable in which to write the digitizer identifier. - The returned value is the digitizer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a digitizer. - Specifies the identifier of the system on which to allocate the digitizer. - Specifies the number or string to identify the device to allocate for the digitizer. - Specifies the name of the digitizer configuration format (DCF) appropriate for your camera. - Specifies the type of initialization to perform on the digitizer. - Specifies the address of the variable in which to write the digitizer identifier. - The returned value is the digitizer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a digitizer. - Specifies the identifier of the system on which to allocate the digitizer. - Specifies the number or string to identify the device to allocate for the digitizer. - Specifies the name of the digitizer configuration format (DCF) appropriate for your camera. - Specifies the type of initialization to perform on the digitizer. - Specifies the address of the variable in which to write the digitizer identifier. - The returned value is the digitizer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a digitizer. - Specifies the identifier of the system on which to allocate the digitizer. - Specifies the number or string to identify the device to allocate for the digitizer. - Specifies the name of the digitizer configuration format (DCF) appropriate for your camera. - Specifies the type of initialization to perform on the digitizer. - Specifies the address of the variable in which to write the digitizer identifier. - The returned value is the digitizer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to control. - Specifies the value to assign to the digitizer setting. - - - Control a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to control. - Specifies the value to assign to the digitizer setting. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Controls a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to control. - Specifies the type of information to control for the specified feature. - Specifies the name of the camera feature to control. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to write the value of the feature. - - - Adjust a camera's lens motor to a position that produces optimum focus, or only calculate the focus quality of a specified image or an image grabbed at the current lens motor position. - Specifies the identifier of the digitizer. - Specifies the identifier of the buffer that contains the image to analyze or in which to grab. - Specifies the identifier of a child buffer of the destination buffer. - Specifies the address of the user-defined function to call before each grab. - Specifies the address of the data that you want to make available to the user-defined function. When only calculating the focus indicator (that is, using the M_EVALUATE operation mode), this parameter is not used, and must be set to M_NULL. - Specifies the minimum focus position of the search. - Specifies the starting focus position of the search. - Specifies the maximum focus position of the search. - Specifies the positional increment to use in the search. - Specifies the operation mode used by this function. - Specifies the address in which to return the resulting value from the focusing operation. - - - Free a digitizer. - Specifies the identifier of the digitizer. - - - Get information about a digitizer hook event. - Specifies the digitizer event identifier received by the hook-handler function (see MdigProcess and MdigHookFunction). - Specifies the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a digitizer hook event. - Specifies the digitizer event identifier received by the hook-handler function (see MdigProcess and MdigHookFunction). - Specifies the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a digitizer hook event. - Specifies the digitizer event identifier received by the hook-handler function (see MdigProcess and MdigHookFunction). - Specifies the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a digitizer hook event. - Specifies the digitizer event identifier received by the hook-handler function (see MdigProcess and MdigHookFunction). - Specifies the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Grab data from a camera into a buffer or container. - Specifies the identifier of the digitizer. - Specifies the identifier of the destination image buffer or container. - - - Grab data continuously from a camera. - Specifies the identifier of the digitizer. - Specifies the identifier of the destination image buffer or container. - - - Wait for the end of the grab in progress. - Specifies the identifier of the digitizer. - Specifies the function's control flag. - - - Halt a continuous grab from an input device. - Specifies the identifier of the digitizer. - - - Hook a function to a digitizer event. - Specifies the identifier of the digitizer. - Specifies the digitizer event to which to hook the function. - Specifies the address of the function that should be called when the specified event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Inquire about a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a digitizer setting. - Specifies the identifier of the digitizer. - Specifies the digitizer setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquires a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to inquire. - Specifies the data type of the variable in which to return the requested information (pointed to by the UserVarPtr parameter). - Specifies the name of the camera feature to inquire. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to return the requested information. - - - Inquires a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to inquire. - Specifies the data type of the variable in which to return the requested information (pointed to by the UserVarPtr parameter). - Specifies the name of the camera feature to inquire. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to return the requested information. - - - Inquires a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to inquire. - Specifies the data type of the variable in which to return the requested information (pointed to by the UserVarPtr parameter). - Specifies the name of the camera feature to inquire. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to return the requested information. - - - Inquires a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to inquire. - Specifies the data type of the variable in which to return the requested information (pointed to by the UserVarPtr parameter). - Specifies the name of the camera feature to inquire. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to return the requested information. - - - Inquires a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to inquire. - Specifies the data type of the variable in which to return the requested information (pointed to by the UserVarPtr parameter). - Specifies the name of the camera feature to inquire. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to return the requested information. - - - Inquires a feature of the camera. - Specifies the identifier of the digitizer accessing the camera to inquire. - Specifies the data type of the variable in which to return the requested information (pointed to by the UserVarPtr parameter). - Specifies the name of the camera feature to inquire. - Specifies the data type of the address pointed to by the UserVarPtr parameter. - Specifies the address of the variable in which to return the requested information. - - - Grab frames of data sequentially into a list of image buffers or containers, and process them with a user-defined function as they are grabbed. - Specifies the identifier of the digitizer to be used to perform the grabs. - Specifies the address of the array containing the identifiers of the image buffers or containers in which to place the grabbed frames of data. Image buffers should be of an appropriate type and depth to hold the grabbed frames of data. - Specifies the number of buffers or containers in the array. - Specifies the type of operation to perform. - Specifies more information about the synchronization and triggering of the grab. - Specifies the address of the function that is called when a buffer/container is modified in the array of destination image buffers/containers. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Grab frames of data sequentially into a list of image buffers or containers, and process them with a user-defined function as they are grabbed. - Specifies the identifier of the digitizer to be used to perform the grabs. - Specifies the address of the array containing the identifiers of the image buffers or containers in which to place the grabbed frames of data. Image buffers should be of an appropriate type and depth to hold the grabbed frames of data. - Specifies the number of buffers or containers in the array. - Specifies the type of operation to perform. - Specifies more information about the synchronization and triggering of the grab. - Specifies the address of the function that is called when a buffer/container is modified in the array of destination image buffers/containers. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Allocate a display. - Specifies the system on which to allocate the display. - Specifies the device to use for image display. - Specifies the format of the display. - Specifies your display's type. - Specifies the address of the variable in which to write the display identifier. - The returned value is the display identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a display. - Specifies the system on which to allocate the display. - Specifies the device to use for image display. - Specifies the format of the display. - Specifies your display's type. - Specifies the address of the variable in which to write the display identifier. - The returned value is the display identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a MIL display setting. - Specifies the identifier of the target display. - Specifies the type of display setting to control. - Specifies the new value to assign to the display setting specified by the ControlType parameter. - - - Control a MIL display setting. - Specifies the identifier of the target display. - Specifies the type of display setting to control. - Specifies the new value to assign to the display setting specified by the ControlType parameter. - - - Free a display. - Specifies the identifier of the display. - - - Get information about a display hook event. - Specifies the display event identifier received by the hook-handler function (see MdispHookFunction). - Specifies the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a display hook event. - Specifies the display event identifier received by the hook-handler function (see MdispHookFunction). - Specifies the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Hook a function to a display event. - Specifies the identifier of the target display. - Specifies the display event type. - Specifies the address of the function that should be called when the specified event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Inquire about a display setting. - Specifies the identifier of the display. - Specifies the type of display setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a display setting. - Specifies the identifier of the display. - Specifies the type of display setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a display setting. - Specifies the identifier of the display. - Specifies the type of display setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a display setting. - Specifies the identifier of the display. - Specifies the type of display setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a display setting. - Specifies the identifier of the display. - Specifies the type of display setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Associate a LUT buffer with a display. - Specifies the identifier of the display with which to associate the LUT buffer. - Specifies a LUT buffer. - - - Pan (scroll) a display. - Specifies the identifier of the display. - Specifies the number of image pixels by which to pan an image buffer horizontally when it is displayed. - Specifies the number of image pixels by which to pan an image buffer vertically when it is displayed. - - - Select an image buffer to display. - Specifies the identifier of the display. - Specifies the identifier of the image buffer to display. - - - Select an image buffer to display in a user-defined window. - Specifies the identifier of the display. - Specifies the image buffer to display. - Specifies the window handle of the user-defined window or child window. - - - Zoom a display. - Specifies the identifier of the display. - Specifies the zoom factor for the X-direction of the display. - Specifies the zoom factor for the Y-direction of the display. - - - Allocate a SureDotOCR context. - Specifies the identifier of the system on which to allocate the SureDotOCR context. - Specifies the type of context to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the SureDotOCR context identifier. - The returned value is the SureDotOCR context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a SureDotOCR context. - Specifies the identifier of the system on which to allocate the SureDotOCR context. - Specifies the type of context to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the SureDotOCR context identifier. - The returned value is the SureDotOCR context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a SureDotOCR result buffer. - Specifies the identifier of the system on which to allocate the SureDotOCR result buffer. - Specifies the type of result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the SureDotOCR result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a SureDotOCR result buffer. - Specifies the identifier of the system on which to allocate the SureDotOCR result buffer. - Specifies the type of result buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the SureDotOCR result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a SureDotOCR context or result buffer. - Specifies the identifier of the SureDotOCR context or result buffer to control. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control a SureDotOCR context or result buffer. - Specifies the identifier of the SureDotOCR context or result buffer to control. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a font in a SureDotOCR context, or control a character in a font. - Specifies the identifier of the SureDotOCR context that contains the fonts to control. - Specifies the font (one or all) to control. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a SureDotOCR string model, or control a position (constraint) in a string model. - Specifies the identifier of the SureDotOCR context that contains the string model to control. - Specifies the string model (one or all) to control. - Specifies how to control the string model. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the second required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a SureDotOCR string model, or control a position (constraint) in a string model. - Specifies the identifier of the SureDotOCR context that contains the string model to control. - Specifies the string model (one or all) to control. - Specifies how to control the string model. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the second required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a SureDotOCR string model, or control a position (constraint) in a string model. - Specifies the identifier of the SureDotOCR context that contains the string model to control. - Specifies the string model (one or all) to control. - Specifies how to control the string model. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the second required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Control a global setting of a SureDotOCR string model, or control a position (constraint) in a string model. - Specifies the identifier of the SureDotOCR context that contains the string model to control. - Specifies the string model (one or all) to control. - Specifies how to control the string model. - Specifies the type of control to set. - Specifies the required value for the control. - Specifies the second required value for the control. - Specifies the address which contains more information about the setting's new value. - - - Draw specific features of a SureDotOCR result buffer. - Specifies the identifier of the 2D graphics context to use when drawing. Set this parameter to one of the values below. - Specifies the identifier of the SureDotOCR result buffer from which to extract the features to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the drawing operation to perform. - Specifies the string result (one or all) for which to perform the drawing operation. - Specifies the character (one or all) in the string result for which to perform the drawing operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Export a font from a SureDotOCR context. - Specifies the name and path of the SureDotOCR font file in which to export the font. - Specifies the format of the file in which to export the font. - Specifies the identifier of the SureDotOCR context from which to export the font. - Specifies the label or index of the font to export from the SureDotOCR context. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a SureDotOCR context or a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR context or SureDotOCR result buffer to free. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get results from a SureDotOCR result buffer. - Specifies the identifier of the SureDotOCR result buffer from which to retrieve results. - Specifies the string (one or all) for which to get results, or specifies to get global results. - Specifies the character (one or all) for which to get results, or specifies to get global or string results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Import characters from a font file into a new or existing font of a SureDotOCR context. - Specifies the name and path of the SureDotOCR font file (MDMRF) from which to import the font. - Specifies the format of the file from which to import the font. - Specifies the identifier of the SureDotOCR context to which you are importing the characters. - Specifies the label or index of an already existing font, or the addition of a new font. - Specifies the characters to import from the SureDotOCR font file. - Specifies how to handle importing characters that have the same name as characters already in the font. - - - Import characters from a font file into a new or existing font of a SureDotOCR context. - Specifies the name and path of the SureDotOCR font file (MDMRF) from which to import the font. - Specifies the format of the file from which to import the font. - Specifies the identifier of the SureDotOCR context to which you are importing the characters. - Specifies the label or index of an already existing font, or the addition of a new font. - Specifies the characters to import from the SureDotOCR font file. - Specifies how to handle importing characters that have the same name as characters already in the font. - - - Inquire about a SureDotOCR context or result buffer setting. - Specifies the identifier of the SureDotOCR context or result buffer about which to inquire. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a SureDotOCR context or result buffer setting. - Specifies the identifier of the SureDotOCR context or result buffer about which to inquire. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a SureDotOCR context or result buffer setting. - Specifies the identifier of the SureDotOCR context or result buffer about which to inquire. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a SureDotOCR context or result buffer setting. - Specifies the identifier of the SureDotOCR context or result buffer about which to inquire. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a font in a SureDotOCR context, or inquire about a character in a font. - Specifies the identifier of the SureDotOCR context that contains the font about which to inquire. - Specifies the font about which to inquire. - Specifies the index of a character in the font, if required. - Specifies the name of a character in the font, if required. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a SureDotOCR string model, or inquire about a position (constraint) in a string model. - Specifies the identifier of the SureDotOCR context that contains the string model about which to inquire. - Specifies the string model about which to inquire. - Specifies how to inquire about the string model. - Specifies the permitted character about which to inquire. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a SureDotOCR string model, or inquire about a position (constraint) in a string model. - Specifies the identifier of the SureDotOCR context that contains the string model about which to inquire. - Specifies the string model about which to inquire. - Specifies how to inquire about the string model. - Specifies the permitted character about which to inquire. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a SureDotOCR string model, or inquire about a position (constraint) in a string model. - Specifies the identifier of the SureDotOCR context that contains the string model about which to inquire. - Specifies the string model about which to inquire. - Specifies how to inquire about the string model. - Specifies the permitted character about which to inquire. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a global setting of a SureDotOCR string model, or inquire about a position (constraint) in a string model. - Specifies the identifier of the SureDotOCR context that contains the string model about which to inquire. - Specifies the string model about which to inquire. - Specifies how to inquire about the string model. - Specifies the permitted character about which to inquire. - Specifies the type of inquire to perform. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Perform name operations for fonts and string models. - Specifies the identifier of the SureDotOCR context containing the font or string model with which to perform the name operation. - Specifies the name operation to perform. - Specifies the label or index value of the font or string model with which to perform the name operation. - Specifies the name. - Specifies the address at which to write the information requested by the name operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform name operations for fonts and string models. - Specifies the identifier of the SureDotOCR context containing the font or string model with which to perform the name operation. - Specifies the name operation to perform. - Specifies the label or index value of the font or string model with which to perform the name operation. - Specifies the name. - Specifies the address at which to write the information requested by the name operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform name operations for fonts and string models. - Specifies the identifier of the SureDotOCR context containing the font or string model with which to perform the name operation. - Specifies the name operation to perform. - Specifies the label or index value of the font or string model with which to perform the name operation. - Specifies the name. - Specifies the address at which to write the information requested by the name operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform name operations for fonts and string models. - Specifies the identifier of the SureDotOCR context containing the font or string model with which to perform the name operation. - Specifies the name operation to perform. - Specifies the label or index value of the font or string model with which to perform the name operation. - Specifies the name. - Specifies the address at which to write the information requested by the name operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform name operations for fonts and string models. - Specifies the identifier of the SureDotOCR context containing the font or string model with which to perform the name operation. - Specifies the name operation to perform. - Specifies the label or index value of the font or string model with which to perform the name operation. - Specifies the name. - Specifies the address at which to write the information requested by the name operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Preprocess a SureDotOCR context. - Specifies the identifier of the SureDotOCR context to preprocess. - Specifies whether to preprocess the SureDotOCR context. - - - Read dot-matrix strings from a target image. - Specifies the identifier of the SureDotOCR context to use for the read operation. - Specifies the identifier of the target image buffer which contains the dot-matrix strings to read. - Specifies the identifier of the SureDotOCR result buffer in which to write the results of the read operation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Restore a SureDotOCR context from disk. - Specifies the name and path of the file from which to restore the SureDotOCR context. - Specifies the identifier of the system on which to restore the SureDotOCR context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the SureDotOCR context identifier. - The returned value is the SureDotOCR context identifier. If this fails, M_NULL is returned. - - - Save a SureDotOCR context to a file. - Specifies the name and path of the file in which to save the SureDotOCR context. - Specifies the identifier of the SureDotOCR context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a SureDotOCR context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the SureDotOCR context. - Specifies the operation to perform on the SureDotOCR context. - Specifies the type of stream in which to store/from which to restore the SureDotOCR context. - Specifies the MIL version of the SureDotOCR context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the SureDotOCR context. - Specifies the address of the variable in which to write the size of the SureDotOCR context, in bytes. - - - Load, restore, or save a SureDotOCR context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the SureDotOCR context. - Specifies the operation to perform on the SureDotOCR context. - Specifies the type of stream in which to store/from which to restore the SureDotOCR context. - Specifies the MIL version of the SureDotOCR context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the SureDotOCR context. - Specifies the address of the variable in which to write the size of the SureDotOCR context, in bytes. - - - Load, restore, or save a SureDotOCR context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the SureDotOCR context. - Specifies the operation to perform on the SureDotOCR context. - Specifies the type of stream in which to store/from which to restore the SureDotOCR context. - Specifies the MIL version of the SureDotOCR context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the SureDotOCR context. - Specifies the address of the variable in which to write the size of the SureDotOCR context, in bytes. - - - Load, restore, or save a SureDotOCR context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the SureDotOCR context. - Specifies the operation to perform on the SureDotOCR context. - Specifies the type of stream in which to store/from which to restore the SureDotOCR context. - Specifies the MIL version of the SureDotOCR context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the SureDotOCR context. - Specifies the address of the variable in which to write the size of the SureDotOCR context, in bytes. - - - Load, restore, or save a SureDotOCR context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the SureDotOCR context. - Specifies the operation to perform on the SureDotOCR context. - Specifies the type of stream in which to store/from which to restore the SureDotOCR context. - Specifies the MIL version of the SureDotOCR context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the SureDotOCR context. - Specifies the address of the variable in which to write the size of the SureDotOCR context, in bytes. - - - Load, restore, or save a SureDotOCR context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the identifier of the system on which to restore the SureDotOCR context. - Specifies the operation to perform on the SureDotOCR context. - Specifies the type of stream in which to store/from which to restore the SureDotOCR context. - Specifies the MIL version of the SureDotOCR context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the SureDotOCR context. - Specifies the address of the variable in which to write the size of the SureDotOCR context, in bytes. - - - Allocate an Edge Finder context. - Specifies the system on which to allocate the Edge Finder context. - Specifies the type of Edge Finder context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Edge Finder context identifier. - The returned value is the Edge Finder context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an Edge Finder context. - Specifies the system on which to allocate the Edge Finder context. - Specifies the type of Edge Finder context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Edge Finder context identifier. - The returned value is the Edge Finder context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an Edge Finder result buffer. - Specifies the system on which to allocate the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Edge Finder result buffer identifier. - The returned value is the result identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an Edge Finder result buffer. - Specifies the system on which to allocate the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Edge Finder result buffer identifier. - The returned value is the result identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Perform edge extraction and feature calculations. - Specifies the Edge Finder context to use for the extraction. - Specifies the source image buffer from which to extract edges. - Specifies the X-source derivative image buffer used to extract edges. - Specifies the Y-source derivative image buffer used to extract edges. - Specifies the source cross-derivative image buffer used to extract edges. - Specifies the Edge Finder result buffer in which to write the results of the extraction. - Specifies whether optimal performance during Edge Finder calculations is ensured. - - - Control an Edge Finder context or an Edge Finder result buffer setting. - Specifies either the Edge Finder context or the Edge Finder result buffer whose settings you want to modify. - Specifies the setting to change. - Specifies the setting's new value. - - - Control an Edge Finder context or an Edge Finder result buffer setting. - Specifies either the Edge Finder context or the Edge Finder result buffer whose settings you want to modify. - Specifies the setting to change. - Specifies the setting's new value. - - - Draw specific edge results in the destination image buffer or 2D graphics list. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the identifier of the Edge Finder result buffer from which to extract the results to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Specifies the edge(s) to draw. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free an Edge Finder context or an Edge Finder result buffer. - Specifies the identifier of the Edge Finder context or Edge Finder result buffer to free. - - - Get edgels from an Edge Finder result buffer that are the closest neighbors to a list of user-specified point coordinates. - Specifies the identifier of the Edge Finder result buffer from which to search for edgel candidates. - Specifies the number of points provided. - Specifies the address of the array containing the X-coordinate(s) of the source point(s). - Specifies the address of the array containing the Y-coordinate(s) of the source point(s). - Specifies the address of the array containing the constraint angle(s) used to refine the search for edgel candidates. - Specifies the address of the array in which the X-coordinate(s) of the edgel(s) found in the Edge Finder result buffer are to be written. - Specifies the address of the array in which the Y-coordinate(s) of the edgel(s) found in the Edge Finder result buffer is to be written. - Specifies the address of the array in which the index of the edgel(s) found in the Edge Finder result buffer is to be written. - Specifies the address of the array in which the label of the edgel's edge found in the Edge Finder result buffer is to be written. - Specifies the accuracy with which to return edgels. - - - Get edgels from an Edge Finder result buffer that are the closest neighbors to a list of user-specified point coordinates. - Specifies the identifier of the Edge Finder result buffer from which to search for edgel candidates. - Specifies the number of points provided. - Specifies the address of the array containing the X-coordinate(s) of the source point(s). - Specifies the address of the array containing the Y-coordinate(s) of the source point(s). - Specifies the address of the array containing the constraint angle(s) used to refine the search for edgel candidates. - Specifies the address of the array in which the X-coordinate(s) of the edgel(s) found in the Edge Finder result buffer are to be written. - Specifies the address of the array in which the Y-coordinate(s) of the edgel(s) found in the Edge Finder result buffer is to be written. - Specifies the address of the array in which the index of the edgel(s) found in the Edge Finder result buffer is to be written. - Specifies the address of the array in which the label of the edgel's edge found in the Edge Finder result buffer is to be written. - Specifies the accuracy with which to return edgels. - - - Get edgels from an Edge Finder result buffer that are the closest neighbors to a list of user-specified point coordinates. - Specifies the identifier of the Edge Finder result buffer from which to search for edgel candidates. - Specifies the number of points provided. - Specifies the address of the array containing the X-coordinate(s) of the source point(s). - Specifies the address of the array containing the Y-coordinate(s) of the source point(s). - Specifies the address of the array containing the constraint angle(s) used to refine the search for edgel candidates. - Specifies the address of the array in which the X-coordinate(s) of the edgel(s) found in the Edge Finder result buffer are to be written. - Specifies the address of the array in which the Y-coordinate(s) of the edgel(s) found in the Edge Finder result buffer is to be written. - Specifies the address of the array in which the index of the edgel(s) found in the Edge Finder result buffer is to be written. - Specifies the address of the array in which the label of the edgel's edge found in the Edge Finder result buffer is to be written. - Specifies the accuracy with which to return edgels. - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Get results of the included edges from an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer from which to get results. - Specifies the edge(s) from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. If nothing is to be written, set SecondResultArrayPtr to M_NULL . - - - Inquire about an Edge Finder context or an Edge Finder result buffer. - Specifies either the Edge Finder context or the Edge Finder result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Edge Finder context or an Edge Finder result buffer. - Specifies either the Edge Finder context or the Edge Finder result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Edge Finder context or an Edge Finder result buffer. - Specifies either the Edge Finder context or the Edge Finder result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an Edge Finder context or an Edge Finder result buffer. - Specifies either the Edge Finder context or the Edge Finder result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Mask regions of the Edge Finder context. - Specifies the Edge Finder context in which to set the mask. - Specifies the identifier of the image buffer used to identify the masked pixels in the Edge Finder context. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edge chains from user-supplied arrays into an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer in which to put user-supplied data. - Specifies the number of edgels to add to the Edge Finder result buffer. - Specifies the address of the array containing the indices of the edgels' edges to add to the Edge Finder result buffer. - Specifies the address of the array containing the X-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the Y-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the orientation of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the magnitude of the edgel(s) to add to the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edge chains from user-supplied arrays into an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer in which to put user-supplied data. - Specifies the number of edgels to add to the Edge Finder result buffer. - Specifies the address of the array containing the indices of the edgels' edges to add to the Edge Finder result buffer. - Specifies the address of the array containing the X-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the Y-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the orientation of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the magnitude of the edgel(s) to add to the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edge chains from user-supplied arrays into an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer in which to put user-supplied data. - Specifies the number of edgels to add to the Edge Finder result buffer. - Specifies the address of the array containing the indices of the edgels' edges to add to the Edge Finder result buffer. - Specifies the address of the array containing the X-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the Y-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the orientation of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the magnitude of the edgel(s) to add to the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edge chains from user-supplied arrays into an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer in which to put user-supplied data. - Specifies the number of edgels to add to the Edge Finder result buffer. - Specifies the address of the array containing the indices of the edgels' edges to add to the Edge Finder result buffer. - Specifies the address of the array containing the X-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the Y-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the orientation of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the magnitude of the edgel(s) to add to the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edge chains from user-supplied arrays into an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer in which to put user-supplied data. - Specifies the number of edgels to add to the Edge Finder result buffer. - Specifies the address of the array containing the indices of the edgels' edges to add to the Edge Finder result buffer. - Specifies the address of the array containing the X-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the Y-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the orientation of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the magnitude of the edgel(s) to add to the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edge chains from user-supplied arrays into an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer in which to put user-supplied data. - Specifies the number of edgels to add to the Edge Finder result buffer. - Specifies the address of the array containing the indices of the edgels' edges to add to the Edge Finder result buffer. - Specifies the address of the array containing the X-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the Y-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the orientation of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the magnitude of the edgel(s) to add to the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edge chains from user-supplied arrays into an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer in which to put user-supplied data. - Specifies the number of edgels to add to the Edge Finder result buffer. - Specifies the address of the array containing the indices of the edgels' edges to add to the Edge Finder result buffer. - Specifies the address of the array containing the X-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the Y-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the orientation of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the magnitude of the edgel(s) to add to the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edge chains from user-supplied arrays into an Edge Finder result buffer. - Specifies the identifier of the Edge Finder result buffer in which to put user-supplied data. - Specifies the number of edgels to add to the Edge Finder result buffer. - Specifies the address of the array containing the indices of the edgels' edges to add to the Edge Finder result buffer. - Specifies the address of the array containing the X-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the Y-coordinate(s) of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the orientation of the edgel(s) to add to the Edge Finder result buffer. - Specifies the address of the array containing the magnitude of the edgel(s) to add to the Edge Finder result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Restore an Edge Finder context from disk. - Specifies the name and path of the file from which to restore the Edge Finder context. - Specifies the system on which to restore the Edge Finder context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Edge Finder context identifier. - The returned value is the Edge Finder context identifier. If allocation fails, M_NULL is returned. - - - Restore an Edge Finder context from disk. - Specifies the name and path of the file from which to restore the Edge Finder context. - Specifies the system on which to restore the Edge Finder context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Edge Finder context identifier. - The returned value is the Edge Finder context identifier. If allocation fails, M_NULL is returned. - - - Save an Edge Finder context to a file, or save edge chains and/or edge approximations from an Edge Finder result buffer to a CAD (Computer-Aided Design) file. - Specifies the name and path of the file in which to save the Edge Finder context, or the destination CAD file. - Specifies either the identifier of the Edge Finder context to save, or the identifier of the Edge Finder result buffer from which to save to a CAD file. - Specifies whether to save edge chains or edge approximations to the DXF CAD file for Edge Finder result buffers. - - - Save an Edge Finder context to a file, or save edge chains and/or edge approximations from an Edge Finder result buffer to a CAD (Computer-Aided Design) file. - Specifies the name and path of the file in which to save the Edge Finder context, or the destination CAD file. - Specifies either the identifier of the Edge Finder context to save, or the identifier of the Edge Finder result buffer from which to save to a CAD file. - Specifies whether to save edge chains or edge approximations to the DXF CAD file for Edge Finder result buffers. - - - Select edges for calculations and result retrieval. - Specifies the identifier of the Edge Finder result buffer to be used in the edge selection process. - Specifies the operation to perform on the specified edges. - Specifies on what the selection criterion will be based. - Specifies the condition for the edge selection. - Specifies a value that is dependent on the feature and condition chosen. - Specifies a value that is dependent on the feature and condition chosen. - - - Load, restore, or save an Edge Finder context from/to a file or memory stream, or save calculated edges from an Edge Finder result buffer to a file or memory stream in CAD DXF format. - Specifies the file or memory stream. - Specifies the system on which to restore the Edge Finder context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the Edge Finder context or calculated edges. - Specifies the MIL version of the Edge Finder context. - Specifies the function's control flag. - Specifies the address of the variable in which to write or from which to read the identifier of the Edge Finder context or the Edge Finder result buffer. - Specifies the address of the variable in which to write the size of the Edge Finder context or calculated edges, in bytes. - - - Load, restore, or save an Edge Finder context from/to a file or memory stream, or save calculated edges from an Edge Finder result buffer to a file or memory stream in CAD DXF format. - Specifies the file or memory stream. - Specifies the system on which to restore the Edge Finder context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the Edge Finder context or calculated edges. - Specifies the MIL version of the Edge Finder context. - Specifies the function's control flag. - Specifies the address of the variable in which to write or from which to read the identifier of the Edge Finder context or the Edge Finder result buffer. - Specifies the address of the variable in which to write the size of the Edge Finder context or calculated edges, in bytes. - - - Load, restore, or save an Edge Finder context from/to a file or memory stream, or save calculated edges from an Edge Finder result buffer to a file or memory stream in CAD DXF format. - Specifies the file or memory stream. - Specifies the system on which to restore the Edge Finder context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the Edge Finder context or calculated edges. - Specifies the MIL version of the Edge Finder context. - Specifies the function's control flag. - Specifies the address of the variable in which to write or from which to read the identifier of the Edge Finder context or the Edge Finder result buffer. - Specifies the address of the variable in which to write the size of the Edge Finder context or calculated edges, in bytes. - - - Load, restore, or save an Edge Finder context from/to a file or memory stream, or save calculated edges from an Edge Finder result buffer to a file or memory stream in CAD DXF format. - Specifies the file or memory stream. - Specifies the system on which to restore the Edge Finder context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the Edge Finder context or calculated edges. - Specifies the MIL version of the Edge Finder context. - Specifies the function's control flag. - Specifies the address of the variable in which to write or from which to read the identifier of the Edge Finder context or the Edge Finder result buffer. - Specifies the address of the variable in which to write the size of the Edge Finder context or calculated edges, in bytes. - - - Load, restore, or save an Edge Finder context from/to a file or memory stream, or save calculated edges from an Edge Finder result buffer to a file or memory stream in CAD DXF format. - Specifies the file or memory stream. - Specifies the system on which to restore the Edge Finder context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the Edge Finder context or calculated edges. - Specifies the MIL version of the Edge Finder context. - Specifies the function's control flag. - Specifies the address of the variable in which to write or from which to read the identifier of the Edge Finder context or the Edge Finder result buffer. - Specifies the address of the variable in which to write the size of the Edge Finder context or calculated edges, in bytes. - - - Load, restore, or save an Edge Finder context from/to a file or memory stream, or save calculated edges from an Edge Finder result buffer to a file or memory stream in CAD DXF format. - Specifies the file or memory stream. - Specifies the system on which to restore the Edge Finder context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the Edge Finder context or calculated edges. - Specifies the MIL version of the Edge Finder context. - Specifies the function's control flag. - Specifies the address of the variable in which to write or from which to read the identifier of the Edge Finder context or the Edge Finder result buffer. - Specifies the address of the variable in which to write the size of the Edge Finder context or calculated edges, in bytes. - - - Allocate an FPGA command context for a PU in the FPGA configuration loaded in a Processing FPGA on a target system. - Specifies the identifier of the system that has the required Processing FPGA. - Specifies the Processing FPGA for which to allocate the command context. - Specifies the function identifier of the required PU. - Specifies the subfunction identifier of the required PU. - Specifies the PU to use when two or more instances, with the same function identifier and subfunction identifier, are present in a FPGA configuration loaded in a Processing FPGA. - Specifies how the processing operation should be issued on the system command queue. - Reserved for future expansion. - Specifies the address of the variable in which to write the handle of the FPGA command context. - The returned value is M_VALID if allocation is successful. If allocation fails, M_NULL is returned. - - - Control a specified FPGA command context setting. - Specifies the handle of the FPGA command context associated with the PU. - Specifies the FPGA command context setting to control. - Specifies the address of the variable which contains the value to assign to the command context setting. - - - Free an FPGA command context. - Specifies the handle of the FPGA command context to deallocate. The command context must have been previously allocated on the system using MfpgaCommandAlloc. - Reserved for future expansion. Set this parameter to M_DEFAULT . - The returned value is M_VALID if deallocation is successful. If deallocation fails, M_NULL is returned. - - - Inquire about a specified FPGA command context setting. - Specifies the handle of the FPGA command context associated with the PU. - Specifies the type of setting about which to inquire. These inquire types correspond to register fields of the PU associated with the specified FPGA command context. - Specifies the address in which to write the requested information. - - - Put an FPGA command on the system command queue of the current thread. - Specifies the handle of the FPGA command context associated with the PU, which defines the command. - Specifies when the processing operation will be tagged as completed. This parameter can be set to one of the following values. - Specifies whether MfpgaCommandQueue should load the current command (or complex command) into hardware or store it into a complex command. - - - Controls a global setting of a specified Processing FPGA. - Specifies the identifier of the system that has the required Processing FPGA. - Specifies the Processing FPGA on the system to control. This parameter must be set to the following value: - Specifies the Processing FPGA setting to control. - Specifies the value to assign to the Processing FPGA setting. - The returned value is M_VALID if successful. If the operation fails, M_NULL is returned. - - - Get information about a PU hook event. - Specifies the PU event identifier received by the hook-handler function (see MfpgaHookFunction). - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Get information about a PU hook event. - Specifies the PU event identifier received by the hook-handler function (see MfpgaHookFunction). - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Set up a request to read registers of a PU. - Specifies the handle of the FPGA command context associated with the PU. - Specifies the section of the PU's register space to access. - Specifies the offset from the start of the specified register section, from which to begin reading, in bytes. The offset must be a multiple of 4 bytes. - Specifies how many bytes of the register to read. The length must be a multiple of 4 bytes. - Specifies the address of the variable in which to write the value read from the register. This address must remain valid for the duration of the operation, otherwise a memory corruption will occur. - Specifies when the register read access must take place. - - - Hook a function to an event generated by a PU on a target system. - Specifies the identifier of the system that has the required Processing FPGA. - Specifies the Processing FPGA on the system which has the required PU. This parameter must be set to the following value: - Specifies the function identifier of the PU. - Specifies the subfunction identifier of the PU. - Specifies the specific PU instance on which to hook a function if two or more instances are present in the FPGA configuration, loaded on the Processing FPGA. - Specifies the Processing FPGA event type. - Specifies the address of the function that should be called when an event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Hook a function to an event generated by a PU on a target system. - Specifies the identifier of the system that has the required Processing FPGA. - Specifies the Processing FPGA on the system which has the required PU. This parameter must be set to the following value: - Specifies the function identifier of the PU. - Specifies the subfunction identifier of the PU. - Specifies the specific PU instance on which to hook a function if two or more instances are present in the FPGA configuration, loaded on the Processing FPGA. - Specifies the Processing FPGA event type. - Specifies the address of the function that should be called when an event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Inquire global information about a specified Processing FPGA. - Specifies the identifier of the system that has the required Processing FPGA. - Specifies the Processing FPGA to inquire. - Specifies the information about which to inquire. - Specifies the address at which to write the requested information. - The returned value is M_VALID if successful. If the operation fails, M_NULL is returned. - - - Inquire global information about a specified Processing FPGA. - Specifies the identifier of the system that has the required Processing FPGA. - Specifies the Processing FPGA to inquire. - Specifies the information about which to inquire. - Specifies the address at which to write the requested information. - The returned value is M_VALID if successful. If the operation fails, M_NULL is returned. - - - Load a new FPGA configuration into a Processing FPGA on a target system. - Specifies the identifier of the system that has the required Processing FPGA. - Specifies the rank of the Processing FPGA into which to load the new FPGA configuration. This parameter must be set to the following value: - Specifies the name and path of the file from which to load the FPGA configuration. - Reserved for future expansion. Set this parameter to M_DEFAULT . - The returned value is M_VALID if successful. If the operation fails, M_NULL is returned. - - - Specify a destination buffer for the FPGA processing operation. - Specifies the handle of the FPGA command context associated with the PU. - Specifies the handle of the destination buffer. - Specifies the stream output port whose data will be routed to the destination buffer. - Reserved for future expansion. - - - Cascade the PUs of two commands, such that a stream output of one PU is routed to a stream input port of the other PU. - Specifies the handle of the FPGA command context to use in the link. - Specifies the stream output port of the PU associated with the source command context. - Specifies the handle of the destination command context to use in the link. - Specifies the stream input port of the PU associated with the destination command context. - Reserved for future expansion. Set this parameter to M_DEFAULT . - - - Set the contents of one or more FPGA registers. - Specifies the handle of the FPGA command context associated with the PU. - Specifies the section of the PU's register space to access. - Specifies the offset from the start of the specified register section, from which to begin writing, in bytes. The offset must be a multiple of 4 bytes. - Specifies the number of bytes to write in the register. The length must be a multiple of 4 bytes. - Specifies the address of the variable in which to write the value to be sent to the register. - Specifies when the register write access must take place. - - - Specify a source buffer for the FPGA processing operation. - Specifies the handle of the FPGA command context associated with the PU. - Specifies the handle of the source buffer. - Specifies the stream input port to which to route data from the source buffer. - Reserved for future expansion. - - - Allocate a MIL function context for your user-defined function. - Specifies the name of the user-defined function. - Specifies the number of parameters passed to the current user-defined function. Note that the number of parameters should not exceed 16. - Specifies the address of the slave function. - Specifies the name of the library file which contains the slave function's code. - Specifies the name of the slave function to export from the library file. - Specifies the opcode to use to locate the slave function when an application executes the user-defined MIL function. The slave function's opcode also serves to identify which user-defined module, if any, the user-defined function belongs to. - Specifies more information about the user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier provided for the user-defined function. Since the MfuncAlloc function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL function context for your user-defined function. - Specifies the name of the user-defined function. - Specifies the number of parameters passed to the current user-defined function. Note that the number of parameters should not exceed 16. - Specifies the address of the slave function. - Specifies the name of the library file which contains the slave function's code. - Specifies the name of the slave function to export from the library file. - Specifies the opcode to use to locate the slave function when an application executes the user-defined MIL function. The slave function's opcode also serves to identify which user-defined module, if any, the user-defined function belongs to. - Specifies more information about the user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier provided for the user-defined function. Since the MfuncAlloc function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL function context for your user-defined function. - Specifies the name of the user-defined function. - Specifies the number of parameters passed to the current user-defined function. Note that the number of parameters should not exceed 16. - Specifies the address of the slave function. - Specifies the name of the library file which contains the slave function's code. - Specifies the name of the slave function to export from the library file. - Specifies the opcode to use to locate the slave function when an application executes the user-defined MIL function. The slave function's opcode also serves to identify which user-defined module, if any, the user-defined function belongs to. - Specifies more information about the user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier provided for the user-defined function. Since the MfuncAlloc function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL function context for your user-defined function. - Specifies the name of the user-defined function. - Specifies the number of parameters passed to the current user-defined function. Note that the number of parameters should not exceed 16. - Specifies the address of the slave function. - Specifies the name of the library file which contains the slave function's code. - Specifies the name of the slave function to export from the library file. - Specifies the opcode to use to locate the slave function when an application executes the user-defined MIL function. The slave function's opcode also serves to identify which user-defined module, if any, the user-defined function belongs to. - Specifies more information about the user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier provided for the user-defined function. Since the MfuncAlloc function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL function context for your user-defined function. - Specifies the name of the user-defined function. - Specifies the number of parameters passed to the current user-defined function. Note that the number of parameters should not exceed 16. - Specifies the address of the slave function. - Specifies the name of the library file which contains the slave function's code. - Specifies the name of the slave function to export from the library file. - Specifies the opcode to use to locate the slave function when an application executes the user-defined MIL function. The slave function's opcode also serves to identify which user-defined module, if any, the user-defined function belongs to. - Specifies more information about the user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier provided for the user-defined function. Since the MfuncAlloc function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL function context for your user-defined function. - Specifies the name of the user-defined function. - Specifies the number of parameters passed to the current user-defined function. Note that the number of parameters should not exceed 16. - Specifies the address of the slave function. - Specifies the name of the library file which contains the slave function's code. - Specifies the name of the slave function to export from the library file. - Specifies the opcode to use to locate the slave function when an application executes the user-defined MIL function. The slave function's opcode also serves to identify which user-defined module, if any, the user-defined function belongs to. - Specifies more information about the user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier provided for the user-defined function. Since the MfuncAlloc function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL function context for your user-defined function. - Specifies the name of the user-defined function. - Specifies the number of parameters passed to the current user-defined function. Note that the number of parameters should not exceed 16. - Specifies the address of the slave function. - Specifies the name of the library file which contains the slave function's code. - Specifies the name of the slave function to export from the library file. - Specifies the opcode to use to locate the slave function when an application executes the user-defined MIL function. The slave function's opcode also serves to identify which user-defined module, if any, the user-defined function belongs to. - Specifies more information about the user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier provided for the user-defined function. Since the MfuncAlloc function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL function context for your user-defined function. - Specifies the name of the user-defined function. - Specifies the number of parameters passed to the current user-defined function. Note that the number of parameters should not exceed 16. - Specifies the address of the slave function. - Specifies the name of the library file which contains the slave function's code. - Specifies the name of the slave function to export from the library file. - Specifies the opcode to use to locate the slave function when an application executes the user-defined MIL function. The slave function's opcode also serves to identify which user-defined module, if any, the user-defined function belongs to. - Specifies more information about the user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier provided for the user-defined function. Since the MfuncAlloc function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Associate a MIL identifier with a user-defined object. - Specifies a MIL function identifier. - Specifies the MIL type of the user-defined object to be associated with a MIL identifier. - Specifies the address of the user-defined object that is to be associated with a MIL identifier. - The returned value is the MIL identifier associated with the object if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL function context for your script-based user-defined MIL function. - Specifies the name of the script-based user-defined MIL function. - Specifies the number of parameters to be registered for the current user-defined function. - Specifies the language and language version in which the script is written. - Specifies the name and path of the file containing the user-defined script. The script file must be accessible to the computer executing the script. - Specifies the name of the function to export from the script file. - Specifies the opcode to use to locate the script-based user-defined MIL function when an application calls the function. The opcode also serves to identify the module in which to group the function, if any. - Specifies more information about the script-based user-defined MIL function. - Specifies the address of the variable in which to store the MIL identifier of the allocated MIL function context. Since the MfuncAllocScript function also returns the MIL identifier, you can set this parameter to M_NULL . - The returned value is the MIL function context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Return the MIL identifier of the ancestor buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the MIL identifier of the specified MIL buffer's ancestor buffer. - - - Return the band offset relative to the ancestor buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the band offset of the specified MIL buffer relative to its ancestor buffer. - - - Return the bit offset relative to the ancestor buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the bit offset of the specified MIL buffer relative its ancestor buffer. - - - Return the X-offset relative to the ancestor buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the X-offset of the specified MIL buffer relative its ancestor buffer. - - - Return the Y-offset relative to the ancestor buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the Y-offset of the specified MIL buffer relative its ancestor buffer. - - - Return the requested format of the specified buffer as set using MbufAlloc...() with Attribute. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is a bit-encoded value that specifies the buffer's attributes, set at allocation. - - - Return the actual format of the specified buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is a bit-encoded value that specifies the buffer's current formatting. - - - Returns the Host address of the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - - - Returns the Host address of a band of the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - Specifies which band's address to return. - - - Return the MIL identifier of the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the MIL identifier of the specified MIL buffer. - - - Return the maximum pixel value possible in the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the maximum pixel value possible in the specified MIL buffer. - - - Return the minimum pixel value possible in the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the minimum pixel value possible in the specified MIL buffer. - - - Return the MIL identifier of the system on which the buffer has been allocated. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the MIL identifier of the system on which the specified MIL buffer has been allocated. - - - Return the type of system on which the buffer has been allocated. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the type of system on which the specified MIL buffer has been allocated. - - - Return the MIL identifier of the parent buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the MIL identifier of the specified MIL buffers' parent buffer. - - - Return the band offset relative to the parent buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the band offset of the specified MIL buffer relative to its parent buffer. - - - Return the X-offset relative to the parent buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the X-offset of the specified MIL buffer relative its parent buffer. - - - Return the Y-offset relative to the parent buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the Y-offset of the specified MIL buffer relative its ancestor buffer. - - - Return the physical address of the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the physical address of the specified MIL buffer. - - - Returns the physical address of a band of the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - Specifies which band's address to return. - The returned value is the physical address of a band of the specified MIL buffer. - - - Return the number of pixels between the beginnings of any two adjacent lines of the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the number of pixels between the beginnings of any two adjacent lines of the specified MIL buffer. - - - Return the number of bytes between the beginnings of any two adjacent lines of the buffer. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the number of bytes between the beginnings of any two adjacent lines of the specified MIL buffer. - - - Return the number of buffer color bands. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the number of color bands in the specified MIL buffer. - - - Return the depth per band, in bits. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the depth per band, in bits, of the specified MIL buffer. - - - Return the width of the buffer, in pixels. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the width, in pixels, of the specified MIL buffer. - - - Return the height of the buffer, in pixels. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the height, in pixels, of the specified MIL buffer. - - - Return the buffer data type and depth. - Specifies the handle of the MIL buffer. The buffer handle must be obtained using MfuncInquire with M_BUFFER_INFO. - The returned value is the buffer data type and depth, in bits, of the specified MIL buffer. - - - Execute the slave function. - Specifies the identifier of the user-defined MIL function. - The returned value is M_NULL if an error occurred; otherwise, not null. - - - Control a user-defined MIL function context. - Specifies the identifier of the user-defined MIL function context. Depending on the control type, the context must have been allocated using a specific MIL allocation function. - Specifies the user-defined MIL function context setting to control. - Specifies the setting's new value. - - - Control a user-defined MIL function context. - Specifies the identifier of the user-defined MIL function context. Depending on the control type, the context must have been allocated using a specific MIL allocation function. - Specifies the user-defined MIL function context setting to control. - Specifies the setting's new value. - - - Report an error message. - Specifies the MIL function identifier. This parameter can be set to the following values: - Specifies a numeric code to the user-defined MIL function's group of error messages. - Specifies the text of your error message to report. - Specifies the text of your first error sub-message to report. - Specifies the text of your second error sub-message to report. - Specifies the text of your third error sub-message to report. - The returned value is M_NULL if an error occurred during the error log operation; otherwise, not M_NULL . - - - Report an error message. - Specifies the MIL function identifier. This parameter can be set to the following values: - Specifies a numeric code to the user-defined MIL function's group of error messages. - Specifies the text of your error message to report. - Specifies the text of your first error sub-message to report. - Specifies the text of your second error sub-message to report. - Specifies the text of your third error sub-message to report. - The returned value is M_NULL if an error occurred during the error log operation; otherwise, not M_NULL . - - - Report an error message. - Specifies the MIL function identifier. This parameter can be set to the following values: - Specifies a numeric code to the user-defined MIL function's group of error messages. - Specifies the text of your error message to report. - Specifies the text of your first error sub-message to report. - Specifies the text of your second error sub-message to report. - Specifies the text of your third error sub-message to report. - The returned value is M_NULL if an error occurred during the error log operation; otherwise, not M_NULL . - - - Report an error message. - Specifies the MIL function identifier. This parameter can be set to the following values: - Specifies a numeric code to the user-defined MIL function's group of error messages. - Specifies the text of your error message to report. - Specifies the text of your first error sub-message to report. - Specifies the text of your second error sub-message to report. - Specifies the text of your third error sub-message to report. - The returned value is M_NULL if an error occurred during the error log operation; otherwise, not M_NULL . - - - Report an error message. - Specifies the MIL function identifier. This parameter can be set to the following values: - Specifies a numeric code to the user-defined MIL function's group of error messages. - Specifies the text of your error message to report. - Specifies the text of your first error sub-message to report. - Specifies the text of your second error sub-message to report. - Specifies the text of your third error sub-message to report. - The returned value is M_NULL if an error occurred during the error log operation; otherwise, not M_NULL . - - - Free a MIL function context. - Specifies the identifier of the user-defined MIL function whose function context you want to free. - - - Free the MIL identifier associated with a user-defined MIL object. - Specifies a MIL function identifier. This parameter can be set to the following values: - Specifies the MIL identifier of the user-defined MIL object to free. - - - Retrieve information about a MIL object. - Specifies the identifier of the MIL object. Depending on the inquire type, this object must have been allocated using a specific MIL allocation function. - Specifies the MIL object feature about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Retrieve information about a MIL object. - Specifies the identifier of the MIL object. Depending on the inquire type, this object must have been allocated using a specific MIL allocation function. - Specifies the MIL object feature about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Retrieve information about a MIL object. - Specifies the identifier of the MIL object. Depending on the inquire type, this object must have been allocated using a specific MIL allocation function. - Specifies the MIL object feature about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Retrieve information about a MIL object. - Specifies the identifier of the MIL object. Depending on the inquire type, this object must have been allocated using a specific MIL allocation function. - Specifies the MIL object feature about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the parameter type of the parameter in the user-defined MIL function. - Specifies the size of the data pointed to by the ParamValuePtr parameter. - Specifies the type of the MIL object when the data type of the parameter of the user-defined function is MIL_ID. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies the type of the MIL object when the data type of the parameter of the user-defined function is MIL_ID. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies the type of the MIL object when the data type of the parameter of the user-defined function is MIL_ID. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_UINT64parameter. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the number of elements in the array. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the length of the string in characters, including the null terminator. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the size of the data, in bytes, pointed to by ParamValuePtr. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the size of the data, in bytes, pointed to by ParamValuePtr. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the size of the data, in bytes, pointed to by ParamValuePtr. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the size of the data, in bytes, pointed to by ParamValuePtr. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the size of the data, in bytes, pointed to by ParamValuePtr. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the length of the string in characters, including the null terminator. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_DOUBLEparameter. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_IDparameter. - Specifies the type of the MIL object when the data type of the parameter of the user-defined function is MIL_ID. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_INTparameter. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_INT32parameter. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_INT64parameter. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the length of the string in characters, including the null terminator. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the length of the string in characters, including the null terminator. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the array or variable to register. - Specifies the length of the string in characters, including the null terminator. - Specifies whether the parameter will be used for data input or to store new data. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_UINTparameter. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_UINT32parameter. - - - Register a parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the value of the type MIL_UINT64parameter. - - - Verify whether parameter checking is required. - Specifies the identifier of the user-defined MIL function. - The returned value is M_NULL if no parameter checking is required; otherwise, checking is required. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Read the value of the specified MIL function parameter. - Specifies the identifier of the user-defined MIL function. - Specifies the index of the parameter within the user-defined MIL function's parameter list. - Specifies the address of the variable in which to write the value of the specified parameter. - - - Generate data into a LUT buffer using a specified standard mathematical function, or a specified colormap (pseudo-color palette). - Specifies the identifier of the LUT in which to generate values. - Specifies the mathematical function or colormap to use for calculations. - Specifies the constant a for the specified mathematical function, or specifies a replacement value for the color assigned to index 0 of the LUT, if filling the LUT with a colormap. - Specifies the constant b for the specified mathematical function, or specifies a replacement value for the color assigned to the highest index of the LUT, if filling the LUT with a colormap. - Specifies the constant c for the specified mathematical function, if applicable. If filling the LUT with a colormap, set this to M_DEFAULT. - Specifies the first LUT index entry for which to generate values. - Specifies the initial value of x in the mathematical function. If filling the LUT with a colormap, set this to M_DEFAULT. - Specifies the last LUT index entry for which to generate values. - - - Generate ramp data into a LUT buffer. - Specifies the identifier of the LUT in which to generate values. - Specifies the first LUT index for which to generate a value. - Specifies the starting value from which the increment is calculated; that is, the first LUT entry. - Specifies the last LUT index for which to generate a value. - Specifies the ending value from which the increment is calculated; that is, the last LUT entry. - - - Generate 2D ramp data into a buffer. - Specifies the identifier of the buffer in which to generate values. - Specifies the factor by which to scale in X. - Specifies the factor by which to scale in Y. - Specifies the offset. This corresponds to the value placed in the first location of the buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Generate coefficients or LUTs used to warp an image. - Specifies the input buffer from which to generate coefficients or LUT entries. - Specifies the buffer in which to place generated coefficients or X-LUT entries. - Specifies the buffer in which to place Y-LUT entries. - Specifies the mode of operation. - Specifies the type of first-order polynomial warping for which to generate coefficients. If you are not generating coefficients for a first-order polynomial warping ( M_WARP_POLYNOMIAL), set the this parameter to M_DEFAULT . - Specifies the first transform constant. - Specifies the second transform constant. - - - Allocate a 2D graphics context. - Specifies the system on which to allocate the 2D graphics context. - Specifies the address of the variable in which the 2D graphics context identifier is to be written. - The returned value is the 2D graphics context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 2D graphics context. - Specifies the system on which to allocate the 2D graphics context. - Specifies the address of the variable in which the 2D graphics context identifier is to be written. - The returned value is the 2D graphics context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 2D graphics list. - Specifies the system on which to allocate the 2D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 2D graphics list identifier. - The returned value is the 2D graphics list identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a 2D graphics list. - Specifies the system on which to allocate the 2D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 2D graphics list identifier. - The returned value is the 2D graphics list identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Draw an arc in an image without rotation or fill color, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer in which to draw the arc or the identifier of a valid 2D graphics list in which to add the arc. - Specifies the X-coordinate of the center of the ellipse from which the arc is defined, in the input coordinate system. - Specifies the Y-coordinate of the center of the ellipse from which the arc is defined, in the input coordinate system. - Specifies the radius of the ellipse from which the arc is defined, along the X-axis of the input coordinate system. - Specifies the radius of the ellipse from which the arc is defined, along the Y-axis of the input coordinate system. - Specifies the angle at which to start drawing the arc, in degrees, relative to the input coordinate system. - Specifies the angle at which to end drawing the arc, in degrees, relative to the input coordinate system. - - - Draw an arc in an image without rotation or fill color, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer in which to draw the arc or the identifier of a valid 2D graphics list in which to add the arc. - Specifies the X-coordinate of the center of the ellipse from which the arc is defined, in the input coordinate system. - Specifies the Y-coordinate of the center of the ellipse from which the arc is defined, in the input coordinate system. - Specifies the radius of the ellipse from which the arc is defined, along the X-axis of the input coordinate system. - Specifies the radius of the ellipse from which the arc is defined, along the Y-axis of the input coordinate system. - Specifies the angle at which to start drawing the arc, in degrees, relative to the input coordinate system. - Specifies the angle at which to end drawing the arc, in degrees, relative to the input coordinate system. - - - Draw an arc or sector in an image, with optional rotation and fill color, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer in which to draw the arc or sector, or the identifier of a valid 2D graphics list in which to add the arc or sector. - Specifies the X-coordinate of the center of the ellipse from which the arc or sector is defined, in the input coordinate system. - Specifies the Y-coordinate of the center of the ellipse from which the arc or sector is defined, in the input coordinate system. - Specifies the radius of the ellipse from which the arc or sector is defined, along the X-axis in the input coordinate system. - Specifies the radius of the ellipse from which the arc or sector is defined, along the Y-axis in the input coordinate system. - Specifies the angle at which to start drawing the arc or sector, in degrees, relative to the input coordinate system. - Specifies the angle at which to end drawing the arc or sector, in degrees, relative to the input coordinate system. - Specifies the amount to rotate the ellipse used to define the arc or sector, in degrees, relative to the input coordinate system. - Specifies whether to draw an arc or sector. This parameter must be set to one of the following values: - - - Draw an arc or sector in an image, with optional rotation and fill color, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer in which to draw the arc or sector, or the identifier of a valid 2D graphics list in which to add the arc or sector. - Specifies the X-coordinate of the center of the ellipse from which the arc or sector is defined, in the input coordinate system. - Specifies the Y-coordinate of the center of the ellipse from which the arc or sector is defined, in the input coordinate system. - Specifies the radius of the ellipse from which the arc or sector is defined, along the X-axis in the input coordinate system. - Specifies the radius of the ellipse from which the arc or sector is defined, along the Y-axis in the input coordinate system. - Specifies the angle at which to start drawing the arc or sector, in degrees, relative to the input coordinate system. - Specifies the angle at which to end drawing the arc or sector, in degrees, relative to the input coordinate system. - Specifies the amount to rotate the ellipse used to define the arc or sector, in degrees, relative to the input coordinate system. - Specifies whether to draw an arc or sector. This parameter must be set to one of the following values: - - - Draw a filled arc (sector) in an image without rotation, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer in which to draw the arc or the identifier of a valid 2D graphics list in which to add the arc. - Specifies the X-coordinate of the center of the ellipse from which the arc is defined, in the input coordinate system. - Specifies the Y-coordinate of the center of the ellipse from which the arc is defined, in the input coordinate system. - Specifies the radius of the ellipse from which the arc is defined, along the X-axis of the input coordinate system. - Specifies the radius of the ellipse from which the arc is defined, along the Y-axis of the input coordinate system. - Specifies the angle at which to start drawing the arc, in degrees, relative to the input coordinate system. - Specifies the angle at which to end drawing the arc, in degrees, relative to the input coordinate system. - - - Draw a filled arc (sector) in an image without rotation, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer in which to draw the arc or the identifier of a valid 2D graphics list in which to add the arc. - Specifies the X-coordinate of the center of the ellipse from which the arc is defined, in the input coordinate system. - Specifies the Y-coordinate of the center of the ellipse from which the arc is defined, in the input coordinate system. - Specifies the radius of the ellipse from which the arc is defined, along the X-axis of the input coordinate system. - Specifies the radius of the ellipse from which the arc is defined, along the Y-axis of the input coordinate system. - Specifies the angle at which to start drawing the arc, in degrees, relative to the input coordinate system. - Specifies the angle at which to end drawing the arc, in degrees, relative to the input coordinate system. - - - Sets the background color of the 2D graphics context. - Specifies the identifier of the 2D graphics context in which to set the background color. This parameter must be set to one of the following values: - Specifies the background color of a specified 2D graphics context. - - - Clear an image buffer to a specified foreground color, or remove graphics from a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer to clear or the identifier of a valid 2D graphics list to empty. - - - Sets the foreground color of the 2D graphics context. - Specifies the identifier of the 2D graphics context in which to set the foreground color. This parameter must be set to one of the following values: - Specifies the foreground color of a specified 2D graphics context. - - - Control a specified 2D graphics context setting. - Specifies the identifier of the 2D graphics context to control. This parameter must be set to one of the following: - Specifies the 2D graphics context setting to control. - Specifies the value to assign to the 2D graphics context setting. - - - Control a specified 2D graphics context setting. - Specifies the identifier of the 2D graphics context to control. This parameter must be set to one of the following: - Specifies the 2D graphics context setting to control. - Specifies the value to assign to the 2D graphics context setting. - - - Control the graphics contained within the 2D graphics list. - Specifies the identifier of the 2D graphics list to control. The 2D graphics list must have been previously allocated on the required system using MgraAllocList. - Specifies the graphic (one or all) to control. - Specifies the index of the sub-element of the graphic on which to apply the control setting. If this information is not required or supported, set this parameter to M_DEFAULT. - Specifies the 2D graphics list setting to control. - Specifies the value to assign to the 2D graphics list setting. - - - Control the graphics contained within the 2D graphics list. - Specifies the identifier of the 2D graphics list to control. The 2D graphics list must have been previously allocated on the required system using MgraAllocList. - Specifies the graphic (one or all) to control. - Specifies the index of the sub-element of the graphic on which to apply the control setting. If this information is not required or supported, set this parameter to M_DEFAULT. - Specifies the 2D graphics list setting to control. - Specifies the value to assign to the 2D graphics list setting. - - - Copy one or more graphics from one 2D graphics list to another. - Specifies the identifier of a valid 2D graphics list from which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the identifier of a valid 2D graphics list in which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the type of copy operation to perform. - Specifies the location inside the destination 2D graphics list at which to insert the graphics. - Specifies the number of graphics to copy or move. - Specifies the address of the array containing the indices or labels of the graphics to copy from the source 2D graphics list. - Specifies the address of the array in which to write the labels that have been automatically given to the copied or moved graphics in the destination 2D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy one or more graphics from one 2D graphics list to another. - Specifies the identifier of a valid 2D graphics list from which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the identifier of a valid 2D graphics list in which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the type of copy operation to perform. - Specifies the location inside the destination 2D graphics list at which to insert the graphics. - Specifies the number of graphics to copy or move. - Specifies the address of the array containing the indices or labels of the graphics to copy from the source 2D graphics list. - Specifies the address of the array in which to write the labels that have been automatically given to the copied or moved graphics in the destination 2D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy one or more graphics from one 2D graphics list to another. - Specifies the identifier of a valid 2D graphics list from which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the identifier of a valid 2D graphics list in which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the type of copy operation to perform. - Specifies the location inside the destination 2D graphics list at which to insert the graphics. - Specifies the number of graphics to copy or move. - Specifies the address of the array containing the indices or labels of the graphics to copy from the source 2D graphics list. - Specifies the address of the array in which to write the labels that have been automatically given to the copied or moved graphics in the destination 2D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy one or more graphics from one 2D graphics list to another. - Specifies the identifier of a valid 2D graphics list from which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the identifier of a valid 2D graphics list in which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the type of copy operation to perform. - Specifies the location inside the destination 2D graphics list at which to insert the graphics. - Specifies the number of graphics to copy or move. - Specifies the address of the array containing the indices or labels of the graphics to copy from the source 2D graphics list. - Specifies the address of the array in which to write the labels that have been automatically given to the copied or moved graphics in the destination 2D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - - - Copy one or more graphics from one 2D graphics list to another. - Specifies the identifier of a valid 2D graphics list from which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the identifier of a valid 2D graphics list in which to copy or move the graphics. You must have allocated the 2D graphics list using MgraAllocList. - Specifies the type of copy operation to perform. - Specifies the location inside the destination 2D graphics list at which to insert the graphics. - Specifies the number of graphics to copy or move. - Specifies the address of the array containing the indices or labels of the graphics to copy from the source 2D graphics list. - Specifies the address of the array in which to write the labels that have been automatically given to the copied or moved graphics in the destination 2D graphics list. - Reserved for future expansion and must be set to M_DEFAULT . - - - Draw a dot in an image or add a dot to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the dot or the identifier of a valid 2D graphics list in which to add the dot. - Specifies the X-coordinate of the dot in the input coordinate system. - Specifies the Y-coordinate of the dot in the input coordinate system. - - - Draw a dot in an image or add a dot to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the dot or the identifier of a valid 2D graphics list in which to add the dot. - Specifies the X-coordinate of the dot in the input coordinate system. - Specifies the Y-coordinate of the dot in the input coordinate system. - - - Draw one or more dots in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the dots or the identifier of a valid 2D graphics list in which to add the dots. - Specifies the number of dots to draw. - Specifies the address of the array containing the X-coordinate(s) of the dots to be drawn in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the dots to be drawn in the input coordinate system. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Draw one or more dots in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the dots or the identifier of a valid 2D graphics list in which to add the dots. - Specifies the number of dots to draw. - Specifies the address of the array containing the X-coordinate(s) of the dots to be drawn in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the dots to be drawn in the input coordinate system. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Draw one or more dots in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the dots or the identifier of a valid 2D graphics list in which to add the dots. - Specifies the number of dots to draw. - Specifies the address of the array containing the X-coordinate(s) of the dots to be drawn in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the dots to be drawn in the input coordinate system. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Draw graphics, contained in a 2D graphics list, in an image. - Specifies the identifier of the 2D graphics list containing the graphics to destructively draw in the image. - Specifies the identifier of the destination image buffer in which to draw. - Specifies whether to also draw the annotations that indicate whether a graphic is selected, such as the selection box and handles. - - - Perform a boundary-type seed fill. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to perform the filling operation. - Specifies the X-coordinate of the seed position in the input coordinate system. - Specifies the Y-coordinate of the seed position in the input coordinate system. - - - Perform a boundary-type seed fill. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to perform the filling operation. - Specifies the X-coordinate of the seed position in the input coordinate system. - Specifies the Y-coordinate of the seed position in the input coordinate system. - - - Associate a text font with a 2D graphics context. - Specifies the identifier of the 2D graphics context with which to associate the character font. This parameter must be set to one of the following values: - Specifies the font with which to write text. - - - Set the font scale of a 2D graphics context. - Specifies the identifier of the 2D graphics context for which to set the font scale. - Specifies the X-scale-factor by which to multiply the width of the font characters. - Specifies the Y-scale-factor by which to multiply the height of the font characters. - - - Free a 2D graphics context or a 2D graphics list. - Specifies the identifier of the 2D graphics context or 2D graphics list to deallocate. If M_DEFAULT is specified, an error will occur. - - - Get information about a 2D graphics list event. - Specifies the 2D graphics list event identifier received by the hook-handler function (see MgraHookFunction). - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a 2D graphics list event. - Specifies the 2D graphics list event identifier received by the hook-handler function (see MgraHookFunction). - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a 2D graphics list event. - Specifies the 2D graphics list event identifier received by the hook-handler function (see MgraHookFunction). - Specifies the type of information to get. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Hook a function to a 2D graphics list event. - Specifies the identifier of the 2D graphics list to which to hook a function. - Specifies the 2D graphics list event to which to hook the function. - Specifies the address of the function that should be called when the specified event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Inquire information about a 2D graphics context. - Specifies the identifier of the 2D graphics context about which to inquire information. This parameter must be set to one of the following values: - Specifies the 2D graphics context setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics context. - Specifies the identifier of the 2D graphics context about which to inquire information. This parameter must be set to one of the following values: - Specifies the 2D graphics context setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics context. - Specifies the identifier of the 2D graphics context about which to inquire information. This parameter must be set to one of the following values: - Specifies the 2D graphics context setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics context. - Specifies the identifier of the 2D graphics context about which to inquire information. This parameter must be set to one of the following values: - Specifies the 2D graphics context setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics list or a graphic contained within the 2D graphics list. - Specifies the identifier of the 2D graphics list about which to inquire information. - Specifies the graphic about which to inquire, or specifies to inquire about the 2D graphics list itself. - Specifies the index of the sub-element of the graphic about which to inquire. If this information is not required or supported, set this parameter to M_DEFAULT. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics list or a graphic contained within the 2D graphics list. - Specifies the identifier of the 2D graphics list about which to inquire information. - Specifies the graphic about which to inquire, or specifies to inquire about the 2D graphics list itself. - Specifies the index of the sub-element of the graphic about which to inquire. If this information is not required or supported, set this parameter to M_DEFAULT. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics list or a graphic contained within the 2D graphics list. - Specifies the identifier of the 2D graphics list about which to inquire information. - Specifies the graphic about which to inquire, or specifies to inquire about the 2D graphics list itself. - Specifies the index of the sub-element of the graphic about which to inquire. If this information is not required or supported, set this parameter to M_DEFAULT. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a 2D graphics list or a graphic contained within the 2D graphics list. - Specifies the identifier of the 2D graphics list about which to inquire information. - Specifies the graphic about which to inquire, or specifies to inquire about the 2D graphics list itself. - Specifies the index of the sub-element of the graphic about which to inquire. If this information is not required or supported, set this parameter to M_DEFAULT. - Specifies the setting to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Change the state of interactivity of graphics in a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid 2D graphics list whose state of interactivity must be changed. - Specifies the type of graphic to define interactively and add to the 2D graphics list, or specifies to cancel or stop the 2D graphics list's state of interactivity. - Specifies optional behavior when defining the graphic in the display. If this behavior is not required or supported, set this parameter to M_DEFAULT . - Specifies how to interactively define the graphic. - - - Draw a line in an image or add a line to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the line or the identifier of a valid 2D graphics list in which to add the line. - Specifies the X-coordinate of the start of the line in the input coordinate system. - Specifies the Y-coordinate of the start of the line in the input coordinate system. - Specifies the X-coordinate of the end of the line in the input coordinate system. - Specifies the Y-coordinate of the end of the line in the input coordinate system. - - - Draw a line in an image or add a line to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the line or the identifier of a valid 2D graphics list in which to add the line. - Specifies the X-coordinate of the start of the line in the input coordinate system. - Specifies the Y-coordinate of the start of the line in the input coordinate system. - Specifies the X-coordinate of the end of the line in the input coordinate system. - Specifies the Y-coordinate of the end of the line in the input coordinate system. - - - Draw one or more lines, a polyline, or a polygon in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the lines, polyline, or polygon or the identifier of a valid 2D graphics list in which to add the lines, polyline, or polygon. - Specifies the number of lines to draw or add ( M_LINE_LIST), or the number of vertices in the polyline or polygon to draw or add ( M_POLYGON or M_POLYLINE), according to the array parameters ( XPtr, YPtr, X2Ptr, and Y2Ptr). - Specifies the address of the array containing the X-coordinate(s) of the start of the lines, or containing the X-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the start of the lines, or containing the Y-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the X-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the type of line to draw in the image or to add to the 2D graphics list. - - - Draw one or more lines, a polyline, or a polygon in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the lines, polyline, or polygon or the identifier of a valid 2D graphics list in which to add the lines, polyline, or polygon. - Specifies the number of lines to draw or add ( M_LINE_LIST), or the number of vertices in the polyline or polygon to draw or add ( M_POLYGON or M_POLYLINE), according to the array parameters ( XPtr, YPtr, X2Ptr, and Y2Ptr). - Specifies the address of the array containing the X-coordinate(s) of the start of the lines, or containing the X-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the start of the lines, or containing the Y-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the X-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the type of line to draw in the image or to add to the 2D graphics list. - - - Draw one or more lines, a polyline, or a polygon in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the lines, polyline, or polygon or the identifier of a valid 2D graphics list in which to add the lines, polyline, or polygon. - Specifies the number of lines to draw or add ( M_LINE_LIST), or the number of vertices in the polyline or polygon to draw or add ( M_POLYGON or M_POLYLINE), according to the array parameters ( XPtr, YPtr, X2Ptr, and Y2Ptr). - Specifies the address of the array containing the X-coordinate(s) of the start of the lines, or containing the X-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the start of the lines, or containing the Y-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the X-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the type of line to draw in the image or to add to the 2D graphics list. - - - Draw one or more lines, a polyline, or a polygon in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the lines, polyline, or polygon or the identifier of a valid 2D graphics list in which to add the lines, polyline, or polygon. - Specifies the number of lines to draw or add ( M_LINE_LIST), or the number of vertices in the polyline or polygon to draw or add ( M_POLYGON or M_POLYLINE), according to the array parameters ( XPtr, YPtr, X2Ptr, and Y2Ptr). - Specifies the address of the array containing the X-coordinate(s) of the start of the lines, or containing the X-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the start of the lines, or containing the Y-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the X-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the type of line to draw in the image or to add to the 2D graphics list. - - - Draw one or more lines, a polyline, or a polygon in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the lines, polyline, or polygon or the identifier of a valid 2D graphics list in which to add the lines, polyline, or polygon. - Specifies the number of lines to draw or add ( M_LINE_LIST), or the number of vertices in the polyline or polygon to draw or add ( M_POLYGON or M_POLYLINE), according to the array parameters ( XPtr, YPtr, X2Ptr, and Y2Ptr). - Specifies the address of the array containing the X-coordinate(s) of the start of the lines, or containing the X-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the start of the lines, or containing the Y-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the X-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the type of line to draw in the image or to add to the 2D graphics list. - - - Draw one or more lines, a polyline, or a polygon in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the lines, polyline, or polygon or the identifier of a valid 2D graphics list in which to add the lines, polyline, or polygon. - Specifies the number of lines to draw or add ( M_LINE_LIST), or the number of vertices in the polyline or polygon to draw or add ( M_POLYGON or M_POLYLINE), according to the array parameters ( XPtr, YPtr, X2Ptr, and Y2Ptr). - Specifies the address of the array containing the X-coordinate(s) of the start of the lines, or containing the X-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the start of the lines, or containing the Y-coordinates of the vertices in the polyline or polygon, in the input coordinate system. - Specifies the address of the array containing the X-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the address of the array containing the Y-coordinate(s) of the end of the lines in the input coordinate system. - Specifies the type of line to draw in the image or to add to the 2D graphics list. - - - Draw a rectangle in an image without rotation or fill color, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the rectangle or the identifier of a valid 2D graphics list in which to add the rectangle. - Specifies the X-coordinate of the top-left corner of the rectangle in the input coordinate system. - Specifies the Y-coordinate of the top-left corner of the rectangle in the input coordinate system. - Specifies the X-coordinate of the bottom-right corner of the rectangle in the input coordinate system. - Specifies the Y-coordinate of the bottom-right corner of the rectangle in the input coordinate system. - - - Draw a rectangle in an image without rotation or fill color, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the rectangle or the identifier of a valid 2D graphics list in which to add the rectangle. - Specifies the X-coordinate of the top-left corner of the rectangle in the input coordinate system. - Specifies the Y-coordinate of the top-left corner of the rectangle in the input coordinate system. - Specifies the X-coordinate of the bottom-right corner of the rectangle in the input coordinate system. - Specifies the Y-coordinate of the bottom-right corner of the rectangle in the input coordinate system. - - - Draw a rectangle in an image with optional rotation and fill color, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the rectangle or the identifier of a valid 2D graphics list in which to add the rectangle. - Specifies the X-coordinate of the rectangle's position in the input coordinate system. - Specifies the Y-coordinate of the rectangle's position in the input coordinate system. - Specifies the width of the rectangle, relative to the input coordinate system. - Specifies the height of the rectangle, relative to the input coordinate system. - Specifies the angle with which to rotate the rectangle, in degrees, relative to the input coordinate system. - Specifies how to draw the rectangle in the image or add the rectangle to the 2D graphics list. - - - Draw a rectangle in an image with optional rotation and fill color, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the rectangle or the identifier of a valid 2D graphics list in which to add the rectangle. - Specifies the X-coordinate of the rectangle's position in the input coordinate system. - Specifies the Y-coordinate of the rectangle's position in the input coordinate system. - Specifies the width of the rectangle, relative to the input coordinate system. - Specifies the height of the rectangle, relative to the input coordinate system. - Specifies the angle with which to rotate the rectangle, in degrees, relative to the input coordinate system. - Specifies how to draw the rectangle in the image or add the rectangle to the 2D graphics list. - - - Draw a filled rectangle in an image without rotation, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the filled rectangle or the identifier of a valid 2D graphics list in which to add the filled rectangle. - Specifies the X-coordinate of the top-left corner of the filled rectangle in the input coordinate system. - Specifies the Y-coordinate of the top-left corner of the filled rectangle in the input coordinate system. - Specifies the X-coordinate of the bottom-right corner of the filled rectangle in the input coordinate system. - Specifies the Y-coordinate of the bottom-right corner of the filled rectangle in the input coordinate system. - - - Draw a filled rectangle in an image without rotation, or add it to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the filled rectangle or the identifier of a valid 2D graphics list in which to add the filled rectangle. - Specifies the X-coordinate of the top-left corner of the filled rectangle in the input coordinate system. - Specifies the Y-coordinate of the top-left corner of the filled rectangle in the input coordinate system. - Specifies the X-coordinate of the bottom-right corner of the filled rectangle in the input coordinate system. - Specifies the Y-coordinate of the bottom-right corner of the filled rectangle in the input coordinate system. - - - Draw text in an image or add text to a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer in which to draw the graphic or the identifier of a valid 2D graphics list in which to add the graphic. - Specifies the X-coordinate at which to start drawing the top-left corner of the first character in the input coordinate system. - Specifies the Y-coordinate at which to start drawing the top-left corner of the first character in the input coordinate system. - Specifies the address of the string containing the text to draw in the destination buffer. - - - Draw text in an image or add text to a 2D graphics list. - Specifies the identifier of the 2D graphics context. - Specifies the identifier of a valid image buffer in which to draw the graphic or the identifier of a valid 2D graphics list in which to add the graphic. - Specifies the X-coordinate at which to start drawing the top-left corner of the first character in the input coordinate system. - Specifies the Y-coordinate at which to start drawing the top-left corner of the first character in the input coordinate system. - Specifies the address of the string containing the text to draw in the destination buffer. - - - Draw vectors at arbitrary positions in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the vectors or the identifier of a valid 2D graphics list in which to add the vectors. - Specifies the number of vectors to draw. - Specifies the address of the array containing the X-coordinates of the starting points of the vectors to draw. - Specifies the address of the array containing the Y-coordinates of the starting points of the vectors to draw. - Specifies the address of the array containing the displacements, in the X-direction, of the vectors to draw. - Specifies the address of the array containing the displacements, in the Y-direction, of the vectors to draw. - Specifies how to use the scale value ( ScaleValue) to scale the vectors. - Specifies the value by which to scale the vectors, according to the specified mode ( ScaleMode). - Specifies how to configure the arrowheads of the vectors, and how to handle null vectors. - - - Draw vectors at arbitrary positions in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the vectors or the identifier of a valid 2D graphics list in which to add the vectors. - Specifies the number of vectors to draw. - Specifies the address of the array containing the X-coordinates of the starting points of the vectors to draw. - Specifies the address of the array containing the Y-coordinates of the starting points of the vectors to draw. - Specifies the address of the array containing the displacements, in the X-direction, of the vectors to draw. - Specifies the address of the array containing the displacements, in the Y-direction, of the vectors to draw. - Specifies how to use the scale value ( ScaleValue) to scale the vectors. - Specifies the value by which to scale the vectors, according to the specified mode ( ScaleMode). - Specifies how to configure the arrowheads of the vectors, and how to handle null vectors. - - - Draw vectors at arbitrary positions in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the vectors or the identifier of a valid 2D graphics list in which to add the vectors. - Specifies the number of vectors to draw. - Specifies the address of the array containing the X-coordinates of the starting points of the vectors to draw. - Specifies the address of the array containing the Y-coordinates of the starting points of the vectors to draw. - Specifies the address of the array containing the displacements, in the X-direction, of the vectors to draw. - Specifies the address of the array containing the displacements, in the Y-direction, of the vectors to draw. - Specifies how to use the scale value ( ScaleValue) to scale the vectors. - Specifies the value by which to scale the vectors, according to the specified mode ( ScaleMode). - Specifies how to configure the arrowheads of the vectors, and how to handle null vectors. - - - Draw vectors at arbitrary positions in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the vectors or the identifier of a valid 2D graphics list in which to add the vectors. - Specifies the number of vectors to draw. - Specifies the address of the array containing the X-coordinates of the starting points of the vectors to draw. - Specifies the address of the array containing the Y-coordinates of the starting points of the vectors to draw. - Specifies the address of the array containing the displacements, in the X-direction, of the vectors to draw. - Specifies the address of the array containing the displacements, in the Y-direction, of the vectors to draw. - Specifies how to use the scale value ( ScaleValue) to scale the vectors. - Specifies the value by which to scale the vectors, according to the specified mode ( ScaleMode). - Specifies how to configure the arrowheads of the vectors, and how to handle null vectors. - - - Draw vectors at equally spaced positions in an image, or add them to a 2D graphics list. - Specifies the identifier of the 2D graphics context. This parameter must be set to one of the following values: - Specifies the identifier of a valid image buffer in which to draw the vectors or the identifier of a valid 2D graphics list in which to add the vectors. - Specifies the identifier of a valid image buffer containing the values corresponding to the displacements, in the X-direction, of the vectors to draw. - Specifies the identifier of a valid image buffer containing the values corresponding to the displacements, in the Y-direction, of the vectors to draw. - Specifies a value that establishes the positions for which vectors are drawn. MIL always draws a vector for the first position (0,0), and then draws subsequent vectors that are a multiple of the specified stride, in both the X- and Y-direction. For example, if you specify a stride of 2, a vector is drawn for position (0,0), and for every second position after that, in the X-direction and in the Y-direction. Specifying a stride of 1 draws a vector for every position. Increasing the stride increases the space between the vectors drawn. - Specifies how to use the scale value ( ScaleValue) to scale the vectors. - Specifies the value by which to scale the vectors, according to the specified mode ( ScaleMode). - Specifies how to configure the arrowheads of the vectors, and how to handle null vectors. - - - Allocate an image processing context. - Specifies the system on which to allocate the context. - Specifies the type of image processing context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the image processing context identifier. - The returned value is the image processing context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an image processing context. - Specifies the system on which to allocate the context. - Specifies the type of image processing context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the image processing context identifier. - The returned value is the image processing context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an image processing result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the number of buffer entries to allocate for the specified result buffer. - Specifies the type of data that will be stored in this result buffer. - Specifies the address of the variable in which to write the image processing result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an image processing result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the number of buffer entries to allocate for the specified result buffer. - Specifies the type of data that will be stored in this result buffer. - Specifies the address of the variable in which to write the image processing result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Perform a point-to-point arithmetic operation. - Specifies the data source of the first operand. - Specifies the data source of the second operand. - Specifies the identifier of the destination of the results. - Specifies the operation to perform. - - - Perform a point-to-point arithmetic operation using multiple source images. - Specifies the data source of the first operand; this parameter must be given an image buffer identifier. - Specifies the data source of the second operand; this parameter can be given an image buffer identifier or a constant. - Specifies the data source of the third operand; this parameter can be given an image buffer identifier or a constant. - Specifies the data source of the fourth operand; this parameter must be given a constant. - Specifies the data source of the fifth operand; this parameter must be given a constant. - Specifies the identifier of the destination of the results; this parameter must be given an image buffer identifier. - Specifies the operation to perform. - Reserved for future expansion. Must be set to M_DEFAULT . - - - Perform an augmentation operation on an image. - Specifies the identifier of the augmentation context. The context must have been allocated using MimAlloc with M_AUGMENTATION_CONTEXT. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination in which to write the result of the augmentation transformation. - Specifies the initial value that will generate the randomized settings for the image processing operations used to perform the augmentation. - Specifies whether MimAugment should perform the augmentation, or should explicitly preprocess the augmentation context. - - - Perform a point-to-point binary threshold operation. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination image buffer in which to write the results. - Specifies the condition, as well as the threshold mode to use to establish the threshold value(s) of the condition. - Specifies either the lower limit of the selected condition or the minimum value to use when establishing the threshold. - Specifies either the upper limit of the selected condition or the maximum value to use when establishing the threshold. - When DstImageBufId is given an image buffer identifier, this function returns the specified value of the LowParam parameter. When DstImageBufId is set to M_NULL and the ConditionAndThreshMode parameter is set to one of the automatic threshold modes (M_BIMODAL, M_TRIANGLE_BISECTION_DARK, or M_TRIANGLE_BISECTION_BRIGHT), this function returns the automatically calculated threshold value. If the ConditionAndThreshMode parameter is set to M_PERCENTILE_VALUE, this function returns the threshold value established from the specified lower limit. When dealing with floating-point source buffers, the returned threshold is truncated to an integer value. Therefore, the returned threshold and the actual threshold used to binarize can differ. - - - Perform a point-to-point adaptive binarization on an image. - Specifies the identifier of the adaptive binarization context. - Specifies the identifier of the source image buffer with which to perform the adaptive binarization. - Specifies the identifier of the image buffer to use as the first seed image. - Specifies the identifier of the image buffer to use as the second seed image. - Specifies the identifier of the image buffer in which to put the result of the adaptive binarization operation. - Specifies the identifier of the image buffer in which to put the resulting threshold values with which to binarize the source image. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform a point-to-point clipping operation. - Specifies the identifier of the image data source. - Specifies the identifier of the destination image buffer. - Specifies the clipping condition. - Specifies the lower clipping point of the selected condition. - Specifies the upper clipping point of the selected condition. - Specifies the value to write to the destination buffer when a pixel satisfies the specified low clipping condition. - Specifies the value to write to the destination buffer when a pixel satisfies the specified high clipping condition. - - - Perform a binary or grayscale closing-type morphological operation. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the resulting image. - Specifies the number of times to iterate the operation. - Specifies the processing mode to use. - - - Perform a 3x3 binary connectivity mapping. - Specifies the identifier of the source of the operation. - Specifies the identifier of the destination of the results. - Specifies the identifier of the LUT buffer. - - - Control an image processing context or result buffer setting. - Specifies the identifier of the image processing context or result buffer. The image processing context or result buffer must have been previously allocated on the system using MimAlloc or MimAllocResult, respectively. - Specifies the processing feature to control. - Specifies the value needed for the control. - - - Control an image processing context or result buffer setting. - Specifies the identifier of the image processing context or result buffer. The image processing context or result buffer must have been previously allocated on the system using MimAlloc or MimAllocResult, respectively. - Specifies the processing feature to control. - Specifies the value needed for the control. - - - Perform a color conversion. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the type of conversion to perform. - - - Perform a general convolution operation. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the results. - Specifies the filter to use. - - - Count the number of pixels that differ in each image. - Specifies the identifier of the first image data source. - Specifies the identifier of the second image data source. - Specifies the identifier of the buffer in which to store the differences. - The returned value is the number of differences between the two specified source buffers. - - - Correct dead pixels in an image. - Specifies the identifier of the dead pixels image processing context. The context must have been allocated using MimAlloc with M_DEAD_PIXEL_CONTEXT. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the control flag. This parameter must be set to one of the following: - - - Produce a sequence of deinterlaced images from a sequence of images acquired from an interlaced camera. - Specifies the identifier of the image processing context to be used for deinterlacing. The image processing context must have been previously allocated on the system using MimAlloc. - Specifies an array containing the identifiers of the buffers of the images to deinterlace. - Specifies an array containing the identifiers of the buffers of the images in which to save the deinterlaced images. - Specifies the number of images in the source sequence. - Specifies the number of deinterlaced images in the destination sequence. - Reserved for future use. Should be set to M_DEFAULT . - - - Produce a sequence of deinterlaced images from a sequence of images acquired from an interlaced camera. - Specifies the identifier of the image processing context to be used for deinterlacing. The image processing context must have been previously allocated on the system using MimAlloc. - Specifies an array containing the identifiers of the buffers of the images to deinterlace. - Specifies an array containing the identifiers of the buffers of the images in which to save the deinterlaced images. - Specifies the number of images in the source sequence. - Specifies the number of deinterlaced images in the destination sequence. - Reserved for future use. Should be set to M_DEFAULT . - - - Produce a sequence of deinterlaced images from a sequence of images acquired from an interlaced camera. - Specifies the identifier of the image processing context to be used for deinterlacing. The image processing context must have been previously allocated on the system using MimAlloc. - Specifies an array containing the identifiers of the buffers of the images to deinterlace. - Specifies an array containing the identifiers of the buffers of the images in which to save the deinterlaced images. - Specifies the number of images in the source sequence. - Specifies the number of deinterlaced images in the destination sequence. - Reserved for future use. Should be set to M_DEFAULT . - - - Perform a differential operation. - Specifies the identifier of an image buffer that stores a derivative, or a linear IIR filter context. - Specifies the identifier of an image buffer that stores the source image, or a derivative. - Specifies the identifier an image buffer that stores the source image (for a sharpenig operation), or a derivative. - Reserved for future expansion and must be set to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies the identifier of the first destination image buffer. - Specifies the identifier of the second destination image buffer. - Specifies an attribute of the operation to perform. - Specifies the differential operation to perform. - Specifies a control setting for the operation to perform. - - - Perform a binary or grayscale dilation-type morphological operation. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the number of times to iterate the operation. - Specifies the processing mode to use. - - - Perform a distance transformation. - Specifies the identifier of the source of the operation. - Specifies the identifier of the destination of the resulting image. - Specifies the way in which the minimum distance from blob pixel to background pixel is calculated. - - - Draw the settings of an image processing context or the results of an image processing operation. - Specifies the identifier of the 2D graphics context to use. This parameter must be set to one of the following: - Specifies the identifier of the primary source image buffer, result buffer, or image processing context from which to extract the results to draw. - Specifies the identifier of the secondary source image buffer for the drawing operation. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Specifies an attribute of the operation to perform. - Specifies an attribute of the operation to perform. - Specifies drawing constraints. - - - Perform a specific edge detection operation and produce a gradient intensity and/or gradient angle image. - Specifies the identifier of the source of the operation. - Specifies the identifier of the destination buffer for the resulting gradient intensity image. - Specifies the identifier of the destination buffer for the resulting gradient angle image. - Specifies the filter to use. - Specifies how to perform the operation. - Specifies the threshold value for calculating the gradient angle. - - - Perform a binary or grayscale erosion-type morphological operation. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the number of times to iterate the operation. - Specifies the processing mode to use. - - - Perform adaptive filtering. - Specifies the predefined adaptive filter context to use. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies an attribute of the operation to perform. - Specifies an attribute of the operation to perform. - Specifies an attribute of the operation to perform. - Specifies how to determine the new value for a pixel determined to be noise. - - - Find an image buffer's extremes (minimum and/or maximum pixel values). - Specifies the identifier of the data source of the operation. - Specifies the identifier of the buffer in which to store the extreme values. - Specifies the type of extreme(s) to find. - - - Find the dominant orientations of an image buffer. - Specifies the find orientation image processing context. - Specifies the identifier of the source image. - Specifies the identifier of the find orientation result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Applies a flat-field correction to remove artifacts from the specified source image. - Specifies the identifier of a flat-field image processing context, previously allocated using MimAlloc with M_FLAT_FIELD_CONTEXT. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the operation to perform. This parameter must be set to one of the following values. - - - Perform a horizontal or vertical image-flipping operation. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the operation to perform. - Reserved for future expansion. Must be set to M_DEFAULT . - - - Free an image processing context or result buffer. - Specifies the identifier of the image processing context or result buffer to free. These must have been successfully allocated (with MimAlloc or MimAllocResult) prior to calling this function. - - - Gets arrays of values from an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the array in which to store the first set of values. - Specifies the address of the array in which to store the second set of values. - Reserved for future expansion and must be set to M_DEFAULT . - The returned value is the number of entries in the array(s). If Param1Ptr and Param2Ptr are both set to M_NULL, MimGet returns the size of the required arrays. - - - Gets arrays of values from an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the array in which to store the first set of values. - Specifies the address of the array in which to store the second set of values. - Reserved for future expansion and must be set to M_DEFAULT . - The returned value is the number of entries in the array(s). If Param1Ptr and Param2Ptr are both set to M_NULL, MimGet returns the size of the required arrays. - - - Gets arrays of values from an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the array in which to store the first set of values. - Specifies the address of the array in which to store the second set of values. - Reserved for future expansion and must be set to M_DEFAULT . - The returned value is the number of entries in the array(s). If Param1Ptr and Param2Ptr are both set to M_NULL, MimGet returns the size of the required arrays. - - - Gets arrays of values from an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the array in which to store the first set of values. - Specifies the address of the array in which to store the second set of values. - Reserved for future expansion and must be set to M_DEFAULT . - The returned value is the number of entries in the array(s). If Param1Ptr and Param2Ptr are both set to M_NULL, MimGet returns the size of the required arrays. - - - Gets arrays of values from an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the array in which to store the first set of values. - Specifies the address of the array in which to store the second set of values. - Reserved for future expansion and must be set to M_DEFAULT . - The returned value is the number of entries in the array(s). If Param1Ptr and Param2Ptr are both set to M_NULL, MimGet returns the size of the required arrays. - - - Gets arrays of values from an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the array in which to store the first set of values. - Specifies the address of the array in which to store the second set of values. - Reserved for future expansion and must be set to M_DEFAULT . - The returned value is the number of entries in the array(s). If Param1Ptr and Param2Ptr are both set to M_NULL, MimGet returns the size of the required arrays. - - - Gets arrays of values from an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the array in which to store the first set of values. - Specifies the address of the array in which to store the second set of values. - Reserved for future expansion and must be set to M_DEFAULT . - The returned value is the number of entries in the array(s). If Param1Ptr and Param2Ptr are both set to M_NULL, MimGet returns the size of the required arrays. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified type of results from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to retrieve results. - Specifies the type of results to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get the specified number of result entries from an image processing result buffer. - Specifies the identifier of the image processing result buffer from which to get results. - Specifies the offset of the first result to read. - Specifies the number of result entries to get, starting from the entry specified by the OffEntry parameter. - Specifies the type of result(s) to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get data from a statistics result buffer, and place it in a user-supplied array. - Specifies the identifier of the statistics image processing result buffer from which to get results. - Specifies the X-offset of the region for which to retrieve results. - Specifies the Y-offset of the region for which to retrieve results. - Specifies the width (X-size) of the region for which to retrieve results. - Specifies the height (Y-size) of the region for which to retrieve results. - Specifies the type of result(s) to retrieve. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the user-specified array in which to write the results read from the multiple statistics result buffer. - - - Get data from a statistics result buffer, and place it in a user-supplied array. - Specifies the identifier of the statistics image processing result buffer from which to get results. - Specifies the X-offset of the region for which to retrieve results. - Specifies the Y-offset of the region for which to retrieve results. - Specifies the width (X-size) of the region for which to retrieve results. - Specifies the height (Y-size) of the region for which to retrieve results. - Specifies the type of result(s) to retrieve. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the user-specified array in which to write the results read from the multiple statistics result buffer. - - - Get data from a statistics result buffer, and place it in a user-supplied array. - Specifies the identifier of the statistics image processing result buffer from which to get results. - Specifies the X-offset of the region for which to retrieve results. - Specifies the Y-offset of the region for which to retrieve results. - Specifies the width (X-size) of the region for which to retrieve results. - Specifies the height (Y-size) of the region for which to retrieve results. - Specifies the type of result(s) to retrieve. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the user-specified array in which to write the results read from the multiple statistics result buffer. - - - Get data from a statistics result buffer, and place it in a user-supplied array. - Specifies the identifier of the statistics image processing result buffer from which to get results. - Specifies the X-offset of the region for which to retrieve results. - Specifies the Y-offset of the region for which to retrieve results. - Specifies the width (X-size) of the region for which to retrieve results. - Specifies the height (Y-size) of the region for which to retrieve results. - Specifies the type of result(s) to retrieve. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the user-specified array in which to write the results read from the multiple statistics result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Get a result from a wavelet transformation or 1D locate peak result buffer. - Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results. - Specifies the first index with which to indicate the result to retrieve. - Specifies the second index for which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the one-dimensional array in which to write the results read from the MIL result buffer. - - - Generate the intensity histogram of an image. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination for the histogram results. - - - Perform a histogram equalization of an image. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the results. - Specifies the equalization operation to perform. This parameter can be set to one of the following values. Note that the cumulative probability distribution, P(f) , of the input image is approximated by its cumulative histogram: - Specifies the value to use for alpha ( α ) in the equations for M_EXPONENTIAL and M_RAYLEIGH. - Specifies the lowest pixel value to equalize. - Specifies the highest pixel value to equalize. - - - Perform an adaptive histogram equalization on an image. - Specifies the identifier of the adaptive histogram equalization context. The context must have been allocated using MimAlloc with M_HISTOGRAM_EQUALIZE_ADAPTIVE_CONTEXT. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Inquire about an image processing context or result buffer setting. - Specifies the identifier of the image processing context or result buffer about which to inquire information. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire about an image processing context or result buffer setting. - Specifies the identifier of the image processing context or result buffer about which to inquire information. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire about an image processing context or result buffer setting. - Specifies the identifier of the image processing context or result buffer about which to inquire information. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Inquire about an image processing context or result buffer setting. - Specifies the identifier of the image processing context or result buffer about which to inquire information. - Specifies the type of information about which to inquire. - Specifies the address of the variable in which to write the requested information. - The returned value is the requested information, if it is a MIL_INT. If the requested information is a MIL_DOUBLEor if it is a MIL_INT64on a 32-bit system, this function will return M_NULL . - - - Label objects in an image buffer. - Specifies identifier of the data source of the operation. - Specifies the identifier of the destination of the results. - Specifies the type of connectivity (lattice) to use for processing. - - - Find pixel coordinates or values that satisfy a specified condition. - Specifies the identifier of the source image for the operation. - Specifies the identifier of the buffer in which to store the event results. - Specifies the condition under which pixel values are considered an event. - Specifies the lower limit of the selected condition. - Specifies the upper limit of the selected condition. - The returned value is the number of pixels that satisfy the specified condition in the specified source image. - - - Performs peak intensity detection in every lane (row or column) of the source image. - Specifies the identifier of the image processing context. - Specifies the identifier of the source image buffer. - Specifies the identifier of the image processing result buffer in which to store results. - Specifies the nominal (expected average) width of the peak neighborhood. - Specifies the number of pixels that can be added to or subtracted from the nominal width, when determining the range of allowable widths of the peak neighborhood. - Specifies the minimum contrast (difference) between the intensity of the local background and the minimum acceptable intensity of pixels in the peak neighborhood. - Specifies whether to explicitly preprocess the image processing result buffer; or specifies a frame index for which to extract peaks. - Specifies the required value for the ControlFlag setting. - - - Perform a point-to-point LUT mapping operation. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the results. - Specifies the LUT through which to map source input values. - - - Generates a series of correlation values between the source image and a model image. - Specifies the identifier of the match image processing context. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the operation to perform. This parameter must be set to one of the following values. - - - Perform a morphological transformation using a user-defined or predefined structuring element. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the structuring element to use. For all operations except area opening and area closing operations, you must specify the identifier of the structuring element buffer which defines the required structuring element. - Specifies the operation to perform. - Specifies a value that is dependent on the morphological operation chosen. - Specifies the processing mode to use. This parameter can be set to one of the following: - - - Perform a binary or grayscale opening-type morphological operation. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the resulting image. - Specifies the number of times to iterate the operation. - Specifies the processing mode to use. - - - Perform a polar-to-rectangular or rectangular-to-polar transformation on an image or generate LUTs used to perform the transformation. - Specifies the identifier of the source image buffer or the destination X-coordinate LUT buffer. - Specifies the identifier of the destination image buffer or the Y-coordinate LUT buffer. - Specifies the X-coordinate of the circle's center in the rectangular image. - Specifies the Y-coordinate of the circle's center in the rectangular image. - Specifies the start radius of the zone of interest in the circle, in pixels. - Specifies the end radius of the zone of interest in the circle, in pixels. - Specifies the start angle of the zone of interest. The scan starts at this angle. - Specifies the end angle of the zone of interest. The scan ends at this angle. - Specifies the transform to perform. - Specifies the interpolation mode and overscan used when transforming the source image. When generating the LUTs to perform the transformation, this parameter is ignored and should be set to M_DEFAULT. - Specifies the address of the variable in which the required width of the destination buffer is written. - Specifies the address of the variable in which the required height of the destination buffer is written. - - - Perform a polar-to-rectangular or rectangular-to-polar transformation on an image or generate LUTs used to perform the transformation. - Specifies the identifier of the source image buffer or the destination X-coordinate LUT buffer. - Specifies the identifier of the destination image buffer or the Y-coordinate LUT buffer. - Specifies the X-coordinate of the circle's center in the rectangular image. - Specifies the Y-coordinate of the circle's center in the rectangular image. - Specifies the start radius of the zone of interest in the circle, in pixels. - Specifies the end radius of the zone of interest in the circle, in pixels. - Specifies the start angle of the zone of interest. The scan starts at this angle. - Specifies the end angle of the zone of interest. The scan ends at this angle. - Specifies the transform to perform. - Specifies the interpolation mode and overscan used when transforming the source image. When generating the LUTs to perform the transformation, this parameter is ignored and should be set to M_DEFAULT. - Specifies the address of the variable in which the required width of the destination buffer is written. - Specifies the address of the variable in which the required height of the destination buffer is written. - - - Perform a polar-to-rectangular or rectangular-to-polar transformation on an image or generate LUTs used to perform the transformation. - Specifies the identifier of the source image buffer or the destination X-coordinate LUT buffer. - Specifies the identifier of the destination image buffer or the Y-coordinate LUT buffer. - Specifies the X-coordinate of the circle's center in the rectangular image. - Specifies the Y-coordinate of the circle's center in the rectangular image. - Specifies the start radius of the zone of interest in the circle, in pixels. - Specifies the end radius of the zone of interest in the circle, in pixels. - Specifies the start angle of the zone of interest. The scan starts at this angle. - Specifies the end angle of the zone of interest. The scan ends at this angle. - Specifies the transform to perform. - Specifies the interpolation mode and overscan used when transforming the source image. When generating the LUTs to perform the transformation, this parameter is ignored and should be set to M_DEFAULT. - Specifies the address of the variable in which the required width of the destination buffer is written. - Specifies the address of the variable in which the required height of the destination buffer is written. - - - Perform a polar-to-rectangular or rectangular-to-polar transformation on an image or generate LUTs used to perform the transformation. - Specifies the identifier of the source image buffer or the destination X-coordinate LUT buffer. - Specifies the identifier of the destination image buffer or the Y-coordinate LUT buffer. - Specifies the X-coordinate of the circle's center in the rectangular image. - Specifies the Y-coordinate of the circle's center in the rectangular image. - Specifies the start radius of the zone of interest in the circle, in pixels. - Specifies the end radius of the zone of interest in the circle, in pixels. - Specifies the start angle of the zone of interest. The scan starts at this angle. - Specifies the end angle of the zone of interest. The scan ends at this angle. - Specifies the transform to perform. - Specifies the interpolation mode and overscan used when transforming the source image. When generating the LUTs to perform the transformation, this parameter is ignored and should be set to M_DEFAULT. - Specifies the address of the variable in which the required width of the destination buffer is written. - Specifies the address of the variable in which the required height of the destination buffer is written. - - - Project a 2D image into 1D. - Specifies the identifier of the source image buffer. - Specifies the destination buffer in which to write the projection results. - Specifies the angle of the projection axis. Lanes are perpendicular to this angle. This parameter can be set to one of the following: - Specifies the operation to perform. - Reserved for future expansion. This parameter must be set to M_NULL . - - - Puts arrays of values into an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the first array of values. - Specifies the address of the second array of values. - Reserved for future expansion and must be set to M_DEFAULT . - - - Puts arrays of values into an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the first array of values. - Specifies the address of the second array of values. - Reserved for future expansion and must be set to M_DEFAULT . - - - Puts arrays of values into an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the first array of values. - Specifies the address of the second array of values. - Reserved for future expansion and must be set to M_DEFAULT . - - - Puts arrays of values into an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the first array of values. - Specifies the address of the second array of values. - Reserved for future expansion and must be set to M_DEFAULT . - - - Puts arrays of values into an image processing context. - Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc. - Specifies the type of information in the array(s). - Specifies the number of values in the array(s). - Specifies the address of the first array of values. - Specifies the address of the second array of values. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform a rank filter on the pixels in an image. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the resulting image. - Specifies the identifier of the structuring element buffer to use as a mask. - Specifies which of the pixel values to select after valid neighborhood values are sorted in increasing order; valid neighborhood pixel values are those that are not masked-out. - Specifies the processing mode to use. - - - Copies specified areas of a source buffer to the specified areas of a destination buffer. - Specifies the identifier of the rearrangement image processing context that indicates how to perform the operation and the locations to copy. - Specifies the identifier of the source image buffer. - Specifies the identifier of the destination image buffer. - Specifies the operation to perform. This parameter must be set to one of the following values. - - - Remap source pixels to destination pixels according to the specified mode. - Specifies the identifier of a remap image processing context. This parameter must be set to M_DEFAULT , which indicates a linear remapping from source pixel to corresponding destination pixel. - Specifies the identifier of the source image buffer. The image buffer must be a 1-band or 3-band float, signed, or unsigned buffer. - Specifies the identifier of the destination image buffer. - Specifies the remapping mode. - - - Resize an image by the specified X- and Y-scale factors or generate the matrix to perform the transformation. - Specifies the source image to resize if performing the transformation. This parameter can be set to one of the following values: - Specifies the destination image buffer or array buffer, depending on whether performing the transformation. This parameter can be set to one of the following values: - Specifies the horizontal scaling factor. - Specifies the vertical scaling factor. - Specifies the interpolation mode when resizing the source image. - - - Restore an image processing context from disk. - Specifies the name and path of the file from which to restore the image processing context. - Specifies the system on which to restore the image processing context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the image processing context identifier. - The returned value is the image processing context identifier. If allocation fails, M_NULL is returned. - - - Restore an image processing context from disk. - Specifies the name and path of the file from which to restore the image processing context. - Specifies the system on which to restore the image processing context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the image processing context identifier. - The returned value is the image processing context identifier. If allocation fails, M_NULL is returned. - - - Rotate an image by a specified angle of rotation or generate the matrix to perform the transformation. - Specifies the source image to rotate if performing the transformation. This parameter can be set to one of the following values: - Specifies the destination image buffer or array buffer, depending on whether performing the transformation. This parameter can be set to one of the following values: - Specifies the angle of rotation. - Specifies the X-coordinate to use as the center of rotation in the source image. - Specifies the Y-coordinate to use as the center of rotation in the source image. - Specifies the X-coordinate in the destination buffer to which the specified center of the rotated source image will be mapped. - Specifies the Y-coordinate in the destination buffer to which the specified center of the rotated source image will be mapped. - Specifies the interpolation mode when rotating the source image. - - - Save an image processing context to a file. - Specifies the name and path of the file in which to save the image processing context; it is recommended that you use the MIC file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the image processing context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save an image processing context to a file. - Specifies the name and path of the file in which to save the image processing context; it is recommended that you use the MIC file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the image processing context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform a point-to-point bit shift. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the results. - Specifies the number of bits to shift. - - - Calculates and stores a variety of statistics from the specified source image(s). - Specifies the identifier of the image processing context that specifies the statistics to calculate. - Specifies the identifier of the source image buffer. - Specifies the identifier of the result buffer. - Specifies the operation to perform on the source image. - - - Load, restore, or save an image processing context from/to a file or a memory stream, or save an augmentation report to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the image processing context. - Specifies the operation to perform on the image processing context. - Specifies the type of stream in which to store/from which to restore the image processing context. - Specifies the MIL version of the image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the image processing context. - Specifies the address of the variable in which to write the size of the image processing context, in bytes. - - - Load, restore, or save an image processing context from/to a file or a memory stream, or save an augmentation report to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the image processing context. - Specifies the operation to perform on the image processing context. - Specifies the type of stream in which to store/from which to restore the image processing context. - Specifies the MIL version of the image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the image processing context. - Specifies the address of the variable in which to write the size of the image processing context, in bytes. - - - Load, restore, or save an image processing context from/to a file or a memory stream, or save an augmentation report to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the image processing context. - Specifies the operation to perform on the image processing context. - Specifies the type of stream in which to store/from which to restore the image processing context. - Specifies the MIL version of the image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the image processing context. - Specifies the address of the variable in which to write the size of the image processing context, in bytes. - - - Load, restore, or save an image processing context from/to a file or a memory stream, or save an augmentation report to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the image processing context. - Specifies the operation to perform on the image processing context. - Specifies the type of stream in which to store/from which to restore the image processing context. - Specifies the MIL version of the image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the image processing context. - Specifies the address of the variable in which to write the size of the image processing context, in bytes. - - - Load, restore, or save an image processing context from/to a file or a memory stream, or save an augmentation report to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the image processing context. - Specifies the operation to perform on the image processing context. - Specifies the type of stream in which to store/from which to restore the image processing context. - Specifies the MIL version of the image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the image processing context. - Specifies the address of the variable in which to write the size of the image processing context, in bytes. - - - Load, restore, or save an image processing context from/to a file or a memory stream, or save an augmentation report to a file. - Specifies the file or memory stream. - Specifies the system on which to restore the image processing context. - Specifies the operation to perform on the image processing context. - Specifies the type of stream in which to store/from which to restore the image processing context. - Specifies the MIL version of the image processing context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the image processing context. - Specifies the address of the variable in which to write the size of the image processing context, in bytes. - - - Perform a binary or grayscale thickening operation on an image. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the resulting image. - Specifies the number of times to iterate the operation. - Specifies the processing mode to use. - - - Perform a binary or grayscale thinning operation on an image. - Specifies the identifier of the data source of the operation. - Specifies the identifier of the destination of the resulting image. - Specifies the number of times to iterate the operation. - Specifies the processing mode to use. - - - Perform a Fast Fourier transform (FFT), a Discrete Cosine transform (DCT), or a polar-cartesian coordinates transformation. - Specifies the identifier of the source buffer for the real component of the image. - Specifies the identifier of the source buffer for the imaginary component of the image. - Specifies the identifier of the destination buffer for the real component of the image. - Specifies the identifier of the destination buffer for the imaginary component of the image. - Specifies the type of transform to perform on the image. - Specifies if the transform is a forward transform or a reverse transform. - - - Translate an image by a specified X- and/or Y-displacement, or generate the matrix to perform the transformation. - Specifies the source image to translate if performing the transformation. This parameter can be set to one of the following values: - Specifies the destination image buffer or array buffer, depending on whether performing the transformation. This parameter can be set to one of the following values: - Specifies the amount, in pixel units, by which to displace the source image in the X-direction. - Specifies the amount, in pixel units, by which to displace the source image in the Y-direction. - Specifies the interpolation mode when translating the source image. When only generating the matrix, this parameter is ignored and should be set to M_DEFAULT. - - - Perform a warping. - Specifies the buffer on which to perform the warping. - Specifies the buffer in which to place the results of the warping. - Specifies the buffer containing the matrix coefficients or the LUT buffer from which x s is determined. - Specifies the LUT buffer from which y s is determined. - Specifies the mode of operation. - Specifies the interpolation mode. - - - Applies a warping matrix to a list of coordinates. - Specifies the buffer containing the warp matrix coefficients. - Specifies the transformation type to perform the warping. - Specifies the number of points in the arrays. - Specifies the address of the array that contains the source X-coordinates. - Specifies the address of the array that contains the source Y-coordinates. - Specifies the address of the array in which to store the destination X-coordinates. - Specifies the address of the array in which to store the destination Y-coordinates. - Reserved for future expansion. - - - Perform a watershed transformation. - Specifies the buffer on which to perform the transform. - Specifies the buffer to use as a marker image. - Specifies the buffer in which to place the results of the transformation. - Specifies the minimum variation of gray-level of a catchment basin. - Specifies how to perform the transformation. - - - Perform a wavelet denoising. - Specifies the identifier of a wavelet image processing context, when performing a wavelet denoising of an image. - Specifies the identifier of the source with which to perform the wavelet denoising. - Specifies the identifier of the destination with which to perform the wavelet denoising. - Specifies the transformation level at which to perform the denoising. - Specifies the type of wavelet process with which to perform the denoising. - Reserved for future expansion and must be set to M_DEFAULT . - - - Set wavelet filters for a custom wavelet context. - Specifies the identifier of a custom wavelet image processing context allocated using MimAlloc with M_WAVELET_TRANSFORM_CUSTOM_CONTEXT. - Specifies the identifier of the kernel buffer containing the real part of the complex numbers used for the low-pass filter of a forward wavelet transformation. - Specifies the identifier of the kernel buffer containing the real part of the complex numbers used for the high-pass filter of a forward wavelet transformation. - Specifies the identifier of the kernel buffer containing the real part of the complex numbers used for the low-pass filter of a reverse wavelet transformation. - Specifies the identifier of the kernel buffer containing the real part of the complex numbers used for the high-pass filter of a reverse wavelet transformation. - Specifies the identifier of the kernel buffer containing the imaginary part of the complex numbers used for the low-pass filter of a forward wavelet transformation. - Specifies the identifier of the kernel buffer containing the imaginary part of the complex numbers used for the high-pass filter of a forward wavelet transformation. - Specifies the identifier of the kernel buffer containing the imaginary part of the complex numbers used for the low-pass filter of a reverse wavelet transformation. - Specifies the identifier of the kernel buffer containing the imaginary part of the complex numbers used for the high-pass filter of a reverse wavelet transformation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform a wavelet transformation. - Specifies the identifier of a wavelet image processing context. The context must have been allocated using MimAlloc with M_WAVELET_TRANSFORM_CONTEXT or M_WAVELET_TRANSFORM_CUSTOM_CONTEXT. - Specifies the identifier of the source with which to perform the wavelet transformation. - Specifies the identifier of the destination in which to write the result of the wavelet transformation. - Specifies the type of wavelet transformation to perform. - Specifies the number of transformation levels with which to calculate results. - Reserved for future expansion and must be set to M_DEFAULT . - - - Perform a zone of influence detection. - Specifies the identifier of the source of the operation. - Specifies the identifier of the destination of the resulting image. - Specifies the type of 3x3 distance matrix used for the operation. - - - Allocate a measurement context. - Specifies the system on which the to allocate the measurement context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which the measurement context identifier is to be written. - The returned value is the measurement context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a measurement context. - Specifies the system on which the to allocate the measurement context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which the measurement context identifier is to be written. - The returned value is the measurement context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a measurement marker buffer. - Specifies the system on which to allocate the marker buffer. - Specifies the type of marker buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the marker buffer identifier. - The returned value is the marker buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a measurement marker buffer. - Specifies the system on which to allocate the marker buffer. - Specifies the type of marker buffer to allocate. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the marker buffer identifier. - The returned value is the marker buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a measurement result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. - Specifies the address of the variable in which the measurement result identifier is to be written. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a measurement result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. - Specifies the address of the variable in which the measurement result identifier is to be written. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Calculate measurements between two markers. - Specifies the measurement context to use. - Specifies the identifier of the first marker buffer to use for calculating measurements. - Specifies the identifier of the second marker buffer to use for calculating measurements. - Specifies the identifier of the result buffer in which to place results. - Specifies which measurement(s) to calculate. - - - Control a measurement context or result buffer setting. - Specifies the identifier of the measurement context or result buffer. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control a measurement context or result buffer setting. - Specifies the identifier of the measurement context or result buffer. - Specifies the type of control to set. - Specifies the required value for the control. - - - Draw expected marker characteristics or the characteristics of marker occurrences, or draw calculation results, in the destination image buffer or 2D graphics list. - Specifies the 2D graphics context to use. This parameter must be set to one of the following values: - Specifies the identifier of a measurement marker buffer or the identifier of a measurement result buffer. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Specifies the index of the result to draw from a measurement marker buffer or from a measurement result buffer. - Specifies whether to perform the drawing operation on the expected marker characteristics, the actual marker characteristics found in the target image, or the results of the measurement calculation. - - - Find a marker in a target image and take the specified measurements. - Specifies the identifier of the measurement context. - Specifies the identifier of the target image buffer in which to locate the marker. - Specifies the identifier of the marker to be located in the image. - Specifies the measurements to perform. - - - Free a measurement context, marker buffer, or result buffer. - Specifies the measurement identifier to free. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result(s) for all points, edges, stripes, or circles from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker buffer (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result(s) to retrieve. - Specifies the address of the first array in which to write the requested information. - Specifies the address of the second array in which to write the requested information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Get the specified type of result for a specific point, edge, stripe, or circle from a measurement marker buffer or a measurement result buffer. - Specifies the identifier of the measurement marker (allocated with MmeasAllocMarker) or measurement result buffer (allocated with MmeasAllocResult) from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address of the first variable or array in which to write the requested information. - Specifies the address of the second variable or array in which to write the requested information. - Specifies the index of the occurrence for which to retrieve information. - - - Retrieves information about the specified score characteristic. - Specifies the identifier of the measurement marker buffer. - Specifies the score characteristic about which to get information. - Specifies the index of the occurrence of a multiple-occurrence marker. This parameter must be set to one of the following values: - Specifies the address of the variable in which to write either the characteristic's resulting value (when using M_RESULT) or the characteristic's minimum acceptable limit, as indicated using MmeasSetScore with the Min parameter (when using M_MARKER). - Specifies the address of the variable in which to write either the characteristic's resulting score (when using M_RESULT) or the characteristic's lowest acceptable limit, as indicated using MmeasSetScore with the Low parameter (when using M_MARKER). - Specifies the address of the variable in which to write either the greatest value that MIL considers theoretically possible for the characteristic (when using M_RESULT) or the characteristic's highest acceptable limit, as indicated using MmeasSetScore with the High parameter (when using M_MARKER). - Specifies the address of the variable in which to write the characteristic's maximum acceptable limit, as indicated using MmeasSetScore with the Max parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Specifies the address of the variable in which to write the characteristic's score-offset, as indicated using MmeasSetScore with the ScoreOffset parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Specifies the address of the variable in which to write the characteristic's input units, as indicated using MmeasSetScore with the InputUnits parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Reserved for future expansion and must be set to M_DEFAULT . - - - Retrieves information about the specified score characteristic. - Specifies the identifier of the measurement marker buffer. - Specifies the score characteristic about which to get information. - Specifies the index of the occurrence of a multiple-occurrence marker. This parameter must be set to one of the following values: - Specifies the address of the variable in which to write either the characteristic's resulting value (when using M_RESULT) or the characteristic's minimum acceptable limit, as indicated using MmeasSetScore with the Min parameter (when using M_MARKER). - Specifies the address of the variable in which to write either the characteristic's resulting score (when using M_RESULT) or the characteristic's lowest acceptable limit, as indicated using MmeasSetScore with the Low parameter (when using M_MARKER). - Specifies the address of the variable in which to write either the greatest value that MIL considers theoretically possible for the characteristic (when using M_RESULT) or the characteristic's highest acceptable limit, as indicated using MmeasSetScore with the High parameter (when using M_MARKER). - Specifies the address of the variable in which to write the characteristic's maximum acceptable limit, as indicated using MmeasSetScore with the Max parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Specifies the address of the variable in which to write the characteristic's score-offset, as indicated using MmeasSetScore with the ScoreOffset parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Specifies the address of the variable in which to write the characteristic's input units, as indicated using MmeasSetScore with the InputUnits parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Reserved for future expansion and must be set to M_DEFAULT . - - - Retrieves information about the specified score characteristic. - Specifies the identifier of the measurement marker buffer. - Specifies the score characteristic about which to get information. - Specifies the index of the occurrence of a multiple-occurrence marker. This parameter must be set to one of the following values: - Specifies the address of the variable in which to write either the characteristic's resulting value (when using M_RESULT) or the characteristic's minimum acceptable limit, as indicated using MmeasSetScore with the Min parameter (when using M_MARKER). - Specifies the address of the variable in which to write either the characteristic's resulting score (when using M_RESULT) or the characteristic's lowest acceptable limit, as indicated using MmeasSetScore with the Low parameter (when using M_MARKER). - Specifies the address of the variable in which to write either the greatest value that MIL considers theoretically possible for the characteristic (when using M_RESULT) or the characteristic's highest acceptable limit, as indicated using MmeasSetScore with the High parameter (when using M_MARKER). - Specifies the address of the variable in which to write the characteristic's maximum acceptable limit, as indicated using MmeasSetScore with the Max parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Specifies the address of the variable in which to write the characteristic's score-offset, as indicated using MmeasSetScore with the ScoreOffset parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Specifies the address of the variable in which to write the characteristic's input units, as indicated using MmeasSetScore with the InputUnits parameter (when using M_MARKER); otherwise, you must specify M_NULL , indicating that MIL does not return any information to this parameter (when using M_RESULT). - Reserved for future expansion and must be set to M_DEFAULT . - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a measurement context, marker, or result buffer. - Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - Specifies the address in which to write the requested information. - The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Restore a marker from disk. - Specifies the name and path of the file from which to restore the marker. - Specifies the system on which to restore the measurement marker. - Reserved for future expansion, and must be set to M_DEFAULT . - Specifies the address of the variable in which the marker identifier is to be written. - The returned value is the marker identifier. If allocation fails, M_NULL is returned. - - - Restore a marker from disk. - Specifies the name and path of the file from which to restore the marker. - Specifies the system on which to restore the measurement marker. - Reserved for future expansion, and must be set to M_DEFAULT . - Specifies the address of the variable in which the marker identifier is to be written. - The returned value is the marker identifier. If allocation fails, M_NULL is returned. - - - Save a marker to disk. - Specifies the name and path of the file in which to save the marker. - Specifies the identifier of the marker to save. - Reserved for future expansion, and must be set to M_DEFAULT . - - - Save a marker to disk. - Specifies the name and path of the file in which to save the marker. - Specifies the identifier of the marker to save. - Reserved for future expansion, and must be set to M_DEFAULT . - - - Set an essential characteristic of a marker. - Specifies the identifier of the marker. - Specifies the type of characteristic to set. - Specifies the first value to assign to the characteristic. - Specifies the second value to assign to the characteristic. - - - Set an essential characteristic of a marker. - Specifies the identifier of the marker. - Specifies the type of characteristic to set. - Specifies the first value to assign to the characteristic. - Specifies the second value to assign to the characteristic. - - - Set a score characteristic of a marker. - Specifies the identifier of the measurement marker for which to set the score characteristic. - Specifies the score characteristic to set. - Specifies the minimum limit, which MIL uses to calculate the characteristic's score. - Specifies the low limit, which MIL uses to calculate the characteristic's score. - Specifies the high limit, which MIL uses to calculate the characteristic's score. - Specifies the maximum limit, which MIL uses to calculate the characteristic's score. - Specifies the characteristic's score-offset. - Specifies the units with which to interpret the Min, Low, High, and Max parameter values, when applicable. - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a marker from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the measurement marker. - Specifies the operation to perform on the measurement marker. - Specifies the type of stream in which to store/from which to restore the measurement marker. - Specifies the MIL version of the marker object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the marker. - Specifies the address of the variable in which to write the size of the measurement marker, in bytes. - - - Load, restore, or save a marker from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the measurement marker. - Specifies the operation to perform on the measurement marker. - Specifies the type of stream in which to store/from which to restore the measurement marker. - Specifies the MIL version of the marker object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the marker. - Specifies the address of the variable in which to write the size of the measurement marker, in bytes. - - - Load, restore, or save a marker from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the measurement marker. - Specifies the operation to perform on the measurement marker. - Specifies the type of stream in which to store/from which to restore the measurement marker. - Specifies the MIL version of the marker object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the marker. - Specifies the address of the variable in which to write the size of the measurement marker, in bytes. - - - Load, restore, or save a marker from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the measurement marker. - Specifies the operation to perform on the measurement marker. - Specifies the type of stream in which to store/from which to restore the measurement marker. - Specifies the MIL version of the marker object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the marker. - Specifies the address of the variable in which to write the size of the measurement marker, in bytes. - - - Load, restore, or save a marker from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the measurement marker. - Specifies the operation to perform on the measurement marker. - Specifies the type of stream in which to store/from which to restore the measurement marker. - Specifies the MIL version of the marker object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the marker. - Specifies the address of the variable in which to write the size of the measurement marker, in bytes. - - - Load, restore, or save a marker from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the measurement marker. - Specifies the operation to perform on the measurement marker. - Specifies the type of stream in which to store/from which to restore the measurement marker. - Specifies the MIL version of the marker object. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the marker. - Specifies the address of the variable in which to write the size of the measurement marker, in bytes. - - - Add a feature to, or modify a feature of, the metrology template of a metrology context. - Specifies the identifier of the metrology context containing the template. - Specifies the type of feature to add ( M_CONSTRUCTED or M_MEASURED) or specifies to modify a feature ( M_MODIFY). - Specifies the geometric shape of the feature to add. - Specifies the label of the feature. - Specifies the operation to use to build the feature. - Specifies the array that holds the label of every feature to use to construct the feature. - Specifies the array that holds the index of every subfeature to use to construct the feature. - Specifies the size of the arrays that hold the information that will be used to construct the feature ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a feature to, or modify a feature of, the metrology template of a metrology context. - Specifies the identifier of the metrology context containing the template. - Specifies the type of feature to add ( M_CONSTRUCTED or M_MEASURED) or specifies to modify a feature ( M_MODIFY). - Specifies the geometric shape of the feature to add. - Specifies the label of the feature. - Specifies the operation to use to build the feature. - Specifies the array that holds the label of every feature to use to construct the feature. - Specifies the array that holds the index of every subfeature to use to construct the feature. - Specifies the size of the arrays that hold the information that will be used to construct the feature ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a feature to, or modify a feature of, the metrology template of a metrology context. - Specifies the identifier of the metrology context containing the template. - Specifies the type of feature to add ( M_CONSTRUCTED or M_MEASURED) or specifies to modify a feature ( M_MODIFY). - Specifies the geometric shape of the feature to add. - Specifies the label of the feature. - Specifies the operation to use to build the feature. - Specifies the array that holds the label of every feature to use to construct the feature. - Specifies the array that holds the index of every subfeature to use to construct the feature. - Specifies the size of the arrays that hold the information that will be used to construct the feature ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a feature to, or modify a feature of, the metrology template of a metrology context. - Specifies the identifier of the metrology context containing the template. - Specifies the type of feature to add ( M_CONSTRUCTED or M_MEASURED) or specifies to modify a feature ( M_MODIFY). - Specifies the geometric shape of the feature to add. - Specifies the label of the feature. - Specifies the operation to use to build the feature. - Specifies the array that holds the label of every feature to use to construct the feature. - Specifies the array that holds the index of every subfeature to use to construct the feature. - Specifies the size of the arrays that hold the information that will be used to construct the feature ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a feature to, or modify a feature of, the metrology template of a metrology context. - Specifies the identifier of the metrology context containing the template. - Specifies the type of feature to add ( M_CONSTRUCTED or M_MEASURED) or specifies to modify a feature ( M_MODIFY). - Specifies the geometric shape of the feature to add. - Specifies the label of the feature. - Specifies the operation to use to build the feature. - Specifies the array that holds the label of every feature to use to construct the feature. - Specifies the array that holds the index of every subfeature to use to construct the feature. - Specifies the size of the arrays that hold the information that will be used to construct the feature ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a geometric tolerance to or modify a geometric tolerance of the metrology template of the metrology context. - Specifies the identifier of the metrology context. - Specifies the type of geometric tolerance to add. - Specifies the label of the target tolerance. - Specifies the minimum value of the geometric tolerance. - Specifies the maximum value of the geometric tolerance. - Specifies the array that holds the label values of the features whose relationship to validate. - Specifies the array that holds the index values of the multiple features' subfeatures whose relationship the added tolerance will validate. - Specifies the size of the arrays that hold the information that will be used to add the geometric tolerance ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a geometric tolerance to or modify a geometric tolerance of the metrology template of the metrology context. - Specifies the identifier of the metrology context. - Specifies the type of geometric tolerance to add. - Specifies the label of the target tolerance. - Specifies the minimum value of the geometric tolerance. - Specifies the maximum value of the geometric tolerance. - Specifies the array that holds the label values of the features whose relationship to validate. - Specifies the array that holds the index values of the multiple features' subfeatures whose relationship the added tolerance will validate. - Specifies the size of the arrays that hold the information that will be used to add the geometric tolerance ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a geometric tolerance to or modify a geometric tolerance of the metrology template of the metrology context. - Specifies the identifier of the metrology context. - Specifies the type of geometric tolerance to add. - Specifies the label of the target tolerance. - Specifies the minimum value of the geometric tolerance. - Specifies the maximum value of the geometric tolerance. - Specifies the array that holds the label values of the features whose relationship to validate. - Specifies the array that holds the index values of the multiple features' subfeatures whose relationship the added tolerance will validate. - Specifies the size of the arrays that hold the information that will be used to add the geometric tolerance ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a geometric tolerance to or modify a geometric tolerance of the metrology template of the metrology context. - Specifies the identifier of the metrology context. - Specifies the type of geometric tolerance to add. - Specifies the label of the target tolerance. - Specifies the minimum value of the geometric tolerance. - Specifies the maximum value of the geometric tolerance. - Specifies the array that holds the label values of the features whose relationship to validate. - Specifies the array that holds the index values of the multiple features' subfeatures whose relationship the added tolerance will validate. - Specifies the size of the arrays that hold the information that will be used to add the geometric tolerance ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Add a geometric tolerance to or modify a geometric tolerance of the metrology template of the metrology context. - Specifies the identifier of the metrology context. - Specifies the type of geometric tolerance to add. - Specifies the label of the target tolerance. - Specifies the minimum value of the geometric tolerance. - Specifies the maximum value of the geometric tolerance. - Specifies the array that holds the label values of the features whose relationship to validate. - Specifies the array that holds the index values of the multiple features' subfeatures whose relationship the added tolerance will validate. - Specifies the size of the arrays that hold the information that will be used to add the geometric tolerance ( FeatureLabelArrayPtr and SubFeatureIndexArrayPtr). - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate a metrology context or a derived metrology region object. - Specifies the system on which to allocate the metrology context or the derived metrology region object. - Specifies whether to allocate a metrology context or a derived metrology region object. - Specifies the address of the variable in which to write the identifier of the metrology context or the derived metrology region object. - The returned value is the identifier of the metrology context or the derived metrology region object if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a metrology context or a derived metrology region object. - Specifies the system on which to allocate the metrology context or the derived metrology region object. - Specifies whether to allocate a metrology context or a derived metrology region object. - Specifies the address of the variable in which to write the identifier of the metrology context or the derived metrology region object. - The returned value is the identifier of the metrology context or the derived metrology region object if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a metrology result buffer. - Specifies the system on which to allocate the metrology result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the metrology result buffer identifier. - The returned value is the metrology result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a metrology result buffer. - Specifies the system on which to allocate the metrology result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the metrology result buffer identifier. - The returned value is the metrology result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Calculate features and validate geometric tolerances. - Specifies the identifier of the metrology context. - Specifies the identifier of the target image buffer from which to extract edges to calculate physically measured features and validate geometric tolerances. - Specifies the metrology result buffer in which to write the results of the calculation. - Reserved for future expansion and must be set to M_DEFAULT . - - - Control a setting for a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer whose settings you want to control. - Specifies to control the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control a setting for a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer whose settings you want to control. - Specifies to control the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of control to set. - Specifies the required value for the control. - - - Draw specific features or tolerances of a metrology context or of a metrology result. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the metrology result buffer or context from which to extract the features to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of drawing operation to perform. This parameter can be set to the following values: - Specifies the label or index of the result in the metrology result buffer for which to perform the drawing operation, or specifies that you are performing a general drawing operation for the metrology context. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a metrology context, a derived metrology region object, or a metrology result buffer. - Specifies the identifier of the metrology context, derived metrology region object, or metrology result buffer to free. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Get the specified type of results from a MIL metrology result buffer. - Specifies the identifier of the metrology result buffer from which to get results. - Specifies the feature or geometric tolerance for which to get results. - Specifies the type of result to retrieve. - Specifies the address of the first element of the array in which to write the requested information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. - Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. - Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Set or retrieve the name of a feature or tolerance, or retrieve the label or index of a specified feature or tolerance. - Specifies the identifier of the metrology context or result buffer containing the feature or tolerance to read or modify. The metrology context or the metrology result buffer must have been previously allocated on the required system using MmetAlloc or MmetAllocResult, respectively. - Specifies the type of operation to perform. - Specifies the label or index value of the metrology feature or tolerance. - Specifies the name to set or retrieve, depending on the Operation parameter. - Specifies the address at which to write the requested information. - Reserved for future expansion and must be set to M_DEFAULT . - - - Set or retrieve the name of a feature or tolerance, or retrieve the label or index of a specified feature or tolerance. - Specifies the identifier of the metrology context or result buffer containing the feature or tolerance to read or modify. The metrology context or the metrology result buffer must have been previously allocated on the required system using MmetAlloc or MmetAllocResult, respectively. - Specifies the type of operation to perform. - Specifies the label or index value of the metrology feature or tolerance. - Specifies the name to set or retrieve, depending on the Operation parameter. - Specifies the address at which to write the requested information. - Reserved for future expansion and must be set to M_DEFAULT . - - - Set or retrieve the name of a feature or tolerance, or retrieve the label or index of a specified feature or tolerance. - Specifies the identifier of the metrology context or result buffer containing the feature or tolerance to read or modify. The metrology context or the metrology result buffer must have been previously allocated on the required system using MmetAlloc or MmetAllocResult, respectively. - Specifies the type of operation to perform. - Specifies the label or index value of the metrology feature or tolerance. - Specifies the name to set or retrieve, depending on the Operation parameter. - Specifies the address at which to write the requested information. - Reserved for future expansion and must be set to M_DEFAULT . - - - Set or retrieve the name of a feature or tolerance, or retrieve the label or index of a specified feature or tolerance. - Specifies the identifier of the metrology context or result buffer containing the feature or tolerance to read or modify. The metrology context or the metrology result buffer must have been previously allocated on the required system using MmetAlloc or MmetAllocResult, respectively. - Specifies the type of operation to perform. - Specifies the label or index value of the metrology feature or tolerance. - Specifies the name to set or retrieve, depending on the Operation parameter. - Specifies the address at which to write the requested information. - Reserved for future expansion and must be set to M_DEFAULT . - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Put edgels or points from user-supplied arrays into a constructed edgel feature built with external edgels/points. - Specifies the identifier of the metrology context. The metrology context must have been previously allocated with MmetAlloc. - Specifies the label or index of a constructed edgel feature with an M_EXTERNAL_FEATURE build operation. - Specifies the number of edgels/points to add to the constructed edgel feature. - Specifies the address of the array containing the index of the edge chain/pixel chain to which an edgel/point belongs. - Specifies the address of the array containing the X-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the Y-coordinates of the edgels/points. To remove all the edgels/points in the feature, set this parameter to M_NULL . - Specifies the address of the array containing the gradient angle (orientation) of the edgels. If adding points instead of edgels, or removing the edgels/points in the feature, set this parameter to M_NULL . - Reserved for future expansion and must be set to M_NULL . - Specifies whether to automatically calculate the expected gradient angle of the edge at the specified points, when a gradient angle array has not been specified. This parameter must be set to one of the following values: - - - Restore a metrology context from disk. - Specifies the name and path of the file from which to restore the metrology context. - Specifies the system on which to restore the metrology context. - Specifies whether to restore, from the metrology context, the camera calibration context associated with the template reference. - Specifies the address of the variable in which to write the metrology context identifier. - The returned value is the metrology context identifier. If allocation fails, M_NULL is returned. - - - Restore a metrology context from disk. - Specifies the name and path of the file from which to restore the metrology context. - Specifies the system on which to restore the metrology context. - Specifies whether to restore, from the metrology context, the camera calibration context associated with the template reference. - Specifies the address of the variable in which to write the metrology context identifier. - The returned value is the metrology context identifier. If allocation fails, M_NULL is returned. - - - Save a metrology context to a file. - Specifies the name and path of the file in which to save the metrology context. - Specifies the identifier of the metrology context to save. - Specifies whether to save, with the metrology context, the camera calibration context associated with the template reference. - - - Save a metrology context to a file. - Specifies the name and path of the file in which to save the metrology context. - Specifies the identifier of the metrology context to save. - Specifies whether to save, with the metrology context, the camera calibration context associated with the template reference. - - - Set the position of a feature. - Specifies the identifier of the metrology context. - Specifies the label or index of the feature you want to position. Set this parameter to one of the following values. - Specifies the type of transformation that will be used to set the new position of the feature. - Specifies an attribute of the position to set. - Specifies an attribute of the position to set. - Specifies an attribute of the position to set. - Specifies an attribute of the position to set. - Reserved for future expansion and must be set to M_DEFAULT . - - - Set the position of a feature. - Specifies the identifier of the metrology context. - Specifies the label or index of the feature you want to position. Set this parameter to one of the following values. - Specifies the type of transformation that will be used to set the new position of the feature. - Specifies an attribute of the position to set. - Specifies an attribute of the position to set. - Specifies an attribute of the position to set. - Specifies an attribute of the position to set. - Reserved for future expansion and must be set to M_DEFAULT . - - - Set the metrology region that delimits the area from which to establish the feature. - Specifies the identifier of the metrology context containing the template in which to set the metrology region. - Specifies the label or index of the feature that will be established from the area delimited by the metrology region. Set this parameter to one of the following values. - Specifies the label or index of the reference frame feature of the feature for which you are specifying a metrology region. - Specifies the geometric shape of the metrology region. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - - - Set the metrology region that delimits the area from which to establish the feature. - Specifies the identifier of the metrology context containing the template in which to set the metrology region. - Specifies the label or index of the feature that will be established from the area delimited by the metrology region. Set this parameter to one of the following values. - Specifies the label or index of the reference frame feature of the feature for which you are specifying a metrology region. - Specifies the geometric shape of the metrology region. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - Specifies an attribute of the metrology region to set. Its definition is dependent on the geometry chosen. - - - Load, restore, or save a MIL metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the metrology context. - Specifies the MIL version of the metrology context. - Specifies whether to restore, from the file or memory stream, the camera calibration context associated with the template reference, or specifies to save, with the metrology context, the camera calibration context associated with the template reference. - Specifies the address of the variable in which to write or from which to read the identifier of the metrology context. - Specifies the address of the variable in which to write the size of the metrology context, in bytes. - - - Load, restore, or save a MIL metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the metrology context. - Specifies the MIL version of the metrology context. - Specifies whether to restore, from the file or memory stream, the camera calibration context associated with the template reference, or specifies to save, with the metrology context, the camera calibration context associated with the template reference. - Specifies the address of the variable in which to write or from which to read the identifier of the metrology context. - Specifies the address of the variable in which to write the size of the metrology context, in bytes. - - - Load, restore, or save a MIL metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the metrology context. - Specifies the MIL version of the metrology context. - Specifies whether to restore, from the file or memory stream, the camera calibration context associated with the template reference, or specifies to save, with the metrology context, the camera calibration context associated with the template reference. - Specifies the address of the variable in which to write or from which to read the identifier of the metrology context. - Specifies the address of the variable in which to write the size of the metrology context, in bytes. - - - Load, restore, or save a MIL metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the metrology context. - Specifies the MIL version of the metrology context. - Specifies whether to restore, from the file or memory stream, the camera calibration context associated with the template reference, or specifies to save, with the metrology context, the camera calibration context associated with the template reference. - Specifies the address of the variable in which to write or from which to read the identifier of the metrology context. - Specifies the address of the variable in which to write the size of the metrology context, in bytes. - - - Load, restore, or save a MIL metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the metrology context. - Specifies the MIL version of the metrology context. - Specifies whether to restore, from the file or memory stream, the camera calibration context associated with the template reference, or specifies to save, with the metrology context, the camera calibration context associated with the template reference. - Specifies the address of the variable in which to write or from which to read the identifier of the metrology context. - Specifies the address of the variable in which to write the size of the metrology context, in bytes. - - - Load, restore, or save a MIL metrology context from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the metrology context. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the metrology context. - Specifies the MIL version of the metrology context. - Specifies whether to restore, from the file or memory stream, the camera calibration context associated with the template reference, or specifies to save, with the metrology context, the camera calibration context associated with the template reference. - Specifies the address of the variable in which to write or from which to read the identifier of the metrology context. - Specifies the address of the variable in which to write the size of the metrology context, in bytes. - - - Allocate a Model Finder context. - Specifies the system on which to allocate the context. This parameter should be set to one of the following values: - Specifies the type of Model Finder context. This parameter must be set to one of the following values: - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Model Finder context identifier. - The returned value is the Model Finder context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Model Finder context. - Specifies the system on which to allocate the context. This parameter should be set to one of the following values: - Specifies the type of Model Finder context. This parameter must be set to one of the following values: - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Model Finder context identifier. - The returned value is the Model Finder context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Model Finder result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. This parameter should be set to one of the following values: - Specifies the address of the variable in which to write the Model Finder result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Model Finder result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. This parameter should be set to one of the following values: - Specifies the address of the variable in which to write the Model Finder result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a Model Finder context, individual model setting, or Model Finder result buffer setting. - Specifies the Model Finder context or Model Finder result buffer whose settings you want to modify. - Specifies that the Model Finder context, an individual model, or a Model Finder result buffer is controlled. - Specifies the setting to change. - Specifies the setting's new value. - - - Control a Model Finder context, individual model setting, or Model Finder result buffer setting. - Specifies the Model Finder context or Model Finder result buffer whose settings you want to modify. - Specifies that the Model Finder context, an individual model, or a Model Finder result buffer is controlled. - Specifies the setting to change. - Specifies the setting's new value. - - - Add a model to, or delete a model from, a Model Finder context. - Specifies the Model Finder context to which to add, or from which to delete, the model. - Specifies the type of model to define when adding models to the context, or specifies to delete a model from the Model Finder context. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - - - Add a model to, or delete a model from, a Model Finder context. - Specifies the Model Finder context to which to add, or from which to delete, the model. - Specifies the type of model to define when adding models to the context, or specifies to delete a model from the Model Finder context. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - - - Defines a model from a file and adds it to a Model Finder context. - Specifies the identifier of the Model Finder context. - Specifies the type of file from which to define the model. - Specifies the name and path of the file from which to define the model. - Reserved for future expansion. Set this parameter to M_DEFAULT . - - - Draw specific features of models or result occurrences an image buffer or 2D graphics list. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the Model Finder context or result buffer from which to extract the features to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Specifies the index of the model in the specified Model Finder context, or of the result occurrence. - Specifies where in the destination image buffer to draw. - - - Search for the model(s) that are in the specified Model Finder context in a target image buffer, Edge Finder result buffer, or M_SHAPE_SEGMENT Model Finder result buffer. - Specifies the Model Finder context to use for the search. - Specifies the target image, Edge Finder result buffer, or M_SHAPE_SEGMENT Model Finder result buffer in which to search for the model(s). - Specifies the result buffer in which to write the results of the search. If you are using an M_SHAPE_... type of Model Finder context, you need to specify a corresponding M_SHAPE_... type of Model Finder result buffer. - - - Free a Model Finder context or a result buffer. - Specifies the identifier of the Model Finder context or result buffer to free. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a Model Finder result buffer. - Specifies the identifier of the Model Finder result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified Model Finder context, a specified model, or a specified result buffer. - Specifies the Model Finder context or Model Finder result buffer about which to inquire information. - Specifies that information will be inquired about the Model Finder context, an individual model, or a Model Finder result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Mask regions of a model. - Specifies the Model Finder context of the model to mask. - Specifies the individual model for which to create a mask. - Specifies the identifier of the image buffer used to identify the masked pixels in the model. - Specifies which type of mask to employ. - Reserved for future expansion and must be set to M_DEFAULT . - - - Preprocess a Model Finder context. - Specifies the Model Finder context of the model to preprocess. - Specifies whether to perform or undo the preprocessing of the model context. - - - Restore a Model Finder context from disk. - Specifies the name and path of the file from which to restore the Model Finder context. - Specifies the system on which to restore the Model Finder context. - Specifies whether to restore, from the Model Finder context, the camera calibration contexts associated with the models. - Specifies the address of the variable in which to write the Model Finder context identifier. - The returned value is the Model Finder context identifier. If allocation fails, M_NULL is returned. - - - Restore a Model Finder context from disk. - Specifies the name and path of the file from which to restore the Model Finder context. - Specifies the system on which to restore the Model Finder context. - Specifies whether to restore, from the Model Finder context, the camera calibration contexts associated with the models. - Specifies the address of the variable in which to write the Model Finder context identifier. - The returned value is the Model Finder context identifier. If allocation fails, M_NULL is returned. - - - Save a Model Finder context to a file. - Specifies the name and path of the file in which to save the Model Finder context; it is recommended that you use the MMF file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the Model Finder context to save. - Specifies whether to save, with the Model Finder context, the camera calibration contexts associated with the models. - - - Save a Model Finder context to a file. - Specifies the name and path of the file in which to save the Model Finder context; it is recommended that you use the MMF file extension for easier use with other Matrox Imaging software products. - Specifies the identifier of the Model Finder context to save. - Specifies whether to save, with the Model Finder context, the camera calibration contexts associated with the models. - - - Load, restore, or save a Model Finder context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Model Finder context. - Specifies the operation to perform on the Model Finder context. - Specifies the type of stream in which to store/from which to restore the Model Finder context. - Specifies the MIL version of the Model Finder context. - Specifies whether to restore, from the file or memory stream, the camera calibration contexts associated with the models, or specifies to save, with the Model Finder context, the camera calibration contexts associated with the models. - Specifies the address of the variable in which to write or from which to read the identifier of the Model Finder context. - Specifies the address of the variable in which to write the size of the Model Finder context, in bytes. - - - Load, restore, or save a Model Finder context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Model Finder context. - Specifies the operation to perform on the Model Finder context. - Specifies the type of stream in which to store/from which to restore the Model Finder context. - Specifies the MIL version of the Model Finder context. - Specifies whether to restore, from the file or memory stream, the camera calibration contexts associated with the models, or specifies to save, with the Model Finder context, the camera calibration contexts associated with the models. - Specifies the address of the variable in which to write or from which to read the identifier of the Model Finder context. - Specifies the address of the variable in which to write the size of the Model Finder context, in bytes. - - - Load, restore, or save a Model Finder context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Model Finder context. - Specifies the operation to perform on the Model Finder context. - Specifies the type of stream in which to store/from which to restore the Model Finder context. - Specifies the MIL version of the Model Finder context. - Specifies whether to restore, from the file or memory stream, the camera calibration contexts associated with the models, or specifies to save, with the Model Finder context, the camera calibration contexts associated with the models. - Specifies the address of the variable in which to write or from which to read the identifier of the Model Finder context. - Specifies the address of the variable in which to write the size of the Model Finder context, in bytes. - - - Load, restore, or save a Model Finder context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Model Finder context. - Specifies the operation to perform on the Model Finder context. - Specifies the type of stream in which to store/from which to restore the Model Finder context. - Specifies the MIL version of the Model Finder context. - Specifies whether to restore, from the file or memory stream, the camera calibration contexts associated with the models, or specifies to save, with the Model Finder context, the camera calibration contexts associated with the models. - Specifies the address of the variable in which to write or from which to read the identifier of the Model Finder context. - Specifies the address of the variable in which to write the size of the Model Finder context, in bytes. - - - Load, restore, or save a Model Finder context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Model Finder context. - Specifies the operation to perform on the Model Finder context. - Specifies the type of stream in which to store/from which to restore the Model Finder context. - Specifies the MIL version of the Model Finder context. - Specifies whether to restore, from the file or memory stream, the camera calibration contexts associated with the models, or specifies to save, with the Model Finder context, the camera calibration contexts associated with the models. - Specifies the address of the variable in which to write or from which to read the identifier of the Model Finder context. - Specifies the address of the variable in which to write the size of the Model Finder context, in bytes. - - - Load, restore, or save a Model Finder context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Model Finder context. - Specifies the operation to perform on the Model Finder context. - Specifies the type of stream in which to store/from which to restore the Model Finder context. - Specifies the MIL version of the Model Finder context. - Specifies whether to restore, from the file or memory stream, the camera calibration contexts associated with the models, or specifies to save, with the Model Finder context, the camera calibration contexts associated with the models. - Specifies the address of the variable in which to write or from which to read the identifier of the Model Finder context. - Specifies the address of the variable in which to write the size of the Model Finder context, in bytes. - - - Allocate a MIL utility object for a Distributed MIL publishing application. - Specifies the system on which to allocate the MIL utility object. - Specifies the type of MIL utility object to allocate. - Specifies the initialization of the MIL utility object. - Specifies the address in which to return the identifier of the allocated MIL utility object. Since MobjAlloc also returns the identifier, you can set this parameter to M_NULL . - The returned value is the MIL utility object identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL utility object for a Distributed MIL publishing application. - Specifies the system on which to allocate the MIL utility object. - Specifies the type of MIL utility object to allocate. - Specifies the initialization of the MIL utility object. - Specifies the address in which to return the identifier of the allocated MIL utility object. Since MobjAlloc also returns the identifier, you can set this parameter to M_NULL . - The returned value is the MIL utility object identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a MIL object's settings and associate information with a MIL object. - Specifies the identifier of the MIL object to control. The MIL object can be a MIL utility object (allocated using MobjAlloc) or any other MIL object, except for MIL objects allocated using MfuncAlloc. - Specifies the type of MIL object setting to control. - Specifies the MIL object setting's new value. - - - Control a MIL object's settings and associate information with a MIL object. - Specifies the identifier of the MIL object to control. The MIL object can be a MIL utility object (allocated using MobjAlloc) or any other MIL object, except for MIL objects allocated using MfuncAlloc. - Specifies the type of MIL object setting to control. - Specifies the MIL object setting's new value. - - - Free an object. - Specifies the identifier of the object. - - - Get information about a hook event. - Specifies the object-related event identifier received by the hook-handler function (see MobjHookFunction). - Specifies the type of information about which to inquire. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Hook a function to an object-related event. - Specifies the identifier of the object on which to hook a function. - Specifies the object-related event on which to hook the function. - Specifies the address of the function that should be called when the specified event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Inquire about a MIL object setting or information associated with the MIL object. - Specifies the identifier of the MIL object about which to inquire. The MIL object can be a MIL utility object (allocated using MobjAlloc) or any other MIL object, except for MIL objects allocated using MfuncAlloc. - Specifies the MIL object setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL object setting or information associated with the MIL object. - Specifies the identifier of the MIL object about which to inquire. The MIL object can be a MIL utility object (allocated using MobjAlloc) or any other MIL object, except for MIL objects allocated using MfuncAlloc. - Specifies the MIL object setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL object setting or information associated with the MIL object. - Specifies the identifier of the MIL object about which to inquire. The MIL object can be a MIL utility object (allocated using MobjAlloc) or any other MIL object, except for MIL objects allocated using MfuncAlloc. - Specifies the MIL object setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Reads data from a message sent to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable in which the message is to be written. - Specifies the size of the array pointed to by MessagePtr, in bytes. - Specifies the address of the variable in which the size of the message to be read will be written. - Specifies the address of the variable in which the message tag associated with the message will be written. - Specifies the address of the variable in which the status of the read operation will be written. - Specifies additional options for the read operation. - The returned value is the same as the value written in MessageOutSizePtr. - - - Reads data from a message sent to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable in which the message is to be written. - Specifies the size of the array pointed to by MessagePtr, in bytes. - Specifies the address of the variable in which the size of the message to be read will be written. - Specifies the address of the variable in which the message tag associated with the message will be written. - Specifies the address of the variable in which the status of the read operation will be written. - Specifies additional options for the read operation. - The returned value is the same as the value written in MessageOutSizePtr. - - - Reads data from a message sent to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable in which the message is to be written. - Specifies the size of the array pointed to by MessagePtr, in bytes. - Specifies the address of the variable in which the size of the message to be read will be written. - Specifies the address of the variable in which the message tag associated with the message will be written. - Specifies the address of the variable in which the status of the read operation will be written. - Specifies additional options for the read operation. - The returned value is the same as the value written in MessageOutSizePtr. - - - Reads data from a message sent to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable in which the message is to be written. - Specifies the size of the array pointed to by MessagePtr, in bytes. - Specifies the address of the variable in which the size of the message to be read will be written. - Specifies the address of the variable in which the message tag associated with the message will be written. - Specifies the address of the variable in which the status of the read operation will be written. - Specifies additional options for the read operation. - The returned value is the same as the value written in MessageOutSizePtr. - - - Reads data from a message sent to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable in which the message is to be written. - Specifies the size of the array pointed to by MessagePtr, in bytes. - Specifies the address of the variable in which the size of the message to be read will be written. - Specifies the address of the variable in which the message tag associated with the message will be written. - Specifies the address of the variable in which the status of the read operation will be written. - Specifies additional options for the read operation. - The returned value is the same as the value written in MessageOutSizePtr. - - - Reads data from a message sent to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable in which the message is to be written. - Specifies the size of the array pointed to by MessagePtr, in bytes. - Specifies the address of the variable in which the size of the message to be read will be written. - Specifies the address of the variable in which the message tag associated with the message will be written. - Specifies the address of the variable in which the status of the read operation will be written. - Specifies additional options for the read operation. - The returned value is the same as the value written in MessageOutSizePtr. - - - Reads data from a message sent to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable in which the message is to be written. - Specifies the size of the array pointed to by MessagePtr, in bytes. - Specifies the address of the variable in which the size of the message to be read will be written. - Specifies the address of the variable in which the message tag associated with the message will be written. - Specifies the address of the variable in which the status of the read operation will be written. - Specifies additional options for the read operation. - The returned value is the same as the value written in MessageOutSizePtr. - - - Reads data from a message sent to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable in which the message is to be written. - Specifies the size of the array pointed to by MessagePtr, in bytes. - Specifies the address of the variable in which the size of the message to be read will be written. - Specifies the address of the variable in which the message tag associated with the message will be written. - Specifies the address of the variable in which the status of the read operation will be written. - Specifies additional options for the read operation. - The returned value is the same as the value written in MessageOutSizePtr. - - - Writes a message to the message mailbox. - Specifies the identifier of the message mailbox. - Specifies the address of the variable of the user message to write. - Specifies the length of the message to write, in Bytes. - Specifies a user-defined tag to send with the message. - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate an OCR font context. - Specifies the system on which to allocate the OCR font context. - Specifies the OCR font context type and the type of its font. - Specifies how many characters can be stored in the OCR font context. - Specifies the width of the characters in the OCR font context, in pixels. - Specifies the height of the characters in the OCR font context, in pixels. - Specifies the distance between the edge of each character and their surrounding cell, along the X-axis, in pixels. - Specifies the distance between the edge of each character and their surrounding cell, along the Y-axis, in pixels. - Specifies the width of the widest character in the font without its surrounding cell, in pixels. - Specifies the height of the tallest character in the font without its surrounding cell, in pixels. - Specifies the maximum thickness (stroke width) of the characters in the OCR font context. - Specifies the maximum length of the string that can be read or verified using the OCR font context. - Specifies whether the characters are brighter than the background. - Specifies the address of the variable to which the OCR font context identifier is to be written. - The returned value is the OCR font context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an OCR font context. - Specifies the system on which to allocate the OCR font context. - Specifies the OCR font context type and the type of its font. - Specifies how many characters can be stored in the OCR font context. - Specifies the width of the characters in the OCR font context, in pixels. - Specifies the height of the characters in the OCR font context, in pixels. - Specifies the distance between the edge of each character and their surrounding cell, along the X-axis, in pixels. - Specifies the distance between the edge of each character and their surrounding cell, along the Y-axis, in pixels. - Specifies the width of the widest character in the font without its surrounding cell, in pixels. - Specifies the height of the tallest character in the font without its surrounding cell, in pixels. - Specifies the maximum thickness (stroke width) of the characters in the OCR font context. - Specifies the maximum length of the string that can be read or verified using the OCR font context. - Specifies whether the characters are brighter than the background. - Specifies the address of the variable to which the OCR font context identifier is to be written. - The returned value is the OCR font context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an OCR result buffer. - Specifies the system on which to allocate the OCR result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable to which the OCR result buffer identifier is to be written. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate an OCR result buffer. - Specifies the system on which to allocate the OCR result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable to which the OCR result buffer identifier is to be written. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Calibrate the OCR font context's character size and target spacing to match the characters in a sample target image. - Specifies the identifier of the sample target image buffer. - Specifies the identifier of the OCR font context to be calibrated. - Specifies the character string present in the sample target image. This string must be null-terminated. - Specifies the minimum width of the characters in the sample target image, in pixels. - Specifies the maximum width of the characters in the sample target image, in pixels. - Specifies the increment to use when searching for the character width between TargetCharSizeXMin and TargetCharSizeXMax. Note that very small step sizes should only be used within small ranges, otherwise application performance can be adversely affected. - Specifies the minimum height of the characters in the sample target image, in pixels. - Specifies the maximum height of the characters in the sample target image, in pixels. - Specifies the increment to use when searching for the character height between TargetCharSizeYMin and TargetCharSizeYMax. Note that very small step sizes should only be used within small ranges, otherwise application performance can be adversely affected. - Specifies the operation to be performed. - - - Control an OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer to control. - Specifies the type of control to set. - Specifies the required value for the control. - - - Control an OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer to control. - Specifies the type of control to set. - Specifies the required value for the control. - - - Copy a font character to or from an image buffer. - Specifies the identifier of the image buffer to/from which characters are copied. - Specifies the identifier of the OCR font context to/from which the characters are copied. - Specifies the direction of the copy operation. - Specifies a string containing the list of characters to be copied. - - - Copy a font character to or from an image buffer. - Specifies the identifier of the image buffer to/from which characters are copied. - Specifies the identifier of the OCR font context to/from which the characters are copied. - Specifies the direction of the copy operation. - Specifies a string containing the list of characters to be copied. - - - Draw specific features of OCR fonts or OCR result occurrences in an image buffer or 2D graphics list. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the OCR Font context or result buffer from which to extract the features to draw. The OCR Font context or result buffer must have been previously allocated using MocrAllocFont or MocrAllocResult. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies a string containing a list of valid characters to draw when drawing an OCR font. To draw all the characters in the font or to draw results, this parameter should be set to M_NULL . - Reserved for future expansion and must be set to M_DEFAULT . - - - Draw specific features of OCR fonts or OCR result occurrences in an image buffer or 2D graphics list. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the OCR Font context or result buffer from which to extract the features to draw. The OCR Font context or result buffer must have been previously allocated using MocrAllocFont or MocrAllocResult. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies a string containing a list of valid characters to draw when drawing an OCR font. To draw all the characters in the font or to draw results, this parameter should be set to M_NULL . - Reserved for future expansion and must be set to M_DEFAULT . - - - Free an OCR font or result buffer. - Specifies the identifier of the OCR font context, or result buffer to free. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Get the specified type of result(s) from an OCR result buffer. - Specifies the identifier of the OCR result buffer from which to retrieve results. - Specifies the type of result(s) to retrieve. The following values are available to retrieve results from a read or a verify operation, unless otherwise specified. - Specifies the address in which to write the results. - - - Hook a function to an event. - Specifies the identifier of the font. - Specifies the event type. - Specifies the address of the function that should be called when the event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - This function returns a NULLpointer. - - - Import character representations into an OCR font context. - Specifies the name and path of the file from which to import the character representation. - Specifies how the data is stored in the file. This parameter can be set to one of the following values: - Specifies the type of import operation to be performed. This parameter must be set to the following value: - Specifies the ASCII characters to associate with the font character representations in the file. This parameter can be set to one of the following values: - Specifies the identifier of the OCR font context. - - - Import character representations into an OCR font context. - Specifies the name and path of the file from which to import the character representation. - Specifies how the data is stored in the file. This parameter can be set to one of the following values: - Specifies the type of import operation to be performed. This parameter must be set to the following value: - Specifies the ASCII characters to associate with the font character representations in the file. This parameter can be set to one of the following values: - Specifies the identifier of the OCR font context. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about OCR font context or an OCR result buffer setting. - Specifies the identifier of the OCR font context or the OCR result buffer from which to read information. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Invert or resize the font of an OCR font context to match the target image characters. - Specifies the identifier of the OCR font context to modify. - Specifies the type of operation to perform. - Specifies the interpolation mode for the function. - - - Preprocess an OCR font context. - Specifies the OCR font context identifier. - Specifies the type of operation to perform. This parameter must be set to the following value. - - - Read an unknown string from a target image. - Specifies the identifier of the image which contains the string to be read. - Specifies the identifier of the OCR font context to use to read the string from the target image. - Specifies the OCR result buffer in which to place results of the read operation. - - - Restore an OCR font context, font constraint data, or control data from file. - Specifies the path and name of the file from which to restore the MIL OCR font context (for example, "C:\mydirectory\myfile"). - Specifies which type of OCR font context data to restore. - Specifies the system on which the OCR font context is allocated. - Specifies the address of the variable to/from which the font identifier is to be written/read. - Returns the identifier of the existing or newly allocated OCR font context. If allocation fails, M_NULL is returned as the identifier. - - - Restore an OCR font context, font constraint data, or control data from file. - Specifies the path and name of the file from which to restore the MIL OCR font context (for example, "C:\mydirectory\myfile"). - Specifies which type of OCR font context data to restore. - Specifies the system on which the OCR font context is allocated. - Specifies the address of the variable to/from which the font identifier is to be written/read. - Returns the identifier of the existing or newly allocated OCR font context. If allocation fails, M_NULL is returned as the identifier. - - - Save an existing OCR font context to disk. - Specifies the name and path of the file in which to save the font data. - Specifies which data to save to disk. - Specifies the OCR font context to be saved. - - - Save an existing OCR font context to disk. - Specifies the name and path of the file in which to save the font data. - Specifies which data to save to disk. - Specifies the OCR font context to be saved. - - - Set character position constraints. - Specifies the OCR font context identifier with which to associate the constraints. - Specifies the character position in the string for which a constraint is being set. - Specifies the type of character that can appear at the specified string position. - Specifies that any character matching the given CharPosType will be accepted as valid, or explicitly lists valid characters for the specified position. - - - Set character position constraints. - Specifies the OCR font context identifier with which to associate the constraints. - Specifies the character position in the string for which a constraint is being set. - Specifies the type of character that can appear at the specified string position. - Specifies that any character matching the given CharPosType will be accepted as valid, or explicitly lists valid characters for the specified position. - - - Load, restore, or save an OCR font context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the OCR font context. - Specifies the operation to perform on the OCR font context. - Specifies the type of stream in which to store/from which to restore the OCR font context. - Specifies the MIL version of the OCR font context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the OCR font context. - Specifies the address of the variable in which to write the size of the OCR font context, in bytes. - - - Load, restore, or save an OCR font context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the OCR font context. - Specifies the operation to perform on the OCR font context. - Specifies the type of stream in which to store/from which to restore the OCR font context. - Specifies the MIL version of the OCR font context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the OCR font context. - Specifies the address of the variable in which to write the size of the OCR font context, in bytes. - - - Load, restore, or save an OCR font context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the OCR font context. - Specifies the operation to perform on the OCR font context. - Specifies the type of stream in which to store/from which to restore the OCR font context. - Specifies the MIL version of the OCR font context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the OCR font context. - Specifies the address of the variable in which to write the size of the OCR font context, in bytes. - - - Load, restore, or save an OCR font context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the OCR font context. - Specifies the operation to perform on the OCR font context. - Specifies the type of stream in which to store/from which to restore the OCR font context. - Specifies the MIL version of the OCR font context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the OCR font context. - Specifies the address of the variable in which to write the size of the OCR font context, in bytes. - - - Load, restore, or save an OCR font context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the OCR font context. - Specifies the operation to perform on the OCR font context. - Specifies the type of stream in which to store/from which to restore the OCR font context. - Specifies the MIL version of the OCR font context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the OCR font context. - Specifies the address of the variable in which to write the size of the OCR font context, in bytes. - - - Load, restore, or save an OCR font context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the OCR font context. - Specifies the operation to perform on the OCR font context. - Specifies the type of stream in which to store/from which to restore the OCR font context. - Specifies the MIL version of the OCR font context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the OCR font context. - Specifies the address of the variable in which to write the size of the OCR font context, in bytes. - - - Verify a known string in an image. - Specifies the identifier of the target image containing the string to be verified. - Specifies the identifier of the OCR font context to use to verify the string in the target image. - Specifies the character string to be verified in the sample target image. - Specifies the OCR result buffer in which to place the verification results. - - - Allocate a Pattern Matching context. - Specifies the system on which to allocate the Pattern Matching context. - Specifies the type of Pattern Matching context. - Reserved for future expansion. - Specifies the address in which to write the Pattern Matching context identifier. - The returned value is the Pattern Matching context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Pattern Matching context. - Specifies the system on which to allocate the Pattern Matching context. - Specifies the type of Pattern Matching context. - Reserved for future expansion. - Specifies the address in which to write the Pattern Matching context identifier. - The returned value is the Pattern Matching context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Pattern Matching result buffer. - Specifies the system on which to allocate the result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Pattern Matching result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a Pattern Matching result buffer. - Specifies the system on which to allocate the result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the Pattern Matching result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a setting of a Pattern Matching context, one or all models, or Pattern Matching result buffer. - Specifies the Pattern Matching context or Pattern Matching result buffer whose settings you want to modify. - Specifies to control a Pattern Matching context, an individual model, or a Pattern Matching result buffer. - Specifies the setting to change. - Specifies the setting's new value. - - - Control a setting of a Pattern Matching context, one or all models, or Pattern Matching result buffer. - Specifies the Pattern Matching context or Pattern Matching result buffer whose settings you want to modify. - Specifies to control a Pattern Matching context, an individual model, or a Pattern Matching result buffer. - Specifies the setting to change. - Specifies the setting's new value. - - - Add one or more models to, or delete a model from, a Pattern Matching context. - Specifies the Pattern Matching context to which to add, or from which to delete, the model. - Specifies the type of the model to define when adding models to the context, or specifies to delete a model from the Pattern Matching context. - Specifies the identifier of the image buffer from which to define the models, or the Pattern Matching context from which to copy a model. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies an attribute of the model to add. Its definition is dependent on the model type chosen. - Specifies the speed of the allocation or the interpolation mode to use, depending on the model type chosen. - - - Draw specific features of the model or result occurrence in an image buffer or 2D graphics list. - Specifies the identifier of the 2D graphics context to use. This parameter must be set to one of the following values: - Specifies the Pattern Matching context or result buffer identifier from which to extract the features to draw. - Specifies the identifier of the destination image buffer or 2D graphics list into which to draw. - Specifies the type of operation to perform. - Specifies whether to draw a specific result occurrence or model, or to draw all of them. - Specifies where to draw a model. - - - Find a pattern matching model(s) in the target image buffer. - Specifies the Pattern Matching context identifier to use when finding the search model in the target image. - Specifies the identifier of the target image. - Specifies the identifier of the pattern matching result buffer in which to store results. - - - Free a Pattern Matching context or a result buffer. - Specifies the identifier of the Pattern Matching context or result buffer to free. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies that information will be inquired about the Pattern Matching context, an individual model, or a Pattern Matching result buffer. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies that information will be inquired about the Pattern Matching context, an individual model, or a Pattern Matching result buffer. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies that information will be inquired about the Pattern Matching context, an individual model, or a Pattern Matching result buffer. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies that information will be inquired about the Pattern Matching context, an individual model, or a Pattern Matching result buffer. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Mask areas of a model in a Pattern Matching context. - Specifies the identifier of the Pattern Matching context containing the model to mask. - Specifies the individual model on which to apply the mask. - Specifies the identifier of the image buffer to use as a mask. - Specifies which type of mask to employ. - Reserved for future expansion. - - - Preprocess a Pattern Matching context. - Specifies the identifier of the Pattern Matching context to preprocess. - Reserved for future expansion. Set this parameter to M_DEFAULT . - Specifies the identifier of a typical target image. - - - Restore a Pattern Matching context from disk. - Specifies the name and path of the file from which to restore the model. - Specifies the system on which to restore the model. - Reserved for future expansion. - Specifies the address of the variable in which to write the Pattern Matching context identifier. - The returned value is the Pattern Matching context identifier. If allocation fails, M_NULL is returned. - - - Restore a Pattern Matching context from disk. - Specifies the name and path of the file from which to restore the model. - Specifies the system on which to restore the model. - Reserved for future expansion. - Specifies the address of the variable in which to write the Pattern Matching context identifier. - The returned value is the Pattern Matching context identifier. If allocation fails, M_NULL is returned. - - - Save a Pattern Matching context to disk. - Specifies the name and path of the file in which to save the model. - Specifies the identifier of the Pattern Matching context to save. - Reserved for future expansion. - - - Save a Pattern Matching context to disk. - Specifies the name and path of the file in which to save the model. - Specifies the identifier of the Pattern Matching context to save. - Reserved for future expansion. - - - Load, restore, or save a Pattern Matching context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Pattern Matching context. - Specifies the operation to perform on the Pattern Matching context. - Specifies the type of stream in which to store/from which to restore the Pattern Matching context. - Specifies the MIL version of the Pattern Matching context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the Pattern Matching context. - Specifies the address of the variable in which to write the size of the Pattern Matching context, in bytes. - - - Load, restore, or save a Pattern Matching context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Pattern Matching context. - Specifies the operation to perform on the Pattern Matching context. - Specifies the type of stream in which to store/from which to restore the Pattern Matching context. - Specifies the MIL version of the Pattern Matching context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the Pattern Matching context. - Specifies the address of the variable in which to write the size of the Pattern Matching context, in bytes. - - - Load, restore, or save a Pattern Matching context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Pattern Matching context. - Specifies the operation to perform on the Pattern Matching context. - Specifies the type of stream in which to store/from which to restore the Pattern Matching context. - Specifies the MIL version of the Pattern Matching context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the Pattern Matching context. - Specifies the address of the variable in which to write the size of the Pattern Matching context, in bytes. - - - Load, restore, or save a Pattern Matching context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Pattern Matching context. - Specifies the operation to perform on the Pattern Matching context. - Specifies the type of stream in which to store/from which to restore the Pattern Matching context. - Specifies the MIL version of the Pattern Matching context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the Pattern Matching context. - Specifies the address of the variable in which to write the size of the Pattern Matching context, in bytes. - - - Load, restore, or save a Pattern Matching context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Pattern Matching context. - Specifies the operation to perform on the Pattern Matching context. - Specifies the type of stream in which to store/from which to restore the Pattern Matching context. - Specifies the MIL version of the Pattern Matching context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the Pattern Matching context. - Specifies the address of the variable in which to write the size of the Pattern Matching context, in bytes. - - - Load, restore, or save a Pattern Matching context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the Pattern Matching context. - Specifies the operation to perform on the Pattern Matching context. - Specifies the type of stream in which to store/from which to restore the Pattern Matching context. - Specifies the MIL version of the Pattern Matching context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the Pattern Matching context. - Specifies the address of the variable in which to write the size of the Pattern Matching context, in bytes. - - - Allocate a registration context. - Specifies the system on which to allocate the context. - Specifies the type of registration context. This parameter defines the registration operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the registration context identifier. - The returned value is the registration context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a registration context. - Specifies the system on which to allocate the context. - Specifies the type of registration context. This parameter defines the registration operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the registration context identifier. - The returned value is the registration context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a registration result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. This parameter should be set to one of the following values. - Specifies the address of the variable in which to write the registration result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a registration result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the type of result buffer to allocate. This parameter should be set to one of the following values. - Specifies the address of the variable in which to write the registration result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Perform the registration operation specified by the registration context on the input images. - Specifies the context to use for the registration; this establishes the operation to perform. The context must have been allocated using MregAlloc. - Specifies the address of the array containing the buffer identifiers of the input images. - Specifies the identifier of the registration result buffer or image buffer in which to write the results of the registration operation. - Specifies the size of the specified image array. - Specifies the operation mode. - - - Perform the registration operation specified by the registration context on the input images. - Specifies the context to use for the registration; this establishes the operation to perform. The context must have been allocated using MregAlloc. - Specifies the address of the array containing the buffer identifiers of the input images. - Specifies the identifier of the registration result buffer or image buffer in which to write the results of the registration operation. - Specifies the size of the specified image array. - Specifies the operation mode. - - - Control a registration context, registration element, or registration result buffer setting. - Specifies the identifier of the registration context or registration result buffer whose settings you can modify; you can only control settings of correlation-stitching or photometric stereo types of registration result buffers. - Specifies that a registration context, an individual registration element (of a correlation-stitching or photometric stereo registration context), or a registration result buffer is controlled. - Specifies the setting to change. - Specifies the setting's new value. - - - Control a registration context, registration element, or registration result buffer setting. - Specifies the identifier of the registration context or registration result buffer whose settings you can modify; you can only control settings of correlation-stitching or photometric stereo types of registration result buffers. - Specifies that a registration context, an individual registration element (of a correlation-stitching or photometric stereo registration context), or a registration result buffer is controlled. - Specifies the setting to change. - Specifies the setting's new value. - - - Draw specific features of the registration results in an image buffer or 2D graphics list. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values. Note that while this parameter is required for calling MregDraw, when using an M_EXTENDED_DEPTH_OF_FIELD_RESULT result buffer, this parameter will not affect the function. - Specifies the identifier of the registration result buffer from which to extract the results to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. This parameter can be set to one of the following: - Specifies the registration element that is associated with the image whose features you want to draw when drawing results of an M_STITCHING_RESULT registration result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - - - Free a registration context or a registration result buffer. - Specifies the identifier of the registration context or registration result buffer to free. - - - Get the specified type of result(s) from a registration result buffer. - Specifies the identifier of the registration result buffer from which to retrieve results. - Specifies which results to get. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - - - Get the specified type of result(s) from a registration result buffer. - Specifies the identifier of the registration result buffer from which to retrieve results. - Specifies which results to get. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - - - Get the specified type of result(s) from a registration result buffer. - Specifies the identifier of the registration result buffer from which to retrieve results. - Specifies which results to get. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - - - Get the specified type of result(s) from a registration result buffer. - Specifies the identifier of the registration result buffer from which to retrieve results. - Specifies which results to get. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - - - Get the specified type of result(s) from a registration result buffer. - Specifies the identifier of the registration result buffer from which to retrieve results. - Specifies which results to get. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - - - Get the specified type of result(s) from a registration result buffer. - Specifies the identifier of the registration result buffer from which to retrieve results. - Specifies which results to get. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write the requested information. - - - Inquire about a registration context, registration element, or registration result buffer setting. - Specifies the identifier of the registration context or registration result buffer about which to inquire. - Specifies that a registration context, an individual registration element (of a correlation-stitching or photometric stereo registration context), or a registration result buffer is inquired. - Specifies the setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a registration context, registration element, or registration result buffer setting. - Specifies the identifier of the registration context or registration result buffer about which to inquire. - Specifies that a registration context, an individual registration element (of a correlation-stitching or photometric stereo registration context), or a registration result buffer is inquired. - Specifies the setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a registration context, registration element, or registration result buffer setting. - Specifies the identifier of the registration context or registration result buffer about which to inquire. - Specifies that a registration context, an individual registration element (of a correlation-stitching or photometric stereo registration context), or a registration result buffer is inquired. - Specifies the setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a registration context, registration element, or registration result buffer setting. - Specifies the identifier of the registration context or registration result buffer about which to inquire. - Specifies that a registration context, an individual registration element (of a correlation-stitching or photometric stereo registration context), or a registration result buffer is inquired. - Specifies the setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Restore a registration context or result buffer from disk. - Specifies the name and path of the file from which to restore the registration context. - Specifies the system on which to restore the registration context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the registration context or result buffer identifier. - The returned value is the registration context or result buffer identifier. If allocation fails, M_NULL is returned. - - - Restore a registration context or result buffer from disk. - Specifies the name and path of the file from which to restore the registration context. - Specifies the system on which to restore the registration context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the registration context or result buffer identifier. - The returned value is the registration context or result buffer identifier. If allocation fails, M_NULL is returned. - - - Save a registration context or an M_STITCHING_RESULT result buffer to a file. - Specifies the name and path of the file in which to save the registration context or the contents of the registration result buffer. - Specifies either the identifier of the registration context or the M_STITCHING_RESULT result buffer to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a registration context or an M_STITCHING_RESULT result buffer to a file. - Specifies the name and path of the file in which to save the registration context or the contents of the registration result buffer. - Specifies either the identifier of the registration context or the M_STITCHING_RESULT result buffer to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Sets the rough location of the specified registration element's image with respect to another registration element's image or the global pixel coordinate system. - Specifies the registration context of the registration element to affect. - Specifies the index of the registration element. - Specifies the reference of the registration element's image. The coordinate system associated with this reference is used as the reference coordinate system. - Specifies the type of transformation to use to set the location of the registration element's image. - Specifies an attribute of the transformation. Its definition depends on the value of ParamType. - Specifies an attribute of the transformation. Its definition depends on the value of ParamType. - Specifies an attribute of the transformation. Its definition depends on the value of ParamType. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - - - Sets the rough location of the specified registration element's image with respect to another registration element's image or the global pixel coordinate system. - Specifies the registration context of the registration element to affect. - Specifies the index of the registration element. - Specifies the reference of the registration element's image. The coordinate system associated with this reference is used as the reference coordinate system. - Specifies the type of transformation to use to set the location of the registration element's image. - Specifies an attribute of the transformation. Its definition depends on the value of ParamType. - Specifies an attribute of the transformation. Its definition depends on the value of ParamType. - Specifies an attribute of the transformation. Its definition depends on the value of ParamType. - Reserved for future expansion and must be set to M_DEFAULT . - Reserved for future expansion and must be set to M_DEFAULT . - - - Load, restore, or save a registration context or an M_STITCHING_RESULT result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the registration context or M_STITCHING_RESULT result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the registration context or the M_STITCHING_RESULT result buffer. - Specifies the MIL version of the registration context or M_STITCHING_RESULT result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the registration context or the M_STITCHING_RESULT result buffer. - Specifies the address of the variable in which to write the size of the registration context or M_STITCHING_RESULT result buffer, in bytes. - - - Load, restore, or save a registration context or an M_STITCHING_RESULT result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the registration context or M_STITCHING_RESULT result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the registration context or the M_STITCHING_RESULT result buffer. - Specifies the MIL version of the registration context or M_STITCHING_RESULT result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the registration context or the M_STITCHING_RESULT result buffer. - Specifies the address of the variable in which to write the size of the registration context or M_STITCHING_RESULT result buffer, in bytes. - - - Load, restore, or save a registration context or an M_STITCHING_RESULT result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the registration context or M_STITCHING_RESULT result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the registration context or the M_STITCHING_RESULT result buffer. - Specifies the MIL version of the registration context or M_STITCHING_RESULT result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the registration context or the M_STITCHING_RESULT result buffer. - Specifies the address of the variable in which to write the size of the registration context or M_STITCHING_RESULT result buffer, in bytes. - - - Load, restore, or save a registration context or an M_STITCHING_RESULT result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the registration context or M_STITCHING_RESULT result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the registration context or the M_STITCHING_RESULT result buffer. - Specifies the MIL version of the registration context or M_STITCHING_RESULT result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the registration context or the M_STITCHING_RESULT result buffer. - Specifies the address of the variable in which to write the size of the registration context or M_STITCHING_RESULT result buffer, in bytes. - - - Load, restore, or save a registration context or an M_STITCHING_RESULT result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the registration context or M_STITCHING_RESULT result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the registration context or the M_STITCHING_RESULT result buffer. - Specifies the MIL version of the registration context or M_STITCHING_RESULT result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the registration context or the M_STITCHING_RESULT result buffer. - Specifies the address of the variable in which to write the size of the registration context or M_STITCHING_RESULT result buffer, in bytes. - - - Load, restore, or save a registration context or an M_STITCHING_RESULT result buffer from/to a file or memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the registration context or M_STITCHING_RESULT result buffer. - Specifies the operation to perform. - Specifies the type of stream in which to store/from which to restore the registration context or the M_STITCHING_RESULT result buffer. - Specifies the MIL version of the registration context or M_STITCHING_RESULT result buffer. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the registration context or the M_STITCHING_RESULT result buffer. - Specifies the address of the variable in which to write the size of the registration context or M_STITCHING_RESULT result buffer, in bytes. - - - Convert a pair of coordinates between two of the following coordinate systems: the global pixel coordinate system, any registered image's pixel coordinate system, and the mosaic's coordinate system. - Specifies the registration result buffer that contains the information that will be used to transform the coordinates. - Specifies the source coordinate system. - Specifies the destination coordinate system. - Specifies the X-coordinate in the source coordinate system. - Specifies the Y-coordinate in the source coordinate system. - Specifies the address in which to write the resulting X-coordinate. - Specifies the address in which to write the resulting Y-coordinate. - Reserved for future expansion and must be set to M_DEFAULT . - - - Convert a list of coordinates between two of the following coordinate systems: the global pixel coordinate system, any registered image's pixel coordinate system, and the mosaic's coordinate system. - Specifies the registration result buffer that contains the information that will be used to transform the coordinates. - Specifies the source coordinate system. - Specifies the destination coordinate system. - Specifies the number of points in the coordinate list. - Specifies the address of the array of the X-coordinates in the source coordinate system. - Specifies the address of the array of the Y-coordinates in the source coordinate system. - Specifies the address in which to write the resulting X-coordinate. - Specifies the address in which to write the resulting Y-coordinate. - Reserved for future expansion and must be set to M_DEFAULT . - - - Composes a mosaic from the specified source images and stores it in the destination image buffer. - Specifies the identifier of the registration result buffer with which to perform the mosaicing operation. - Specifies the address of the array containing the identifiers of the image buffers. To omit images from the mosaic, replace their identifiers with M_NULL in the array. - Specifies the destination image buffer that will contain the mosaic after the MregTransformImage operation is performed. - Specifies the number of images in the image array. - Specifies the interpolation mode. - Reserved for future expansion and must be set to M_DEFAULT . - - - Composes a mosaic from the specified source images and stores it in the destination image buffer. - Specifies the identifier of the registration result buffer with which to perform the mosaicing operation. - Specifies the address of the array containing the identifiers of the image buffers. To omit images from the mosaic, replace their identifiers with M_NULL in the array. - Specifies the destination image buffer that will contain the mosaic after the MregTransformImage operation is performed. - Specifies the number of images in the image array. - Specifies the interpolation mode. - Reserved for future expansion and must be set to M_DEFAULT . - - - Allocate a sequence context. - Specifies the system on which to allocate the sequence context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the operation that the sequence processing session should perform. - Specifies the format to use to create the internal output buffer. - Specifies the underlying hardware or software used for the operation. - Specifies the address of the variable in which to write the sequence context identifier. - The returned value is the sequence context's identifier. If allocation fails, M_NULL is returned. - - - Allocate a sequence context. - Specifies the system on which to allocate the sequence context. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the operation that the sequence processing session should perform. - Specifies the format to use to create the internal output buffer. - Specifies the underlying hardware or software used for the operation. - Specifies the address of the variable in which to write the sequence context identifier. - The returned value is the sequence context's identifier. If allocation fails, M_NULL is returned. - - - Control a sequence context or an individual source or destination setting. - Specifies the identifier of the sequence context to control. The sequence context must have been previously allocated using MseqAlloc. - Specifies that the sequence context, the source of an input, or a destination of an output is controlled. Set this parameter to one of the following values: - Specifies the setting to control. - Specifies the value needed for the setting. - - - Control a sequence context or an individual source or destination setting. - Specifies the identifier of the sequence context to control. The sequence context must have been previously allocated using MseqAlloc. - Specifies that the sequence context, the source of an input, or a destination of an output is controlled. Set this parameter to one of the following values: - Specifies the setting to control. - Specifies the value needed for the setting. - - - Define, or redefine, a source or destination of an input or output of the sequence operation, respectively. - Specifies the identifier of the sequence context. The sequence context must have been previously allocated using MseqAlloc. - Specifies whether to define, or redefine, the source of an input or one of the destinations of an output for the sequence operation of the specified sequence context. - Specifies the type of source or destination to define. - Specifies an attribute of the source or destination to define. Its definition is dependent on the sequence type chosen. - Specifies an attribute of the source or destination to define. Its definition is dependent on the sequence type chosen. - - - Define, or redefine, a source or destination of an input or output of the sequence operation, respectively. - Specifies the identifier of the sequence context. The sequence context must have been previously allocated using MseqAlloc. - Specifies whether to define, or redefine, the source of an input or one of the destinations of an output for the sequence operation of the specified sequence context. - Specifies the type of source or destination to define. - Specifies an attribute of the source or destination to define. Its definition is dependent on the sequence type chosen. - Specifies an attribute of the source or destination to define. Its definition is dependent on the sequence type chosen. - - - Queue an image on which to operate. - Specifies the identifier of the sequence context. The sequence context must have been previously allocated using MseqAlloc. - Specifies the identifier of the buffer containing the image to be queued for the sequence processing operation. - Reserved for future use. Set this parameter to M_DEFAULT . - - - Free a sequence context. - Specifies the identifier of the sequence context to deallocate. The sequence context must have been previously allocated using MseqAlloc. - - - Get information about a sequence hook event. - Specifies the sequence event identifier received by the hook-handler function. See MseqHookFunction for more information. - Specifies a combination of two values: the event type and the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Hook a function to a sequence event. - Specifies the identifier of the sequence context. The sequence context must have been previously allocated using MseqAlloc. - Specifies the sequence event to which to hook the function. - Specifies the address of the function that should be called when the specified event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Inquire information about a sequence context or an individual source or destination setting. - Specifies the sequence context about which to inquire information. The sequence context must have been previously allocated using MseqAlloc. - Specifies that the sequence context, the source of an input, or a destination of an output is inquired. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a sequence context or an individual source or destination setting. - Specifies the sequence context about which to inquire information. The sequence context must have been previously allocated using MseqAlloc. - Specifies that the sequence context, the source of an input, or a destination of an output is inquired. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a sequence context or an individual source or destination setting. - Specifies the sequence context about which to inquire information. The sequence context must have been previously allocated using MseqAlloc. - Specifies that the sequence context, the source of an input, or a destination of an output is inquired. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a sequence context or an individual source or destination setting. - Specifies the sequence context about which to inquire information. The sequence context must have been previously allocated using MseqAlloc. - Specifies that the sequence context, the source of an input, or a destination of an output is inquired. Set this parameter to one of the following values: - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Starts or stops a sequence processing session. - Specifies the identifier of the sequence context. The sequence context must have been previously allocated using MseqAlloc. - Specifies the command to give the sequence processing session. - Specifies the synchronization state of the sequence processing session. - - - Allocate a String Reader context. - Specifies the system on which to allocate the String Reader context. - Specifies the type of String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the String Reader context identifier. - The returned value is the String Reader context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a String Reader context. - Specifies the system on which to allocate the String Reader context. - Specifies the type of String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the String Reader context identifier. - The returned value is the String Reader context identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a String Reader result buffer. - Specifies the system on which to allocate the String Reader result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the String Reader result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a String Reader result buffer. - Specifies the system on which to allocate the String Reader result buffer. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the String Reader result buffer identifier. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a String Reader context, result buffer, a specific string model, or a specific font. - Specifies the String Reader context or result buffer whose settings to modify. - Specifies that the String Reader context, a specific font, a specific string model, or a result buffer is controlled. - Specifies the setting to change. - Specifies the setting's new value. - - - Control a String Reader context, result buffer, a specific string model, or a specific font. - Specifies the String Reader context or result buffer whose settings to modify. - Specifies that the String Reader context, a specific font, a specific string model, or a result buffer is controlled. - Specifies the setting to change. - Specifies the setting's new value. - - - Draw specific features of the String Reader context or String Reader results. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the String Reader context or String Reader result buffer from which to extract the features to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Specifies the index of the font feature or result feature to draw. - Specifies an explicit list of valid characters to draw, at the specified position. This is an optional, null-terminated string. - Specifies where in the destination image buffer to draw. - - - Draw specific features of the String Reader context or String Reader results. - Specifies the identifier of the 2D graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the String Reader context or String Reader result buffer from which to extract the features to draw. - Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. - Specifies the type of operation to perform. - Specifies the index of the font feature or result feature to draw. - Specifies an explicit list of valid characters to draw, at the specified position. This is an optional, null-terminated string. - Specifies where in the destination image buffer to draw. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - - - Makes a diagnosis of the String Reader context and reports configuration problems. - Specifies the identifier of the String Reader context. - Specifies the identifier of the image to analyze. - Specifies the identifier of the string to locate. - Specifies the number of images to analyze. - Specifies the identifier of the String Reader result buffer in which to save the results of MstrExpert. - Specifies the type of analysis to perform with MstrExpert. - - - Makes a diagnosis of the String Reader context and reports configuration problems. - Specifies the identifier of the String Reader context. - Specifies the identifier of the image to analyze. - Specifies the identifier of the string to locate. - Specifies the number of images to analyze. - Specifies the identifier of the String Reader result buffer in which to save the results of MstrExpert. - Specifies the type of analysis to perform with MstrExpert. - - - Makes a diagnosis of the String Reader context and reports configuration problems. - Specifies the identifier of the String Reader context. - Specifies the identifier of the image to analyze. - Specifies the identifier of the string to locate. - Specifies the number of images to analyze. - Specifies the identifier of the String Reader result buffer in which to save the results of MstrExpert. - Specifies the type of analysis to perform with MstrExpert. - - - Free a String Reader context or a String Reader result buffer. - Specifies the identifier of the String Reader context or String Reader result buffer to free. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Get the specified type of result(s) from a String Reader result buffer. - Specifies the identifier of the String Reader result buffer from which to retrieve results. - Specifies where to get results. - Specifies the type of result to retrieve. - Specifies the address in which to write results. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire information about a specified String Reader context, string model, result buffer, font, or an error/warning code generated by MstrExpert. - Specifies the String Reader context or result buffer about which to inquire information. - Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. - Specifies the type of setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Preprocess a String Reader context. - Specifies the String Reader context to preprocess. - Specifies whether to preprocess the String Reader context. - - - Read strings from a target image. - Specifies the String Reader context to use for the read operation. - Specifies the target image in which to read the strings. - Specifies the result buffer in which to write the results of the read operation. - - - Restore a String Reader context from disk. - Specifies the path and name of the file from which to restore the String Reader context (for example, "C:\mydirectory\myfile"). - Specifies the system on which to restore the String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the String Reader context identifier. - The returned value is the String Reader context identifier. If allocation fails, M_NULL is returned. - - - Restore a String Reader context from disk. - Specifies the path and name of the file from which to restore the String Reader context (for example, "C:\mydirectory\myfile"). - Specifies the system on which to restore the String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the String Reader context identifier. - The returned value is the String Reader context identifier. If allocation fails, M_NULL is returned. - - - Save a String Reader context to a file. - Specifies the name and path of the file in which to save the String Reader context. - Specifies the identifier of the String Reader context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Save a String Reader context to a file. - Specifies the name and path of the file in which to save the String Reader context. - Specifies the identifier of the String Reader context to save. - Reserved for future expansion and must be set to M_DEFAULT . - - - Set character constraints. - Specifies the String Reader context with which to associate the constraint. The String Reader context must have been previously allocated on the required system using MstrAlloc. - Specifies the string(s) in the String Reader context to affect. - Specifies the character position in the string for which to set the constraint. - Specifies the type of constraint to set. - Specifies an explicit list of valid characters, at the specified position. This is an optional, null-terminated string. - - - Set character constraints. - Specifies the String Reader context with which to associate the constraint. The String Reader context must have been previously allocated on the required system using MstrAlloc. - Specifies the string(s) in the String Reader context to affect. - Specifies the character position in the string for which to set the constraint. - Specifies the type of constraint to set. - Specifies an explicit list of valid characters, at the specified position. This is an optional, null-terminated string. - - - Load, restore, or save a String Reader context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the String Reader context. - Specifies the operation to perform on the String Reader context. - Specifies the type of stream in which to store/from which to restore the String Reader context. - Specifies the MIL version of the String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the String Reader context. - Specifies the address of the variable in which to write the size of the String Reader context, in bytes. - - - Load, restore, or save a String Reader context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the String Reader context. - Specifies the operation to perform on the String Reader context. - Specifies the type of stream in which to store/from which to restore the String Reader context. - Specifies the MIL version of the String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the String Reader context. - Specifies the address of the variable in which to write the size of the String Reader context, in bytes. - - - Load, restore, or save a String Reader context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the String Reader context. - Specifies the operation to perform on the String Reader context. - Specifies the type of stream in which to store/from which to restore the String Reader context. - Specifies the MIL version of the String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the String Reader context. - Specifies the address of the variable in which to write the size of the String Reader context, in bytes. - - - Load, restore, or save a String Reader context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the String Reader context. - Specifies the operation to perform on the String Reader context. - Specifies the type of stream in which to store/from which to restore the String Reader context. - Specifies the MIL version of the String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the String Reader context. - Specifies the address of the variable in which to write the size of the String Reader context, in bytes. - - - Load, restore, or save a String Reader context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the String Reader context. - Specifies the operation to perform on the String Reader context. - Specifies the type of stream in which to store/from which to restore the String Reader context. - Specifies the MIL version of the String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the String Reader context. - Specifies the address of the variable in which to write the size of the String Reader context, in bytes. - - - Load, restore, or save a String Reader context from/to a file or a memory stream. - Specifies the file or memory stream. - Specifies the system on which to restore the String Reader context. - Specifies the operation to perform on the String Reader context. - Specifies the type of stream in which to store/from which to restore the String Reader context. - Specifies the MIL version of the String Reader context. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write or from which to read the identifier of the String Reader context. - Specifies the address of the variable in which to write the size of the String Reader context, in bytes. - - - Allocate a MIL system. - Specifies the identifier of the application context to use. - Specifies the type of system to allocate. Set this parameter to one of the following values: - Specifies the number (rank) or user-defined name of the target board of the specified system type. - Specifies how to perform the allocation. - Specifies the address of the variable in which to write the system identifier. - The returned value is the system identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL system. - Specifies the identifier of the application context to use. - Specifies the type of system to allocate. Set this parameter to one of the following values: - Specifies the number (rank) or user-defined name of the target board of the specified system type. - Specifies how to perform the allocation. - Specifies the address of the variable in which to write the system identifier. - The returned value is the system identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a system setting. - Specifies the system identifier. - Specifies the type of setting to control. - Specifies the new value to assign to the system setting specified by the ControlType parameter. - - - Control a system setting. - Specifies the system identifier. - Specifies the type of setting to control. - Specifies the new value to assign to the system setting specified by the ControlType parameter. - - - Free a system. - Specifies the identifier of the system to free. - - - Get information about a hook event. - Specifies the identifier of the system. - Specifies the system event identifier received by the hook-handler function (see MsysHookFunction). - Specifies the type of information about which to inquire. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hook event. - Specifies the identifier of the system. - Specifies the system event identifier received by the hook-handler function (see MsysHookFunction). - Specifies the type of information about which to inquire. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Get information about a hook event. - Specifies the identifier of the system. - Specifies the system event identifier received by the hook-handler function (see MsysHookFunction). - Specifies the type of information about which to inquire. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (! M_NULL ) value is returned. - - - Hook a function to a system event. - Specifies the identifier of the system on which to hook a function. - Specifies the system event to which to hook the function. - Specifies the address of the function that should be called when the specified event occurs. - Specifies the address of the user data that you want to make available to the hook-handler function. - - - Inquire about a system setting. - Specifies the system identifier. This parameter should be set to one of the following values: - Specifies the type of system setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a system setting. - Specifies the system identifier. This parameter should be set to one of the following values: - Specifies the type of system setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a system setting. - Specifies the system identifier. This parameter should be set to one of the following values: - Specifies the type of system setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a system setting. - Specifies the system identifier. This parameter should be set to one of the following values: - Specifies the type of system setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Allocate a MIL I/O command list. - Specifies the identifier of the MIL system on which to allocate the I/O command list. - Specifies the index of the I/O command list to allocate. - Specifies the type of I/O command list to allocate. - Specifies the signal to use as the counter source. - Specifies the address of the variable in which to write the I/O command list identifier. - The returned value is the I/O command list identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL I/O command list. - Specifies the identifier of the MIL system on which to allocate the I/O command list. - Specifies the index of the I/O command list to allocate. - Specifies the type of I/O command list to allocate. - Specifies the signal to use as the counter source. - Specifies the address of the variable in which to write the I/O command list identifier. - The returned value is the I/O command list identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Add a command to change the state of a bit of the I/O command register at a specified time or counter value. - Specifies the identifier of the I/O command list in which to add a command. - Specifies the command to add to the I/O command list to change the state of the specified I/O command register bit. - Specifies the reference time or counter value to which the delay is added. - Specifies the delay to add to the reference time or counter value; the sum of the two establishes the specific moment that the command is executed. - Specifies the duration of the pulse if the command specified with Operation is M_PULSE_HIGH or M_PULSE_LOW. - Specifies the bit of the I/O command register to affect with the command. - Specifies the address in which to write whether the command was successfully added to the list. - The returned value is M_NULL if the function successfully scheduled the command, M_INVALID if the moment at which to execute the command had elapsed when the function was executed, and M_UNKNOWN if the function encountered an error or if the CommandStatusPtr parameter was set to M_NULL . - - - Add a command to change the state of a bit of the I/O command register at a specified time or counter value. - Specifies the identifier of the I/O command list in which to add a command. - Specifies the command to add to the I/O command list to change the state of the specified I/O command register bit. - Specifies the reference time or counter value to which the delay is added. - Specifies the delay to add to the reference time or counter value; the sum of the two establishes the specific moment that the command is executed. - Specifies the duration of the pulse if the command specified with Operation is M_PULSE_HIGH or M_PULSE_LOW. - Specifies the bit of the I/O command register to affect with the command. - Specifies the address in which to write whether the command was successfully added to the list. - The returned value is M_NULL if the function successfully scheduled the command, M_INVALID if the moment at which to execute the command had elapsed when the function was executed, and M_UNKNOWN if the function encountered an error or if the CommandStatusPtr parameter was set to M_NULL . - - - Control an I/O command list setting. - Specifies the identifier of the I/O command list. - Specifies the type of I/O command list setting to control. - Specifies the new value to assign to the I/O command list setting specified by the ControlType parameter. - - - Control an I/O command list setting. - Specifies the identifier of the I/O command list. - Specifies the type of I/O command list setting to control. - Specifies the new value to assign to the I/O command list setting specified by the ControlType parameter. - - - Free the specified I/O command list. - Specifies the identifier of the I/O command list to free. - - - Inquire about an I/O command list setting. - Specifies the identifier of the I/O command list. - Specifies the type of I/O command list setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an I/O command list setting. - Specifies the identifier of the I/O command list. - Specifies the type of I/O command list setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about an I/O command list setting. - Specifies the identifier of the I/O command list. - Specifies the type of I/O command list setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Allocate a MIL thread context, event, or mutex. - Specifies the identifier of the system on which to allocate a MIL thread context, event, or mutex. - Specifies the type of object to allocate. - Specifies the initialization state of the MIL thread context, event, mutex, or the identifier of an existing MIL event. - Specifies the address of the function that will be executed by the new thread ( M_THREAD). - Specifies the address of user data necessary to execute theFunctionToCallfunction of the new thread ( M_THREAD). - Specifies the address of the variable in which to write the MIL identifier of the MIL thread context, event, or mutex. - The returned value is the identifier of the MIL thread, event, or mutex if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL thread context, event, or mutex. - Specifies the identifier of the system on which to allocate a MIL thread context, event, or mutex. - Specifies the type of object to allocate. - Specifies the initialization state of the MIL thread context, event, mutex, or the identifier of an existing MIL event. - Specifies the address of the function that will be executed by the new thread ( M_THREAD). - Specifies the address of user data necessary to execute theFunctionToCallfunction of the new thread ( M_THREAD). - Specifies the address of the variable in which to write the MIL identifier of the MIL thread context, event, or mutex. - The returned value is the identifier of the MIL thread, event, or mutex if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL thread context, event, or mutex. - Specifies the identifier of the system on which to allocate a MIL thread context, event, or mutex. - Specifies the type of object to allocate. - Specifies the initialization state of the MIL thread context, event, mutex, or the identifier of an existing MIL event. - Specifies the address of the function that will be executed by the new thread ( M_THREAD). - Specifies the address of user data necessary to execute theFunctionToCallfunction of the new thread ( M_THREAD). - Specifies the address of the variable in which to write the MIL identifier of the MIL thread context, event, or mutex. - The returned value is the identifier of the MIL thread, event, or mutex if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL thread context, event, or mutex. - Specifies the identifier of the system on which to allocate a MIL thread context, event, or mutex. - Specifies the type of object to allocate. - Specifies the initialization state of the MIL thread context, event, mutex, or the identifier of an existing MIL event. - Specifies the address of the function that will be executed by the new thread ( M_THREAD). - Specifies the address of user data necessary to execute theFunctionToCallfunction of the new thread ( M_THREAD). - Specifies the address of the variable in which to write the MIL identifier of the MIL thread context, event, or mutex. - The returned value is the identifier of the MIL thread, event, or mutex if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL thread context, event, or mutex. - Specifies the identifier of the system on which to allocate a MIL thread context, event, or mutex. - Specifies the type of object to allocate. - Specifies the initialization state of the MIL thread context, event, mutex, or the identifier of an existing MIL event. - Specifies the address of the function that will be executed by the new thread ( M_THREAD). - Specifies the address of user data necessary to execute theFunctionToCallfunction of the new thread ( M_THREAD). - Specifies the address of the variable in which to write the MIL identifier of the MIL thread context, event, or mutex. - The returned value is the identifier of the MIL thread, event, or mutex if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a MIL thread context, event, or mutex. - Specifies the identifier of the system on which to allocate a MIL thread context, event, or mutex. - Specifies the type of object to allocate. - Specifies the initialization state of the MIL thread context, event, mutex, or the identifier of an existing MIL event. - Specifies the address of the function that will be executed by the new thread ( M_THREAD). - Specifies the address of user data necessary to execute theFunctionToCallfunction of the new thread ( M_THREAD). - Specifies the address of the variable in which to write the MIL identifier of the MIL thread context, event, or mutex. - The returned value is the identifier of the MIL thread, event, or mutex if the allocation is successful. If allocation fails, M_NULL is returned. - - - Control a MIL thread context, MIL event, or MIL mutex setting. - Specifies the identifier of a user-allocated MIL thread context, event, or mutex, allocated using MthrAlloc. This parameter can also be set to the MIL identifier of a system. - Specifies the type of setting to control. - Specifies the new value to assign to the setting specified by the ControlType parameter. - - - Control a MIL thread context, MIL event, or MIL mutex setting. - Specifies the identifier of a user-allocated MIL thread context, event, or mutex, allocated using MthrAlloc. This parameter can also be set to the MIL identifier of a system. - Specifies the type of setting to control. - Specifies the new value to assign to the setting specified by the ControlType parameter. - - - Control a MIL multi-core processing setting of a thread context. - Specifies the identifier of a user-allocated MIL thread context allocated using MthrAlloc. - Specifies the type of multi-core processing setting to control. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the setting's new value. - Specifies the address which contains more information about the setting's new value. - - - Control a MIL multi-core processing setting of a thread context. - Specifies the identifier of a user-allocated MIL thread context allocated using MthrAlloc. - Specifies the type of multi-core processing setting to control. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the setting's new value. - Specifies the address which contains more information about the setting's new value. - - - Free a MIL thread context, event, or mutex. - Specifies the identifier of the MIL thread context/event/mutex to free. - - - Inquire about a MIL thread context, event, or mutex setting. - Specifies the identifier of a user-allocated MIL thread context, event, or mutex, allocated using MthrAlloc. - Specifies the type of information about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a MIL thread context, event, or mutex setting. - Specifies the identifier of a user-allocated MIL thread context, event, or mutex, allocated using MthrAlloc. - Specifies the type of information about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquires about a MIL multi-core processing setting of a thread context. - Specifies the identifier of a user-allocated MIL thread context allocated using MthrAlloc. - Specifies the type of multi-core processing setting about which to inquire. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address in which to write the requested information. - The returned value is the requested information cast to a MIL_INT, except for M_CORE_AFFINITY_MASK. In this case, the returned value is undefined. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquires about a MIL multi-core processing setting of a thread context. - Specifies the identifier of a user-allocated MIL thread context allocated using MthrAlloc. - Specifies the type of multi-core processing setting about which to inquire. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Reserved for future expansion. This parameter must be set to M_DEFAULT . - Specifies the address in which to write the requested information. - The returned value is the requested information cast to a MIL_INT, except for M_CORE_AFFINITY_MASK. In this case, the returned value is undefined. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Perform a wait operation on a MIL thread or event. - Specifies the identifier of the MIL thread context or event with which to be synchronized. - Specifies the wait option. - Specifies the address of the variable in which to write the state of the specified thread or event. - The returned value for M_THREAD_END_WAIT, M_THREAD_WAIT, and M_EVENT_WAIT is M_SIGNALED if the specified thread has successfully completed or if the state of the specified event has changed; it is M_TIMEOUT if the thread or event on which the current thread was waiting timed out. For M_EVENT_SYNCHRONIZE, the returned value is M_UNKNOWN . - - - Perform a wait operation on a MIL thread or event. - Specifies the identifier of the MIL thread context or event with which to be synchronized. - Specifies the wait option. - Specifies the address of the variable in which to write the state of the specified thread or event. - The returned value for M_THREAD_END_WAIT, M_THREAD_WAIT, and M_EVENT_WAIT is M_SIGNALED if the specified thread has successfully completed or if the state of the specified event has changed; it is M_TIMEOUT if the thread or event on which the current thread was waiting timed out. For M_EVENT_SYNCHRONIZE, the returned value is M_UNKNOWN . - - - Perform a wait operation on multiple MIL events. - Specifies the address of a user-supplied array that contains the identifiers of the MIL events for which to wait. - Specifies the number of events in the user-supplied array. - Specifies the wait option. - Specifies the address in which to write the returned value. - The returned value for M_EVENT_WAIT is the index of the event that changed to the M_SIGNALED state, or M_TIMEOUT if none of the events in the array changed state before the time out interval is reached. For M_EVENT_WAIT + M_ALL_OBJECTS, the returned value is M_SIGNALED if all the events specified in the array changed state, or M_TIMEOUT if the time out interval is reached before all the events in the array have changed state. For M_EVENT_SYNCHRONIZE, the returned value is M_UNKNOWN . - - - Perform a wait operation on multiple MIL events. - Specifies the address of a user-supplied array that contains the identifiers of the MIL events for which to wait. - Specifies the number of events in the user-supplied array. - Specifies the wait option. - Specifies the address in which to write the returned value. - The returned value for M_EVENT_WAIT is the index of the event that changed to the M_SIGNALED state, or M_TIMEOUT if none of the events in the array changed state before the time out interval is reached. For M_EVENT_WAIT + M_ALL_OBJECTS, the returned value is M_SIGNALED if all the events specified in the array changed state, or M_TIMEOUT if the time out interval is reached before all the events in the array have changed state. For M_EVENT_SYNCHRONIZE, the returned value is M_UNKNOWN . - - - Perform a wait operation on multiple MIL events. - Specifies the address of a user-supplied array that contains the identifiers of the MIL events for which to wait. - Specifies the number of events in the user-supplied array. - Specifies the wait option. - Specifies the address in which to write the returned value. - The returned value for M_EVENT_WAIT is the index of the event that changed to the M_SIGNALED state, or M_TIMEOUT if none of the events in the array changed state before the time out interval is reached. For M_EVENT_WAIT + M_ALL_OBJECTS, the returned value is M_SIGNALED if all the events specified in the array changed state, or M_TIMEOUT if the time out interval is reached before all the events in the array have changed state. For M_EVENT_SYNCHRONIZE, the returned value is M_UNKNOWN . - - - Perform a wait operation on multiple MIL events. - Specifies the address of a user-supplied array that contains the identifiers of the MIL events for which to wait. - Specifies the number of events in the user-supplied array. - Specifies the wait option. - Specifies the address in which to write the returned value. - The returned value for M_EVENT_WAIT is the index of the event that changed to the M_SIGNALED state, or M_TIMEOUT if none of the events in the array changed state before the time out interval is reached. For M_EVENT_WAIT + M_ALL_OBJECTS, the returned value is M_SIGNALED if all the events specified in the array changed state, or M_TIMEOUT if the time out interval is reached before all the events in the array have changed state. For M_EVENT_SYNCHRONIZE, the returned value is M_UNKNOWN . - - - Control a MIL object setting for a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the identifier of the MIL object to control. - Specifies the type of MIL object setting to control. - Specifies the MIL object setting's new value. - - - Control a MIL object setting for a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the identifier of the MIL object to control. - Specifies the type of MIL object setting to control. - Specifies the MIL object setting's new value. - - - Inquire about a MIL object setting in a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the identifier of the MIL object about which to inquire. - Specifies the MIL object setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information is not a single value, this function will return M_NULL . - - - Inquire about a MIL object setting in a Distributed MIL publishing application. - Specifies the identifier of the application context to use. - Specifies the identifier of the MIL object about which to inquire. - Specifies the MIL object setting about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to aMIL_INT. If the requested information is not a single value, this function will return M_NULL . - - - Allocate a blob analysis feature list. - Specifies the system on which to allocate the feature list. - Specifies the address of the variable in which the feature list identifier will be written. - The returned value is the feature list identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a blob analysis feature list. - Specifies the system on which to allocate the feature list. - Specifies the address of the variable in which the feature list identifier will be written. - The returned value is the feature list identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a blob analysis result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the address of the variable in which the blob analysis result buffer identifier is to be written. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a blob analysis result buffer. - Specifies the system on which to allocate the result buffer. - Specifies the address of the variable in which the blob analysis result buffer identifier is to be written. - The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Draw blobs that meet a specified fill criterion. - Specifies the identifier of the blob analysis result buffer. - Specifies the identifier of the destination image buffer. - Specifies which blobs to draw with the specified value. - Specifies the value with which to fill the blobs that meet the specified criterion. If the destination buffer is binary, this value must be 0 or 1. - - - Get the number of currently included blobs. - Specifies the identifier of the blob analysis result buffer. - Specifies the address of the variable in which to write the count. Since MblobGetNumber also returns the number of selected blobs, you can set this parameter to M_NULL . - The returned value is the number of included blobs in the specified result buffer. - - - Get the number of currently included blobs. - Specifies the identifier of the blob analysis result buffer. - Specifies the address of the variable in which to write the count. Since MblobGetNumber also returns the number of selected blobs, you can set this parameter to M_NULL . - The returned value is the number of included blobs in the specified result buffer. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of the included blobs, from a blob result buffer. - Specifies the identifier of the Blob Analysis result buffer from which to get results. - Specifies the type of result to retrieve. - Specifies the address of the array in which to write results. - - - Get results for a feature of a single blob. - Specifies the identifier of the blob analysis result buffer from which to get the result. - Specifies the label value of the blob for which to get the result. The label value can be obtained, using MblobGetLabel or MblobGetResult . Note, you cannot obtain results for blobs that have been deleted from the result buffer, using MblobSelect . - Specifies the feature for which to retrieve results. - Specifies the address in which to write the result retrieved from the blob analysis result buffer. - - - Get results for a feature of a single blob. - Specifies the identifier of the blob analysis result buffer from which to get the result. - Specifies the label value of the blob for which to get the result. The label value can be obtained, using MblobGetLabel or MblobGetResult . Note, you cannot obtain results for blobs that have been deleted from the result buffer, using MblobSelect . - Specifies the feature for which to retrieve results. - Specifies the address in which to write the result retrieved from the blob analysis result buffer. - - - Get results for a feature of a single blob. - Specifies the identifier of the blob analysis result buffer from which to get the result. - Specifies the label value of the blob for which to get the result. The label value can be obtained, using MblobGetLabel or MblobGetResult . Note, you cannot obtain results for blobs that have been deleted from the result buffer, using MblobSelect . - Specifies the feature for which to retrieve results. - Specifies the address in which to write the result retrieved from the blob analysis result buffer. - - - Get results for a feature of a single blob. - Specifies the identifier of the blob analysis result buffer from which to get the result. - Specifies the label value of the blob for which to get the result. The label value can be obtained, using MblobGetLabel or MblobGetResult . Note, you cannot obtain results for blobs that have been deleted from the result buffer, using MblobSelect . - Specifies the feature for which to retrieve results. - Specifies the address in which to write the result retrieved from the blob analysis result buffer. - - - Get results for a feature of a single blob. - Specifies the identifier of the blob analysis result buffer from which to get the result. - Specifies the label value of the blob for which to get the result. The label value can be obtained, using MblobGetLabel or MblobGetResult . Note, you cannot obtain results for blobs that have been deleted from the result buffer, using MblobSelect . - Specifies the feature for which to retrieve results. - Specifies the address in which to write the result retrieved from the blob analysis result buffer. - - - Get results for a feature of a single blob. - Specifies the identifier of the blob analysis result buffer from which to get the result. - Specifies the label value of the blob for which to get the result. The label value can be obtained, using MblobGetLabel or MblobGetResult . Note, you cannot obtain results for blobs that have been deleted from the result buffer, using MblobSelect . - Specifies the feature for which to retrieve results. - Specifies the address in which to write the result retrieved from the blob analysis result buffer. - - - Get results for a feature of a single blob. - Specifies the identifier of the blob analysis result buffer from which to get the result. - Specifies the label value of the blob for which to get the result. The label value can be obtained, using MblobGetLabel or MblobGetResult . Note, you cannot obtain results for blobs that have been deleted from the result buffer, using MblobSelect . - Specifies the feature for which to retrieve results. - Specifies the address in which to write the result retrieved from the blob analysis result buffer. - - - Get results for a feature of a single blob. - Specifies the identifier of the blob analysis result buffer from which to get the result. - Specifies the label value of the blob for which to get the result. The label value can be obtained, using MblobGetLabel or MblobGetResult . Note, you cannot obtain results for blobs that have been deleted from the result buffer, using MblobSelect . - Specifies the feature for which to retrieve results. - Specifies the address in which to write the result retrieved from the blob analysis result buffer. - - - Get the blob run-length encoding information. - Specifies the identifier of the blob analysis result buffer. - Specifies the blob(s) for which to get run length encoding information. - Specifies the type of the arrays in which the coordinate and length of the runs for a blob will be returned. - Specifies the address of the array in which to write the X-coordinate of the start (left-most pixel) of each run in the specified blob. - Specifies the address of the array in which to write the Y-coordinate of the start of each run in the specified blob. - Specifies the address of the array in which to write the length of each run in the specified blob. - - - Get the blob run-length encoding information. - Specifies the identifier of the blob analysis result buffer. - Specifies the blob(s) for which to get run length encoding information. - Specifies the type of the arrays in which the coordinate and length of the runs for a blob will be returned. - Specifies the address of the array in which to write the X-coordinate of the start (left-most pixel) of each run in the specified blob. - Specifies the address of the array in which to write the Y-coordinate of the start of each run in the specified blob. - Specifies the address of the array in which to write the length of each run in the specified blob. - - - Get the blob run-length encoding information. - Specifies the identifier of the blob analysis result buffer. - Specifies the blob(s) for which to get run length encoding information. - Specifies the type of the arrays in which the coordinate and length of the runs for a blob will be returned. - Specifies the address of the array in which to write the X-coordinate of the start (left-most pixel) of each run in the specified blob. - Specifies the address of the array in which to write the Y-coordinate of the start of each run in the specified blob. - Specifies the address of the array in which to write the length of each run in the specified blob. - - - Get the blob run-length encoding information. - Specifies the identifier of the blob analysis result buffer. - Specifies the blob(s) for which to get run length encoding information. - Specifies the type of the arrays in which the coordinate and length of the runs for a blob will be returned. - Specifies the address of the array in which to write the X-coordinate of the start (left-most pixel) of each run in the specified blob. - Specifies the address of the array in which to write the Y-coordinate of the start of each run in the specified blob. - Specifies the address of the array in which to write the length of each run in the specified blob. - - - Select feature(s) to be calculated. - Specifies the identifier of the feature list buffer. - Specifies the feature to add to the feature list. - - - Add Feret angle to the feature list. - Specifies the identifier of the feature list buffer. - Specifies the angle, in degrees, to be used for calculating the general Feret. - - - Add specified moment to the feature list. - Specifies the identifier of the feature list buffer. - Specifies the moment type. - Specifies the X-order of the moment. - Specifies the Y-order of the moment. - - - Change an operation control type setting of a kernel buffer or structuring element buffer. - Specifies the identifier of the kernel buffer or structuring element buffer. - Specifies the operation to perform during a neighborhood operation when using the specified buffer. - Specifies the new value to assign to the operation setting specified by the OperationControlType parameter. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Read the pixels along a specified arc, count the pixels, and store their values in a user-defined array. - Specifies the identifier of the single-band (monochrome) source image buffer. - Specifies the X-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the Y-coordinate of the ellipse center, relative to the top-left coordinate of the source buffer. - Specifies the radius along the X-axis. The radius should be given in pixels and must be greater than 0. - Specifies the radius along the Y-axis. The radius should be given in pixels and must be greater than 0. - Specifies the angle at which to start reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the angle at which to stop reading the arc, moving in a counter-clockwise direction. Express the angle in degrees relative to the positive X-axis. - Specifies the address of the user array in which to store the pixels from the image buffer. - Specifies the address of the variable in which to write the number of pixels found along the arc. Set this parameter to M_NULL if it is not to be evaluated. - The returned value is the number of pixels found along the arc. - - - Draw specific features of results obtained from an McodeRead, McodeGrade, or McodeDetect operation. - Specifies the identifier of the graphics context to use when drawing. This parameter must be set to one of the following values: - Specifies the identifier of the code read, grade, or detect result buffer from which to extract features to draw. - Specifies the identifier of the destination image buffer or graphics list in which to write specific features of results. - Specifies the type of drawing operation to perform. - Specifies from which code occurrence or scan reflectance profile to draw results. - Specifies the function's control flag. Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for every occurrence of every code model, or in the case of an McodeTrain operation, for every code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for a specified code occurrence, or in the case of an McodeTrain operation, for a specified code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence/code model, scan reflectance profile, or code row from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for a specified code occurrence, or in the case of an McodeTrain operation, for a specified code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence/code model, scan reflectance profile, or code row from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for a specified code occurrence, or in the case of an McodeTrain operation, for a specified code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence/code model, scan reflectance profile, or code row from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for a specified code occurrence, or in the case of an McodeTrain operation, for a specified code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence/code model, scan reflectance profile, or code row from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for a specified code occurrence, or in the case of an McodeTrain operation, for a specified code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence/code model, scan reflectance profile, or code row from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for a specified code occurrence, or in the case of an McodeTrain operation, for a specified code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence/code model, scan reflectance profile, or code row from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Get the specified type of result for a specified code occurrence, or in the case of an McodeTrain operation, for a specified code model, from a code result buffer. - Specifies the identifier of the code result buffer from which to retrieve results. - Specifies the code occurrence/code model, scan reflectance profile, or code row from which to retrieve results. - Specifies the type of result to retrieve. - Specifies the address in which to place the specified result. - - - Compute the different quality-grades of the code in the specified source image. - Specifies the identifier of the code context. - Specifies the identifier of the image buffer containing the string to be verified. - Reserved for future expansion and must be set to M_NULL. - Specifies the result buffer in which to write the results of the verify operation. - - - Compute the different quality-grades of the code in the specified source image. - Specifies the identifier of the code context. - Specifies the identifier of the image buffer containing the string to be verified. - Reserved for future expansion and must be set to M_NULL. - Specifies the result buffer in which to write the results of the verify operation. - - - Encode an ASCII string into a symbol. - Specifies the identifier of the code model. - Specifies the 8-bit unsigned 1-band image buffer in which to write the symbol. - Specifies the address of the string to be encoded. - Specifies the function's control flag. - - - Select the active input data or synchronization channel of a digitizer. - Specifies the identifier of the digitizer. - Specifies the channel on which the digitizer is to acquire data. - - - Get information about a digitizer hook event. - Specifies the digitizer event identifier received by the hook-handler function (see MdigProcess and MdigHookFunction). - Specifies the type of information about the event to return. - Specifies the address in which to write the requested information. - The returned value is M_NULL if successful. If the operation fails, a non-null (!M_NULL) value is returned. - - - Copy a LUT buffer to a digitizer's physical LUT. - Specifies the identifier of the digitizer. - Specifies the LUT buffer identifier. - - - Select a digitization reference level. - Specifies the identifier of the digitizer on which to set the reference level. - Specifies the reference level type to adjust for the specified digitizer. - Specifies the level of reference. - - - - MimDataAugment - - Id of the data augment context to use. - Id of the source buffer. - Id of the destination buffer. - Seed value for the random generator. - Operation controlFlag - - - Project a 2D image into 1D. - Specifies the identifier of the data source of the image. - Specifies the identifier of the destination of the projection results or a destination image buffer. - Specifies the angle of projection, in degrees. - - - Calculate a variety of statistics on the source image. - Specifies the identifier of the source image for the operation. This parameter must be given a 1-band image buffer identifier. - Specifies the identifier of the destination result buffer for the operation. - Specifies the type of statistic to compute. - Specifies the condition for the statistical computation. - Specifies the lower limit of the selected condition. - Specifies the upper limit of the selected condition. - - - Calculates and stores a variety of statistics from the specified source images. - Specifies the identifier of the image processing context that specifies the statistics to calculate. - Specifies the identifier of the source image buffer. - Specifies the identifier of the result buffer. - Specifies the operation to perform on the source image. - - - Compute the transformation that aligns two point clouds. - Specifies the identifier of a pairwise 3D alignment context, allocated using M3dmapAlloc with M_PAIRWISE_ALIGNMENT_CONTEXT. - Specifies the 3D reconstruction result buffer of type M_POINT_CLOUD_CONTAINER that contains the model point cloud(s). - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, that represents the model. - Specifies the 3D reconstruction result buffer of type M_POINT_CLOUD_CONTAINER that contains the scene point cloud(s). - Specifies the point cloud(s) in the specified 3D reconstruction result buffer, or the entire result buffer itself, that represents the scene. - Specifies a transformation matrix in a pairwise 3D alignment result buffer or 4x4 MIL array buffer, which is used to prealign the model before the pairwise 3D alignment process begins. - Specifies a pairwise 3D alignment result buffer or 4x4 MIL array buffer used to store the results from the pairwise 3D alignment process. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the address of the variable in which to write the 3D alignment status of the alignment operation. - - - Perform a point-to-point arithmetic operation on depth maps and geometry objects. - Specifies the data source of the first operand. - Specifies the data source of the second operand. - Specifies the identifier of the destination image buffer in which to put the result of the arithmetic operation. - Specifies the identifier of the image buffer used as a mask. - Specifies the operation to perform. - Specifies how to handle the camera calibration information of the destination buffer. - - - Copy a single point cloud from one M_POINT_CLOUD_CONTAINER result buffer to another, according to the specified condition. - Specifies the identifier of the 3D reconstruction result buffer containing the source point cloud to copy. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud to copy from the source M_POINT_CLOUD_CONTAINER result buffer. - Specifies the identifier of the 3D reconstruction result buffer in which to copy the source point cloud. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. You can specify the same identifier as the SrcResult3dmapId identifier, but the label to assign the copied point cloud must be different. - Specifies a new label in the destination M_POINT_CLOUD_CONTAINER result buffer in which to copy the source point cloud. - Specifies the attribute on which the condition is based. - Specifies the identifier of the image buffer to use as an input condition. - Specifies the condition under which pixel values are considered true for copying the corresponding point in a point cloud. - Specifies the lower limit of the selected condition. - Specifies the upper limit of the selected condition. - Reserved for future expansion and must be set to M_DEFAULT . - - - Exports one or more point clouds from an M_POINT_CLOUD_CONTAINER result buffer to a CAD file. - Specifies the name and path of the CAD file in which to save the data buffer. - Specifies the file format of the CAD file. - Specifies the identifier of the 3D reconstruction result buffer containing the point clouds to export. - Specifies the label or index of a specific point cloud in the M_POINT_CLOUD_CONTAINER result buffer. - Specifies which points of the point cloud(s) to export. - Specifies to cast the position coordinates into the specified data type and depth. - Specifies whether to export the intensity values and, if exporting, specifies the data type and depth to which to cast the intensity values. - Reserved for future expansion and must be set to M_DEFAULT . - - - Generate a depth map image and, optionally, an intensity map image from data stored in a 3D reconstruction result buffer. - Specifies the identifier of the result buffer which contains the laser line data. - Specifies the identifier of the image buffer in which to store the depth map. The image buffer must be a 1-band, 8-bit or 16-bit unsigned buffer. - Specifies the identifier of the intensity image buffer. - Specifies the type of operation to perform. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer from which to create a fully corrected depth map. - Reserved for future expansion. This parameter must be set to M_DEFAULT . - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Retrieve the world coordinates and intensity of each of the points in one or more point clouds. - Specifies the identifier of the 3D reconstruction result buffer from which to retrieve the information about the points. The 3D reconstruction result buffer must have been previously allocated using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the point cloud(s) in the specified 3D reconstruction result buffer. - Specifies the feature to retrieve from the point cloud(s). - Specifies which points to include in the array(s). - Specifies to cast the point cloud data into one or more arrays of the specified data type and depth. - Specifies the maximum number of elements that the arrays can hold. - Specifies the address of the array in which to store the retrieved data. - Specifies the address of the array in which to store the Y-coordinates. - Specifies the address of the array in which to store the Z-coordinates. - Specifies the address of the variable in which to write the number of array elements needed for this function, given the specified point cloud(s) and values for the PointsToInclude parameter. - The returned value is the size that the arrays needed to store all the data. The PointsToInclude parameter can modify the total number of points returned, and so can modify the return value of this function. - - - Import a computer-aided design (CAD) file as a new point cloud. - Specifies the name and path of the file from which to import the point cloud. - Specifies the file format of the file to import. - Specifies the identifier of the 3D reconstruction result buffer, allocated using M3dmapAllocResult, into which to import the CAD file information. - Specifies a label for the point cloud in the specified result buffer into which the CAD file information is imported. - Specifies a calibrated MIL object whose relative coordinate system is used to interpret the given 3D points. - Reserved for future expansion and must be set to M_DEFAULT . - - - Calculates a distance between a source point cloud and a source geometry object. - Specifies the identifier of a 3D reconstruction result buffer containing the source point cloud. - Specifies a point cloud in the source M_POINT_CLOUD_CONTAINER result buffer. - Specifies the identifier of a geometry object or, if set to M_NULL , indicates the calculated metric applies to the source point cloud only. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies the identifier of the destination image buffer in which to put the result of the calculate operation. - Specifies the operation to perform. - Reserved for future expansion and must be set to M_DEFAULT . - - - Store world points inside a new or existing unorganized point cloud. - Specifies the identifier of the 3D reconstruction result buffer in which to store the points. - Specifies the label or index of the point cloud in which to add or replace point data. - Specifies the type of data (position or intensity) to overwrite/add to the point cloud. - Specifies a combination of two values: the data type and depth of the data in the arrays. - Specifies the number of elements in each specified array. - Specifies the address of an array containing the X-coordinates or the intensities of the points, or a packed array containing all the data of the points. - Specifies the address of an array containing the Y-coordinates of the points. - Specifies the address of an array containing the Z-coordinates of the points. - Specifies a calibrated MIL object whose relative coordinate system is used to express the given 3D points. - Specifies if points are added to the point cloud, or features are changed. - - - Store world points inside a new or existing unorganized point cloud. - Specifies the identifier of the 3D reconstruction result buffer in which to store the points. - Specifies the label or index of the point cloud in which to add or replace point data. - Specifies the type of data (position or intensity) to overwrite/add to the point cloud. - Specifies a combination of two values: the data type and depth of the data in the arrays. - Specifies the number of elements in each specified array. - Specifies the address of an array containing the X-coordinates or the intensities of the points, or a packed array containing all the data of the points. - Specifies the address of an array containing the Y-coordinates of the points. - Specifies the address of an array containing the Z-coordinates of the points. - Specifies a calibrated MIL object whose relative coordinate system is used to express the given 3D points. - Specifies if points are added to the point cloud, or features are changed. - - - Store world points inside a new or existing unorganized point cloud. - Specifies the identifier of the 3D reconstruction result buffer in which to store the points. - Specifies the label or index of the point cloud in which to add or replace point data. - Specifies the type of data (position or intensity) to overwrite/add to the point cloud. - Specifies a combination of two values: the data type and depth of the data in the arrays. - Specifies the number of elements in each specified array. - Specifies the address of an array containing the X-coordinates or the intensities of the points, or a packed array containing all the data of the points. - Specifies the address of an array containing the Y-coordinates of the points. - Specifies the address of an array containing the Z-coordinates of the points. - Specifies a calibrated MIL object whose relative coordinate system is used to express the given 3D points. - Specifies if points are added to the point cloud, or features are changed. - - - Store world points inside a new or existing unorganized point cloud. - Specifies the identifier of the 3D reconstruction result buffer in which to store the points. - Specifies the label or index of the point cloud in which to add or replace point data. - Specifies the type of data (position or intensity) to overwrite/add to the point cloud. - Specifies a combination of two values: the data type and depth of the data in the arrays. - Specifies the number of elements in each specified array. - Specifies the address of an array containing the X-coordinates or the intensities of the points, or a packed array containing all the data of the points. - Specifies the address of an array containing the Y-coordinates of the points. - Specifies the address of an array containing the Z-coordinates of the points. - Specifies a calibrated MIL object whose relative coordinate system is used to express the given 3D points. - Specifies if points are added to the point cloud, or features are changed. - - - Store world points inside a new or existing unorganized point cloud. - Specifies the identifier of the 3D reconstruction result buffer in which to store the points. - Specifies the label or index of the point cloud in which to add or replace point data. - Specifies the type of data (position or intensity) to overwrite/add to the point cloud. - Specifies a combination of two values: the data type and depth of the data in the arrays. - Specifies the number of elements in each specified array. - Specifies the address of an array containing the X-coordinates or the intensities of the points, or a packed array containing all the data of the points. - Specifies the address of an array containing the Y-coordinates of the points. - Specifies the address of an array containing the Z-coordinates of the points. - Specifies a calibrated MIL object whose relative coordinate system is used to express the given 3D points. - Specifies if points are added to the point cloud, or features are changed. - - - Store world points inside a new or existing unorganized point cloud. - Specifies the identifier of the 3D reconstruction result buffer in which to store the points. - Specifies the label or index of the point cloud in which to add or replace point data. - Specifies the type of data (position or intensity) to overwrite/add to the point cloud. - Specifies a combination of two values: the data type and depth of the data in the arrays. - Specifies the number of elements in each specified array. - Specifies the address of an array containing the X-coordinates or the intensities of the points, or a packed array containing all the data of the points. - Specifies the address of an array containing the Y-coordinates of the points. - Specifies the address of an array containing the Z-coordinates of the points. - Specifies a calibrated MIL object whose relative coordinate system is used to express the given 3D points. - Specifies if points are added to the point cloud, or features are changed. - - - Store world points inside a new or existing unorganized point cloud. - Specifies the identifier of the 3D reconstruction result buffer in which to store the points. - Specifies the label or index of the point cloud in which to add or replace point data. - Specifies the type of data (position or intensity) to overwrite/add to the point cloud. - Specifies a combination of two values: the data type and depth of the data in the arrays. - Specifies the number of elements in each specified array. - Specifies the address of an array containing the X-coordinates or the intensities of the points, or a packed array containing all the data of the points. - Specifies the address of an array containing the Y-coordinates of the points. - Specifies the address of an array containing the Z-coordinates of the points. - Specifies a calibrated MIL object whose relative coordinate system is used to express the given 3D points. - Specifies if points are added to the point cloud, or features are changed. - - - Store world points inside a new or existing unorganized point cloud. - Specifies the identifier of the 3D reconstruction result buffer in which to store the points. - Specifies the label or index of the point cloud in which to add or replace point data. - Specifies the type of data (position or intensity) to overwrite/add to the point cloud. - Specifies a combination of two values: the data type and depth of the data in the arrays. - Specifies the number of elements in each specified array. - Specifies the address of an array containing the X-coordinates or the intensities of the points, or a packed array containing all the data of the points. - Specifies the address of an array containing the Y-coordinates of the points. - Specifies the address of an array containing the Z-coordinates of the points. - Specifies a calibrated MIL object whose relative coordinate system is used to express the given 3D points. - Specifies if points are added to the point cloud, or features are changed. - - - Set the extraction box used for depth map extraction. - Specifies the identifier of the 3D reconstruction result buffer for which to specify the extraction box. The 3D reconstruction result buffer must be a point cloud container, which means it must have been allocated on the required system using M3dmapAllocResult with M_POINT_CLOUD_CONTAINER. - Specifies the type of box to set. - Specifies how the extraction box is defined. - Specifies the X-coordinate of the first point used to define the extraction box, or specifies a MIL identifier used to define the extraction box. - Specifies the Y-coordinate of the first point used to define the extraction box. - Specifies the Z-coordinate of the first point used to define the extraction box. - Specifies the X-coordinate of the second point used to define the extraction box, or the length of the extraction box along the X-axis. - Specifies the Y-coordinate of the second point used to define the extraction box, or the length of the extraction box along the Y-axis. - Specifies the Z-coordinate of the second point used to define the extraction box, or the length of the extraction box along the Z-axis. - - - Define a geometry object, either parametrically or by fitting it to a depth map or point cloud. - Specifies the identifier of a geometry object. - Specifies the type of geometry object to define. - Specifies whether to define the geometry object by providing explicit values for the geometry's equation or by applying a best-fit geometry operation on the depth map or point cloud. - Specifies information about the geometry object used for the operation. - Specifies information about the geometry object used for the operation. - Specifies information about the geometry object used for the operation. - Specifies information about the geometry object used for the operation. - Specifies information about the geometry object used for the operation. - - - Compute a variety of statistics on a depth map. - Specifies the image buffer identifier of the depth map on which to compute statistics. - Specifies what will be used as reference level for statistics computation. - Specifies the identifier of the image buffer to use as a mask, if needed. - Specifies the result buffer identifier, if needed. - Specifies what statistics to compute. - Specifies the outlier distance to use to exclude pixels from the statistics. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies where to write the results, if needed. - - - Compute a variety of statistics on a depth map. - Specifies the image buffer identifier of the depth map on which to compute statistics. - Specifies what will be used as reference level for statistics computation. - Specifies the identifier of the image buffer to use as a mask, if needed. - Specifies the result buffer identifier, if needed. - Specifies what statistics to compute. - Specifies the outlier distance to use to exclude pixels from the statistics. - Reserved for future expansion and must be set to M_DEFAULT . - Specifies where to write the results, if needed. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Get the specified type of result(s) from a Pattern Matching result buffer. - Specifies the identifier of the Pattern Matching result buffer from which to retrieve results. - Specifies the type of result to retrieve for each model occurrence. - Specifies the address of the one-dimensional array in which to write the specified results. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer. - Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. - Specifies the parameter about which to inquire. - Specifies the address in which to write the requested information. - The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information. - - - Save a Pattern Matching context to disk. - Specifies the name and path of the file in which to save the model. - Specifies the identifier of the Pattern Matching context to save. - - - Save a Pattern Matching context to disk. - Specifies the name and path of the file in which to save the model. - Specifies the identifier of the Pattern Matching context to save. - - - Automatically allocate unique pattern matching models of the specified type, from a source image. - Specifies the system on which to allocate the models. - Specifies the identifier of the image buffer from which to extract the models. - Specifies the width of the required models. - Specifies the height of the required models. - Specifies the maximum displacement (shift) expected between the reference position of the models in the source image and their position when found in the target images in the horizontal direction. - Specifies the maximum displacement (shift) expected between the reference position of the models in the source image and their position when found in the target images in the vertical direction. - Specifies the type of the model. - Specifies the speed of the allocation process. - Specifies the address of the array in which to write the model identifiers. - The returned value is the model identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Automatically allocate unique pattern matching models of the specified type, from a source image. - Specifies the system on which to allocate the models. - Specifies the identifier of the image buffer from which to extract the models. - Specifies the width of the required models. - Specifies the height of the required models. - Specifies the maximum displacement (shift) expected between the reference position of the models in the source image and their position when found in the target images in the horizontal direction. - Specifies the maximum displacement (shift) expected between the reference position of the models in the source image and their position when found in the target images in the vertical direction. - Specifies the type of the model. - Specifies the speed of the allocation process. - Specifies the address of the array in which to write the model identifiers. - The returned value is the model identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Automatically allocate unique pattern matching models of the specified type, from a source image. - Specifies the system on which to allocate the models. - Specifies the identifier of the image buffer from which to extract the models. - Specifies the width of the required models. - Specifies the height of the required models. - Specifies the maximum displacement (shift) expected between the reference position of the models in the source image and their position when found in the target images in the horizontal direction. - Specifies the maximum displacement (shift) expected between the reference position of the models in the source image and their position when found in the target images in the vertical direction. - Specifies the type of the model. - Specifies the speed of the allocation process. - Specifies the address of the array in which to write the model identifiers. - The returned value is the model identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a pattern matching model from a source image. - Specifies the system on which to allocate the model. - Specifies the identifier of the image buffer from which to extract the model (that is, the model's source image). This function currently supports only 8-bit unsigned grayscale images. - Specifies the coordinates of the model origin in the source image ( SrcImageBufId ). - Specifies the coordinates of the model origin in the source image ( SrcImageBufId ). - Specifies the width of the model. - Specifies the height of the model. - Specifies the type of the model. - Specifies the address of the variable in which to write the model identifier. - The returned value is the model identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Allocate a pattern matching model from a source image. - Specifies the system on which to allocate the model. - Specifies the identifier of the image buffer from which to extract the model (that is, the model's source image). This function currently supports only 8-bit unsigned grayscale images. - Specifies the coordinates of the model origin in the source image ( SrcImageBufId ). - Specifies the coordinates of the model origin in the source image ( SrcImageBufId ). - Specifies the width of the model. - Specifies the height of the model. - Specifies the type of the model. - Specifies the address of the variable in which to write the model identifier. - The returned value is the model identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Rotate a pattern matching model. - Specifies the system on which to allocate the rotated model. - Specifies the identifier of the source model. - Specifies the angle at which to rotate the model in a counter-clockwise direction. - Specifies the mode of interpolation. - Specifies the type of the new model. - Specifies the address of the variable in which to write the rotated model identifier. - The returned value is the model identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Rotate a pattern matching model. - Specifies the system on which to allocate the rotated model. - Specifies the identifier of the source model. - Specifies the angle at which to rotate the model in a counter-clockwise direction. - Specifies the mode of interpolation. - Specifies the type of the new model. - Specifies the address of the variable in which to write the rotated model identifier. - The returned value is the model identifier if the allocation is successful. If allocation fails, M_NULL is returned. - - - Copy a pattern matching model to an image buffer. - Specifies the identifier of the model that you want copied to the image buffer. - Specifies the identifier of the destination image buffer in which to place the model. - Specifies how the model will be copied. - - - Find a pattern matching model in the target image buffer. - Specifies the identifier of the target image. - Specifies the identifier of the model for which to search in the specified target image buffer. - Specifies the identifier of the pattern matching result buffer in which to store results. - - - Find multiple pattern matching models in the target image buffer. - Specifies the identifier of the target image buffer. - Specifies the address of the one-dimensional array that contains the identifiers of the models for which to search in the specified target image buffer. - Specifies the address of the one-dimensional array that contains the identifiers of the pattern matching result buffers in which to store results. - Specifies the number of models. - Specifies the search mode. - - - Find multiple pattern matching models in the target image buffer. - Specifies the identifier of the target image buffer. - Specifies the address of the one-dimensional array that contains the identifiers of the models for which to search in the specified target image buffer. - Specifies the address of the one-dimensional array that contains the identifiers of the pattern matching result buffers in which to store results. - Specifies the number of models. - Specifies the search mode. - - - Get the number of model occurrences found in the target image. - Specifies the identifier of the pattern matching result buffer that was used to store results obtained by MpatFindModel . - Specifies the address of the variable in which to write the number of occurrences. - The returned value is the number of occurrences of the model that were found and that were greater than or equal to the acceptance level. - - - Get the number of model occurrences found in the target image. - Specifies the identifier of the pattern matching result buffer that was used to store results obtained by MpatFindModel . - Specifies the address of the variable in which to write the number of occurrences. - The returned value is the number of occurrences of the model that were found and that were greater than or equal to the acceptance level. - - - Preprocess a pattern matching model. - Specifies the identifier of a typical target image. - Specifies the identifier of the model to preprocess. - Specifies the preprocessing mode. Set this parameter to M_DEFAULT. - - - Restore a Pattern Matching context from disk. - Specifies the name and path of the file from which to restore the model. - Specifies the system on which to restore the model. - Specifies the address of the variable in which to write the Pattern Matching context identifier. - The returned value is the Pattern Matching context identifier. If allocation fails, M_NULL is returned. - - - Restore a Pattern Matching context from disk. - Specifies the name and path of the file from which to restore the model. - Specifies the system on which to restore the model. - Specifies the address of the variable in which to write the Pattern Matching context identifier. - The returned value is the Pattern Matching context identifier. If allocation fails, M_NULL is returned. - - - Set the acceptance level of a model. - Specifies the identifier of the model for which to change the acceptance threshold search parameter. - Specifies the acceptance level, as a percentage. - - - Set the positional accuracy of a model. - Specifies the identifier of the model for which to change the positional accuracy search parameter. - Specifies the required positional accuracy for the search. - - - Set the angular search parameters of a model. - Specifies the identifier of the model for which to change the angular search parameter. - Specifies the type of control to set. - Specifies the value to which to set the control. - - - Set the reference position of a model. - Specifies the identifier of the model for which to change the reference position. - Specifies the X-offset of the new model's reference position relative to the model origin. - Specifies the Y-offset of the new model's reference position relative to the model origin. - - - Set the certainty level of a model. - Specifies the identifier of the model for which to change the certainty threshold search parameter. - Specifies the certainty level, as a percentage. - - - Set the "don't care" pixels in a model. - Specifies the identifier of the model in which to set "don't care" pixels. - Specifies the identifier of the image buffer used to identify which pixels in the model will be set to "don't care". - Specifies the X-offset from the upper-left corner of the specified image buffer to the upper-left corner of the pixel-value comparison area. - Specifies the Y-offset from the upper-left corner of the specified image buffer to the upper-left corner of the pixel-value comparison area. - Specifies the pixel value in the image buffer that determine the corresponding "don't care" pixels. - - - Set the expected number of occurrences of a model. - Specifies the identifier of the model for which to set the expected number of occurrences. - Specifies the maximum number of occurrences for which to look in the target image. - - - Set the search region of a model. - Specifies the identifier of the model for which to change the search region. - Specifies the X-coordinate of the top-left corner of the search region in the target image. - Specifies the Y-coordinate of the top-left corner of the search region in the target image. - Specifies the width of the search region. - Specifies the height of the search region. - - - Set the internal search parameters of a model. - Specifies the identifier of the model whose search parameter to change, or of the result buffer. - Specifies the search parameter to set. - Specifies the value to which to set the specified parameter. - - - Set search speed of a model. - Specifies the identifier of the model for which to change the speed parameter. - Specifies the search speed. Set this parameter to one of the values below. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - - - Edit a specified font. - Specifies the String Reader context that contains the font to edit. - Specifies the index of the font to edit. - Specifies the operation to be performed. - Specifies the mode of the operation. - Specifies a value that is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - Specifies the address of the value that will be used to edit the font. The value is dependent on the operation and mode chosen. - - - - Marks the program element as deprecated with a version number indicating since when - it has been deprecated. - - - - - Gets the deprecated version number. - - - This corresponds to the value of the MIL_DEPRECATED() macro. - - - - - Extracts event information from a MIL buffer modified event Id and returns a new BufferModifiedEventArgs object. - - The MIL identifier of the buffer modified event. - A new BufferModifiedEventArgs object containing the information describing the MIL buffer modified event. - - - - Creates a new instance of a BufferModifiedEventArgs object containing information about a MIL buffer modified event. - - The MIL identifier of the modified buffer. - Whether the buffer modification event was triggered by a move operation performed by MbufChildMove(); that is, the buffer is a child buffer and its X/Y offset was changed. - The X-offset of the modified region (of the buffer). - The Y-offset of the modified region (of the buffer). - The width of the modified region (of the buffer). - The height of the modified region (of the buffer). - Whether the buffer modification event was triggered by a resize operation performed by MbufChildMove(); that is; the buffer is a child buffer and its X/Y size was changed. - - - - Gets the MIL identifier of the modified buffer. - - - - - Gets whether the buffer modification event was triggered by a move operation performed by MbufChildMove(); that is, the buffer is a child buffer and its X/Y offset was changed. - - - - - Gets the X-offset of the modified region (of the buffer). - - - - - Gets the Y-offset of the modified region (of the buffer). - - - - - Gets the width of the modified region (of the buffer). - - - - - Gets the height of the modified region (of the buffer). - - - - - Gets whether the buffer modification event was triggered by a resize operation performed by MbufChildMove(); that is; the buffer is a child buffer and its X/Y size was changed. - - - - - Returns the DisplaySurface object attached to the specified display. - - The display from which to obtain the DisplaySurface object. - A DisplaySurface object instance or null if no display surface is attached to the display. - - - - Creates a DisplaySurface object and attaches it to the specified display. - - The display to which this surface belongs. - - - - Creates a DisplaySurface object with the specified size and attaches it to the specified display. - - The display to which this surface belongs. - The initial size in X of the surface. - The initial size in Y of the surface. - - - - Creates a DisplaySurface object with the specified size and attaches it to the specified display. - - The display to which this surface belongs. - The initial size in X of the surface. - The initial size in Y of the surface. - The maximum size in X of the surface. - The maximum size in Y of the surface. - - - - Returns the MIL_ID of the display this surface belongs to. - - - - - Locks the surface to allow obtaining a valid buffer address. - - - - - Unlocks the surface. - - - - - Gets the MIL_ID of the surface buffer. - - - - - Returns the location of the surface buffer. - - - Returns M_LOCAL if the buffer was allocated on a local system. - Returns M_REMOTE if the buffer was allocated on a remote system. - - - - - Returns an array representing the pixels of this DisplaySurface object. - - - - - - Returns a pointer to the surface's pixel data. - - - - - Returns the size in byte of a row of pixels. - - - - - Gets the current size in X of this display surface. - - - - - Gets the current size in Y of this display surface. - - - - - Gets the maximum size in X this display surface can be resized. - - - - - Gets the maximum size in Y this display surface can be resized. - - - - - Attempts to resize the DisplaySurface to the specified size. - - The requested size in X. This parameter must be less or equal to MaximumSizeX - The requested size in Y. This parameter must be less or equal to MaximumSizeY - Thrown when the requested size is larger than the maximum size of the surface. - - - - Occurs when the surface buffer is modified. - - - - - Notifies listeners that the surface buffer was modified. - - A BufferModifiedEventArgs object defining this event. - - - - Handles the ObjectFree event on the display ID. - - - - - - - Releases the resources of the DisplaySurface object. - - - - - Constructs an ObjectFreedEventArgs object from a MIL event Id. - - - - - - - Encapsulates the M_OBJECT_FREE and provides a .NET event. - - - - - Constructs an ObjectFreedHookHandler for the specified object. - - - - - - Writes a value to unmanaged memory. - - The address in unmanaged memory to write to. - The value to write. - - - - Writes a value to unmanaged memory. - - The address in unmanaged memory to write to. - The value to write. - - - - Writes a value to unmanaged memory. - - The address in unmanaged memory to write to. - The value to write. - - - - Initializes a new instance of the using the specified array . - - A 16-element byte array containing values with which to initialize the . - b is null. - b is not 16 bytes long. - - - - Initializes a new instance of the using the value represented by the specified string. - - A string that contains a in one of the following formats ("d" represents - a hexadecimal digit whose case is ignored): 32 contiguous digits: dddddddddddddddddddddddddddddddd - -or- Groups of 8, 4, 4, 4, and 12 digits with hyphens between the groups. The - entire can optionally be enclosed in matching braces or parentheses: dddddddd-dddd-dddd-dddd-dddddddddddd - -or- {dddddddd-dddd-dddd-dddd-dddddddddddd} -or- (dddddddd-dddd-dddd-dddd-dddddddddddd) - -or- Groups of 8, 4, and 4 digits, and a subset of eight groups of 2 digits, - with each group prefixed by "0x" or "0X", and separated by commas. The entire - , as well as the subset, is enclosed in matching braces: {0xdddddddd, 0xdddd, - 0xdddd,{0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd,0xdd}} All braces, commas, and "0x" - prefixes are required. All embedded spaces are ignored. All leading zeros in - a group are ignored.The digits shown in a group are the maximum number of meaningful - digits that can appear in that group. You can specify from 1 to the number of - digits shown for a group. The specified digits are assumed to be the low-order - digits of the group. - - g is null. - The format of g is invalid. - The format of g is invalid. - - - - Initializes a new instance of the using the specified integers and byte array. - - The first 4 bytes of the . - The next 2 bytes of the . - The next 2 bytes of the . - The remaining 8 bytes of the . - d is null. - d is not 8 bytes long. - - - - Initializes a new instance of the using the specified unsigned integers and bytes. - - The first 4 bytes of the . - The next 2 bytes of the . - The next 2 bytes of the . - The next byte of the . - The next byte of the . - The next byte of the . - The next byte of the . - The next byte of the . - The next byte of the . - The next byte of the . - The next byte of the . - - - - Initializes a new instance of the using the specified unsigned integers and bytes. - - The first 4 bytes of the . - The next 2 bytes of the . - The next 2 bytes of the . - The next byte of the . - The next byte of the . - The next byte of the . - The next byte of the . - The next byte of the . - The next byte of the . - The next byte of the . - The next byte of the . - - - - Returns a string representation of the value of this instance in registry format. - - - The value of this , formatted using the "D" format specifier as follows: - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx where the value of the is represented - as a series of lowercase hexadecimal digits in groups of 8, 4, 4, 4, and 12 digits - and separated by hyphens. An example of a return value is "382c74c3-721d-4f34-80e5-57657b6cbc27". - - - - - Returns a value that indicates whether this instance is equal to a specified object. - - The object to compare with this instance. - true if is a that has the same value as this instance; otherwise, false. - - - - Returns the hash code for this instance. - - The hash code for this instance. - - - Indicates whether the values of two specified objects are equal. - true if and are equal; otherwise, false. - The first object to compare. - The second object to compare. - - - Indicates whether the values of two specified objects are not equal. - true if and are not equal; otherwise, false. - The first object to compare. - The second object to compare. - - - Compares this instance to a specified object and returns an indication of their relative values. - A signed number indicating the relative values of this instance and .Return value Description A negative integer This instance is less than . Zero This instance is equal to . A positive integer This instance is greater than , or is null. - An object to compare, or null. - - is not a . - - - - - Compares this instance to a specified object and returns an indication of their relative values. - - A signed number indicating the relative values of this instance and .Return value Description A negative integer This instance is less than . Zero This instance is equal to . A positive integer This instance is greater than . - An object to compare to this instance. - - - - Returns a value indicating whether this instance and a specified object represent the same value. - - An object to compare to this instance. - true if g is equal to this instance; otherwise, false. - - - - Provides mechanism for exception handling in wrapper. - It handles both synchronous and asynchronus error. - To handle asynchronous error, you must register the client class - to the event - - - - - Event raised when an async MIL exception occurs. - - - - - This method is being called when a MIL Exception occurs - - - - - - - - - This method allow us to call the private method - MILExceptionHandlerFunction. We need to call it in some unit tests - and we use reflection to call it. We do not call directly - MILExceptionHandlerFunction because for the parameter MIL_ID it throws - an ArgumentException. - - - - - - - - Method called to fire the event of a MIL Asynchronous exception - - - - - - Method used to register a call so that when MIL reports an exception, we will - be able to differentiate is the error was synchronous or asynchronous. - If we omit to register the MIL calls we do, every MIL exception will then be - treated as asynchronous exception. - - - - - Method used when we called a MILFunction to check if there was - an error during the call. This is to be used with synchronous - MIL calls. - - - - - - This exception is throw when a MIL object is not freed at the end of the application. - The exception message contains a call stack where each object had been allocated. - - - - - An object used to store custom information in a MIL display when using - a WPF to display images. - - - - - Creates a new instance. - - The display's to attach this instance to. - The of the image buffer to be displayed. - The object used to host the MIL display specified by . - This object keeps a weak reference to . - - - - Returns the of the display this object is attached to. - - - - - Returns the of the image buffer selected on this display. - - The returned can be M_NULL. - - - - Returns the object whose handle is passed to MIL to draw into. - - - - - Updates the image buffer selected on the display. - - The new of the buffer selected on the display. - - - This function resizes the user control specified by to match the buffer's size. - If is the same as , this function does nothing. - - - - - - Updates the object that is hosting the MIL display specified by . - - The new object that will host the MIL display. - - - - This function removes the child of the currently associated if it is hosting the UserControl specified by . - - If is the same as , this function does nothing. - - - - - - Returns a object from the specified by . - - An object that represents a GCHandle object. - The object that the represents. - The target object represented by is not a object. - If is , this method returns null. - - - - Returns the object attached to the display specified by . - - The of the display to get the attached info object from. - The object attached to the specified display, or null if no object is currently attached. - - - - Gets a strong reference to the object used to host the MIL display. - specified by . - - The object used to host the display, or null if the object has already been garbage collected. - - - - Attaches the specified to the MIL display specified by . - - An obtained from a allocated on this instance. - - - - Updates the image buffer selected on the display. - - The new of the buffer selected on the display. - Forces an update event if is the same as - - - This function resizes the user control specified by to match the buffer's size. - If is the same as and is false, this function does nothing. - - - - - - Updates the object that is hosting the MIL display specified by . - - The new object that will host the MIL display. - Forces an update event if is the same as - - - - This function removes the child of the currently associated if it is hosting the UserControl specified by . - - If is the same as the object returned by and is false, this function does nothing. - - - - - - Performs cleanup when the display represented by is freed. - - The type of hook received. This paramter should be M_OBJECT_FREE. - The decribing this event. - User data pointer. This paramter should be the integer representation of a GCHandle representing a - . - - - - Asserts that the object represented by is a M_DISPLAY object. - - The of the object to assert the type of. - This function is not compiled in release builds. - - - - Performs cleanup of the object. - - When this method is called, the object's finalizer is suppressed. - - - - Performs cleanup of the object. - - A value indicating if the method was called - by the IDisposable.Dispose() method or by the object's finalizer. If True/>, - the method was called by the IDisposable.Dispose() method. If False, the method was called - by the object's finalizer. - - - - - Finalizes the object. - - - - - This class provides the means to monitor allocations of MIL objects and report an error when objects are not freed. - Usage : Set the property to true to monitor MIL object allocations. - When an object is not freed, a is thrown. - - - - - Gets or sets whether or not MIL object allocations will be monitored. - Typical usage of this property is to set it to true in Debug configurations. - The default value is false. - - - - - Enumerates currently allocated MIL_ID and their allocation StackTrace. - - - - - - Attaches the specified to the specified . - - The of the diplay to attach info to. - An obtained from a allocated on a managed object instance. - - - - Gets the .NET info pointer of the specified . - - The of the diplay to attach info to. - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Bcl.AsyncInterfaces.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Bcl.AsyncInterfaces.dll deleted file mode 100644 index 6031ba1..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Bcl.AsyncInterfaces.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Bcl.AsyncInterfaces.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Bcl.AsyncInterfaces.xml deleted file mode 100644 index e75808a..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Bcl.AsyncInterfaces.xml +++ /dev/null @@ -1,417 +0,0 @@ - - - - Microsoft.Bcl.AsyncInterfaces - - - - Provides the core logic for implementing a manual-reset or . - - - - - The callback to invoke when the operation completes if was called before the operation completed, - or if the operation completed before a callback was supplied, - or null if a callback hasn't yet been provided and the operation hasn't yet completed. - - - - State to pass to . - - - to flow to the callback, or null if no flowing is required. - - - - A "captured" or with which to invoke the callback, - or null if no special context is required. - - - - Whether the current operation has completed. - - - The result with which the operation succeeded, or the default value if it hasn't yet completed or failed. - - - The exception with which the operation failed, or null if it hasn't yet completed or completed successfully. - - - The current version of this value, used to help prevent misuse. - - - Gets or sets whether to force continuations to run asynchronously. - Continuations may run asynchronously if this is false, but they'll never run synchronously if this is true. - - - Resets to prepare for the next operation. - - - Completes with a successful result. - The result. - - - Complets with an error. - - - - Gets the operation version. - - - Gets the status of the operation. - Opaque value that was provided to the 's constructor. - - - Gets the result of the operation. - Opaque value that was provided to the 's constructor. - - - Schedules the continuation action for this operation. - The continuation to invoke when the operation has completed. - The state object to pass to when it's invoked. - Opaque value that was provided to the 's constructor. - The flags describing the behavior of the continuation. - - - Ensures that the specified token matches the current version. - The token supplied by . - - - Signals that the operation has completed. Invoked after the result or error has been set. - - - - Invokes the continuation with the appropriate captured context / scheduler. - This assumes that if is not null we're already - running within that . - - - - Provides a set of static methods for configuring -related behaviors on asynchronous enumerables and disposables. - - - Configures how awaits on the tasks returned from an async disposable will be performed. - The source async disposable. - Whether to capture and marshal back to the current context. - The configured async disposable. - - - Configures how awaits on the tasks returned from an async iteration will be performed. - The type of the objects being iterated. - The source enumerable being iterated. - Whether to capture and marshal back to the current context. - The configured enumerable. - - - Sets the to be passed to when iterating. - The type of the objects being iterated. - The source enumerable being iterated. - The to use. - The configured enumerable. - - - Represents a builder for asynchronous iterators. - - - Creates an instance of the struct. - The initialized instance. - - - Invokes on the state machine while guarding the . - The type of the state machine. - The state machine instance, passed by reference. - - - Schedules the state machine to proceed to the next action when the specified awaiter completes. - The type of the awaiter. - The type of the state machine. - The awaiter. - The state machine. - - - Schedules the state machine to proceed to the next action when the specified awaiter completes. - The type of the awaiter. - The type of the state machine. - The awaiter. - The state machine. - - - Marks iteration as being completed, whether successfully or otherwise. - - - Gets an object that may be used to uniquely identify this builder to the debugger. - - - Indicates whether a method is an asynchronous iterator. - - - Initializes a new instance of the class. - The type object for the underlying state machine type that's used to implement a state machine method. - - - Provides a type that can be used to configure how awaits on an are performed. - - - Asynchronously releases the unmanaged resources used by the . - A task that represents the asynchronous dispose operation. - - - Provides an awaitable async enumerable that enables cancelable iteration and configured awaits. - - - Configures how awaits on the tasks returned from an async iteration will be performed. - Whether to capture and marshal back to the current context. - The configured enumerable. - This will replace any previous value set by for this iteration. - - - Sets the to be passed to when iterating. - The to use. - The configured enumerable. - This will replace any previous set by for this iteration. - - - Returns an enumerator that iterates asynchronously through collections that enables cancelable iteration and configured awaits. - An enumerator for the class. - - - Provides an awaitable async enumerator that enables cancelable iteration and configured awaits. - - - Advances the enumerator asynchronously to the next element of the collection. - - A that will complete with a result of true - if the enumerator was successfully advanced to the next element, or false if the enumerator has - passed the end of the collection. - - - - Gets the element in the collection at the current position of the enumerator. - - - - Performs application-defined tasks associated with freeing, releasing, or - resetting unmanaged resources asynchronously. - - - - Allows users of async-enumerable methods to mark the parameter that should receive the cancellation token value from . - - - Initializes a new instance of the class. - - - - Attribute used to indicate a source generator should create a function for marshalling - arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time. - - - This attribute is meaningless if the source generator associated with it is not enabled. - The current built-in source generator only supports C# and only supplies an implementation when - applied to static, partial, non-generic methods. - - - - - Initializes a new instance of the . - - Name of the library containing the import. - - - - Gets the name of the library containing the import. - - - - - Gets or sets the name of the entry point to be called. - - - - - Gets or sets how to marshal string arguments to the method. - - - If this field is set to a value other than , - must not be specified. - - - - - Gets or sets the used to control how string arguments to the method are marshalled. - - - If this field is specified, must not be specified - or must be set to . - - - - - Gets or sets whether the callee sets an error (SetLastError on Windows or errno - on other platforms) before returning from the attributed method. - - - - - Specifies how strings should be marshalled for generated p/invokes - - - - - Indicates the user is suppling a specific marshaller in . - - - - - Use the platform-provided UTF-8 marshaller. - - - - - Use the platform-provided UTF-16 marshaller. - - - - Exposes an enumerator that provides asynchronous iteration over values of a specified type. - The type of values to enumerate. - - - Returns an enumerator that iterates asynchronously through the collection. - A that may be used to cancel the asynchronous iteration. - An enumerator that can be used to iterate asynchronously through the collection. - - - Supports a simple asynchronous iteration over a generic collection. - The type of objects to enumerate. - - - Advances the enumerator asynchronously to the next element of the collection. - - A that will complete with a result of true if the enumerator - was successfully advanced to the next element, or false if the enumerator has passed the end - of the collection. - - - - Gets the element in the collection at the current position of the enumerator. - - - Provides a mechanism for releasing unmanaged resources asynchronously. - - - - Performs application-defined tasks associated with freeing, releasing, or - resetting unmanaged resources asynchronously. - - - - Specifies that null is allowed as an input even if the corresponding type disallows it. - - - Specifies that null is disallowed as an input even if the corresponding type allows it. - - - Specifies that an output may be null even if the corresponding type disallows it. - - - Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns. - - - Specifies that when a method returns , the parameter may be null even if the corresponding type disallows it. - - - Initializes the attribute with the specified return value condition. - - The return value condition. If the method returns this value, the associated parameter may be null. - - - - Gets the return value condition. - - - Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. - - - Initializes the attribute with the specified return value condition. - - The return value condition. If the method returns this value, the associated parameter will not be null. - - - - Gets the return value condition. - - - Specifies that the output will be non-null if the named parameter is non-null. - - - Initializes the attribute with the associated parameter name. - - The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null. - - - - Gets the associated parameter name. - - - Applied to a method that will never return under any circumstance. - - - Specifies that the method will not return if the associated Boolean parameter is passed the specified value. - - - Initializes the attribute with the specified parameter value. - - The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to - the associated parameter matches this value. - - - - Gets the condition parameter value. - - - Specifies that the method or property will ensure that the listed field and property members have not-null values. - - - Initializes the attribute with a field or property member. - - The field or property member that is promised to be not-null. - - - - Initializes the attribute with the list of field and property members. - - The list of field and property members that are promised to be not-null. - - - - Gets field or property member names. - - - Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition. - - - Initializes the attribute with the specified return value condition and a field or property member. - - The return value condition. If the method returns this value, the associated parameter will not be null. - - - The field or property member that is promised to be not-null. - - - - Initializes the attribute with the specified return value condition and list of field and property members. - - The return value condition. If the method returns this value, the associated parameter will not be null. - - - The list of field and property members that are promised to be not-null. - - - - Gets the return value condition. - - - Gets field or property member names. - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Bcl.HashCode.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Bcl.HashCode.dll deleted file mode 100644 index 3f97f6e..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Bcl.HashCode.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Bcl.HashCode.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Bcl.HashCode.xml deleted file mode 100644 index d5c6c3d..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Bcl.HashCode.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - Microsoft.Bcl.HashCode - - - - - Rotates the specified value left by the specified number of bits. - Similar in behavior to the x86 instruction ROL. - - The value to rotate. - The number of bits to rotate by. - Any value outside the range [0..31] is treated as congruent mod 32. - The rotated value. - - - - Rotates the specified value left by the specified number of bits. - Similar in behavior to the x86 instruction ROL. - - The value to rotate. - The number of bits to rotate by. - Any value outside the range [0..63] is treated as congruent mod 64. - The rotated value. - - - HashCode is a mutable struct and should not be compared with other HashCodes. - - - HashCode is a mutable struct and should not be compared with other HashCodes. Use ToHashCode to retrieve the computed hash code. - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Extensions.Logging.Abstractions.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Extensions.Logging.Abstractions.dll deleted file mode 100644 index 1b1f204..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Extensions.Logging.Abstractions.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Xaml.Behaviors.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Xaml.Behaviors.dll deleted file mode 100644 index ba77c7d..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Xaml.Behaviors.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Xaml.Behaviors.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Xaml.Behaviors.xml deleted file mode 100644 index b8874a6..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/Microsoft.Xaml.Behaviors.xml +++ /dev/null @@ -1,2388 +0,0 @@ - - - - Microsoft.Xaml.Behaviors - - - - - Represents a collection of IAttachedObject with a shared AssociatedObject and provides change notifications to its contents when that AssociatedObject changes. - - - - - The object on which the collection is hosted. - - - - - Initializes a new instance of the class. - - Internal, because this should not be inherited outside this assembly. - - - - Called immediately after the collection is attached to an AssociatedObject. - - - - - Called when the collection is being detached from its AssociatedObject, but before it has actually occurred. - - - - - Called when a new item is added to the collection. - - The new item. - - - - Called when an item is removed from the collection. - - The removed item. - - - Cannot add the instance to a collection more than once. - - - - Gets the associated object. - - The associated object. - - - - Attaches to the specified object. - - The object to attach to. - The IAttachedObject is already attached to a different object. - - - - Detaches this instance from its associated object. - - - - - Encapsulates state information and zero or more ICommands into an attachable object. - - The type the can be attached to. - - Behavior is the base class for providing attachable state and commands to an object. - The types the Behavior can be attached to can be controlled by the generic parameter. - Override OnAttached() and OnDetaching() methods to hook and unhook any necessary handlers - from the AssociatedObject. - - - - - Initializes a new instance of the class. - - - - - Gets the object to which this is attached. - - - - - Encapsulates state information and zero or more ICommands into an attachable object. - - This is an infrastructure class. Behavior authors should derive from Behavior<T> instead of from this class. - - - - The type to which this behavior can be attached. - - - - - Gets the object to which this behavior is attached. - - - - - Called after the behavior is attached to an AssociatedObject. - - Override this to hook up functionality to the AssociatedObject. - - - - Called when the behavior is being detached from its AssociatedObject, but before it has actually occurred. - - Override this to unhook functionality from the AssociatedObject. - - - - Gets the associated object. - - The associated object. - - - - Attaches to the specified object. - - The object to attach to. - The Behavior is already hosted on a different element. - dependencyObject does not satisfy the Behavior type constraint. - - - - Detaches this instance from its associated object. - - - - - Represents a collection of behaviors with a shared AssociatedObject and provides change notifications to its contents when that AssociatedObject changes. - - - - - Initializes a new instance of the class. - - Internal, because this should not be inherited outside this assembly. - - - - Called immediately after the collection is attached to an AssociatedObject. - - - - - Called when the collection is being detached from its AssociatedObject, but before it has actually occurred. - - - - - Called when a new item is added to the collection. - - The new item. - - - - Called when an item is removed from the collection. - - The removed item. - - - - Creates a new instance of the BehaviorCollection. - - The new instance. - - - - This method evaluates operands. - - Left operand from the LeftOperand property. - Operator from Operator property. - Right operand from the RightOperand property. - Returns true if the condition is met; otherwise, returns false. - - - - Evaluates both operands that implement the IComparable interface. - - Left operand from the LeftOperand property. - Operator from Operator property. - Right operand from the RightOperand property. - Returns true if the condition is met; otherwise, returns false. - - - - A basic implementation of ICommand that wraps a method that takes no parameters or a method that takes one parameter. - - - - - Initializes a new instance of the class. - - The action. - Use this constructor to provide an action that ignores the ICommand parameter. - - - - Initializes a new instance of the class. - - An action that takes an object parameter. - Use this constructor to provide an action that uses the object parameter passed by the Execute method. - - - - Occurs when changes occur that affect whether the command should execute. Will not be fired by ActionCommand. - - - - - Defines the method that determines whether the command can execute in its current state. - - Data used by the command. If the command does not require data to be passed, then this object can be set to null. - - Always returns true. - - - - - Defines the method to be called when the command is invoked. - - Data used by the command. If the command does not require data to be passed, then this object can be set to null. - - - - Calls a method on a specified object when invoked. - - - - - The object that exposes the method of interest. This is a dependency property. - - - - - The name of the method to invoke. This is a dependency property. - - - - - Invokes the action. - - The parameter of the action. If the action does not require a parameter, the parameter may be set to a null reference. - - - - Called after the action is attached to an AssociatedObject. - - Override this to hook up functionality to the AssociatedObject. - - - - Called when the action is getting detached from its AssociatedObject, but before it has actually occurred. - - Override this to unhook functionality from the AssociatedObject. - - - - An action that will change a specified property to a specified value when invoked. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the name of the property to change. This is a dependency property. - - The name of the property to change. - - - - Gets or sets the value to set. This is a dependency property. - - The value to set. - - - - Gets or sets the duration of the animation that will occur when the ChangePropertyAction is invoked. This is a dependency property. - If the duration is unset, no animation will be applied. - - - - - Increment by Value if true; otherwise, set the value directly. If the property cannot be incremented, it will instead try to set the value directly. - - - - - Invokes the action. - - The parameter of the action. If the action does not require a parameter, then the parameter may be set to a null reference. - A property with could not be found on the Target. - Could not set to the value specified by . - - - - Represents one ternary condition. - - - - - Gets or sets the left operand. - - - - - Gets or sets the right operand. - - - - - Gets or sets the comparison operator. - - - - - Method that evaluates the condition. Note that this method can throw ArgumentException if the operator is - incompatible with the type. For instance, operators LessThan, LessThanOrEqual, GreaterThan, and GreaterThanOrEqual - require both operators to implement IComparable. - - Returns true if the condition has been met; otherwise, returns false. - - - - Ensure that any binding on DP operands are up-to-date. - - - - - Enumeration of different comparison operators. - - - - - Forward chaining. - - - - - Represents a conditional expression that is set on a ConditionBehavior.Condition property. - Contains a list of conditions that gets evaluated in order to return true or false for ICondition.Evaluate(). - - - - - Gets or sets forward chaining for the conditions. - If forward chaining is set to ForwardChaining.And, all conditions must be met. - If forward chaining is set to ForwardChaining.Or, only one condition must be met. - - - - - Return the Condition collections. - - - - - Initializes a new instance of the class. - - - - - Goes through the Conditions collection and evalutes each condition based on - ForwardChaining property. - - Returns true if conditions are met; otherwise, returns false. - - - - A behavior that attaches to a trigger and controls the conditions - to fire the actions. - - - - - - Gets or sets the IConditon object on behavior. - - The name of the condition to change. - - - - Initializes a new instance of the class. - - - - - The event handler that is listening to the preview invoke event that is fired by - the trigger. Setting PreviewInvokeEventArgs.Cancelling to True will - cancel the invocation. - - The trigger base object. - An object of type PreviewInvokeEventArgs where e.Cancelling can be set to True. - - - - Toggles between two states based on a conditional statement. - - - - - Gets or sets the binding that produces the property value of the data object. This is a dependency property. - - - - - Gets or sets the value to be compared with the property value of the data object. This is a dependency property. - - - - - Gets or sets the name of the visual state to transition to when the condition is met. This is a dependency property. - - - - - Gets or sets the name of the visual state to transition to when the condition is not met. This is a dependency property. - - - - - Called after the behavior is attached to an AssociatedObject. - - Override this to hook up functionality to the AssociatedObject. - - - - A helper function to take the place of FrameworkElement.IsLoaded, as this property isn't available in Silverlight. - - The element of interest. - Returns true if the element has been loaded; otherwise, returns false. - - - - Trigger designed to be bound to a data store property. Fires when the property changes. - - - - - Represents a trigger that performs actions when the bound data meets a specified condition. - - - - - Gets or sets the value to be compared with the property value of the data object. This is a dependency property. - - - - - Gets or sets the type of comparison to be performed between the specified values. This is a dependency property. - - - - - Called when the binding property has changed. - UA_REVIEW:chabiss - - argument. - - - - ExtendedVisualStateManager is a custom VisualStateManager that can smooth out the animation of layout properties. - With this custom VisualStateManager, states can include changes to properties like Grid.Column, can change element heights to or from Auto, and so on. - These changes will be smoothed out over time using the GeneratedDuration and GeneratedEasingFunction of the appropriate transition. - See the "VisualStateManager overrides" region below for a general description of the algorithm. - - - - - OriginalValueRecord remembers the original value of a property that was changed in a state. - - - - - A VisualStateGroup that can use FluidLayout or not. - - - - - Visibility is shadowed by a custom attached property at runtime. - - - - - A VisualStateGroup keeps a list of these original values in an attached property. - - - - - For every state, the layout-specific properties get extracted and then are attached to the state. These properties are removed from the state itself. - - - - - Remember the current state. - - - - - The TransitionEffect to use when the state changes. - - - - - The TransitionEffectStoryboard in use during the state change. - - - - - The cached background in use during the state change. - - - - - The cached background in use during the state change. - - - - - The cached background in use during the state change. - - - - - This is the set of elements that are currently in motion. - - - - - This is the storyboard that is animating the transition. - - - - - This list contains all the known layout properties. - - - - - Stop the animation and replace the layout changes that were made to support that animation. - - - - - Locate the transition that VisualStateManager will use to animate the change, so that the layout animation can match the duration and easing. - - The group in which the transition is taking place. - The state that you are coming from. - The state you are going to. - The transition - - - - Remove all layout-affecting properties from the Storyboard for the state and cache them in an attached property. - - The state you are moving to. - A Storyboard containing the layout properties in that state. - - - - The set of target elements is the set of all elements that might have moved in a layout transition. This set is the closure of: - - Elements with layout properties animated in the state. - - Siblings of elements in the set. - - Parents of elements in the set. - - Subsequent code will check these rectangles both before and after the layout change. - - The control whose layout is changing state. - The storyboard containing the layout changes. - Any previous values from previous state navigations that might be reverted. - The set of elements currently in motion, if there is a state change transition ongoing. - The full set of elements whose layout may have changed. - - - - Gets a set of rectangles for all the elements in the target list. - - The set of elements to consider. - The set of elements currently in motion. - A Dictionary mapping elements to their Rects. - - - - Get the layout rectangle of an element, by getting the layout slot and then computing which portion of the slot is being used. - - The element whose layout Rect will be retrieved. - The layout Rect of that element. - - - - Get the opacities of elements at the time of the state change, instead of visibilities, because the state change may be in process and the current value is the most important. - - The control whose state is changing. - The storyboard with the layout properties. - The set of original values. - - - - - Go through the layout Storyboard and set all the properties by using SetValue to enable calling UpdateLayout without - ticking the timeline, which would cause a render. - All values that are overwritten will be stored in the collection of OriginalValueRecords so that they can be replaced later. - - The control whose state is changing. - The Storyboard holding the layout properties. - The store of original values. - - - - Take all the elements that will be moving as a result of the layout animation, and wrap them in Canvas panels so that - they do not affect their sibling elements. - - The set of elements that will be moving. - - - - Take all the elements that have been moving as a result of the layout animation, and unwrap them from their Canvas panels. - - The set of elements that have been moving. - - - - Copy the layout properties from the source element to the target element, clearing them from the source. - - The source of the layout properties. - The destination of the layout properties. - - - - Create the actual Storyboard that will be used to animate the transition. Use all previously calculated results. - - The duration of the animation. - The easing function to be used in the animation. - The set of elements that will be moving. - The old opacities of the elements whose visibility properties are changing. - The Storyboard. - - - - An action that will transition a FrameworkElement to a specified VisualState when invoked. - - - If the TargetName property is set, this action will attempt to change the state of the targeted element. If not, it walks - the element tree in an attempt to locate an alternative target that defines states. ControlTemplate and UserControl are - two common possibilities. - - - - - Determines whether or not to use a VisualTransition to transition between states. - - - - - The name of the VisualState. - - - - - Called when the target changes. If the TargetName property isn't set, this action has custom behavior. - - - - Could not locate an appropriate FrameworkElement with states. - - - - This method is called when some criteria is met and the action is invoked. - - - Could not change the target to the specified StateName. - - - - An interface that a given object must implement in order to be - set on a ConditionBehavior.Condition property. - - - - - An action that will launch a process to open a file or Uri. For files, this action will launch the default program - for the given file extension. A Uri will open in a web browser. - - - - - The file or Uri to open. - - - - - This method is called when some criteria is met and the action is invoked. - - - - - - Represents a trigger that performs actions when the bound data have changed. - - - - - A binding object that the trigger will listen to, and that causes the trigger to fire when it changes. - - - - - Called when the binding property has changed. - - argument. - - - - Called after the trigger is attached to an AssociatedObject. - - - - - Called when the trigger is being detached from its AssociatedObject, but before it has actually occurred. - - - - - Called when the target changes. If the TargetName property isn't set, this action has custom behavior. - - - - Could not locate an appropriate FrameworkElement with states. - - - - Allows a user to remove the item from a ListBox ItemTemplate. - - - - - An action that will remove the targeted element from the tree when invoked. - - - This action may fail. The action understands how to remove elements from common parents but not from custom collections or direct manipulation - of the visual tree. - - - - - An action that will change the value of a property from a data store object. - This class is identical to ChangePropertyAction. The only difference is that the data store picker is loaded - for this action. - - - - - A trigger that is triggered by a specified event occurring on its source and fires after a delay when that event is fired. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the number of milliseconds to wait between ticks. This is a dependency property. - - - - - Gets or sets the total number of ticks to be fired before the trigger is finished. This is a dependency property. - - - - - Enumerates possible values for reusable property value editors. - - - - - Uses the element picker, if supported, to edit this property at design time. - - - - - Uses the storyboard picker, if supported, to edit this property at design time. - - - - - Uses the state picker, if supported, to edit this property at design time. - - - - - Uses the element-binding picker, if supported, to edit this property at design time. - - - - - Uses the property-binding picker, if supported, to edit this property at design time. - - - - - Associates the given editor type with the property on which the CustomPropertyValueEditor is applied. - - Use this attribute to get improved design-time editing for properties that denote element (by name), storyboards, or states (by name). - - - - Gets or sets the custom property value editor. - - The custom property value editor. - - - - Initializes a new instance of the class. - - The custom property value editor. - - - - Helper class for managing binding expressions on dependency objects. - - - - - Ensure that all DP on an action with binding expressions are - up to date. DataTrigger fires during data binding phase. Since - actions are children of the trigger, any bindings on the action - may not be up-to-date. This routine is called before the action - is invoked in order to guarantee that all bindings are up-to-date - with the most current data. - - - - - Ensures that all binding expression on actions are up to date - - - - - This helper function ensures that, if a dependency property on a dependency object - has a binding expression, the binding expression is up-to-date. - - - - - - - Provides design tools information about what to instantiate for a given action or command. - - - - - Gets the type that this DefaultTriggerAttribute applies to. - - The type this DefaultTriggerAttribute applies to. - - - - Gets the type of the to instantiate. - - The type of the to instantiate. - - - - Gets the parameters to pass to the constructor. - - The parameters to pass to the constructor. - - - - Initializes a new instance of the class. - - The type this attribute applies to. - The type of to instantiate. - A single argument for the specified . - is not derived from TriggerBase. - This constructor is useful if the specifed has a single argument. The - resulting code will be CLS compliant. - - - - Initializes a new instance of the class. - - The type this attribute applies to. - The type of to instantiate. - The constructor arguments for the specified . - is not derived from TriggerBase. - - - - Instantiates this instance. - - The specified by the DefaultTriggerAttribute. - - - - This method will use the VisualTreeHelper.GetParent method to do a depth first walk up - the visual tree and return all ancestors of the specified object, including the object itself. - - The object in the visual tree to find ancestors of. - Returns itself an all ancestors in the visual tree. - - - - EventObserver is designed to help manage event handlers by detatching when disposed. Creating this object will also attach in the constructor. - - - - - Creates an instance of EventObserver and attaches to the supplied event on the supplied target. Call dispose to detach. - - The event to attach and detach from. - The target object the event is defined on. Null if the method is static. - The delegate to attach to the event. - - - - Detaches the handler from the event. - - - - - A trigger that listens for a specified event on its source and fires when that event is fired. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the event. - - - - Gets or sets the name of the event to listen for. This is a dependency property. - - The name of the event. - - - - Represents a trigger that can listen to an element other than its AssociatedObject. - - The type that this trigger can be associated with. - - EventTriggerBase extends TriggerBase to add knowledge of another object than the one it is attached to. - This allows a user to attach a Trigger/Action pair to one element and invoke the Action in response to a - change in another object somewhere else. Override OnSourceChanged to hook or unhook handlers on the source - element, and OnAttached/OnDetaching for the associated element. The type of the Source element can be - constrained by the generic type parameter. If you need control over the type of the - AssociatedObject, set a TypeConstraintAttribute on your derived type. - - - - - Initializes a new instance of the class. - - - - - Gets the resolved source. If is not set or cannot be resolved, defaults to AssociatedObject. - - The resolved source object. - In general, this property should be used in place of AssociatedObject in derived classes. - - - - Called when the source property changes. - - Override this to hook functionality to and unhook functionality from the specified source, rather than the AssociatedObject. - The old source. - The new source. - - - - Represents a trigger that can listen to an object other than its AssociatedObject. - - This is an infrastructure class. Trigger authors should derive from EventTriggerBase<T> instead of this class. - - - - Gets the type constraint of the associated object. - - The associated object type constraint. - Define a TypeConstraintAttribute on a derived type to constrain the types it may be attached to. - - - - Gets the source type constraint. - - The source type constraint. - - - - Gets or sets the target object. If TargetObject is not set, the target will look for the object specified by TargetName. If an element referred to by TargetName cannot be found, the target will default to the AssociatedObject. This is a dependency property. - - The target object. - - - - Gets or sets the name of the element this EventTriggerBase listens for as a source. If the name is not set or cannot be resolved, the AssociatedObject will be used. This is a dependency property. - - The name of the source element. - - - - Gets the resolved source. If is not set or cannot be resolved, defaults to AssociatedObject. - - The resolved source object. - In general, this property should be used in place of AssociatedObject in derived classes. - The element pointed to by does not satisify the type constraint. - - - - Specifies the name of the Event this EventTriggerBase is listening for. - - - - - - Called when the event associated with this EventTriggerBase is fired. By default, this will invoke all actions on the trigger. - - The instance containing the event data. - Override this to provide more granular control over when actions associated with this trigger will be invoked. - - - - Called when the source changes. - - The old source. - The new source. - This function should be overridden in derived classes to hook functionality to and unhook functionality from the changing source objects. - - - - Called after the trigger is attached to an AssociatedObject. - - - - - Called when the trigger is being detached from its AssociatedObject, but before it has actually occurred. - - - - Could not find eventName on the Target. - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to Could not find method named '{0}' on object of type '{1}' that matches the expected signature.. - - - - - Looks up a localized string similar to Cannot set the same BehaviorCollection on multiple objects.. - - - - - Looks up a localized string similar to An instance of a Behavior cannot be attached to more than one object at a time.. - - - - - Looks up a localized string similar to Cannot host an instance of a TriggerAction in multiple TriggerCollections simultaneously. Remove it from one TriggerCollection before adding it to another.. - - - - - Looks up a localized string similar to Cannot set the same TriggerCollection on multiple objects.. - - - - - Looks up a localized string similar to An instance of a trigger cannot be attached to more than one object at a time.. - - - - - Looks up a localized string similar to More than one potential addition operator was found on type '{0}'.. - - - - - Looks up a localized string similar to Cannot animate a property change on a type '{0}' Target. Property changes can only be animated on types derived from DependencyObject.. - - - - - Looks up a localized string similar to Cannot find a property named "{0}" on type "{1}".. - - - - - Looks up a localized string similar to The Increment property cannot be set to True if the Duration property is set.. - - - - - Looks up a localized string similar to The '{0}' property cannot be incremented because its value cannot be read.. - - - - - Looks up a localized string similar to Cannot assign value of type "{0}" to property "{1}" of type "{2}". The "{1}" property can be assigned only values of type "{2}".. - - - - - Looks up a localized string similar to Property "{0}" defined by type "{1}" does not expose a set method and therefore cannot be modified.. - - - - - Looks up a localized string similar to The command "{0}" does not exist or is not publicly exposed on {1}.. - - - - - Looks up a localized string similar to Cannot find state named '{0}' on type '{1}'. Ensure that the state exists and that it can be accessed from this context.. - - - - - Looks up a localized string similar to "{0}" is not a valid type for the TriggerType parameter. Make sure "{0}" derives from TriggerBase.. - - - - - Looks up a localized string similar to Cannot add the same instance of "{0}" to a "{1}" more than once.. - - - - - Looks up a localized string similar to The event "{0}" on type "{1}" has an incompatible signature. Make sure the event is public and satisfies the EventHandler delegate.. - - - - - Looks up a localized string similar to Cannot find an event named "{0}" on type "{1}".. - - - - - Looks up a localized string similar to Target {0} does not define any VisualStateGroups. . - - - - - Looks up a localized string similar to LeftOperand of type "{0}" cannot be used with operator "{1}".. - - - - - Looks up a localized string similar to LeftOperand of type "{1}" and RightOperand of type "{0}" cannot be used with operator "{2}".. - - - - - Looks up a localized string similar to RightOperand of type "{0}" cannot be used with operator "{1}".. - - - - - Looks up a localized string similar to An object of type "{0}" cannot have a {3} property of type "{1}". Instances of type "{0}" can have only a {3} property of type "{2}".. - - - - - Looks up a localized string similar to Cannot attach type "{0}" to type "{1}". Instances of type "{0}" can only be attached to objects of type "{2}".. - - - - - Looks up a localized string similar to Unable to resolve TargetName "{0}".. - - - - - Looks up a localized string similar to The target of the RemoveElementAction is not supported.. - - - - - An interface for an object that can be attached to another object. - - - - - Gets the associated object. - - The associated object. - Represents the object the instance is attached to. - - - - Attaches to the specified object. - - The object to attach to. - - - - Detaches this instance from its associated object. - - - - - A Trigger that is triggered by a keyboard event. If the target Key and Modifiers are detected, it fires. - - - - - The key that must be pressed for the trigger to fire. - - - - - The modifiers that must be active for the trigger to fire (the default is no modifiers pressed). - - - - - If true, the Trigger only listens to its trigger Source object, which means that element must have focus for the trigger to fire. - If false, the Trigger listens at the root, so any unhandled KeyDown/Up messages will be caught. - - - - - Determines whether or not to listen to the KeyDown or KeyUp event. - - - - - Allows the user to use common touch gestures to translate, zoom, and rotate the attached object. - - - - - Gets or sets a value specifying which zooming and translation variants to support. - - - - - Gets or sets a number describing the rate at which the translation will decrease. - - - - - Gets or sets a number describing the rate at which the rotation will decrease. - - - - - Gets or sets the value indicating whether the zoom and translate position of the attached object is limited by the bounds of the parent object. - - - - - Gets or sets a number indicating the minimum zoom value allowed. - - - - - Gets or sets a number indicating the maximum zoom value allowed. - - - - - Called after the behavior is attached to an AssociatedObject. - - Override this to hook up functionality to the AssociatedObject. - - - - Called when the behavior is getting detached from its AssociatedObject, but before it has actually occurred. - - Override this to unhook functionality from the AssociatedObject. - - - - Static class that owns the Triggers and Behaviors attached properties. Handles propagation of AssociatedObject change notifications. - - - - - Gets or sets a value indicating whether to run as if in design mode. - - - True if [should run in design mode]; otherwise, False. - - Not to be used outside unit tests. - - - - This property is used as the internal backing store for the public Triggers attached property. - - - This property is not exposed publicly. This forces clients to use the GetTriggers and SetTriggers methods to access the - collection, ensuring the collection exists and is set before it is used. - - - - - This property is used as the internal backing store for the public Behaviors attached property. - - - This property is not exposed publicly. This forces clients to use the GetBehaviors and SetBehaviors methods to access the - collection, ensuring the collection exists and is set before it is used. - - - - - Gets the TriggerCollection containing the triggers associated with the specified object. - - The object from which to retrieve the triggers. - A TriggerCollection containing the triggers associated with the specified object. - - - - Gets the associated with a specified object. - - The object from which to retrieve the . - A containing the behaviors associated with the specified object. - - - Cannot host the same BehaviorCollection on more than one object at a time. - - - Cannot host the same TriggerCollection on more than one object at a time. - - - - A helper function to take the place of FrameworkElement.IsLoaded, as this property is not available in Silverlight. - - The element of interest. - True if the element has been loaded; otherwise, False. - - - - Executes a specified ICommand when invoked. - - - - - Gets or sets the name of the command this action should invoke. - - The name of the command this action should invoke. - This property will be superseded by the Command property if both are set. - - - - Gets or sets the command this action should invoke. This is a dependency property. - - The command to execute. - This property will take precedence over the CommandName property if both are set. - - - - Gets or sets the command parameter. This is a dependency property. - - The command parameter. - This is the value passed to ICommand.CanExecute and ICommand.Execute. - - - - Gets or sets the IValueConverter that is used to convert the EventArgs passed to the Command as a parameter. - - If the or properties are set, this property is ignored. - - - - Gets or sets the parameter that is passed to the EventArgsConverter. - - - - - Gets or sets the parameter path used to extract a value from an property to pass to the Command as a parameter. - - If the propert is set, this property is ignored. - - - - Specifies whether the EventArgs of the event that triggered this action should be passed to the Command as a parameter. - - If the , , or properties are set, this property is ignored. - - - - Invokes the action. - - The parameter to the action. If the action does not require a parameter, the parameter may be set to a null reference. - - - - This enumerated type indicates whether a FluidMoveBehavior applies to the element to which it is attached, or to the children of that element. - "Self" is useful when there is a single element that should behave in a special manner; "Children" is useful when the same behavior should apply to all - children of a WrapPanel or to the ItemsHost panel of an ItemsControl. - - - - - This enumerated type indicates whether an element is identified by itself, or by its DataContext. - DataContext identification allows movement from one data-driven location to another. - - - - - Indicates whether the behavior applies just to this element, or to all children of the element (if the element is a Panel). - - - - - Dependency property for the scope of the behavior. See FluidMoveScope for more details. - - - - - Indicates whether the behavior is currently active. - - - - - Dependency property for the active state of the behavior. - - - - - Indicates whether to use the element as its own tag, or to use the binding on the element as the tag. - - - - - Dependency property that provides the ability to use the element as its own tag, or the binding on the element. - - - - - Extra path to add to the binding when TagType is specified. - - - - - Dependency property for the extra path to add to the binding when UsaBindingAsTag is true. - - - - - Identity tag used to detect element motion between containers. - - - - - Private structure that stores all relevant data pertaining to a tagged item. - - - - - Behavior that watches an element (or a set of elements) for layout changes, and moves the element smoothly to the new position when needed. - This behavior does not animate the size or visibility of an element; it only animates the offset of that element within its parent container. - - - - - The duration of the move. - - - - - Dependency property for the duration of the move. - - - - - Spawning point for this item. - - - - - Dependency property for the tag type to use just before the object is loaded. - - - - - Extra path to add to the binding when TagType is specified. - - - - - Dependency property for the extra path to add to the binding when UsaBindingAsTag is true. - - - - - Identity tag used to detect element motion between containers. - - - - - Flag that says whether elements are allowed to float above their containers (in a Popup or Adorner) when changing containers. - - - - - Dependency property for the FloatAbove flag. - - - - - EasingFunction to use for the horizontal component of the move. - - - - - Dependency property for the EasingFunction to use for the horizontal component of the move. - - - - - EasingFunction to use for the vertical component of the move. - - - - - Dependency property for the EasingFunction to use for the vertical component of the move. - - - - - Remember the popup/adorner being used, in case of element motion between containers when FloatAbove is true. - - - - - Opacity cache used when floating a Popup. - - - - - Marks the animation transform. - - - - - Simple helper class to allow any UIElements to be used as an Adorner. - - - - - Repositions the attached element in response to mouse drag gestures on the element. - - - - - Occurs when a drag gesture is initiated. - - - - - Occurs when a drag gesture update is processed. - - - - - Occurs when a drag gesture is finished. - - - - - Dependency property for the X position of the dragged element, relative to the left of the root element. - - - - - Dependency property for the Y position of the dragged element, relative to the top of the root element. - - - - - Dependency property for the ConstrainToParentBounds property. If true, the dragged element will be constrained to stay within the bounds of its parent container. - - - - - Gets or sets the X position of the dragged element, relative to the left of the root element. This is a dependency property. - - - - - Gets or sets the Y position of the dragged element, relative to the top of the root element. This is a dependency property. - - - - - Gets or sets a value indicating whether the dragged element is constrained to stay within the bounds of its parent container. This is a dependency property. - - - True if the dragged element should be constrained to its parents bounds; otherwise, False. - - - - - Gets the on-screen position of the associated element in root coordinates. - - The on-screen position of the associated element in root coordinates. - - - - Gets the element bounds in element coordinates. - - The element bounds in element coordinates. - - - - Gets the parent element of the associated object. - - The parent element of the associated object. - - - - Gets the root element of the scene in which the associated object is located. - - The root element of the scene in which the associated object is located. - - - - Gets and sets the RenderTransform of the associated element. - - - - - Attempts to update the position of the associated element to the specified coordinates. - - The desired position of the element in root coordinates. - - - - Applies a relative position translation to the associated element. - - The X component of the desired translation in root coordinates. - The Y component of the desired translation in root coordinates. - - - - Applies the given translation to the RenderTransform of the associated element. - - The X component of the translation in parent coordinates. - The Y component of the translation in parent coordinates. - - - - Does a recursive deep copy of the specified transform. - - The transform to clone. - A deep copy of the specified transform, or null if the specified transform is null. - Thrown if the type of the Transform is not recognized. - - - - Updates the X and Y properties based on the current rendered position of the associated element. - - - - - Check if one Rect is contained by another. - - The containing Rect. - The contained Rect. - True if rect1 contains rect2; otherwise, False. - - - - Transforms as vector. - - The transform. - The X component of the vector. - The Y component of the vector. - A point containing the values of X and Y transformed by transform as a vector. - - - - Gets the transform offset. - - The transform. - The offset of the transform. - - - - Called after the behavior is attached to an AssociatedObject. - - Override this to hook up functionality to the AssociatedObject. - - - - Called when the behavior is getting detached from its AssociatedObject, but before it has actually occurred. - - Override this to unhook functionality from the AssociatedObject. - - - - An action that will play a sound to completion. - - - This action is intended for use with short sound effects that don't need to be stopped or controlled. If you're trying - to create a music player or game, it may not meet your needs. - - - - - Initializes a new instance of the class. - - - - - A Uri defining the location of the sound file. This is used to set the source property of the MediaElement. This is a dependency property. - - - The sound can be any file format supported by MediaElement. In the case of a video, it will play only the - audio portion. - - - - - Control the volume of the sound. This is used to set the Volume property of the MediaElement. This is a dependency property. - - - - - When the action is invoked, this method is used to customize the dynamically created MediaElement. - - - This method may be useful for Action authors who wish to extend PlaySoundAction. If you want to control the - MediaElement Balance property, you could inherit from PlaySoundAction and override this method. - - - - - - This method is called when some criteria are met and the action should be invoked. - - - Each invocation of the Action plays a new sound. Although the implementation is subject-to-change, the caller should - anticipate that this will create a new MediaElement that will be cleaned up when the sound completes or if the media - fails to play. - - - - - - An abstract class that provides the ability to target a Storyboard. - - - For action authors, this class provides a standard way to target a Storyboard. Design tools may choose to provide a - special editing experience for classes that inherit from this action, thereby improving the designer experience. - - - - - The targeted Storyboard. This is a dependency property. - - - - - This method is called when the Storyboard property is changed. - - - - - - An action that will change the state of a targeted storyboard when invoked. - - - - - This method is called when some criteria is met and the action should be invoked. This method will attempt to - change the targeted storyboard in a way defined by the ControlStoryboardOption. - - - - - - An abstract class that provides the ability to target a Storyboard. - - - For Trigger authors, this class provides a standard way to target a Storyboard. Design tools may choose to provide a - special editing experience for classes that inherit from this trigger, thereby improving the designer experience. - - - - - The targeted Storyboard. This is a dependency property. - - - - - This method is called when the Storyboard property is changed. - - - - - A trigger that listens for the completion of a Storyboard. - - - - - Initializes a new instance of the class. - - - - - Defines a transition effect shader that transitions from one visual to another visual - using an interpolated value between 0 and 1. - - - - - Brush-valued properties that turn into sampler-properties in the shader. - Represents the image present in the final state of the transition. - - - - - Brush-valued properties that turn into sampler-properties in the shader. - Represents the image present in the initial state of the transition. - - - - - A Dependency property as the backing store for Progress. - Also used to represent the state of a transition from start to finish (range between 0 and 1). - - - - - Creates a modifiable clone (deep copy) of the using its current values. - - - - - Makes a deep copy of the transition effect. Implements CloneCurrentValue in Silverlight. - - A clone of current instance of transition effect. - - - - Updates the shader's variables to the default values. - - - - - Gets or sets the Input variable within the shader. - - - - - Gets or sets the OldImage variable within the shader. - - - - - Gets or sets the Progress variable within the shader. - - - - - Provides data about which objects were affected when resolving a name change. - - - - - Helper class to handle the logic of resolving a TargetName into a Target element - based on the context provided by a host element. - - - - - Occurs when the resolved element has changed. - - - - - Gets or sets the name of the element to attempt to resolve. - - The name to attempt to resolve. - - - - The resolved object. Will return the reference element if TargetName is null or empty, or if a resolve has not been attempted. - - - - - Gets or sets the reference element from which to perform the name resolution. - - The reference element. - - - - Gets or sets a value indicating whether the reference element load is pending. - - - True if [pending reference element load]; otherwise, False. - - - If the Host has not been loaded, the name will not be resolved. - In that case, delay the resolution and track that fact with this property. - - - - - Attempts to update the resolved object from the name within the context of the namescope reference element. - - The old resolved object. - - Resets the existing target and attempts to resolve the current TargetName from the - context of the current Host. If it cannot resolve from the context of the Host, it will - continue up the visual tree until it resolves. If it has not resolved it when it reaches - the root, it will set the Target to null and write a warning message to Debug output. - - - - - The current version of the flow file schema. - This number should be incremented whenever: - A new _required_ field is added. - The data type of a field is changed. - The semantic interpretation of a field is changed. - - When upgrading the current schema number, you'll also need to take into account - migration/upgrade strategies, and mechanisms for deserializing older schemas. - In some cases, the same serializer data structure may suffice by applying different - parsing validation rules. In other cases, a new data structure may be needed to - deserialize the old format from disk. - - - - - Represents an action that can be targeted to affect an object other than its AssociatedObject. - - The type constraint on the target. - - TargetedTriggerAction extends TriggerAction to add knowledge of another element than the one it is attached to. - This allows a user to invoke the action on an element other than the one it is attached to in response to a - trigger firing. Override OnTargetChanged to hook or unhook handlers on the target element, and OnAttached/OnDetaching - for the associated element. The type of the Target element can be constrained by the generic type parameter. If - you need control over the type of the AssociatedObject, set a TypeConstraintAttribute on your derived type. - - - - - Initializes a new instance of the class. - - - - - Gets the target object. If TargetName is not set or cannot be resolved, defaults to the AssociatedObject. - - The target. - In general, this property should be used in place of AssociatedObject in derived classes. - - - - Called when the target property changes. - - Override this to hook and unhook functionality on the specified Target, rather than the AssociatedObject. - The old target. - The new target. - - - - Represents an action that can be targeted to affect an object other than its AssociatedObject. - - This is an infrastructure class. Action authors should derive from TargetedTriggerAction<T> instead of this class. - - - - Gets or sets the target object. If TargetObject is not set, the target will look for the object specified by TargetName. If an element referred to by TargetName cannot be found, the target will default to the AssociatedObject. This is a dependency property. - - The target object. - - - - Gets or sets the name of the object this action targets. If Target is set, this property is ignored. If Target is not set and TargetName is not set or cannot be resolved, the target will default to the AssociatedObject. This is a dependency property. - - The name of the target object. - - - - Gets the target object. If TargetObject is set, returns TargetObject. Else, if TargetName is not set or cannot be resolved, defaults to the AssociatedObject. - - The target object. - In general, this property should be used in place of AssociatedObject in derived classes. - The Target element does not satisfy the type constraint. - - - - Gets the associated object type constraint. - - The associated object type constraint. - Define a TypeConstraintAttribute on a derived type to constrain the types it may be attached to. - - - - Gets the target type constraint. - - The target type constraint. - - - - Called when the target changes. - - The old target. - The new target. - This function should be overriden in derived classes to hook and unhook functionality from the changing source objects. - - - - Called after the action is attached to an AssociatedObject. - - - - - Called when the action is being detached from its AssociatedObject, but before it has actually occurred. - - - - - Represents an attachable object that encapsulates a unit of functionality. - - The type to which this action can be attached. - - - - Initializes a new instance of the class. - - - - - Gets the object to which this is attached. - - The associated object. - - - - Gets the associated object type constraint. - - The associated object type constraint. - - - - Represents an attachable object that encapsulates a unit of functionality. - - This is an infrastructure class. Action authors should derive from TriggerAction<T> instead of this class. - - - - Gets or sets a value indicating whether this action will run when invoked. This is a dependency property. - - - True if this action will be run when invoked; otherwise, False. - - - - - Gets the object to which this action is attached. - - The associated object. - - - - Gets the associated object type constraint. - - The associated object type constraint. - - - - Gets or sets a value indicating whether this instance is attached. - - True if this instance is attached; otherwise, False. - - - - Attempts to invoke the action. - - The parameter to the action. If the action does not require a parameter, the parameter may be set to a null reference. - - - - Invokes the action. - - The parameter to the action. If the action does not require a parameter, the parameter may be set to a null reference. - - - - Called after the action is attached to an AssociatedObject. - - - - - Called when the action is being detached from its AssociatedObject, but before it has actually occurred. - - - - - When implemented in a derived class, creates a new instance of the derived class. - - The new instance. - - - - Gets the associated object. - - The associated object. - - - - Attaches to the specified object. - - The object to attach to. - Cannot host the same TriggerAction on more than one object at a time. - dependencyObject does not satisfy the TriggerAction type constraint. - - - - Detaches this instance from its associated object. - - - - - Represents a collection of actions with a shared AssociatedObject and provides change notifications to its contents when that AssociatedObject changes. - - - - - Initializes a new instance of the class. - - Internal, because this should not be inherited outside this assembly. - - - - Called immediately after the collection is attached to an AssociatedObject. - - - - - Called when the collection is being detached from its AssociatedObject, but before it has actually occurred. - - - - - Called when a new item is added to the collection. - - The new item. - - - - Called when an item is removed from the collection. - - The removed item. - - - - Creates a new instance of the TriggerActionCollection. - - The new instance. - - - - Represents an object that can invoke actions conditionally. - - The type to which this trigger can be attached. - - TriggerBase is the base class for controlling actions. Override OnAttached() and - OnDetaching() to hook and unhook handlers on the AssociatedObject. You may - constrain the types that a derived TriggerBase may be attached to by specifying - the generic parameter. Call InvokeActions() to fire all Actions associated with - this TriggerBase. - - - - - Initializes a new instance of the class. - - - - - Gets the object to which the trigger is attached. - - The associated object. - - - - Gets the type constraint of the associated object. - - The associated object type constraint. - - - - Argument passed to PreviewInvoke event. Assigning Cancelling to True will cancel the invoking of the trigger. - - This is an infrastructure class. Behavior attached to a trigger base object can add its behavior as a listener to TriggerBase.PreviewInvoke. - - - - Represents an object that can invoke Actions conditionally. - - This is an infrastructure class. Trigger authors should derive from Trigger<T> instead of this class. - - - - Gets the object to which the trigger is attached. - - The associated object. - - - - Gets the type constraint of the associated object. - - The associated object type constraint. - - - - Gets the actions associated with this trigger. - - The actions associated with this trigger. - - - - Event handler for registering to PreviewInvoke. - - - - - Invoke all actions associated with this trigger. - - Derived classes should call this to fire the trigger. - - - - Called after the trigger is attached to an AssociatedObject. - - - - - Called when the trigger is being detached from its AssociatedObject, but before it has actually occurred. - - - - - Creates a new instance of the TriggerBase derived class. - - The new instance. - - - - Gets the associated object. - - The associated object. - - - - Attaches to the specified object. - - The object to attach to. - Cannot host the same trigger on more than one object at a time. - dependencyObject does not satisfy the trigger type constraint. - - - - Detaches this instance from its associated object. - - - - - Represents a collection of triggers with a shared AssociatedObject and provides change notifications to its contents when that AssociatedObject changes. - - - - - Initializes a new instance of the class. - - Internal, because this should not be inherited outside this assembly. - - - - Called immediately after the collection is attached to an AssociatedObject. - - - - - Called when the collection is being detached from its AssociatedObject, but before it has actually occurred. - - - - - Called when a new item is added to the collection. - - The new item. - - - - Called when an item is removed from the collection. - - The removed item. - - - - Creates a new instance of the . - - The new instance. - - - - Specifies type constraints on the AssociatedObject of TargetedTriggerAction and EventTriggerBase. - - - - - Gets the constraint type. - - The constraint type. - - - - Initializes a new instance of the class. - - The constraint type. - - - - This class provides various platform agnostic standard operations for working with VisualStateManager. - - - - - Transitions the control between two states. - - The element to transition between states. - The state to transition to. - True to use a System.Windows.VisualTransition to transition between states; otherwise, false. - True if the control successfully transitioned to the new state; otherwise, false. - Control is null. - StateName is null. - - - - Gets the value of the VisualStateManager.VisualStateGroups attached property. - - The element from which to get the VisualStateManager.VisualStateGroups. - - - - Find the nearest parent which contains visual states. - - The element from which to find the nearest stateful control. - The nearest stateful control if True; else null. - True if a parent contains visual states; else False. - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Mil.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Mil.dll deleted file mode 100644 index 14698cd..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Mil.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilCacheInfo.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MilCacheInfo.dll deleted file mode 100644 index 53c1589..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilCacheInfo.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilCamera.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MilCamera.dll deleted file mode 100644 index b45dad2..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilCamera.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilCamera.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/MilCamera.xml deleted file mode 100644 index a8d36e4..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilCamera.xml +++ /dev/null @@ -1,705 +0,0 @@ - - - - MilCamera - - - - - Euresys 그래버 매니저 - - - - - cti 파일 경로 - - - - - EGenTL 객체 - - - - - EGrabberDiscovery 객체 - - - - - cti 파일로 그래버 생성 및 연결 - - cti 파일 경로 - 성공 유무 - - - - 그래버 생성 여부 체크 - - 그래버 생성 여부 - - - - 리소스 정리 - EGenTL과 EGrabberDiscovery는 모든 카메라 공용이므로 카메라 1대만 Dispose할 때, 이 함수를 호출하지 않도록 주의. - 즉, 프로그램 종료시에만 해주면 됨. - - - - - Euresys 모듈 정의 - - - - - Euresys 카메라 디바이스 (영상처리는 MIL로 함) - - - - - 생성자 - - 디바이스 ID - - - - [방법1] GigE 카메라 고정 IP를 이용한 카메라 연결 - - - - - [방법2] GenI캠 DeviceUserId를 이용한 카메라 연결 - - - - - [방법3] SlotPos와 PortPos를 이용한 카메라 연결 - - - - - 이미지 버퍼 복제 - - 복제 버퍼 - - - - 카메라 연결 유무 - - 연결 유무 - - - - 카메라 Gain 읽기 - - Gain 값 - - - - 카메라 Gain 쓰기 - - Gain 값 - 성공 유무 - - - - 카메라 노출시간 읽기 - - 노출시간 - - - - 카메라 최소 노출시간 읽기 - - 최소 노출시간 - - - - 카메라 최대 노출시간 읽기 - - 최대 노출시간 - - - - 카메라 노출시간 쓰기 - - 노출시간[ms] - 성공 유무 - - - - - 디스플레이 가져오기 - - 디스플레이 - - - - 디스플레이 지정하기 - - 디스플레이 - - - - 이미지 사이즈 가져오기 - - 이미지 사이즈 - - - - 버퍼로부터 이미지를 꺼내온다. - - 디스플레이 - 이미지 - 성공 유무 - - - - 동기식 그랩 - - 디스플레이 - 그랩 이미지 - 성공 유무 - - - - SW 트리거의 경우 HookHandler에서 이미지가 계속 갱신되고 있으므로, 가져가기만 하면 됨 - - 이미지 - 성공 유무 - - - - 라이브 시작 - - 디스플레이 - - - - 라이브 종료 - - - - - 디스플레이에서 이미지 꺼내오기 - - 디스플레이 - 디스플레이 이미지 - - - - EventCallBack 함수 (SW 트리거 일때는 계속 들어오고, HW 트리거 일때는 신호가 터질 때만 들어옴) - - 그래버 - Raw 데이터 - - - - 플라잉 시작 - - FOV 정보 - 추가 파라미터 - 성공 유무 - - - - 플라잉 종료 - - 추가 파라미터 - 성공 유무 - - - - Child 이미지들로 Parent(원장) 이미지가 정상적으로 만들어지는지 검증 - - 디스플레이 - 원장(부모) 이미지 - 성공 유무 - - - - Euresys 환경 변수 및 메소드 관리 - - - - - 싱글톤 객체 - - - - - 생성자 - - - - - Euresys 보드 타입인지 체크 - - 보드 타입 - Euresys 보드 타입 여부 - - - - MIL 카메라 디바이스 - - - - - 생성자 - - - - - - 이미지 버퍼 복제 - - 복제 버퍼 - - - - 카메라 연결 유무 - - 연결 유무 - - - - 카메라 Gain 읽기 - - Gain 값 - - - - 카메라 Gain 쓰기 - - Gain 값 - 성공 유무 - - - - 카메라 노출시간 읽기 - - 노출시간 - - - - 카메라 최소 노출시간 읽기 - - 최소 노출시간 - - - - 카메라 최대 노출시간 읽기 - - 최대 노출시간 - - - - 카메라로부터 최초 노출시간 가져오기 - 현재 노출시간은 아니고, 프로그램 시작시 DCF파일로부터 읽은 값임. - - 최초 노출시간(ms) - - - - 카메라로부터 최초 노출시간 가져오기 (현재 노출시간은 아님) - - 성공 유무 - - - - 카메라 노출시간 쓰기. GigE 카메라가 아닌 경우 HW에서 설정해주어야 함. (MIL에서 지원X) - - 노출시간[ms] - 성공 유무 - - - - - 디스플레이 가져오기 - - 디스플레이 - - - - 디스플레이 지정하기 - - 디스플레이 - - - - 이미지 사이즈 가져오기 - - 이미지 사이즈 - - - - 버퍼로부터 이미지를 꺼내온다. - - 디스플레이 - 이미지 - 성공 유무 - - - - 동기식 그랩 - - 디스플레이 - 그랩 이미지 - 성공 유무 - - - - 라이브 시작 - - 디스플레이 - - - - 라이브 종료 - - - - - 디스플레이에서 이미지 꺼내오기 - - 디스플레이 - 디스플레이 이미지 - - - - 플라잉 시작 - - FOV 정보 - 추가 파라미터 - 성공 유무 - - - - 플라잉 종료 - - 추가 파라미터 - 성공 유무 - - - - Child 이미지들로 Parent(원장) 이미지가 정상적으로 만들어지는지 검증 - - 디스플레이 - 원장(부모) 이미지 - 성공 유무 - - - - MIL 카메라 에이전트 - - - - - 생성자 - - FOV 정보 - - - - 이미지 사이즈 가져오기 - - 이미지 사이즈 - - - - 이미지 버퍼 복제 - - 복제 버퍼 - - - - 버퍼로부터 이미지를 꺼내온다. - - 디스플레이 - 이미지 - 성공 유무 - - - - 동기식 그랩 - - 디스플레이 - 그랩 이미지 - 성공 유무 - - - - 라이브 시작 - - 디스플레이 - - - - 라이브 종료 - - - - - 라이브 상태 체크 - - 라이브 상태 - - - - 카메라 노출시간 읽기 - - 노출시간 - - - - 카메라 노출시간 쓰기 - - 노출시간[ms] - 성공 유무 - - - - - 플라잉 시작 - - FOV 정보 - 추가 파라미터 - 성공 유무 - - - - 플라잉 종료 - - 추가 파라미터 - 성공 유무 - - - - 플라잉 상태 체크 - - 성공 유무 - - - - 현재 플라잉 인덱스 가져오기 - - 현재 플라잉 인덱스 - - - - 플라잉 이미지 가져오기 - - 플라잉 인덱스 - 플라잉 이미지 - - - - 플라잉 이미지 전체 가져오기 - - 플라잉 이미지 전체 - - - - 플라잉 합성(원장) 이미지 가져오기. *원장 : Child 이미지를 조합하여 한 장으로 만듬 - - 플아잉 합성(원장) 이미지 - - - - Child 이미지들로 Parent(원장) 이미지가 정상적으로 만들어지는지 검증 - - 디스플레이 - 원장(부모) 이미지 - 성공 유무 - - - - 카메라 생성 및 등록 - - - - - 카메라 생성 및 등록 - - Aurora 레지스트리 - - - - 카메라 ID로 보드 타입 가져오기 - - 카메라 ID - 보드 타입 - - - - MIL 시뮬 카메라 디바이스 - - - - - 생성자 - - 디바이스 ID - - - - 카메라 연결 유무 - - 연결 유무 - - - - 카메라 Gain 읽기 - - Gain 값 - - - - 카메라 Gain 쓰기 - - Gain 값 - 성공 유무 - - - - 카메라 노출시간 읽기 - - 노출시간 - - - - 카메라 최소 노출시간 읽기 - - 최소 노출시간 - - - - 카메라 최대 노출시간 읽기 - - 최대 노출시간 - - - - 카메라 노출시간 쓰기 - - 노출시간[ms] - 성공 유무 - - - - - 이미지 버퍼 복제 - - 복제 버퍼 - - - - 디스플레이 가져오기 - - 디스플레이 - - - - 디스플레이 지정하기 - - 디스플레이 - - - - 이미지 사이즈 가져오기 - - 이미지 사이즈 - - - - 버퍼로부터 이미지를 꺼내온다. 시뮬모드이므로 신규 그랩으로 처리 - - 디스플레이 - 이미지 - 성공 유무 - - - - 동기식 그랩 - - 디스플레이 - 그랩 이미지 - 성공 유무 - - - - 플라잉 시작 - - FOV 정보 - 추가 파라미터 - 성공 유무 - - - - 플라잉 종료 - - 추가 파라미터 - 성공 유무 - - - - Child 이미지들로 Parent(원장) 이미지가 정상적으로 만들어지는지 검증 - - 디스플레이 - 원장(부모) 이미지 - 성공 유무 - - - - 라이브 시작 - - 디스플레이 - - - - 라이브 종료 - - - - - 디스플레이에서 이미지 꺼내오기 - - 디스플레이 - 디스플레이 이미지 - - - - 이미지 반전 및 회전을 위한 Tool - - - - - 생성자 - - 카메라 ID - 카메라 컨피그 - - - - 이미지 반전 및 회전 - - 소스 이미지 - 결과 이미지 - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilCommon.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MilCommon.dll deleted file mode 100644 index a7ac5ce..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilCommon.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilCommon.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/MilCommon.xml deleted file mode 100644 index 8cb031b..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilCommon.xml +++ /dev/null @@ -1,761 +0,0 @@ - - - - MilCommon - - - - - MIL or Cognex 상호참조 해결을 위한 클래스 - - - - - 이미지 픽셀 클리어 - - 이미지 - - - - 이미지 리소스 회수 - - 이미지 - 성공 유무 - - - - 이미지 저장 - - 파일 경로 - 이미지 - 성공 유무 - - - - 이미지 로드 - - 파일 경로 - 이미지 - - - - 이미지 로드 (MIL 전용) - - 파일 경로 - 보드 타입 - 보드 슬롯 위치 - 이미지 - - - - 이미지 사이즈 가져오기 - - 이미지 - 이미지 사이즈 - - - - 이미지 중심좌표 가져오기 - - 이미지 - 중심좌표 - - - - 이미지 사이즈 동일 여부 체크 - - 이미지 사이즈 1 - 이미지 사이즈 2 - 이미지 사이즈 동일 여부 - - - - 이미지의 ROI 내에서 Pixel Sharpness 값 가져오기 - - 이미지 - Rect - Pixel Sharpness 값 - - - - 이미지의 ROI 내에서 Pixel Sharpness 값 가져오기 - - 이미지 - ROI - Pixel Sharpness 값 - - - - Overlay 이미지 저장 - - 파일 경로 - 모든 FOV 정보 - 디스플레이 타입 - 성공 유무 - - - - 이미지 반전 유무 확인 - - 카메라 컨피그 - 이미지 반전 유무 - - - - 이미지 회전 유무 확인 - - 카메라 컨피그 - 이미지 회전 유무 - - - - 이미지 세로 사이즈가 가로 사이즈보다 큰지 확인 - - 카메라 컨피그 - 이미지 세로 사이즈가 가로 사이즈보다 크면 True - - - - MIL 컬러 컨버터 - - - - - eColor 컬러를 MIL 컬러 타입으로 변환 - - 범용 컬러 - MIL 컬러 - - - - Shape 모델 타입 - - - - - RunParam 스피드 옵션 - - - - - RunParam 정확도 옵션 - - - - - RunParam 디테일 옵션 - - - - - 텍스트 컬러 옵션 - - - - - 극성 옵션 - - - - - Image MIL_ID 가져오기 - - ImageBuffer MIL_ID - - - - Image 사이즈에 맞게 조절하기 - - 원하는 Image Size - 성공 여부 - - - - Display Id 가져오기 - - Display MIL_ID - - - - Graphic Context Id 가져오기 - - Display MIL_ID - - - - Graphic List Id 가져오기 - - Display MIL_ID - - - - PatternEdge 추가 - - 결과 Context ID (MIL_ID) - ROI - 성공 여부 - - - - Cross 추가 - - - - 성공 여부 - - - - 여러개의 Cross 추가 - - 여러개의 Cross (List) - Cross 색상 - 성공 여부 - - - - Line 추가 - - 색상 - line - 수정가능 여부 - 성공 여부 - - - - 여러개의 Line 추가 - - 색상 - 여러개의 line (List) - 성공 여부 - - - - 여러개의 Vector 추가 - - 색상 - 여러개의 line (List) - Tail을 그릴지 여부 - 성공 여부 - - - - 패턴 결과 여러개의 FindRoi 추가 - - 색상 - 찾은 여러개의 ROI (List) - 성공 여부 - - - - 패턴 결과 단일 FindRoi 추가 - - 색상 - 찾은 단일 ROI - 성공 여부 - - - - 패천 결과 여러개의 점 추가 - - 색상 - 여러개의 ImagePoint (List) - 성공 여부 - - - - MIL 환경 변수 및 메소드 관리 - - - - - 싱글톤 객체 - - - - - MIL 시스템 가져오기 - - 보드 타입 - 보드 슬롯 위치 - MIL 시스템 - - - - MIL 시스템 할당 여부 체크 - - 보드 타입 - 보드 슬롯 위치 - - - - - 이미지로 MIL 시스템 가져오기 - - 이미지 - MIL 시스템 - - - - MIL 시스템 할당 - - 보드 타입 - 보드 슬롯 위치 - - - - MIL 라이센스 체크 - - 라이센스 여부 - - - - 디스플레이 생성 - - 윈폼 핸들러(IntPtr) - 이미지 버퍼 Mil_ID - Display ID (MIL_ID) - - - - 해당 디스플레이 선택 - - 윈폼 핸들러(IntPtr) - 이미지 버퍼 Mil_ID - 선택할 Display Id (MIL_ID) - - - - 디스플레이 해제/제거 - - 해제할 Display Id (MIL_ID) - - - - 원본 이미지 버퍼 할당 - - 카메라 컨피그 - 원본 이미지 버퍼 - 성공 유무 - - - - - Crop 이미지 버퍼 할당 - - 카메라 컨피그 - Crop 이미지 버퍼 - 성공 유무 - - - - Dig Process 이미지 배열 할당 - - 카메라 컨피그 - 버퍼 사이즈 - Proc 이미지 버퍼 배열 - - - - - Child 이미지 할당 - - 카메라 컨피그 - 부모 이미지 버퍼 - 자식 이미지 버퍼 배열 - - - - - Child 이미지 사용시, 부모 이미지 버퍼 할당 - - 카메라 컨피그 - 부모 이미지 버퍼 - 성공 유무 - - - - 이미지 반전 유무 확인 - - 카메라 컨피그 - 이미지 반전 유무 - - - - 이미지 회전 유무 확인 - - 카메라 컨피그 - 이미지 회전 유무 - - - - 이미지 세로 사이즈가 가로 사이즈보다 큰지 확인 - - 카메라 컨피그 - 이미지 세로 사이즈가 가로 사이즈보다 크면 True - - - - 이미지 저장 - - 파일경로 - 이미지버퍼 MIL_ID - 크롭(저장) 할 영역 - 성공 유무 - - - - 이미지 저장 - - 파일경로 - 이미지버퍼 MIL_ID - 성공 유무 - - - - 이미지 로드 - - 불러올 이미지 경로 - 보드 타입 - 보드 슬롯 위치 - 이미지 버퍼 MIL_ID - - - - 이미지 로드 - - 불러올 이미지 경로 - Mil 시스템 Id - 이미지 버퍼 MIL_ID - - - - 이미지 복사 - - 소스 이미지 버퍼 - 목적지 이미지 버퍼 - 성공 유무 - - - - 버퍼 카피 가능한지 여부 - - 소스 이미지 버퍼 - 목적지 이미지 버퍼 - - - - - 이미지 복제 - - 복제할 이미지 ID - 복제된 이미지 MIL_ID - - - - 이미지 복제 - - 복제할 이미지 ID - MIL 시스템 ID - 복제된 이미지 MIL_ID - - - - 호환가능한 이미지 버퍼 가져오기 - - 이미지 버퍼 MIL_ID - 호환가능한 이미지 버퍼 MIL_ID - - - - 호환가능한 이미지 버퍼 가져오기 - - 이미지 사이즈 - 보드 타입 - 보드 슬롯 위치 - 호환가능한 이미지 버퍼 MIL_ID - - - - 호환가능한 이미지 버퍼 가져오기 - - 이미지 사이즈 - Mil 시스템 Id - 호환가능한 이미지 버퍼 MIL_ID - - - - 호환가능한 Gray 이미지 버퍼 가져오기 - - 이미지 버퍼 MIL_ID - 호환가능한 Gray 이미지 버퍼 MIL_ID - - - - 호환가능한 Gray이미지 버퍼 가져오기 - - 이미지 사이즈 - 보드 타입 - 보드 슬롯 위치 - 호환가능한 Gray 이미지 버퍼 MIL_ID - - - - 호환가능한 Gray 이미지 버퍼 가져오기 - - 이미지 사이즈 - Mil 시스템 Id - 호환가능한 Gray 이미지 버퍼 MIL_ID - - - - 호환가능한 Color 이미지 버퍼 가져오기 - - 이미지 버퍼 MIL_ID - 호환가능한 Color 이미지 버퍼 MIL_ID - - - - 호환가능한 Color 이미지 버퍼 가져오기 - - 이미지 사이즈 - 보드 타입 - 보드 슬롯 위치 - 호환가능한 Color 이미지 버퍼 MIL_ID - - - - 호환가능한 Color 이미지 버퍼 가져오기 - - 이미지 사이즈 - Mil 시스템 Id - 호환가능한 Color 이미지 버퍼 MIL_ID - - - - 이미지 크롭 - - 이미지 버퍼 MIL_ID - - - - - - 이미지 크롭 - - 이미지 버퍼 MIL_ID - - - - - - 이미지 리소스 회수 - - 이미지 ID - 성공 유무 - - - - 이미지 리소스 회수 - - 이미지 ID - 성공 유무 - - - - Proc 이미지 배열 리소스 회수 - - 버퍼 사이즈 - Proc 이미지 배열 - 성공 유무 - - - - 사각형 중심 포인트 가져오기 - - - - - - - 이미지 중심 포인트 가져오기 - - 이미지 버퍼 MIL_ID - - - - - 이미지 사이즈 가져오기 - - 이미지 버퍼 MIL_ID - 이미지 사이즈 - - - - 이미지 사이즈 가져오기 - - 카메라 컨피그 - 성공 유무 - - - - 이미지 사이즈 동일 여부 체크 - - 이미지1 - 이미지2 - 이미지 사이즈 동일 여부 - - - - 이미지 사이즈 동일 여부 체크 - - 이미지 사이즈 1 - 이미지 사이즈 2 - 이미지 사이즈 동일 여부 - - - - 이미지 사이즈 Null인지 여부 - - 이미지 사이즈 - True : Null - - - - 이미지가 Color인지 여부 - - 이미지 버퍼 MIL_ID - True : ColorImage - - - - Mil 이미지를 byte array로 변환 - - 이미지 버퍼 MIL_ID - 변환된 이미지 byte array - - - - byte array를 mil 이미지 로 변환 - - - - - 이미지 버퍼 MIL_ID - - - - color 이미지를 gray 이미지로 변환 - - - - - - - color 이미지를 gray 이미지로 변환 - - - - - - - - gray 이미지를 rgb 이미지로 변환 - - 이미지 버퍼 MIL_ID - 보드 타입 - 보드 슬롯 위치 - - - - - mil 이미지를 bitmap 이미지로 변환 - - 이미지 - - - - - 컬러 이미지인지 여부 - - 이미지 사이즈 - - - - - 이미지 픽셀 클리어 - - 이미지 - - - - 이미지 픽셀 클리어 - - 이미지 - - - - 이미지의 ROI 내에서 Pixel Sharpness 값 가져오기 - - 이미지 - Rect - Pixel Sharpness 값 - - - - 이미지의 ROI 내에서 Pixel Sharpness 값 가져오기 - - 이미지 - ROI - Pixel Sharpness 값 - - - - 이미지 내에서 Pixel Sharpness 값 가져오기 - - 이미지 - Pixel Sharpness 값 - - - - 이미지의 ROI 내에서 Pixel Brightness 값 가져오기 - - 이미지 - Rect - Pixel Brightness 값 - - - - 이미지의 ROI 내에서 Pixel Brightness 값 가져오기 - - 이미지 - ROI - Pixel Brightness 값 - - - - 이미지 Point에서 Pixel Brightness 값 가져오기 - - 이미지 - 이미지 포인트 - Pixel Brightness 값 - - - - Overlay 이미지 가져오기 - - mil 카메라 디스플레이 - 그랩 이미지 - Overlay 이미지 - - - - Overlay 이미지 저장 - - 파일 경로 - 모든 FOV 정보 - 디스플레이 타입 - 이미지 default:Null - 성공 유무 - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilDisplay.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MilDisplay.dll deleted file mode 100644 index 232e22a..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilDisplay.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilMP.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MilMP.dll deleted file mode 100644 index c34919a..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilMP.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilPattern.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MilPattern.dll deleted file mode 100644 index b9a10f9..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilPattern.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilPattern.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/MilPattern.xml deleted file mode 100644 index 61b7873..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilPattern.xml +++ /dev/null @@ -1,160 +0,0 @@ - - - - MilPattern - - - - - 마스크 영역 분할을 위한 Uitl 클래스 - - - - - 지원되는 마스크 레이아웃 리스트를 얻는다. - - 마스크 레이아웃 리스트 - - - - 마스크 레이아웃의 영역의 총 개수를 구한다. - - - 영역의 총 개수 - - - - 마스크 레이아웃의 행개수를 구한다. - - 마스크 레이아웃 - 행 개수 - - - - 마스크 레이아웃의 열개수를 구한다. - - 마스크 레이아웃 - 열 개수 - - - - 마스크 영역별 서브 패턴 자동 생성을 위한 - 레이아웃 리스트를 얻는다. - - 마스크 레이아웃 리스트 - - - - 마스크 이미지에 마스크 영역을 설정한다. - - 마스크 이미지 - 행 개수 - 열 개수 - 마스크 영역 1차원 인덱스 - - - - 마스크 이미지에 마스크 영역을 설정한다. - - 마스크 이미지 - 행 개수 - 열 개수 - 마스크 영역 행 인덱스 - 마스크 영역 열 인덱스 - - - - 오버레이 이미지에 마스크 영역을 설정한다. - - MIL 그래픽 컨텍스트 - 오버레이 이미지 - 마스크 컬러 - 행 개수 - 열 개수 - 마스크 영역 1차원 인덱스 - - - - 마스크 영역에 해댱되는 Rectangle을 구한다. - - 이미지 너비 - 이미지 높이 - 행 개수 - 열 개수 - 마스크 영역 1차원 인덱스 - 마스크 영역 - - - - 마스크 영역에 해댱되는 Rectangle을 구한다. - - 이미지 너비 - 이미지 높이 - 행 개수 - 열 개수 - 마스크 영역 행 인덱스 - 마스크 영역 열 인덱스 - 마스크 영역 - - - - 마커의 가장자리가 설정된 강도 전환의 시작과 끝 사이의 회색조 차이를 기준으로 점수를 백분율로 계산 - 대조의 경우 8비트 이미지의 경우 최대 가능한 대비는 255이며, 이는 에지 값 100에 해당 - - - - - 마커의 가장자리가 설정된 강도 전환의 시작과 끝 사이의 회색조 차이를 기준으로 점수를 백분율로 계산 - 강도의 경우 최대 가능한 값은 100이며, 이는 에지 값 100에 해당 - - - - - 패턴 가져오기 - - 패턴 - - - - 카메라 전용 패턴 에이전트 생성 및 등록 - - - - - 카메라 전용 패턴 에이전트 생성 및 등록 - - - - - 패턴 가져오기 - - 패턴 - - - - FOV 전용 패턴 에이전트 생성 및 등록 - - - - - FOV 전용 패턴 에이전트 생성 및 등록 - - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilUI.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MilUI.dll deleted file mode 100644 index b8cc237..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilUI.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilUI.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/MilUI.xml deleted file mode 100644 index 04bf201..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/MilUI.xml +++ /dev/null @@ -1,649 +0,0 @@ - - - - MilUI - - - - - Interaction logic for CameraDisplay.xaml - - - CameraDisplay - - - - - 레퍼런스 위치에 십자가 그리기 - - 십자가 길이 - 십자가 색상 - - - - InitializeComponent - - - - - CameraView - - - - - InitializeComponent - - - - - Interaction logic for BrightnessSettingView.xaml - - - BrightnessSettingView - - - - - InitializeComponent - - - - - Interaction logic for BrightnessSettingWindow.xaml - - - BrightnessSettingWindow - - - - - InitializeComponent - - - - - Interaction logic for ForceOkView.xaml - - - ForceOkView - - - - - InitializeComponent - - - - - Interaction logic for BarCodeSettingView.xaml - - - BarCodeSettingView - - - - - InitializeComponent - - - - - Interaction logic for BarCodeSettingWindow.xaml - - - BarCodeSettingWindow - - - - - InitializeComponent - - - - - Interaction logic for BlobSettingView.xaml - - - BlobSettingView - - - - - InitializeComponent - - - - - Interaction logic for BlobSettingWindow.xaml - - - BlobSettingWindow - - - - - InitializeComponent - - - - - Interaction logic for CaliperSettingView.xaml - - - CaliperSettingView - - - - - InitializeComponent - - - - - Interaction logic for CaliperSettingWindow.xaml - - - CaliperSettingWindow - - - - - InitializeComponent - - - - - Interaction logic for EdgeSettingView.xaml - - - EdgeSettingView - - - - - InitializeComponent - - - - - Interaction logic for EdgeSettingWindow.xaml - - - EdgeSettingWindow - - - - - InitializeComponent - - - - - Interaction logic for FixtureSettingView.xaml - - - FixtureSettingView - - - - - InitializeComponent - - - - - Interaction logic for LineSettingView.xaml - - - LineAllSettingView - - - - - InitializeComponent - - - - - Interaction logic for MultiLineParamSettingView.xaml - - - MultiLineParamSettingView - - - - - InitializeComponent - - - - - Interaction logic for MultiLineSettingView.xaml - - - MultiLineSettingView - - - - - InitializeComponent - - - - - Interaction logic for MultiLineSettingWindow.xaml - - - MultiLineSettingWindow - - - - - InitializeComponent - - - - - Interaction logic for ImageMaskView.xaml - - - ImageMaskView - - - - - InitializeComponent - - - - - Interaction logic for ImageMaskViewWindow.xaml - - - ImageMaskViewWindow - - - - - InitializeComponent - - - - - Interaction logic for ImageModelSettingView.xaml - - - ImageModelSettingView - - - - - InitializeComponent - - - - - Interaction logic for ImageModelSettingWindow.xaml - - - ImageModelSettingWindow - - - - - InitializeComponent - - - - - Interaction logic for LineWidthSettingView.xaml - - - LineWidthSettingView - - - - - InitializeComponent - - - - - Interaction logic for LineWidthSettingWindow.xaml - - - LineWidthSettingWindow - - - - - InitializeComponent - - - - - Interaction logic for LineIntersectionSettingView.xaml - - - LineIntersectionSettingView - - - - - InitializeComponent - - - - - Interaction logic for LineIntersectionSettingWindow.xaml - - - LineIntersectionSettingWindow - - - - - InitializeComponent - - - - - Interaction logic for LineSettingPatternBlockView.xaml - - - LineSettingPatternBlockView - - - - - InitializeComponent - - - - - Interaction logic for LineSettingView.xaml - - - LineSettingView - - - - - InitializeComponent - - - - - Interaction logic for LineSettingWindow.xaml - - - LineSettingWindow - - - - - InitializeComponent - - - - - Interaction logic for SubMaskViewWindow.xaml - - - SubMaskViewWindow - - - - - InitializeComponent - - - - - Interaction logic for SubMaskView.xaml - - - SubMaskView - - - - - InitializeComponent - - - - - Interaction logic for PatternInfoView.xaml - - - PatternInfoView - - - - - InitializeComponent - - - - - Interaction logic for RegisterPatternView.xaml - - - RegisterPatternView - - - - - InitializeComponent - - - - - Interaction logic for PatternMatchingSettingWindow.xaml - - - PatternMatchingSettingWindow - - - - - InitializeComponent - - - - - Interaction logic for RegisterPatternWindow.xaml - - - RegisterPatternWindow - - - - - InitializeComponent - - - - - Interaction logic for PatternMatchingSettingView.xaml - - - PatternMatchingSettingView - - - - - InitializeComponent - - - - - Interaction logic for PreProcessingSettingView.xaml - - - PreProcessingSettingView - - - - - InitializeComponent - - - - - Interaction logic for PreProcessingWindow.xaml - - - PreProcessingWindow - - - - - InitializeComponent - - - - - Interaction logic for CircleSettingView.xaml - - - CircleSettingView - - - - - InitializeComponent - - - - - Interaction logic for RingSettingView.xaml - - - RingSettingView - - - - - InitializeComponent - - - - - Interaction logic for CrossSettingView.xaml - - - CrossSettingView - - - - - InitializeComponent - - - - - Interaction logic for SquareSettingView.xaml - - - SquareSettingView - - - - - InitializeComponent - - - - - Interaction logic for UCPositionControl.xaml - - - UCPositionControl - - - - - InitializeComponent - - - - - Interaction logic for WidthHeightSettingView.xaml - - - WidthHeightSettingView - - - - - InitializeComponent - - - - - Interaction logic for ShapeModelSettingView.xaml - - - ShapeModelSettingView - - - - - InitializeComponent - - - - - Interaction logic for ShapeModelSettingWindow.xaml - - - ShapeModelSettingWindow - - - - - InitializeComponent - - - - - Interaction logic for ShapeSettingWindow.xaml - - - ShapeSettingWindow - - - - - InitializeComponent - - - - - Interaction logic for TrainOriginSyncView.xaml - - - TrainOriginSyncView - - - - - InitializeComponent - - - - - Interaction logic for TrainOriginSyncWindow.xaml - - - TrainOriginSyncWindow - - - - - InitializeComponent - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Milim.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Milim.dll deleted file mode 100644 index f9d8227..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Milim.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MockGrabber.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MockGrabber.dll deleted file mode 100644 index 7d2d8a1..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MockGrabber.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MongoDB.Bson.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MongoDB.Bson.dll deleted file mode 100644 index 27e3e27..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MongoDB.Bson.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MongoDB.Driver.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MongoDB.Driver.Core.dll deleted file mode 100644 index 03934a6..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MongoDB.Driver.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MongoDB.Driver.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MongoDB.Driver.dll deleted file mode 100644 index 9b7ecc1..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MongoDB.Driver.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MongoDB.Libmongocrypt.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MongoDB.Libmongocrypt.dll deleted file mode 100644 index 35263c6..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MongoDB.Libmongocrypt.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/MySqlConnector.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/MySqlConnector.dll deleted file mode 100644 index 27bb0e3..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/MySqlConnector.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/NMF.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/NMF.dll deleted file mode 100644 index e46e717..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/NMF.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/NMF.lib b/Machines/_out_prismatic_rd_ptop/x64-Debug/NMF.lib deleted file mode 100644 index f69ee5f..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/NMF.lib and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/NModbus.Serial.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/NModbus.Serial.dll deleted file mode 100644 index 4cf2311..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/NModbus.Serial.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/NModbus.Serial.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/NModbus.Serial.xml deleted file mode 100644 index 78caf91..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/NModbus.Serial.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - NModbus.Serial - - - - - Concrete Implementor - http://en.wikipedia.org/wiki/Bridge_Pattern - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/NModbus.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/NModbus.dll deleted file mode 100644 index d10eff3..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/NModbus.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/NModbus.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/NModbus.xml deleted file mode 100644 index 0cd47a7..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/NModbus.xml +++ /dev/null @@ -1,2099 +0,0 @@ - - - - NModbus - - - - - A simple implementation of the point source. All registers are - - - - - - Collection of discrete values. - - - - - Number of bits per byte. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Array for discrete collection. - - - - Initializes a new instance of the class. - - Array for discrete collection. - - - - Initializes a new instance of the class. - - List for discrete collection. - - - - Initializes a new instance of the class. - - List for discrete collection. - - - - Gets the network bytes. - - - - - Gets the byte count. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - The Extended Memory file number - - - - - The starting register address within the file. - - - - - The bytes written to the extended memory file. - - - - - Gets the byte count. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Modbus message containing data. - - - - - Gets the network bytes. - - - - - Gets the byte count. - - - - - A simple implementation of the point source. Memory for all points is allocated the first time a point is accessed. - This is useful for cases where many points are used. - - - - - - Collection of 16 bit registers. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Array for register collection. - - - - Initializes a new instance of the class. - - Array for register collection. - - - - Initializes a new instance of the class. - - List for register collection. - - - - Gets the byte count. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Provides concurrency control across multiple Modbus readers/writers. - - - - - Modbus device. - - - - - Gets the Modbus Transport. - - - - - Releases unmanaged and - optionally - managed resources. - - - - - Releases unmanaged and - optionally - managed resources. - - - true to release both managed and unmanaged resources; - false to release only unmanaged resources. - - - - - Base class for - - The type of request to handle. - - - - Modbus IP master device. - - - - - Modbus IP master device. - - Transport used by this master. - - - - Reads from 1 to 2000 contiguous coils status. - - Address to begin reading. - Number of coils to read. - Coils status. - - - - Asynchronously reads from 1 to 2000 contiguous coils status. - - Address to begin reading. - Number of coils to read. - A task that represents the asynchronous read operation. - - - - Reads from 1 to 2000 contiguous discrete input status. - - Address to begin reading. - Number of discrete inputs to read. - Discrete inputs status. - - - - Asynchronously reads from 1 to 2000 contiguous discrete input status. - - Address to begin reading. - Number of discrete inputs to read. - A task that represents the asynchronous read operation. - - - - Reads contiguous block of holding registers. - - Address to begin reading. - Number of holding registers to read. - Holding registers status. - - - - Asynchronously reads contiguous block of holding registers. - - Address to begin reading. - Number of holding registers to read. - A task that represents the asynchronous read operation. - - - - Reads contiguous block of input registers. - - Address to begin reading. - Number of holding registers to read. - Input registers status. - - - - Asynchronously reads contiguous block of input registers. - - Address to begin reading. - Number of holding registers to read. - A task that represents the asynchronous read operation. - - - - Writes a single coil value. - - Address to write value to. - Value to write. - - - - Asynchronously writes a single coil value. - - Address to write value to. - Value to write. - A task that represents the asynchronous write operation. - - - - Write a single holding register. - - Address to write. - Value to write. - - - - Asynchronously writes a single holding register. - - Address to write. - Value to write. - A task that represents the asynchronous write operation. - - - - Write a block of 1 to 123 contiguous registers. - - Address to begin writing values. - Values to write. - - - - Asynchronously writes a block of 1 to 123 contiguous registers. - - Address to begin writing values. - Values to write. - A task that represents the asynchronous write operation. - - - - Force each coil in a sequence of coils to a provided value. - - Address to begin writing values. - Values to write. - - - - Asynchronously writes a sequence of coils. - - Address to begin writing values. - Values to write. - A task that represents the asynchronous write operation - - - - Performs a combination of one read operation and one write operation in a single MODBUS transaction. - The write operation is performed before the read. - Message uses default TCP slave id of 0. - - Address to begin reading (Holding registers are addressed starting at 0). - Number of registers to read. - Address to begin writing (Holding registers are addressed starting at 0). - Register values to write. - - - - Asynchronously performs a combination of one read operation and one write operation in a single Modbus transaction. - The write operation is performed before the read. - - Address to begin reading (Holding registers are addressed starting at 0). - Number of registers to read. - Address to begin writing (Holding registers are addressed starting at 0). - Register values to write. - A task that represents the asynchronous operation. - - - - Modbus master device. - - - - - Reads from 1 to 2000 contiguous coils status. - - Address of device to read values from. - Address to begin reading. - Number of coils to read. - Coils status. - - - - Asynchronously reads from 1 to 2000 contiguous coils status. - - Address of device to read values from. - Address to begin reading. - Number of coils to read. - A task that represents the asynchronous read operation. - - - - Reads from 1 to 2000 contiguous discrete input status. - - Address of device to read values from. - Address to begin reading. - Number of discrete inputs to read. - Discrete inputs status. - - - - Asynchronously reads from 1 to 2000 contiguous discrete input status. - - Address of device to read values from. - Address to begin reading. - Number of discrete inputs to read. - A task that represents the asynchronous read operation. - - - - Reads contiguous block of holding registers. - - Address of device to read values from. - Address to begin reading. - Number of holding registers to read. - Holding registers status. - - - - Asynchronously reads contiguous block of holding registers. - - Address of device to read values from. - Address to begin reading. - Number of holding registers to read. - A task that represents the asynchronous read operation. - - - - Reads contiguous block of input registers. - - Address of device to read values from. - Address to begin reading. - Number of holding registers to read. - Input registers status. - - - - Asynchronously reads contiguous block of input registers. - - Address of device to read values from. - Address to begin reading. - Number of holding registers to read. - A task that represents the asynchronous read operation. - - - - Writes a single coil value. - - Address of the device to write to. - Address to write value to. - Value to write. - - - - Asynchronously writes a single coil value. - - Address of the device to write to. - Address to write value to. - Value to write. - A task that represents the asynchronous write operation. - - - - Writes a single holding register. - - Address of the device to write to. - Address to write. - Value to write. - - - - Asynchronously writes a single holding register. - - Address of the device to write to. - Address to write. - Value to write. - A task that represents the asynchronous write operation. - - - - Write a block of 1 to 123 contiguous 16 bit holding registers. - - Address of the device to write to. - Address to begin writing values. - Values to write. - - - - Asynchronously writes a block of 1 to 123 contiguous registers. - - Address of the device to write to. - Address to begin writing values. - Values to write. - A task that represents the asynchronous write operation. - - - - Writes a sequence of coils. - - Address of the device to write to. - Address to begin writing values. - Values to write. - - - - Asynchronously writes a sequence of coils. - - Address of the device to write to. - Address to begin writing values. - Values to write. - A task that represents the asynchronous write operation. - - - - Performs a combination of one read operation and one write operation in a single Modbus transaction. - The write operation is performed before the read. - - Address of device to read values from. - Address to begin reading (Holding registers are addressed starting at 0). - Number of registers to read. - Address to begin writing (Holding registers are addressed starting at 0). - Register values to write. - - - - Asynchronously performs a combination of one read operation and one write operation in a single Modbus transaction. - The write operation is performed before the read. - - Address of device to read values from. - Address to begin reading (Holding registers are addressed starting at 0). - Number of registers to read. - Address to begin writing (Holding registers are addressed starting at 0). - Register values to write. - A task that represents the asynchronous operation. - - - - Write a file record to the device. - - Address of device to write values to - The Extended Memory file number - The starting register address within the file - The data to be written - - - - Executes the custom message. - - The type of the response. - The request. - - - - Represents an incoming connection from a Modbus master. Contains the slave's logic to process the connection. - - - - - Occurs when a Modbus master TCP connection is closed. - - - - - Modbus serial master device. - - - - - Gets the Modbus Transport. - - - - - Serial Line only. - Diagnostic function which loops back the original data. - NModbus only supports looping back one ushort value, this is a limitation of the "Best Effort" implementation of - the RTU protocol. - - Address of device to test. - Data to return. - Return true if slave device echoed data. - - - - Start slave listening for requests. - - - - - Apply the request. - - - - - - Modbus TCP slave device. - - - - - Gets the Modbus TCP Masters connected to this Modbus TCP Slave. - - - - - Gets the server. - - The server. - - This property is not thread safe, it should only be consumed within a lock. - - - - - Start slave listening for requests. - - - - - Releases unmanaged and - optionally - managed resources - - - true to release both managed and unmanaged resources; false to release only - unmanaged resources. - - Dispose is thread-safe. - - - - Modbus UDP slave device. - - - - - Start slave listening for requests. - - - - - Modbus Slave request event args containing information on the message. - - - - - Determines whether the crc stored in the message matches the calculated crc. - - - - - - - Gets the CRC of the message - - - - - - - Gets the specified value in the dictionary. If not found, returns default for TValue. - - - - - - - - - - Utility extensions for the Enron Modbus dialect. - - - - - Reads contiguous block of input registers with 32 bit register size. - - The Modbus master. - Address of device to read values from. - Address to begin reading. - Number of holding registers to read. - Input registers status. - - - - Reads contiguous block of holding registers. - - The Modbus master. - Address of device to read values from. - Address to begin reading. - Number of holding registers to read. - Holding registers status. - - - - Asynchronously reads contiguous block of input registers with 32 bit register size. - - The Modbus master. - Address of device to read values from. - Address to begin reading. - Number of holding registers to read. - A task that represents the asynchronous read operation. - - - - Asynchronously reads contiguous block of holding registers. - - The Modbus master. - Address of device to read values from. - Address to begin reading. - Number of holding registers to read. - A task that represents the asynchronous read operation. - - - - Write a single 16 bit holding register. - - The Modbus master. - Address of the device to write to. - Address to write. - Value to write. - - - - Write a block of contiguous 32 bit holding registers. - - The Modbus master. - Address of the device to write to. - Address to begin writing values. - Values to write. - - - Convert the 32 bit registers to two 16 bit values. - - - Convert the double 16 bit registers to single 32 bit values. - - - - Class containing functions to covert endian from network device to host this code is running on. - - - - - Converts BigEndian source bytes to Endian format of system. - Source BE: 0x0A,0x0B,0x0C,0x0D. - Target BE: 0x0A,0x0B,0x0C,0x0D. - Target LE: 0x0D,0x0C,0x0B,0x0A. - - Byte array from device - Bytes in Endian format for system - - - - Converts LittleEndian source bytes to Endian format of system. - Source LE: 0x0D,0x0C,0x0B,0x0A. - Target BE: 0x0A,0x0B,0x0C,0x0D. - Target LE: 0x0D,0x0C,0x0B,0x0A. - - Byte array from device - Bytes in Endian format for system - - - - This class provides some functions that can be used to read/write values of a set word size. - - - - - Utility Class to support Modbus 32/64bit devices. - - - - - Constructor with values to be used by all methods. - Default is 32bit, LittleEndian, with wordswapping. - - The Modbus master - Wordsize used by device. 16/32/64 are valid. - The endian encoding of the device. - Should the ushort words mirrored then flattened to bytes. - - - - Reads registers and converts the result into a char array. - - Address of device to read values from. - Address to begin reading. - Number of chars to read. - - - - - Reads registers and converts the result into a ushort array. - - Address of device to read values from. - Address to begin reading. - Number of ushorts to read. - - - - - Reads registers and converts the result into a short array. - - Address of device to read values from. - Address to begin reading. - Number of shots to read. - - - - - Reads registers and converts the result into a uint array. - - Address of device to read values from. - Address to begin reading. - Number of uints to read. - - - - - Reads registers and converts the result into a int array. - - Address of device to read values from. - Address to begin reading. - Number of ints to read. - - - - - Reads registers and converts the result into a float array. - - Address of device to read values from. - Address to begin reading. - Number of floats to read. - - - - - Write a char array to registers. - - Address of the device to write to. - Address to start writting values at. - Chars to write to device. - - - - Write a ushort array to registers. - - Address of the device to write to. - Address to start writting values at. - Ushorts to write to device. - - - - Write a short array to registers. - - Address of the device to write to. - Address to start writting values at. - Shorts to write to device. - - - - Write a int array to registers. - - Address of the device to write to. - Address to start writting values at. - Ints to write to device. - - - - Write a uint array to registers. - - Address of the device to write to. - Address to start writting values at. - Uints to write to device. - - - - Write a float array to registers. - - Address of the device to write to. - Address to start writting values at. - Floats to write to device. - - - - Extension methods for the IModbusFactory interface. - - - - - Creates an RTU master. - - - - - - - - Creates an ASCII master. - - - - - - - - Creates a TCP or UDP master. - - - - - - - - Creates an RTU slave network. - - - - - - - - Creates an ASCII slave network. - - - - - - - - Container for modbus function services. - - - - - Get the service for a given function code. - - - - - - - Gets all of the services. - - - - - - Create an rtu master. - - - - - - - Create a TCP master. - - - - - - - - - - - - - - Creates a Modbus Slave. - - The address of this slave on the Modbus network. - Optionally specify a custom data store for the created slave. - - - - - Creates a slave network based on the RTU transport. - - - - - - - Creates an ascii slave network. - - The ascii transport to base this on. - - - - - Create a slave network based on TCP. - - - - - - - Creates a UDP modbus slave network. - - - - - - - Creates an RTU transpoort. - - - - - - - Creates an Ascii Transport. - - - - - - - Creates an IP Transport - - - - - - - A Modbus slave message handler. - - - - - The function code that this handles - - - - - Creates a message that wrapps the request frame. - - - - - - - Handle a slave request. - - - - - - - - Gets the number of bytes to read for a request - - - - - - - Gets the number of bytes to read for a response. - - - - - - - Simple logging target. Designed to be easily integrated into other logging frameworks. - - - - - Conditionally log a message - - - - - - - True if this level should be logged, false otherwise. - - - - - - - Modbus master device. - - - - - Transport used by this master. - - - - - Reads from 1 to 2000 contiguous coils status. - - Address of device to read values from. - Address to begin reading. - Number of coils to read. - Coils status. - - - - Asynchronously reads from 1 to 2000 contiguous coils status. - - Address of device to read values from. - Address to begin reading. - Number of coils to read. - A task that represents the asynchronous read operation. - - - - Reads from 1 to 2000 contiguous discrete input status. - - Address of device to read values from. - Address to begin reading. - Number of discrete inputs to read. - Discrete inputs status. - - - - Asynchronously reads from 1 to 2000 contiguous discrete input status. - - Address of device to read values from. - Address to begin reading. - Number of discrete inputs to read. - A task that represents the asynchronous read operation. - - - - Reads contiguous block of holding registers. - - Address of device to read values from. - Address to begin reading. - Number of holding registers to read. - Holding registers status. - - - - Asynchronously reads contiguous block of holding registers. - - Address of device to read values from. - Address to begin reading. - Number of holding registers to read. - A task that represents the asynchronous read operation. - - - - Reads contiguous block of input registers. - - Address of device to read values from. - Address to begin reading. - Number of holding registers to read. - Input registers status. - - - - Asynchronously reads contiguous block of input registers. - - Address of device to read values from. - Address to begin reading. - Number of holding registers to read. - A task that represents the asynchronous read operation. - - - - Writes a single coil value. - - Address of the device to write to. - Address to write value to. - Value to write. - - - - Asynchronously writes a single coil value. - - Address of the device to write to. - Address to write value to. - Value to write. - A task that represents the asynchronous write operation. - - - - Writes a single holding register. - - Address of the device to write to. - Address to write. - Value to write. - - - - Asynchronously writes a single holding register. - - Address of the device to write to. - Address to write. - Value to write. - A task that represents the asynchronous write operation. - - - - Writes a block of 1 to 123 contiguous registers. - - Address of the device to write to. - Address to begin writing values. - Values to write. - - - - Asynchronously writes a block of 1 to 123 contiguous registers. - - Address of the device to write to. - Address to begin writing values. - Values to write. - A task that represents the asynchronous write operation. - - - - Writes a sequence of coils. - - Address of the device to write to. - Address to begin writing values. - Values to write. - - - - Asynchronously writes a sequence of coils. - - Address of the device to write to. - Address to begin writing values. - Values to write. - A task that represents the asynchronous write operation. - - - - Performs a combination of one read operation and one write operation in a single Modbus transaction. - The write operation is performed before the read. - - Address of device to read values from. - Address to begin reading (Holding registers are addressed starting at 0). - Number of registers to read. - Address to begin writing (Holding registers are addressed starting at 0). - Register values to write. - - - - Asynchronously performs a combination of one read operation and one write operation in a single Modbus transaction. - The write operation is performed before the read. - - Address of device to read values from. - Address to begin reading (Holding registers are addressed starting at 0). - Number of registers to read. - Address to begin writing (Holding registers are addressed starting at 0). - Register values to write. - A task that represents the asynchronous operation - - - - Write a file record to the device. - - Address of device to write values to - The Extended Memory file number - The starting register address within the file - The data to be written - - - - Executes the custom message. - - The type of the response. - The request. - - - - A message built by the master (client) that initiates a Modbus transaction. - - - - - The function code tells the server what kind of action to perform. - - - - - Address of the slave (server). - - - - - Composition of the slave address and protocol data unit. - - - - - Composition of the function code and message data. - - - - - A unique identifier assigned to a message when using the IP protocol. - - - - - Initializes a modbus message from the specified message frame. - - Bytes of Modbus frame. - - - - Modbus Serial Master device. - - - - - Transport for used by this master. - - - - - Serial Line only. - Diagnostic function which loops back the original data. - NModbus only supports looping back one ushort value, this is a - limitation of the "Best Effort" implementation of the RTU protocol. - - Address of device to test. - Data to return. - Return true if slave device echoed data. - - - - A modbus slave. - - - - - Gets the unit id of this slave. - - - - - Gets the data store for this slave. - - - - - Applies the request. - - - - - - - A network of slave devices on a single transport. - - - - - Listen for incoming requests. - - - - - - Add a slave to the network. - - - - - - Get a slave from the network. - - The slave address - The specified slave, or null if one can't be found. - - - - Removes a slave from the network. - - - - - - Modbus TCP slave device. - - - - - Gets the Modbus TCP Masters connected to this Modbus TCP Slave. - - - - - Represents a memory map. - - - - - - Read a series of points. - - - - - - - - Write a series of points. - - - - - - - Object simulation of a device memory map. - - - - - Gets the descrete coils. - - - - - Gets the discrete inputs. - - - - - Gets the holding registers. - - - - - Gets the input registers. - - - - - Following the guidelines from https://github.com/aspnet/Logging/wiki/Guidelines. - - - - - The most detailed log messages, may contain sensitive application data. These messages should be disabled by default and should never be enabled in a production environment. - - - - - Logs that are used for interactive investigation during development should use the Debug level. These logs should primarily contain information useful for debugging and have no long-term value. - This is the default most verbose level of logging. - - - - - Track the general flow of the application using logs at the Information level. These logs should have value in the long term. - - - - - Warnings should highlight an abnormal or unexpected event in the application flow. This event does not cause the application execution to stop, but can signify sub-optimal performance or a potential problem for the future. A common place to log a warning is from handled exceptions. - - - - - An error should be logged when the current flow of execution is stopped due to a failure. These should indicate a failure in the current activity, not an application-wide failure. These will mainly be unhandled exceptions and recoverable failures. - - - - - A critical log should describe an unrecoverable application or system crash, or a catastrophic failure that requires immediate attention. - - - - - An exception that provides the exception code that will be sent in response to an invalid Modbus request. - - - - - Initializes a new instance of the class with a specified Modbus exception code. - - The Modbus exception code to provide to the slave. - - - - Initializes a new instance of the class with a specified error message and Modbus exception code. - - The error message that explains the reason for the exception. - The Modbus exception code to provide to the slave. - - - - Initializes a new instance of the class with a specified Modbus exception code and a reference to the inner exception that is the cause of this exception. - - The Modbus exception code to provide to the slave. - The exception that is the cause of the current exception. If the parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception. - - - - Initializes a new instance of the class with a specified Modbus exception code and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The Modbus exception code to provide to the slave. - The exception that is the cause of the current exception. If the parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception. - - - - Initializes a new instance of the class with serialized data. - - The object that holds the serialized object data. - The contextual information about the source or destination. - - - - Gets the Modbus exception code to provide to the slave. - - - - Sets the object with the Modbus exception code and additional exception information. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - - - Represents a serial resource. - Implementor - http://en.wikipedia.org/wiki/Bridge_Pattern - - - - - Indicates that no timeout should occur. - - - - - Gets or sets the number of milliseconds before a timeout occurs when a read operation does not finish. - - - - - Gets or sets the number of milliseconds before a timeout occurs when a write operation does not finish. - - - - - Purges the receive buffer. - - - - - Reads a number of bytes from the input buffer and writes those bytes into a byte array at the specified offset. - - The byte array to write the input to. - The offset in the buffer array to begin writing. - The number of bytes to read. - The number of bytes read. - - - - Writes a specified number of bytes to the port from an output buffer, starting at the specified offset. - - The byte array that contains the data to write to the port. - The offset in the buffer array to begin writing. - The number of bytes to write. - - - - Refined Abstraction - http://en.wikipedia.org/wiki/Bridge_Pattern - - - - - Transport for Internet protocols. - Refined Abstraction - http://en.wikipedia.org/wiki/Bridge_Pattern - - - - - Create a new transaction ID. - - - - - Refined Abstraction - http://en.wikipedia.org/wiki/Bridge_Pattern - - - - - Transport for Serial protocols. - Refined Abstraction - http://en.wikipedia.org/wiki/Bridge_Pattern - - - - - Gets or sets a value indicating whether LRC/CRC frame checking is performed on messages. - - - - - Modbus transport. - Abstraction - http://en.wikipedia.org/wiki/Bridge_Pattern - - - - - This constructor is called by the NullTransport. - - - - - Number of times to retry sending message after encountering a failure such as an IOException, - TimeoutException, or a corrupt message. - - - - - If non-zero, this will cause a second reply to be read if the first is behind the sequence number of the - request by less than this number. For example, set this to 3, and if when sending request 5, response 3 is - read, we will attempt to re-read responses. - - - - - If set, Slave Busy exception causes retry count to be used. If false, Slave Busy will cause infinite retries - - - - - Gets or sets the number of milliseconds the tranport will wait before retrying a message after receiving - an ACKNOWLEGE or SLAVE DEVICE BUSY slave exception response. - - - - - Gets or sets the number of milliseconds before a timeout occurs when a read operation does not finish. - - - - - Gets or sets the number of milliseconds before a timeout occurs when a write operation does not finish. - - - - - Gets the stream resource. - - - - - Gets the logger for this instance. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Check whether we need to attempt to read another response before processing it (e.g. response was from previous request) - - - - - Provide hook to check whether receiving a response should be retried - - - - - Provide hook to do transport level message validation. - - - - - Releases unmanaged and - optionally - managed resources - - - true to release both managed and unmanaged resources; false to release only - unmanaged resources. - - - - - Concrete Implementor - http://en.wikipedia.org/wiki/Bridge_Pattern - This implementation is for sockets that Convert Rs485 to Ethernet. - - - - - Concrete Implementor - http://en.wikipedia.org/wiki/Bridge_Pattern - - - - - Concrete Implementor - http://en.wikipedia.org/wiki/Bridge_Pattern - - - - - Writes using Debug.WriteLine(). - - - - - Base class for Modbus loggers. - - - - - Returns true if the level should be loggged, false otherwise. - - - - - - - Log the specified message at the specified level. - - - - - - - Override this method to implement logging behavior. This function will only be called if ShouldLog(level) is true. - - - - - - - Empty logger. - - - - - Singleton. - - - - - This won't do anything. - - - - - - - Always returnsa false - - - - - - - Abstract Modbus message. - - - - - Abstract Modbus message. - - - - - Abstract Modbus message. - - - - - Methods specific to a modbus request message. - - - - - Validate the specified response against the current request. - - - - - Modbus message factory. - - - - - Create a Modbus message. - - Modbus message type. - Bytes of Modbus frame. - New Modbus message based on type and frame bytes. - - - - Class holding all implementation shared between two or more message types. - Interfaces expose subsets of type specific implementations. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Write Multiple Coils request. - - - - - Write Multiple Coils request. - - - - - Write Multiple Coils request. - - - - - Defines constants related to the Modbus protocol. - - - - - The "built-in" message handlers. - - - - - Create a factory which uses the built in standard slave function handlers. - - - - - Create a factory which optionally uses the built in function services and allows custom services to be added. - - User provided function services. - If true, the built in function services are included. Otherwise, all function services will come from the functionService parameter. - Logger - - - - Supported function codes - - - - - 502: mbap/TCP - - - - - 802: mbap/TLS/TCP - - - - - Represents slave errors that occur during communication. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Initializes a new instance of the class. - - - The that holds the serialized - object data about the exception being thrown. - - - The that contains contextual - information about the source or destination. - - - The class name is null or - is zero (0). - - The info parameter is null. - - - - Gets a message that describes the current exception. - - - The error message that explains the reason for the exception, or an empty string. - - - - - Gets the response function code that caused the exception to occur, or 0. - - The function code. - - - - Gets the slave exception code, or 0. - - The slave exception code. - - - - Gets the slave address, or 0. - - The slave address. - - - - When overridden in a derived class, sets the - with information about the exception. - - - The that holds the serialized - object data about the exception being thrown. - - - The that contains contextual - information about the source or destination. - - The info parameter is a null reference (Nothing in Visual Basic). - - - - - - - - Modbus slave exception codes - - - - - The function code received in the query is not an allowable action for the slave. This may be because the function code is only applicable to newer devices, and was not implemented in the unit selected. It could also indicate that the slave is in the wrong state to process a request of this type, for example because it is unconfigured and is being asked to return register values. If a Poll Program Complete command was issued, this code indicates that no program function preceded it. - - - - - The data address received in the query is not an allowable address for the slave. More specifically, the combination of reference number and transfer length is invalid. For a controller with 100 registers, a request with offset 96 and length 4 would succeed, a request with offset 96 and length 5 will generate exception 02. - - - - - A value contained in the query data field is not an allowable value for the slave. This indicates a fault in the structure of remainder of a complex request, such as that the implied length is incorrect. It specifically does NOT mean that a data item submitted for storage in a register has a value outside the expectation of the application program, since the MODBUS protocol is unaware of the significance of any particular value of any particular register. - - - - - An unrecoverable error occurred while the slave was attempting to perform the requested action. - - - - - Specialized use in conjunction with programming commands. - - The slave has accepted the request and is processing it, but a long duration of time will be required to do so.T - his response is returned to prevent a timeout error from occurring in the master.The master can next issue a - Poll Program Complete message to determine if processing is completed. - - - - - Specialized use in conjunction with programming commands. - The slave is engaged in processing a long-duration program command.The master should retransmit - the message later when the slave is free. - - - - - Possible options for DiscriminatedUnion type. - - - - - Option A. - - - - - Option B. - - - - - A data type that can store one of two possible strongly typed options. - - The type of option A. - The type of option B. - - - - Gets the value of option A. - - - - - Gets the value of option B. - - - - - Gets the discriminated value option set for this instance. - - - - - Factory method for creating DiscriminatedUnion with option A set. - - - - - Factory method for creating DiscriminatedUnion with option B set. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Modbus utility methods. - - - - - Converts four UInt16 values into a IEEE 64 floating point format. - - Highest-order ushort value. - Second-to-highest-order ushort value. - Second-to-lowest-order ushort value. - Lowest-order ushort value. - IEEE 64 floating point value. - - - - Converts two UInt16 values into a IEEE 32 floating point format. - - High order ushort value. - Low order ushort value. - IEEE 32 floating point value. - - - - Converts two UInt16 values into a UInt32. - - - - - Converts an array of bytes to an ASCII byte array. - - The byte array. - An array of ASCII byte values. - - - - Converts an array of UInt16 to an ASCII byte array. - - The ushort array. - An array of ASCII byte values. - - - - Converts a network order byte array to an array of UInt16 values in host order. - - The network order byte array. - The host order ushort array. - - - - Converts a hex string to a byte array. - - The hex string. - Array of bytes. - - - - Calculate Longitudinal Redundancy Check. - - The data used in LRC. - LRC value. - - - - Calculate Cyclical Redundancy Check. - - The data used in CRC. - CRC value. - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Newtonsoft.Json.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Newtonsoft.Json.dll deleted file mode 100644 index 341d08f..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Newtonsoft.Json.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Newtonsoft.Json.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/Newtonsoft.Json.xml deleted file mode 100644 index 2c981ab..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/Newtonsoft.Json.xml +++ /dev/null @@ -1,11363 +0,0 @@ - - - - Newtonsoft.Json - - - - - Represents a BSON Oid (object id). - - - - - Gets or sets the value of the Oid. - - The value of the Oid. - - - - Initializes a new instance of the class. - - The Oid value. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. - - - - - Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. - - - true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. - - - - - Gets or sets a value indicating whether the root object will be read as a JSON array. - - - true if the root object will be read as a JSON array; otherwise, false. - - - - - Gets or sets the used when reading values from BSON. - - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. - - - - - Gets or sets the used when writing values to BSON. - When set to no conversion will occur. - - The used when writing values to BSON. - - - - Initializes a new instance of the class. - - The to write to. - - - - Initializes a new instance of the class. - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. - - - - - Writes the end. - - The token. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes the beginning of a JSON array. - - - - - Writes the beginning of a JSON object. - - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value that represents a BSON object id. - - The Object ID value to write. - - - - Writes a BSON regex. - - The regex pattern. - The regex options. - - - - Specifies how constructors are used when initializing objects during deserialization by the . - - - - - First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. - - - - - Json.NET will use a non-public default constructor before falling back to a parameterized constructor. - - - - - Converts a binary value to and from a base 64 string value. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Creates a custom object. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Creates an object which will then be populated by the serializer. - - Type of the object. - The created object. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Provides a base class for converting a to and from JSON. - - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a F# discriminated union type to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an Entity Framework to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). - - - - - Gets or sets the date time styles used when converting a date to and from JSON. - - The date time styles used when converting a date to and from JSON. - - - - Gets or sets the date time format used when converting a date to and from JSON. - - The date time format used when converting a date to and from JSON. - - - - Gets or sets the culture used when converting a date to and from JSON. - - The culture used when converting a date to and from JSON. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from its name string value. - - - - - Gets or sets a value indicating whether the written enum text should be camel case. - The default value is false. - - true if the written enum text will be camel case; otherwise, false. - - - - Gets or sets the naming strategy used to resolve how enum text is written. - - The naming strategy used to resolve how enum text is written. - - - - Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. - The default value is true. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - true if the written enum text will be camel case; otherwise, false. - - - - Initializes a new instance of the class. - - The naming strategy used to resolve how enum text is written. - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from Unix epoch time - - - - - Gets or sets a value indicating whether the dates before Unix epoch - should converted to and from JSON. - - - true to allow converting dates before Unix epoch to and from JSON; - false to throw an exception when a date being converted to or from JSON - occurred before Unix epoch. The default value is false. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - true to allow converting dates before Unix epoch to and from JSON; - false to throw an exception when a date being converted to or from JSON - occurred before Unix epoch. The default value is false. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from a string (e.g. "1.2.3.4"). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts XML to and from JSON. - - - - - Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. - - The name of the deserialized root element. - - - - Gets or sets a value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - true if the array attribute is written to the XML; otherwise, false. - - - - Gets or sets a value indicating whether to write the root JSON object. - - true if the JSON root object is omitted; otherwise, false. - - - - Gets or sets a value indicating whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - true if special characters are encoded; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The calling serializer. - The value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Checks if the is a namespace attribute. - - Attribute name to test. - The attribute name prefix if it has one, otherwise an empty string. - true if attribute name is for a namespace attribute, otherwise false. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Specifies how dates are formatted when writing JSON text. - - - - - Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". - - - - - Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". - - - - - Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. - - - - - Date formatted strings are not parsed to a date type and are read as strings. - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Specifies how to treat the time value when converting between string and . - - - - - Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. - - - - - Treat as a UTC. If the object represents a local time, it is converted to a UTC. - - - - - Treat as a local time if a is being converted to a string. - If a string is being converted to , convert to a local time if a time zone is specified. - - - - - Time zone information should be preserved when converting. - - - - - The default JSON name table implementation. - - - - - Initializes a new instance of the class. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Adds the specified string into name table. - - The string to add. - This method is not thread-safe. - The resolved string. - - - - Specifies default value handling options for the . - - - - - - - - - Include members where the member value is the same as the member's default value when serializing objects. - Included members are written to JSON. Has no effect when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - so that it is not written to JSON. - This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, - decimals and floating point numbers; and false for booleans). The default value ignored can be changed by - placing the on the property. - - - - - Members with a default value but no JSON will be set to their default value when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - and set members to their default value when deserializing. - - - - - Specifies float format handling options when writing special floating point numbers, e.g. , - and with . - - - - - Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". - - - - - Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. - Note that this will produce non-valid JSON. - - - - - Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. - - - - - Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Floating point numbers are parsed to . - - - - - Floating point numbers are parsed to . - - - - - Specifies formatting options for the . - - - - - No special formatting is applied. This is the default. - - - - - Causes child objects to be indented according to the and settings. - - - - - Provides an interface for using pooled arrays. - - The array type content. - - - - Rent an array from the pool. This array must be returned when it is no longer needed. - - The minimum required length of the array. The returned array may be longer. - The rented array from the pool. This array must be returned when it is no longer needed. - - - - Return an array to the pool. - - The array that is being returned. - - - - Provides an interface to enable a class to return line and position information. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - The current line number or 0 if no line information is available (for example, when returns false). - - - - Gets the current line position. - - The current line position or 0 if no line information is available (for example, when returns false). - - - - Instructs the how to serialize the collection. - - - - - Gets or sets a value indicating whether null items are allowed in the collection. - - true if null items are allowed in the collection; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a flag indicating whether the array can contain null items. - - A flag indicating whether the array can contain null items. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to use the specified constructor when deserializing that object. - - - - - Instructs the how to serialize the object. - - - - - Gets or sets the id. - - The id. - - - - Gets or sets the title. - - The title. - - - - Gets or sets the description. - - The description. - - - - Gets or sets the collection's items converter. - - The collection's items converter. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets a value that indicates whether to preserve object references. - - - true to keep object reference; otherwise, false. The default is false. - - - - - Gets or sets a value that indicates whether to preserve collection's items references. - - - true to keep collection's items object references; otherwise, false. The default is false. - - - - - Gets or sets the reference loop handling used when serializing the collection's items. - - The reference loop handling. - - - - Gets or sets the type name handling used when serializing the collection's items. - - The type name handling. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Provides methods for converting between .NET types and JSON types. - - - - - - - - Gets or sets a function that creates default . - Default settings are automatically used by serialization methods on , - and and on . - To serialize without using any default settings create a with - . - - - - - Represents JavaScript's boolean value true as a string. This field is read-only. - - - - - Represents JavaScript's boolean value false as a string. This field is read-only. - - - - - Represents JavaScript's null as a string. This field is read-only. - - - - - Represents JavaScript's undefined as a string. This field is read-only. - - - - - Represents JavaScript's positive infinity as a string. This field is read-only. - - - - - Represents JavaScript's negative infinity as a string. This field is read-only. - - - - - Represents JavaScript's NaN as a string. This field is read-only. - - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - The time zone handling when the date is converted to a string. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - The string escape handling. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Serializes the specified object to a JSON string. - - The object to serialize. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting. - - The object to serialize. - Indicates how the output should be formatted. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a collection of . - - The object to serialize. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting and a collection of . - - The object to serialize. - Indicates how the output should be formatted. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Deserializes the JSON to a .NET object. - - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to a .NET object using . - - The JSON to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The JSON to deserialize. - The of object being deserialized. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The type of the object to deserialize to. - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the given anonymous type. - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the given anonymous type using . - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The type of the object to deserialize to. - The JSON to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The type of the object to deserialize to. - The object to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The JSON to deserialize. - The type of the object to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The JSON to deserialize. - The type of the object to deserialize to. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Populates the object with values from the JSON string. - - The JSON to populate values from. - The target object to populate values onto. - - - - Populates the object with values from the JSON string using . - - The JSON to populate values from. - The target object to populate values onto. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - - - Serializes the to a JSON string. - - The node to serialize. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to serialize. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Serializes the to a JSON string. - - The node to convert to JSON. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to convert to JSON. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Converts an object to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can read JSON. - - true if this can read JSON; otherwise, false. - - - - Gets a value indicating whether this can write JSON. - - true if this can write JSON; otherwise, false. - - - - Converts an object to and from JSON. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. If there is no existing value then null will be used. - The existing value has a value. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Instructs the to use the specified when serializing the member or class. - - - - - Gets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - - - - - Initializes a new instance of the class. - - Type of the . - - - - Initializes a new instance of the class. - - Type of the . - Parameter list to use when constructing the . Can be null. - - - - Represents a collection of . - - - - - Instructs the how to serialize the collection. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Instructs the to deserialize properties with no matching class member into the specified collection - and write values during serialization. - - - - - Gets or sets a value that indicates whether to write extension data when serializing the object. - - - true to write extension data when serializing the object; otherwise, false. The default is true. - - - - - Gets or sets a value that indicates whether to read extension data when deserializing the object. - - - true to read extension data when deserializing the object; otherwise, false. The default is true. - - - - - Initializes a new instance of the class. - - - - - Instructs the not to serialize the public field or public read/write property value. - - - - - Base class for a table of atomized string objects. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Instructs the how to serialize the object. - - - - - Gets or sets the member serialization. - - The member serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified member serialization. - - The member serialization. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to always serialize the member with the specified name. - - - - - Gets or sets the type used when serializing the property's collection items. - - The collection's items type. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the null value handling used when serializing this property. - - The null value handling. - - - - Gets or sets the default value handling used when serializing this property. - - The default value handling. - - - - Gets or sets the reference loop handling used when serializing this property. - - The reference loop handling. - - - - Gets or sets the object creation handling used when deserializing this property. - - The object creation handling. - - - - Gets or sets the type name handling used when serializing this property. - - The type name handling. - - - - Gets or sets whether this property's value is serialized as a reference. - - Whether this property's value is serialized as a reference. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets a value indicating whether this property is required. - - - A value indicating whether this property is required. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified name. - - Name of the property. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously skips the children of the current token. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Specifies the state of the reader. - - - - - A read method has not been called. - - - - - The end of the file has been reached successfully. - - - - - Reader is at a property. - - - - - Reader is at the start of an object. - - - - - Reader is in an object. - - - - - Reader is at the start of an array. - - - - - Reader is in an array. - - - - - The method has been called. - - - - - Reader has just read a value. - - - - - Reader is at the start of a constructor. - - - - - Reader is in a constructor. - - - - - An error occurred that prevents the read operation from continuing. - - - - - The end of the file has been reached successfully. - - - - - Gets the current reader state. - - The current reader state. - - - - Gets or sets a value indicating whether the source should be closed when this reader is closed. - - - true to close the source when this reader is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether multiple pieces of JSON content can - be read from a continuous stream without erroring. - - - true to support reading multiple pieces of JSON content; otherwise false. - The default is false. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - Gets or sets how time zones are handled when reading JSON. - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Gets or sets how custom date formatted strings are parsed when reading JSON. - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is 64. - - - - - Gets the type of the current JSON token. - - - - - Gets the text value of the current JSON token. - - - - - Gets the .NET type for the current JSON token. - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets or sets the culture used when reading JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Reads the next JSON token from the source. - - true if the next token was read successfully; false if there are no more tokens to read. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Skips the children of the current token. - - - - - Sets the current token. - - The new token. - - - - Sets the current token and value. - - The new token. - The value. - - - - Sets the current token and value. - - The new token. - The value. - A flag indicating whether the position index inside an array should be updated. - - - - Sets the state based on current token type. - - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Changes the reader's state to . - If is set to true, the source is also closed. - - - - - The exception thrown when an error occurs while reading JSON text. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Instructs the to always serialize the member, and to require that the member has a value. - - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Serializes and deserializes objects into and from the JSON format. - The enables you to control how objects are encoded into JSON. - - - - - Occurs when the errors during serialization and deserialization. - - - - - Gets or sets the used by the serializer when resolving references. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - - - - Gets or sets how reference loops (e.g. a class referencing itself) is handled. - The default value is . - - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets a collection that will be used during serialization. - - Collection that will be used during serialization. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is 64. - - - - - Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. - The default value is false. - - - true if there will be a check for additional JSON content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Creates a new instance. - The will not use default settings - from . - - - A new instance. - The will not use default settings - from . - - - - - Creates a new instance using the specified . - The will not use default settings - from . - - The settings to be applied to the . - - A new instance using the specified . - The will not use default settings - from . - - - - - Creates a new instance. - The will use default settings - from . - - - A new instance. - The will use default settings - from . - - - - - Creates a new instance using the specified . - The will use default settings - from as well as the specified . - - The settings to be applied to the . - - A new instance using the specified . - The will use default settings - from as well as the specified . - - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Deserializes the JSON structure contained by the specified . - - The that contains the JSON structure to deserialize. - The being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The type of the object to deserialize. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Specifies the settings on a object. - - - - - Gets or sets how reference loops (e.g. a class referencing itself) are handled. - The default value is . - - Reference loop handling. - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - Missing member handling. - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - Null value handling. - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - The default value handling. - - - - Gets or sets a collection that will be used during serialization. - - The converters. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - The preserve references handling. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - The type name handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - The contract resolver. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets the used by the serializer when resolving references. - - The reference resolver. - - - - Gets or sets a function that creates the used by the serializer when resolving references. - - A function that creates the used by the serializer when resolving references. - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the error handler called during serialization and deserialization. - - The error handler called during serialization and deserialization. - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is 64. - - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets a value indicating whether there will be a check for additional content after deserializing an object. - The default value is false. - - - true if there will be a check for additional content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - using values copied from the passed in . - - - - - Represents a reader that provides fast, non-cached, forward-only access to JSON text data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Initializes a new instance of the class with the specified . - - The containing the JSON data to read. - - - - Gets or sets the reader's property name table. - - - - - Gets or sets the reader's character buffer pool. - - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - - The current line number or 0 if no line information is available (for example, returns false). - - - - - Gets the current line position. - - - The current line position or 0 if no line information is available (for example, returns false). - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Gets or sets the writer's character array pool. - - - - - Gets or sets how many s to write for each level in the hierarchy when is set to . - - - - - Gets or sets which character to use to quote attribute values. - - - - - Gets or sets which character to use for indenting when is set to . - - - - - Gets or sets a value indicating whether object names will be surrounded with quotes. - - - - - Initializes a new instance of the class using the specified . - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying . - - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the specified end token. - - The end token to write. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Specifies the type of JSON token. - - - - - This is returned by the if a read method has not been called. - - - - - An object start token. - - - - - An array start token. - - - - - A constructor start token. - - - - - An object property name. - - - - - A comment. - - - - - Raw JSON. - - - - - An integer. - - - - - A float. - - - - - A string. - - - - - A boolean. - - - - - A null token. - - - - - An undefined token. - - - - - An object end token. - - - - - An array end token. - - - - - A constructor end token. - - - - - A Date. - - - - - Byte data. - - - - - - Represents a reader that provides validation. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Sets an event handler for receiving schema validation errors. - - - - - Gets the text value of the current JSON token. - - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - - Gets the type of the current JSON token. - - - - - - Gets the .NET type for the current JSON token. - - - - - - Initializes a new instance of the class that - validates the content returned from the given . - - The to read from while validating. - - - - Gets or sets the schema. - - The schema. - - - - Gets the used to construct this . - - The specified in the constructor. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a []. - - - A [] or null if the next JSON token is null. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously ets the state of the . - - The being written. - The value being written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Gets or sets a value indicating whether the destination should be closed when this writer is closed. - - - true to close the destination when this writer is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. - - - true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. - - - - - Gets the top. - - The top. - - - - Gets the state of the writer. - - - - - Gets the path of the writer. - - - - - Gets or sets a value indicating how JSON text output should be formatted. - - - - - Gets or sets how dates are written to JSON text. - - - - - Gets or sets how time zones are handled when writing JSON text. - - - - - Gets or sets how strings are escaped when writing JSON text. - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written to JSON text. - - - - - Gets or sets how and values are formatted when writing JSON text. - - - - - Gets or sets the culture used when writing JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the destination and also flushes the destination. - - - - - Closes this writer. - If is set to true, the destination is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the end of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the end of an array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end constructor. - - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes the end of the current JSON object or array. - - - - - Writes the current token and its children. - - The to read the token from. - - - - Writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - - - - Writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - - - - Writes the token. - - The to write. - - - - Writes the specified end token. - - The end token to write. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON without changing the writer's state. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Sets the state of the . - - The being written. - The value being written. - - - - The exception thrown when an error occurs while writing JSON text. - - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Specifies how JSON comments are handled when loading JSON. - - - - - Ignore comments. - - - - - Load comments as a with type . - - - - - Specifies how duplicate property names are handled when loading JSON. - - - - - Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. - - - - - Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. - - - - - Throw a when a duplicate property is encountered. - - - - - Contains the LINQ to JSON extension methods. - - - - - Returns a collection of tokens that contains the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the descendants of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, and the descendants of every token in the source collection. - - - - Returns a collection of child properties of every object in the source collection. - - An of that contains the source collection. - An of that contains the properties of every object in the source collection. - - - - Returns a collection of child values of every object in the source collection with the given key. - - An of that contains the source collection. - The token key. - An of that contains the values of every token in the source collection with the given key. - - - - Returns a collection of child values of every object in the source collection. - - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child values of every object in the source collection with the given key. - - The type to convert the values to. - An of that contains the source collection. - The token key. - An that contains the converted values of every token in the source collection with the given key. - - - - Returns a collection of converted child values of every object in the source collection. - - The type to convert the values to. - An of that contains the source collection. - An that contains the converted values of every token in the source collection. - - - - Converts the value. - - The type to convert the value to. - A cast as a of . - A converted value. - - - - Converts the value. - - The source collection type. - The type to convert the value to. - A cast as a of . - A converted value. - - - - Returns a collection of child tokens of every array in the source collection. - - The source collection type. - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child tokens of every array in the source collection. - - An of that contains the source collection. - The type to convert the values to. - The source collection type. - An that contains the converted values of every token in the source collection. - - - - Returns the input typed as . - - An of that contains the source collection. - The input typed as . - - - - Returns the input typed as . - - The source collection type. - An of that contains the source collection. - The input typed as . - - - - Represents a collection of objects. - - The type of token. - - - - Gets the of with the specified key. - - - - - - Represents a JSON array. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Loads an from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads an from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the at the specified index. - - - - - - Determines the index of a specific item in the . - - The object to locate in the . - - The index of if found in the list; otherwise, -1. - - - - - Inserts an item to the at the specified index. - - The zero-based index at which should be inserted. - The object to insert into the . - - is not a valid index in the . - - - - - Removes the item at the specified index. - - The zero-based index of the item to remove. - - is not a valid index in the . - - - - - Returns an enumerator that iterates through the collection. - - - A of that can be used to iterate through the collection. - - - - - Adds an item to the . - - The object to add to the . - - - - Removes all items from the . - - - - - Determines whether the contains a specific value. - - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - - Copies the elements of the to an array, starting at a particular array index. - - The array. - Index of the array. - - - - Gets a value indicating whether the is read-only. - - true if the is read-only; otherwise, false. - - - - Removes the first occurrence of a specific object from the . - - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . - - - - - Represents a JSON constructor. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets or sets the name of this constructor. - - The constructor name. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name. - - The constructor name. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a token that can contain other tokens. - - - - - Occurs when the list changes or an item in the list changes. - - - - - Occurs before an item is added to the collection. - - - - - Occurs when the items list of the collection has changed, or the collection is reset. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Get the first child token of this token. - - - A containing the first child token of the . - - - - - Get the last child token of this token. - - - A containing the last child token of the . - - - - - Returns a collection of the child tokens of this token, in document order. - - - An of containing the child tokens of this , in document order. - - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - - A containing the child values of this , in document order. - - - - - Returns a collection of the descendant tokens for this token in document order. - - An of containing the descendant tokens of the . - - - - Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. - - An of containing this token, and all the descendant tokens of the . - - - - Adds the specified content as children of this . - - The content to be added. - - - - Adds the specified content as the first children of this . - - The content to be added. - - - - Creates a that can be used to add tokens to the . - - A that is ready to have content written to it. - - - - Replaces the child nodes of this token with the specified content. - - The content. - - - - Removes the child nodes from this token. - - - - - Merge the specified content into this . - - The content to be merged. - - - - Merge the specified content into this using . - - The content to be merged. - The used to merge the content. - - - - Gets the count of child JSON tokens. - - The count of child JSON tokens. - - - - Represents a collection of objects. - - The type of token. - - - - An empty collection of objects. - - - - - Initializes a new instance of the struct. - - The enumerable. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Gets the of with the specified key. - - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Represents a JSON object. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Occurs when a property value changes. - - - - - Occurs when a property value is changing. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Gets the node type for this . - - The type. - - - - Gets an of of this object's properties. - - An of of this object's properties. - - - - Gets a with the specified name. - - The property name. - A with the specified name or null. - - - - Gets the with the specified name. - The exact name will be searched for first and if no matching property is found then - the will be used to match a property. - - The property name. - One of the enumeration values that specifies how the strings will be compared. - A matched with the specified name or null. - - - - Gets a of of this object's property values. - - A of of this object's property values. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the with the specified property name. - - - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified property name. - - Name of the property. - The with the specified property name. - - - - Gets the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - One of the enumeration values that specifies how the strings will be compared. - The with the specified property name. - - - - Tries to get the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - The value. - One of the enumeration values that specifies how the strings will be compared. - true if a value was successfully retrieved; otherwise, false. - - - - Adds the specified property name. - - Name of the property. - The value. - - - - Determines whether the JSON object has the specified property name. - - Name of the property. - true if the JSON object has the specified property name; otherwise, false. - - - - Removes the property with the specified name. - - Name of the property. - true if item was successfully removed; otherwise, false. - - - - Tries to get the with the specified property name. - - Name of the property. - The value. - true if a value was successfully retrieved; otherwise, false. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Represents a JSON property. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the property name. - - The property name. - - - - Gets or sets the property value. - - The property value. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a view of a . - - - - - Initializes a new instance of the class. - - The name. - - - - When overridden in a derived class, returns whether resetting an object changes its value. - - - true if resetting the component changes its value; otherwise, false. - - The component to test for reset capability. - - - - When overridden in a derived class, gets the current value of the property on a component. - - - The value of a property for a given component. - - The component with the property for which to retrieve the value. - - - - When overridden in a derived class, resets the value for this property of the component to the default value. - - The component with the property value that is to be reset to the default value. - - - - When overridden in a derived class, sets the value of the component to a different value. - - The component with the property value that is to be set. - The new value. - - - - When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. - - - true if the property should be persisted; otherwise, false. - - The component with the property to be examined for persistence. - - - - When overridden in a derived class, gets the type of the component this property is bound to. - - - A that represents the type of component this property is bound to. - When the or - - methods are invoked, the object specified might be an instance of this type. - - - - - When overridden in a derived class, gets a value indicating whether this property is read-only. - - - true if the property is read-only; otherwise, false. - - - - - When overridden in a derived class, gets the type of the property. - - - A that represents the type of the property. - - - - - Gets the hash code for the name of the member. - - - - The hash code for the name of the member. - - - - - Represents a raw JSON string. - - - - - Asynchronously creates an instance of with the content of the reader's current token. - - The reader. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns an instance of with the content of the reader's current token. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class. - - The raw json. - - - - Creates an instance of with the content of the reader's current token. - - The reader. - An instance of with the content of the reader's current token. - - - - Specifies the settings used when cloning JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a flag that indicates whether to copy annotations when cloning a . - The default value is true. - - - A flag that indicates whether to copy annotations when cloning a . - - - - - Specifies the settings used when loading JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets how JSON comments are handled when loading JSON. - The default value is . - - The JSON comment handling. - - - - Gets or sets how JSON line info is handled when loading JSON. - The default value is . - - The JSON line info handling. - - - - Gets or sets how duplicate property names in JSON objects are handled when loading JSON. - The default value is . - - The JSON duplicate property name handling. - - - - Specifies the settings used when merging JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the method used when merging JSON arrays. - - The method used when merging JSON arrays. - - - - Gets or sets how null value properties are merged. - - How null value properties are merged. - - - - Gets or sets the comparison used to match property names while merging. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - The comparison used to match property names while merging. - - - - Specifies the settings used when selecting JSON. - - - - - Gets or sets a timeout that will be used when executing regular expressions. - - The timeout that will be used when executing regular expressions. - - - - Gets or sets a flag that indicates whether an error should be thrown if - no tokens are found when evaluating part of the expression. - - - A flag that indicates whether an error should be thrown if - no tokens are found when evaluating part of the expression. - - - - - Represents an abstract JSON token. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Writes this token to a asynchronously. - - A into which this method will write. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Gets a comparer that can compare two tokens for value equality. - - A that can compare two nodes for value equality. - - - - Gets or sets the parent. - - The parent. - - - - Gets the root of this . - - The root of this . - - - - Gets the node type for this . - - The type. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Compares the values of two tokens, including the values of all descendant tokens. - - The first to compare. - The second to compare. - true if the tokens are equal; otherwise false. - - - - Gets the next sibling token of this node. - - The that contains the next sibling token. - - - - Gets the previous sibling token of this node. - - The that contains the previous sibling token. - - - - Gets the path of the JSON token. - - - - - Adds the specified content immediately after this token. - - A content object that contains simple content or a collection of content objects to be added after this token. - - - - Adds the specified content immediately before this token. - - A content object that contains simple content or a collection of content objects to be added before this token. - - - - Returns a collection of the ancestor tokens of this token. - - A collection of the ancestor tokens of this token. - - - - Returns a collection of tokens that contain this token, and the ancestors of this token. - - A collection of tokens that contain this token, and the ancestors of this token. - - - - Returns a collection of the sibling tokens after this token, in document order. - - A collection of the sibling tokens after this tokens, in document order. - - - - Returns a collection of the sibling tokens before this token, in document order. - - A collection of the sibling tokens before this token, in document order. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets the with the specified key converted to the specified type. - - The type to convert the token to. - The token key. - The converted token value. - - - - Get the first child token of this token. - - A containing the first child token of the . - - - - Get the last child token of this token. - - A containing the last child token of the . - - - - Returns a collection of the child tokens of this token, in document order. - - An of containing the child tokens of this , in document order. - - - - Returns a collection of the child tokens of this token, in document order, filtered by the specified type. - - The type to filter the child tokens on. - A containing the child tokens of this , in document order. - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - A containing the child values of this , in document order. - - - - Removes this token from its parent. - - - - - Replaces this token with the specified token. - - The value. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Returns the indented JSON for this token. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - The indented JSON for this token. - - - - - Returns the JSON for this token using the given formatting and converters. - - Indicates how the output should be formatted. - A collection of s which will be used when writing the token. - The JSON for this token using the given formatting and converters. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to []. - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from [] to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Creates a for this token. - - A that can be used to read this token and its descendants. - - - - Creates a from an object. - - The object that will be used to create . - A with the value of the specified object. - - - - Creates a from an object using the specified . - - The object that will be used to create . - The that will be used when reading the object. - A with the value of the specified object. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - Creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A , or null. - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - A . - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - The used to select tokens. - A . - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - An of that contains the selected elements. - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - An of that contains the selected elements. - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - The used to select tokens. - An of that contains the selected elements. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Creates a new instance of the . All child tokens are recursively cloned. - - A new instance of the . - - - - Creates a new instance of the . All child tokens are recursively cloned. - - A object to configure cloning settings. - A new instance of the . - - - - Adds an object to the annotation list of this . - - The annotation to add. - - - - Get the first annotation object of the specified type from this . - - The type of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets the first annotation object of the specified type from this . - - The of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets a collection of annotations of the specified type for this . - - The type of the annotations to retrieve. - An that contains the annotations for this . - - - - Gets a collection of annotations of the specified type for this . - - The of the annotations to retrieve. - An of that contains the annotations that match the specified type for this . - - - - Removes the annotations of the specified type from this . - - The type of annotations to remove. - - - - Removes the annotations of the specified type from this . - - The of annotations to remove. - - - - Compares tokens to determine whether they are equal. - - - - - Determines whether the specified objects are equal. - - The first object of type to compare. - The second object of type to compare. - - true if the specified objects are equal; otherwise, false. - - - - - Returns a hash code for the specified object. - - The for which a hash code is to be returned. - A hash code for the specified object. - The type of is a reference type and is null. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Gets the at the reader's current position. - - - - - Initializes a new instance of the class. - - The token to read from. - - - - Initializes a new instance of the class. - - The token to read from. - The initial path of the token. It is prepended to the returned . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Gets the path of the current JSON token. - - - - - Specifies the type of token. - - - - - No token type has been set. - - - - - A JSON object. - - - - - A JSON array. - - - - - A JSON constructor. - - - - - A JSON object property. - - - - - A comment. - - - - - An integer value. - - - - - A float value. - - - - - A string value. - - - - - A boolean value. - - - - - A null value. - - - - - An undefined value. - - - - - A date value. - - - - - A raw JSON value. - - - - - A collection of bytes value. - - - - - A Guid value. - - - - - A Uri value. - - - - - A TimeSpan value. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets the at the writer's current position. - - - - - Gets the token being written. - - The token being written. - - - - Initializes a new instance of the class writing to the given . - - The container being written to. - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the underlying . - - - - - Closes this writer. - If is set to true, the JSON is auto-completed. - - - Setting to true has no additional effect, since the underlying is a type that cannot be closed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end. - - The token. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes a value. - An error will be raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Represents a value in JSON (string, integer, date, etc). - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Creates a comment with the given value. - - The value. - A comment with the given value. - - - - Creates a string with the given value. - - The value. - A string with the given value. - - - - Creates a null value. - - A null value. - - - - Creates a undefined value. - - A undefined value. - - - - Gets the node type for this . - - The type. - - - - Gets or sets the underlying token value. - - The underlying token value. - - - - Writes this token to a . - - A into which this method will write. - A collection of s which will be used when writing the token. - - - - Indicates whether the current object is equal to another object of the same type. - - - true if the current object is equal to the parameter; otherwise, false. - - An object to compare with this object. - - - - Determines whether the specified is equal to the current . - - The to compare with the current . - - true if the specified is equal to the current ; otherwise, false. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Returns a that represents this instance. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format provider. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - The format provider. - - A that represents this instance. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: - Value - Meaning - Less than zero - This instance is less than . - Zero - This instance is equal to . - Greater than zero - This instance is greater than . - - - is not of the same type as this instance. - - - - - Specifies how line information is handled when loading JSON. - - - - - Ignore line information. - - - - - Load line information. - - - - - Specifies how JSON arrays are merged together. - - - - Concatenate arrays. - - - Union arrays, skipping items that already exist. - - - Replace all array items. - - - Merge array items together, matched by index. - - - - Specifies how null value properties are merged. - - - - - The content's null value properties will be ignored during merging. - - - - - The content's null value properties will be merged. - - - - - Specifies the member serialization options for the . - - - - - All public members are serialized by default. Members can be excluded using or . - This is the default member serialization mode. - - - - - Only members marked with or are serialized. - This member serialization mode can also be set by marking the class with . - - - - - All public and private fields are serialized. Members can be excluded using or . - This member serialization mode can also be set by marking the class with - and setting IgnoreSerializableAttribute on to false. - - - - - Specifies metadata property handling options for the . - - - - - Read metadata properties located at the start of a JSON object. - - - - - Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. - - - - - Do not try to read metadata properties. - - - - - Specifies missing member handling options for the . - - - - - Ignore a missing member and do not attempt to deserialize it. - - - - - Throw a when a missing member is encountered during deserialization. - - - - - Specifies null value handling options for the . - - - - - - - - - Include null values when serializing and deserializing objects. - - - - - Ignore null values when serializing and deserializing objects. - - - - - Specifies how object creation is handled by the . - - - - - Reuse existing objects, create new objects when needed. - - - - - Only reuse existing objects. - - - - - Always create new objects. - - - - - Specifies reference handling options for the . - Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . - - - - - - - - Do not preserve references when serializing types. - - - - - Preserve references when serializing into a JSON object structure. - - - - - Preserve references when serializing into a JSON array structure. - - - - - Preserve references when serializing. - - - - - Specifies reference loop handling options for the . - - - - - Throw a when a loop is encountered. - - - - - Ignore loop references and do not serialize. - - - - - Serialize loop references. - - - - - Indicating whether a property is required. - - - - - The property is not required. The default state. - - - - - The property must be defined in JSON but can be a null value. - - - - - The property must be defined in JSON and cannot be a null value. - - - - - The property is not required but it cannot be a null value. - - - - - - Contains the JSON schema extension methods. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - true if the specified is valid; otherwise, false. - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - When this method returns, contains any error messages generated while validating. - - true if the specified is valid; otherwise, false. - - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - The validation event handler. - - - - - An in-memory representation of a JSON Schema. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the id. - - - - - Gets or sets the title. - - - - - Gets or sets whether the object is required. - - - - - Gets or sets whether the object is read-only. - - - - - Gets or sets whether the object is visible to users. - - - - - Gets or sets whether the object is transient. - - - - - Gets or sets the description of the object. - - - - - Gets or sets the types of values allowed by the object. - - The type. - - - - Gets or sets the pattern. - - The pattern. - - - - Gets or sets the minimum length. - - The minimum length. - - - - Gets or sets the maximum length. - - The maximum length. - - - - Gets or sets a number that the value should be divisible by. - - A number that the value should be divisible by. - - - - Gets or sets the minimum. - - The minimum. - - - - Gets or sets the maximum. - - The maximum. - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). - - A flag indicating whether the value can not equal the number defined by the minimum attribute (). - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). - - A flag indicating whether the value can not equal the number defined by the maximum attribute (). - - - - Gets or sets the minimum number of items. - - The minimum number of items. - - - - Gets or sets the maximum number of items. - - The maximum number of items. - - - - Gets or sets the of items. - - The of items. - - - - Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . - - - true if items are validated using their array position; otherwise, false. - - - - - Gets or sets the of additional items. - - The of additional items. - - - - Gets or sets a value indicating whether additional items are allowed. - - - true if additional items are allowed; otherwise, false. - - - - - Gets or sets whether the array items must be unique. - - - - - Gets or sets the of properties. - - The of properties. - - - - Gets or sets the of additional properties. - - The of additional properties. - - - - Gets or sets the pattern properties. - - The pattern properties. - - - - Gets or sets a value indicating whether additional properties are allowed. - - - true if additional properties are allowed; otherwise, false. - - - - - Gets or sets the required property if this property is present. - - The required property if this property is present. - - - - Gets or sets the a collection of valid enum values allowed. - - A collection of valid enum values allowed. - - - - Gets or sets disallowed types. - - The disallowed types. - - - - Gets or sets the default value. - - The default value. - - - - Gets or sets the collection of that this schema extends. - - The collection of that this schema extends. - - - - Gets or sets the format. - - The format. - - - - Initializes a new instance of the class. - - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The object representing the JSON Schema. - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The to use when resolving schema references. - The object representing the JSON Schema. - - - - Load a from a string that contains JSON Schema. - - A that contains JSON Schema. - A populated from the string that contains JSON Schema. - - - - Load a from a string that contains JSON Schema using the specified . - - A that contains JSON Schema. - The resolver. - A populated from the string that contains JSON Schema. - - - - Writes this schema to a . - - A into which this method will write. - - - - Writes this schema to a using the specified . - - A into which this method will write. - The resolver used. - - - - Returns a that represents the current . - - - A that represents the current . - - - - - - Returns detailed information about the schema exception. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - - Generates a from a specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets how undefined schemas are handled by the serializer. - - - - - Gets or sets the contract resolver. - - The contract resolver. - - - - Generate a from the specified type. - - The type to generate a from. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - - Resolves from an id. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the loaded schemas. - - The loaded schemas. - - - - Initializes a new instance of the class. - - - - - Gets a for the specified reference. - - The id. - A for the specified reference. - - - - - The value types allowed by the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - No type specified. - - - - - String type. - - - - - Float type. - - - - - Integer type. - - - - - Boolean type. - - - - - Object type. - - - - - Array type. - - - - - Null type. - - - - - Any type. - - - - - - Specifies undefined schema Id handling options for the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Do not infer a schema Id. - - - - - Use the .NET type name as the schema Id. - - - - - Use the assembly qualified .NET type name as the schema Id. - - - - - - Returns detailed information related to the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the associated with the validation error. - - The JsonSchemaException associated with the validation error. - - - - Gets the path of the JSON location where the validation error occurred. - - The path of the JSON location where the validation error occurred. - - - - Gets the text description corresponding to the validation error. - - The text description. - - - - - Represents the callback method that will handle JSON schema validation events and the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - A camel case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Resolves member mappings for a type, camel casing property names. - - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used by to resolve a for a given . - - - - - Gets a value indicating whether members are being get and set using dynamic code generation. - This value is determined by the runtime permissions available. - - - true if using dynamic code generation; otherwise, false. - - - - - Gets or sets the default members search flags. - - The default members search flags. - - - - Gets or sets a value indicating whether compiler generated members should be serialized. - - - true if serialized compiler generated members; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. - - - true if the interface will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. - - - true if the attribute will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. - - - true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. - - - true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. - - The naming strategy used to resolve how property names and dictionary keys are serialized. - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Gets the serializable members for the type. - - The type to get serializable members for. - The serializable members for the type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates the constructor parameters. - - The constructor to create properties for. - The type's member properties. - Properties for the given . - - - - Creates a for the given . - - The matching member property. - The constructor parameter. - A created for the given . - - - - Resolves the default for the contract. - - Type of the object. - The contract's default . - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Determines which contract type is created for the given type. - - Type of the object. - A for the given type. - - - - Creates properties for the given . - - The type to create properties for. - /// The member serialization mode for the type. - Properties for the given . - - - - Creates the used by the serializer to get and set values from a member. - - The member. - The used by the serializer to get and set values from a member. - - - - Creates a for the given . - - The member's parent . - The member to create a for. - A created for the given . - - - - Resolves the name of the property. - - Name of the property. - Resolved name of the property. - - - - Resolves the name of the extension data. By default no changes are made to extension data names. - - Name of the extension data. - Resolved name of the extension data. - - - - Resolves the key of the dictionary. By default is used to resolve dictionary keys. - - Key of the dictionary. - Resolved key of the dictionary. - - - - Gets the resolved name of the property. - - Name of the property. - Name of the property. - - - - The default naming strategy. Property names and dictionary keys are unchanged. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - The default serialization binder used when resolving and loading classes from type names. - - - - - Initializes a new instance of the class. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - The type of the object the formatter creates a new instance of. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer that writes to the application's instances. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides information surrounding an error. - - - - - Gets the error. - - The error. - - - - Gets the original object that caused the error. - - The original object that caused the error. - - - - Gets the member that caused the error. - - The member that caused the error. - - - - Gets the path of the JSON location where the error occurred. - - The path of the JSON location where the error occurred. - - - - Gets or sets a value indicating whether this is handled. - - true if handled; otherwise, false. - - - - Provides data for the Error event. - - - - - Gets the current object the error event is being raised against. - - The current object the error event is being raised against. - - - - Gets the error context. - - The error context. - - - - Initializes a new instance of the class. - - The current object. - The error context. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides methods to get attributes. - - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Used by to resolve a for a given . - - - - - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used to resolve references when serializing and deserializing JSON by the . - - - - - Resolves a reference to its object. - - The serialization context. - The reference to resolve. - The object that was resolved from the reference. - - - - Gets the reference for the specified object. - - The serialization context. - The object to get a reference for. - The reference to the object. - - - - Determines whether the specified object is referenced. - - The serialization context. - The object to test for a reference. - - true if the specified object is referenced; otherwise, false. - - - - - Adds a reference to the specified object. - - The serialization context. - The reference. - The object to reference. - - - - Allows users to control class loading and mandate what class to load. - - - - - When implemented, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object - The type of the object the formatter creates a new instance of. - - - - When implemented, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - The that will be used to filter the trace messages passed to the writer. - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Provides methods to get and set values. - - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Contract details for a used by the . - - - - - Gets the of the collection items. - - The of the collection items. - - - - Gets a value indicating whether the collection type is a multidimensional array. - - true if the collection type is a multidimensional array; otherwise, false. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the collection values. - - true if the creator has a parameter with the collection values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the default collection items . - - The converter. - - - - Gets or sets a value indicating whether the collection items preserve object references. - - true if collection items preserve object references; otherwise, false. - - - - Gets or sets the collection item reference loop handling. - - The reference loop handling. - - - - Gets or sets the collection item type name handling. - - The type name handling. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Handles serialization callback events. - - The object that raised the callback event. - The streaming context. - - - - Handles serialization error callback events. - - The object that raised the callback event. - The streaming context. - The error context. - - - - Sets extension data for an object during deserialization. - - The object to set extension data on. - The extension data key. - The extension data value. - - - - Gets extension data for an object during serialization. - - The object to set extension data on. - - - - Contract details for a used by the . - - - - - Gets the underlying type for the contract. - - The underlying type for the contract. - - - - Gets or sets the type created during deserialization. - - The type created during deserialization. - - - - Gets or sets whether this type contract is serialized as a reference. - - Whether this type contract is serialized as a reference. - - - - Gets or sets the default for this contract. - - The converter. - - - - Gets the internally resolved for the contract's type. - This converter is used as a fallback converter when no other converter is resolved. - Setting will always override this converter. - - - - - Gets or sets all methods called immediately after deserialization of the object. - - The methods called immediately after deserialization of the object. - - - - Gets or sets all methods called during deserialization of the object. - - The methods called during deserialization of the object. - - - - Gets or sets all methods called after serialization of the object graph. - - The methods called after serialization of the object graph. - - - - Gets or sets all methods called before serialization of the object. - - The methods called before serialization of the object. - - - - Gets or sets all method called when an error is thrown during the serialization of the object. - - The methods called when an error is thrown during the serialization of the object. - - - - Gets or sets the default creator method used to create the object. - - The default creator method used to create the object. - - - - Gets or sets a value indicating whether the default creator is non-public. - - true if the default object creator is non-public; otherwise, false. - - - - Contract details for a used by the . - - - - - Gets or sets the dictionary key resolver. - - The dictionary key resolver. - - - - Gets the of the dictionary keys. - - The of the dictionary keys. - - - - Gets the of the dictionary values. - - The of the dictionary values. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the dictionary values. - - true if the creator has a parameter with the dictionary values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets the object's properties. - - The object's properties. - - - - Gets or sets the property name resolver. - - The property name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object constructor. - - The object constructor. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object member serialization. - - The member object serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets the object's properties. - - The object's properties. - - - - Gets a collection of instances that define the parameters used with . - - - - - Gets or sets the function used to create the object. When set this function will override . - This function is called with a collection of arguments which are defined by the collection. - - The function used to create the object. - - - - Gets or sets the extension data setter. - - - - - Gets or sets the extension data getter. - - - - - Gets or sets the extension data value type. - - - - - Gets or sets the extension data name resolver. - - The extension data name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Maps a JSON property to a .NET member or constructor parameter. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the type that declared this property. - - The type that declared this property. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets the name of the underlying member or parameter. - - The name of the underlying member or parameter. - - - - Gets the that will get and set the during serialization. - - The that will get and set the during serialization. - - - - Gets or sets the for this property. - - The for this property. - - - - Gets or sets the type of the property. - - The type of the property. - - - - Gets or sets the for the property. - If set this converter takes precedence over the contract converter for the property type. - - The converter. - - - - Gets or sets the member converter. - - The member converter. - - - - Gets or sets a value indicating whether this is ignored. - - true if ignored; otherwise, false. - - - - Gets or sets a value indicating whether this is readable. - - true if readable; otherwise, false. - - - - Gets or sets a value indicating whether this is writable. - - true if writable; otherwise, false. - - - - Gets or sets a value indicating whether this has a member attribute. - - true if has a member attribute; otherwise, false. - - - - Gets the default value. - - The default value. - - - - Gets or sets a value indicating whether this is required. - - A value indicating whether this is required. - - - - Gets a value indicating whether has a value specified. - - - - - Gets or sets a value indicating whether this property preserves object references. - - - true if this instance is reference; otherwise, false. - - - - - Gets or sets the property null value handling. - - The null value handling. - - - - Gets or sets the property default value handling. - - The default value handling. - - - - Gets or sets the property reference loop handling. - - The reference loop handling. - - - - Gets or sets the property object creation handling. - - The object creation handling. - - - - Gets or sets or sets the type name handling. - - The type name handling. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets a predicate used to determine whether the property should be deserialized. - - A predicate used to determine whether the property should be deserialized. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets an action used to set whether the property has been deserialized. - - An action used to set whether the property has been deserialized. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Gets or sets the converter used when serializing the property's collection items. - - The collection's items converter. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - A collection of objects. - - - - - Initializes a new instance of the class. - - The type. - - - - When implemented in a derived class, extracts the key from the specified element. - - The element from which to extract the key. - The key for the specified element. - - - - Adds a object. - - The property to add to the collection. - - - - Gets the closest matching object. - First attempts to get an exact case match of and then - a case insensitive match. - - Name of the property. - A matching property if found. - - - - Gets a property by property name. - - The name of the property to get. - Type property name string comparison. - A matching property if found. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Lookup and create an instance of the type described by the argument. - - The type to create. - Optional arguments to pass to an initializing constructor of the JsonConverter. - If null, the default constructor is used. - - - - A kebab case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Represents a trace writer that writes to memory. When the trace message limit is - reached then old trace messages will be removed as new messages are added. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Initializes a new instance of the class. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Returns an enumeration of the most recent trace messages. - - An enumeration of the most recent trace messages. - - - - Returns a of the most recent trace messages. - - - A of the most recent trace messages. - - - - - A base class for resolving how property names and dictionary keys are serialized. - - - - - A flag indicating whether dictionary keys should be processed. - Defaults to false. - - - - - A flag indicating whether extension data names should be processed. - Defaults to false. - - - - - A flag indicating whether explicitly specified property names, - e.g. a property name customized with a , should be processed. - Defaults to false. - - - - - Gets the serialized name for a given property name. - - The initial property name. - A flag indicating whether the property has had a name explicitly specified. - The serialized property name. - - - - Gets the serialized name for a given extension data name. - - The initial extension data name. - The serialized extension data name. - - - - Gets the serialized key for a given dictionary key. - - The initial dictionary key. - The serialized dictionary key. - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Hash code calculation - - - - - - Object equality implementation - - - - - - - Compare to another NamingStrategy - - - - - - - Represents a method that constructs an object. - - The object type to create. - - - - When applied to a method, specifies that the method is called when an error occurs serializing an object. - - - - - Provides methods to get attributes from a , , or . - - - - - Initializes a new instance of the class. - - The instance to get attributes for. This parameter should be a , , or . - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Get and set values for a using reflection. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - A snake case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Specifies how strings are escaped when writing JSON text. - - - - - Only control characters (e.g. newline) are escaped. - - - - - All non-ASCII and control characters (e.g. newline) are escaped. - - - - - HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. - - - - - Indicates the method that will be used during deserialization for locating and loading assemblies. - - - - - In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. - - - - - In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. - - - - - Specifies type name handling options for the . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Do not include the .NET type name when serializing types. - - - - - Include the .NET type name when serializing into a JSON object structure. - - - - - Include the .NET type name when serializing into a JSON array structure. - - - - - Always include the .NET type name when serializing. - - - - - Include the .NET type name when the type of the object being serialized is not the same as its declared type. - Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON - you must specify a root type object with - or . - - - - - Determines whether the collection is null or empty. - - The collection. - - true if the collection is null or empty; otherwise, false. - - - - - Adds the elements of the specified collection to the specified generic . - - The list to add to. - The collection of elements to add. - - - - Converts the value to the specified type. If the value is unable to be converted, the - value is checked whether it assignable to the specified type. - - The value to convert. - The culture to use when converting. - The type to convert or cast the value to. - - The converted type. If conversion was unsuccessful, the initial value - is returned if assignable to the target type. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic that returns a result - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Returns a Restrictions object which includes our current restrictions merged - with a restriction limiting our type - - - - - Helper class for serializing immutable collections. - Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed - https://github.com/JamesNK/Newtonsoft.Json/issues/652 - - - - - Gets the type of the typed collection's items. - - The type. - The type of the typed collection's items. - - - - Gets the member's underlying type. - - The member. - The underlying type of the member. - - - - Determines whether the property is an indexed property. - - The property. - - true if the property is an indexed property; otherwise, false. - - - - - Gets the member's value on the object. - - The member. - The target object. - The member's value on the object. - - - - Sets the member's value on the target object. - - The member. - The target. - The value. - - - - Determines whether the specified MemberInfo can be read. - - The MemberInfo to determine whether can be read. - /// if set to true then allow the member to be gotten non-publicly. - - true if the specified MemberInfo can be read; otherwise, false. - - - - - Determines whether the specified MemberInfo can be set. - - The MemberInfo to determine whether can be set. - if set to true then allow the member to be set non-publicly. - if set to true then allow the member to be set if read-only. - - true if the specified MemberInfo can be set; otherwise, false. - - - - - Builds a string. Unlike this class lets you reuse its internal buffer. - - - - - Determines whether the string is all white space. Empty string will return false. - - The string to test whether it is all white space. - - true if the string is all white space; otherwise, false. - - - - - Specifies the state of the . - - - - - An exception has been thrown, which has left the in an invalid state. - You may call the method to put the in the Closed state. - Any other method calls result in an being thrown. - - - - - The method has been called. - - - - - An object is being written. - - - - - An array is being written. - - - - - A constructor is being written. - - - - - A property is being written. - - - - - A write method has not been called. - - - - Specifies that an output will not be null even if the corresponding type allows it. - - - Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. - - - Initializes the attribute with the specified return value condition. - - The return value condition. If the method returns this value, the associated parameter will not be null. - - - - Gets the return value condition. - - - Specifies that an output may be null even if the corresponding type disallows it. - - - Specifies that null is allowed as an input even if the corresponding type disallows it. - - - - Specifies that the method will not return if the associated Boolean parameter is passed the specified value. - - - - - Initializes a new instance of the class. - - - The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to - the associated parameter matches this value. - - - - Gets the condition parameter value. - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Client.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Client.dll deleted file mode 100644 index b260be5..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Client.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Client.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Client.xml deleted file mode 100644 index d48ba9d..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Client.xml +++ /dev/null @@ -1,5130 +0,0 @@ - - - - Opc.Ua.Client - - - - - Stores the options to use for a browse operation. - - - - - Creates an unattached instance of a browser. - - - - - Creates new instance of a browser and attaches it to a session. - - - - - Creates a copy of a browser. - - - - - Sets all private fields to default values. - - - - - The session that the browse is attached to. - - - - - The view to use for the browse operation. - - - - - The maximum number of refrences to return in a single browse operation. - - - - - The direction to browse. - - - - - The reference type to follow. - - - - - Whether subtypes of the reference type should be included. - - - - - The classes of the target nodes. - - - - - The results to return. - - - - - Raised when a browse operation halted because of a continuation point. - - - - - Whether subsequent continuation points should be processed automatically. - - - - - Browses the specified node. - - - - - Checks the state of the browser. - - - - - Fetches the next batch of references. - - The continuation point. - if set to true the browse operation is cancelled. - The next batch of references - - - - The event arguments provided a browse operation returns a continuation point. - - - - - Creates a new instance. - - - - - Whether the browse operation should be cancelled. - - - - - Whether subsequent continuation points should be processed automatically. - - - - - The references that have been fetched so far. - - - - - A delegate used to received browser events. - - - - - Defines numerous re-useable utility functions for clients. - - - EventSource for client. - - - - - The default discover operation timeout. - - - - - Discovers the servers on the local machine. - - The configuration. - A list of server urls. - - - - Discovers the servers on the local machine. - - The configuration. - Operation timeout in milliseconds. - A list of server urls. - - - - Finds the endpoint that best matches the current settings. - - The discovery URL. - if set to true select an endpoint that uses security. - The best available endpoint. - - - - Finds the endpoint that best matches the current settings. - - The discovery URL. - if set to true select an endpoint that uses security. - Operation timeout in milliseconds. - The best available endpoint. - - - - Finds the endpoint that best matches the current settings. - - - - - Finds the endpoint that best matches the current settings. - - - - - Finds the endpoint that best matches the current settings. - - The application configuration. - The discovery URL. - if set to true select an endpoint that uses security. - The best available endpoint. - - - - Finds the endpoint that best matches the current settings. - - The application configuration. - The discovery URL. - if set to true select an endpoint that uses security. - The timeout for the discover operation. - The best available endpoint. - - - - Select the best supported endpoint from an - EndpointDescriptionCollection, with or without security. - - - - - - - - Convert the discoveryUrl to a Uri and modify endpoint as per connection scheme if required. - - - - - The EventSource log interface. - - - - - A class that holds the configuration for a UA service. - - - - - The default constructor. - - - - - Sets private members to default values. - - - - - The node id for the dictionary. - - - - - The display name for the dictionary. - - - - - The node id for the type system. - - - - - The display name for the type system. - - - - - The type dictionary. - - - - - The data type dictionary DataTypes - - - - - Loads the dictionary identified by the node id. - - - - - Loads the dictionary identified by the node id. - - - - - Returns true if the dictionary contains the data type description; - - - - - Returns the schema for the specified type (returns the entire dictionary if null). - - - - - Retrieves the type system for the dictionary. - - - - - Retrieves the data types in the dictionary. - - - In order to allow for fast Linq matching of dictionary - QNames with the data type nodes, the BrowseName of - the DataType node is replaced with Value string. - - - - - Reads the contents of multiple data dictionaries. - - - - - Reads the contents of a data dictionary. - - - - - Validates the type dictionary. - - The encoded dictionary to validate. - Throw if an error occurred. - - - - Validates the type dictionary. - - The encoded dictionary to validate. - A table of imported namespace schemas. - Throw if an error occurred. - - - - Object that creates instances of an Opc.Ua.Client.Session object. - - - - - The default instance of the factory. - - - - - Force use of the default instance. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The Opc.Ua.Client namespace defines classes which can be used to implement a UA client. - These classes manage client side state information, provide higher level abstractions for UA - tasks such as managing sessions/subscriptions and saving/restoring connection information for - later use. - - - - - - A client side cache of the server's type model. - - - - - Loads the UA defined types into the cache. - - The context. - - - - Removes all nodes from the cache. - - - - - Fetches a node from the server and updates the cache. - - - - - Finds a set of nodes in the nodeset, - fetches missing nodes from server. - - The node identifier collection. - - - - Fetches a node collection from the server and updates the cache. - - - - - Adds the supertypes of the node to the cache. - - - - - Returns the references of the specified node that meet the criteria specified. - - - - - Returns the references of the specified nodes that meet the criteria specified. - - - - - Returns a display name for a node. - - - - - Returns a display name for a node. - - - - - Returns a display name for the target of a reference. - - - - - Builds the relative path from a type to a node. - - - - - Used to handle renews of user identity tokens before reconnect. - - - - - The delegate used to receive keep alive notifications. - - - - - The delegate used to receive publish notifications. - - - - - The delegate used to receive pubish error notifications. - - - - - The delegate used to modify publish response sequence numbers to acknowledge. - - - - - Manages a session with a server. - - - - - Raised when a keep alive arrives from the server or an error is detected. - - - Once a session is created a timer will periodically read the server state and current time. - If this read operation succeeds this event will be raised each time the keep alive period elapses. - If an error is detected (KeepAliveStopped == true) then this event will be raised as well. - - - - - Raised when a notification message arrives in a publish response. - - - All publish requests are managed by the Session object. When a response arrives it is - validated and passed to the appropriate Subscription object and this event is raised. - - - - - Raised when an exception occurs while processing a publish response. - - - Exceptions in a publish response are not necessarily fatal and the Session will - attempt to recover by issuing Republish requests if missing messages are detected. - That said, timeout errors may be a symptom of a OperationTimeout that is too short - when compared to the shortest PublishingInterval/KeepAliveCount amount the current - Subscriptions. The OperationTimeout should be twice the minimum value for - PublishingInterval*KeepAliveCount. - - - - - Raised when a publish request is about to acknolegde sequence numbers. - - - If the client chose to defer acknowledge of sequenece numbers, it is responsible - to transfer these to the deferred list. - - - - - Raised when a subscription is added or removed - - - - - Raised to indicate the session is closing. - - - - - Raised to indicate the session configuration changed. - - - An example for a session configuration change is a new user identity, - a new server nonce, a new locale etc. - - - - - The factory which was used to create the session. - - - - - Gets the endpoint used to connect to the server. - - - - - Gets the name assigned to the session. - - - - - Gets the period for wich the server will maintain the session if there is no communication from the client. - - - - - Gets the local handle assigned to the session. - - - - - Gets the user identity currently used for the session. - - - - - Gets a list of user identities that can be used to connect to the server. - - - - - Gets the table of namespace uris known to the server. - - - - - Gest the table of remote server uris known to the server. - - - - - Gets the system context for use with the session. - - - - - Gets the factory used to create encodeable objects that the server understands. - - - - - Gets the cache of the server's type tree. - - - - - Gets the cache of nodes fetched from the server. - - - - - Gets the context to use for filter operations. - - - - - Gets the locales that the server should use when returning localized text. - - - - - Gets the data type system dictionaries in use. - - - - - Gets the subscriptions owned by the session. - - - - - Gets the number of subscriptions owned by the session. - - - - - If the subscriptions are deleted when a session is closed. - - - - - Gets or Sets the default subscription for the session. - - - - - Gets or Sets how frequently the server is pinged to see if communication is still working. - - - This interval controls how much time elaspes before a communication error is detected. - If everything is ok the KeepAlive event will be raised each time this period elapses. - - - - - Returns true if the session is not receiving keep alives. - - - Set to true if the server does not respond for 2 times the KeepAliveInterval. - Set to false is communication recovers. - - - - - Gets the time of the last keep alive. - - - - - Gets the number of outstanding publish or keep alive requests. - - - - - Gets the number of outstanding publish or keep alive requests which appear to be missing. - - - - - Gets the number of good outstanding publish requests. - - - - - Gets and sets the minimum number of publish requests to be used in the session. - - - - - Stores the operation limits of a OPC UA Server. - - - - - If the subscriptions are transferred when a session is reconnected. - - - Default false, set to true if subscriptions should - be transferred after reconnect. Service must be supported by server. - - - - - Whether the endpoint Url domain is checked in the certificate. - - - - - Raised before a reconnect operation completes. - - - - - Reconnects to the server after a network failure. - - - - - Reconnects to the server after a network failure using a waiting connection. - - - - - Reconnects to the server using a new channel. - - - - - Saves all the subscriptions of the session. - - The file path. - - - - Saves a set of subscriptions to a stream. - - - - - Saves a set of subscriptions to a file. - - - - - Load the list of subscriptions saved in a stream. - - The stream. - Load the subscriptions for transfer after load. - The list of loaded subscriptions - - - - Load the list of subscriptions saved in a file. - - The file path. - Load the subscriptions for transfer after load. - The list of loaded subscriptions - - - - Returns the active session configuration and writes it to a stream. - - - - - Applies a session configuration. - Using a secure channel, with the session configuration a session can be reconnected. - - - - - Updates the local copy of the server's namespace uri and server uri tables. - - - - - Updates the cache with the type and its subtypes. - - - This method can be used to ensure the TypeTree is populated. - - - - - Updates the cache with the types and its subtypes. - - - This method can be used to ensure the TypeTree is populated. - - - - - Returns the available encodings for a node - - The variable node. - - - - Returns the data description for the encoding. - - The encoding Id. - - - - Returns the data dictionary that contains the description. - - The description id. - - - - Returns the data dictionary that contains the description. - - The dictionary id. - - The dictionary. - - - - Loads all dictionaries of the OPC binary or Xml schema type system. - - The type system. - - - - Reads the values for the node attributes and returns a node object. - - The nodeId. - - - - Reads the values for the node attributes and returns a node object. - - - If the nodeclass is known, only the supported attribute values are read. - - The nodeId. - The nodeclass of the node to read. - Read optional attributes. - - - - Reads the values for the node attributes and returns a node object. - Reads the nodeclass of the nodeIds, then reads - the values for the node attributes and returns a node object collection. - - The nodeId collection. - The node collection read from the server. - The errors occured reading the nodes. - Set to true if optional attributes should not be omitted. - - - - Reads the values for the node attributes and returns a node object collection. - - - If the nodeclass for the nodes in nodeIdCollection is already known, - and passed as nodeClass, reads only values of required attributes. - Otherwise NodeClass.Unspecified should be used. - - The nodeId collection to read. - The nodeClass of all nodes in the collection. Set to NodeClass.Unspecified if the nodeclass is unknown. - The node collection that is created from attributes read from the server. - The errors that occured reading the nodes. - Set to true if optional attributes should not be omitted. - - - - Reads the value for a node. - - The node Id. - - - - Reads the value for a node an checks that it is the specified type. - - The node id. - The expected type. - - - - Reads the values for a node collection. Returns diagnostic errors. - - The node Id. - The data values read from the server. - The errors reported by the server. - - - - Fetches all references for the specified node. - - The node id. - - - - Fetches all references for the specified nodes. - - The node id collection. - A list of reference collections. - The errors reported by the server. - - - - Establishes a session with the server. - - The name to assign to the session. - The user identity. - - - - Establishes a session with the server. - - The name to assign to the session. - The session timeout. - The user identity. - The list of preferred locales. - - - - Establishes a session with the server. - - The name to assign to the session. - The session timeout. - The user identity. - The list of preferred locales. - If set to true then the domain in the certificate must match the endpoint used. - - - - Updates the preferred locales used for the session. - - The preferred locales. - - - - Updates the user identity and/or locales used for the session. - - The user identity. - The preferred locales. - - - - Finds the NodeIds for the components for an instance. - - - - - Reads the values for a set of variables. - - The variable ids. - The expected types. - The list of returned values. - The list of returned errors. - - - - Reads the display name for a set of Nodes. - - - - - Reads the values for the node attributes and returns a node object collection. - - - If the nodeclass for the nodes in nodeIdCollection is already known - and passed as nodeClass, reads only values of required attributes. - Otherwise NodeClass.Unspecified should be used. - - The nodeId collection to read. - The nodeClass of all nodes in the collection. Set to NodeClass.Unspecified if the nodeclass is unknown. - Set to true if optional attributes should not be omitted. - The cancellation token. - The node collection and associated errors. - - - - Reads the value for a node. - - The node Id. - The cancellation token for the request. - - - - Reads the values for the node attributes and returns a node object. - - The nodeId. - The cancellation token for the request. - - - - Reads the values for the node attributes and returns a node object. - - - If the nodeclass is known, only the supported attribute values are read. - - The nodeId. - The nodeclass of the node to read. - Read optional attributes. - The cancellation token for the request. - - - - Reads the values for the node attributes and returns a node object collection. - Reads the nodeclass of the nodeIds, then reads - the values for the node attributes and returns a node collection. - - The nodeId collection. - If optional attributes to read. - The cancellation token. - - - - Reads the values for a node collection. Returns diagnostic errors. - - The node Id. - The cancellation token for the request. - - - - Disconnects from the server and frees any network resources with the specified timeout. - - - - - Close the session with the server and optionally closes the channel. - - - - - Disconnects from the server and frees any network resources with the specified timeout. - - - - - Disconnects from the server and frees any network resources with the default timeout. - - - - - Close the session with the server and optionally closes the channel. - - - - - Disconnects from the server and frees any network resources with the specified timeout. - - - - - Disconnects from the server and frees any network resources with the specified timeout. - - - - - Adds a subscription to the session. - - The subscription to add. - - - - Removes a subscription from the session. - - The subscription to remove. - - - - Removes a list of subscriptions from the session. - - The list of subscriptions to remove. - - - - Reactivates a list of subscriptions loaded from storage. - - The list of subscriptions to reactivate. - Send the last value of each monitored item in the subscriptions. - - - - Transfers a list of subscriptions from another session. - - The list of subscriptions to transfer. - Send the last value of each monitored item in the subscriptions. - - - - Removes a transferred subscription from the session. - Called by the session to which the subscription - is transferred to obtain ownership. Internal. - - The subscription to remove. - - - - Removes a subscription from the session. - - The subscription to remove. - The cancellation token for the request. - - - - Removes a list of subscriptions from the session. - - The list of subscriptions to remove. - The cancellation token for the request. - - - - Reactivates a list of subscriptions loaded from storage. - - The list of subscriptions to reactivate. - Send the last value of each monitored item in the subscriptions. - The cancellation token for the request. - - - - Transfers a list of subscriptions from another session. - - The list of subscriptions to transfer. - Send the last value of each monitored item in the subscriptions. - The cancellation token for the request. - - - - Invokes the Browse service. - - The request header. - The view to browse. - The node to browse. - The maximum number of returned values. - The browse direction. - The reference type id. - If set to true the subtypes of the ReferenceType will be included in the browse. - The node class mask. - The continuation point. - The list of node references. - - - - Begins an asynchronous invocation of the Browse service. - - The request header. - The view to browse. - The node to browse. - The maximum number of returned values.. - The browse direction. - The reference type id. - If set to true the subtypes of the ReferenceType will be included in the browse. - The node class mask. - The callback. - - - - - Finishes an asynchronous invocation of the Browse service. - - The result. - The continuation point. - The list of node references. - - - - Invokes the BrowseNext service. - - - - - Begins an asynchronous invocation of the BrowseNext service. - - - - - Finishes an asynchronous invocation of the BrowseNext service. - - - - - Calls the specified method and returns the output arguments. - - The NodeId of the object that provides the method. - The NodeId of the method to call. - The input arguments. - The list of output argument values. - - - - Calls the specified method and returns the output arguments. - - The NodeId of the object that provides the method. - The NodeId of the method to call. - The cancellation token for the request. - The input arguments. - The list of output argument values. - - - - Sends an additional publish request. - - - - - Sends a republish request. - - - - - Call the ResendData method on the server for all subscriptions. - - - - - Call the ResendData method on the server for all subscriptions. - - - - - Object that creates instances of an ISessions object. - - - - - Creates a new communication session with a server by invoking the CreateSession service - - The configuration for the client application. - The endpoint for the server. - If set to true the discovery endpoint is used to update the endpoint description before connecting. - The name to assign to the session. - The timeout period for the session. - The identity. - The user identity to associate with the session. - The cancellation token - The new session object - - - - Creates a new communication session with a server by invoking the CreateSession service - - The configuration for the client application. - The endpoint for the server. - If set to true the discovery endpoint is used to update the endpoint description before connecting. - If set to true then the domain in the certificate must match the endpoint used. - The name to assign to the session. - The timeout period for the session. - The user identity to associate with the session. - The preferred locales. - The cancellation token - The new session object. - - - - Creates a new session with a server using the specified channel by invoking the CreateSession service. - - The configuration for the client application. - The channel for the server. - The endpoint for the server. - The certificate to use for the client. - The list of available endpoints returned by server in GetEndpoints() response. - The value of profileUris used in GetEndpoints() request. - - - - Creates a secure channel to the specified endpoint. - - The application configuration. - The client endpoint for the reverse connect. - A configured endpoint to connect to. - Update configuration based on server prior connect. - Check that the certificate specifies a valid domain (computer) name. - The cancellation token. - A representing the asynchronous operation. - - - - Creates a new communication session with a server using a reverse connection. - - The configuration for the client application. - The client endpoint for the reverse connect. - The endpoint for the server. - If set to true the discovery endpoint is used to update the endpoint description before connecting. - If set to true then the domain in the certificate must match the endpoint used. - The name to assign to the session. - The timeout period for the session. - The user identity to associate with the session. - The preferred locales. - The cancellation token - The new session object. - - - - Creates a new communication session with a server using a reverse connect manager. - - The configuration for the client application. - The reverse connect manager for the client connection. - The endpoint for the server. - If set to true the discovery endpoint is used to update the endpoint description before connecting. - If set to true then the domain in the certificate must match the endpoint used. - The name to assign to the session. - The timeout period for the session. - The user identity to associate with the session. - The preferred locales. - The cancellation token. - The new session object. - - - - Recreates a session based on a specified template. - - The ISession object to use as template - The cancellation token. - The new session object. - - - - Recreates a session based on a specified template. - - The ISession object to use as template - The waiting reverse connection. - The cancellation token. - The new session object. - - - - Recreates a session based on a specified template using the provided channel. - - The Session object to use as template - The channel to use to recreate the session. - The cancellation token. - The new session object. - - - - A monitored item. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The client handle. The caller must ensure it uniquely identifies the monitored item. - - - - Initializes a new instance of the class. - - The template used to specify the monitoring parameters. - - - - Initializes a new instance of the class. - - The template used to specify the monitoring parameters. - if set to true the event handlers are copied. - - - - Initializes a new instance of the class. - - The template used to specify the monitoring parameters. - if set to true the event handlers are copied. - if set to true the clientHandle is of the template copied. - - - - Called by the .NET framework during deserialization. - - - - - Sets the private members to default values. - - - - - A display name for the monitored item. - - - - - The start node for the browse path that identifies the node to monitor. - - - - - The relative path from the browse path to the node to monitor. - - - A null or empty string specifies that the start node id should be monitored. - - - - - The node class of the node being monitored (affects the type of filter available). - - - - - The attribute to monitor. - - - - - The range of array indexes to monitor. - - - - - The encoding to use when returning notifications. - - - - - The monitoring mode. - - - - - The sampling interval. - - - - - The filter to use to select values to return. - - - - - The length of the queue used to buffer values. - - - - - Whether to discard the oldest entries in the queue when it is full. - - - - - Server-assigned id for the MonitoredItem. - - - - - The subscription that owns the monitored item. - - - - - A local handle assigned to the monitored item. - - - - - Whether the item has been created on the server. - - - - - The identifier assigned by the client. - - - - - The node id to monitor after applying any relative path. - - - - - Whether the monitoring attributes have been modified since the item was created. - - - - - The status associated with the monitored item. - - - - - Returns the queue size used by the cache. - - - - - The last value or event received from the server. - - - - - Read all values in the cache queue. - - - - - Read all events in the cache queue. - - - - - The last message containing a notification for the item. - - - - - Raised when a new notification arrives. - - - - - Reset the notification event handler. - - - - - Saves a data change or event in the cache. - - - - - - - - Creates a deep copy of the object. - - - - - Sets the error status for the monitored item. - - - - - Updates the object with the results of a translate browse path request. - - - - - Updates the object with the results of a create monitored item request. - - - - - Updates the object with the results of a modify monitored item request. - - - - - Updates the object with the results of a transfer subscription request. - - - - - Updates the object with the results of a delete monitored item request. - - - - - Returns the field name the specified SelectClause in the EventFilter. - - - - - Returns value of the field name containing the event type. - - - - - Returns value of the field name containing the event type. - - - - - Returns value of the field name containing the event type. - - - - - Returns value of the field name containing the event type. - - - - - Returns value of the field name containing the event type. - - - - - The service result for a data change notification. - - - - - The service result for a field in an notification (the field must contain a Status object). - - - - - Throws an exception if the flter cannot be used with the node class. - - - - - Sets the default event filter. - - - - - The event arguments provided when a new notification message arrives. - - - - - Creates a new instance. - - - - - The new notification. - - - - - The delegate used to receive monitored item value notifications. - - - - - An item in the cache - - - - - Constructs a cache for a monitored item. - - - - - The size of the queue to maintain. - - - - - The last value received from the server. - - - - - Returns all values in the queue. - - - - - Saves a notification in the cache. - - - - - Changes the queue size. - - - - - Saves the events received from the srever. - - - - - Constructs a cache for a monitored item. - - - - - The size of the queue to maintain. - - - - - The last event received. - - - - - Returns all events in the queue. - - - - - Saves a notification in the cache. - - - - - Changes the queue size. - - - - - The current status of monitored item. - - - - - Creates a empty object. - - - - - The identifier assigned by the server. - - - - - Whether the item has been created on the server. - - - - - Any error condition associated with the monitored item. - - - - - The node id being monitored. - - - - - The attribute being monitored. - - - - - The range of array indexes to being monitored. - - - - - The encoding to use when returning notifications. - - - - - The monitoring mode. - - - - - The identifier assigned by the client. - - - - - The sampling interval. - - - - - The filter to use to select values to return. - - - - - The result of applying the filter - - - - - The length of the queue used to buffer values. - - - - - Whether to discard the oldest entries in the queue when it is full. - - - - - Updates the monitoring mode. - - - - - Updates the object with the results of a translate browse paths request. - - - - - Updates the object with the results of a create monitored item request. - - - - - Updates the object with the results of a transfer monitored item request. - - - - - Updates the object with the results of a modify monitored item request. - - - - - Updates the object with the results of a delete item request. - - - - - Sets the error state for the monitored item status. - - - - - An implementation of a client side nodecache. - - - - - Initializes the object with default values. - - - - - Destructor to clean up. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Event source for high performance logging. - - - - - The client messages. - - - - - The Client Event Ids used for event messages, when calling ILogger. - - - - - The state of the client subscription. - - - - - The notification message. Called internally to convert wrapped value. - - - - - A notification received in Publish complete. - - - - - A Publish begin received. - - - - - A Publish complete received. - - - - - Log a Notification. - - - - - The implementation of a reverse connect client manager. - - - This reverse connect manager allows to register for reverse connections - with various strategies: - i) take any connection. - ii) filter for a specific application Uri and Url scheme. - iii) filter for the Url. - Second, any filter can be combined with the Once or Always flag. - - - - - A default value for reverse hello configurations, if undefined. - - - This value is used as wait timeout if the value is undefined by a caller. - - - - - Internal state of the reverse connect manager. - - - - - Internal state of the reverse connect host. - - - - - Specify the strategy for the reverse connect registration. - - - - - Undefined strategy, defaults to Once. - - - - - Remove entry after reverse connect callback. - - - - - Always callback on matching url or uri. - - - - - Flag for masking any connection. - - - - - Respond to any incoming reverse connection, - remove entry after reverse connect callback. - - - - - Respond to any incoming reverse connection, - always callback. - - - - - Entry for a client reverse connect registration. - - - - - Record to store information on a client - registration for a reverse connect event. - - - - - Register with the server certificate. - - - - - - - - Initializes the object with default values. - - - - - Dispose implementation. - - - - - An overrideable version of the Dispose. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Raised when the configuration changes. - - The sender. - The instance containing the event data. - - - - Called when the configuration is changed on disk. - - The configuration. - - - - Called when the reverse connect configuration is changed. - - - An empty configuration or null stops service on all configured endpoints. - - The client endpoint configuration. - - - - Open host ports. - - - - - Close host ports. - - - - - Dispose the hosts; - - - - - Add endpoint for reverse connection. - - - - - - Starts the server application. - - The configuration. - - - - Starts the server application. - - The configuration. - - - - Clears all waiting reverse connectino handlers. - - - - - Helper to wait for a reverse connection. - - - - - - - - Register for a waiting reverse connection. - - The endpoint Url of the reverse connection. - Optional. The server application Uri of the reverse connection. - The callback - The reverse connect callback strategy. - - - - Unregister reverse connection callback. - - The hashcode returned by the registration. - - - - Called before the server stops - - - - - Called to start hosting the reverse connect ports. - - - - - Remove configuration endpoints from list. - - - - - Add endpoint for reverse connection. - - The endpoint Url of the reverse connect client endpoint. - Tf this is an entry in the application configuration. - - - - Raised when a reverse connection is waiting, - finds and calls a waiting connection. - - - - - Match the waiting connection with a registration, callback registration, - return if connection is accepted in event. - - true if a match was found. - - - - Raised when a connection status changes. - - - - - Renew the cancellation token after use. - - - - - Manages a session with a server. - - - Manages a session with a server. - Contains the async versions of the public session api. - - - Obsolete warnings for service calls which should not be used when using the Session API. - - - - - Constructs a new instance of the class. - - The channel used to communicate with the server. - The configuration for the client application. - The endpoint use to initialize the channel. - - - - Constructs a new instance of the class. - - The channel used to communicate with the server. - The configuration for the client application. - The endpoint used to initialize the channel. - The certificate to use for the client. - The list of available endpoints returned by server in GetEndpoints() response. - The value of profileUris used in GetEndpoints() request. - - The application configuration is used to look up the certificate if none is provided. - The clientCertificate must have the private key. This will require that the certificate - be loaded from a certicate store. Converting a DER encoded blob to a X509Certificate2 - will not include a private key. - The availableEndpoints and discoveryProfileUris parameters are used to validate - that the list of EndpointDescriptions returned at GetEndpoints matches the list returned at CreateSession. - - - - - Initializes a new instance of the class. - - The channel. - The template session. - if set to true the event handlers are copied. - - - - Initializes the channel. - - - - - Sets the object members to default values. - - - - - Check if all required configuration fields are populated. - - - - - Validates the server nonce and security parameters of user identity. - - - - - Closes the session and the underlying channel. - - - - - Raised when a keep alive arrives from the server or an error is detected. - - - Once a session is created a timer will periodically read the server state and current time. - If this read operation succeeds this event will be raised each time the keep alive period elapses. - If an error is detected (KeepAliveStopped == true) then this event will be raised as well. - - - - - Raised when a notification message arrives in a publish response. - - - All publish requests are managed by the Session object. When a response arrives it is - validated and passed to the appropriate Subscription object and this event is raised. - - - - - Raised when an exception occurs while processing a publish response. - - - Exceptions in a publish response are not necessarily fatal and the Session will - attempt to recover by issuing Republish requests if missing messages are detected. - That said, timeout errors may be a symptom of a OperationTimeout that is too short - when compared to the shortest PublishingInterval/KeepAliveCount amount the current - Subscriptions. The OperationTimeout should be twice the minimum value for - PublishingInterval*KeepAliveCount. - - - - - - - - Raised when a subscription is added or removed - - - - - Raised to indicate the session is closing. - - - - - - - - A session factory that was used to create the session. - - - - - Gets the endpoint used to connect to the server. - - - - - Gets the name assigned to the session. - - - - - Gets the period for wich the server will maintain the session if there is no communication from the client. - - - - - Gets the local handle assigned to the session. - - - - - Gets the user identity currently used for the session. - - - - - Gets a list of user identities that can be used to connect to the server. - - - - - Gets the table of namespace uris known to the server. - - - - - Gets the table of remote server uris known to the server. - - - - - Gets the system context for use with the session. - - - - - Gets the factory used to create encodeable objects that the server understands. - - - - - Gets the cache of the server's type tree. - - - - - Gets the cache of nodes fetched from the server. - - - - - Gets the context to use for filter operations. - - - - - Gets the locales that the server should use when returning localized text. - - - - - Gets the data type system dictionaries in use. - - - - - Gets the subscriptions owned by the session. - - - - - Gets the number of subscriptions owned by the session. - - - - - If the subscriptions are deleted when a session is closed. - - - Default true, set to false if subscriptions need to - be transferred or for durable subscriptions. - - - - - If the subscriptions are transferred when a session is reconnected. - - - Default false, set to true if subscriptions should - be transferred after reconnect. Service must be supported by server. - - - - - Whether the endpoint Url domain is checked in the certificate. - - - - - Gets or Sets the default subscription for the session. - - - - - Gets or Sets how frequently the server is pinged to see if communication is still working. - - - This interval controls how much time elaspes before a communication error is detected. - If everything is ok the KeepAlive event will be raised each time this period elapses. - - - - - Returns true if the session is not receiving keep alives. - - - Set to true if the server does not respond for 2 times the KeepAliveInterval. - Set to false is communication recovers. - - - - - Gets the time of the last keep alive. - - - - - Gets the number of outstanding publish or keep alive requests. - - - - - Gets the number of outstanding publish or keep alive requests which appear to be missing. - - - - - Gets the number of good outstanding publish requests. - - - - - Gets and sets the minimum number of publish requests to be used in the session. - - - - - Creates a new communication session with a server by invoking the CreateSession service - - The configuration for the client application. - The endpoint for the server. - If set to true the discovery endpoint is used to update the endpoint description before connecting. - The name to assign to the session. - The timeout period for the session. - The identity. - The user identity to associate with the session. - The cancellation token. - The new session object - - - - Creates a new communication session with a server by invoking the CreateSession service - - The configuration for the client application. - The endpoint for the server. - If set to true the discovery endpoint is used to update the endpoint description before connecting. - If set to true then the domain in the certificate must match the endpoint used. - The name to assign to the session. - The timeout period for the session. - The user identity to associate with the session. - The preferred locales. - The cancellation token. - The new session object. - - - - Creates a new session with a server using the specified channel by invoking the CreateSession service - - The configuration for the client application. - The channel for the server. - The endpoint for the server. - The certificate to use for the client. - The list of available endpoints returned by server in GetEndpoints() response. - The value of profileUris used in GetEndpoints() request. - - - - - Creates a secure channel to the specified endpoint. - - The application configuration. - The client endpoint for the reverse connect. - A configured endpoint to connect to. - Update configuration based on server prior connect. - Check that the certificate specifies a valid domain (computer) name. - The cancellation token. - A representing the asynchronous operation. - - - - Creates a new communication session with a server using a reverse connection. - - The configuration for the client application. - The client endpoint for the reverse connect. - The endpoint for the server. - If set to true the discovery endpoint is used to update the endpoint description before connecting. - If set to true then the domain in the certificate must match the endpoint used. - The name to assign to the session. - The timeout period for the session. - The user identity to associate with the session. - The preferred locales. - The cancellation token. - The new session object. - - - - Creates a new communication session with a server using a reverse connect manager. - - The configuration for the client application. - The reverse connect manager for the client connection. - The endpoint for the server. - If set to true the discovery endpoint is used to update the endpoint description before connecting. - If set to true then the domain in the certificate must match the endpoint used. - The name to assign to the session. - The timeout period for the session. - The user identity to associate with the session. - The preferred locales. - The cancellation token. - The new session object. - - - - Recreates a session based on a specified template. - - The Session object to use as template - The new session object. - - - - Recreates a session based on a specified template. - - The Session object to use as template - The waiting reverse connection. - The new session object. - - - - Recreates a session based on a specified template using the provided channel. - - The Session object to use as template - The waiting reverse connection. - The new session object. - - - - - - - - - - - - - - - - - - - - - - Reconnects to the server after a network failure using a waiting connection. - - - - - - - - - - - - - - - - - - - - - - - Fetch the operation limits of the server. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Returns the software certificates assigned to the application. - - - - - Handles an error when validating the application instance certificate provided by the server. - - - - - Handles an error when validating software certificates provided by the server. - - - - - Inspects the software certificates provided by the server. - - - - - Starts a timer to check that the connection to the server is still available. - - - - - Removes a completed async request. - - - - - Adds a new async request. - - - - - Removes a completed async request. - - - - - Sends a keep alive by reading from the server. - - - - - Checks if a notification has arrived. Sends a publish if it has not. - - - - - Called when the server returns a keep alive response. - - - - - Called when a error occurs during a keep alive. - - - - - Prepare a list of subscriptions to delete. - - - - - Creates a read request with attributes determined by the NodeClass. - - - - - Creates a read request with attributes determined by the NodeClass. - - - - - Builds the node collection results based on the attribute values of the read response. - - The collection of all attributes to read passed in the read request. - The attributes requested per NodeId - The attribute values returned by the read request. - The diagnostic info returned by the read request. - The response header of the read request. - The node collection which holds the results. - The service results for each node. - - - - Creates a Node based on the read response. - - - - - Create a dictionary of attributes to read for a nodeclass. - - - - - Sends an additional publish request. - - - - - Completes an asynchronous publish operation. - - - - - - - - - - - Processes the response from a publish request. - - - - - Recreate the subscriptions in a reconnected session. - Uses Transfer service if is set to true. - - The template for the subscriptions. - - - - Raises an event indicating that publish has returned a notification. - - - - - Invokes a DeleteSubscriptions call for the specified subscriptionId. - - - - - Load certificate for connection. - - - - - Load certificate chain for connection. - - - - - Helper to determine if a continuation point needs to be processed. - - - - - Returns true if the Bad_TooManyPublishRequests limit - has not been reached. - - The actual number of publish requests. - If the publish request limit was reached. - - - - Returns the minimum number of active publish request that should be used. - - - Returns 0 if there are no subscriptions. - - - - - Creates resend data call requests for the subscriptions. - - The subscriptions to call resend data. - - - - Create the publish requests for the active subscriptions. - - - - - Creates and validates the subscription ids for a transfer. - - The subscriptions to transfer. - The subscription ids for the transfer. - Thrown if a subscription is in invalid state. - - - - Indicates that the session configuration has changed. - - - - - The period for which the server will maintain the session if there is no communication from the client. - - - - - The locales that the server should use when returning localized text. - - - - - The Application Configuration. - - - - - The endpoint used to connect to the server. - - - - - The Instance Certificate. - - - - - The Instance Certificate Chain. - - - - - If set totrue then the domain in the certificate must match the endpoint used. - - - - - The name assigned to the session. - - - - - The user identity currently used for the session. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The event arguments provided when a keep alive response arrives. - - - - - Creates a new instance. - - - - - Gets the status associated with the keep alive operation. - - - - - Gets the current server state. - - - - - Gets the current server time. - - - - - Gets or sets a flag indicating whether the session should send another keep alive. - - - - - Represents the event arguments provided when a new notification message arrives. - - - - - Creates a new instance. - - - - - Gets the subscription that the notification applies to. - - - - - Gets the notification message. - - - - - Gets the string table returned with the notification message. - - - - - Represents the event arguments provided when a publish error occurs. - - - - - Creates a new instance. - - - - - Creates a new instance. - - - - - Gets the status associated with the keep alive operation. - - - - - Gets the subscription with the message that could not be republished. - - - - - Gets the sequence number for the message that could not be republished. - - - - - Represents the event arguments provided when publish response - sequence numbers are about to be achknoledged with a publish request. - - - A callee can defer an acknowledge to the next publish request by - moving the to the deferred list. - The callee can modify the list of acknowledgements to send, it is the - responsibility of the caller to protect the lists for modifications. - - - - - Creates a new instance. - - - - - The acknowledgements which are sent with the next publish request. - - - A client may also chose to remove an acknowledgement from this list to add it back - to the list in a subsequent callback when the request is fully processed. - - - - - The deferred list of acknowledgements. - - - The callee can transfer an outstanding - to this list to defer the acknowledge of a sequence number to the next publish request. - - - - - A session configuration stores all the information - needed to reconnect a session with a new secure channel. - - - - - Creates a session configuration - - - - - Creates the session configuration from a stream. - - - - - The session name used by the client. - - - - - The session id assigned by the server. - - - - - The authentication token used by the server to identify the session. - - - - - The identity used to create the session. - - - - - The configured endpoint for the secure channel. - - - - - If the client is configured to check the certificate domain. - - - - - The last server nonce received. - - - - - Attempts to reconnect to the server. - - - - - The minimum reconnect period in ms. - - - - - The maximum reconnect period in ms. - - - - - The default reconnect period in ms. - - - - - The default reconnect operation timeout in ms. - - - - - The internal state of the reconnect handler. - - - - - The reconnect handler is ready to start the reconnect timer. - - - - - The reconnect timer is triggered and waiting to reconnect. - - - - - The reconnection is in progress. - - - - - The reconnect handler is disposed and can not be used for further reconnect attempts. - - - - - Create a reconnect handler. - - Set to true to allow reconnect abort if keep alive recovered. - - The upper limit for the reconnect period after exponential backoff. - -1 (default) indicates that no exponential backoff should be used. - - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - Gets the session managed by the handler. - - The session. - - - - The internal state of the reconnect handler. - - - - - Cancel a reconnect in progress. - - - - - Begins the reconnect process. - - - - - Begins the reconnect process using a reverse connection. - - - - - Returns the reconnect period with a random jitter. - - - - - Returns the reconnect period within the min and max boundaries. - - - - - Called when the reconnect timer expires. - - - - - Reconnects to the server. - - - - - Reset the timer and enter ready state. - - - - - A subscription. - - - The async interface for a subscription. - - - - - Creates a empty object. - - - - - Initializes the subscription from a template. - - - - - Initializes the subscription from a template. - - The template. - if set to true the event handlers are copied. - - - - Resets the state of the publish timer and associated message worker. - - - - - Called by the .NET framework during deserialization. - - - - - Sets the private members to default values. - - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - - - - - - - Raised to indicate that the state of the subscription has changed. - - - - - Raised to indicate the publishing state for the subscription has stopped or resumed (see PublishingStopped property). - - - - - A display name for the subscription. - - - - - The publishing interval. - - - - - The keep alive count. - - - - - The life time of of the subscription in counts of - publish interval. - LifetimeCount shall be at least 3*KeepAliveCount. - - - - - The maximum number of notifications per publish request. - - - - - Whether publishing is enabled. - - - - - The priority assigned to subscription. - - - - - The timestamps to return with the notification messages. - - - - - The maximum number of messages to keep in the internal cache. - - - - - The default monitored item. - - - - - The minimum lifetime for subscriptions in milliseconds. - - - - - Gets or sets a value indicating whether the notifications are cached within the monitored items. - - - true if monitored item cache is disabled; otherwise, false. - - - Applications must process the Session.Notication event if this is set to true. - This flag improves performance by eliminating the processing involved in updating the cache. - - - - - Gets or sets the behavior of waiting for sequential order in handling incoming messages. - - - true if incoming messages are handled sequentially; false otherwise. - - - Setting to true means incoming messages are processed in - a "single-threaded" manner and callbacks will not be invoked in parallel. - - - - - If the available sequence numbers of a subscription - are republished or acknowledged after a transfer. - - - Default false, set to true if no data loss is important - and available publish requests (sequence numbers) that were never acknowledged should be - recovered with a republish. The setting is used after a subscription transfer. - - - - - The unique identifier assigned by the server which can be used to transfer a session. - - - - - Gets or sets the fast data change callback. - - The fast data change callback. - - Only one callback is allowed at a time but it is more efficient to call than an event. - - - - - Gets or sets the fast event callback. - - The fast event callback. - - Only one callback is allowed at a time but it is more efficient to call than an event. - - - - - Gets or sets the fast keep alive callback. - - The keep alive change callback. - - Only one callback is allowed at a time but it is more efficient to call than an event. - - - - - The items to monitor. - - - - - Allows the list of monitored items to be saved/restored when the object is serialized. - - - - - Returns true if the subscription has changes that need to be applied. - - - - - Returns the number of monitored items. - - - - - The session that owns the subscription item. - - - - - A local handle assigned to the subscription - - - - - The unique identifier assigned by the server. - - - - - Whether the subscription has been created on the server. - - - - - The current publishing interval. - - - - - The current keep alive count. - - - - - The current lifetime count. - - - - - Whether publishing is currently enabled. - - - - - The priority assigned to subscription when it was created. - - - - - The when that the last notification received was published. - - - - - The when that the last notification was received. - - - - - The sequence number assigned to the last notification message. - - - - - The number of notifications contained in the last notification message. - - - - - The last notification received from the server. - - - - - The cached notifications. - - - - - The sequence numbers that are available for republish requests. - - - - - Sends a notification that the state of the subscription has changed. - - - - - Returns true if the subscription is not receiving publishes. - - - - - Creates a subscription on the server and adds all monitored items. - - - - - Called after the subscription was transferred. - - The session to which the subscription is transferred. - Id of the transferred subscription. - The available sequence numbers on the server. - - - - Called after the subscription was transferred. - - The session to which the subscription is transferred. - Id of the transferred subscription. - The available sequence numbers on the server. - The cancellation token. - - - - Deletes a subscription on the server. - - - - - Modifies a subscription on the server. - - - - - Changes the publishing enabled state for the subscription. - - - - - Republishes the specified notification message. - - - - - Applies any changes to the subscription items. - - - - - Resolves all relative paths to nodes on the server. - - - - - Creates all items that have not already been created. - - - - - Modies all items that have been changed. - - - - - Deletes all items that have been marked for deletion. - - - - - Set monitoring mode of items. - - - - - Adds the notification message to internal cache. - - - - - Get the number of outstanding message workers - - - - - Adds an item to the subscription. - - - - - Adds an item to the subscription. - - - - - Removes an item from the subscription. - - - - - Removes an item from the subscription. - - - - - Returns the monitored item identified by the client handle. - - - - - Tells the server to refresh all conditions being monitored by the subscription. - - - - - Call the ResendData method on the server for this subscription. - - - - - Updates the available sequence numbers and queues after transfer. - - - If is set to true, sequence numbers - are queued for republish, otherwise ack may be sent. - - The list of available sequence numbers on the server. - - - - Call the GetMonitoredItems method on the server. - - - - - Call the GetMonitoredItems method on the server. - - - - - Starts a timer to ensure publish requests are sent frequently enough to detect network interruptions. - - - - - Checks if a notification has arrived. Sends a publish if it has not. - - - - - Periodically checks if the sessions have timed out. - - - - - Dumps the current state of the session queue. - - - - - Update the subscription with the given revised settings. - - - - - Update the subscription with the given revised settings. - - - - - Update the subscription with the given revised settings. - - - - - Delete the subscription. - Ignore errors, always reset all parameter. - - - - - Ensures sensible values for the counts. - - - - - Processes the incoming messages. - - - - - Throws an exception if the subscription is not in the correct state. - - - - - Validates the sequence number of the incoming publish request. - - - - - Update the results to monitored items - after updating the monitoring mode. - - - - - Prepare the creation requests for all monitored items that have not yet been created. - - - - - Prepare the modify requests for all monitored items - that need modification. - - - - - Transfer all monitored items and prepares the modify - requests if transfer of client handles is not possible. - - - - - Prepare the ResolveItem to NodeId service call. - - - - - Saves a data change in the monitored item cache. - - - - - Saves events in the monitored item cache. - - - - - Find or create an entry for the incoming sequence number. - - The current Utc time. - The sequence number for the new entry. - - - - A message received from the server cached until is processed or discarded. - - - - - Creates a subscription on the server and adds all monitored items. - - - - - Deletes a subscription on the server. - - - - - Modifies a subscription on the server. - - - - - Changes the publishing enabled state for the subscription. - - - - - Republishes the specified notification message. - - - - - Applies any changes to the subscription items. - - - - - Resolves all relative paths to nodes on the server. - - - - - Creates all items on the server that have not already been created. - - - - - Modies all items that have been changed. - - - - - Deletes all items that have been marked for deletion. - - - - - Set monitoring mode of items. - - - - - Tells the server to refresh all conditions being monitored by the subscription. - - - - - Flags indicating what has changed in a subscription. - - - - - The subscription has not changed. - - - - - The subscription was created on the server. - - - - - The subscription was deleted on the server. - - - - - The subscription was modified on the server. - - - - - Monitored items were added to the subscription (but not created on the server) - - - - - Monitored items were removed to the subscription (but not deleted on the server) - - - - - Monitored items were created on the server. - - - - - Monitored items were deleted on the server. - - - - - Monitored items were modified on the server. - - - - - Subscription was transferred on the server. - - - - - Flags indicating what has changed in a publish state change. - - - - - The publish state has not changed. - - - - - The publishing stopped. - - - - - The publishing recovered. - - - - - A keep alive message was received. - - - - - A republish for a missing message was issued. - - - - - The publishing was transferred to another node. - - - - - The publishing was timed out - - - - - The delegate used to receive data change notifications via a direct function call instead of a .NET Event. - - - - - The delegate used to receive event notifications via a direct function call instead of a .NET Event. - - - - - The delegate used to receive keep alive notifications via a direct function call instead of a .NET Event. - - - - - The event arguments provided when the state of a subscription changes. - - - - - Creates a new instance. - - - - - The changes that have affected the subscription. - - - - - The delegate used to receive subscription state change notifications. - - - - - The event arguments provided when the state of a subscription changes. - - - - - Creates a new instance. - - - - - The publish state changes. - - - - - The delegate used to receive publish state change notifications. - - - - - A collection of subscriptions. - - - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - The existing collection to use as the basis of creating this collection - - - - Initializes the collection with the specified capacity. - - The max. capacity of the collection - - - - - - - - - - Decorator class for traceable session with Activity Source. - - - - - Initializes a new instance of the class. - - - - - Activity Source Name. - - - - - Activity Source static instance. - - - - - The ISession which is being traced. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Disposes the session. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Object that creates instances of an Opc.Ua.Client.Session object with Activity Source. - - - - - The default instance of the factory. - - - - - Force use of the default instance. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The client side interface with support for batching according to operation limits. - - - - - Intializes the object with a channel and default operation limits. - - - - - The operation limits are used to batch the service requests. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initialize the collections for a service call. - - - Preset the result collections with null if the operation limit - is sufficient or with the final size if batching is necessary. - - - - - Add the result of a batched service call to the results. - - - Assigns the batched collection result to the result if the result - collection is not initialized, adds the range to the result - collections otherwise. - The string table indexes are updated in the diagnostic infos if necessary. - - - - - Extension helpers for client service calls. - - - - - Returns batches of a collection for processing. - - - Returns the original collection if batchsize is 0 or the collection count is smaller than the batch size. - - The type of the items in the collection. - The type of the items in the collection. - The collection from which items are batched. - The size of a batch. - The collection. - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Core.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Core.dll deleted file mode 100644 index 5ff19a6..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Core.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Core.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Core.xml deleted file mode 100644 index 6d67875..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Core.xml +++ /dev/null @@ -1,127759 +0,0 @@ - - - - Opc.Ua.Core - - - - - The Opc.Ua.Bindings namespace contains classes that implement the bindings for the - mappings described in Part 6 of the UA specification. It also includes an implementation for - the UA TCP protocol. - - - - - - Provides stream access to a sequence of buffers. - - - - - Attaches the stream to a set of buffers - - The buffers. - - - - Creates a writeable stream that creates buffers as necessary. - - The buffer manager. - Size of the buffer. - The start. - The count. - - - - Returns ownership of the buffers stored in the stream. - - The owner. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Sets the current buffer. - - - - - Returns the total length in all buffers. - - - - - Returns the current position. - - - - - Returns the number of bytes used in the buffer. - - - - - Check if end of stream is reached and take new buffer if necessary. - - Throws if end of stream is reached. - - - - The binding for the UA native stack - - - - - Initializes the binding. - - - - - The message context to use with the binding. - - - - - A collection of buffers. - - - - - Creates an empty collection. - - - - - Creates an empty collection with the specified capacity. - - The capacity. - - - - Creates a collection with a single element. - - The segment. - - - - Creates a collection with a single element. - - The array. - The offset. - The count. - - - - Returns the buffers to the manager before clearing the collection. - - The buffer manager. - The owner. - Length of all buffers in this collection - - - - Returns the total amount of data in the buffers. - - The total size. - - - - A thread safe wrapper for the buffer manager class. - - - - - Constructs the buffer manager. - - The name. - Max size of the buffer. - - - - Returns a buffer with at least the specified size. - - The size. - The owner. - The buffer content - - - - Changes the owner of a buffer (used for debugging only). - - The buffer. - The owner. - - - - Locks the buffer (used for debugging only). - - The buffer. - - - - Unlocks the buffer (used for debugging only). - - The buffer. - - - - Release the buffer. - - The buffer. - The owner. - - - - This is an interface to the scheme of a transport binding. - - - - - The protocol scheme supported by the binding. - - - - - This is an interface to the factory of a transport binding. - - - - - The factory to create a new transport. - - The transport. - - - - The interface to manage transport bindings. - - - - - Get a transport binding for a uri scheme. - - The uri scheme. - - - - Return if there is a transport listener for a uri scheme. - - The uri scheme. - - - - Set the transport factory to the binding. - Overrides other bindings with the same uri scheme. - - - - - Add all bindings with interface exported from a assembly. - - The assembly with the bindings. - - - - Add all bindings with interface from a list. - - The array of binding types with interface. - - - - This is the transport listener factory interface for a binding (server). - - - - - Create the service host for a server using - - The server base. - The service hosts are added to this list. - The application configuration. - The base addreses for the service host. - The server description. - The list of supported security policies. - The server certificate. - The cert cahin of the server certificate. - - - - This is the transport channel factory interface for a binding (client). - - - - - The transport bindings available for the UA applications. - - - - - The bindings for transport channels (client). - - - - - The bindings for transport listeners (server). - - - - - The bindings for the transport channels. - - - - - Initialize the transport listener. - - List of known default bindings. - - - - Get a transport channel for the specified uri scheme. - - The uri scheme of the transport. - - - - The bindings for the transport listeners. - - - - - Initialize the transport listener. - - List of known default bindings. - - - - Get a transport listener for the specified uri scheme. - - The uri scheme of the transport. - - - - The bindings for the transport listeners. - - - - - Implement the default constructor. - - - The default constructor adds all interfaces T. - - - - - Initialize object with default list of bindings. - - - - - Dictionary of bindings. - - - - - - - - - - - - - - - - - - - - Validate the type is a transport listener. - - - - - Try to load a binding from well known assemblies at runtime. - - The uri scheme of the binding. - - - - Stores the results of an asynchronous operation. - - - - - Initializes the object with a callback - - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - Called when an asynchronous operation completes. - - - - - Called when an asynchronous operation completes. - - - - - Called when an asynchronous operation completes. - - - - - Called when an asynchronous operation completes. - - - - - Called when an asynchronous operation completes. - - - - - Called when an asynchronous operation completes. - - - - - Called when an asynchronous operation completes. - - - - - Called when an asynchronous operation completes. - - - - - The response returned from the server. - - - - - Stores additional state information associated with the operation. - - - - - - - - - - - - - - - - - Called when the operation times out. - - - - - Called when an asynchronous operation completes. - - - - - Stores various configuration parameters used by the channel. - - - - - Creates an object with default values. - - - - - The context to use when encoding/decoding messages. - - - - - Validator to use when handling certificates. - - - - - The maximum size for a message sent or received. - - - - - The maximum size for the send or receive buffers. - - - - - The default lifetime for the channel in milliseconds. - - - - - The default lifetime for a security token in milliseconds. - - - - - Represents a security token associate with a channel. - - - - - Creates an object with default values. - - - - - The id assigned to the channel that the token belongs to. - - - - - The id assigned to the token. - - - - - When the token was created by the server (refers to the server's clock). - - - - - The lifetime of the token in milliseconds. - - - - - Whether the token has expired. - - - - - Whether the token should be activated in case a new one is already created. - - - - - The nonce provided by the client. - - - - - The nonce provided by the server. - - - - - The key used to sign messages sent by the client. - - - - - The key used to encrypt messages sent by the client. - - - - - The initialization vector by the client when encrypting a message. - - - - - The key used to sign messages sent by the server. - - - - - The key used to encrypt messages sent by the server. - - - - - The initialization vector by the server when encrypting a message. - - - - - The SymmetricAlgorithm object used by the client to encrypt messages. - - - - - The SymmetricAlgorithm object used by the server to encrypt messages. - - - - - The HMAC object used by the client to sign messages. - - - - - The HMAC object used by the server to sign messages. - - - - - Interface between listener and UA TCP channel - - - - - The endpoint url of the listener - - - - - Binds a new socket to an existing channel. - - - - - - - - - - - - - Used to transfer a reverse connection socket to the client. - - - - - Called when a channel closes. - - - - - Manages the listening side of a UA TCP channel. - - - - - Attaches the object to an existing socket. - - - - - Attaches the object to an existing socket. - - - - - An overrideable version of the Dispose. - - - - - The channel name used in trace output. - - - - - The TCP channel listener. - - - - - Sets the callback used to receive notifications of new events. - - - - - Sets the callback used to raise channel audit events. - - - - - Sets the callback used to raise channel audit events. - - - - - Sets the callback used to raise channel audit events. - - - - - Attaches the channel to an existing socket. - - - - - Handles a socket error. - - - - - Forces the channel into a faulted state as a result of a fatal error. - - - - - Forces the channel into a faulted state as a result of a fatal error. - - - - - Forces the channel into a faulted state as a result of a fatal error. - - - - - Starts a timer that will clean up the channel if it is not opened/re-opened. - - - - - Cleans up a timer that will clean up the channel if it is not opened/re-opened. - - - - - Called when the channel needs to be cleaned up. - - - - - Closes the channel and releases resources. - - - - - Sends an error message over the socket. - - - - - Sends a fault response secured with the symmetric keys. - - - - - Notify if the channel status changed. - - - - - Called to indicate an error or success if the listener - channel initiated a reverse hello connection. - - - The callback is only used by the server channel. - The listener channel uses the callback to indicate - an error condition to the server channel. - - - - - Sends a fault response secured with the asymmetric keys. - - - - - Handles a reconnect request. - - - - - Set the flag if a response is required for the use case of reverse connect. - - - - - Returns a new token id. - - - - - The channel request event handler. - - - - - The report open secure channel audit event handler. - - - - - The report close secure channel audit event handler. - - - - - The report certificate audit event handler. - - - - - Used to report an incoming request. - - - - - Used to report the status of the channel. - - - - - Used to report an open secure channel audit event. - - - - - Used to report a close secure channel audit event - - - - - Used to report an open secure channel audit event. - - - - - Creates a transport channel with UA-TCP transport, UA-SC security and UA Binary encoding - - - - - Create a Tcp transport channel. - - - - - Creates a new TcpTransportChannel with ITransportChannel interface. - - - - - The protocol supported by the channel. - - - - - The method creates a new instance of a TCP transport channel - - The transport channel - - - - Handles async event callbacks from a socket - - - - - Create the event args for the async TCP message socket. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The socket event args. - - - - - Handles async event callbacks only for the ConnectAsync method - - - - - Create the async event args for a TCP message socket. - - The socket error. - - - - - - - - - - Not implemented here. - - - - - - - - - - Not implemented here. - - - - - - - Not implemented here. - - - - Not implememnted here. - - - - Creates a new TcpMessageSocket with IMessageSocket interface. - - - - - The method creates a new instance of a UA-TCP message socket - - the message socket - - - - Gets the implementation description. - - The implementation string. - - - - Handles reading and writing of message chunks over a socket. - - - - - Creates an unconnected socket. - - - - - Attaches the object to an existing socket. - - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - Gets the socket handle. - - The socket handle. - - - - Gets the local endpoint. - - An error occurred when attempting to access the socket. - See the Remarks section for more information. - The System.Net.Sockets.Socket has been closed. - The System.Net.EndPoint that the System.Net.Sockets.Socket is using for communications. - - - - Gets the transport channel features implemented by this message socket. - - The transport channel feature. - - - - Connects to an endpoint. - - - - - Forcefully closes the socket. - - - - - Starts reading messages from the socket. - - - - - Changes the sink used to report reads. - - - - - Handles a read complete event. - - - - - Handles a read complete event. - - - - - Reads the next block of data from the socket. - - - - - Helper to read read next block or message based on current state. - - - - - delegate to handle internal callbacks with socket error - - - - - Try to connect to endpoint and do callback if connected successfully - - Endpoint address - Endpoint address family - Endpoint port - Callback that must be executed if the connection would be established - - - - Handle socket connection event - - - - - - - Sends a buffer. - - - - - Create event args for TcpMessageSocket. - - - - - States for the nested read handler. - - - - - Defines constants for the UA TCP message identifiers. - - - - - A final chunk for a message. - - - - - An intermediate chunk for a message. - - - - - A final chunk for a message which indicates that the message has been aborted by the sender. - - - - - A mask used to select the message type portion of the message id. - - - - - A mask used to select the chunk type portion of the message id. - - - - - A chunk for a generic message. - - - - - A chunk for a generic message. - - - - - A chunk for a generic message. - - - - - A chunk for an OpenSecureChannel message. - - - - - A chunk for a CloseSecureChannel message. - - - - - A hello message. - - - - - A reverse hello message. - - - - - An acknowledge message. - - - - - An error message. - - - - - Returns true if the message type is equal to the expected type. - - - - - Returns true if the message type indicates it is a final chunk. - - - - - Returns true if the message type indicates it is a abort chunk. - - - - - Returns true if the message type is recognized. - - - - - Defines constants for the UA TCP message identifiers. - - - - - The size of the message type and size prefix in each message. - - - - - The minimum send or receive buffer size. - - - - - Minimum message body size - - - - - The maximum send or receive buffer size. - - - - - The maximum length for the reason in an error message. - - - - - The maximum length for the endpoint url in the hello message. - - - - - The maximum length for an x509 certificate. - - - - - The maximum length for an a security policy uri. - - - - - The length of the base message header. - - - - - The length of the message header use with symmetric cryptography. - - - - - The length of the sequence message header. - - - - - The length a X509 certificate thumbprint. - - - - - The number of bytes required to specify the length of an encoding string or bytestring. - - - - - Sequence numbers may only rollover if they are larger than this value. - - - - - The first sequence number after a rollover must be less than this value. - - - - - The default buffer size to use for communication. - - - - - The default maximum chunk count for Request and Response messages. - - - - - The default maximum message size. - - - - - The default maximum message size for the discovery channel. - - - - - How long a connection will remain in the server after it goes into a faulted state. - - - - - How long a security token lasts before it needs to be renewed. - - - - - The minimum lifetime for a security token lasts before it needs to be renewed. - - - - - The minimum time interval between reconnect attempts. - - - - - The maximum time interval between reconnect attempts. - - - - - The fraction of the lifetime to wait before renewing a token. - - - - - The fraction of the lifetime to wait before forcing the activation of the renewed token. - - - - - The certificates that have the key size larger than KeySizeExtraPadding need an extra padding byte in the transport message - - - - - Manages the reverse connect client UA TCP channel. - - - - - Attaches the object to an existing socket. - - - - - The channel name used in trace output. - - - - - Processes an incoming message. - - True if the implementor takes ownership of the buffer. - - - - Processes a ReverseHello message from the server. - - - - - Manages the server side of a UA TCP channel. - - - - - Attaches the object to an existing socket. - - - - - Attaches the object to an existing socket. - - - - - An overrideable version of the Dispose. - - - - - The channel name used in trace output. - - - - - The URL used to establish a connection to the client. - - - - - Raised when the connection status changes. - - - - - Begin a reverse connect. - - - - - End the reverse connect. - - - - - Reverse client is connected, send reverse hello message. - - - - - Handles a reconnect request. - - - - - Processes an incoming message. - - True if the implementor takes ownership of the buffer. - - - - Called to send queued responses after a reconnect. - - - - - Processes a Hello message from the client. - - - - - Processes an OpenSecureChannel request message. - - - - - - - - - - - Sends an OpenSecureChannel response. - - - - - Processes an CloseSecureChannel request message. - - - - - Processes a request message. - - - - - Sends the response for the specified request. - - - - - Reset the sorted dictionary of queued responses after reconnect. - - - - - Closes the channel in case the message limits have been exceeded - - - - - Validate the type of message before it is decoded. - - - - - Creates a new Tcp service host. - - - This class can be used by a transport which - implements the - - - - - - - - - - - - Create a new service host for UA TCP. - - - - - Creates a new TcpTransportListener with ITransportListener interface. - - - - - - - - - - - Manages the transport for a UA TCP server. - - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - The URI scheme handled by the listener. - - - - - Opens the listener and starts accepting connection. - - The base address. - The settings to use when creating the listener. - The callback to use when requests arrive via the channel. - Thrown if any parameter is null. - Thrown if any communication error occurs. - - - - Closes the listener and stops accepting connection. - - Thrown if any communication error occurs. - - - - Gets the URL for the listener's endpoint. - - The URL for the listener's endpoint. - - - - Binds a new socket to an existing channel. - - - - - Called when a channel closes. - - - - - Raised when a new connection is waiting for a client. - - - - - Raised when a monitored connection's status changed. - - - - - - - - Indicate that the reverse hello connection attempt completed. - - - The server tried to connect to a client using a reverse hello message. - - - - - Starts listening at the specified port. - - - - - Stops listening. - - - - - Transfers the channel to a waiting connection. - - TRUE if the channel should be kept open; FALSE otherwise. - - - - Called when a UpdateCertificate event occured. - - - - - Handles a new connection. - - - - - Handles requests arriving from a channel. - - - - - Callback for reporting the open secure channel audit event - - - - - Callback for reporting the close secure channel audit event - - - - - Callback for reporting the certificate audit events - - - - - Get the next channel id. Handles overflow. - - - - - Sets the URI for the listener. - - - - - The Tcp specific arguments passed to the ConnectionWaiting event. - - - - - - - - - - - Manages the server side of a UA TCP channel. - - - Manages the server side of a UA TCP channel. - - - Manages the server side of a UA TCP channel. - - - - - Returns the endpoint description selected by the client. - - - - - The certificate for the server. - - - - - The server certificate chain. - - - - - The security mode used with the channel. - - - - - The security policy used with the channel. - - - - - Whether the channel is restricted to discovery operations. - - - - - The certificate for the client. - - - - - The client certificate chain. - - - - - Creates a new nonce. - - - - - Returns the thumbprint as a uppercase string. - - - - - Returns the thumbprint as a uppercase string. - - - - - Compares two certificates. - - - - - Returns the length of the symmetric encryption key. - - - - - Validates the nonce. - - - - - Returns the plain text block size for key in the specified certificate. - - - - - Returns the cipher text block size for key in the specified certificate. - - - - - Calculates the size of the asymmetric security header. - - - - - Get asymmetric header size - - - - - Calculates the size of the footer with an asymmetric signature. - - - - - Writes the asymmetric security header to the buffer. - - - - - Writes the asymmetric security header to the buffer. - - - - - Sends a OpenSecureChannel request. - - - - - Sends a OpenSecureChannel request. - - - - - Reads the asymmetric security header to the buffer. - - - - - Checks if it is possible to revise the security mode. - - - - - Sets to endpoint according to the endpoint url. - - - - - Processes an OpenSecureChannel request message. - - - - - Adds an asymmetric signature to the end of the buffer. - - - Start and count specify the block of data to be signed. - The padding and signature must be written to the stream wrapped by the encoder. - - - - - Verifies an asymmetric signature at the end of the buffer. - - - Start and count specify the block of data including the signature and padding. - The current security policy uri and sender certificate specify the size of the signature. - This call also verifies that the padding is correct. - - - - - Encrypts the buffer using asymmetric encryption. - - - Start and count specify the block of data to be encrypted. - The caller must ensure that count is a multiple of the input block size for the current cipher. - The header specifies unencrypted data that must be copied to the output. - - - - - Decrypts the buffer using asymmetric encryption. - - - Start and count specify the block of data to be decrypted. - The header specifies unencrypted data that must be copied to the output. - - - - - Attaches the object to an existing socket. - - - - - Attaches the object to an existing socket. - - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - The identifier assigned to the channel by the server. - - - - - The globally unique identifier assigned to the channel by the server. - - - - - Raised when the state of the channel changes. - - - - - Reports that the channel state has changed (in another thread). - - - - - Returns a new sequence number. - - - - - Resets the sequence number after a connect. - - - - - Checks if the sequence number is valid. - - - - - Saves an intermediate chunk for an incoming message. - - - - - Returns the chunks saved for message. - - - - - Returns total length of the chunks saved for message. - - - - - Code executed when the message limits are exceeded. - - - - - - - - - - - Processes an incoming message. - - True if the implementor takes ownership of the buffer. - - - - Handles an error parsing or verifying a message. - - - - - Handles an error parsing or verifying a message. - - - - - Handles an error parsing or verifying a message. - - - - - - - - Handles a socket error. - - - - - Handles a write complete event. - - - - - Queues a write request. - - - - - Queues a write request. - - - - - Called after a write operation completes. - - - - - Writes an error to a stream. - - - - - Reads an error from a stream. - - - - - Checks if the message limits have been exceeded. - - - - - Updates the message type stored in the message header. - - - - - Updates the message size stored in the message header. - - - - - The synchronization object for the channel. - - - - - The socket for the channel. - - - - - Whether the client channel uses a reverse hello socket. - - - - - The buffer manager for the channel. - - - - - The resource quotas for the channel. - - - - - The size of the receive buffer. - - - - - The size of the send buffer. - - - - - The maximum size for a request message. - - - - - The maximum number of chunks per request message. - - - - - The maximum size for a response message. - - - - - The maximum number of chunks per response message. - - - - - The state of the channel. - - - - - The identifier assigned to the channel by the server. - - - - - A class that stores the state for a write operation. - - - - - Initializes the object with a callback - - - - - The request id associated with the operation. - - - - - The body of the request or response associated with the operation. - - - - - Calculate the chunk count which can be used for messages based on buffer size. - - The message size to be used. - The buffer available for a message. - The chunk count. - - - - Creates an RSA PKCS#1 v1.5 or PSS signature of a hash algorithm for the stream. - - - - - Verifies an RSA PKCS#1 v1.5 or PSS signature of a hash algorithm for the stream. - - - - - Encrypts the message using RSA encryption. - - - - - Decrypts the message using RSA encryption. - - - - - Returns the current security token. - - - - - Returns the current security token. - - - - - Returns the renewed but not yet activated token. - - - - - Creates a new token. - - - - - Activates a new token. - - - - - Sets the renewed token - - - - - Discards the tokens. - - - - - The byte length of the MAC (a.k.a signature) attached to each message. - - - - - The byte length the encryption blocks. - - - - - Calculates the symmetric key sizes based on the current security policy. - - - - - Computes the keys for a token. - - - - - Secures the message using the security token. - - - - - Decrypts and verifies a message chunk. - - - - - Returns the symmetric signature for the data. - - - - - Returns the symmetric signature for the data. - - - - - Decrypts the data in a buffer using symmetric encryption. - - - - - Decrypts the data in a buffer using symmetric encryption. - - - - - Signs the message using SHA1 HMAC - - - - - Verifies a HMAC for a message. - - - - - Encrypts a message using a symmetric algorithm. - - - - - Decrypts a message using a symmetric algorithm. - - - - - The possible channel states. - - - - - The channel is closed. - - - - - The channel is closing. - - - - - The channel establishing a network connection. - - - - - The channel negotiating security parameters. - - - - - The channel is open and accepting messages. - - - - - The channel is in a error state. - - - - - Used to report changes to the channel state. - - - - - Manages the client side of a UA TCP channel. - - - - - Creates a channel for for a client. - - - - - Creates a channel for for a client. - - - - - An overrideable version of the Dispose. - - - - - Creates a connection with the server. - - - - - Finishes a connect operation. - - - - - Closes a connection with the server. - - - - - Sends a request to the server. - - - - - Returns the response to a previously sent request. - - - - - Sends a Hello message. - - - - - Processes an Acknowledge message. - - - - - Sends an OpenSecureChannel request. - - - - - Processes an OpenSecureChannel response message. - - - - - Closes the channel in case the message limits have been exceeded - - - - - Handles a socket error. - - - - - Called when a write operation completes. - - - - - Processes an incoming message. - - True if the function takes ownership of the buffer. - - - - Called when the socket is connected. - - - - - Called when it is time to do a handshake. - - - - - Called when a token is renewed. - - - - - Sends a request to the server. - - - - - Parses the response return from the server. - - - - - Cancels all pending requests and closes the channel. - - - - - Closes the channel and attempts to reconnect. - - - - - Schedules the renewal of a token. - - - - - Creates a object to manage the state of an asynchronous operation. - - - - - Cleans up after an asychronous operation completes. - - - - - Stores the state of a operation that was queued while waiting for the channel to connect. - - - - - Called when the connect operation completes. - - The state. - - - - Processes an Error message received over the socket. - - - - - Sends an CloseSecureChannel request message. - - - - - Processes a response message. - - - - - Creates a transport channel for the ITransportChannel interface. - Implements the UA-SC security and UA Binary encoding. - The socket layer requires a IMessageSocketFactory implementation. - - - - - Create a transport channel from a message socket factory. - - The message socket factory. - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - Returns the channel's underlying message socket if connected / available. - - - - - A masking indicating which features are implemented. - - - - - Gets the description for the endpoint used by the channel. - - - - - Gets the configuration for the channel. - - - - - Gets the context used when serializing messages exchanged via the channel. - - - - - Gets the the channel's current security token. - - - - - Gets or sets the default timeout for requests send via the channel. - - - - - Initializes a secure channel with the endpoint identified by the URL. - - The URL for the endpoint. - The settings to use when creating the channel. - Thrown if any communication error occurs. - - - - Initializes a secure channel with the endpoint identified by the connection. - - The connection to use. - The settings to use when creating the channel. - Thrown if any communication error occurs. - - - - Opens a secure channel with the endpoint identified by the URL. - - Thrown if any communication error occurs. - - - - Begins an asynchronous operation to open a secure channel with the endpoint identified by the URL. - - The callback to call when the operation completes. - The callback data to return with the callback. - - The result which must be passed to the EndOpen method. - - Thrown if any communication error occurs. - - - - - Completes an asynchronous operation to open a secure channel. - - The result returned from the BeginOpen call. - Thrown if any communication error occurs. - - - - - Closes any existing secure channel and opens a new one. - - Thrown if any communication error occurs. - - Calling this method will cause outstanding requests over the current secure channel to fail. - - - - - Closes any existing secure channel and opens a new one. - - A reverse connection, null otherwise. - Thrown if any communication error occurs. - - Calling this method will cause outstanding requests over the current secure channel to fail. - - - - - Begins an asynchronous operation to close the existing secure channel and open a new one. - - The callback to call when the operation completes. - The callback data to return with the callback. - - The result which must be passed to the EndReconnect method. - - Thrown if any communication error occurs. - - - - - Completes an asynchronous operation to close the existing secure channel and open a new one. - - The result returned from the BeginReconnect call. - Thrown if any communication error occurs. - - - - - Closes the secure channel. - - Thrown if any communication error occurs. - - - - Begins an asynchronous operation to close the secure channel. - - The callback to call when the operation completes. - The callback data to return with the callback. - - The result which must be passed to the EndClose method. - - Thrown if any communication error occurs. - - - - - Completes an asynchronous operation to close the secure channel. - - The result returned from the BeginClose call. - Thrown if any communication error occurs. - - - - - Sends a request over the secure channel. - - The request to send. - The response returned by the server. - Thrown if any communication error occurs. - - - - Sends a request over the secure channel (async version). - - The request to send. - The cancellation token. - The response returned by the server. - Thrown if any communication error occurs. - - - - Begins an asynchronous operation to send a request over the secure channel. - - The request to send. - The callback to call when the operation completes. - The callback data to return with the callback. - - The result which must be passed to the EndSendRequest method. - - Thrown if any communication error occurs. - - - - - Completes an asynchronous operation to send a request over the secure channel. - - The result returned from the BeginSendRequest call. - - Thrown if any communication error occurs. - - - - - Saves the settings so the channel can be opened later. - - The URL. - The settings. - - - - Opens the channel before sending the request. - - A reverse connection, null otherwise. - - - - Represents an asynchronous message socket operation. - - - - - Gets the data buffer to use with an asynchronous socket method. - - - A System.Byte array that represents the data buffer to use with an asynchronous - socket method. - - - - - Gets or sets an array of data buffers to use with an asynchronous socket method. - - - An System.Collections.IList that represents an array of data buffers to use with - an asynchronous socket method. - - - - - Gets the number of bytes transferred in the socket operation. - - An System.Int32 that contains the number of bytes transferred in the socket operation. - - - - Gets the result of the asynchronous socket operation. - - true if error, false if ok - - - - Gets the SocketError string of the asynchronous socket operation. - - the socket error string - - - - Gets or sets a user or application object associated with this asynchronous socket - operation. - - - An object that represents the user or application object associated with this - asynchronous socket operation. - - - - - The event used to complete an asynchronous operation. - - the message socket - - - - Sets the data buffer to use with an asynchronous socket method. - - The data buffer to use with an asynchronous socket method. - The offset, in bytes, in the data buffer where the operation starts. - The maximum amount of data, in bytes, to send or receive in the buffer. - - - - - An interface to an object that received messages from the socket. - - - - - Indicates that the sender side of the channel - has too many outstanding messages that were not yet delivered. - - - - - Called when a new message arrives. - - - - - Called when an error occurs during a read. - - - - - This is an interface to a message socket which supports a factory - - - - - Creates an unconnected socket. - - the message socket - - - - Gets the implementation description. - - The implementation string. - - - - Handles reading and writing of message chunks over a socket. - - - - - Gets the socket handle. - - The socket handle. - - - - Gets the local endpoint. - - An error occurred when attempting to access the socket. - See the Remarks section for more information. - The Socket has been closed. - The System.Net.EndPoint that the Socket is using for communications. - - - - Returns the features implemented by the message socket. - - - - - Connects to an endpoint. - - - - - Forcefully closes the socket. - - - - - Starts reading messages from the socket. - - - - - Changes the sink used to report reads. - - - - - Sends a buffer. - - - - - Get the message socket event args. - - - - - A channel, based on an underlying message socket - - - - - Returns the channel's underlying message socket if connected. - - - - - The Opc.Ua.Configuration namespace contains classes that used to manage the - configuration and security information for a UA application. - - - - - - The Opc.Ua namespace contains classes and interfaces which implement all of the types - and services defined by the UA specification. - - - - - - The Opc.Ua.Schema.Binary namespace provides classes which implement the OPC Binary - Type Description schema which is defined in Part 3 of the UA specification. - - - - - - A description of type, - - - - - - The qualifed name for the type. - - - - - - - - - - - - - - - - - Generates files used to describe data types. - - - - - Intializes the object with default values. - - - - - Intializes the object with a file table. - - - - - Intializes the object with a import table. - - - - - The dictionary that was validated. - - - - - The types defined in the dictionary. - - - - - Any warnings during validation. - - - - - Generates the code from the contents of the address space. - - - - - Generates the code from the contents of the address space. - - - - - Returns the schema for the specified type (returns the entire schema if null). - - - - - Generates the code from the contents of the address space. - - - - - Imports a dictionary identified by an import directive. - - - - - Returns true if the documentation element is empty. - - - - - Returns true if field is an integer type. - - - - - Returns the length of field in bits (-1 if the length is not fixed). - - - - - Checks if a string is a valid part of a qname. - - - - - Imports a type description. - - - - - Validates a type description. - - - - - Validates a field in a structured type description. - - - - - Well known embedded binary schemas. - - - - - The binary schema documentation. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The Opc.Ua.Schema namespace provides classes which facilitate manipulation of the schemas - used to describe data types exposed by a UA server. - - - - - - The Opc.Ua.Schema.Xml namespace provides classes which provide access to - XML schemas used to describe the data types provided by a UA Server. - - - - - - Generates files used to describe data types. - - - - - Intializes the object with default values. - - - - - Intializes the object with a file table. - - - - - Intializes the object with a import table. - - - - - The schema set that was validated. - - - - - The schema that was validated. - - - - - Generates the code from the contents of the address space. - - - - - Generates the code from the contents of the address space. - - - - - Returns the schema for the specified type (returns the entire schema if null). - - - - - Handles a validation error. - - - - - The well known schemas embedded in the assembly. - - - - - A base class for schema validators. - - - - - Intializes the object with default values. - - - - - Intializes the object with a file table. - - - - - Intializes the object with a import table. - - - - - The file that was validated. - - - - - A table of known files. - - - - - A table of files which have been loaded. - - - - - A table of import files. - - - - - Returns true if the QName is null, - - - - - Formats a string and throws an exception. - - - - - Formats a string and throws an exception. - - - - - Formats a string and throws an exception. - - - - - Formats a string and throws an exception. - - - - - Loads an input file for validation. - - - - - Loads an input file for validation. - - - - - Loads the dictionary from a file. - - - - - Loads a schema from a file. - - - - - Loads a schema from a file. - - - - - Loads a schema from an embedded resource. - - - - - Adds the embedded resources to the file table. - - - - - Returns the schema for the specified type (returns the entire schema if null). - - - - - Stores the configurable configuration information for a UA application. - - - Stores the configurable configuration information for a UA application. - - - - - The default constructor. - - - - - The constructor from a template. - - - - - Sets private members to default values. - - - - - Initializes the object during deserialization. - - The context. - - - - Gets an object used to synchronize access to the properties dictionary. - - - The object used to synchronize access to the properties dictionary. - - - - - Gets a dictionary used to save state associated with the application. - - - The dictionary used to save state associated with the application. - - - - - Storage for decoded extensions of the application. - Used by ParseExtension if no matching XmlElement is found. - - - - - A descriptive name for the application (not necessarily unique). - - The name of the application. - - - - A unique identifier for the application instance. - - The application URI. - - - - A unique identifier for the product. - - The product URI. - - - - The type of application. - - The type of the application. - - - - The security configuration for the application. - - The security configuration. - - - - The transport configuration for the application. - - The transport configurations. - - - - The quotas that are used at the transport layer. - - The transport quotas. - - - - Additional configuration for server applications. - - The server configuration. - - - - Additional configuration for client applications. - - The client configuration. - - - - Additional configuration of the discovery server. - - The discovery server configuration. - - - - A bucket to store additional application specific configuration data. - - The extensions. - - - - Configuration of the trace and information about log file - - The trace configuration. - - - - Disabling / enabling high resolution clock - - true if high resolution clock is disabled; otherwise, false. - - - - Gets the file that was used to load the configuration. - - The source file path. - - - - Gets or sets the certificate validator which is configured to use. - - - - - Returns the domain names which the server is configured to use. - - A list of domain names. - - - - Creates the message context from the configuration. - - A new instance of a ServiceMessageContext object. - - - - Creates the message context from the configuration. - - A new instance of a ServiceMessageContext object. - - - - Loads and validates the application configuration from a configuration section. - - Name of configuration section for the current application's default configuration containing . - Type of the application. - Application configuration - - - - Loads and validates the application configuration from a configuration section. - - Name of configuration section for the current application's default configuration containing . - A description for the ApplicationType DataType. - A user type of the configuration instance. - Application configuration - - - - Loads but does not validate the application configuration from a configuration section. - - The file. - Type of the system. - Application configuration - Use this method to ensure the configuration is not changed during loading. - - - - Loads and validates the application configuration from a configuration section. - - The file. - Type of the application. - Type of the system. - Application configuration - - - - Loads and validates the application configuration from a configuration section. - - The file. - Type of the application. - Type of the system. - if set to true apply trace settings after validation. - The certificate password provider. - Application configuration - - - - Loads and validates the application configuration from a configuration section. - - The stream. - Type of the application. - Type of the system. - if set to true apply trace settings after validation. - The certificate password provider. - Application configuration - - - - Reads the file path from the application configuration file. - - Name of configuration section for the current application's default configuration containing . - - File path from the application configuration file. - - - - Saves the configuration file. - - The file path. - Calls GetType() on the current instance and passes that to the DataContractSerializer. - - - - Ensures that the application configuration is valid. - - Type of the application. - - - - Loads the endpoints cached on disk. - - if set to true ConfiguredEndpointCollection is always returned, - even if loading from disk fails - Colection of configured endpoints from the disk. - - - - Loads the endpoints cached on disk. - - if set to true ConfiguredEndpointCollection is always returned, - even if loading from disk fails - if set to true overrides the configuration. - - Colection of configured endpoints from the disk. - - - - - Looks for an extension with the specified type and uses the DataContractSerializer to parse it. - - - - The deserialized extension. Null if an error occurs. - - - The containing element must use the name and namespace uri specified by the DataContractAttribute for the type. - - - - - Looks for an extension with the specified type and uses the DataContractSerializer to parse it. - - The type of extension. - Name of the element (null means use type name). - The extension if found. Null otherwise. - - - - Updates the extension. - - The type of extension. - Name of the element (null means use type name). - The value. - - - - Specifies various limits that apply to the transport or secure channel layers. - - - - - The default constructor. - - - - - Sets private members to default values. - - - - - Initializes the object during deserialization. - - The context. - - - - The default timeout to use when sending requests (in milliseconds). - - The operation timeout. - - - - The maximum length of string encoded in a message body. - - The max length of the string. - - - - The maximum length of a byte string encoded in a message body. - - The max length of the byte string. - - - - The maximum length of an array encoded in a message body. - - The max length of the array. - - - - The maximum length of a message body. - - The max size of the message. - - - - The maximum size of the buffer to use when sending messages. - - The max size of the buffer. - - - - The lifetime of a secure channel (in milliseconds). - - The channel lifetime. - - - - The lifetime of a security token (in milliseconds). - - The security token lifetime. - - - - Specifies parameters used for tracing. - - - Specifies parameters used for tracing. - - - - - The default constructor. - - - - - Sets private members to default values. - - - - - Initializes the object during deserialization. - - The context. - - - - The output file used to log the trace information. - - The output file path. - - - - Whether the existing log file should be deleted when the application configuration is loaded. - - true if existing log file should be deleted when the application configuration is loaded; otherwise, false. - - - - The masks used to select what is written to the output - Masks supported by the trace feature: - - Do not output any messages -None = 0x0; - - Output error messages - Error = 0x1; - - Output informational messages - Information = 0x2; - - Output stack traces - StackTrace = 0x4; - - Output basic messages for service calls - Service = 0x8; - - Output detailed messages for service calls - ServiceDetail = 0x10; - - Output basic messages for each operation - Operation = 0x20; - - Output detailed messages for each operation - OperationDetail = 0x40; - - Output messages related to application initialization or shutdown - StartStop = 0x80; - - Output messages related to a call to an external system - ExternalSystem = 0x100; - - Output messages related to security. - Security = 0x200; - - The trace masks. - - - - Applies the trace settings to the current process. - - - - - Specifies the configuration information for a transport protocol - - - Each application is allows to have one transport configure per protocol type. - - - - - The default constructor. - - - - - The default constructor. - - The URL scheme. - The type. - - - - The URL prefix used by the application (http, opc.tcp, net.tpc, etc.). - - The URI scheme. - - - - The name of the class that defines the binding for the transport. - - The name of the type. - - This can be any instance of the System.ServiceModel.Channels.Binding class - that implements these constructors: - - XxxBinding(EndpointDescription description, EndpointConfiguration configuration); - XxxBinding(IList{EndpointDescription} descriptions, EndpointConfiguration configuration) - XxxBinding(EndpointConfiguration configuration) - - - - - A collection of TransportConfiguration objects. - - - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - A collection of values to add to this new collection - - is null. - - - - - Initializes the collection with the specified capacity. - - The capacity. - - - - A class that defines a group of sampling rates supported by the server. - - - - - The default constructor. - - - - - Sets private members to default values. - - - - - Initializes the object during deserialization. - - The context. - - - - Calculates the security level, given the security mode and policy - Invalid and none is discouraged - Just signing is always weaker than any use of encryption - - - - - Specifies whether the messages are signed and encrypted or simply signed - - The security mode. - - - - The security policy to use. - - The security policy URI. - - - - A collection of ServerSecurityPolicy objects. - - - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - A collection of values to add to this new collection - - is null. - - - - - Initializes the collection with the specified capacity. - - The capacity. - - - - The security configuration for the application. - - - The security configuration for the application. - - - - - The default constructor. - - - - - Sets private members to default values. - - - - - Initializes the object during deserialization. - - - - - The application instance certificate. - - The application certificate. - - This certificate must contain the application uri. - For servers, URLs for each supported protocol must also be present. - - - - - The store containing any additional issuer certificates. - - - - - The trusted certificate store. - - - - - The length of nonce in the CreateSession service. - - - The length of nonce in the CreateSession service. - - - - - A store where invalid certificates can be placed for later review by the administrator. - - - A store where invalid certificates can be placed for later review by the administrator. - - - - - Gets or sets a value indicating whether untrusted certificates should be automatically accepted. - - - This flag can be set to by servers that allow anonymous clients or use user credentials for authentication. - It can be set by clients that connect to URLs specified in configuration rather than with user entry. - - - - - Gets or sets a directory which contains files representing users roles. - - - - - Gets or sets a value indicating whether SHA-1 signed certificates are accepted. - - - This flag can be set to false by servers that accept SHA-1 signed certificates. - - - - - Gets or sets a value indicating whether certificates with unavailable revocation lists are not accepted. - - - This flag can be set to true by servers that must have a revocation list for each CA (even if empty). - - - - - Gets or sets a value indicating which minimum certificate key strength is accepted. - - - This value can be set to 1024, 2048 or 4096 by servers - - - - - Gets or sets a value indicating whether the Validator skips the full chain validation - for already validated or accepted certificates. - - - This flag can be set to true by applications. - - - - - Gets or sets a value indicating whether the application cert should be copied to the trusted store. - - - It is useful for client/server applications running on the same host and sharing the cert store to autotrust. - - - - - Gets or sets a value indicating whether the application should send the complete certificate chain. - - - If set to true the complete certificate chain will be sent for CA signed certificates. - - - - - The store containing additional user issuer certificates. - - - - - The store containing trusted user certificates. - - - - - The store containing additional Https issuer certificates. - - - - - The store containing trusted Https certificates. - - - - - Gets or sets a value indicating whether the server nonce validation errors should be suppressed. - - - Allows client interoperability with legacy servers which do not comply with the specification for nonce usage. - If set to true the server nonce validation errors are suppressed. - Please set this flag to true only in close and secured networks since it can cause security vulnerabilities. - - - - - Adds a certificate as a trusted peer. - - - - - Validates the security configuration. - - - - - Ensure valid trust lists. - - - - - Get the provider which is invoked when a password - for a private key is requested. - - - - - A class that defines a group of sampling rates supported by the server. - - - - - The default constructor. - - - - - Creates a group with the specified settings. - - The start. - The increment. - The count. - - - - Sets private members to default values. - - - - - Initializes the object during deserialization. - - The context. - - - - The first sampling rate in the group (in milliseconds). - - The first sampling rate in the group (in milliseconds). - - - - The increment between sampling rates in the group (in milliseconds). - - The increment. - - An increment of 0 means the group only contains one sampling rate equal to the start. - - - - - The number of sampling rates in the group. - - The count. - - A count of 0 means there is no limit. - - - - - A collection of SamplingRateGroup objects. - - - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - A collection of values to add to this new collection - - is null. - - - - - Initializes the collection with the specified capacity. - - The capacity. - - - - Specifies the configuration for a server application. - - - Specifies the configuration for a server application. - - - - - The default constructor. - - - - - Sets private members to default values. - - - - - Initializes the object during deserialization. - - The context. - - - - Remove unsupported security policies and expand wild cards. - - - - - The base addresses for the server. - - The base addresses. - - The actually endpoints are constructed from the security policies. - On one base address per supported transport protocol is allowed. - - - - - Gets or sets the alternate base addresses. - - The alternate base addresses. - - These addresses are used to specify alternate paths to ther via firewalls, proxies - or similar network infrastructure. If these paths are specified in the configuration - file then the server will use the domain of the URL used by the client to determine - which, if any, or the alternate addresses to use instead of the primary addresses. - - - - - The security policies supported by the server. - - The security policies. - - An endpoint description is created for each combination of base address and security policy. - - - - - The minimum number of threads assigned to processing requests. - - The minimum request thread count. - - - - The maximum number of threads assigned to processing requests. - - The maximum request thread count. - - - - The maximum number of requests that will be queued waiting for a thread. - - The maximum queued request count. - - - - Validates the configuration. - - - - - Specifies the configuration for a server application. - - - Specifies the configuration for a server application. - - - - - The default constructor. - - - - - Sets private members to default values. - - - - - Initializes the object during deserialization. - - The context. - - - - The user tokens accepted by the server. - - The user token policies. - - - - Whether diagnostics are enabled. - - true if diagnostic is enabled; otherwise, false. - - - - The maximum number of open sessions. - - The maximum session count. - - - - That minimum period of that a session is allowed to remain - open without communication from the client (in milliseconds). - - The minimum session timeout. - - - - That maximum period of that a session is allowed to remain - open without communication from the client (in milliseconds). - - The maximum session timeout. - - - - The maximum number of continuation points used for - Browse/BrowseNext operations. - - The maximum number of continuation points used for Browse/BrowseNext operations - - - - The maximum number of continuation points used for - Query/QueryNext operations. - - The maximum number of query continuation points. - - - - The maximum number of continuation points used for HistoryRead operations. - - The maximum number of history continuation points. - - - - The maximum age of an incoming request (old requests are rejected) (in milliseconds). - - The maximum age of an incoming request. - - - - The minimum publishing interval supported by the server (in milliseconds). - - The minimum publishing interval. - - - - The maximum publishing interval supported by the server (in milliseconds). - - The maximum publishing interval. - - - - The minimum difference between supported publishing interval (in milliseconds). - - The publishing resolution. - - - - How long the subscriptions will remain open without a publish from the client. - - The maximum subscription lifetime. - - - - The maximum number of messages saved in the queue for each subscription. - - The maximum size of the message queue. - - - - The maximum number of notificates saved in the queue for each monitored item. - - The maximum size of the notification queue. - - - - The maximum number of notifications per publish. - - The maximum number of notifications per publish. - - - - The minimum sampling interval for metadata. - - The minimum sampling interval for metadata. - - - - The available sampling rates. - - The available sampling rates. - - - - The endpoint description for the registration endpoint. - - The registration endpoint. - - - - The maximum time between registration attempts (in milliseconds). - - The maximum time between registration attempts (in milliseconds). - - - - The path to the file containing nodes persisted by the core node manager. - - The path to the file containing nodes persisted by the core node manager. - - - - The minimum lifetime for a subscription (in milliseconds). - - The minimum lifetime for a subscription. - - - - The max publish request count. - - The max publish request count. - - - - The max subscription count. - - The max subscription count. - - - - The max size of the event queue. - - The max size of the event queue. - - - - The server profile array. - - The array of server profiles. - - - - The server shutdown delay. - - The number of seconds to delay the shutdown if a client is connected. - - - - The server capabilities. - The latest set of server capabilities is listed - here. - - The array of server capabilites. - - - - Gets or sets the supported private key format. - - The array of server profiles. - - - - Gets or sets the max size of the trust list. - - - - - Gets or sets if multicast DNS is enabled. - - - - - Gets or sets reverse connect server configuration. - - - - - Gets or sets the operation limits of the OPC UA Server. - - - - - Whether auditing is enabled. - - true if auditing is enabled; otherwise, false. - - - - Validates the configuration. - - - - - Stores the configuration of the reverse connections. - - - - - The default constructor. - - - - - Initializes the object during deserialization. - - - - - Sets private members to default values. - - - - - A collection of reverse connect clients. - - - - - The interval after which a new reverse connection is attempted. - - - - - The default timeout to wait for a response to a reverse connection. - - - - - The timeout to wait to establish a new reverse - connection after a rejected attempt. - - - - - Stores the operation limits of a OPC UA Server. - - - - - The default constructor. - - - - - Initializes the object during deserialization. - - - - - Sets private members to default values. - - - - - Indicates the maximum size of the nodesToRead array when a Client calls the Read Service. - - - - - Indicates the maximum size of the nodesToRead array when a Client calls the HistoryRead - Service using the historyReadDetails RAW, PROCESSED, MODIFIED or ATTIME. - - - - - Indicates the maximum size of the nodesToRead array when a Client calls the HistoryRead - Service using the historyReadDetails EVENTS. - - - - - Indicates the maximum size of the nodesToWrite array when a Client calls the Write Service. - - - - - Indicates the maximum size of the historyUpdateDetails array supported by the Server - when a Client calls the HistoryUpdate Service. - - - - - Indicates the maximum size of the historyUpdateDetails array - when a Client calls the HistoryUpdate Service. - - - - - Indicates the maximum size of the methodsToCall array when a Client calls the Call Service. - - - - - Indicates the maximum size of the nodesToBrowse array when calling the Browse Service - or the continuationPoints array when a Client calls the BrowseNext Service. - - - - - Indicates the maximum size of the nodesToRegister array when a Client calls the RegisterNodes Service - and the maximum size of the nodesToUnregister when calling the UnregisterNodes Service. - - - - - Indicates the maximum size of the browsePaths array when a Client calls the TranslateBrowsePathsToNodeIds Service. - - - - - Indicates the maximum size of the nodesToAdd array when a Client calls the AddNodes Service, - the maximum size of the referencesToAdd array when a Client calls the AddReferences Service, - the maximum size of the nodesToDelete array when a Client calls the DeleteNodes Service, - and the maximum size of the referencesToDelete array when a Client calls the DeleteReferences Service. - - - - - Indicates the maximum size of the itemsToCreate array when a Client calls the CreateMonitoredItems Service, - the maximum size of the itemsToModify array when a Client calls the ModifyMonitoredItems Service, - the maximum size of the monitoredItemIds array when a Client calls the SetMonitoringMode Service or the DeleteMonitoredItems Service, - the maximum size of the sum of the linksToAdd and linksToRemove arrays when a Client calls the SetTriggering Service. - - - - - Stores the configuration of the reverse connections. - - - - - The default constructor. - - - - - Initializes the object during deserialization. - - - - - Sets private members to default values. - - - - - The endpoint Url of the reverse connect client endpoint. - - - - - The timeout to wait for a response to a reverse connection. - Overrides the default reverse connection setting. - - - - - The maximum count of active reverse connect sessions. - 0 or undefined means unlimited number of sessions. - 1 means a single connection is created at a time. - n disables reverse hello once the total number of sessions - in the server reaches n. - - - - - Specifies whether the sending of reverse connect attempts is enabled. - - - - - A collection of reverse connect clients. - - - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - A collection of values to add to this new collection - - is null. - - - - - Initializes the collection with the specified capacity. - - The capacity. - - - - The configuration for a client application. - - - The configuration for a client application. - - - - - The default constructor. - - - - - Sets private members to default values. - - - - - Initializes the object during deserialization. - - The context. - - - - The default session timeout (in milliseconds). - - The default session timeout. - - - - The well known URLs for the local discovery servers. - - The well known discovery URLs. - - - - The endpoint descriptions for central discovery servers. - - The endpoint descriptions for central discovery servers. - - - - The path to the file containing the cached endpoints. - - The path to the file containing the cached endpoints. - - - - The minimum lifetime for a subscription (in milliseconds). - - The minimum lifetime for a subscription. - - - - The reverse connect Client configuration. - - - - - Gets or sets the default operation limits of the OPC UA client. - - - Values not equal to zero are overwritten with smaller values set by the server. - The values are used to limit client service calls. - - - - - Validates the configuration. - - - - - Stores the configuration of the reverse connections. - - - - - The default constructor. - - - - - Initializes the object during deserialization. - - - - - Sets private members to default values. - - - - - A collection of reverse connect client endpoints. - - - - - The time a reverse hello port is held open to wait for a - reverse connection until the request is rejected. - - - - - The timeout to wait for a reverse hello message. - - - - - Stores the configuration of the reverse connections. - - - - - The default constructor. - - - - - Initializes the object during deserialization. - - - - - Sets private members to default values. - - - - - The endpoint Url of a reverse connect client. - - - - - A collection of reverse connect client endpoints. - - - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - A collection of values to add to this new collection - - is null. - - - - - Initializes the collection with the specified capacity. - - The capacity. - - - - Specifies the configuration for a discovery server application. - - - - - The default constructor. - - - - - Sets private members to default values. - - - - - Initializes the object during deserialization. - - The context. - - - - The localized names for the discovery server. - - The server names. - - - - The path to the file containing servers saved by the discovery server. - - The discovery server cache file. - - - - Gets or sets the server registrations associated with the discovery server. - - The server registrations. - - - - Specifies the configuration for a discovery server application. - - - - - The default constructor. - - - - - Sets private members to default values. - - - - - Initializes the object during deserialization. - - The context. - - - - Gets or sets the application URI of the server which the registration applies to. - - The application uri. - - - - Gets or sets the alternate discovery urls. - - The alternate discovery urls. - - These addresses are used to specify alternate paths to ther via firewalls, proxies - or similar network infrastructure. If these paths are specified in the configuration - file then the server will use the domain of the URL used by the client to determine - which, if any, or the alternate addresses to use instead of the primary addresses. - - In the ideal world the server would provide these URLs during registration but this - table allows the administrator to provide the information to the disovery server - directly without requiring a patch to the server. - - - - - A collection of AdditionalServerRegistrationInfo objects. - - - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - A collection of values to add to this new collection - - is null. - - - - - Initializes the collection with the specified capacity. - - The capacity. - - - - Describes a certificate store. - - - Describes a certificate store. - - - - - The type of certificate store. - - - If the StoreName is not empty, the CertificateStoreType.X509Store is returned, otherwise the StoreType is returned. - - - - - The path that identifies the certificate store. - - - If the StoreName is not empty and the StoreLocation is empty, the Utils.Format("CurrentUser\\{0}", m_storeName) is returned. - If the StoreName is not empty and the StoreLocation is not empty, the Utils.Format("{1}\\{0}", m_storeName, m_storeLocation) is returned. - If the StoreName is empty, the m_storePath is returned. - - - - - The name of the certifcate store that contains the trusted certficates. - - - - - The location of the certifcate store that contains the trusted certficates. - - - - - Options that can be used to suppress certificate validation errors. - - - - - - - - Creates a new object that is a copy of the current instance. - - - - - Formats the value of the current instance using the specified format. - - The specifying the format to use. - -or- - null to use the default format defined for the type of the implementation. - The to use to format the value. - -or- - null to obtain the numeric format information from the current locale setting of the operating system. - - A containing the value of the current instance in the specified format. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - The path to the default PKI Root. - - - - - The path to the current user X509Store. - - - - - The path to the local machine X509Store. - - - - - Options that can be used to suppress certificate validation errors. - - - - - Detects the type of store represented by the path. - - - - - Returns an object that can be used to access the store. - - - - - Returns an object to access the store containing the certificates. - - - Opens an instance of the store which contains public keys. - - A disposable instance of the . - - - - Returns an object to access the store containing the certificates. - - - Opens an instance of the store which contains public keys. - - A disposable instance of the . - - - - A list of trusted certificates. - - - Administrators can create a list of trusted certificates by designating all certificates - in a particular certificate store as trusted and/or by explictly specifying a list of - individual certificates. - - A trust list can contain either instance certificates or certification authority certificates. - If the list contains instance certificates the application will trust peers that use the - instance certificate (provided the ApplicationUri and HostName match the certificate). - - If the list contains certification authority certificates then the application will trust - peers that have certificates issued by one of the authorities. - - Any certificate could be revoked by the issuer (CAs may issue certificates for other CAs). - The RevocationMode specifies whether this check should be done each time a certificate - in the list are used. - - - - - The default constructor. - - - - - Sets private members to default values. - - - - - Initializes the object during deserialization. - - - - - The list of trusted certificates. - - - The list of trusted certificates is set when TrustedCertificates is not a null value, otherwise new CertificateIdentifierCollection is set. - - - - - Returns an object to access the store containing the certificate of the trustlist. - - - Opens a cached instance of the store which contains public keys. - To take advantage of the certificate cache use - and let the CertificateTrustList handle the dispose. - Disposing the store has no functional impact but may - enforce unnecessary refresh of the cached certificate store. - - A disposable instance of the . - - - - Returns the certificates in the trust list. - - - - - A collection of CertificateIdentifier objects. - - - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - A collection of values to add to this new collection - - - - Initializes the collection with the specified capacity. - - - - - - - - Creates a new object that is a copy of the current instance. - - - A new object that is a copy of this instance. - - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - - The certificate identifier store ignores the location. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The identifier for an X509 certificate. - - - - - The default constructor. - - - - - Initializes the identifier with the raw data from a certificate. - - - - - Initializes the identifier with the raw data from a certificate. - - - - - Initializes the identifier with the raw data from a certificate. - - - - - Sets private members to default values. - - - - - Initializes the object during deserialization. - - - - - The type of certificate store. - - The type of the store - defined in the . - - - - The path that identifies the certificate store. - - The store path in the form StoreName\\Store Location . - - - - The name of the store that contains the certificate. - - The name of the store. - - - - - The location of the store that contains the certificate. - - The store location. - - - - - The certificate's subject name - the distinguished name of an X509 certificate. - - - The distinguished name of an X509 certificate acording to the Abstract Syntax Notation One (ASN.1) syntax. - - The subject field identifies the entity associated with the public key stored in the subject public - key field. The subject name MAY be carried in the subject field and/or the subjectAltName extension. - Where it is non-empty, the subject field MUST contain an X.500 distinguished name (DN). - Name is defined by the following ASN.1 structures: - Name ::= CHOICE {RDNSequence } - RDNSequence ::= SEQUENCE OF RelativeDistinguishedName - RelativeDistinguishedName ::= SET OF AttributeTypeAndValue - AttributeTypeAndValue ::= SEQUENCE {type AttributeType, value AttributeValue } - AttributeType ::= OBJECT IDENTIFIER - AttributeValue ::= ANY DEFINED BY AttributeType - DirectoryString ::= CHOICE { - teletexString TeletexString (SIZE (1..MAX)), - printableString PrintableString (SIZE (1..MAX)), - universalString UniversalString (SIZE (1..MAX)), - utf8String UTF8String (SIZE (1..MAX)), - bmpString BMPString (SIZE (1..MAX)) } - The Name describes a hierarchical name composed of attributes, such as country name, and - corresponding values, such as US. The type of the component AttributeValue is determined by - the AttributeType; in general it will be a DirectoryString. - String X.500 AttributeType: - - CN commonName - L localityName - ST stateOrProvinceName - O organizationName - OU organizationalUnitName - C countryName - STREET streetAddress - DC domainComponent - UID userid - - This notation is designed to be convenient for common forms of name. This section gives a few - examples of distinguished names written using this notation. First is a name containing three relative - distinguished names (RDNs): - CN=Steve Kille,O=Isode Limited,C=GB - - RFC 3280 Internet X.509 Public Key Infrastructure, April 2002 - RFC 2253 LADPv3 Distinguished Names, December 1997 - - - - - - - The certificate's thumbprint. - - The thumbprint of a certificate.. - - - - - Gets the DER encoded certificate data or create emebeded in this instance certifcate using the DER encoded certificate data. - - A byte array containing the X.509 certificate data. - - - - Gets or sets the XML encoded validation options - use to serialize the validation options. - - The XML encoded validation options. - - - - Formats the value of the current instance using the specified format. - - The specifying the format to use. - -or- - null to use the default format defined for the type of the implementation. - The to use to format the value. - -or- - null to obtain the numeric format information from the current locale setting of the operating system. - - A containing the value of the current instance in the specified format. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Returns true if the objects are equal. - - - - - Returns a suitable hash code. - - - - - - Gets or sets the validation options. - - - The validation options that can be used to suppress certificate validation errors. - - - - - Gets or sets the actual certificate. - - The X509 certificate used by this instance. - - - - Finds a certificate in a store. - - - - - Loads the private key for the certificate with an optional password. - - - - - Loads the private key for the certificate with an optional password. - - - - - Finds a certificate in a store. - - if set to true the returned certificate must contain the private key. - An instance of the that is embedded by this instance or find it in - the selected store pointed out by the using selected . - - - - Updates the object from another object (usage is not updated). - - The certificate. - - - - Returns a display name for a certificate. - - The certificate. - - A string containg FriendlyName of the or created using Subject of - the . - - - - - Finds a certificate in the specified collection. - - The collection. - The thumbprint of the certificate. - Subject name of the certificate. - if set to true [need private key]. - - - - - Creates a DER blob from a certificate with zero or more supporting certificates. - - The certificates list to be returned as raw data. - - A DER blob containing zero or more certificates. - - If the is null or empty. - - - - Parses a blob with a list of DER encoded certificates. - - The encoded data. - - An object of containing - certificates created from a buffer with DER encoded certificate - - - Any supporting certificates found in the buffer are processed as well. - - - - - Returns an object to access the store containing the certificate. - - - Opens a store which contains public and private keys. - - A disposable instance of the . - - - - Checks if the certificate data represents a valid X509v3 certificate header. - - The raw data of a object. - - true if is a valid certificate BLOB; otherwise, false. - - - - - Stores a list of cached enpoints. - - - Stores a list of cached enpoints. - - - - - The default constructor. - - - - - Called by the .NET framework during deserialization. - - - - - Sets private members to default values. - - - - - A list of known hosts that can be used for discovery. - - - - - The default configuration to use when connecting to an endpoint. - - - - - The URL of the UA TCP proxy server. - - - - - Initializes the object with its default endpoint configuration. - - - - - Initializes the object from an application configuration. - - - - - Loads a collection of endpoints from a file and overrides the endpoint configuration. - - - - - Loads a collection of endpoints from a file and overrides the endpoint configuration. - - - - - Loads a collection of endpoints from a file. - - - - - Loads a collection of endpoints from a stream. - - - - - Saves a collection of endpoints the file that it was loaded from. - - - - - Saves a collection of endpoints to a file. - - - - - Saves a collection of endpoints to a stream. - - - - - - - - Returns a deep copy of the collection. - - - - - Determines the index of a specific item in the . - - The object to locate in the . - - The index of if found in the list; otherwise, -1. - - - - - Inserts an item to the at the specified index. - - The zero-based index at which should be inserted. - The object to insert into the . - - is not a valid index in the . - The is read-only. - - - - Removes the item at the specified index. - - The zero-based index of the item to remove. - - is not a valid index in the . - The is read-only. - - - - Gets or sets the at the specified index. - - The at the index - - - - Removes all items from the . - - The is read-only. - - - - Determines whether the contains a specific value. - - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - - Copies the elements of the to an , starting at a particular index. - - The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. - The zero-based index in at which copying begins. - - is null. - - is less than 0. - - is multidimensional.-or- is equal to or greater than the length of .-or-The number of elements in the source is greater than the available space from to the end of the destination ./>. - - - - Gets the number of elements contained in the . - - The number of elements contained in the . - - - - Gets a value indicating whether the is read-only. - - - true if the is read-only; otherwise, false. - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Add the endpoint description to the cache. - - - - - Add the endpoint description and configuration to the cache. - - - - - Adds a previous created endpoint to the collection. - - - - - Adds a previous created endpoint to the collection. - - - - - Removes the configured endpoint. - - - - - Removes all endpoints for the specified server. - - - - - Updates the server descrption for the endpoints. - - - - - Creates a new endpoint from a url that is not part of the collection. - - - Call the Add() method to add it to the collection. - - - - - Returns the configured endpoints for the server uri. - - - - - Returns the servers that are part of the collection. - - - - - Copies the endpoints. - - The server URI. - - - - - Updates an endpoint with information from the server's discovery endpoint. - - - - - A list of well known urls that can be used for discovery. - - - - - The default configuration for new ConfiguredEndpoints. - - - - - Throws exceptions if the endpoint is not valid. - - - - - Stores the configuration information for an endpoint. - - - Stores the configuration information for an endpoint. - - - - - The default constructor. - - - - - Called by the .NET framework during deserialization. - - - - - Sets private members to default values. - - - - - The description for the endpoint. - - - - - The configuration to use when connecting to an endpoint. - - - - - Whether the endpoint information should be updated before connecting to the server. - - - - - The user identity to use when connecting to the endpoint. - - - - - The user identity to use when connecting to the endpoint. - - - - - The user identity to use when connecting to the endpoint. - - - - - The reverse connect information. - - - - - A bucket to store additional application specific configuration data. - - - - - Creates a configured endpoint from the server description. - - - - - The default constructor. - - - - - The default constructor. - - - - - - - - Returns a deep copy of the endpoint. - - - - - Returns the string representation of the object. - - - - - Returns the string representation of the object. - - (Unused). Always pass NULL/NOTHING - (Unused). Always pass NULL/NOTHING - Thrown if non-null parameters are used - - - - Determine if an update of the endpoint from the server is needed. - - - - - Updates the endpoint description. - - - - - Updates the endpoint description. - - - - - Updates the endpoint configuration. - - - - - Updates an endpoint with information from the server's discovery endpoint. - - - - - Updates an endpoint with information from the server's discovery endpoint. - - - - - Updates an endpoint with information from the server's discovery endpoint. - - - - - Updates an endpoint with information from the server's discovery endpoint. - - - - - Updates an endpoint with information from the server's discovery endpoint. - - - - - Updates an endpoint with information from the server's discovery endpoint. - - - - - Returns a discovery url that can be used to update the endpoint description. - - - - - Parses the extension. - - The type of extension. - Name of the element (null means use type name). - The extension if found. Null otherwise. - - - - Updates the extension. - - The type of extension. - Name of the element (null means use type name). - The value. - - - - The collection that the endpoint belongs to. - - - - - The URL used to create a sessions. - - - - - The user identity to use when connecting to the endpoint. - - - - - Select the best match from a security description. - - - - - The type of binary encoding support allowed by a channel. - - - - - The UA binary encoding may be used. - - - - - The UA binary encoding must be used. - - - - - The UA binary encoding may not be used. - - - - - Stores the reverse connect information for an endpoint. - - - - - The default constructor. - - - - - Called by the .NET framework during deserialization. - - - - - Sets private members to default values. - - - - - Whether reverse connect is enabled for the endpoint. - - - - - The server Uri of the endpoint. - - - - - The thumbprint of the certificate which contains - the server Uri. - - - - - Stores the security settings for an application. - - - - - The name of the application. - - - - - The uri of the application. - - - - - A store of certificates trusted by the application. - - - - - A list of certificates trusted by the application. - - - - - A store of certificate issuers used by the application. - - - - - A list of certificate issuers used by the application. - - - - - Casts a ApplicationType value. - - - - - Casts a ApplicationType value. - - - - - Creates a CertificateIdentifier object. - - - - - Creates a CertificateIdentifier object. - - - - - Creates a CertificateStoreIdentifier object. - - - - - Creates a CertificateTrustList object. - - - - - Creates a CertificateStoreIdentifier object. - - - - - Creates a CertificateTrustList object. - - - - - Creates a CertificateList object. - - - - - Creates a CertificateIdentifierCollection object. - - - - - Creates a ListOfBaseAddresses object. - - - - - Creates a ListOfBaseAddresses object. - - - - - Creates a ListOfSecurityProfiles object. - - - - - Creates a ServerSecurityPolicyCollection object. - - - - - Creates a new policy object. - Always uses sign and encrypt for all security policies except none - - - - - Creates a new policy object. - - - - - An identifier for a certificate. - - - - - Gets the certificate associated with the identifier. - - - - - Gets the certificate associated with the identifier. - - - - - Opens the certificate store. - - - - - An identifier for a certificate store. - - - - - Opens the certificate store. - - - - - A class which is used to report events which have security implications. - - - - - Called when a secure channel is created by the client. - - Information about the secure channel implementation. - The identifier assigned to the secure channel - The identifier assigned to the secure channel - The endpoint. - The client certificate. - The server certificate. - The type of encoding supported by the channel. - - - - Called when a secure channel is renewed by the client. - - Information about the secure channel implementation. - The identifier assigned to the secure channel. - - - - Implemented by types that have knownledge of an application configuration. - - - - - Exports the security configuration for an application identified by a file or url. - - The file path. - The security configuration. - - - - Updates the security configuration for an application identified by a file or url. - - The file path. - The configuration. - - - - A class used to create instances of ISecurityConfigurationManager. - - - - - Returns an instance of the type identified by the assembly qualified name. - - Name of the type. - The new instance. - - - - Provides access to security configuration for windows based .NET application. - - - - - Exports the security configuration for an application identified by a file or url. - - The file path. - The security configuration. - - - - Finds the specified parent. - - The parent. - Name of the local. - The namespace URI. - - - - - Updates the security configuration for an application identified by a file or url. - - The file path. - The configuration. - - - - Updates the XML document with the new configuration information. - - - - - Reads an object from the body of an XML element. - - - - - Reads an object from the body of an XML element. - - - - - - A set of nodes in an address space. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates an empty nodeset. - - - - - Loads a nodeset from a stream. - - The input stream. - The set of nodes - - - - Write a nodeset to a stream. - - The input stream. - - - - Adds an alias to the node set. - - - - - Imports a node from the set. - - - - - Adds a node to the set. - - - - - Creates an encoder to save Variant values. - - - - - Creates an decoder to restore Variant values. - - - - - Imports a node from the set. - - - - - Exports a NodeId as an alias. - - - - - Exports a NodeId - - - - - Imports a NodeId - - - - - Exports a ExpandedNodeId - - - - - Imports a ExpandedNodeId - - - - - Exports a QualifiedName - - - - - Exports a DataTypeDefinition - - - - - Imports a DataTypeDefinition - - - - - Imports a QualifiedName - - - - - Exports the array dimensions. - - - - - Imports the array dimensions. - - - - - Exports localized text. - - - - - Exports localized text. - - - - - Imports localized text. - - - - - Exports a namespace index. - - - - - Exports a namespace index. - - - - - Exports a namespace uri. - - - - - Exports a server index. - - - - - Exports a server index. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates certificates. - - - - - The default key size for RSA certificates in bits. - - - Supported values are 1024(deprecated), 2048, 3072 or 4096. - - - - - The default hash size for RSA certificates in bits. - - - Supported values are 160 for SHA-1(deprecated) or 256, 384 and 512 for SHA-2. - - - - - The default lifetime of certificates in months. - - - - - Creates a certificate from a buffer with DER encoded certificate. - - The encoded data. - if set to true the copy of the certificate in the cache is used. - The certificate. - - - - Loads the cached version of a certificate. - - The certificate to load. - If true a key container is created for a certificate that must be deleted by calling Cleanup. - The cached certificate. - - This function is necessary because all private keys used for cryptography - operations must be in a key container. - Private keys stored in a PFX file have no key container by default. - - - - - Create a certificate for any use. - - The subject of the certificate - Return the Certificate builder. - - - - Create a certificate for an OPC UA application. - - The application Uri - The friendly name of the application - The subject of the certificate - The domain names for the alt name extension - - Return the Certificate builder with X509 Subject Alt Name extension - to create the certificate. - - - - - Creates a self-signed, signed or CA certificate. - - Type of certificate store (Directory) . - The store path (syntax depends on storeType). - The password to use to protect the certificate. - The application uri (created if not specified). - Name of the application (optional if subjectName is specified). - The subject used to create the certificate (optional if applicationName is specified). - The domain names that can be used to access the server machine (defaults to local computer name if not specified). - Size of the key (1024, 2048 or 4096). - The start time. - The lifetime of the key in months. - The hash size in bits. - if set to true then a CA certificate is created. - The CA cert with the CA private key. - The public key if no new keypair is created. - The path length constraint for CA certs. - The certificate with a private key. - - - - Revoke the certificate. - The CRL number is increased by one and the new CRL is returned. - - - - - Revoke the certificates. - - - Merge all existing revoked certificates from CRL list. - Add serialnumbers of new revoked certificates. - The CRL number is increased by one and the new CRL is returned. - - - - - Creates a certificate signing request from an existing certificate. - - - - - Create a X509Certificate2 with a private key by combining - the new certificate with a private key from an existing certificate - - - - - Create a X509Certificate2 with a private key by combining - the certificate with a private key from a PEM stream - - - - - Creates a self-signed, signed or CA certificate. - - The application uri (created if not specified). - Name of the application (optional if subjectName is specified). - The subject used to create the certificate (optional if applicationName is specified). - The domain names that can be used to access the server machine (defaults to local computer name if not specified). - Size of the key (1024, 2048 or 4096). - The start time. - The lifetime of the key in months. - The hash size in bits. - if set to true then a CA certificate is created. - The CA cert with the CA private key. - The public key if no new keypair is created. - The path length constraint for CA certs. - The certificate with a private key. - - - - Sets the parameters to suitable defaults. - - - - - Options that can be used to suppress certificate validation errors. - - - - - Use the default options. - - - - - Ignore expired certificates. - - - - - Ignore mismatches between the URL and the DNS names in the certificate. - - - - - Ignore errors when it is not possible to check the revocation status for a certificate. - - - - - Attempt to check the revocation status online. - - - - - Attempt to check the revocation status offline. - - - - - Never trust the certificate. - - - - - An interface for a password provider for certificate private keys. - - - - - Return the password for a certificate private key. - - The certificate identifier for which the password is needed. - - - - The default certificate password provider implementation. - - - - - Constructor which takes a password string. - - - - - - Return the password used for the certificate. - - - - - The type of certificate store. - - - - - Registers a new certificate store type that con be specified in config files. - - The name of the store type. - - - - - A windows certificate store. - - - - - A directory certificate store. - - - - - Validates certificates. - - - - - The default constructor. - - - - - Raised when a certificate validation error occurs. - - - - - Raised when an application certificate update occurs. - - - - - Updates the validator with the current state of the configuration. - - - - - Updates the validator with a new set of trust lists. - - - - - Updates the validator with the current state of the configuration. - - - - - Updates the validator with a new application certificate. - - - - - Reset the list of validated certificates. - - - - - If untrusted certificates should be accepted. - - - - - If certificates using a SHA1 signature should be trusted. - - - - - if certificates with unknown revocation status should be rejected. - - - - - The minimum size of a certificate key to be trusted. - - - - - Opt-In to use the already validated certificates for validation. - - - - - Validates the specified certificate against the trust list. - - The certificate. - - - - Validates a certificate. - - - Each UA application may have a list of trusted certificates that is different from - all other UA applications that may be running on the same machine. As a result, the - certificate validator cannot rely completely on the Windows certificate store and - user or machine specific CTLs (certificate trust lists). - - - - - Validates a certificate with domain validation check. - - - - - - Recursively checks whether any of the service results or inner service results - of the input sr must not be suppressed. - The list of supressible status codes is - for backwards compatibiliyt - longer - than the spec would imply. - (BadCertificateUntrusted and BadCertificateChainIncomplete - must not be supressed according to (e.g.) version 1.04 of the spec) - - - - - - List all reasons for failing cert validation. - - - - - Saves the certificate in the rejected certificate store. - - - - - Saves the certificate chain in the rejected certificate store. - - - - - Returns the certificate information for a trusted peer certificate. - - - - - Returns true if the certificate matches the criteria. - - - - - Returns the issuers for the certificates. - - - - - Returns the issuers for the certificates. - - - - - Returns the issuers for the certificate. - - The certificate. - The issuers. - - - - Returns the certificate information for a trusted issuer certificate. - - - - - Returns the certificate information for a trusted issuer certificate. - - - - - Throws an exception if validation fails. - - The certificates to be checked. - The endpoint for domain validation. - If certificate[0] cannot be accepted - - - - Returns an object that can be used with a UA channel. - - - - - Validate domains in a server certificate against endpoint used for connection. - A url mismatch can be accepted by the certificate validation event, - otherwise an exception is thrown. - - - On a client: the endpoint is only checked if the certificate is not already validated. - A rejected server certificate is saved. - On a server: the endpoint is always checked but the certificate is not saved. - - The server certificate which contains the list of domains. - The endpoint used to connect to a server. - if the domain validation is called by a server or client. - - if the endpoint can not be found in the list of domais in the certificate. - - - - - Returns an error if the chain status elements indicate an error. - - - - - Returns if a certificate is signed with a SHA1 algorithm. - - - - - Returns a certificate information message. - - - - - Returns if a self signed certificate is properly signed. - - - - - The list of suppressible status codes. - - - - - Find the domain in a certificate in the - endpoint that was used to connect a session. - - The server certificate which is tested for domain names. - The endpoint which was used to connect. - True if domain was found. - - - - Flag to protect setting by application - from a modification by a SecurityConfiguration. - - - - - The event arguments provided when a certificate validation error occurs. - - - - - Creates a new instance. - - - - - The error that occurred. - - - - - The certificate. - - - - - Whether the current error reported for - a certificate should be accepted and suppressed. - - - - - Whether all the errors reported for - a certificate should be accepted and suppressed. - - - - - The custom error message from the application. - - - - - Used to handled certificate validation errors. - - - - - The event arguments provided when a certificate validation error occurs. - - - - - Creates a new instance. - - - - - The new security configuration. - - - - - The new certificate validator. - - - - - Used to handle certificate update events. - - - - - Provides access to a simple file based certificate store. - - - - - Initializes a store for a directory path. - - - - - Initializes a store with a directory path. - - - - - May be called by the application to clean up resources. - - - - - Cleans up all resources held by the object. - - - - - The directory containing the certificate store. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Returns the path to the public key file. - - The thumbprint of the certificate. - The path. - - - - Returns the path to the private key file. - - The thumbprint of the certificate. - The path. - - - - - - - Loads the private key from a PFX/PEM file in the certificate store. - - - - - - - - - - - - - - - - - - - - - - - Gets or sets a value indicating whether any private keys are found in the store. - - - true if [no private keys]; otherwise, false. - - - - - Reads the current contents of the directory from disk. - - - - - Finds the public key for the certificate. - - - - - Returns the file name to use for the certificate. - - - - - Writes the data to a file. - - - - - Stores a block of encypted data. - - - - - The algorithm used to encrypt the data. - - - - - The encrypted data. - - - - - An abstract interface to certficate stores. - - - - - Opens the store at the specified location. - - The location. - Indicates whether NO private keys are found in the store. Default true. - - The syntax depends on the store implementation. - - - - - Closes the store. - - - - - The store type. - - - - - The store path used to open the store. - - - - - Enumerates the certificates in the store. - - - - - Adds a certificate to the store. - - The certificate. - The certificate password. - - - - Deletes a certificate from the store. - - The thumbprint. - True if the certificate exists. - - - - Finds the certificate with the specified thumprint. - - The thumbprint. - The matching certificate - - - - If the store supports the LoadPrivateKey operation. - - - - - Finds the certificate with the specified thumprint. - - The thumbprint. - The certificate subject. - The certificate password. - Returns always null if SupportsLoadPrivateKey returns false. - The matching certificate with private key - - - - Checks if issuer has revoked the certificate. - - - - - Whether the store supports CRLs. - - - - - Returns the CRLs in the store. - - - - - Returns the CRLs for the issuer. - - - - - Adds a CRL to the store. - - - - - Removes a CRL from the store. - - - - - Supports implementation for custom certificate store type. - - - - - Determines if the store path is supported by the store type. - - The store path to examine. - if the store type supports the given store path, otherwise . - - - - Creates a new certificate store. - - A reference to the new certificate store object - - - - An abstract interface to the certificate validator. - - - - - Validates a certificate. - - - - - Validates a certificate chain. - - - - - Defines internal functions to implement RSA cryptography. - - - - - Return the plaintext block size for RSA OAEP encryption. - - - - - Return the plaintext block size for RSA OAEP encryption. - - - - - Return the ciphertext block size for RSA OAEP encryption. - - - - - Return the ciphertext block size for RSA OAEP encryption. - - - - - Returns the length of a RSA PKCS#1 v1.5 signature of a digest. - - - - - Computes a RSA signature. - - - - - Verifies a RSA signature. - - - - - Encrypts the data using RSA encryption. - - - - - Encrypts the data using RSA PKCS#1 v1.5 or OAEP encryption. - - - - - Decrypts the data using RSA encryption. - - - - - Decrypts the message using RSA encryption. - - - - - Helper to test for RSASignaturePadding.Pss support, some platforms do not support it. - - - - - Lazy helper to allow runtime to check for Pss support. - - - - - Provides access to a simple X509Store based certificate store. - - - - - Create an instance of the certificate store. - - - - - - - - Dispose method for derived classes. - - - - - - Syntax: StoreLocation\StoreName - Example: - CurrentUser\My - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The LoadPrivateKey special handling is not necessary in this store. - - - - CRLs are not supported here. - - - - CRLs are not supported here. - - - - CRLs are not supported here. - - - - CRLs are not supported here. - - - - CRLs are not supported here. - - - - CRLs are not supported here. - - - - Utility functions for X509 certificates. - - - - - Extracts the DNS names specified in the certificate. - - The certificate. - The DNS names. - - - - Returns the size of the public key and disposes RSA key. - - The certificate - - - - Extracts the application URI specified in the certificate. - - The certificate. - The application URI. - - - - Check if certificate has an application urn. - - The certificate. - true if the application URI starts with urn: - - - - Checks that the domain in the URL provided matches one of the domains in the certificate. - - The certificate. - The endpoint url to verify. - True if the certificate matches the url. - - - - Determines whether the certificate is allowed to be an issuer. - - - - - Determines whether the certificate is issued by a Certificate Authority. - - - - - Return the key usage flags of a certificate. - - - - - Check for self signed certificate if there is match of the Subject/Issuer. - - The certificate to test. - True if self signed. - - - - Compares two distinguished names. - - - - - Compares two distinguished names as strings. - - - Where possible, distinguished names should be compared - by using the version. - - - - - Compares string fields of two distinguished names. - - - - - Compares two distinguished names. - - - - - Parses a distingushed name. - - - - - Verify RSA key pair of two certificates. - - - - - Verify the signature of a self signed certificate. - - - - - Creates a certificate from a PKCS #12 store with a private key. - - The raw PKCS #12 store data. - The password to use to access the store. - The certificate with a private key. - - - - Get the certificate by issuer and serial number. - - - - - Extension to add a certificate to a . - - - Saves also the private key, if available. - If written to a Pfx file, the password is used for protection. - - The certificate to store. - Type of certificate store (Directory) . - The store path (syntax depends on storeType). - The password to use to protect the certificate. - - - - - Get the hash algorithm from the hash size in bits. - - - - - - Create secure temporary passcode. - - - - - Defines constants for key security policies. - - - - - The HMAC-SHA1 algorithm used to create symmetric key signatures. - - - - - The HMAC-SHA256 algorithm used to create symmetric key signatures. - - - - - The RSA-SHA1 algorithm used to create asymmetric key signatures. - - - - - The RSA-SHA256 algorithm used to create asymmetric key signatures. - - - - - The RSA-PSS-SHA256 algorithm used to create asymmetric key signatures. - - - - - The AES128 algorithm used to encrypt data. - - - - - The AES256 algorithm used to encrypt data. - - - - - The RSA-OAEP algorithm used to encrypt data. - - - - - The RSA-OAEP-SHA256 algorithm used to encrypt data. - - - - - The RSA-PKCSv1.5 algorithm used to encrypt data. - - - - - The RSA-PKCSv1.5 SHA256 algorithm used to encrypt data. - - - - - The RSA-OAEP algorithm used to encrypt keys. - - - - - The RSA-PKCSv1.5 algorithm used to encrypt keys. - - - - - The P-SHA1 algorithm used to generate keys. - - - - - The P-SHA256 algorithm used to generate keys. - - - - - Common profiles that UA applications may support. - - - - - Communicates with UA TCP, UA Security and UA Binary. - - - - - Communicates with UA TCP over secure Websockets, UA Security and UA Binary. - - - - - Communicates with UA Binary over HTTPS. - - - - - Uri for "PubSub UDP UADP" Profile. - This PubSub transport Facet defines a combination of the UDP transport protocol mapping with UADP message mapping - - - - - Uri for "PubSub MQTT UADP" Profile. - This PubSub transport Facet defines a combination of the MQTT transport protocol mapping with UADP message mapping. - This Facet is used for broker-based messaging. - - - - - Uri for "PubSub MQTT JSON" Profile. - This PubSub transport Facet defines a combination of the MQTT transport protocol mapping with JSON message mapping. - This Facet is used for broker-based messaging. - - - - - An Issued User Token that complies with the JWT specification. - - - - - The security policy header used by the Https transport. - - - - - Converts the URI to a URI that can be used for comparison. - - The profile URI. - The normalixed URI. - - - - Defines constants for key security policies. - - - - - The base URI for all policy URIs. - - - - - The URI for a policy that uses no security. - - - - - The URI for the Basic128Rsa15 security policy. - - - - - The URI for the Basic256 security policy. - - - - - The URI for the Aes128_Sha256_RsaOaep security policy. - - - - - The URI for the Basic256Sha256 security policy. - - - - - The URI for the Aes256_Sha256_RsaPss security policy. - - - - - The URI for the Https security policy. - - - - - Returns the uri associated with the display name. - - - - - Returns a display name for a security policy uri. - - - - - Returns the display names for all security policy uris. - - - - - Returns the default security policy uri. - - - - - Encrypts the text using the SecurityPolicyUri and returns the result. - - - - - Decrypts the CipherText using the SecurityPolicyUri and returns the PlainTetx. - - - - - Signs the data using the SecurityPolicyUri and returns the signature. - - - - - Verifies the signature using the SecurityPolicyUri and return true if valid. - - - - - The client side interface with a UA server. - - - - - Intializes the object with a channel and a message context. - - The channel. - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - The description of the endpoint. - - - - - The configuration for the endpoint. - - - - - The message context used when serializing messages. - - The message context. - - - - Gets or set the channel being wrapped by the client object. - - The transport channel. - - - - The channel being wrapped by the client object. - - - - - What diagnostics the server should return in the response. - - The diagnostics. - - - - Sets the timeout for an operation. - - - - - Gets a value that indicates whether to use the TransportChannel when sending requests. - - - - - Attach the channel to an already created client. - - Channel to be used by the client - - - - Detach the channel. - - - - - Closes the channel. - - - - - Whether the object has been disposed. - - true if disposed; otherwise, false. - - - - Generates a unique request handle. - - - - - Initializes the channel. - - - - - - Closes the channel. - - - - - Disposes the channel. - - - - - An object used to synchronize access to the session state. - - The synchronization object. - - - - The authorization token used to connect to the server. - - The authentication token. - - - - Updates the header of a service request. - - The request. - - - - Updates the header of a service request. - - The request. - if set to true use defaults]. - - - - Updates the header of a service request. - - The request. - if set to true the no request header was provided. - The name of the service. - - - - Called when a request completes. - - The request. - The response. - The name of the service. - - - - Creates an audit log entry for the request. - - The request. - log entry - - - - Throws an exception if a response contains an error. - - The header. - - - - Validates a response returned by the server. - - The response. - The request. - - - - Validates a response returned by the server. - - The response. - The request. - - - - Converts a service response to a ServiceResult object. - - The status code. - The index. - The diagnostic information. - The response header. - Converted service response. - - - - Validates a DataValue returned from the server. - - The value. - The expected type. - The index. - The diagnostic information. - The response header. - Result of the vaidation - - - - An object used by clients to access a UA discovery service. - - - The client side interface for a UA server. - - - - - - Creates a binding for to use for discovering servers. - - - - - Creates a binding for to use for discovering servers. - - - - - Creates a binding for to use for discovering servers. - - - - - Creates a binding for to use for discovering servers. - - The discovery URL. - - - - - Creates a binding for to use for discovering servers. - - The discovery URL. - The configuration. - - - - - Creates a binding for to use for discovering servers. - - - - - Creates a binding for to use for discovering servers. - - The discovery URL. - The endpoint configuration. - /// The application configuration. - - - - - Invokes the GetEndpoints service. - - The collection of profile URIs. - - - - - Invokes the GetEndpoints service async. - - The collection of profile URIs. - The cancellation token. - - - - Invokes the FindServers service. - - The collection of server URIs. - - - - - Invokes the FindServers service async. - - The collection of server URIs. - The cancellation token. - - - - - Invokes the FindServersOnNetwork service. - - - - - - - - - - Patch returned endpoints urls with url used to reached the endpoint. - - - - - Intializes the object with a channel and a message context. - - - - - The component contains classes object use to communicate with the server. - - - - - Invokes the FindServers service. - - - - - Begins an asynchronous invocation of the FindServers service. - - - - - Finishes an asynchronous invocation of the FindServers service. - - - - - Invokes the FindServers service using async Task based request. - - - - - Invokes the FindServersOnNetwork service. - - - - - Begins an asynchronous invocation of the FindServersOnNetwork service. - - - - - Finishes an asynchronous invocation of the FindServersOnNetwork service. - - - - - Invokes the FindServersOnNetwork service using async Task based request. - - - - - Invokes the GetEndpoints service. - - - - - Begins an asynchronous invocation of the GetEndpoints service. - - - - - Finishes an asynchronous invocation of the GetEndpoints service. - - - - - Invokes the GetEndpoints service using async Task based request. - - - - - A channel object used by clients to access a UA discovery service. - - - A channel object used by clients to access a UA service. - - - - - - Creates a new transport channel that supports the ISessionChannel service contract. - - The discovery url. - The configuration to use with the endpoint. - The message context to use when serializing the messages. - The client certificate to use. - - - - - Creates a new transport channel that supports the ITransportWaitingConnection service contract. - - - - - Creates a new transport channel that supports the IDiscoveryChannel service contract. - - - - - Initializes the object with the endpoint address. - - - - - The client side implementation of the FindServers service contract. - - - - - The client side implementation of the BeginFindServers service contract. - - - - - The client side implementation of the EndFindServers service contract. - - - - - The async client side implementation of the FindServers service contract. - - - - - The client side implementation of the FindServersOnNetwork service contract. - - - - - The client side implementation of the BeginFindServersOnNetwork service contract. - - - - - The client side implementation of the EndFindServersOnNetwork service contract. - - - - - The async client side implementation of the FindServersOnNetwork service contract. - - - - - The client side implementation of the GetEndpoints service contract. - - - - - The client side implementation of the BeginGetEndpoints service contract. - - - - - The client side implementation of the EndGetEndpoints service contract. - - - - - The async client side implementation of the GetEndpoints service contract. - - - - - The base interface for client proxies. - - - - - Returns true if the channel uses the UA Binary encoding. - - - - - Schedules an outgoing request. - - The request. - - - - The operation contract for the InvokeService service. - - - - - The operation contract for the InvokeService service. - - - - - The method used to retrieve the results of a InvokeService service request. - - - - - An interface to an object that manages a request received from a client. - - - - - Gets the request. - - The request. - - - - Gets the handler that must be used to send the request. - - The send request handler. - - - - Used to call the default synchronous handler. - - - This method may block the current thread so the caller must not call in the - thread that calls IServerBase.ScheduleIncomingRequest(). - This method always traps any exceptions and reports them to the client as a fault. - - - - - Used to indicate that the asynchronous operation has completed. - - The response. May be null if an error is provided. - An error to result as a fault. - - - - A delegate used to dispatch outgoing service requests. - - - - - The client side interface with a UA server. - - - - - The description of the endpoint. - - - - - The configuration for the endpoint. - - - - - The message context used when serializing messages. - - The message context. - - - - Gets or set the channel being wrapped by the client object. - - The transport channel. - - - - What diagnostics the server should return in the response. - - The diagnostics. - - - - Sets the timeout for an operation. - - - - - Whether the object has been disposed. - - true if disposed; otherwise, false. - - - - Attach the channel to an already created client. - - Channel to be used by the client - - - - Detach the channel. - - - - - Closes the channel. - - - - - Generates a unique request handle. - - - - - The message contract for the InvokeService service. - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - The invoke service request. - - - - The message contract for the InvokeService service response. - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - The invoke service response. - - - - An interface to a service request. - - - - - The header for the request. - - The request header. - - - - An interface to a service response. - - - - - The header for the response. - - The response header. - - - - An interface to a service message. - - - - - Returns the request contained in the message. - - - - - - Creates an instance of a response message. - - The response. - - - - - The client side interface for a UA server. - - - - - The server assigned identifier for the current session. - - The session id. - - - - Whether a session has beed created with the server. - - true if connected; otherwise, false. - - - - An interface to an object with stores the identity of a user. - - - - - A display name that identifies the user. - - The display name. - - - - The user token policy. - - The user token policy. - - - - The type of identity token used. - - The type of the token. - - - - The type of issued token. - - The type of the issued token. - - - - Whether the object can create signatures to prove possession of the user's credentials. - - true if signatures are supported; otherwise, false. - - - - Get or sets the list of granted role ids associated to the UserIdentity. - - - - - Returns a UA user identity token containing the user information. - - UA user identity token containing the user information. - - - - An object used by clients to access a UA discovery service. - - - The client side interface for a UA server. - - - - - - Creates a binding for to use for discovering servers. - - The configuration. - The description. - The endpoint configuration. - The instance certificate. - - - - - Intializes the object with a channel and a message context. - - - - - The component contains classes object use to communicate with the server. - - - - - Invokes the RegisterServer service. - - - - - Begins an asynchronous invocation of the RegisterServer service. - - - - - Finishes an asynchronous invocation of the RegisterServer service. - - - - - Invokes the RegisterServer service using async Task based request. - - - - - Invokes the RegisterServer2 service. - - - - - Begins an asynchronous invocation of the RegisterServer2 service. - - - - - Finishes an asynchronous invocation of the RegisterServer2 service. - - - - - Invokes the RegisterServer2 service using async Task based request. - - - - - A channel object used by clients to access a UA discovery service. - - - A channel object used by clients to access a UA service. - - - - - - Creates a new transport channel that supports the IRegistrationChannel service contract. - - The application configuration. - The description for the endpoint. - The configuration to use with the endpoint. - The client certificate. - The message context to use when serializing the messages. - - - - - Initializes the object with the endpoint address. - - - - - The client side implementation of the RegisterServer service contract. - - - - - The client side implementation of the BeginRegisterServer service contract. - - - - - The client side implementation of the EndRegisterServer service contract. - - - - - The async client side implementation of the RegisterServer service contract. - - - - - The client side implementation of the RegisterServer2 service contract. - - - - - The client side implementation of the BeginRegisterServer2 service contract. - - - - - The client side implementation of the EndRegisterServer2 service contract. - - - - - The async client side implementation of the RegisterServer2 service contract. - - - - - Reverse Connect Client Host. - - - - - Creates a new reverse listener host for a client. - - - - - The Url which is used by the transport listener. - - - - - Opens a reverse listener host. - - - - - Close the reverse connect listener. - - - - - A channel object used by clients to access a UA service. - - - A channel object used by clients to access a UA service. - - - - - - Creates a new transport channel that supports the ISessionChannel service contract. - - The application configuration. - The description for the endpoint. - The configuration to use with the endpoint. - The client certificate. - The message context to use when serializing the messages. - - - - - Creates a new transport channel that supports the ISessionChannel service contract. - - The application configuration. - The description for the endpoint. - The configuration to use with the endpoint. - The client certificate. - The client certificate chain. - The message context to use when serializing the messages. - - - - - Creates a new transport channel that supports the ISessionChannel service contract. - - The application configuration. - - The description for the endpoint. - The configuration to use with the endpoint. - The client certificate. - The client certificate chain. - The message context to use when serializing the messages. - - - - - Initializes the object with the endpoint address. - - - - - The client side implementation of the CreateSession service contract. - - - - - The client side implementation of the BeginCreateSession service contract. - - - - - The client side implementation of the EndCreateSession service contract. - - - - - The async client side implementation of the CreateSession service contract. - - - - - The client side implementation of the ActivateSession service contract. - - - - - The client side implementation of the BeginActivateSession service contract. - - - - - The client side implementation of the EndActivateSession service contract. - - - - - The async client side implementation of the ActivateSession service contract. - - - - - The client side implementation of the CloseSession service contract. - - - - - The client side implementation of the BeginCloseSession service contract. - - - - - The client side implementation of the EndCloseSession service contract. - - - - - The async client side implementation of the CloseSession service contract. - - - - - The client side implementation of the Cancel service contract. - - - - - The client side implementation of the BeginCancel service contract. - - - - - The client side implementation of the EndCancel service contract. - - - - - The async client side implementation of the Cancel service contract. - - - - - The client side implementation of the AddNodes service contract. - - - - - The client side implementation of the BeginAddNodes service contract. - - - - - The client side implementation of the EndAddNodes service contract. - - - - - The async client side implementation of the AddNodes service contract. - - - - - The client side implementation of the AddReferences service contract. - - - - - The client side implementation of the BeginAddReferences service contract. - - - - - The client side implementation of the EndAddReferences service contract. - - - - - The async client side implementation of the AddReferences service contract. - - - - - The client side implementation of the DeleteNodes service contract. - - - - - The client side implementation of the BeginDeleteNodes service contract. - - - - - The client side implementation of the EndDeleteNodes service contract. - - - - - The async client side implementation of the DeleteNodes service contract. - - - - - The client side implementation of the DeleteReferences service contract. - - - - - The client side implementation of the BeginDeleteReferences service contract. - - - - - The client side implementation of the EndDeleteReferences service contract. - - - - - The async client side implementation of the DeleteReferences service contract. - - - - - The client side implementation of the Browse service contract. - - - - - The client side implementation of the BeginBrowse service contract. - - - - - The client side implementation of the EndBrowse service contract. - - - - - The async client side implementation of the Browse service contract. - - - - - The client side implementation of the BrowseNext service contract. - - - - - The client side implementation of the BeginBrowseNext service contract. - - - - - The client side implementation of the EndBrowseNext service contract. - - - - - The async client side implementation of the BrowseNext service contract. - - - - - The client side implementation of the TranslateBrowsePathsToNodeIds service contract. - - - - - The client side implementation of the BeginTranslateBrowsePathsToNodeIds service contract. - - - - - The client side implementation of the EndTranslateBrowsePathsToNodeIds service contract. - - - - - The async client side implementation of the TranslateBrowsePathsToNodeIds service contract. - - - - - The client side implementation of the RegisterNodes service contract. - - - - - The client side implementation of the BeginRegisterNodes service contract. - - - - - The client side implementation of the EndRegisterNodes service contract. - - - - - The async client side implementation of the RegisterNodes service contract. - - - - - The client side implementation of the UnregisterNodes service contract. - - - - - The client side implementation of the BeginUnregisterNodes service contract. - - - - - The client side implementation of the EndUnregisterNodes service contract. - - - - - The async client side implementation of the UnregisterNodes service contract. - - - - - The client side implementation of the QueryFirst service contract. - - - - - The client side implementation of the BeginQueryFirst service contract. - - - - - The client side implementation of the EndQueryFirst service contract. - - - - - The async client side implementation of the QueryFirst service contract. - - - - - The client side implementation of the QueryNext service contract. - - - - - The client side implementation of the BeginQueryNext service contract. - - - - - The client side implementation of the EndQueryNext service contract. - - - - - The async client side implementation of the QueryNext service contract. - - - - - The client side implementation of the Read service contract. - - - - - The client side implementation of the BeginRead service contract. - - - - - The client side implementation of the EndRead service contract. - - - - - The async client side implementation of the Read service contract. - - - - - The client side implementation of the HistoryRead service contract. - - - - - The client side implementation of the BeginHistoryRead service contract. - - - - - The client side implementation of the EndHistoryRead service contract. - - - - - The async client side implementation of the HistoryRead service contract. - - - - - The client side implementation of the Write service contract. - - - - - The client side implementation of the BeginWrite service contract. - - - - - The client side implementation of the EndWrite service contract. - - - - - The async client side implementation of the Write service contract. - - - - - The client side implementation of the HistoryUpdate service contract. - - - - - The client side implementation of the BeginHistoryUpdate service contract. - - - - - The client side implementation of the EndHistoryUpdate service contract. - - - - - The async client side implementation of the HistoryUpdate service contract. - - - - - The client side implementation of the Call service contract. - - - - - The client side implementation of the BeginCall service contract. - - - - - The client side implementation of the EndCall service contract. - - - - - The async client side implementation of the Call service contract. - - - - - The client side implementation of the CreateMonitoredItems service contract. - - - - - The client side implementation of the BeginCreateMonitoredItems service contract. - - - - - The client side implementation of the EndCreateMonitoredItems service contract. - - - - - The async client side implementation of the CreateMonitoredItems service contract. - - - - - The client side implementation of the ModifyMonitoredItems service contract. - - - - - The client side implementation of the BeginModifyMonitoredItems service contract. - - - - - The client side implementation of the EndModifyMonitoredItems service contract. - - - - - The async client side implementation of the ModifyMonitoredItems service contract. - - - - - The client side implementation of the SetMonitoringMode service contract. - - - - - The client side implementation of the BeginSetMonitoringMode service contract. - - - - - The client side implementation of the EndSetMonitoringMode service contract. - - - - - The async client side implementation of the SetMonitoringMode service contract. - - - - - The client side implementation of the SetTriggering service contract. - - - - - The client side implementation of the BeginSetTriggering service contract. - - - - - The client side implementation of the EndSetTriggering service contract. - - - - - The async client side implementation of the SetTriggering service contract. - - - - - The client side implementation of the DeleteMonitoredItems service contract. - - - - - The client side implementation of the BeginDeleteMonitoredItems service contract. - - - - - The client side implementation of the EndDeleteMonitoredItems service contract. - - - - - The async client side implementation of the DeleteMonitoredItems service contract. - - - - - The client side implementation of the CreateSubscription service contract. - - - - - The client side implementation of the BeginCreateSubscription service contract. - - - - - The client side implementation of the EndCreateSubscription service contract. - - - - - The async client side implementation of the CreateSubscription service contract. - - - - - The client side implementation of the ModifySubscription service contract. - - - - - The client side implementation of the BeginModifySubscription service contract. - - - - - The client side implementation of the EndModifySubscription service contract. - - - - - The async client side implementation of the ModifySubscription service contract. - - - - - The client side implementation of the SetPublishingMode service contract. - - - - - The client side implementation of the BeginSetPublishingMode service contract. - - - - - The client side implementation of the EndSetPublishingMode service contract. - - - - - The async client side implementation of the SetPublishingMode service contract. - - - - - The client side implementation of the Publish service contract. - - - - - The client side implementation of the BeginPublish service contract. - - - - - The client side implementation of the EndPublish service contract. - - - - - The async client side implementation of the Publish service contract. - - - - - The client side implementation of the Republish service contract. - - - - - The client side implementation of the BeginRepublish service contract. - - - - - The client side implementation of the EndRepublish service contract. - - - - - The async client side implementation of the Republish service contract. - - - - - The client side implementation of the TransferSubscriptions service contract. - - - - - The client side implementation of the BeginTransferSubscriptions service contract. - - - - - The client side implementation of the EndTransferSubscriptions service contract. - - - - - The async client side implementation of the TransferSubscriptions service contract. - - - - - The client side implementation of the DeleteSubscriptions service contract. - - - - - The client side implementation of the BeginDeleteSubscriptions service contract. - - - - - The client side implementation of the EndDeleteSubscriptions service contract. - - - - - The async client side implementation of the DeleteSubscriptions service contract. - - - - - The client side interface with a UA server. - - - The client side interface for a UA server. - - - - - - An overrideable version of the Dispose. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - The server assigned identifier for the current session. - - The session id. - - - - Whether a session has beed created with the server. - - true if connected; otherwise, false. - - - - Called when a new session is created. - - The session id. - The session cookie. - - - - Intializes the object with a channel and a message context. - - - - - The component contains classes object use to communicate with the server. - - - - - Invokes the CreateSession service. - - - - - Begins an asynchronous invocation of the CreateSession service. - - - - - Finishes an asynchronous invocation of the CreateSession service. - - - - - Invokes the CreateSession service using async Task based request. - - - - - Invokes the ActivateSession service. - - - - - Begins an asynchronous invocation of the ActivateSession service. - - - - - Finishes an asynchronous invocation of the ActivateSession service. - - - - - Invokes the ActivateSession service using async Task based request. - - - - - Invokes the CloseSession service. - - - - - Begins an asynchronous invocation of the CloseSession service. - - - - - Finishes an asynchronous invocation of the CloseSession service. - - - - - Invokes the CloseSession service using async Task based request. - - - - - Invokes the Cancel service. - - - - - Begins an asynchronous invocation of the Cancel service. - - - - - Finishes an asynchronous invocation of the Cancel service. - - - - - Invokes the Cancel service using async Task based request. - - - - - Invokes the AddNodes service. - - - - - Begins an asynchronous invocation of the AddNodes service. - - - - - Finishes an asynchronous invocation of the AddNodes service. - - - - - Invokes the AddNodes service using async Task based request. - - - - - Invokes the AddReferences service. - - - - - Begins an asynchronous invocation of the AddReferences service. - - - - - Finishes an asynchronous invocation of the AddReferences service. - - - - - Invokes the AddReferences service using async Task based request. - - - - - Invokes the DeleteNodes service. - - - - - Begins an asynchronous invocation of the DeleteNodes service. - - - - - Finishes an asynchronous invocation of the DeleteNodes service. - - - - - Invokes the DeleteNodes service using async Task based request. - - - - - Invokes the DeleteReferences service. - - - - - Begins an asynchronous invocation of the DeleteReferences service. - - - - - Finishes an asynchronous invocation of the DeleteReferences service. - - - - - Invokes the DeleteReferences service using async Task based request. - - - - - Invokes the Browse service. - - - - - Begins an asynchronous invocation of the Browse service. - - - - - Finishes an asynchronous invocation of the Browse service. - - - - - Invokes the Browse service using async Task based request. - - - - - Invokes the BrowseNext service. - - - - - Begins an asynchronous invocation of the BrowseNext service. - - - - - Finishes an asynchronous invocation of the BrowseNext service. - - - - - Invokes the BrowseNext service using async Task based request. - - - - - Invokes the TranslateBrowsePathsToNodeIds service. - - - - - Begins an asynchronous invocation of the TranslateBrowsePathsToNodeIds service. - - - - - Finishes an asynchronous invocation of the TranslateBrowsePathsToNodeIds service. - - - - - Invokes the TranslateBrowsePathsToNodeIds service using async Task based request. - - - - - Invokes the RegisterNodes service. - - - - - Begins an asynchronous invocation of the RegisterNodes service. - - - - - Finishes an asynchronous invocation of the RegisterNodes service. - - - - - Invokes the RegisterNodes service using async Task based request. - - - - - Invokes the UnregisterNodes service. - - - - - Begins an asynchronous invocation of the UnregisterNodes service. - - - - - Finishes an asynchronous invocation of the UnregisterNodes service. - - - - - Invokes the UnregisterNodes service using async Task based request. - - - - - Invokes the QueryFirst service. - - - - - Begins an asynchronous invocation of the QueryFirst service. - - - - - Finishes an asynchronous invocation of the QueryFirst service. - - - - - Invokes the QueryFirst service using async Task based request. - - - - - Invokes the QueryNext service. - - - - - Begins an asynchronous invocation of the QueryNext service. - - - - - Finishes an asynchronous invocation of the QueryNext service. - - - - - Invokes the QueryNext service using async Task based request. - - - - - Invokes the Read service. - - - - - Begins an asynchronous invocation of the Read service. - - - - - Finishes an asynchronous invocation of the Read service. - - - - - Invokes the Read service using async Task based request. - - - - - Invokes the HistoryRead service. - - - - - Begins an asynchronous invocation of the HistoryRead service. - - - - - Finishes an asynchronous invocation of the HistoryRead service. - - - - - Invokes the HistoryRead service using async Task based request. - - - - - Invokes the Write service. - - - - - Begins an asynchronous invocation of the Write service. - - - - - Finishes an asynchronous invocation of the Write service. - - - - - Invokes the Write service using async Task based request. - - - - - Invokes the HistoryUpdate service. - - - - - Begins an asynchronous invocation of the HistoryUpdate service. - - - - - Finishes an asynchronous invocation of the HistoryUpdate service. - - - - - Invokes the HistoryUpdate service using async Task based request. - - - - - Invokes the Call service. - - - - - Begins an asynchronous invocation of the Call service. - - - - - Finishes an asynchronous invocation of the Call service. - - - - - Invokes the Call service using async Task based request. - - - - - Invokes the CreateMonitoredItems service. - - - - - Begins an asynchronous invocation of the CreateMonitoredItems service. - - - - - Finishes an asynchronous invocation of the CreateMonitoredItems service. - - - - - Invokes the CreateMonitoredItems service using async Task based request. - - - - - Invokes the ModifyMonitoredItems service. - - - - - Begins an asynchronous invocation of the ModifyMonitoredItems service. - - - - - Finishes an asynchronous invocation of the ModifyMonitoredItems service. - - - - - Invokes the ModifyMonitoredItems service using async Task based request. - - - - - Invokes the SetMonitoringMode service. - - - - - Begins an asynchronous invocation of the SetMonitoringMode service. - - - - - Finishes an asynchronous invocation of the SetMonitoringMode service. - - - - - Invokes the SetMonitoringMode service using async Task based request. - - - - - Invokes the SetTriggering service. - - - - - Begins an asynchronous invocation of the SetTriggering service. - - - - - Finishes an asynchronous invocation of the SetTriggering service. - - - - - Invokes the SetTriggering service using async Task based request. - - - - - Invokes the DeleteMonitoredItems service. - - - - - Begins an asynchronous invocation of the DeleteMonitoredItems service. - - - - - Finishes an asynchronous invocation of the DeleteMonitoredItems service. - - - - - Invokes the DeleteMonitoredItems service using async Task based request. - - - - - Invokes the CreateSubscription service. - - - - - Begins an asynchronous invocation of the CreateSubscription service. - - - - - Finishes an asynchronous invocation of the CreateSubscription service. - - - - - Invokes the CreateSubscription service using async Task based request. - - - - - Invokes the ModifySubscription service. - - - - - Begins an asynchronous invocation of the ModifySubscription service. - - - - - Finishes an asynchronous invocation of the ModifySubscription service. - - - - - Invokes the ModifySubscription service using async Task based request. - - - - - Invokes the SetPublishingMode service. - - - - - Begins an asynchronous invocation of the SetPublishingMode service. - - - - - Finishes an asynchronous invocation of the SetPublishingMode service. - - - - - Invokes the SetPublishingMode service using async Task based request. - - - - - Invokes the Publish service. - - - - - Begins an asynchronous invocation of the Publish service. - - - - - Finishes an asynchronous invocation of the Publish service. - - - - - Invokes the Publish service using async Task based request. - - - - - Invokes the Republish service. - - - - - Begins an asynchronous invocation of the Republish service. - - - - - Finishes an asynchronous invocation of the Republish service. - - - - - Invokes the Republish service using async Task based request. - - - - - Invokes the TransferSubscriptions service. - - - - - Begins an asynchronous invocation of the TransferSubscriptions service. - - - - - Finishes an asynchronous invocation of the TransferSubscriptions service. - - - - - Invokes the TransferSubscriptions service using async Task based request. - - - - - Invokes the DeleteSubscriptions service. - - - - - Begins an asynchronous invocation of the DeleteSubscriptions service. - - - - - Finishes an asynchronous invocation of the DeleteSubscriptions service. - - - - - Invokes the DeleteSubscriptions service using async Task based request. - - - - - A base class for UA channel objects used to access UA interfaces - - - - - Initializes the object with the specified binding and endpoint address. - - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - Returns true if the channel uses the UA Binary encoding. - - - - - Gets the binary encoding support. - - - - - Opens the channel with the server. - - - - - Closes the channel with the server. - - - - - Schedules an outgoing request. - - The request. - - - - A masking indicating which features are implemented. - - - - - Gets the description for the endpoint used by the channel. - - - - - Gets the configuration for the channel. - - - - - Gets the context used when serializing messages exchanged via the channel. - - - - - Gets the the channel's current security token. - - - - - Gets or sets the default timeout for requests send via the channel. - - - - - Initializes a secure channel with the endpoint identified by the URL. - - The URL for the endpoint. - The settings to use when creating the channel. - Thrown if any communication error occurs. - - - - Initializes a secure channel with the endpoint identified by the URL. - - The connection to use. - The settings to use when creating the channel. - Thrown if any communication error occurs. - - - - Opens a secure channel with the endpoint identified by the URL. - - - - - Begins an asynchronous operation to open a secure channel with the endpoint identified by the URL. - - - - - Completes an asynchronous operation to open a communication object. - - - - - Closes any existing secure channel and opens a new one. - - Thrown if any communication error occurs. - - Calling this method will cause outstanding requests over the current secure channel to fail. - - - - - Closes any existing secure channel and opens a new one using an existing channel. - - The reverse transport connection for the Reconnect. - Thrown if any communication error occurs. - - Calling this method will cause outstanding requests over the current secure channel to fail. - - - - - Begins an asynchronous operation to close the existing secure channel and open a new one. - - - - - Completes an asynchronous operation to close the existing secure channel and open a new one. - - - - - Closes any existing secure channel. - - - - - Begins an asynchronous operation to close the secure channel. - - - - - Completes an asynchronous operation to close a communication object. - - - - - Sends a request over the secure channel. - - - - - Begins an asynchronous operation to send a request over the secure channel. - - - - - Completes an asynchronous operation to send a request over the secure channel. - - - - - Sends a request over the secure channel. - - The request. - The cancellation token. - The response. - - - - The client side implementation of the InvokeService service contract. - - - - - The client side implementation of the BeginInvokeService service contract. - - - - - The client side implementation of the EndInvokeService service contract. - - - - - Creates a new UA-binary transport channel if requested. Null otherwise. - - - - - Creates a new UA-binary transport channel if requested. Null otherwise. - - The application configuration. - The description for the endpoint. - The configuration to use with the endpoint. - The client certificate. - The message context to use when serializing the messages. - - - - - Creates a new UA-binary transport channel if requested. Null otherwise. - - The application configuration. - The description for the endpoint. - The configuration to use with the endpoint. - The client certificate. - The client certificate chain. - The message context to use when serializing the messages. - - - - - A base class for UA channel objects used access UA interfaces - - - - - An overrideable version of the Dispose. - - - - - The client side implementation of the InvokeService service contract. - - - - - The client side implementation of the BeginInvokeService service contract. - - - - - The client side implementation of the EndInvokeService service contract. - - - - - Closes any existing secure channel and opens a new one. - - - - - - - - An async result object that wraps the UA channel. - - - - - Initializes a new instance of the class. - - The channel. - The callback. - The callback data. - - - - Gets the wrapped channel. - - The wrapped channel. - - - - Called when asynchronous operation completes. - - The asynchronous result object. - - - - Checks for a valid IAsyncResult object and waits for the operation to complete. - - The IAsyncResult object for the operation. - The oject that - - - - Gets the inner channel. - - The channel. - - - - A generic user identity class. - - - - - Initializes the object as an anonymous user. - - - - - Initializes the object with a username and password. - - The user name. - The password. - - - - Initializes the object with a UA identity token. - - The token. - - - - Initializes the object with an X509 certificate identifier - - - - - Initializes the object with an X509 certificate - - - - - Initializes the object with a UA identity token. - - The user identity token. - - - - Initializes the object during deserialization. - - - The user identity encodes only the token type, - the issued token and the policy id, if available. - Hence, the default constructor - is used to initialize the token as anonymous. - - - - - Gets or sets the UserIdentityToken PolicyId associated with the UserIdentity. - - - This value is used to initialize the UserIdentityToken object when GetIdentityToken() is called. - - - - - - - - - - - - - - - - - Get or sets the list of granted role ids associated to the UserIdentity. - - - - - - - - Initializes the object with a UA identity token - - - - - Initializes the object with an X509 certificate - - - - - Stores information about the user that is currently being impersonated. - - - - - The security principal being impersonated. - - - - - Loads the configuration section for an application. - - - - - Creates the configuration object from the configuration section. - - The parent object. - The configuration context object. - The section as XML node. - The created section handler object. - - - - Represents the location of a configuration file. - - - - - Gets or sets the relative or absolute path to the configuration file. - - The file path. - - - - Watches the configuration file and reports any changes. - - - - - Creates the watcher for the configuration. - - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - Raised when the configuration file changes. - - - - - Handles a file changed event. - - - - - Stores the arguments passed when the configuration file changes. - - - - - Initializes the object with a configuration and a file path. - - - - - The application configuration which changed. - - - - - The path to the application configuration file. - - - - - Describes how to connect to an endpoint. - - - - - - - Creates an instance of a configuration with reasonable default values. - - - - - Creates an instance of a configuration with reasonable default values. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Describes how to connect to an endpoint. - - - - - - - Creates an endpoint configuration from a url. - - - - - The encodings supported by the configuration. - - - - - The proxy url to use when connecting to the endpoint. - - - - - Finds the user token policy with the specified id. - - - - - Finds a token policy that matches the user identity specified. - - - - - Finds a token policy that matches the user identity specified. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The default constructor. - - - - - Initializes the object during deserialization. - - - - - Sets private members to default values. - - - - - The properties of the current server instance. - - - - - The default constructor. - - - - - The unique identifier for the product. - - - - - The name of the product - - - - - The name of the manufacturer - - - - - The software version for the application - - - - - The build number for the application - - - - - When the application was built. - - - - - The assemblies that contain encodeable types that could be uses a variable values. - - - - - The software certificates granted to the server. - - - - - Defines the default names for the condition states. - - - - - The name of the Disabled state. - - - - - The name of the Enabled state. - - - - - The name of the Inactive state. - - - - - The name of the Active state. - - - - - The name of the Unacknowledged state. - - - - - The name of the Acknowledged state. - - - - - The name of the Unconfirmed state. - - - - - The name of the Confirmed state. - - - - - The name of the Unsuppressed state. - - - - - The name of the Suppressed state. - - - - - The name of the HighHighActive state. - - - - - The name of the HighActive state. - - - - - The name of the LowActive state. - - - - - The name of the LowLowActive state. - - - - - A class that defines constants used by UA applications. - - - - - - - Returns the browse name for the attribute. - - - - - Returns the browse names for all attributes. - - - - - Returns the id for the attribute with the specified browse name. - - - - - Returns the data type id that describes a value. - - - - - Returns the data type id that describes a value. - - - - - Returns the data type id that describes a value. - - - - - Returns the array rank for a value. - - - - - Returns the array rank for a type. - - - - - Returns the BuiltInType type for the DataTypeId. - - - - - Returns the BuiltInType type for the DataTypeId. - - - - - Returns the system type for the datatype. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Defines well-known namespaces. - - - - - - The XML Schema namespace. - - - - - The XML Schema Instance namespace. - - - - - The WS Secuirity Extensions Namespace. - - - - - The WS Secuirity Utilities Namespace. - - - - - The URI for the UA WSDL. - - - - - The URI for the UA SecuredApplication schema. - - - - - The base URI for the Global Discovery Service. - - - - - The base URI for SDK related schemas. - - - - - The URI for the UA SDK Configuration Schema. - - - - - The URI for the built-in types namespace. - - - - - The URI for the OPC Binary Schema. - - - - - The URI representing all resources in at a site managed by an OAuthe Authorization Service. - - - - - The URI for the OpcUa namespace (.NET code namespace is 'Opc.Ua'). - - - - - The URI for the OpcUaXsd namespace (.NET code namespace is 'Opc.Ua'). - - - - - A class that defines constants used by UA applications. - - - - - - - Returns the browse name for the attribute. - - - - - Returns the browse names for all attributes. - - - - - Returns the id for the attribute with the specified browse name. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes a new event. - - The current system context. - The source of the event. - The severity for the event. - The default message. - - - - - - - Makes a copy of the node and all children. - - - A new object that is a copy of this instance. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes a new event. - - The current system context. - The source of the event. - The severity for the event. - The default message. - Whether the operation that caused the event succeeded. - When the operation started. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes the object as a collection of counters which change value on read. - - - - - Stores information about a statemachine element. - - - - - Creates a new instance of the object. - - - - - The node id for the element. - - - - - The browse name of the element. - - - - - A number assigned to the element. - - - - - The namespace index used to qualify the element browse names and node ids. - - - - - The table of states belonging to the state machine. - - - - - The table of states belonging to the state machine. - - - - - The table of transitions belonging to the state machine. - - - - - The mapping between transitions and their from and to states. - - - - - The mapping between causes, the current state and a transition. - - - - - The last state that the machine was in. - - - - - Returns the current state of for the state machine. - - - - - Returns the new state for the specified transition. Returns 0 if the transition is not allowed. - - - - - Checks if the transition has an effect. - - - - - Returns the transition for the cause given the current state. - - - - - Returns the transition from the current state to the target state. - - - - - Updates the current state variable. - - - - - Updates the last transition variable. - - - - - Raised to check whether the current user is allowed to execute the command. - - - - - Raised before a transition occurs. - - - - - Raises after a transition occurs. Errors are ignored. - - - - - If true transition events will not be produced by the state machine. - - - - - Invokes the callback function if it has been specified. - - - - - Checks if the cause is permitted given the current state and returns the associated transition. - - - - - Forces the machine into the specified state. - - - - - Invokes the specified cause. - - - - - Creates an instance of an audit event. - - - - - Updates an audit event after the method is invoked. - - - - - Reports AuditProgramTransition event - - - - - - - - - - Updates the state machine to reflect the successful processing of a method. - - The context. - The cause id. - - - - - Causes the specified transition to occur. - - - - - Creates an instance of an transition event. - - - - - Updates a transition event after the transition is complete. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Called after a node is created. - - - - - Gets or sets a value indicating whether the condition will automatically report an event when a method call completes. - - - true if the condition automatically reports ecents; otherwise, false. - - - - - Called when one or more sub-states change state. - - The context. - The display name for the effective state. - The transition time. - - - - Sets the enable state for the condition without raising events. - - The system context. - If true the condition is put into the Enabled state. - This method ensures all related variables are set correctly. - - - - Sets the severity for the condition without raising events. - - The system context. - The event severity. - This method ensures all related variables are set correctly. - - - - Updates the condition after adding a comment. - - The system context. - The comment. - The user that added the comment. - - - - Create a branch based off the original Event - - The system context. - The Desired Branch Id - ConditionState newly created branch - - - - Retrieves the branches for the current ConditionState. - Creates the branches dictionary if required - - - Function exists because constructor is in auto generated code. - - - - - - Finds an event, whether it is the original event, or a branch - - Desired Event Id - ConditionState branch if it exists - - - - Determines whether a specified branch exists, and returns it as ConditionState - - Desired Event Id - ConditionState branch if it exists - - - - Replace the Event Id of a branch, usually due to an Acknowledgment - - Event Id prior to the Acknowledgment - Branch, containing the updated EventId to be stored - - - - Remove a specific branch - - The desired event to remove - - - - Clear all branches for this event - - - - - Updates the value of Retain based off all effective alarm properties - ActiveState, AckedState, ConfirmedState, Branches, Enabled - - - - - Determines the desired Retain state based off Enabled state, and whether there are any branches - - - All implementations of this method should check the enabled state - - - - - Get the Number of Branches currently utilized by this event - - - Int contain the number of Branches - - - - - Determines if Events are monitored for this event. If this is a branch, then the original event is checked - - - Boolean determining if this event is monitored, and should be reported - - - - Raised when the condition is enabled or disabled. - - - Return code can be used to cancel the operation. - - - - - Raised when a comment is added to the condition. - - - Return code can be used to cancel the operation. - - - - - Handles a condition refresh. - - - - - Reports the state change for the condition. - - The context. - if set to true the event is reported event if the condition is in the disabled state. - - - - Updates the effective state for the condition. - - The context. - - - - Called when the add comment method is called. - - The system context. - The method being called. - The id of the object. - The identifier for the event which is the target for the comment. - The comment. - Any error. - - - - Gets the current user id from the system context. - - The system context. - The display name for the current user. - - - - Does any processing before adding a comment to a condition. - - The system context. - The identifier for the event which is the target for the comment. - The comment. - - - - Handles the Enable method. - - - - - Handles the Disable method. - - - - - Does any processing before a condition is enabled or disabled. - - The system context. - True is the condition is being enabled. - - - - Updates the condition state after enabling. - - The system context. - - - - Updates the condition state after disabling. - - The system context. - - - - Determines if this event is a branch - - true if branch - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Called after a node is created. - - - - - Activates the dialog. - - The system context. - - - - Sets the response to the dialog. - - The system context. - The selected response. - - - - Raised when a dialog receives a Response. - - - Return code can be used to cancel the operation. - - - - - Updates the effective state for the condition. - - The context. - - - - Called when the Respond method is called. - - The system context. - The method being called. - The id of the object. - The selected response. - Any error. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Called after a node is created. - - - - - Sets the acknowledged state of the condition. - - The system context. - if set to true the condition is acknowledged. - - - - Sets the confirmed state of the condition. - - The context. - if set to true the condition is confirmed. - - - - Raised when a condition is acknowledged. - - - Return code can be used to cancel the operation. - - - - - Raised when a condition is confirmed. - - - Return code can be used to cancel the operation. - - - - - Updates the effective state for the condition. - - The context. - - - - Called when the Acknowledge method is called. - - The system context. - The method being called. - The id of the object. - The identifier for the event which is the target for the comment. - The comment. - Any error. - - - - Does any processing before adding a comment to a condition. - - The system context. - The identifier for the event which is the target for the comment. - The comment. - - - - Updates the condition state after enabling. - - The system context. - - - - Updates the condition state after disabling. - - The system context. - - - - Called when the Confirm method is called. - - The system context. - The method being called. - The id of the object. - The identifier for the event which is the target for the comment. - The comment. - Any error. - - - - Does any processing before adding a comment to a condition. - - The system context. - The identifier for the event which is the target for the comment. - The comment. - - - - Updates the condition state after enabling. - - The system context. - - - - Updates the condition state after disabling. - - The system context. - - - - Determines if a comment should be added on Acknowledgment or Confirm. - - The client provided comment. - Boolean stating whether the comment should be set - - According to the specification for Alarms, the Acknowledgment states that - "If the comment field is NULL (both locale and text are empty) it will be - ignored and any existing comments will remain unchanged." - This also applies to the Confirm method, although the spec needs updating - (Mantis issue 6405) - - - - - Determines if this Event supports Confirm. - - - Boolean stating whether the Confirm is supported - - - - - Determines whether a specified branch exists, and returns it as AcknowledgeableConditionState - - Desired Event Id - - AcknowledgeableConditionState branch if it exists - - - - - Determines the desired Retain state based off of the values of AckedState and - ConfirmedState if ConfirmedState is supported - - - All implementations of this method should check the enabled state - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Called after a node is created. - - - - - An overrideable version of the Dispose. - - - - - Defines how often to update the UnshelveTime when Shelving State is TimedShelve or OneShotShelved. - Defaults to 1000 ms - - - - - Called when one or more sub-states change state. - - The context. - The display name for the effective state. - The transition time. - - - - Gets when the alarm is scheduled to be unshelved. - - The unshelve time. - - - - Sets the active state of the condition. - - The system context. - if set to true the condition is active. - - - - Sets the suppressed state of the condition. - - The context. - if set to true the condition is suppressed. - - - - Sets the shelving state of the condition. - - The shelving context. - if set to true shelved. - if set to true for a one shot shelve.. - The duration of a timed shelve. - - - - Determines the desired Retain state based off of the values of AckedState and - ConfirmedState if ConfirmedState is supported - - - All implementations of this method should check the enabled state - - - - - Returns the method with the specified NodeId or MethodDeclarationId. Looks specifically for - Shelving State Methods - - The system context. - The identifier for the method to find. - Returns the method. Null if no method found. - - It is possible to call ShelvingState Methods by using only the ConditionId (1.04 Part 9 5.8.10.4). - Look to the Shelving State object for the method if it cannot be found by the normal mechanism. - - - - - Raised when the alarm is shelved. - - - Return code can be used to cancel the operation. - - - - - Raised when the timed shelving period expires. - - - - - Raised periodically when the shelving state is not Unshelved to update the UnshelveTimeValue. - - - - - Updates the effective state for the condition. - - The context. - - - - Checks whether the OneShotShelve method is executable. - - - - - Checks whether the OneShotShelve method is executable. - - - - - Handles the OneShotShelve method. - - - - - Checks whether the TimedShelve method is executable. - - - - - Handles the TimedShelve method. - - - - - Checks whether the Unshelve method is executable. - - - - - Handles the Unshelve method. - - - - - Called when timed shelve period expires. - - - - - Called when shelved state is not Unshelved to update the UnshelveTime value. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes the object as a collection of counters which change value on read. - - - - - The table of states belonging to the state machine. - - - - - A table of valid states. - - - - - The table of transitions belonging to the state machine. - - - - - A table of valid transitions. - - - - - The mapping between transitions and their from and to states. - - - - - A table of the to and from states for the transitions. - - - - - The mapping between causes, the current state and a transition. - - - - - A table of transitions for the available causes. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes the object as a collection of counters which change value on read. - - - - - The table of states belonging to the state machine. - - - - - A table of valid states. - - - - - The table of transitions belonging to the state machine. - - - - - A table of valid transitions. - - - - - The mapping between transitions and their from and to states. - - - - - A table of the to and from states for the transitions. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Sets the active state of the condition. - - The system context. - if set to true the condition is active. - - - - Sets the limit state of the condition. - - The system context. - The bit masks specifying the current state. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Sets the limit state of the condition. - - The system context. - The bit masks specifying the current state. - - - - Updates the state. - - The limit. - if set to true is the state is active. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes the object as a collection of counters which change value on read. - - - - - The table of states belonging to the state machine. - - - - - A table of valid states. - - - - - The table of transitions belonging to the state machine. - - - - - A table of valid transitions. - - - - - The mapping between transitions and their from and to states. - - - - - A table of the to and from states for the transitions. - - - - - The mapping between causes, the current state and a transition. - - - - - A table of transitions for the available causes. - - - - - Creates an instance of an audit event. - - - - - Updates an audit event after the method is invoked. - - - - - Creates an instance of an transition event. - - - - - Checks whether the start method is executable. - - - - - Checks whether the start method is executable by the current user. - - - - - Handles the start method. - - - - - Checks whether the suspend method is executable. - - - - - Checks whether the suspend method is executable by the current user. - - - - - Handles the suspend method. - - - - - Checks whether the resume method is executable. - - - - - Checks whether the resume method is executable by the current user. - - - - - Handles the resume method. - - - - - Checks whether the halt method is executable. - - - - - Checks whether the halt method is executable by the current user. - - - - - Handles the halt method. - - - - - Checks whether the reset method is executable. - - - - - Checks whether the reset method is executable by the current user. - - - - - Handles the reset method. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - An interface used by by clients to access a UA server. - - - - - - Invokes the CreateSession service. - - - - - Begins an asynchronous invocation of the CreateSession service. - - - - - Finishes an asynchronous invocation of the CreateSession service. - - - - - Invokes the CreateSession service using async Task based request. - - - - - Invokes the ActivateSession service. - - - - - Begins an asynchronous invocation of the ActivateSession service. - - - - - Finishes an asynchronous invocation of the ActivateSession service. - - - - - Invokes the ActivateSession service using async Task based request. - - - - - Invokes the CloseSession service. - - - - - Begins an asynchronous invocation of the CloseSession service. - - - - - Finishes an asynchronous invocation of the CloseSession service. - - - - - Invokes the CloseSession service using async Task based request. - - - - - Invokes the Cancel service. - - - - - Begins an asynchronous invocation of the Cancel service. - - - - - Finishes an asynchronous invocation of the Cancel service. - - - - - Invokes the Cancel service using async Task based request. - - - - - Invokes the AddNodes service. - - - - - Begins an asynchronous invocation of the AddNodes service. - - - - - Finishes an asynchronous invocation of the AddNodes service. - - - - - Invokes the AddNodes service using async Task based request. - - - - - Invokes the AddReferences service. - - - - - Begins an asynchronous invocation of the AddReferences service. - - - - - Finishes an asynchronous invocation of the AddReferences service. - - - - - Invokes the AddReferences service using async Task based request. - - - - - Invokes the DeleteNodes service. - - - - - Begins an asynchronous invocation of the DeleteNodes service. - - - - - Finishes an asynchronous invocation of the DeleteNodes service. - - - - - Invokes the DeleteNodes service using async Task based request. - - - - - Invokes the DeleteReferences service. - - - - - Begins an asynchronous invocation of the DeleteReferences service. - - - - - Finishes an asynchronous invocation of the DeleteReferences service. - - - - - Invokes the DeleteReferences service using async Task based request. - - - - - Invokes the Browse service. - - - - - Begins an asynchronous invocation of the Browse service. - - - - - Finishes an asynchronous invocation of the Browse service. - - - - - Invokes the Browse service using async Task based request. - - - - - Invokes the BrowseNext service. - - - - - Begins an asynchronous invocation of the BrowseNext service. - - - - - Finishes an asynchronous invocation of the BrowseNext service. - - - - - Invokes the BrowseNext service using async Task based request. - - - - - Invokes the TranslateBrowsePathsToNodeIds service. - - - - - Begins an asynchronous invocation of the TranslateBrowsePathsToNodeIds service. - - - - - Finishes an asynchronous invocation of the TranslateBrowsePathsToNodeIds service. - - - - - Invokes the TranslateBrowsePathsToNodeIds service using async Task based request. - - - - - Invokes the RegisterNodes service. - - - - - Begins an asynchronous invocation of the RegisterNodes service. - - - - - Finishes an asynchronous invocation of the RegisterNodes service. - - - - - Invokes the RegisterNodes service using async Task based request. - - - - - Invokes the UnregisterNodes service. - - - - - Begins an asynchronous invocation of the UnregisterNodes service. - - - - - Finishes an asynchronous invocation of the UnregisterNodes service. - - - - - Invokes the UnregisterNodes service using async Task based request. - - - - - Invokes the QueryFirst service. - - - - - Begins an asynchronous invocation of the QueryFirst service. - - - - - Finishes an asynchronous invocation of the QueryFirst service. - - - - - Invokes the QueryFirst service using async Task based request. - - - - - Invokes the QueryNext service. - - - - - Begins an asynchronous invocation of the QueryNext service. - - - - - Finishes an asynchronous invocation of the QueryNext service. - - - - - Invokes the QueryNext service using async Task based request. - - - - - Invokes the Read service. - - - - - Begins an asynchronous invocation of the Read service. - - - - - Finishes an asynchronous invocation of the Read service. - - - - - Invokes the Read service using async Task based request. - - - - - Invokes the HistoryRead service. - - - - - Begins an asynchronous invocation of the HistoryRead service. - - - - - Finishes an asynchronous invocation of the HistoryRead service. - - - - - Invokes the HistoryRead service using async Task based request. - - - - - Invokes the Write service. - - - - - Begins an asynchronous invocation of the Write service. - - - - - Finishes an asynchronous invocation of the Write service. - - - - - Invokes the Write service using async Task based request. - - - - - Invokes the HistoryUpdate service. - - - - - Begins an asynchronous invocation of the HistoryUpdate service. - - - - - Finishes an asynchronous invocation of the HistoryUpdate service. - - - - - Invokes the HistoryUpdate service using async Task based request. - - - - - Invokes the Call service. - - - - - Begins an asynchronous invocation of the Call service. - - - - - Finishes an asynchronous invocation of the Call service. - - - - - Invokes the Call service using async Task based request. - - - - - Invokes the CreateMonitoredItems service. - - - - - Begins an asynchronous invocation of the CreateMonitoredItems service. - - - - - Finishes an asynchronous invocation of the CreateMonitoredItems service. - - - - - Invokes the CreateMonitoredItems service using async Task based request. - - - - - Invokes the ModifyMonitoredItems service. - - - - - Begins an asynchronous invocation of the ModifyMonitoredItems service. - - - - - Finishes an asynchronous invocation of the ModifyMonitoredItems service. - - - - - Invokes the ModifyMonitoredItems service using async Task based request. - - - - - Invokes the SetMonitoringMode service. - - - - - Begins an asynchronous invocation of the SetMonitoringMode service. - - - - - Finishes an asynchronous invocation of the SetMonitoringMode service. - - - - - Invokes the SetMonitoringMode service using async Task based request. - - - - - Invokes the SetTriggering service. - - - - - Begins an asynchronous invocation of the SetTriggering service. - - - - - Finishes an asynchronous invocation of the SetTriggering service. - - - - - Invokes the SetTriggering service using async Task based request. - - - - - Invokes the DeleteMonitoredItems service. - - - - - Begins an asynchronous invocation of the DeleteMonitoredItems service. - - - - - Finishes an asynchronous invocation of the DeleteMonitoredItems service. - - - - - Invokes the DeleteMonitoredItems service using async Task based request. - - - - - Invokes the CreateSubscription service. - - - - - Begins an asynchronous invocation of the CreateSubscription service. - - - - - Finishes an asynchronous invocation of the CreateSubscription service. - - - - - Invokes the CreateSubscription service using async Task based request. - - - - - Invokes the ModifySubscription service. - - - - - Begins an asynchronous invocation of the ModifySubscription service. - - - - - Finishes an asynchronous invocation of the ModifySubscription service. - - - - - Invokes the ModifySubscription service using async Task based request. - - - - - Invokes the SetPublishingMode service. - - - - - Begins an asynchronous invocation of the SetPublishingMode service. - - - - - Finishes an asynchronous invocation of the SetPublishingMode service. - - - - - Invokes the SetPublishingMode service using async Task based request. - - - - - Invokes the Publish service. - - - - - Begins an asynchronous invocation of the Publish service. - - - - - Finishes an asynchronous invocation of the Publish service. - - - - - Invokes the Publish service using async Task based request. - - - - - Invokes the Republish service. - - - - - Begins an asynchronous invocation of the Republish service. - - - - - Finishes an asynchronous invocation of the Republish service. - - - - - Invokes the Republish service using async Task based request. - - - - - Invokes the TransferSubscriptions service. - - - - - Begins an asynchronous invocation of the TransferSubscriptions service. - - - - - Finishes an asynchronous invocation of the TransferSubscriptions service. - - - - - Invokes the TransferSubscriptions service using async Task based request. - - - - - Invokes the DeleteSubscriptions service. - - - - - Begins an asynchronous invocation of the DeleteSubscriptions service. - - - - - Finishes an asynchronous invocation of the DeleteSubscriptions service. - - - - - Invokes the DeleteSubscriptions service using async Task based request. - - - - - An interface used by by clients to access a UA server. - - - - - - Invokes the FindServers service. - - - - - Begins an asynchronous invocation of the FindServers service. - - - - - Finishes an asynchronous invocation of the FindServers service. - - - - - Invokes the FindServers service using async Task based request. - - - - - Invokes the FindServersOnNetwork service. - - - - - Begins an asynchronous invocation of the FindServersOnNetwork service. - - - - - Finishes an asynchronous invocation of the FindServersOnNetwork service. - - - - - Invokes the FindServersOnNetwork service using async Task based request. - - - - - Invokes the GetEndpoints service. - - - - - Begins an asynchronous invocation of the GetEndpoints service. - - - - - Finishes an asynchronous invocation of the GetEndpoints service. - - - - - Invokes the GetEndpoints service using async Task based request. - - - - - An interface used by by clients to access a UA server. - - - - - - Invokes the RegisterServer service. - - - - - Begins an asynchronous invocation of the RegisterServer service. - - - - - Finishes an asynchronous invocation of the RegisterServer service. - - - - - Invokes the RegisterServer service using async Task based request. - - - - - Invokes the RegisterServer2 service. - - - - - Begins an asynchronous invocation of the RegisterServer2 service. - - - - - Finishes an asynchronous invocation of the RegisterServer2 service. - - - - - Invokes the RegisterServer2 service using async Task based request. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The first non-inherited field in the structure definition. - - - - - Set the default encoding id for the requested data encoding. - - The system context with the encodeable factory. - The type id of the Data Type. - The data encoding to apply to the default encoding id. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - If TRUE the values are bit positions rather than values. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A node in the server address space. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates a node from a reference desciption. - - The reference. - - - - Creates a node from another node (copies attributes - not references). - - The source. - - - - Returns a copy of the node - - The source. - A copy of the source node - - - - An opaque handle that can be assoociated with the node. - - The handle. - - - - Returns the string representation of the object. - - The format. - The provider. - String representation of the object. - - - - Returns the string representation of the object. - - - A that represents the current . - - - - - The node identifier. - - The node identifier. - - - - The identifier for the TypeDefinition node. - - The type definition identifier. - - - - A synchronization object that can be used to safely access the node. - - The data lock. - - - - A mask indicating which attributes are writeable. - - The write mask. - - - - A mask indicating which attributes that are writeable for the current user. - - The user write mask. - - - - The identifier for the ModellingRule node. - - The modelling rule. - - - - The collection of references for the node. - - The references. - - - - Creates a copy of the node. - - The node identifier. - Copy of the node - - - - Returns true if the node supports the attribute. - - The attribute id. - True if the node supports the attribute. - - - - Reads the value of a attribute. - - The context. - The attribute id. - The value. - The result of read operation. - - - - Writes the value of an attribute. - - The attribute id. - The value. - The result of write operation. - - - - A searchable table of references for the node. - - The reference table. - - - - Returns true if the reference exist. - - The reference type id. - if set to true [is inverse]. - The target id. - True if the reference exist. - - - - Returns all targets of the specified reference type. - - The reference type id. - if set to true [is inverse]. - All targets of the specified reference type. - - - - Returns a target of the specified reference type. - - The reference type id. - if set to true [is inverse]. - The index. - A target of the specified reference type. - - - - Returns the supertype for the Node if one exists. - - The type tree. - The supertype for the Node if one exists. - - Includes subtypes of HasSubtype if typeTree != null. - - - - - Reads the value of an attribute. - - The attribute id. - The value of an attribute. - - - - Writes the value of an attribute. - - The attribute id. - The value. - The result of write operation. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - An instance node in the server address space. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates a node from another node (copies attributes - not references). - - The source. - - - - - - An type node in the server address space. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates a node from another node (copies attributes - not references). - - The source. - - - - - - An object node in the server address space. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates a node from another node (copies attributes - not references). - - The source. - - - - Whether the node supports the specified attribute. - - The attribute identifier. - True if the value of an attribute. - - - - Reads the value of an attribute. - - The attribute id. - The value of an attribute. - - - - Writes the value of an attribute. - - The attribute id. - The value. - Result of write operation. - - - - - - An object type node in the server address space. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates a node from another node (copies attributes - not references). - - The source. - - - - Whether the node supports the specified attribute. - - The attribute id. - True if the node supports the specified attribute. - - - - Reads the value of an attribute. - - The attribute id. - Tthe node supports the specified attribute. - - - - Writes the value of an attribute. - - The attribute id. - The value. - The result of write operation. - - - - - - A variable node in the server address space. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates a node from another node (copies attributes - not references). - - The source. - - - - The value attribute. - - The value. - - - - The number in each dimension of an array value. - - The array dimensions. - - - - Whether the node supports the specified attribute. - - The attribute id. - True if the node supports the specified attribute. - - - - Reads the value of an attribute. - - The attribute id. - The value of an attribute. - - - - Writes the value of an attribute. - - The attribute id. - The value. - The result of write operation. - - - - - - A variable type node in the server address space. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates a node from another node (copies attributes - not references). - - The source. - - - - The value attribute. - - The value. - - - - The number in each dimension of an array value. - - The number in each dimension of an array value. - - - - Whether the node supports the specified attribute. - - The attribute id. - True if the node supports the specified attribute. - - - - Reads the value of an attribute. - - The attribute id. - The value of an attribute. - - - - Writes the value of an attribute. - - The attribute id. - The value. - The result of write operation. - - - - - - A reference type node in the server address space. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates a node from another node (copies attributes - not references). - - The source. - - - - Whether the node supports the specified attribute. - - The attribute identifier. - True if the node supports the specified attribute. - - - - Reads the value of an attribute. - - The attribute id. - The value of an attribute. - - - - Writes the value of an attribute. - - The attribute id. - The value. - The result of write operation. - - - - - - A method node in the server address space. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates a node from another node (copies attributes - not references). - - The source. - - - - Whether the node supports the specified attribute. - - The attribute id. - True if the node supports the specified attribute. - - - - Reads the value of an attribute. - - The attribute id. - The value of an attribute. - - - - Writes the value of an attribute. - - The attribute id. - The value. - The result of write operation. - - - - - - A view node in the server address space. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates a node from another node (copies attributes - not references). - - The source. - - - - Whether the node supports the specified attribute. - - The attribute identifier. - True if the node supports the specified attribute. - - - - Reads the value of an attribute. - - The attribute identifier. - The value of an attribute. - - - - Writes the value of an attribute. - - The attribute identifier. - The value. - The write operation result. - - - - - - A view node in the server address space. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates a node from another node (copies attributes - not references). - - The source. - - - - Whether the node supports the specified attribute. - - The attribute identifier. - True if the node supports the specified attribute. - - - - Reads the value of an attribute. - - The attribute id. - The value of an attribute. - - - - Writes the value of an attribute. - - The attribute id. - The value. - The result of write operation. - - - - - - A node in the server address space. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes the reference. - - The reference type id. - if set to true [is inverse]. - The target id. - - - - Returns a string representation of the HierarchyBrowsePath. - - - A that represents the current . - - - - - Returns a string representation of the HierarchyBrowsePath. - - The format. - The provider. - A string representation of the HierarchyBrowsePath. - - - - Determines whether the specified is equal to the current . - - The to compare with the current . - - true if the specified is equal to the current ; otherwise, false. - - - The parameter is null. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Returns true if the objects are equal. - - ReferenceNode A. - The ReferenceNode B. - The result of the operator.Returns true if the objects are equal. - - - - Returns true if the objects are not equal. - - ReferenceNode A. - The ReferenceNode B. - The result of the operator.Returns true if the objects are not equal. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: - Value - Meaning - Less than zero - This instance is less than . - Zero - This instance is equal to . - Greater than zero - This instance is greater than . - - - is not the same type as this instance. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The Argument class. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes an instance of the argument. - - - - - The value for the argument. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The ServiceFault class. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Defines constants for key user token policies. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates an empty token policy with the specified token type. - - - - - Returns the object formatted as a string. - - - - - Returns the string representation of the object. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The UserIdentityToken class. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Encrypts the token (implemented by the subclass). - - - - - Decrypts the token (implemented by the subclass). - - - - - Creates a signature with the token (implemented by the subclass). - - - - - Verifies a signature created with the token (implemented by the subclass). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The UserIdentityToken class. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The decrypted password associated with the token. - - - - - Encrypts the DecryptedPassword using the EncryptionAlgorithm and places the result in Password - - - - - Decrypts the Password using the EncryptionAlgorithm and places the result in DecryptedPassword - - - - - - - The X509IdentityToken class. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The certificate associated with the token. - - - - - Creates a signature with the token. - - - - - Verifies a signature created with the token. - - - - - - - The IssuedIdentityToken class. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The type of issued token. - - - - - The decrypted password associated with the token. - - - - - Encrypts the DecryptedTokenData using the EncryptionAlgorithm and places the result in Password - - - - - Decrypts the Password using the EncryptionAlgorithm and places the result in DecryptedPassword - - - - - Creates a signature with the token. - - - - - Verifies a signature created with the token. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Stores information about engineering units. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes the object with the unitName and namespaceUri. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Describes a view to browse or query. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A handle assigned to the item during processing. - - - - - Returns true if the view description represents the default (null) view. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A handle assigned to the item during processing. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A reference returned in browse operation. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Returns the string representation of the object. - - - - - Returns the string representation of the object. - - - - - Sets the reference type for the reference. - - - - - Sets the target attributes for the reference. - - - - - True if the reference filter has not been applied. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A class that stores a relative path - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates a relative path to follow any hierarchial references to find the specified browse name. - - - - - Creates a relative path to follow the forward reference type to find the specified browse name. - - - - - Creates a relative path to follow the forward reference type to find the specified browse name. - - - - - Formats the relative path as a string. - - - - - Returns true if the relative path does not specify any elements. - - - - - Parses a relative path formatted as a string. - - - - - Parses a relative path formatted as a string. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A handle assigned to the item during processing. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Stores the parsed form of the index range parameter. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A handle assigned to the item during processing. - - - - - Whether the value has been processed. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Formats the value of the current instance using the specified format. - - The specifying the format to use. - -or- - null to use the default format defined for the type of the implementation. - The to use to format the value. - -or- - null to obtain the numeric format information from the current locale setting of the operating system. - - A containing the value of the current instance in the specified format. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - The ContentFilter that this Element is part of. - - The parent. - - - - Validates the content filter element. - - The context. - The index. - The results of the validation. - - - - Returns the operands for the element. - - The list of operands for the element. - - - - Sets the operands for the element. - - The list of the operands. - - - - Converts an ContentFilterElement to a displayable string. - - The node table. - ContentFilterElement as a displayable string. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - This class contains functions used to evaluate a ContentFilter and report the - results of the evaluation. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Formats the value of the current instance using the specified format. - - The specifying the format to use. - -or- - null to use the default format defined for the type of the implementation. - The to use to format the value. - -or- - null to obtain the numeric format information from the current locale setting of the operating system. - - A containing the value of the current instance in the specified format. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Validates the ContentFilter. - - The context. - The result of validation. - - - - Pushes a new element onto the stack. - - The filter operator. - The operands. - - - - - Finds the index of the specified element. - - The targetto be found. - The index of the specified element. - - - - Stores the validation results for a ContentFilterElement. - - - - - Initializes the object with a result code. - - The status. - - - - Casts ServiceResult to an ElementResult. - - The status. - The result of the conversion. - - - - The result for the entire filter. - - The status. - - - - The result for each element. - - The element results. - - - - Converts the object to an ContentFilterResult. - - The diagnostics masks. - The string table. - - - - - Stores the validation results for a ContentFilterElement. - - - - - Initializes the object with a result code. - - The status. - - - - Casts ServiceResult to an ElementResult. - - The status. - The result of the conversion. - - - - The result for the entire element. - - The status. - - - - The result for each operand. - - The operand results. - - - - Converts the object to an ContentFilterElementResult. - - The diagnostics masks. - The string table. - - - - - Evaluates the first element in the ContentFilter. If the first or any - subsequent element has dependent elements, the dependent elements are - evaluated before the root element (recursive descent). Elements which - are not linked (directly or indirectly) to the first element will not - be evaluated (they have no influence on the result). - - The context to use when evaluating the filter. - The target to use when evaluating elements that reference the type model. - Returns true, false or null. - - - - Evaluates element at the specified index. - - - - - Returns the operands for the element. - - - - - Returns the operands necessary for the BitwiseAnd and BitwiseOr operations - - - - - Returns the value for the element. - - - - - Returns the BuiltInType type for the value. - - - - - Returns the BuiltInType type for the DataTypeId. - - - - - Returns the data type precedence for the value. - - - - - Implicitly converts the values according to their data type precedence. - - - - - Returns true if the values are equal. - - - - - Returns true if the target string matches the UA pattern string. - The pattern string may include UA wildcards %_\[]! - - String to check for a pattern match. - Pattern to match with the target string. - true if the target string matches the pattern, otherwise false. - - - - Returns true if the type is Integer, otherwise returns false - - The type to check against - true if the type is Integer, otherwise returns false - - - - Converts a value to a Boolean - - - - - Converts a value to a SByte - - - - - Converts a value to a Byte - - - - - Converts a value to a Int16 - - - - - Converts a value to a UInt16 - - - - - Converts a value to a Int32 - - - - - Converts a value to a UInt32 - - - - - Converts a value to a Int64 - - - - - Converts a value to a UInt64 - - - - - Converts a value to a Float - - - - - Converts a value to a Double - - - - - Converts a value to a String - - - - - Converts a value to a DateTime - - - - - Converts a value to a Guid - - - - - Converts a value to a ByteString - - - - - Converts a value to a NodeId - - - - - Converts a value to a ExpandedNodeId - - - - - Converts a value to a StatusCode - - - - - Converts a value to a QualifiedName - - - - - Converts a value to a LocalizedText - - - - - Casts a value to the specified target type. - - - - - Casts a value to the specified target type. - - - - - And FilterOperator - - - - - Or FilterOperator - - - - - Not FilterOperator - - - - - Equals FilterOperator - - - - - GreaterThan FilterOperator - - - - - GreaterThanOrEqual FilterOperator - - - - - LessThan FilterOperator - - - - - LessThanOrEqual FilterOperator - - - - - Between FilterOperator - - - - - InList FilterOperator - - - - - Like FilterOperator - - - - - IsNull FilterOperator - - - - - Cast FilterOperator - - - - - OfType FilterOperator - - - - - InView FilterOperator - - - - - RelatedTo FilterOperator - - - - - RelatedTo FilterOperator - - - - - BitwiseAnd FilterOperator - - - - - BitwiseOr FilterOperator - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The ContentFilterElement this FilterOperand is contained in. - The ContentFilterElement contains the operator and the operands - so it defines the expression to be evaluated. - - The parent element. - - - - Validates the operand. - - The context. - The index. - the result of the validation - - - - Converts an FilterOperand to a displayable string. - - The node table. - ContentFilterElement as a displayable string. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructs an operand from a value. - - The index. - - - - Formats the value of the current instance using the specified format. - - The specifying the format to use. - -or- - null to use the default format defined for the type of the implementation. - The to use to format the value. - -or- - null to obtain the numeric format information from the current locale setting of the operating system. - - A containing the value of the current instance in the specified format. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Validates the operand. - - The context. - The index. - The result of the validation - - - - Converts an ElementOperand to a displayable string. - - The table. - ElementOperand as a displayable string. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructs an operand from a value. - - The value. - - - - Formats the value of the current instance using the specified format. - - The specifying the format to use. - -or- - null to use the default format defined for the type of the implementation. - The to use to format the value. - -or- - null to obtain the numeric format information from the current locale setting of the operating system. - - A containing the value of the current instance in the specified format. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Validates the operand. - - The context. - The index. - The result of the validation - - - - Converts an LiteralOperand to a displayable string. - - The table. - LiteralOperand as a displayable string. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructs an operand from a value. - - The node identifier. - The browse path. - - - - Constructs an operand from a value. - - The node identifier. - The browse paths. - - - - Creates an operand that references a component/property of a type. - - The context. - The node identifier. - The relative path. - - - - Creates an operand that references a component/property of a type. - - The context. - The type definition identifier. - The browse path. - The attribute identifier. - The index range. - - - - Formats the value of the current instance using the specified format. - - The specifying the format to use. - -or- - null to use the default format defined for the type of the implementation. - The to use to format the value. - -or- - null to obtain the numeric format information from the current locale setting of the operating system. - - A containing the value of the current instance in the specified format. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Whether the operand has been validated. - - true if validated; otherwise, false. - - Set when Validate() is called. - - - - - Stores the parsed form of the IndexRange parameter. - - The parsed index range. - - Set when Validate() is called. - - - - - Validates the operand (sets the ParsedBrowsePath and ParsedIndexRange properties). - - The context. - The index. - The result of the validation. - - - - Converts an AttributeOperand to a displayable string. - - The node table. - AttributeOperand as a displayable string. - - - - - - A clause that identifies a field to return with the event. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates an operand that references a component/property of a type. - - - - - Creates an operand that references a component/property of a type. - - - - - Creates an operand that references a component/property of a type. - - - - - Creates an operand that references a component/property of a type. - - - - - Formats the value of the current instance using the specified format. - - The specifying the format to use. - -or- - null to use the default format defined for the type of the implementation. - The to use to format the value. - -or- - null to obtain the numeric format information from the current locale setting of the operating system. - - A containing the value of the current instance in the specified format. - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Whether the operand has been validated. - - - Set when Validate() is called. - - - - - Stores the parsed form of the IndexRange parameter. - - - Set when Validate() is called. - - - - - Validates the operand (sets the ParsedBrowsePath and ParsedIndexRange properties). - - - - - Converts an AttributeOperand to a displayable string. - - - - - Formats a browse path. - - - - - Parses a browse path. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The description of a value to read. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A handle assigned to the item during processing. - - - - - Whether the value has been processed. - - - - - Stores the parsed form of the index range parameter. - - - - - Validates a read value id parameter. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The description of a value to read. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A handle assigned to the item during processing. - - - - - Whether the value has been processed. - - - - - Stores the parsed form of the index range parameter. - - - - - Validates a read value id parameter. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The description of a value to write. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A handle assigned to the item during processing. - - - - - Whether the value has been processed. - - - - - Stores the parsed form of the index range parameter. - - - - - Validates a write value parameter. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The description of a value to read. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A handle assigned to the item during processing. - - - - - Whether the value has been processed. - - - - - Validates a HistoryUpdateDetails parameter. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The description of a value to write. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A handle assigned to the item during processing. - - - - - Whether the value has been processed. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A filter to apply when monitoring data changes. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Checks that the filter is valid. - - - - - Returns the AbsoluteDeadband if the filter specifies one. Zero otherwize. - - - - - Returns the PercentageDeadband if the filter specifies one. Zero otherwize. - - - - - - - A filter to apply when monitoring event. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Adds the specified property to the event filter. - - - - - Adds the specified browse path to the event filter. - - - - - Stores the validation results for a EventFilter. - - - - - Initializes the object. - - - - - Casts ServiceResult to an ElementResult. - - - - - The result for the entire filter. - - - - - Returns a string containing the errors reported. - - - - - The result for each select clause. - - - - - The results for the where clause. - - - - - Converts the object to an EventFilterResult. - - - - - Validates the object. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The description of a monitored item to create. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A handle assigned to the item during processing. - - - - - Whether the value has been processed. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The description of a monitored item to create. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes the object with an error code. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The description of a monitored item to create. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A handle assigned to the item during processing. - - - - - Whether the value has been processed. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A message return in a Publish response. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The string table that was received with the message. - - - - - Gets a value indicating whether this NotificationMessage is empty. - - - true if this instance is empty; otherwise, false. - - - - - Returns the data changes contained in the notification message. - - - - - Returns the events contained in the notification message. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Helper variable for a client to pass the sequence number - of the publish response for the data and the event change notification - to a client application which subscribes to subscription notifications. - - - A value of 0 indicates that the sequence number is not known. - A KeepAlive notification contains the sequence number of the next - notification. - - - - - Helper variable for a client to pass the publish time - of the publish response for the data and the event change notification - to a client application which subscribes to subscription notifications. - - - A value of MinTime indicates that the time is not known. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A datachange returned in a NotificationMessage. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The notification message that the item belongs to. - - - - - The diagnostic info associated with the notification. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A list of event field values returned in a NotificationMessage. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The handle cast to a notification message. - - - - - A handle associated withe the event instance. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Stores a StatusCode/DiagnosticInfo. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes the object with a ServiceResult. - - - - - Applies the diagnostic mask if the object was initialize with a ServiceResult. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Stores a range. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes the object with the high and low limits. - - - - - Returns the difference between high and low. - - - - - - - Stores information about engineering units. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Initializes the object with the unitName and namespaceUri. - - - - - Initializes the object with the unitName and namespaceUri. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A endpoint object used by clients to access a UA service. - - - - - - Initializes the object when it is created by the WCF framework. - - - - - Initializes the when it is created directly. - - - - - Initializes a new instance of the class. - - The server. - - - - The UA server instance that the endpoint is connected to. - - - - - Invokes the FindServers service. - - - - - Asynchronously calls the FindServers service. - - - - - Waits for an asynchronous call to the FindServers service to complete. - - - - - Invokes the FindServersOnNetwork service. - - - - - Asynchronously calls the FindServersOnNetwork service. - - - - - Waits for an asynchronous call to the FindServersOnNetwork service to complete. - - - - - Invokes the GetEndpoints service. - - - - - Asynchronously calls the GetEndpoints service. - - - - - Waits for an asynchronous call to the GetEndpoints service to complete. - - - - - Invokes the CreateSession service. - - - - - Asynchronously calls the CreateSession service. - - - - - Waits for an asynchronous call to the CreateSession service to complete. - - - - - Invokes the ActivateSession service. - - - - - Asynchronously calls the ActivateSession service. - - - - - Waits for an asynchronous call to the ActivateSession service to complete. - - - - - Invokes the CloseSession service. - - - - - Asynchronously calls the CloseSession service. - - - - - Waits for an asynchronous call to the CloseSession service to complete. - - - - - Invokes the Cancel service. - - - - - Asynchronously calls the Cancel service. - - - - - Waits for an asynchronous call to the Cancel service to complete. - - - - - Invokes the AddNodes service. - - - - - Asynchronously calls the AddNodes service. - - - - - Waits for an asynchronous call to the AddNodes service to complete. - - - - - Invokes the AddReferences service. - - - - - Asynchronously calls the AddReferences service. - - - - - Waits for an asynchronous call to the AddReferences service to complete. - - - - - Invokes the DeleteNodes service. - - - - - Asynchronously calls the DeleteNodes service. - - - - - Waits for an asynchronous call to the DeleteNodes service to complete. - - - - - Invokes the DeleteReferences service. - - - - - Asynchronously calls the DeleteReferences service. - - - - - Waits for an asynchronous call to the DeleteReferences service to complete. - - - - - Invokes the Browse service. - - - - - Asynchronously calls the Browse service. - - - - - Waits for an asynchronous call to the Browse service to complete. - - - - - Invokes the BrowseNext service. - - - - - Asynchronously calls the BrowseNext service. - - - - - Waits for an asynchronous call to the BrowseNext service to complete. - - - - - Invokes the TranslateBrowsePathsToNodeIds service. - - - - - Asynchronously calls the TranslateBrowsePathsToNodeIds service. - - - - - Waits for an asynchronous call to the TranslateBrowsePathsToNodeIds service to complete. - - - - - Invokes the RegisterNodes service. - - - - - Asynchronously calls the RegisterNodes service. - - - - - Waits for an asynchronous call to the RegisterNodes service to complete. - - - - - Invokes the UnregisterNodes service. - - - - - Asynchronously calls the UnregisterNodes service. - - - - - Waits for an asynchronous call to the UnregisterNodes service to complete. - - - - - Invokes the QueryFirst service. - - - - - Asynchronously calls the QueryFirst service. - - - - - Waits for an asynchronous call to the QueryFirst service to complete. - - - - - Invokes the QueryNext service. - - - - - Asynchronously calls the QueryNext service. - - - - - Waits for an asynchronous call to the QueryNext service to complete. - - - - - Invokes the Read service. - - - - - Asynchronously calls the Read service. - - - - - Waits for an asynchronous call to the Read service to complete. - - - - - Invokes the HistoryRead service. - - - - - Asynchronously calls the HistoryRead service. - - - - - Waits for an asynchronous call to the HistoryRead service to complete. - - - - - Invokes the Write service. - - - - - Asynchronously calls the Write service. - - - - - Waits for an asynchronous call to the Write service to complete. - - - - - Invokes the HistoryUpdate service. - - - - - Asynchronously calls the HistoryUpdate service. - - - - - Waits for an asynchronous call to the HistoryUpdate service to complete. - - - - - Invokes the Call service. - - - - - Asynchronously calls the Call service. - - - - - Waits for an asynchronous call to the Call service to complete. - - - - - Invokes the CreateMonitoredItems service. - - - - - Asynchronously calls the CreateMonitoredItems service. - - - - - Waits for an asynchronous call to the CreateMonitoredItems service to complete. - - - - - Invokes the ModifyMonitoredItems service. - - - - - Asynchronously calls the ModifyMonitoredItems service. - - - - - Waits for an asynchronous call to the ModifyMonitoredItems service to complete. - - - - - Invokes the SetMonitoringMode service. - - - - - Asynchronously calls the SetMonitoringMode service. - - - - - Waits for an asynchronous call to the SetMonitoringMode service to complete. - - - - - Invokes the SetTriggering service. - - - - - Asynchronously calls the SetTriggering service. - - - - - Waits for an asynchronous call to the SetTriggering service to complete. - - - - - Invokes the DeleteMonitoredItems service. - - - - - Asynchronously calls the DeleteMonitoredItems service. - - - - - Waits for an asynchronous call to the DeleteMonitoredItems service to complete. - - - - - Invokes the CreateSubscription service. - - - - - Asynchronously calls the CreateSubscription service. - - - - - Waits for an asynchronous call to the CreateSubscription service to complete. - - - - - Invokes the ModifySubscription service. - - - - - Asynchronously calls the ModifySubscription service. - - - - - Waits for an asynchronous call to the ModifySubscription service to complete. - - - - - Invokes the SetPublishingMode service. - - - - - Asynchronously calls the SetPublishingMode service. - - - - - Waits for an asynchronous call to the SetPublishingMode service to complete. - - - - - Invokes the Publish service. - - - - - Asynchronously calls the Publish service. - - - - - Waits for an asynchronous call to the Publish service to complete. - - - - - Invokes the Republish service. - - - - - Asynchronously calls the Republish service. - - - - - Waits for an asynchronous call to the Republish service to complete. - - - - - Invokes the TransferSubscriptions service. - - - - - Asynchronously calls the TransferSubscriptions service. - - - - - Waits for an asynchronous call to the TransferSubscriptions service to complete. - - - - - Invokes the DeleteSubscriptions service. - - - - - Asynchronously calls the DeleteSubscriptions service. - - - - - Waits for an asynchronous call to the DeleteSubscriptions service to complete. - - - - - Populates the known types table. - - - - - A endpoint object used by clients to access a UA service. - - - - - - Initializes the object when it is created by the WCF framework. - - - - - Initializes the when it is created directly. - - - - - Initializes a new instance of the class. - - The server. - - - - The UA server instance that the endpoint is connected to. - - - - - Invokes the FindServers service. - - - - - Asynchronously calls the FindServers service. - - - - - Waits for an asynchronous call to the FindServers service to complete. - - - - - Invokes the FindServersOnNetwork service. - - - - - Asynchronously calls the FindServersOnNetwork service. - - - - - Waits for an asynchronous call to the FindServersOnNetwork service to complete. - - - - - Invokes the GetEndpoints service. - - - - - Asynchronously calls the GetEndpoints service. - - - - - Waits for an asynchronous call to the GetEndpoints service to complete. - - - - - Invokes the RegisterServer service. - - - - - Asynchronously calls the RegisterServer service. - - - - - Waits for an asynchronous call to the RegisterServer service to complete. - - - - - Invokes the RegisterServer2 service. - - - - - Asynchronously calls the RegisterServer2 service. - - - - - Waits for an asynchronous call to the RegisterServer2 service to complete. - - - - - Populates the known types table. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The URI for the OpcUaGds namespace (.NET code namespace is 'Opc.Ua.Gds'). - - - - - The URI for the OpcUaGdsXsd namespace (.NET code namespace is 'Opc.Ua.Gds'). - - - - - The URI for the OpcUa namespace (.NET code namespace is 'Opc.Ua'). - - - - - The URI for the OpcUaXsd namespace (.NET code namespace is 'Opc.Ua'). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The asynchronous service contract which must be implemented by UA servers. - - - - - - The operation contract for the CreateSession service. - - - - - The method used to retrieve the results of a CreateSession service request. - - - - - The operation contract for the ActivateSession service. - - - - - The method used to retrieve the results of a ActivateSession service request. - - - - - The operation contract for the CloseSession service. - - - - - The method used to retrieve the results of a CloseSession service request. - - - - - The operation contract for the Cancel service. - - - - - The method used to retrieve the results of a Cancel service request. - - - - - The operation contract for the AddNodes service. - - - - - The method used to retrieve the results of a AddNodes service request. - - - - - The operation contract for the AddReferences service. - - - - - The method used to retrieve the results of a AddReferences service request. - - - - - The operation contract for the DeleteNodes service. - - - - - The method used to retrieve the results of a DeleteNodes service request. - - - - - The operation contract for the DeleteReferences service. - - - - - The method used to retrieve the results of a DeleteReferences service request. - - - - - The operation contract for the Browse service. - - - - - The method used to retrieve the results of a Browse service request. - - - - - The operation contract for the BrowseNext service. - - - - - The method used to retrieve the results of a BrowseNext service request. - - - - - The operation contract for the TranslateBrowsePathsToNodeIds service. - - - - - The method used to retrieve the results of a TranslateBrowsePathsToNodeIds service request. - - - - - The operation contract for the RegisterNodes service. - - - - - The method used to retrieve the results of a RegisterNodes service request. - - - - - The operation contract for the UnregisterNodes service. - - - - - The method used to retrieve the results of a UnregisterNodes service request. - - - - - The operation contract for the QueryFirst service. - - - - - The method used to retrieve the results of a QueryFirst service request. - - - - - The operation contract for the QueryNext service. - - - - - The method used to retrieve the results of a QueryNext service request. - - - - - The operation contract for the Read service. - - - - - The method used to retrieve the results of a Read service request. - - - - - The operation contract for the HistoryRead service. - - - - - The method used to retrieve the results of a HistoryRead service request. - - - - - The operation contract for the Write service. - - - - - The method used to retrieve the results of a Write service request. - - - - - The operation contract for the HistoryUpdate service. - - - - - The method used to retrieve the results of a HistoryUpdate service request. - - - - - The operation contract for the Call service. - - - - - The method used to retrieve the results of a Call service request. - - - - - The operation contract for the CreateMonitoredItems service. - - - - - The method used to retrieve the results of a CreateMonitoredItems service request. - - - - - The operation contract for the ModifyMonitoredItems service. - - - - - The method used to retrieve the results of a ModifyMonitoredItems service request. - - - - - The operation contract for the SetMonitoringMode service. - - - - - The method used to retrieve the results of a SetMonitoringMode service request. - - - - - The operation contract for the SetTriggering service. - - - - - The method used to retrieve the results of a SetTriggering service request. - - - - - The operation contract for the DeleteMonitoredItems service. - - - - - The method used to retrieve the results of a DeleteMonitoredItems service request. - - - - - The operation contract for the CreateSubscription service. - - - - - The method used to retrieve the results of a CreateSubscription service request. - - - - - The operation contract for the ModifySubscription service. - - - - - The method used to retrieve the results of a ModifySubscription service request. - - - - - The operation contract for the SetPublishingMode service. - - - - - The method used to retrieve the results of a SetPublishingMode service request. - - - - - The operation contract for the Publish service. - - - - - The method used to retrieve the results of a Publish service request. - - - - - The operation contract for the Republish service. - - - - - The method used to retrieve the results of a Republish service request. - - - - - The operation contract for the TransferSubscriptions service. - - - - - The method used to retrieve the results of a TransferSubscriptions service request. - - - - - The operation contract for the DeleteSubscriptions service. - - - - - The method used to retrieve the results of a DeleteSubscriptions service request. - - - - - An interface used by by clients to access a UA server. - - - - - - The operation contract for the CreateSession service. - - - - - The operation contract for the CreateSession service. - - - - - The method used to retrieve the results of a CreateSession service request. - - - - - The async operation contract for the CreateSession service. - - - - - The operation contract for the ActivateSession service. - - - - - The operation contract for the ActivateSession service. - - - - - The method used to retrieve the results of a ActivateSession service request. - - - - - The async operation contract for the ActivateSession service. - - - - - The operation contract for the CloseSession service. - - - - - The operation contract for the CloseSession service. - - - - - The method used to retrieve the results of a CloseSession service request. - - - - - The async operation contract for the CloseSession service. - - - - - The operation contract for the Cancel service. - - - - - The operation contract for the Cancel service. - - - - - The method used to retrieve the results of a Cancel service request. - - - - - The async operation contract for the Cancel service. - - - - - The operation contract for the AddNodes service. - - - - - The operation contract for the AddNodes service. - - - - - The method used to retrieve the results of a AddNodes service request. - - - - - The async operation contract for the AddNodes service. - - - - - The operation contract for the AddReferences service. - - - - - The operation contract for the AddReferences service. - - - - - The method used to retrieve the results of a AddReferences service request. - - - - - The async operation contract for the AddReferences service. - - - - - The operation contract for the DeleteNodes service. - - - - - The operation contract for the DeleteNodes service. - - - - - The method used to retrieve the results of a DeleteNodes service request. - - - - - The async operation contract for the DeleteNodes service. - - - - - The operation contract for the DeleteReferences service. - - - - - The operation contract for the DeleteReferences service. - - - - - The method used to retrieve the results of a DeleteReferences service request. - - - - - The async operation contract for the DeleteReferences service. - - - - - The operation contract for the Browse service. - - - - - The operation contract for the Browse service. - - - - - The method used to retrieve the results of a Browse service request. - - - - - The async operation contract for the Browse service. - - - - - The operation contract for the BrowseNext service. - - - - - The operation contract for the BrowseNext service. - - - - - The method used to retrieve the results of a BrowseNext service request. - - - - - The async operation contract for the BrowseNext service. - - - - - The operation contract for the TranslateBrowsePathsToNodeIds service. - - - - - The operation contract for the TranslateBrowsePathsToNodeIds service. - - - - - The method used to retrieve the results of a TranslateBrowsePathsToNodeIds service request. - - - - - The async operation contract for the TranslateBrowsePathsToNodeIds service. - - - - - The operation contract for the RegisterNodes service. - - - - - The operation contract for the RegisterNodes service. - - - - - The method used to retrieve the results of a RegisterNodes service request. - - - - - The async operation contract for the RegisterNodes service. - - - - - The operation contract for the UnregisterNodes service. - - - - - The operation contract for the UnregisterNodes service. - - - - - The method used to retrieve the results of a UnregisterNodes service request. - - - - - The async operation contract for the UnregisterNodes service. - - - - - The operation contract for the QueryFirst service. - - - - - The operation contract for the QueryFirst service. - - - - - The method used to retrieve the results of a QueryFirst service request. - - - - - The async operation contract for the QueryFirst service. - - - - - The operation contract for the QueryNext service. - - - - - The operation contract for the QueryNext service. - - - - - The method used to retrieve the results of a QueryNext service request. - - - - - The async operation contract for the QueryNext service. - - - - - The operation contract for the Read service. - - - - - The operation contract for the Read service. - - - - - The method used to retrieve the results of a Read service request. - - - - - The async operation contract for the Read service. - - - - - The operation contract for the HistoryRead service. - - - - - The operation contract for the HistoryRead service. - - - - - The method used to retrieve the results of a HistoryRead service request. - - - - - The async operation contract for the HistoryRead service. - - - - - The operation contract for the Write service. - - - - - The operation contract for the Write service. - - - - - The method used to retrieve the results of a Write service request. - - - - - The async operation contract for the Write service. - - - - - The operation contract for the HistoryUpdate service. - - - - - The operation contract for the HistoryUpdate service. - - - - - The method used to retrieve the results of a HistoryUpdate service request. - - - - - The async operation contract for the HistoryUpdate service. - - - - - The operation contract for the Call service. - - - - - The operation contract for the Call service. - - - - - The method used to retrieve the results of a Call service request. - - - - - The async operation contract for the Call service. - - - - - The operation contract for the CreateMonitoredItems service. - - - - - The operation contract for the CreateMonitoredItems service. - - - - - The method used to retrieve the results of a CreateMonitoredItems service request. - - - - - The async operation contract for the CreateMonitoredItems service. - - - - - The operation contract for the ModifyMonitoredItems service. - - - - - The operation contract for the ModifyMonitoredItems service. - - - - - The method used to retrieve the results of a ModifyMonitoredItems service request. - - - - - The async operation contract for the ModifyMonitoredItems service. - - - - - The operation contract for the SetMonitoringMode service. - - - - - The operation contract for the SetMonitoringMode service. - - - - - The method used to retrieve the results of a SetMonitoringMode service request. - - - - - The async operation contract for the SetMonitoringMode service. - - - - - The operation contract for the SetTriggering service. - - - - - The operation contract for the SetTriggering service. - - - - - The method used to retrieve the results of a SetTriggering service request. - - - - - The async operation contract for the SetTriggering service. - - - - - The operation contract for the DeleteMonitoredItems service. - - - - - The operation contract for the DeleteMonitoredItems service. - - - - - The method used to retrieve the results of a DeleteMonitoredItems service request. - - - - - The async operation contract for the DeleteMonitoredItems service. - - - - - The operation contract for the CreateSubscription service. - - - - - The operation contract for the CreateSubscription service. - - - - - The method used to retrieve the results of a CreateSubscription service request. - - - - - The async operation contract for the CreateSubscription service. - - - - - The operation contract for the ModifySubscription service. - - - - - The operation contract for the ModifySubscription service. - - - - - The method used to retrieve the results of a ModifySubscription service request. - - - - - The async operation contract for the ModifySubscription service. - - - - - The operation contract for the SetPublishingMode service. - - - - - The operation contract for the SetPublishingMode service. - - - - - The method used to retrieve the results of a SetPublishingMode service request. - - - - - The async operation contract for the SetPublishingMode service. - - - - - The operation contract for the Publish service. - - - - - The operation contract for the Publish service. - - - - - The method used to retrieve the results of a Publish service request. - - - - - The async operation contract for the Publish service. - - - - - The operation contract for the Republish service. - - - - - The operation contract for the Republish service. - - - - - The method used to retrieve the results of a Republish service request. - - - - - The async operation contract for the Republish service. - - - - - The operation contract for the TransferSubscriptions service. - - - - - The operation contract for the TransferSubscriptions service. - - - - - The method used to retrieve the results of a TransferSubscriptions service request. - - - - - The async operation contract for the TransferSubscriptions service. - - - - - The operation contract for the DeleteSubscriptions service. - - - - - The operation contract for the DeleteSubscriptions service. - - - - - The method used to retrieve the results of a DeleteSubscriptions service request. - - - - - The async operation contract for the DeleteSubscriptions service. - - - - - The asynchronous service contract which must be implemented by UA servers. - - - - - - The operation contract for the FindServers service. - - - - - The method used to retrieve the results of a FindServers service request. - - - - - The operation contract for the FindServersOnNetwork service. - - - - - The method used to retrieve the results of a FindServersOnNetwork service request. - - - - - The operation contract for the GetEndpoints service. - - - - - The method used to retrieve the results of a GetEndpoints service request. - - - - - An interface used by by clients to access a UA server. - - - - - - The operation contract for the FindServers service. - - - - - The operation contract for the FindServers service. - - - - - The method used to retrieve the results of a FindServers service request. - - - - - The async operation contract for the FindServers service. - - - - - The operation contract for the FindServersOnNetwork service. - - - - - The operation contract for the FindServersOnNetwork service. - - - - - The method used to retrieve the results of a FindServersOnNetwork service request. - - - - - The async operation contract for the FindServersOnNetwork service. - - - - - The operation contract for the GetEndpoints service. - - - - - The operation contract for the GetEndpoints service. - - - - - The method used to retrieve the results of a GetEndpoints service request. - - - - - The async operation contract for the GetEndpoints service. - - - - - The asynchronous service contract which must be implemented by UA servers. - - - - - - The operation contract for the RegisterServer service. - - - - - The method used to retrieve the results of a RegisterServer service request. - - - - - The operation contract for the RegisterServer2 service. - - - - - The method used to retrieve the results of a RegisterServer2 service request. - - - - - An interface used by by clients to access a UA server. - - - - - - The operation contract for the RegisterServer service. - - - - - The operation contract for the RegisterServer service. - - - - - The method used to retrieve the results of a RegisterServer service request. - - - - - The async operation contract for the RegisterServer service. - - - - - The operation contract for the RegisterServer2 service. - - - - - The operation contract for the RegisterServer2 service. - - - - - The method used to retrieve the results of a RegisterServer2 service request. - - - - - The async operation contract for the RegisterServer2 service. - - - - - The message contract for the FindServers service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the FindServers service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the FindServersOnNetwork service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the FindServersOnNetwork service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the GetEndpoints service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the GetEndpoints service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the RegisterServer service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the RegisterServer service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the RegisterServer2 service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the RegisterServer2 service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the OpenSecureChannel service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the OpenSecureChannel service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the CloseSecureChannel service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the CloseSecureChannel service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the CreateSession service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the CreateSession service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the ActivateSession service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the ActivateSession service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the CloseSession service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the CloseSession service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the Cancel service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the Cancel service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the AddNodes service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the AddNodes service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the AddReferences service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the AddReferences service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the DeleteNodes service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the DeleteNodes service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the DeleteReferences service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the DeleteReferences service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the Browse service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the Browse service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the BrowseNext service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the BrowseNext service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the TranslateBrowsePathsToNodeIds service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the TranslateBrowsePathsToNodeIds service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the RegisterNodes service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the RegisterNodes service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the UnregisterNodes service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the UnregisterNodes service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the QueryFirst service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the QueryFirst service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the QueryNext service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the QueryNext service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the Read service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the Read service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the HistoryRead service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the HistoryRead service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the Write service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the Write service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the HistoryUpdate service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the HistoryUpdate service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the Call service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the Call service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the CreateMonitoredItems service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the CreateMonitoredItems service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the ModifyMonitoredItems service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the ModifyMonitoredItems service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the SetMonitoringMode service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the SetMonitoringMode service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the SetTriggering service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the SetTriggering service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the DeleteMonitoredItems service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the DeleteMonitoredItems service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the CreateSubscription service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the CreateSubscription service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the ModifySubscription service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the ModifySubscription service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the SetPublishingMode service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the SetPublishingMode service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the Publish service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the Publish service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the Republish service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the Republish service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the TransferSubscriptions service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the TransferSubscriptions service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - The message contract for the DeleteSubscriptions service. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - - - - - - - The message contract for the DeleteSubscriptions service response. - - - - - - The body of the message. - - - - - Initializes an empty message. - - - - - Initializes the message with the body. - - - - - Initializes the message with a service fault. - - - - - An interface to a UA server implementation. - - - - - - Invokes the FindServers service. - - - - - Invokes the FindServersOnNetwork service. - - - - - Invokes the GetEndpoints service. - - - - - Invokes the CreateSession service. - - - - - Invokes the ActivateSession service. - - - - - Invokes the CloseSession service. - - - - - Invokes the Cancel service. - - - - - Invokes the AddNodes service. - - - - - Invokes the AddReferences service. - - - - - Invokes the DeleteNodes service. - - - - - Invokes the DeleteReferences service. - - - - - Invokes the Browse service. - - - - - Invokes the BrowseNext service. - - - - - Invokes the TranslateBrowsePathsToNodeIds service. - - - - - Invokes the RegisterNodes service. - - - - - Invokes the UnregisterNodes service. - - - - - Invokes the QueryFirst service. - - - - - Invokes the QueryNext service. - - - - - Invokes the Read service. - - - - - Invokes the HistoryRead service. - - - - - Invokes the Write service. - - - - - Invokes the HistoryUpdate service. - - - - - Invokes the Call service. - - - - - Invokes the CreateMonitoredItems service. - - - - - Invokes the ModifyMonitoredItems service. - - - - - Invokes the SetMonitoringMode service. - - - - - Invokes the SetTriggering service. - - - - - Invokes the DeleteMonitoredItems service. - - - - - Invokes the CreateSubscription service. - - - - - Invokes the ModifySubscription service. - - - - - Invokes the SetPublishingMode service. - - - - - Invokes the Publish service. - - - - - Invokes the Republish service. - - - - - Invokes the TransferSubscriptions service. - - - - - Invokes the DeleteSubscriptions service. - - - - - A basic implementation of the UA server. - - - - - - Invokes the FindServers service. - - - - - Invokes the FindServersOnNetwork service. - - - - - Invokes the GetEndpoints service. - - - - - Invokes the CreateSession service. - - - - - Invokes the ActivateSession service. - - - - - Invokes the CloseSession service. - - - - - Invokes the Cancel service. - - - - - Invokes the AddNodes service. - - - - - Invokes the AddReferences service. - - - - - Invokes the DeleteNodes service. - - - - - Invokes the DeleteReferences service. - - - - - Invokes the Browse service. - - - - - Invokes the BrowseNext service. - - - - - Invokes the TranslateBrowsePathsToNodeIds service. - - - - - Invokes the RegisterNodes service. - - - - - Invokes the UnregisterNodes service. - - - - - Invokes the QueryFirst service. - - - - - Invokes the QueryNext service. - - - - - Invokes the Read service. - - - - - Invokes the HistoryRead service. - - - - - Invokes the Write service. - - - - - Invokes the HistoryUpdate service. - - - - - Invokes the Call service. - - - - - Invokes the CreateMonitoredItems service. - - - - - Invokes the ModifyMonitoredItems service. - - - - - Invokes the SetMonitoringMode service. - - - - - Invokes the SetTriggering service. - - - - - Invokes the DeleteMonitoredItems service. - - - - - Invokes the CreateSubscription service. - - - - - Invokes the ModifySubscription service. - - - - - Invokes the SetPublishingMode service. - - - - - Invokes the Publish service. - - - - - Invokes the Republish service. - - - - - Invokes the TransferSubscriptions service. - - - - - Invokes the DeleteSubscriptions service. - - - - - An interface to a UA server implementation. - - - - - - Invokes the FindServers service. - - - - - Invokes the FindServersOnNetwork service. - - - - - Invokes the GetEndpoints service. - - - - - Invokes the RegisterServer service. - - - - - Invokes the RegisterServer2 service. - - - - - A basic implementation of the UA server. - - - - - - Invokes the FindServers service. - - - - - Invokes the FindServersOnNetwork service. - - - - - Invokes the GetEndpoints service. - - - - - Invokes the RegisterServer service. - - - - - Invokes the RegisterServer2 service. - - - - - This interface is used by ContentFilterOperation to get values from the - NodeSet for use by the various filter operators. All NodeSets used in a - ContentFilter must implement this interface. - - - - - Checks whether the target is an instance of the specified type. - - The context to use when checking the type definition. - The type of the instance. - - True if the object is an instance of the specified type. - - - - - Returns the value of an attribute identified by the operand. - - The context to use when evaluating the operand. - The type of the instance. - The path from the instance to the node which defines the attribute. - The attribute to return. - The sub-set of an array value to return. - - The attribute value. Returns null if the attribute does not exist. - - - - - This interface is used by ContentFilterOperation to get values from the - NodeSet for use by the various filter operators. All NodeSets used in a - ContentFilter must implement this interface. - - - - - Checks whether the target is an instance is in the specified view. - - The context to use when checking the biew. - The identifier for the view. - True if the instance is in the view. - - - - Returns TRUE if the node is related to the current target. - - - - - Returns the list of nodes related to the current target. - - - - - Returns the value of attributes for nodes which are related to the current node. - - The context to use when evaluating the operand. - The type of the instance. - The relative path to the attribute. - The attribute to return. - The sub-set of an array value to return. - - The attribute value. Returns null if the attribute does not exist. - - - - - Provides context information to used when searching the address space. - - - - - Initializes the context. - - The namespace URIs. - The type tree. - The context. - - - - Initializes the context. - - The namespace URIs. - The type tree. - - - - Initializes the context. - - The namespace URIs. - The type tree. - The preferred locales. - - - - The namespace table to use when evaluating filters. - - The namespace URIs. - - - - The type tree to use when evaluating filters. - - The type tree. - - - - The identifier for the session (null if multiple sessions are associated with the operation). - - The session identifier. - - - - The identity of the user. - - The user identity. - - - - The locales to use if available. - - The preferred locales. - - - - The mask to use when collecting any diagnostic information. - - The diagnostics mask. - - - - The table of strings which is used to store diagnostic string data. - - The string table. - - - - When the operation times out. - - The operation deadline. - - - - The current status of the the operation (bad if the operation has been aborted). - - The operation status. - - - - The audit identifier associated with the operation. - - The audit entry identifier. - - - - An interface to an object that describes a node. - - - - - The node identifier. - - The node identifier. - - - - The node class. - - The node class. - - - - The locale independent browse name. - - The name of the browse. - - - - The localized display name. - - The display name. - - - - The identifier for the TypeDefinition node. - - The type definition identifier. - - - - An interface to an object that describes a node local to the server. - - - - - A synchronization object that can be used to safely access the node. - - The data lock. - - - - A handle assigned to the node. - - The handle. - - - - The node identifier. - - The node identifier. - - - - The locale independent browse name. - - The name of the browse. - - - - The localized display name. - - The display name. - - - - The localized description - - The description. - - - - A mask indicating which attributes are writeable. - - The write mask. - - - - A mask indicating which attributes that are writeable for the current user. - - The user write mask. - - - - The identifier for the ModellingRule node. - - The modelling rule. - - - - The collection of references for the node. - - The references. - - - - Creates a copy of the node. - - The node identifier. - Copy of the node. - - - - Returns true if the node supports the attribute. - - The attribute identifier. - True if the node supports the attribute. - - - - Reads the value of a attribute. - - The context. - The attribute identifier. - The value. - The result of read operation. - - - - Writes the value of an attribute. - - The attribute identifier. - The value. - The result of Write operation - - - - An interface to an object that describes an ObjectType node. - - - - - Whether the type is an abstract type. - - - - - An interface to an object that describes an Object node. - - - - - Whether the object supports events. - - - - - An interface to an object that describes either a Variable or a VariableType node. - - - - - The value attribute. - - The value. - - - - The data type for the value attribute. - - The type of the data. - - - - Specifies whether the the value is an array or scalar. - - The value rank. - - - - The number in each dimension of an array value. - - The array dimensions. - - - - An interface to an object that describes a VariableType node. - - - - - Whether the type is an abstract type. - - - - - An interface to an object that describes a Variable node. - - - - - The type of access supported by variable. - - The access level. - - - - The type of access supported by variable for the current user. - - The user access level. - - - - The minimum sampling interval supported by the variable. - - The minimum sampling interval. - - - - Whether historical data is being archived for the variable. - - true if historizing; otherwise, false. - - - - An interface to an object that describes a DataType node. - - - - - Whether the method is currently executable. - - true if executable; otherwise, false. - - - - Whether the method is currently executable by the current user. - - true if executable by user; otherwise, false. - - - - An interface to an object that describes a DataType node. - - - - - Whether the type is an abstract type. - - - true if this instance is abstract; otherwise, false. - - - - - An interface to an object that describes a ReferenceType node. - - - - - Whether the type is an abstract type. - - - true if this instance is abstract; otherwise, false. - - - - - Whether the reference type has the same meaning in both directions. - - true if symmetric; otherwise, false. - - - - Whether the reference type has the same meaning in both directions. - - The name of the inverse. - - - - An interface to an object that describes a View node. - - - - - Whether the view supports events. - - The event notifier. - - - - Whether the view contains no loops. - - true if contains no loops; otherwise, false. - - - - An interface to an object that describes a node local to the server. - - - - - The identifier for the session (null if multiple sessions are associated with the operation). - - The session identifier. - - - - The identity of the user. - - The user identity. - - - - The locales to use if available. - - The preferred locales. - - - - The mask to use when collecting any diagnostic information. - - The diagnostics mask. - - - - The table of strings which is used to store diagnostic string data. - - The string table. - - - - When the operation times out. - - The operation deadline. - - - - The current status of the the operation (bad if the operation has been aborted). - - The operation status. - - - - The audit identifier associated with the operation. - - The audit entry identifier. - - - - A set of nodes in an address space. - - - - - Creates an empty nodeset. - - - - - Loads a nodeset from a stream. - - The input stream. - The set of nodes - - - - Write a nodeset to a stream. - - The input stream. - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Adds a node to the set. - - The node. - - The NodeId must reference the strings for the node set. - - - - - Translates all elements in an array value. - - The array. - Type of the element. - The namespace URIs. - The server URIs. - - - - Translates a value. - - The value. - The namespace URIs. - The server URIs. - Translated value. - - - - Adds a node to the set after translating all namespace/server indexes in attributes or references. - - The node to export. - The namespace URIs. - The server URIs. - The node. - - Does not add references. - - - - - Translates a reference and adds it to the specified node. - - The node. - The reference to export. - The namespace URIs. - The server URIs. - - - - Removes a node from the set. - - The node identifier. - The result of the removal. - - The NodeId must reference the strings for the node set. - - - - - Returns true if the node exists in the nodeset. - - The node identifier. - - true if the node exists in the nodeset; otherwise, false. - - - The NodeId must reference the strings for the node set. - - - - - Returns the node in the set. - - The node identifier. - The node in the set. - - The NodeId must reference the strings for the node set. - - - - - Returns the node in the set. - - The node identifier. - The namespace URIs. - The node in the set. - - The NodeId namespace is translated before the node is looked up. - - - - - Translates all namespace/server indexes in attributes or references and returns a copy of the node. - - The node to import. - The namespace URIs. - The server URIs. - Translated copy of the node. - - Only imports references stored in the References collection. - - - - - Recursively imports any NodeIds or ExpandedNodeIds contained in a value. - - The value. - The namespace URIs. - The server URIs. - - - - - Updates the nodeset string tables and returns a NodeId that references those tables. - - The node identifier. - The namespace URIs. - A NodeId that references those tables. - - - - Updates the specified namespace tables and returns a NodeId that references those tables. - - The node identifier. - The namespace URIs. - A NodeId that references those tables. - - - - Updates the nodeset string tables and returns a NodeId that references those tables. - - The node identifier. - The namespace URIs. - The server URIs. - A NodeId that references those tables. - - - - Updates the specified string tables and returns a NodeId that references those tables. - - The node identifier. - The namespace URIs. - The server URIs. - A NodeId that references those tables. - - - - The table of namespaces. - - - - - The table of servers. - - - - - The table of nodes. - - - - - Updates the nodeset string tables and returns a NodeId that references those tables. - - The node identifier. - The target namespace URIs. - The source namespace URIs. - A NodeId that references those tables. - - - - Updates the nodeset string tables and returns a NodeId that references those tables. - - The qualified name. - The target namespace URIs. - The source namespace URIs. - A NodeId that references those tables. - - - - Updates the nodeset string tables and returns a NodeId that references those tables. - - The node identifier. - The target namespace URIs. - The target server URIs. - The source namespace URIs. - The source server URIs. - A NodeId that references those tables. - - - - Provides context information to used when evaluating filters. - - - - - The table of Namespace URIs used by the table. - - The namespace URIs. - - - - The table of Server URIs used by the table. - - The server URIs. - - - - The type model that describes the nodes in the table. - - The type tree. - - - - Returns true if the node is in the table. - - The node identifier. - True if the node is in the table. - - - - Finds a node in the node set. - - The node identifier. - Returns null if the node does not exist. - - - - Follows the reference from the source and returns the first target with the specified browse name. - - The source identifier. - The reference type identifier. - if set to true this is inverse reference. - if set to true subtypes are included. - Name of the browse. - - Returns null if the source does not exist or if there is no matching target. - - - - - Follows the reference from the source and returns all target nodes. - - The source identifier. - The reference type identifier. - if set to true this is inverse reference. - if set to true subtypes are included. - - Returns an empty list if the source does not exist or if there are no matching targets. - - - - - A table of nodes. - - - - - Initializes the object. - - The namespace URIs. - The server URIs. - The type tree. - - - - - - - - - - - - - - - - - - - - - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - The number of nodes in the table. - - The count. - - - - Adds a set of nodes to the table. - - The node set. - The external references. - - - - - Creates/updates a node from a ReferenceDescription. - - The reference. - Node - - - - Adds a node to the table (takes ownership of the object passed in). - - The node. - - Any existing node is removed. - - - - - Removes node from the table. - - The node identifier. - The result of removal. - - - - Removes all references from the table. - - - - - Adds the node to the table. - - The node. - - - - Removes the node from the table. - - The node. - - - - Adds the remote node to the table. - - The node. - - - - Removes the remote node from the table. - - The node. - - - - Finds the specified node. Returns null if the node does node exist. - - The node identifier. - - - - - Stores information for a node on a remote server. - - - - - Initializes the object. - - The owner. - The node identifier. - - - - Adds a reference to the node. - - The number of references. - - - - Removes a reference to the node. - - The number of references. - - - - The cached type definition id for the remote node. - - The type definition identifier. - - - - The node identifier. - - The node identifier. - - - - The node class. - - The node class. - - - - The locale independent browse name. - - The name of the browse. - - - - The localized display name. - - The display name. - - - - A reference to a node. - - - - - The type of reference. - - The reference type identifier. - - - - True if the reference is an inverse reference. - - - true if this instance is inverse; otherwise, false. - - - - - The identifier for the target node. - - The target identifier. - - - - A reference to a node. - - - - - Adds the reference to the node. - - The reference type identifier. - if set to true this is inverse reference. - The target identifier. - - - - Removes the reference from the node. - - The reference type identifier. - if set to true this is inverse reference. - The target identifier. - The result of removal. - - - - Removes all of the specified references. - - The reference type identifier. - if set to true this is inverse reference. - The result of removal. - - - - Checks whether any references which meet the specified critia exist. - - The reference type identifier. - if set to true this is inverse reference. - The target identifier. - if set to true subtypes are included. - The type tree. - True if reference exists. - - - - Returns a list of references which match the specified criteria. - - The reference type identifier. - if set to true this is inverse reference. - if set to true subtypes are included. - The type tree. - A list of references which match the specified criteria. - - - - Returns a single target that meets the specifed criteria. - - The reference type identifier. - if set to true this is inverse reference. - if set to true subtypes are included. - The type tree. - The index. - A single target that meets the specifed criteria. - - - - Returns a list of references to the specified target. - - The target identifier. - A list of references to the specified target. - - - - A table of references for a node. - - - - - Initializes the object. - - - - - Returns a string representation of the ReferenceCollection. - - - A that represents the current . - - - - - Returns a string representation of the ReferenceCollection. - - The specifying the format to use. - -or- - null to use the default format defined for the type of the implementation. - The to use to format the value. - -or- - null to obtain the numeric format information from the current locale setting of the operating system. - - A containing the value of the current instance in the specified format. - - - - - Adds the reference to the node. - - The reference type identifier. - if set to true this is inverse reference. - The target identifier. - - - - Removes the reference from the node. - - The reference type identifier. - if set to true this is inverse reference. - The target identifier. - The result of removal. - - - - Removes all of the specified references. - - The reference type identifier. - if set to true this is inverse reference. - The result of removal. - - - - Checks whether any references which meet the specified critia exist. - - The reference type identifier. - if set to true this is inverse reference. - The target identifier. - if set to true subtypes are included. - The type tree. - True if reference exists. - - - - Returns a list of references which match the specified criteria. - - The reference type identifier. - if set to true this is inverse reference. - if set to true subtypes are included. - The type tree. - A list of references which match the specified criteria. - - - - Returns a single target that meets the specifed criteria. - - The reference type identifier. - if set to true this is inverse reference. - if set to true subtypes are included. - The type tree. - The index. - A single target that meets the specifed criteria. - - - - Returns a list of references to the specified target. - - The target identifier. - A list of references to the specified target. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A dictionary designed to provide efficient lookups for references. - - - - - Creates an empty dictionary. - - - - - Returns true if the dictionary contains a reference that matches any subtype of the reference type. - - The reference. - The type tree. - - true if the dictionary contains key; otherwise, false. - - - - - Returns a list of references that match the direction and reference type. - - The reference type identifier. - if set to true this is inverse reference. - A list of references that match the direction and reference type. - - - - Returns a list of references that match the direction and are subtypes of the reference type. - - The reference type identifier. - if set to true this is inverse reference. - The type tree. - A list of references that match the direction and are subtypes of the reference type. - - - - Returns a list of references to the specified target. - - The target identifier. - A list of references to the specified target. - - - - Removes all of the references of the specified type and direction. - - The reference type identifier. - if set to true this is inverse reference. - The result of removal. - - - - - - - - - - - - - - - - - - - - - - Gets or sets the value with the specified NodeId. - - The value with the specified NodeId. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Stores the references for a particular reference type. - - - - - Whether the entry is empty. - - true if this instance is empty; otherwise, false. - - - - Validates a reference passed as a parameter. - - The key. - if set to true [throw on error]. - The result of the validation. - - - - Returns the target entry associated with the reference. - - The key. - The value. - The target entry associated with the reference. - - - - Adds or replaces a reference. - - The key. - The value. - if set to true reference is replaced. - - - - Checks the isInverse flag are returns true if a specified target exists. - - The entry. - The reference. - - true if the specified entry contains key; otherwise, false. - - - - - Add references to a list that match the criteria. - - The entry. - if set to true this is inverse reference. - The hits. - - - - Stores the type tree for a server. - - - - - Initializes the object with default values. - - The namespace URIs. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Removes all types from the tree. - - - - - Adds a node to the type table if it is a type and does not already exist. If it exists references are updated. - - The node. - - - - Adds type to the table. A browse name is only required if it is a ReferenceType. - - The sub type identifier. - The super type identifier. - - Updates the any existing entry. - - - - - Adds type to the table. A browse name is only required if it is a ReferenceType. - - The sub type identifier. - The super type identifier. - Name of the browse. - - Updates the any existing entry. - - - - - Adds an encoding for an existing data type. - - - - - Adds type to the table. A browse name is only required if it is a ReferenceType. - - The sub type identifier. - The super type identifier. - Name of the browse. - - Updates the any existing entry. - - - - - Removes a subtype. - - The type identifier. - - - - Stores the information about an indexed type. - - - - - Checks if the type is a subtype of the specified node. - - The node identifier. - - true if this node is type of the specified NodeId otherwise, false. - - - - - Adds a subtype to the object. - - The subtype - - - - Remove subtype. - - The subtype identifier. - - - - Adds the subtypes to the list. - - The node identifiers. - - - - The table of all reference types known to the server. - - This class is thread safe. - - - - Initializes the object with default values. - - - - - Determines whether a node id is a valid view id. - - The description. - - true if the specified description is valid; otherwise, false. - - - - - Determines whether a node is in a view. - - The description. - The node id. - - true whether a node is in a view; otherwise, false. - - - - - Determines whether a reference is in a view. - - The description. - The reference. - - true whether a reference is in a view; otherwise, false. - - - - - Adds a view to the table. - - The view. - - - - Removes a view from the table. - - The view identifier. - - - - A base class for UA endpoints. - - - - - Initializes the object when it is created by the WCF framework. - - - - - Initializes the when it is created directly. - - The host. - - - - Initializes the endpoint with a server instead of a host. - - - - - Begins processing a request received via a binary encoded channel. - - A unique identifier for the secure channel which is the source of the request. - The description of the endpoint which the secure channel is using. - The incoming request. - The callback. - The callback data. - - The result which must be passed to the EndProcessRequest method. - - - - - - - Ends processing a request received via a binary encoded channel. - - The result returned by the BeginProcessRequest method. - - The response to return over the secure channel. - - - - - - - - - - - - - - - Dispatches an incoming binary encoded request. - - Incoming request. - - - - Dispatches an incoming binary encoded request. - - - - - Dispatches an incoming binary encoded request. - - The async result. - - - - Returns the host associated with the current context. - - The host associated with the current context. - - - - Returns the host associated with the current context. - - The host associated with the current context. - - - - Gets the server object from the operation context. - - The server object from the operation context. - - - - Gets the server object from the operation context. - - The server object from the operation context. - - - - Find the endpoint description for the endpoint. - - - - - Finds the service identified by the request type. - - - - - Creates a fault message. - - The request. - The exception. - A fault message. - - - - Creates a fault message. - - The request. - The exception. - A fault message. - - - - Returns the message context used by the server associated with the endpoint. - - The message context. - - - - Returns the description for the endpoint - - The endpoint description. - - - - Returns the error of the server. - - The server error. - - - - The types of services known to the server. - - - - - Sets the request context for the thread. - - The encoding. - - - - Called when a new request is received by the endpoint. - - The request. - - - - Called when a response sent via the endpoint. - - The response. - - - - Called when a response fault sent via the endpoint. - - The fault. - - - - Stores the definition of a service supported by the server. - - - - - Initializes the object with its request type and implementation. - - Type of the request. - The invoke method. - - - - The system type of the request object. - - The type of the request. - - - - The system type of the request object. - - The type of the response. - - - - Processes the request. - - The request. - - - - - A delegate used to dispatch incoming service requests. - - - - - An AsyncResult object when handling an asynchronous request. - - - - - Initializes a new instance of the class. - - The endpoint being called. - The callback to use when the operation completes. - The callback data. - The timeout in milliseconds - - - - Gets the request. - - The request. - - - - Gets the secure channel context associated with the request. - - The secure channel context. - - - - Gets or sets the call data associated with the request. - - The call data. - - - - Used to call the default synchronous handler. - - - This method may block the current thread so the caller must not call in the - thread that calls IServerBase.ScheduleIncomingRequest(). - This method always traps any exceptions and reports them to the client as a fault. - - - - - Used to indicate that the asynchronous operation has completed. - - The response. May be null if an error is provided. - - - - - Begins processing an incoming request. - - The security context for the request - The request data. - - The result object that is used to call the EndProcessRequest method. - - - - - Begins processing an incoming request. - - The security context for the request - The request. - The result object that is used to call the EndProcessRequest method. - - - - Checks for a valid IAsyncResult object and waits for the operation to complete. - - The IAsyncResult object for the operation. - if set to true an exception is thrown if an error occurred. - The response. - - - - Checks for a valid IAsyncResult object and returns the original request object. - - The IAsyncResult object for the operation. - The request object if available; otherwise null. - - - - Saves an exception as response. - - The exception. - - - - Processes the request. - - - - - This is an interface to a object that receives audit event notifications. - - - - - Report the open secure channel audit event. - - The global unique channel id. - The endpoint description used for the request. - The incoming - The client certificate. - The exception resulted from the open secure channel request. - - - - Report the close secure channel audit event. - - The global unique channel id. - The exception resulted from the open secure channel request. - - - - Report certificate audit event. - - The client certificate. - The Exception that triggers a certificate audit event. - - - - The base asynchronous interface for all services exposed by UA servers. - - - - - The operation contract for the InvokeService service. - - - - - The method used to retrieve the results of a InvokeService service request. - - - - - An interface to a service response message. - - - - - The message context to use with the service. - - - The context information associated with a UA server that is used during message processing. - - - - - An error condition that describes why the server if not running (null if no error exists). - - The object that combines the status code and diagnostic info structures. - - - - Returns the endpoints supported by the server. - - Returns a collection of objects. - - - - Schedules an incoming request. - - The request. - - - - An interface to an object that manages a request received from a client. - - - - - Gets the request. - - The request. - - - - Gets the secure channel context associated with the request. - - The secure channel context. - - - - Gets or sets the call data associated with the request. - - The call data. - - - - Used to call the default synchronous handler. - - - This method may block the current thread so the caller must not call in the - thread that calls IServerBase.ScheduleIncomingRequest(). - This method always traps any exceptions and reports them to the client as a fault. - - - - - Used to indicate that the asynchronous operation has completed. - - The response. May be null if an error is provided. - An error to result as a fault. - - - - An interface for the service host object. - - - - - The UA server instance associated with the service host. - - An object of interface to a service response message. - - - - Stores context information for the current secure channel. - - - - - Initializes a new instance with the specified property values. - - The secure channel identifier. - The endpoint description. - The message encoding. - - - - Initializes a new instance with the context for the current thread. - - - - - TThe unique identifier for the secure channel. - - The secure channel identifier. - - - - The description of the endpoint used with the channel. - - The endpoint description. - - - - The encoding used with the channel. - - The message encoding. - - - - The active secure channel for the thread. - - The current secure channel context. - - - - The message encoding used with a request. - - - - - The request used the UA binary encoding. - - - - - The request used the UA XML encoding. - - - - - A base class for a UA server implementation. - - - - - Initializes object with default values. - - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - The message context to use with the service. - - The message context that stores context information associated with a UA - server that is used during message processing. - - - - - An error condition that describes why the server if not running (null if no error exists). - - The object that combines the status code and diagnostic info structures. - - - - Returns the endpoints supported by the server. - - Returns a collection of EndpointDescription. - - - - Schedules an incoming request. - - The request. - - - - - - - - - - - - - Raised when the status of a monitored connection changes. - - - - - Raised when a connection arrives and is waiting for a callback. - - - - - Creates a new connection with a client. - - - - - Starts the server. - - The object that stores the configurable configuration information - for a UA application - The array of Uri elements which contains base addresses. - Returns a host for a UA service. - - - - Starts the server (called from a dedicated host process). - - The object that stores the configurable configuration - information for a UA application. - - - - - Initializes the list of base addresses. - - - - - Returns the discovery URLs for the server. - - - - - Initializes the request queue. - - The configuration. - - - - Stops the server and releases all resources. - - - - - Creates an instance of the service host. - - - - - Stores information about a base address. - - - - - The URL for the base address. - - - - - Alternate URLs for the base address. - - - - - The profile URL for the address. - - - - - The discovery URL for the address. - - - - - Gets the list of base addresses supported by the server. - - - - - Gets the list of endpoints supported by the server. - - - - - The object used to verify client certificates - - The identifier for an X509 certificate. - - - - The server's application instance certificate. - - The instance X.509 certificate. - - - - Gets the instance certificate chain. - - - - - The non-configurable properties for the server. - - The properties of the current server instance. - - - - The configuration for the server. - - Object that stores the configurable configuration information for a UA application - - - - The application description for the server. - - Object that contains a description for the ApplicationDescription DataType. - - - - Gets the list of service hosts used by the server instance. - - The service hosts. - - - - Gets or set the capabilities for the server. - - - - - Gets the list of transport listeners used by the server instance. - - The transport listeners. - - - - Returns the service contract to use. - - - - - Returns an instance of the endpoint to use. - - - - - Specifies if the server requires encryption; if so the server needs to send its certificate to the clients and validate the client certificates - - The description. - - - - Called after the application certificate update. - - - - - Create the transport listener for the service host endpoint. - - The endpoint Uri. - The description of the endpoints. - The configuration of the endpoints. - The transport listener. - The certificate validator for the transport. - - - - Returns the UserTokenPolicies supported by the server. - - The configuration. - The description. - - Returns a collection of UserTokenPolicy objects, - the return type is . - - - - - Checks for IP address or well known hostnames that map to the computer. - - The hostname. - The hostname to use for URL filtering. - - - - Filters the list of addresses by profile. - - - - - Filters the list of addresses by the URL that the client provided. - - - - - Returns the best discovery URL for the base address based on the URL used by the client. - - - - - Translates the discovery URLs based on the client url and returns an updated ApplicationDescription. - - The client URL. - The application description. - The base addresses. - The localized application name. - A copy of the application description - - - - Translates the endpoint descriptions based on the client url and profiles provided. - - The client URL. - The base addresses. - The endpoints. - The application to use with the endpoints. - The translated list of endpoints. - - - - Verifies that the request header is valid. - - The object that contains description for the RequestHeader DataType. - - - - Creates the response header. - - The object that contains description for the RequestHeader DataType. - The status code. - If statusCode is bad. - Returns a description for the ResponseHeader DataType. - - - - Creates the response header. - - The object that contains description for the RequestHeader DataType. - The exception used to create DiagnosticInfo assigned to the ServiceDiagnostics. - Returns a description for the ResponseHeader DataType. - - - - Creates the response header. - - The object that contains description for the RequestHeader DataType. - The thread safe table of string constants. - Returns a description for the ResponseHeader DataType. - - - - Called when the server configuration is changed on disk. - - The object that stores the configurable configuration information for a UA application. - - Servers are free to ignore changes if it is difficult/impossible to apply them without a restart. - - - - - Called before the server starts. - - The object that stores the configurable configuration information for a UA application. - - - - Creates the endpoints and creates the hosts. - - The object that stores the configurable configuration information for a UA application. - The object of a class that manages a mapping between a URL scheme and a listener. - The object of the class that contains a description for the ApplicationDescription DataType. - The collection of objects. - Returns list of hosts for a UA service. - - - - Starts the server application. - - The object that stores the configurable configuration information for a UA application. - - - - Called before the server stops - - - - - Returns the properties for associated with the server instance. - - Returns the properties of the current server instance. - - - - Processes the request. - - The request. - The calldata passed with the request. - - - - Manages a queue of requests. - - - - - Initializes a new instance of the class. - - The server. - The minimum number of threads in the pool. - The maximum number of threads in the pool. - The maximum number of requests that will placed in the queue. - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - Schedules an incoming request. - - The request. - - - - Processes the requests in the request queue. - - - - - The state of the service host. - - - - - The service host is in closed state. - - - - - The service host is in open state. - - - - - A host for a UA service. - - - - - Initializes the service host. - - The server. - Type of the endpoint. - The addresses. - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - - - - Called when the service host is opened. - - - - - Called when the service host is open to abort operation. - - - - - Called when the service host is closed. - - - - - State of the service host. - - - - - Used to receive notifications when a alarm is shelved or unshelved. - - The current system context. - The alarm that raised the event. - True if the condition is being shelved. - True if the condition is being until it goes inactive (i.e. OneShotShelve). - How long to shelve the condition. - - - - Used to receive notifications when the timed shelve period elapses for an alarm. - - The current system context. - The alarm that raised the event. - - - - Used to receive notifications when the shelving state is either OneShotShelved or TimedShelved. - Updates the value of the UnshelveTime - - The current system context. - The alarm that raised the event. - - - - The severity for an event. - - - Event severities can have any value between 1 and 1000. This enumeration provides default values. - - - - - The highest possible severity. - - - - - The event has high severity. - - - - - The event has medium high severity. - - - - - The event has medium severity. - - - - - The event has medium-low severity. - - - - - The event has low severity. - - - - - The lowest possible severity. - - - - - The base class for all instance nodes. - - - - - Initializes the instance with its defalt attribute values. - - - - - Initializes the instance from another instance. - - - - - Returns the id of the default type definition node for the instance. - - The namespace uris. - - - - - - - - Makes a copy of the node and all children. - - - A new object that is a copy of this instance. - - - - - The parent node. - - - - - Returns the id of the default type definition node for the instance. - - The type definition id. - - - - Gets a display path for the node. - - - - - Gets a display text for the node. - - - - - Gets a display path for the node. - - - - - Returns non-null text for the node. - - - - - A numeric identifier for the instance that is unique within the parent. - - - - - The type of reference from the parent node to the instance. - - - - - The identifier for the type definition node. - - - - - The modelling rule assigned to the instance. - - - - - Sets the flag which indicates whether event are being monitored for the instance and its children. - - The system context. - The event to report. - - - - Initializes the instance from an event notification. - - The context. - The fields selected for the event notification. - The event notification. - - This method creates components based on the browse paths in the event field and sets - the NodeId or Value based on values in the event notification. - - - - - Sets the minimum sampling interval for the node an all of its child variables.. - - The context. - The minimum sampling interval. - - - - - - - - - - Exports a copy of the node to a node table. - - The context. - The node to update with the values from the instance. - - - - Saves the attributes from the stream. - - The context for the system being accessed. - The encoder wrapping the stream to write. - - - - Returns a mask which indicates which attributes have non-default value. - - The context for the system being accessed. - A mask the specifies the available attributes. - - - - Saves object in an binary stream. - - The context user. - The encoder to write to. - The masks indicating what attributes to write. - - - - Updates the specified context. - - The context. - The decoder. - The attributes to load. - - - - Updates the attributes from the stream. - - The context for the system being accessed. - The decoder wrapping the stream to read. - - - - Populates the browser with references that meet the criteria. - - The context for the system being accessed. - The browser to populate. - - - - A lightweight snapshot of an instance node. - - - - - Gets or sets a handled associated with the snapshot. - - The handle. - - - - Initializes the snapshot from an instance. - - The context. - The state. - - - - Sets the value for a child. Adds it if it does not already exist. - - The BrowseName. - The node class. - The value. - - - - Returns true if the snapshort is an instance of the specified type. - - The context to use when checking the type definition. - The type of the instance. - - True if the object is an instance of the specified type. - - - - - Returns the value of the attribute for the specified child. - - The context to use when evaluating the operand. - The type of the instance. - The path from the instance to the node which defines the attribute. - The attribute to return. - The sub-set of an array value to return. - - The attribute value. Returns null if the attribute does not exist. - - - - - Stores the key attributes of a child node. - - - - - Sets the value for a child. Adds it if it does not already exist. - - The node. - The BrowseName. - The node class. - The value. - - - - Creates a snapshot of a node. - - The context. - The state. - A snapshot of a node. - - - - Recusively stores the the current value for Object and Variable child nodes. - - The context. - The state. - The list of the nodes. - - - - Returns the value of the attribute for the specified child. - - The node. - The relative path. - The index. - The attribute id. - The value of the attribute for the specified child. - - - - The base class for all object nodes. - - - - - Initializes the instance with its defalt attribute values. - - - - - Constructs an instance of a node. - - The parent. - The new node. - - - - Initializes the instance with the default values. - - - - - Initializes the instance from another instance. - - - - - Returns the id of the default type definition node for the instance. - - - - - - - - Makes a copy of the node and all children. - - - A new object that is a copy of this instance. - - - - - The inverse name for the reference. - - - - - Raised when the EventNotifier attribute is read. - - - - - Raised when the EventNotifier attribute is written. - - - - - Exports a copt of the node to a node table. - - The context. - The node. - - - - Saves the attributes from the stream. - - The context for the system being accessed. - The encoder wrapping the stream to write. - - - - Updates the attributes from the stream. - - The context for the system being accessed. - The decoder wrapping the stream to read. - - - - Returns a mask which indicates which attributes have non-default value. - - The context for the system being accessed. - A mask the specifies the available attributes. - - - - Saves object in an binary stream. - - The context user. - The encoder to write to. - The masks indicating what attributes to write. - - - - Updates the specified context. - - The context. - The decoder. - The attributes to load. - - - - Reads the value for any non-value attribute. - - - - - Write the value for any non-value attribute. - - - - - The base class for all folder nodes. - - - - - Initializes the instance with its defalt attribute values. - - - - - Initializes the instance with the default values. - - - - - Returns the id of the default type definition node for the instance. - - - - - The base class for all object type nodes. - - - - - Initializes the instance with its default attribute values. - - - - - Initializes the instance with the default values. - - - - - Constructs an instance of a node. - - The parent. - The new node. - - - - - - - Makes a copy of the node and all children. - - - A new object that is a copy of this instance. - - - - - The base class for all object type nodes. - - - - - Initializes the instance with its defalt attribute values. - - - - - Initializes the instance with the default values. - - - - - The base class for all type nodes. - - - - - Initializes the type with its defalt attribute values. - - - - - Initializes the instance from another instance. - - - - - - - - Makes a copy of the node and all children. - - - A new object that is a copy of this instance. - - - - - The identifier for the supertype node. - - - - - Whether the type is an abstract type. - - - - - Raised when the IsAbstract attribute is read. - - - - - Raised when the IsAbstract attribute is written. - - - - - Exports a copt of the node to a node table. - - The context. - The node. - - - - Saves the attributes from the stream. - - The context for the system being accessed. - The encoder wrapping the stream to write. - - - - Updates the attributes from the stream. - - The context for the system being accessed. - The decoder wrapping the stream to read. - - - - Returns a mask which indicates which attributes have non-default value. - - The context for the system being accessed. - A mask the specifies the available attributes. - - - - Saves object in an binary stream. - - The context user. - The encoder to write to. - The masks indicating what attributes to write. - - - - Updates the specified context. - - The context. - The decoder. - The attributes to load. - - - - Reads the value for any non-value attribute. - - - - - Write the value for any non-value attribute. - - - - - Populates the browser with references that meet the criteria. - - The context for the current operation. - The browser to populate. - - - - The base class for all variable nodes. - - - - - Initializes the instance with its defalt attribute values. - - The parent node. - - - - Initializes the instance from another instance. - - The description how access the system containing the data. - A source node to be copied to this instance. - - - - If overridden returns the id of the default type definition node for the instance. - - The namespace uris. - Returns the id of the default type definition or if not overridden - - - - If overridden returns the id of the default data type node for the instance. - - The namespace uris. - - The id of the default data type node for the instance or if not overridden. - - - - - If overridden returns the id of the default value rank for the instance. - - - The id of the default value rank or if not overridden. - - - - - Converts a values contained in a variant to the value defined for the variable. - - - - - Converts a values contained in a variant to the value defined for the variable. - - The system context. - The value. - if set to true throw an exception on error. - If not overridden returns . - - - - Returns the value after checking if the variable is null. - - The framework type of value contained in the . - The variable. - - The value contained by the or the default value for the datatype if the variable is null. - - - - - Returns the value after checking if the property is null. - - The type of value contained in the property. - The property. - - The value. The default value for the datatype if the property is null. - - - - - Converts a values contained in a variant to the value defined for the variable. - - - - - Converts a values contained in a variant to the value defined for the variable. - - The framework type of value contained in this instance. - The context. - The value. - if set to true throws the on error, otherwise default value for is returned . - - The value of the type. - - - If throwOnError is false the default value for the type is returned if the value is not valid. - - If cannot convert . - - - - Decodes the contents of an extension object. - - The context (uses ServiceMessageContext.GlobalContext if null). - The type that the ExtensionObject must be converted to. - The ExtensionObject to convert. - Whether to throw an exception on error. - The decoded instance. Null on error. - - - - Checks the data type of a value before casting it to the type . - - The framework type of value contained in the variable. - The value. - if set to true is thrown on error. - Returns or default for - if it is impossible to cast the value or the value is null and for the type returns true. - - - - - - - Makes a copy of the node and all children. - - - A new object that is a copy of this instance. - - - - - The value of the variable. - - - - - Whether the value can be set to null. - - - - - The value of the variable as a Variant. - - The wrapped value as a Variant. - - - - The timestamp associated with the variable value. - - The timestamp. - - - - The status code associated with the variable value. - - The status code. - - - - The behavior to use when reading or writing all or part of the object. - - The copy policy that specifies the policies to use when handling reads and write to value. - - This value is ignored if the OnReadValue or OnWriteValue event handlers are provided. - - - - - The data type for the variable value. - - The type of the data . - - - - The number of array dimensions permitted for the variable value. - - The value rank. - Indicates whether the DataType is an array and how many dimensions the array has. - - - - The number of dimensions for an array values with one or more fixed dimensions. - - The array dimensions. - - If the Value Rank does not identify an array of a specific dimension (i.e. ValueRank <= 0) - the Array Dimensions attribute can either be set to null or the attribute is missing. This behaviour is vendor-specific. - If the Value Rank attribute specifies an array of a specific dimension (i.e. ValueRank > 0) then the Array Dimensions - attribute shall be specified in the table defining the Variable. - - - - - The type of access available for the variable. - - The access level. - - - - The type of access granted to the current user. - - The user access level. - - - - The minimum sampling interval supported by the variable. - - The minimum sampling interval. - - - - Whether the server is archiving the value of the variable. - - true if historizing; otherwise, false. - - - - A bit mask specifying how the value may be accessed. - - The extended access level. - - - - Raised when the Value attribute is read. - - - - - Raised when the Value attribute is written. - - - - - Raised when the Value attribute is read. - - - - - Raised when the Value attribute is written. - - - - - Raised when the DataType attribute is read. - - - - - Raised when the DataType attribute is written. - - - - - Raised when the ValueRank attribute is read. - - - - - Raised when the ValueRank attribute is written. - - - - - Raised when the ArrayDimensions attribute is read. - - - - - Raised when the ArrayDimensions attribute is written. - - - - - Raised when the AccessLevel attribute is read. - - - - - Raised when the AccessLevel attribute is written. - - - - - Raised when the UserAccessLevel attribute is read. - - - - - Raised when the UserAccessLevel attribute is written. - - - - - Raised when the MinimumSamplingInterval attribute is read. - - - - - Raised when the MinimumSamplingInterval attribute is written. - - - - - Raised when the Historizing attribute is read. - - - - - Raised when the Historizing attribute is written. - - - - - Raised when the AccessLevelEx attribute is read. - - - - - Raised when the AccessLevelEx attribute is written. - - - - - Exports a copy of the node to a node provided the type is compatible with . - - The context that describes how access the system containing the data. - The node to be a copy of this instance. - - - - Saves the attributes from this instance to the . - - The context for the system being accessed. - The encoder wrapping the stream to write. - - - - Updates the attributes from the . - - The context for the system being accessed. - The decoder wrapping the stream to read. - - - - Returns a mask which indicates which attributes have non-default value. - - The context for the system being accessed. - - A mask that specifies the available attributes. - - - - - Saves object in an binary stream. - - The context that describes how access the system containing the data.. - The encoder to write to. - The masks indicating what attributes to write. - - - - Updates the attributes of this instance from the . - - The context. - The decoder. - The attributes to load. - - - - Converts the array dimensions to an XML string. - - The array dimensions. - The XML string value. - - - - Returns a list of the array dimensions. - - The XML string value. - The array dimensions list. - - - - Recusively sets the status code and timestamp for the node and all child variables. - - The context. - The status code. - The timestamp. Not updated if set to DateTime.Min - - - - Reads the value for any non-value attribute. - - The context. - The attribute idetifier . - The returned value. - - An instance of the containing the status code and diagnostic info for the operation. - ServiceResult.Good if successful. Detailed error information otherwise. - - - - - Reads the value for the value attribute. - - The context. - The index range. - The data encoding. - The value to be returned. - The source timestamp. - - An instance of the containing the status code and diagnostic info for the operation. - ServiceResult.Good if successful. Detailed error information otherwise. - - - - - Applys the index range and the data encoding to the value. - - The context. - The index range. - The data encoding. - The value. - - - - - Write the value for any non-value attribute. - - The context. - The attribute id. - The value. - - An instance of the containing the status code and diagnostic info for the operation. - ServiceResult.Good if successful. Detailed error information otherwise. - - - - - Write the value for the value attribute. - - The context. - The index range. - The value. - The status code. - The source timestamp. - - An instance of the containing the status code and diagnostic info for the operation. - ServiceResult.Good if successful. Detailed error information otherwise. - - - - - A typed base class for all data variable nodes. - - - - - Initializes the instance with its defalt attribute values. - - - - - Constructs an instance of a node. - - The parent. - The new node. - - - - Initializes the instance with the default values. - - - - - Returns the id of the default type definition node for the instance. - - - - - A typed base class for all data variable nodes. - - - - - Initializes the instance with its defalt attribute values. - - - - - Initializes the instance with the default values. - - - - - Sets the value to its default value if it is not valid. - - - - - The value of the variable. - - - - - A typed base class for all data variable nodes. - - - - - Initializes the instance with its defalt attribute values. - - - - - Constructs an instance of a node. - - The parent. - The new node. - - - - Initializes the instance with the default values. - - - - - Returns the id of the default type definition node for the instance. - - - - - The strings that describe the values for an enumeration. - - - - - Populates a list with the children that belong to the node. - - The context for the system being accessed. - The list of children to populate. - - - - Finds the child with the specified browse name. - - - - - A typed base class for all data variable nodes. - - - - - Initializes the instance with its defalt attribute values. - - - - - Initializes the instance with the default values. - - An object that describes how access the system containing the data. - - - - Extracts a value of the specified type from a value stored in a variant. - - - - - Extracts a value of the specified type from a value stored in a variant. - - The context. - The value. - if set to true throw an exception on error. - - If throwOnError is false the default value for the type is returned if the value is not valid. - - Returns value of the T type - - - - The value of the variable. - - - - - A thread safe object that can be used to access the value of a structure variable. - - - - - Initializes the instance with a synchronization object. - - - - - An object used to synchronize access to the value. - - - - - The behavior to use when reading or writing all or part of the object. - - - - - Gets or sets the current error state. - - - - - Gets or sets the timestamp associated with the value. - - - - - Clears the change masks for all nodes in the update list. - - - - - Raised before the value is read. - - - - - Raised after the value is written. - - - - - Does any processing before a read operation takes place. - - The context. - The node. - - - - Reads the value or a component of the value. - - - - - Reads the current value. - - - - - Writes the current value. - - - - - Sets the list of nodes which are updated when ClearChangeMasks is called. - - - - - Used to receive notifications when the value attribute is read or written. - - - - - Specifies the policies to use when handling reads and write to value. - - - - - The value is copied when is is read. - - - - - The value is copied before it is written. - - - - - The value is never copied (only useful for value types that do not contain reference types). - - - - - Data is copied when it is written and when it is read. - - - - - The base class for all variable type nodes. - - - - - Initializes the instance with its defalt attribute values. - - - - - Initializes the instance from another instance. - - - - - Sets the value to its default value if it is not valid. - - - - - - - - Makes a copy of the node and all children. - - - A new object that is a copy of this instance. - - - - - The value of the variable. - - - - - The value of the variable as a Variant. - - - - - The data type for the variable value. - - - - - The number of array dimensions permitted for the variable value. - - - - - The number of dimensions for an array values with one or more fixed dimensions. - - - - - Raised when the Value attribute is read. - - - - - Raised when the Value attribute is written. - - - - - Raised when the DataType attribute is read. - - - - - Raised when the DataType attribute is written. - - - - - Raised when the ValueRank attribute is read. - - - - - Raised when the ValueRank attribute is written. - - - - - Raised when the ArrayDimensions attribute is read. - - - - - Raised when the ArrayDimensions attribute is written. - - - - - Exports a copy of the node to a node table. - - The context. - The node. - - - - Saves the attributes from the stream. - - The context for the system being accessed. - The encoder wrapping the stream to write. - - - - Updates the attributes from the stream. - - The context for the system being accessed. - The decoder wrapping the stream to read. - - - - Returns a mask which indicates which attributes have non-default value. - - The context for the system being accessed. - A mask the specifies the available attributes. - - - - Saves object in an binary stream. - - The context user. - The encoder to write to. - The masks indicating what attributes to write. - - - - Updates the specified context. - - The context. - The decoder. - The attributes to load. - - - - Reads the value for any non-value attribute. - - - - - Reads the value for the value attribute. - - - - - Write the value for any non-value attribute. - - - - - Write the value for the value attribute. - - - - - A base class for all data variable type nodes. - - - - - Initializes the type with its defalt attribute values. - - - - - Constructs an instance of a node. - - The parent. - The new node. - - - - Initializes the instance with the default values. - - - - - A typed base class for all data variable type nodes. - - - - - Initializes the type with its defalt attribute values. - - - - - Initializes the instance with the default values. - - - - - Sets the value to its default value if it is not valid. - - - - - The value of the variable. - - - - - A base class for all property variable type nodes. - - - - - Initializes the type with its defalt attribute values. - - - - - Constructs an instance of a node. - - The parent. - The new node. - - - - Initializes the instance with the default values. - - - - - A typed base class for all property variable type nodes. - - - - - Initializes the type with its defalt attribute values. - - - - - Initializes the instance with the default values. - - - - - Sets the value to its default value if it is not valid. - - - - - The value of the variable. - - - - - Used to receive notifications when a condition is enabled or disabled. - - The current system context. - The condition that raised the event. - True if the condition is moving/has moved to the Enabled state. - - - - Used to receive notifications when a comment is added. - - The current system context. - The condition that raised the event. - The identifier for the event which is the target for the comment. - The comment. - - - - The base class for all reference type nodes. - - - - - Initializes the instance with its defalt attribute values. - - - - - Constructs an instance of a node. - - The parent. - The new node. - - - - - - - Makes a copy of the node and all children. - - - A new object that is a copy of this instance. - - - - - The abstract definition of the data type. - - - - - The purpose of the data type. - - - - - Saves the attributes from the stream. - - The context for the system being accessed. - The encoder wrapping the stream to write. - - - - Updates the attributes from the stream. - - The context for the system being accessed. - The decoder wrapping the stream to read. - - - - Returns a mask which indicates which attributes have non-default value. - - The context for the system being accessed. - A mask the specifies the available attributes. - - - - Saves object in an binary stream. - - The context for the system being accessed. - The encoder to write to. - The masks indicating what attributes to write. - - - - Updates the specified context. - - The context. - The decoder. - The attributes to load. - - - - Raised when the DataTypeDefinition attribute is read. - - - - - Raised when the DataTypeDefinition attribute is written. - - - - - Reads the value for DataTypeDefinition attribute. - - - - - Write the value for DataTypeDefinition attribute. - - - - - Used to receive notifications when the dialog receives a response. - - - - - A delegate used to receive notifications when a state machine transition occurs. - - - - - An interface to an object that describes how access the system containing the data. - - - - - An application defined handle for the system. - - The system handle. - - - - The identifier for the session (null if multiple sessions are associated with the operation). - - The session identifier. - - - - The identity of the user (null if not available). - - The user identity. - - - - The locales to use if available. - - The preferred locales. - - - - The audit log entry associated with the operation (null if not available). - - The audit entry identifier. - - - - The table of namespace uris to use when accessing the system. - - The namespace URIs. - - - - The table of server uris to use when accessing the system. - - The server URIs. - - - - A table containing the types that are to be used when accessing the system. - - The type table. - - - - A factory that can be used to create encodeable types. - - The encodeable factory. - - - - A factory that can be used to create node ids. - - The node identifiers factory. - - - - A factory that can be used to create encodeable types. - - The encodeable factory. - - - - An interface that can be used to create new node ids. - - - - - Creates the NodeId for the specified node. - - The context. - The node. - The new NodeId. - - - - A generic implementation for ISystemContext interface. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The context. - - - - An application defined handle for the system. - - The system handle. - - - - The identifier for the session (null if multiple sessions are associated with the operation). - - The session identifier. - - - - The identity of the user. - - The user identity. - - - - The locales to use if available. - - The preferred locales. - - - - The audit log entry associated with the operation (null if not available). - - The audit entry identifier. - - - - The table of namespace uris to use when accessing the system. - - The namespace URIs. - - - - The table of server uris to use when accessing the system. - - The server URIs. - - - - A table containing the types that are to be used when accessing the system. - - The type table. - - - - A factory that can be used to create encodeable types. - - The encodeable factory. - - - - A factory that can be used to create node instances. - - The node state factory. - - - - A factory that can be used to create node ids. - - The node idetifiers factory. - - - - The operation context associated with the system context. - - The operation context. - - - - Creates a copy of the context that can be used with the specified operation context. - - The operation context to use. - - A copy of the system context that references the new operation context. - - - - - The diagnostics mask associated with the operation. - - The diagnostics mask. - - - - The table of strings associated with the operation. - - The string table. - - - - When the operation will be abandoned if it has not completed. - - The operation deadline. - - - - The current status of the operation. - - The operation status. - - - - The possible states for a limit alarm. - - - - - The alarm ia inactive. - - - - - The alarm is in the HighHigh state. - - - - - The alarm is in the High state. - - - - - The alarm is in the Low state. - - - - - The alarm is in the LowLow state. - - - - - The base class for all method nodes. - - - - - Initializes the instance with its defalt attribute values. - - - - - Constructs an instance of a node. - - The parent. - The new node. - - - - Initializes the instance with the default values. - - - - - Initializes the instance from another instance. - - - - - - - - Makes a copy of the node and all children. - - - A new object that is a copy of this instance. - - - - - The identifier for the declaration of the method in the type model. - - - - - Whether the method can be called. - - - - - Whether the method can be called by the current user. - - - - - Raised when the Executable attribute is read. - - - - - Raised when the Executable attribute is written. - - - - - Raised when the UserExecutable attribute is read. - - - - - Raised when the UserExecutable attribute is written. - - - - - Raised when the method is called. - - - - - Raised when the method is called. - - - - - Exports a copt of the node to a node table. - - The context. - The node. - - - - Saves the attributes from the stream. - - The context for the system being accessed. - The encoder wrapping the stream to write. - - - - Updates the attributes from the stream. - - The context for the system being accessed. - The decoder wrapping the stream to read. - - - - Returns a mask which indicates which attributes have non-default value. - - The context for the system being accessed. - A mask the specifies the available attributes. - - - - Saves object in an binary stream. - - The context user. - The encoder to write to. - The masks indicating what attributes to write. - - - - Updates the specified context. - - The context. - The decoder. - The attributes to load. - - - - Reads the value for any non-value attribute. - - - - - Write the value for any non-value attribute. - - - - - The input arguments for the method. - - - - - The output arguments for the method. - - - - - Populates a list with the children that belong to the node. - - The context for the system being accessed. - The list of children to populate. - - - - Finds the child with the specified browse name. - - - - - Invokes the methods and returns the output parameters. - - The context to use. - The object being called. - The input arguments. - Any errors for the input arguments. - The output arguments. - The result of the method call. - - - - Invokes the method, returns the result and output argument. - - - - - Invokes the method, returns the result and output argument. - - The current context. - The id of the object. - The input arguments which have been already validated. - The output arguments which have initialized with thier default values. - - - - - Validates the input argument. - - The context to use. - The input argument. - The index in the the list of input argument. - Any error. - - - - Returns the default value for the output argument. - - The context to use. - The output argument description. - The default value. - - - - Used to process a method call. - - - - - Used to process a method call. - - - - - The base class for custom nodes. - - - - - The specification that defines the node. - - - - - The documentation for the node that is saved in the NodeSet. - - - - - Creates an empty object. - - The node class. - - - - An overrideable version of the Dispose. - - - - - An overrideable version of the Dispose. - - - - - - - - Makes a copy of all children. - Children must implement MemberwiseClone or ICloneable. - - - - - When overridden in a derived class, iinitializes the instance with the default values. - - The object that describes how access the system containing the data. - - - - When overridden in a derived class, initializes the any option children defined for the instance. - - The object that describes how access the system containing the data. - - - - Initializes the instance with the XML or bnary (array of bytes) representation contained in the string. - - The object that describes how access the system containing the data. - The initialization string that is used to initializes the node. - - - - Initializes the instance with the default values. - - The object that describes how access the system containing the data. - The source node. - - - - Returns a string representation of the node. - - - A that represents the current . - - - - - Returns a string representation of the node. - - The specifying the format to use. - -or- - null to use the default format defined for the type of the implementation. - The to use to format the value. - -or- - null to obtain the numeric format information from the current locale setting of the operating system. - - A containing the value of the current instance in the specified format. - - - - - An arbitrary handle associated with the node. - - - - - What has changed in the node since was last called. - - The change masks that indicates what has changed in a node. - - - - A symbolic name for the node that is not expected to be globally unique. - - The name of the symbolic. - - This string can only contain characters that are valid for an XML element name. - - - - - The identifier for the node. - - An instance that stores an identifier for a node in a server's address space. - - - - The class for the node. - - The node class that is a description of the node. - - - - The browse name of the node. - - The name qualified with a namespace. - - - - The display name for the node. - - Human readable qualified with a locale. - - - - The localized description for the node. - - Human readable qualified with a locale. - - - - Specifies which attributes are writeable. - - A description for the AttributeWriteMask of the node fields. - - - - Specifies which attributes are writeable for the current user. - - A description for the AttributeWriteMask of the node fields. - - - - Specifies a list of permissions for the node assigned to roles. - - The Permissions that apply to the node. - - - - Specifies a list of permissions for the node assigned to roles for the current user. - - The Permissions that apply to the node for the current user. - - - - Specifies a mask indicating any access restrictions that apply to the node. - - The server specific access restrictions of the node. - - - - Gets or sets the extensions of the node set. Property used when importing NodeSet2.xml files. - - - The extensions. - - - - - The categories assigned to the node. - - - - - The release status for the node. - - - - - Exports a copy of the node to a node table. - - The object that describes how access the system containing the data. - A table of nodes. - - - - Exports a copy of the node to a node table. - - The object that describes how access the system containing the data. - The node to update with the values from the instance. - - - - Saves the node as XML in a stream. - - The context for the system being accessed. - The stream to write. - - - - Saves the node in a binary stream. - - The context for the system being accessed. - The stream to write. - - - - Saves the object in the binary stream. - - The context for the system being accessed. - The stream to write. - - - - Loads the node from a binary stream. - - The context for the system being accessed. - The stream to read. - - - - Flags which control the serialization of a NodeState in a stream. - - - - - The default value. - - - - - The AccessLevel attribute. - - - - - The ArrayDimensions attribute. - - - - - The BrowseName attribute. - - - - - The ContainsNoLoops attribute. - - - - - The DataType attribute. - - - - - The Description attribute. - - - - - The DisplayName attribute. - - - - - The EventNotifier attribute. - - - - - The Executable attribute. - - - - - The Historizing attribute. - - - - - The InverseName attribute. - - - - - The IsAbstract attribute. - - - - - The MinimumSamplingInterval attribute. - - - - - The NodeClass attribute. - - - - - The NodeId attribute. - - - - - The Symmetric attribute. - - - - - The UserAccessLevel attribute. - - - - - The UserExecutable attribute. - - - - - The UserWriteMask attribute. - - - - - The ValueRank attribute. - - - - - The WriteMask attribute. - - - - - The Value attribute. - - - - - The SymbolicName for the node. - - - - - The target of the TypeDefinitionId reference. - - - - - The target of the HasModellingRule reference. - - - - - The NumericId for the node. - - - - - The type of reference between a child and a parent. - - - - - The source of the HasSubType reference. - - - - - The StatusCode associated with the Value attribute. - - - - - The DataTypeDefinition attribute of a DataType Node. - - - - - Returns a mask which indicates which attributes have non-default value. - - The context for the system being accessed. - A mask the specifies the available attributes. - - - - Saves object in an binary stream. - - The context for the system being accessed. - The encoder to write to. - The masks indicating what attributes to write. - - - - Updates the object from a binary stream. - - The context for the system being accessed. - The decoder to read from. - The masks indicating what attributes to read. - - - - Saves the children in a binary stream. - - The context for the system being accessed. - The encoder wrapping the stream to write. - - - - Loads the children from a binary stream. - - The context for the system being accessed. - The decoder to read from. - - - - Reads attributes for the next child found in the stream. - - The context for the system being accessed. - The decoder wrapping the stream to read. - The updated child. - - The child is created if it does not already exist. - Recursively updates any children of the child. - - - - - Creates a node and initializes it from the stream. - - The context for the system being accessed. - The decoder. - The new node. - - - - Saves the reference table in a binary stream. - - The context for the system being accessed. - The encoder wrapping the stream to write. - - - - Loads the reference table from a binary stream. - - The context for the system being accessed. - The decoder to read from. - - - - Saves the node as XML in a stream. - - The context for the system being accessed. - The encoder wrapping the stream to write. - - - - Initializes the node from XML in a stream. - - The context for the system being accessed. - The stream to read. - - - - Initializes the node from XML in a stream. - - The context for the system being accessed. - The stream to read. - - - - Initializes the node from XML in a stream. - - The context for the system being accessed. - The stream to read. - - - - Initializes the node from XML in a stream. - - The context for the system being accessed. - The decoder wrapping the stream to read. - - - - Saves the attributes from the stream. - - The context for the system being accessed. - The encoder wrapping the stream to write. - - - - Updates the attributes from the stream. - - The context for the system being accessed. - The decoder wrapping the stream to read. - - - - Saves the children from the stream. - - The context for the system being accessed. - The encoder wrapping the stream to write. - - - - Saves a refernce table from an XML stream. - - The context for the system being accessed. - The encoder wrapping the stream to write. - - - - Reads attributes for the children from the stream. - - The context for the system being accessed. - The decoder wrapping the stream to read. - - Any children found in the stream that do not exist are created and initialized from the stream. - - - - - Loads any additional references from the stream. - - The context for the system being accessed. - The decoder wrapping the stream to read. - - - - Reads attributes for the next child found in the stream. - - The context for the system being accessed. - The decoder wrapping the stream to read. - The updated child. - - The child is created if it does not already exist. - Recursively updates any children of the child. - - - - - Creates a node and initializes it from the stream. - - The context for the system being accessed. - The decoder. - The new node. - - - - Updates a child which is not defined by the type definition. - - The context for the system being accessed. - The decoder. - The parent. - The attributes to load. - The node class. - Symbolic name of the node. - A name qualified with a namespace. - An instance of the type that is a base class for all instance nodes. - - - - Reads an unknown node from a stream. - - - - - Reads an unknown node from a stream. - - - - - Updates a child which is not defined by the type definition. - - - - - An event which allows multiple sinks to be notified when the OnStateChanged callback is called. - - - - - Called when the Validate method is called - - - - - Called when ClearChangeMasks is called and the ChangeMask is not None. - - - - - Called when a reference gets added to the node - - - - - Called when a reference gets removed from the node - - - - - Called when a node produces an event that needs to be reported. - - - - - Called when ClearChangeMasks is called and the ChangeMask is not None. - - - - - Called after the CreateBrowser method is called. - - - - - Called after the PopulateBrowser method is called. - - - - - Called when the NodeId attribute is read. - - - - - Called when the NodeId attribute is written. - - - - - Called when the NodeClass attribute is read. - - - - - Called when the NodeClass attribute is written. - - - - - Called when the BrowseName attribute is read. - - - - - Called when the BrowseName attribute is written. - - - - - Called when the DisplayName attribute is read. - - - - - Called when the DisplayName attribute is written. - - - - - Called when the Description attribute is read. - - - - - Called when the Description attribute is written. - - - - - Called when the WriteMask attribute is read. - - - - - Called when the WriteMask attribute is written. - - - - - Called when the UserWriteMask attribute is read. - - - - - Called when the UserWriteMask attribute is written. - - - - - Called when the RolePermissions attribute is read. - - - - - Called when the RolePermissions attribute is written. - - - - - Called when the UserRolePermissions attribute is read. - - - - - Called when the UserRolePermissions attribute is written. - - - - - Called when the AccessRestrictions attribute is read. - - - - - Called when the AccessRestrictions attribute is written. - - - - - Returns the root node if the node is part of an instance hierarchy. - - - - - - True if events produced by the instance are being monitored. - - - - - True if the node and its children have been initialized. - - - - - True if the node must be validated with the underlying system before use. - - - - - Sets the flag which indicates whether event are being monitored for the instance and its children. - - The system context. - True if monitoring is active. - Whether to recursively set the flag on any children. - - - - Reports an event produced by the node. - - The system context. - The event to report. - - - - Adds a notifier relationship to the node. - - The system context. - The type of reference (HasEventSource is used if null specified). - True for an inverse reference. - The target of the reference. - - - - Removes a notifier relationship from the node. - - The system context. - The target of the notifier relationship. - Whether the inverse relationship should be removed from the target. - - - - Populates a list with the notifiers that belong to the node. - - The system context. - The list of notifiers to populate. - - - - Returns any notifiers with the specified notifier type (NodeId) and direction. - - - - - Returns the last event produced for any conditions belonging to the node or its chilren. - - The system context. - The list of condition events to return. - Whether to recursively report events for the children. - - - - Returns the method with the specified NodeId or MethodDeclarationId. - - The system context. - The identifier for the method to find. - Returns the method. Null if no method found. - - - - Sets the specified bits in the change masks (ORs with the current bits). - - - - - Clears the change masks. - - The context that describes how access the system containing the data.. - if set to true clear masks recursively for all children.. - - - - Recusively sets the status code and timestamp for the node and all child variables. - - The context. - The status code. - The timestamp. Not updated if set to DateTime.Min - - - - Called before a node is created. - - - - - Called before the ids are assigned to the node and its children. - - - - - Called after a node is created. - - - - - Called before the node is deleted. - - - - - Called after the object is deleted. - - - - - Creates a node with default values and assigns new node ids to it and all children. - - - - - Recusivesly calls OnBeforeCreate for the node and its children. - - - - - Recusivesly calls OnBeforeCreate for the node and its children. - - - - - Recusivesly calls OnAfterCreate for the node and its children. - - - - - Create an instance by copying another node. - - - - - Deletes an instance and its children (calls OnStateChange callback for each node). - - - - - Recursively assigns NodeIds to the node and its children. - - The context. - A table mapping the old node ids to the new node ids. - - - - Recursively assigns NodeIds to the node and its children. - - - - - Verifies that the node represents a valid node. - - The context for the current operation. - True if the node is currently valid. - - - - Creates a browser for the entity references. - - The context for the current operation. - The view to use. - The reference type filter to use. - Whether to include sub-types. - The direction to browse. - The browse name of the targets to return. - Any additional references that should be included in the list. - Only return references that are stored in memory. - A thread safe object which enumerates the references for an entity. - - - - Populates a table with all nodes in the hierarchy. - - The context for the current operation. - The path to the parent object. - A table of all nodes in the hierarchy. - - This method is use get a snapshot of the relative paths to all nodes in the hierarchy. - The hierarchy may not be complete if portions of it are stored external systems. - - - - - Populates a table with all references in the hierarchy. - - The context for the current operation. - The path to the parent object. - A table of all nodes in the hierarchy. - The references in the hierarchy. - - The method is used to serialize any additional references between nodes in the hierarchy. - The references are stored as relative paths from the root node. - Any references to nodes outside the hierachy are stored as NodeIds instead of relative paths. - - - - - Recursively updates the targets of references. - - The context. - A table mapping the old node ids to the new node ids. - - - - Recursively updates the targets of references. - - - - - Populates the browser with references that meet the criteria. - - The context for the current operation. - The browser to populate. - - - - Updates the node with the values from an event notification. - - - - - Reads the values for a set of attributes. - - The context for the current operation. - The attributes to read. - - A list of values. - If any error occurs for an attribute the value will be null. - - - - - Reads the value of an attribute. - - The context for the current operation. - The attribute id. - The index range. - The data encoding. - The value. - - An instance of the containing the status code and diagnostic info for the operation. - ServiceResult.Good if successful. Detailed error information otherwise. - - - - - Reads the value for any non-value attribute. - - The context. - The attribute idetifier . - The returned value. - - An instance of the containing the status code and diagnostic info for the operation. - ServiceResult.Good if successful. Detailed error information otherwise. - - - - - When overridden in a derived class, iReads the value for the value attribute. - - The context. - The index range. - The data encoding. - The value to be returned. - The source timestamp. - - An instance of the containing the status code and diagnostic info for the operation. - ServiceResult.Good if successful. Detailed error information otherwise. - - - - - Writes the specified attribute value. - - The context for the current operation. - The attribute id. - The index range. - The value. - - An instance of the containing the status code and diagnostic info for the operation. - ServiceResult.Good if successful. Detailed error information otherwise. - - - - - Write the value for any non-value attribute. - - The context. - The attribute id. - The value. - - An instance of the containing the status code and diagnostic info for the operation. - ServiceResult.Good if successful. Detailed error information otherwise. - - - - - Write the value for the value attribute. - - The context. - The index range. - The value. - The status code. - The source timestamp. - - An instance of the containing the status code and diagnostic info for the operation. - ServiceResult.Good if successful. Detailed error information otherwise. - - - - - Finds the child by a path constructed from the symbolic names. - - The context. - The symbolic path. - The matching child. Null if the no child was found. - - This method assumes the symbolicPath consists of symbolic names seperated by a slash ('/'). - Leading and trailing slashes are ignored. - - - - - Finds the child with the specified browse name - - The context to use. - The browse name. - The target if found. Null otherwise. - - - - Finds the child with the specified browse path. - - The context to use. - The browse path. - The current position in the browse path. - The target if found. Null otherwise. - - - - Finds or creates the child with the specified browse name. - - The context to use. - The browse name. - The child if avialble. Null otherwise. - - - - Creates or replaces the child with the same browse name. - - The context to use. - The child to add or replace. - - - - Adds a child to the node. - - - - - Creates a property and adds it to the node. - - - - - Removes a child from the node. - - - - - Finds the child with the specified browse and assigns the values from any variables in the hierachy of the source. - - False if the child does not exist or is not a variable. - Creates the child if does not already exist. - - - - Finds the child variable with the specified browse and assigns the value to it. - - False if the child does not exist or is not a variable. - Creates the child if does not already exist. - - - - Reads the attribute of the child node. - - The context. - The relative path. - The index. - The attribute id. - The data value. - - An instance of the containing the status code and diagnostic info for the operation. - ServiceResult.Good if successful. Detailed error information otherwise. - - - - - Writes the value of the child attribute. - - The context. - The component path. - The index. - The attribute id. - The value. - - An instance of the containing the status code and diagnostic info for the operation. - ServiceResult.Good if successful. Detailed error information otherwise. - - - - - Returns true if the reference exists. - - The type of reference. - Whether the reference is an inverse reference. - The target of the reference. - True if the reference exists. - - - - Adds a reference. - - Type of the reference. - If set to true the refernce is an inverse reference. - The target of the reference. - - - - Removes a reference. - - Type of the reference. - If set to true the refernce is an inverse reference. - The target of the reference. - - - - Adds a list of references (ignores duplicates). - - The list of references to add. - - - - Removes all references of the specified type. - - Type of the reference. - If set to true the reference is an inverse reference. - - - - Populates a list with the children that belong to the node. - - The context for the system being accessed. - The list of children to populate. - - This method returns the children that are in memory and does not attempt to - access an underlying system. The PopulateBrowser method is used to discover those references. - - - - - Populates a list with the non-child related references that belong to the node. - - The context for the system being accessed. - The list of references to populate. - - This method only returns references that are not implied by the parent-child - relation or references which are intrinsic to the NodeState classes (e.g. HasTypeDefinition) - - This method also only returns the reference that are in memory and does not attempt to - access an underlying system. The PopulateBrowser method is used to discover those references. - - - - - Returns any references with the specified reference type and direction. - - - - - Finds the child with the specified browse name. - - The context for the system being accessed. - The browse name of the children to add. - if set to true and the child could exist then the child is created. - The replacement to use if createOrReplace is true. - The child. - - - - Stores the notifier relationship to another node. - - - - - The node state. - - - - - The reference type id. - - - - - Whether the reference direction is inverse. - - - - - A list of children of the node. - - - - - Indicates what has changed in the node. - - - - - Stores a collection of nodes. - - - - - Writes the collection to a stream using the Opc.Ua.Schema.UANodeSet schema. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The initial capacity. - - - - Initializes a new instance of the class. - - The collection whose elements are copied to the new list. - - is null. - - - - - Writes the collection to a stream using the NodeSet schema. - - - - - Stores a well known alias. - - - - - The list of aliases to use. - - - - - Writes the collection to a stream using the Opc.Ua.Schema.UANodeSet schema. - - - - - Writes the collection to a stream using the Opc.Ua.Schema.UANodeSet schema. - - - - - Writes the schema information to a static XML export file. - - - - - Writes the schema information to a static XML export file. - - - - - Writes the collection to a binary stream. The stream is closed by this method. - - - - - Reads the schema information from a XML document. - - - - - Reads the schema information from a XML document. - - - - - Loads the nodes from an embedded resource. - - The context. - The resource path. - The assembly containing the resource. - if set to true the namespace and server tables are updated with any new URIs. - - - - Loads the nodes from an embedded resource. - - The context. - The resource path. - The assembly containing the resource. - if set to true the namespace and server tables are updated with any new URIs. - - - - An interface to an object that browses the references of an node. - - - - - Returns the next reference. - - - - - Pushes a previously returned reference back into the browser. - - - - - A thread safe object which browses the references for an node. - - - - - Creates a new browser object with a set of filters. - - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - Returns the next reference. Null if no more references. - - - - - Pushes a previously returned reference back into the browser. - - - - - Returns true if the target node is required (used to apply view filters); - - - - - Returns true if the reference type is required. - - - - - Adds a reference to target entity. - - - - - Adds a reference to target entity. - - - Will not add the reference if the browse name does not match the browse name filter. - - - - - Adds a reference to target identified by its node id. - - - - - Thr synchronization lock used by the browser. - - - - - The table of types known to the UA server. - - - - - The view being browsed. - - - - - The type of reference to return. - - - - - Whether to return subtypes of the reference. - - - - - The direction for the references to return. - - - - - The browse name of the targets to return. - - - - - Indicates that the browser only returned easy to access references stored in memory. - - - - - Stores the a reference for a node. - - - - - Constructs a reference to an internal target. - - - - - Constructs a reference to an external target. - - - - - The internal target of the reference. - - - - - - - - - - - - - - Indicates what has changed in a node. - - - - - None has changed - - - - - One or more children have been added, removed or replaced. - - - - - One or more references have been added or removed. - - - - - The value attribute has changed. - - - - - One or more non-value attribute has changed. - - - - - The node has been deleted. - - - - - Used to validate a node. - - - - - Used to receive notifications when a non-value attribute is read or written. - - - - - Used to receive notifications when a reference get added to the node - - - - - Used to receive notifications when a reference get removed to the node - - - - - Used to receive notifications when a node produces an event. - - - - - Used to receive notifications when a node needs to refresh its conditions. - - - - - Used to receive notifications when a node browser is created. - - - - - Used to receive notifications when a node is browsed. - - - - - Used to receive notifications when a non-value attribute is read or written. - - - - - Used to receive notifications when the value attribute is read or written. - - - - - Used to receive notifications when the value attribute is read or written. - - - - - Stores a reference from a node in the instance hierarchy. - - - - - Initializes a new instance of the class. - - The path to the source node. - The reference. - - - - Initializes a new instance of the class. - - The path to the source node. - The path to the target node. - The reference. - - - - Gets the path to the source node. - - The source path. - - - - Gets the identifier for the reference type. - - The reference type id. - - - - Gets a value indicating whether the reference is an inverse reference. - - - true if this is an inverse reference; otherwise, false. - - - - - Gets the identifier for the target node. - - The target id. - Only one of TargetId or TargetPath is specified. - - - - Gets the path to the target node. - - The target path. - Only one of TargetId or TargetPath is specified. - - - - A delegate which creates a new node. - - The parent of the node. - The new node. - - - - A class that creates instances of nodes based on the paramters provided. - - - - - Creates a new instance. - - The current context. - The parent. - The node class. - The browse name. - The reference type between the parent and the node. - The type definition. - Returns null if the type is not known. - - - - Registers a type with the factory. - - The type definition. - The system type. - - - - Unregisters a type with the factory. - - The type definition. - - - - The base class for all reference type nodes. - - - - - Initializes the instance with its defalt attribute values. - - - - - Constructs an instance of a node. - - The parent. - The new node. - - - - Initializes the instance with the default values. - - - - - Initializes the instance from another instance. - - - - - - - - Makes a copy of the node and all children. - - - A new object that is a copy of this instance. - - - - - The inverse name for the reference. - - - - - Whether the reference is symmetric. - - - - - Exports a copy of the node to a node table. - - The context. - The node. - - - - Saves the attributes from the stream. - - The context for the system being accessed. - The encoder wrapping the stream to write. - - - - Updates the attributes from the stream. - - The context for the system being accessed. - The decoder wrapping the stream to read. - - - - Returns a mask which indicates which attributes have non-default value. - - The context for the system being accessed. - A mask the specifies the available attributes. - - - - Saves object in an binary stream. - - The context user. - The encoder to write to. - The masks indicating what attributes to write. - - - - Updates the specified context. - - The context. - The decoder. - The attributes to load. - - - - Raised when the InverseName attribute is read. - - - - - Raised when the InverseName attribute is written. - - - - - Raised when the Symmetric attribute is read. - - - - - Raised when the Symmetric attribute is written. - - - - - Reads the value for any non-value attribute. - - - - - Write the value for any non-value attribute. - - - - - The base class for all view nodes. - - - - - Initializes the instance with its defalt attribute values. - - - - - Constructs an instance of a node. - - The parent. - The new node. - - - - Initializes the instance with the default values. - - - - - Initializes the instance from another instance. - - - - - - - - Makes a copy of the node and all children. - - - A new object that is a copy of this instance. - - - - - The inverse name for the reference. - - - - - Whether the reference is containsNoLoops. - - - - - Raised when the EventNotifier attribute is read. - - - - - Raised when the EventNotifier attribute is written. - - - - - Raised when the ContainsNoLoops attribute is read. - - - - - Raised when the ContainsNoLoops attribute is written. - - - - - Exports a copy of the node to a node table. - - The context. - The node. - - - - Saves the attributes from the stream. - - The context for the system being accessed. - The encoder wrapping the stream to write. - - - - Updates the attributes from the stream. - - The context for the system being accessed. - The decoder wrapping the stream to read. - - - - Returns a mask which indicates which attributes have non-default value. - - The context for the system being accessed. - A mask the specifies the available attributes. - - - - Saves object in an binary stream. - - The context user. - The encoder to write to. - The masks indicating what attributes to write. - - - - Updates the specified context. - - The context. - The decoder. - The attributes to load. - - - - Reads the value for any non-value attribute. - - - - - Write the value for any non-value attribute. - - - - - A base class for AsyncResult objects - - - - - Initializes a new instance of the class. - - The callback to use when the operation completes. - The callback data. - The timeout for the operation. - - - - Initializes a new instance of the class. - - The callback to use when the operation completes. - The callback data. - The timeout for the operation. - Cancellation token for async operation. - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - An object used to synchronize access to the result object. - - - - - An object used to synchronize access to the result object. - - - - - An exception that occured during processing. - - - - - The cancellation token associated with the operation. - - - - - Waits for the operation to complete. - - The result object returned from the Begin method. - - - - Waits for the operation to complete. - - True if operation completed without any errors. - - - - Called to reset the wait handle. - - - - - Called to invoke the callback after the asynchronous operation completes. - - - - - Called to dispose the timer. - - - - - Disposes the wait handle. - - - - - - Called when the operation times out. - - - - - Gets a user-defined object that qualifies or contains information about an asynchronous operation. - - A user-defined object that qualifies or contains information about an asynchronous operation. - - - - Gets a that is used to wait for an asynchronous operation to complete. - - A that is used to wait for an asynchronous operation to complete. - - - - Gets a value that indicates whether the asynchronous operation completed synchronously. - - true if the asynchronous operation completed synchronously; otherwise, false. - - - - Gets a value that indicates whether the asynchronous operation has completed. - - true if the operation is complete; otherwise, false. - - - - The arguments passed to the ConnectionWaiting event. - - - - - Create a connection waiting event for a reverse hello message. - - The Uri of the server. - The endpoint Url of the server. - - - - - - - - - - - - - Allow the event callback handler to accept the - incoming reverse hello connection. - - - - - The arguments passed to the ConnectionStatus event. - - - - - The endpoint Url of the channel which changed the status. - - - - - The new status of the channel. - - - - - Indicate that the channel is closed. - - - - - This is an interface to a channel which supports - - - - - A masking indicating which features are implemented. - - - - - Gets the description for the endpoint used by the channel. - - - - - Gets the configuration for the channel. - - - - - Gets the context used when serializing messages exchanged via the channel. - - - - - Gets the the channel's current security token. - - - - - Gets or sets the default timeout for requests send via the channel. - - - - - Initializes a secure channel with the endpoint identified by the URL. - - The URL for the endpoint. - The settings to use when creating the channel. - Thrown if any communication error occurs. - - - - Initializes a secure channel with the endpoint identified by the URL. - - - - - Opens a secure channel with the endpoint identified by the URL. - - Thrown if any communication error occurs. - - - - Begins an asynchronous operation to open a secure channel with the endpoint identified by the URL. - - The callback to call when the operation completes. - The callback data to return with the callback. - The result which must be passed to the EndOpen method. - Thrown if any communication error occurs. - - - - - Completes an asynchronous operation to open a secure channel. - - The result returned from the BeginOpen call. - Thrown if any communication error occurs. - - - - - Closes any existing secure channel and opens a new one. - - Thrown if any communication error occurs. - - Calling this method will cause outstanding requests over the current secure channel to fail. - - - - - Closes any existing secure channel and opens a new one. - - The waiting reverse connection for the reconnect attempt. - Thrown if any communication error occurs. - - Calling this method will cause outstanding requests over the current secure channel to fail. - - - - - Begins an asynchronous operation to close the existing secure channel and open a new one. - - The callback to call when the operation completes. - The callback data to return with the callback. - The result which must be passed to the EndReconnect method. - Thrown if any communication error occurs. - - - - - Completes an asynchronous operation to close the existing secure channel and open a new one. - - The result returned from the BeginReconnect call. - Thrown if any communication error occurs. - - - - - Closes the secure channel. - - Thrown if any communication error occurs. - - - - Begins an asynchronous operation to close the secure channel. - - The callback to call when the operation completes. - The callback data to return with the callback. - The result which must be passed to the EndClose method. - Thrown if any communication error occurs. - - - - - Completes an asynchronous operation to close the secure channel. - - The result returned from the BeginClose call. - Thrown if any communication error occurs. - - - - - Sends a request over the secure channel. - - The request to send. - The response returned by the server. - Thrown if any communication error occurs. - - - - Sends a request over the secure channel, async version. - - The request to send. - The cancellation token. - The response returned by the server. - Thrown if any communication error occurs. - - - - Begins an asynchronous operation to send a request over the secure channel. - - The request to send. - The callback to call when the operation completes. - The callback data to return with the callback. - The result which must be passed to the EndSendRequest method. - Thrown if any communication error occurs. - - - - - Completes an asynchronous operation to send a request over the secure channel. - - The result returned from the BeginSendRequest call. - Thrown if any communication error occurs. - - - - - The masks for the optional features which may not be supported by every transport channel. - - - - - The channel does not support any optional features. - - - - - The channel supports Open. - - - - - The channel supports asynchronous Open. - - - - - The channel supports Reconnect. - - - - - The channel supports asynchronous Reconnect. - - - - - The channel supports asynchronous Close. - - - - - The channel supports asynchronous SendRequest. - - - - - The channel supports Reconnect. - - - - - The channel supports asynchronous SendRequestAsync. - - - - - The delegate for the async connection waiting handler. - - - - - This is an interface to a listener which supports UA binary encoding. - - - - - The protocol supported by the listener. - - - - - Opens the listener and starts accepting connection. - - The base address. - The settings to use when creating the listener. - The callback to use when requests arrive via the channel. - Thrown if any parameter is null. - Thrown if any communication error occurs. - - - - Closes the listener and stops accepting connection. - - Thrown if any communication error occurs. - - - - Updates the application certificate for a listener. - - - - - Raised when a new connection is waiting for a client. - - - - - Raised when a monitored connection's status changed. - - - - - Creates a reverse connection to a client. - - - - - The arguments passed to the ConnectionWaiting event. - - - An object which implements this interface can be used - to create a session using the reverse connect handshake. - - - - - The application Uri of the server in the - reverse hello message. - - - - - The endpoint of the server in the - reverse hello message. - - - - - A handle to a message socket that can be used - to connect to the server. - - - - - This is an interface to a object that receives notifications - from the listener when a message arrives. - - - - - Begins processing a request received via a binary encoded channel. - - A unique identifier for the secure channel which is the source of the request. - The description of the endpoint which the secure channel is using. - The incoming request. - The callback. - The callback data. - The result which must be passed to the EndProcessRequest method. - - - - - - Ends processing a request received via a binary encoded channel. - - The result returned by the BeginProcessRequest method. - The response to return over the secure channel. - - - - - Stores the configuration settings for a channel. - - - - - Gets or sets the description for the endpoint. - - May be null if no security is used. - - - - Gets or sets the configuration for the endpoint. - - - - - Gets or sets the client certificate. - - May be null if no security is used. - - - - Gets or sets the client certificate chain. - - - The client certificate chain. - - - - - Gets or Sets the server certificate. - - May be null if no security is used. - - - - Gets or sets the certificate validator for the application. - - - May be null if no security is used. - This is the object used by the channel to validate received certificates. - Validatation errors are reported to the application via this object. - - - - - Gets or sets a reference to the table of namespaces for the server. - - - This is a thread safe object that may be updated by the application at any time. - This table is used to lookup the NamespaceURI for the DataTypeEncodingId when decoding ExtensionObjects. - If the NamespaceURI can be found the decoder will use the Factory to create an instance of a .NET object. - The raw data is passed to application if the NamespaceURI cannot be found or there is no .NET class - associated with the DataTypeEncodingId then. - - - - - - Gets or sets the table of known encodeable objects. - - - This is a thread safe object that may be updated by the application at any time. - This is a table of .NET types indexed by their DataTypeEncodingId. - The decoder uses this table to automatically create the appropriate .NET objects when it - encounters an ExtensionObject in the message being decoded. - The table uses DataTypeEncodingIds with the URI explicitly specified so multiple channels - with different servers can share the same table. - The NamespaceUris table is used to lookup the NamespaceURI from the NamespaceIndex provide - in the encoded message. - - - - - - Stores the configuration settings for a channel. - - - - - Gets or sets the descriptions for the endpoints supported by the listener. - - - - - Gets or sets the configuration for the endpoints. - - - - - Gets or sets the server certificate. - - - - - Gets or sets the server certificate chain. - - - The server certificate chain. - - - - - Gets or Sets the certificate validator. - - - This is the object used by the channel to validate received certificates. - Validatation errors are reported to the application via this object. - - - - - Gets or sets a reference to the table of namespaces for the server. - - - This is a thread safe object that may be updated by the application at any time. - This table is used to lookup the NamespaceURI for the DataTypeEncodingId when decoding ExtensionObjects. - If the NamespaceURI can be found the decoder will use the Factory to create an instance of a .NET object. - The raw data is passed to application if the NamespaceURI cannot be found or there is no .NET class - associated with the DataTypeEncodingId then. - - - - - - Gets or sets the table of known encodeable objects. - - - This is a thread safe object that may be updated by the application at any time. - This is a table of .NET types indexed by their DataTypeEncodingId. - The decoder uses this table to automatically create the appropriate .NET objects when it - encounters an ExtensionObject in the message being decoded. - The table uses DataTypeEncodingIds with the URI explicitly specified so multiple channels - with different servers can share the same table. - The NamespaceUris table is used to lookup the NamespaceURI from the NamespaceIndex provide - in the encoded message. - - - - - - Indicates if the transport listener is used as an endpoint for a reverse connection. - - - - - The SoftwareCertificate class. - - - - - The SignedSoftwareCertificate that contains the SoftwareCertificate - - - - - Validates a software certificate. - - - - - The issued token type. - - - - - Web services security (WSS) token. - - - - - Security Assertions Markup Language (SAML) token. - - - - - JSON web token. - - - - - Kerberos token. - - - - - Flags that can be set for the EventNotifier attribute. - - - Flags that can be set for the EventNotifier attribute. - - - - - The Object or View produces no event and has no event history. - - - - - The Object or View produces event notifications. - - - - - The Object has an event history which may be read. - - - - - The Object has an event history which may be updated. - - - - - Flags that can be set for the AccessLevel attribute. - - - Flags that can be set for the AccessLevel attribute. - - - - - The Variable value cannot be accessed and has no event history. - - - - - The current value of the Variable may be read. - - - - - The current value of the Variable may be written. - - - - - The current value of the Variable may be read or written. - - - - - The history for the Variable may be read. - - - - - The history for the Variable may be updated. - - - - - The history value of the Variable may be read or updated. - - - - - Indicates if the Variable generates SemanticChangeEvents when its value changes. - - - - - Indicates if the current StatusCode of the value is writable. - - - - - Indicates if the current SourceTimestamp is writable. - - - - - Constants defined for the ValueRank attribute. - - - Constants defined for the ValueRank attribute. - - - - - The variable may be a scalar or a one dimensional array. - - - - - The variable may be a scalar or an array of any dimension. - - - - - The variable is always a scalar. - - - - - The variable is always an array with one or more dimensions. - - - - - The variable is always one dimensional array. - - - - - The variable is always an array with two or more dimensions. - - - - - Checks if the actual value rank is compatible with the expected value rank. - - - - - Checks if the actual array diminesions is compatible with the expected value rank and array dimensions. - - - - - Constants defined for the MinimumSamplingInterval attribute. - - - Constants defined for the MinimumSamplingInterval attribute. - - - - - The server does not know how fast the value can be sampled. - - - - - TThe server can sample the variable continuously. - - - - - A collection of Boolean values. - - - Provides a strongly-typed collection of Boolean values. - - - - BooleanCollection bools = new BooleanCollection(); - bools.AddRange( new bool[]{true, false, true, false} ); - - - Dim bools As New BooleanCollection() - bools.AddRange( New Boolean(){ True, False, True, False } ) - - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - - Creates a new collection and populates the collection with the - values passed in. - - A collection of boolean values to add to this new collection - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of boolean values to convert to a strong-collection of this class type - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of boolean values to convert to a strong-collection of this class type - - - - - - - Creates a deep copy of the collection. - - - Returns a new instance of this object type, while copying its contents. - - - - - A collection of SByte values. - - - Provides a strongly-typed list of values. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection and sets the maximum capacity - - - Initializes the collection and sets the maximum capacity - - The maximum size of this collection - - - - Initializes the collection and populates it with the specified collection of SByte values - - - Initializes the collection and populates it with the specified collection of SByte values - - A collection of values to populate this collection with - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of values to convert from - - - - Converts an array to a collection. - - - Converts an array of SByte to a collection. - - An array of SByte values to convert - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - A collection of Byte values. - - - Provides a strongly-typed list of values. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection and sets the maximum capacity - - - Initializes the collection and sets the maximum capacity - - The maximum size of this collection - - - - Initializes the collection and populates it with the specified collection of Byte values - - - Initializes the collection and populates it with the specified collection of Byte values - - A collection of values to populate this collection with - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of values to convert from - - - - Converts an array to a collection. - - - Converts an array of Byte to a collection. - - An array of Byte values to convert - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - A collection of Int16 values. - - - A strongly-typed collection of Int16 values. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection and specifies the capacity - - - Initializes the collection and specifies the capacity - - The max size of the collection - - - - Initializes the collection and populates it with the values passed-in - - - Initializes the collection and populates it with the values passed-in - - A collection of values to populate the collection with - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of values to convert to a collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of values to convert to a collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - A collection of UInt16 values. - - - A collection of UInt16 values. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - The max capacity size of this collection - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - A Collection of to pre-populate the collection with - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of values to conver to a collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of values to conver to a collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - A collection of Int32 values. - - - - - Initializes an empty collection. - - - Initializes an empty collection of . - - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - Max capacity of this collection - - - - Initializes the collection from another collection - - - Initializes the collection from another collection - - A collection of to pre-populate this collection with - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of to convert to a collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of to convert to a collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - A collection of UInt32 values. - - - A collection of UInt32 values. - - - - - Initializes an empty collection. - - - Initializes an empty collection of . - - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - Max capacity of the collection - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - A collection of to pre-populate the collection with - - - - Converts an array to a collection. - - - Converts an array to a collection. - - - An array of values to return as a strongly-typed collection - - - - - Converts an array to a collection. - - - Converts an array to a collection. - - - An array of values to return as a strongly-typed collection - - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - A collection of Int64 values. - - - A strongly-typed collection of Int64 values. - - - - - Initializes an empty collection. - - - Initializes an empty collection of . - - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - Max capacity of the collection - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - A colleciton of to pre-populate the collection with - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of to convert to a collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of to convert to a collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - A collection of UInt64 values. - - - A strongly-typed collection of UInt64 values. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - Max capacity of collection - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - A collection of to pre-populate the collection with - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of to return as a collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of to return as a collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - A collection of Float values. - - - A strongly-typed collection of Float values. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - The max capacity of this collection - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - The collection of values to add into this collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of floats to return as a collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of floats to return as a collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - A collection of Double values. - - - A collection of Double values. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - max capacity of collection - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - A collection of doubles to add into this collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - an array of doubles to return as a collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - an array of doubles to return as a collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - A collection of String values. - - - A strongly-typed collection of String values. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - Max capacity of collection - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - A collection of strings to add to this collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - A collection of strings to add to this collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - A collection of strings to add to this collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - A collection of DateTime values. - - - A strongly-typed collection of DateTime values. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - Max capacity of collection - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - A collection of DateTime to add to this collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - Array of DateTime to return as a collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - Array of DateTime to return as a collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - A collection of ByteString values. - - - A collection of ByteString values. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - Max size of collection - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - A collection of byte to add to this collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - Array of bytes to return as a collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - Array of bytes to return as a collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - A collection of XmlElement values. - - - A strongly-typed collection of XmlElement values. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - Max size of collection - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - A collection of XmlElement's to add to this collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of XmlElement's to return as a collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of XmlElement's to return as a collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - A class that stores the value of variable with an optional status code and timestamps. - - - - This object relates to the OPC UA Specifications Part 6: Mappings, section 6.2.2.16 - titled DataValue. -
    - - This object is essentially a place-holder for the following: - - - - for the Servers Timestamp - -
    -
    - - - - //define a new DataValue first where: - // (a) the value is a string, which is "abc123" - // (b) the statuscode is 0 (zero) - // (c) the timestamp is 'now' - DataValue dv = new DataValue(new Variant("abc123"), new StatusCode(0), DateTime.Now); - - - - - 'define a new DataValue first where: - ' (a) the value is a string, which is "abc123" - ' (b) the statuscode is 0 (zero) - ' (c) the timestamp is 'now' - Dim dv As DataValue = New DataValue(New Variant("abc123"), New StatusCode(0), DateTime.Now); - - - - - -
    - - - Initializes the object with default values. - - - Initializes the object with default values. - - - - - Creates a deep copy of the value. - - - Creates a new instance of the class while copying the contents - of another instance. - - The DataValue to copy. - Thrown when the value is null - - - - Initializes the object with a value. - - - Initializes the object with a value from a - - The value to set - - - - Initializes the object with a status code. - - - Initializes the object with a status code. - - The StatusCode to set - - - - Initializes the object with a status code and a server timestamp. - - - Initializes the object with a status code and a server timestamp. - - The status code associated with the value. - The timestamp associated with the status code. - - - - Initializes the object with a value and a status code. - - - Initializes the object with a value and a status code. - - The status code to set - The value to set - - - - Initializes the object with a value, a status code and a source timestamp - - - Initializes the object with a value, a status code and a source timestamp - - The timestamp to set - The status code to set - The variant value to set - - - - Initializes the object with a value, a status code, a source timestamp and a server timestamp - - - Initializes the object with a value, a status code, a source timestamp and a server timestamp - - The servers timestamp to set - The source timestamp to set - The status code to set - The variant value to set - - - - Sets private members to default values. - - - - - Determines if the specified object is equal to the object. - - - Determines if the specified object is equal to the object. - - The object to compare to *this* - - - - Determines if the specified object is equal to the object. - - - Determines if the specified object is equal to the object. - - The DataValue to compare to *this* - - - - Returns a unique hashcode for the object. - - - Returns a unique hashcode for the object. - - - - - Converts the value to a human readable string. - - - Converts the value to a human readable string. - - - - - Returns the string representation of the object. - - - Returns the string representation of the object. - - Not used, ALWAYS specify a null/nothing value - The format string, ALWAYS specify a null/nothing value - Thrown when the format is NOT null/nothing - - - - - - - Makes a deep copy of the object. - - - Makes a deep copy of the object. - - - - - The value of data value. - - - The value of data value. - - - - - The value of data value. - - - The value of data value. - - - - - The status code associated with the value. - - - The status code associated with the value. - - - - - The source timestamp associated with the value. - - - The source timestamp associated with the value. - - - - - Additional resolution for the source timestamp. - - - Additional resolution for the source timestamp. - - - - - The server timestamp associated with the value. - - - The server timestamp associated with the value. - - - - - Additional resolution for the server timestamp. - - - Additional resolution for the server timestamp. - - - - - Returns true if the status code is good. - - - Returns true if the status code is good. - - The value to check the quality of - - - - Returns true if the status is bad or uncertain. - - - Returns true if the status is bad or uncertain. - - The value to check the quality of - - - - Returns true if the status code is uncertain. - - - Returns true if the status code is uncertain. - - The value to checck the quality of - - - - Returns true if the status is good or uncertain. - - - Returns true if the status is good or uncertain. - - The value to check the quality of - - - - Returns true if the status code is bad. - - - Returns true if the status code is bad. - - The value to check the quality of - - - - Returns true if the status is good or uncertain. - - - Returns true if the status is good or uncertain. - - The value to check the quality of - - - - Ensures the data value contains a value with the specified type. - - - - - Gets the value from the data value. - - The type of object. - The default value to return if any error occurs. - The value. - - Does not throw exceptions; returns the caller provided value instead. - Extracts the body from an ExtensionObject value if it has the correct type. - Checks the StatusCode and returns an error if not Good. - - - - - A collection of DataValues. - - - A strongly-typed collection of DataValues. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - A collection of objects to pre-populate this new collection with - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - The max capacity of this collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of objects to return as a collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of objects to return as a collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - Contains diagnostic information associated with a StatusCode. - - - - The DiagnosticInfo BinaryEncoding is defined in Part 6 - Mappings, Section 6.2.2.13, titled - Mappings. -
    - - The DiagnosticInfo object is an object that contains diagnostic information, and is intended to be used - in provide diagnostic information in a uniform way. -
    -
    -
    - - - Limits the recursion depth for the InnerDiagnosticInfo field. - - - - - Initializes the object with default values. - - - - - Creates a deep copy of the value. - - - Creates a new instance of the object while copying the value passed in. - If InnerDiagnosticInfo exceeds the recursion limit, it is not copied. - - The value to copy - Thrown when the value is null - - - - Creates a deep copy of the value, but limits the recursion depth. - - - - - Initializes the object with specific values. - - The symbolic ID - The namespace URI applicable - The locale for the localized text value - The localized text value - Additional, textual information - - - - Initializes the object with a ServiceResult. - - The bitmask describing the diagnostic data - The overall transaction result - The service level - A table of strings carrying more diagnostic data - - - - Initializes the object with a ServiceResult. - Limits the recursion depth for the InnerDiagnosticInfo field. - - The bitmask describing the diagnostic data - The overall transaction result - The service level - A table of strings carrying more diagnostic data - The recursion depth of the inner diagnostics field - - - - Initializes the object with an exception. - - A bitmask describing the type of diagnostic data - The exception to associated with the diagnostic data - The service level - A table of strings that may contain additional diagnostic data - - - - Initializes the object during deserialization. - - The context information of an underlying data-stream - - - - Initializes the object during deserialization. - - - Initializes the object with default values during deserialization. - - - - - Initializes the object with a service result. - - The bitmask describing the type of diagnostic data - The transaction result - An array of strings that may be used to provide additional diagnostic details - The depth of the inner diagnostics property - - - - The index of the symbolic id in the string table. - - - - - The index of the namespace uri in the string table. - - - - - The index of the locale associated with the localized text. - - - - - The index of the localized text in the string table. - - - - - The additional debugging or trace information. - - - - - The status code returned from an underlying system. - - - - - The diagnostic info returned from a underlying system. - - - - - Whether the object represents a Null DiagnosticInfo. - - - - - Determines if the specified object is equal to the object. - - - - - Returns a unique hashcode for the object. - - - - - Converts the value to a human readable string. - - - Converts the value to a human readable string. - - - - - Returns the string representation of the object. - - - Returns the string representation of the object. - - (Unused). Always pass a null - (Unused) The provider. - Thrown if the format parameter is NOT null - - - - - - - Makes a deep copy of the object. - - - - - Adds the hashcodes for the object. - Limits the recursion depth to prevent stack overflow. - - - - - Determines if the specified object is equal to this object. - Limits the depth of the comparison to avoid infinite recursion. - - - - - A collection of DiagnosticInfo objects. - - - A strongly-typed collection of DiagnosticInfo objects. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - The collection to copy the contents from - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - The max capacity of the collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of objects to return within a collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of objects to return within a collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - The DiagnosticsMasks enumeration. - - - - - ServiceSymbolicId = 0, - - - - - ServiceSymbolicId = 1, - - - - - ServiceLocalizedText = 2, - - - - - ServiceAdditionalInfo = 4, - - - - - ServiceInnerStatusCode = 8, - - - - - ServiceInnerDiagnostics = 16, - - - - - ServiceSymbolicIdAndText = 3, - - - - - ServiceNoInnerStatus = 15, - - - - - ServiceAll = 31, - - - - - OperationSymbolicId = 32, - - - - - OperationLocalizedText = 64, - - - - - OperationAdditionalInfo = 128, - - - - - OperationInnerStatusCode = 256, - - - - - OperationInnerDiagnostics = 512, - - - - - OperationSymbolicIdAndText = 96, - - - - - OperationNoInnerStatus = 224, - - - - - OperationAll = 992, - - - - - SymbolicId = 33, - - - - - LocalizedText = 66, - - - - - AdditionalInfo = 132, - - - - - InnerStatusCode = 264, - - - - - InnerDiagnostics = 528, - - - - - SymbolicIdAndText = 99, - - - - - NoInnerStatus = 239, - - - - - All = 1023 - - - - - UserPermissionAdditionalInfo = 0x80000000, - - - Mask for internal use only. - - - - - Extends a node id by adding a complete namespace URI. - - - Extends a node id by adding a complete namespace URI. - - - - - Initializes the object with default values. - - - Creates a new instance of the object, accepting the default values. - - - - - Creates a deep copy of the value. - - - Creates a new instance of the object, while copying the properties of the specified object. - - The ExpandedNodeId to copy - Thrown when the parameter is null - - - - Initializes an expanded node identifier with a node id. - - - Creates a new instance of the object, while wrapping the specified . - - The to wrap - - - - Initializes a new instance of the class. - - The identifier. - The namespace index. - The namespace URI. - The server index. - - - - Initializes an expanded node identifier with a node id and a namespace URI. - - - Creates a new instance of the object while allowing you to specify both the - and the Namespace URI that applies to the NodeID. - - The to wrap. - The namespace that this node belongs to - - - - Initializes an expanded node identifier with a node id and a namespace URI. - - - Creates a new instance of the object while allowing you to specify both the - and the Namespace URI that applies to the NodeID. - - The to wrap. - The namespace that this node belongs to - The server that the node belongs to - - - - Initializes a numeric node identifier. - - - Creates a new instance of the object while accepting the numeric id/value of - the NodeID we are wrapping. - - The numeric id of a node to wrap - - - - Initializes a numeric node identifier with a namespace index. - - - Creates a new instance of the class while accepting both the id and namespace - of the node we are wrapping. - - The numeric id of the node we are wrapping - The namspace index that this node belongs to - - - - Initializes a numeric node identifier with a namespace URI. - - - Creates a new instance of the class while accepting both the numeric id of the - node, along with the actual namespace that this node belongs to. - - The numeric id of the node we are wrapping - The namespace that this node belongs to - - - - Initializes a string node identifier with a namespace index. - - - Creates a new instance of the class while allowing you to specify both the - node and the namespace. - - The numeric index of the namespace within the table, that this node belongs to - The string id/value of the node we are wrapping - - - - Initializes a string node identifier with a namespace URI. - - - Creates a new instance of the class while allowing you to specify both the node and namespace - - The actual namespace URI that this node belongs to - The string value/id of the node we are wrapping - - - - Initializes a guid node identifier. - - - Creates a new instance of the class while specifying the value - of the node we are wrapping. - - The Guid value of the node we are wrapping - - - - Initializes a guid node identifier. - - - Creates a new instance of the class while specifying the value - of the node and the namesapceIndex we are wrapping. - - The Guid value of the node we are wrapping - The index of the namespace that this node should belong to - - - - Initializes a guid node identifier. - - - Creates a new instance of the class while specifying the value - of the node and the namespaceUri we are wrapping. - - The Guid value of the node we are wrapping - The namespace that this node belongs to - - - - Initializes a opaque node identifier. - - - Creates a new instance of the class while allowing you to specify the byte[] id - of the node. - - The id of the node we are wrapping - - - - Initializes an opaque node identifier with a namespace index. - - - Creates a new instance of the class while allowing you to specify the node - and namespace index. - - The id of the node we are wrapping - The index of the namespace that this node should belong to - - - - Initializes an opaque node identifier with a namespace index. - - - Creates a new instance of the class while allowing you to specify the node and namespace. - - The node we are wrapping - The namespace that this node belongs to - - - - Initializes a node id by parsing a node id string. - - - Creates a new instance of the class while allowing you to specify the id of the node. - - The textual id of the node being wrapped - - - - Sets the private members to default values. - - - Sets the private members to default values. - - - - - The index of the namespace URI in the server's namespace array. - - - The index of the namespace URI in the server's namespace array. - - - - - The type of node identifier used. - - - The type of node identifier used. - - - - - The node identifier. - - - Returns the node id in whatever form, i.e. - string, Guid, byte[] or uint. - - - - - The namespace that qualifies the node identifier. - - - Returns the namespace that the node belongs to - - - - - The index of the server where the node exists. - - - Returns the index of the server where the node resides - - - - - Whether the object represents a Null NodeId. - - - Returns whether or not the is null - - - - - Returns true if the expanded node id is an absolute identifier that contains a namespace URI instead of a server dependent index. - - - Returns true if the expanded node id is an absolute identifier that contains a namespace URI instead of a server dependent index. - - - - - Returns the inner node id. - - - Returns the inner node id. - - - - - The node identifier formatted as a URI. - - - The node identifier formatted as a URI. - - - - - Formats a expanded node id as a string. - - - - Formats a ExpandedNodeId as a string. -
    - - An example of this would be: -
    - - NodeId = "hello123"
    - NamespaceUri = "http://mycompany/"
    -
    This would translate into:
    - nsu=http://mycompany/;s=hello123 -
    -
    - - NodeId = 5
    - NamespaceIndex = 2
    -
    This would translate into:
    - ns=2;i=5 -
    -
    - - Note: Only information already included in the ExpandedNodeId-Instance will be included in the result - -
    -
    - - - Formats the node ids as string and adds it to the buffer. - - - - - Formats the node ids as string and adds it to the buffer. - - - - - Parses a expanded node id string, translated any namespace indexes and returns the result. - - - - - Parses a expanded node id string and returns a node id object. - - - Parses a ExpandedNodeId String and returns a NodeId object - - The ExpandedNodeId value as a string. - Thrown under a variety of circumstances, each time with a specific message. - - - - Unescapes any reserved characters in the uri. - - - - - The set of hexadecimal digits used for decoding escaped URIs. - - - - - Compares the current instance to the object. - - - Compares the current instance to the object. - - - - - Returns true if a is greater than b. - - - Returns true if a is greater than b. - - - - - Returns true if a is less than b. - - - Returns true if a is less than b. - - - - - Determines if the specified object is equal to the ExpandedNodeId. - - - Determines if the specified object is equal to the ExpandedNodeId. - - - - - Returns a unique hashcode for the ExpandedNodeId - - - Returns a unique hashcode for the ExpandedNodeId - - - - - Returns true if the objects are equal. - - - Returns true if the objects are equal. - - - - - Returns true if the objects are not equal. - - - Returns true if the objects are not equal. - - - - - Implements .Equals(T)"/> - - The other ExpandedNodeId. - - - - Returns the string representation of an ExpandedNodeId. - - - Returns the string representation of an ExpandedNodeId. - - The as a formatted string - (Unused) The format string. - (Unused) The format-provider. - Thrown when the 'format' parameter is NOT null. So leave that parameter null. - - - - - - - Makes a deep copy of the object. - - - Returns a reference to *this* object. This means that no copy is being made of this object. - - - - - Returns the string representation of am ExpandedNodeId. - - - Returns the string representation of am ExpandedNodeId. - - - - - Converts an expanded node id to a node id using a namespace table. - - - Converts an to a using a namespace table. - - The ExpandedNodeId to convert to a NodeId - The namespace table that contains all the namespaces needed to resolve the namespace index as encoded within this object. - - - - Updates the namespace index. - - - Updates the namespace index. - - - - - Updates the namespace uri. - - - - - Updates the server index. - - - - - Parses an absolute NodeId formatted as a string and converts it a local NodeId. - - The current namespace table. - The text to parse. - The local identifier. - Thrown if the namespace URI is not in the namespace table. - - - - Converts an ExpandedNodeId to a NodeId. - - - Converts an ExpandedNodeId to a NodeId. - - Thrown if the ExpandedNodeId is an absolute node identifier. - - - - Converts an integer to a numeric node identifier. - - - Converts an integer to a numeric node identifier. - - - - - Converts a guid to a guid node identifier. - - - Converts a guid to a guid node identifier. - - - - - Converts a byte array to an opaque node identifier. - - - Converts a byte array to an opaque node identifier. - - - - - Parses a node id string and initializes a node id. - - - Parses a node id string and initializes a node id. - - - - - Converts a NodeId to an ExpandedNodeId - - - Converts a NodeId to an ExpandedNodeId - - - - - Returns an instance of a null ExpandedNodeId. - - - - - Parses a expanded node id string and sets the properties. - - The ExpandedNodeId value as a string. - - - - A collection of ExpandedNodeId objects. - - - - - Initializes an empty collection. - - - Creates a new [empty] collection. - - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - - - - Converts an array to a collection. - - - This static method converts an array of objects to - an . - - An array of values to return as a collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of values to return as a collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - An object used to wrap data types that the receiver may not understand. - - - - This class is a wrapper/helper class for storing data types that a receiver might not - understand, or be prepared to handle. This class may use to - analyze an object and retrieve the values of its public properties directly, and then - encode those into a string representation that can then be easily encoded as a single string. -
    -
    - - An instance of the is a container for any complex data types which cannot be encoded as one of the - other built-in data types. The ExtensionObject contains a complex value serialized as a sequence of - bytes or as an XML element. It also contains an identifier which indicates what data it contains and - how it is encoded. - -
    - - - The following example demonstrates a simple class containing 3 public properties of - type int, DateTime and string. This class implements the - interface, and is then encoded using the WriteExtensionObject method. -
    - - //First, we will define a very simple class object that will represent - //some real-world process. - class simpleClass : IEncodeable - { - - //fields - public string PublicFieldNotVisible = "I should not be encoded"; - - //properties - private string stringField; - public string StringProperty - { - get - { - return (stringField); - } - set - { - stringField = value; - } - } - - private int intField; - public int IntProperty - { - get - { - return (intField); - } - set - { - intField = value; - } - } - - private DateTime datetimeField; - public DateTime DatetimeProperty - { - get - { - return (datetimeField); - } - set - { - datetimeField = value; - } - } - - //class constructor - public simpleClass(string StringValue, int IntValue, DateTime DateTimeValue) - { - StringProperty = StringValue; - IntProperty = IntValue; - DatetimeProperty = DateTimeValue; - } - public simpleClass(simpleClass SimpleClassInstance) - { - StringProperty = SimpleClassInstance.StringProperty; - IntProperty = SimpleClassInstance.IntProperty; - DatetimeProperty = SimpleClassInstance.DatetimeProperty; - } - - #region IEncodeable Members - - public ExpandedNodeId TypeId - { - get - { - return (new ExpandedNodeId(Guid.NewGuid())); - } - } - - public void Encode(IEncoder encoder) - { - if (encoder != null) - { - //our simple object has 3 properies: string, int and datetime - encoder.WriteString("StringProperty", this.StringProperty); - encoder.WriteInt32("IntProperty", this.IntProperty); - encoder.WriteDateTime("DateTimeProperty", this.DatetimeProperty); - } - } - - public void Decode(IDecoder decoder) - { - if (decoder != null) - { - this.StringProperty = decoder.ReadString("StringProperty"); - this.IntProperty = decoder.ReadInt16("IntProperty"); - this.DatetimeProperty = decoder.ReadDateTime("DateTimeProperty"); - } - } - - public bool IsEqual(IEncodeable encodeable) - { - return (encodeable.Equals(this)); - } - - #endregion - - #region ICloneable Members - - public new object MemberwiseClone() - { - return (new simpleClass(this)); - } - - #endregion - - } - - public void EncodeExample() - { - //define an instance of our class object, defined above. - simpleClass mySimpleClassInstance1 = new simpleClass("String", int.MaxValue, DateTime.Now); - - //define an object that will encapsulate/extend our simple instance above - ExtensionObject extendedSimpleClassInstance = new ExtensionObject(mySimpleClassInstance1); - - /// - //encode our class object into the stream - uaEncoderInstance.WriteExtensionObject( "Extended1", extendedSimpleClassInstance); - } - - - - 'First, we will define a very simple class object that will represent - 'some real-world process. - - Class simpleClass - Inherits IEncodeable - - 'fields - Public PublicFieldNotVisible As String = "I should not be encoded" - - 'properties - Private stringField As String - Private intField As Integer - Private datetimeField As DateTime - - 'class constructor - Public Sub New(ByVal StringValue As String, ByVal IntValue As Integer, ByVal DateTimeValue As DateTime) - StringProperty = StringValue - IntProperty = IntValue - DatetimeProperty = DateTimeValue - End Sub - - Public Sub New(ByVal SimpleClassInstance As simpleClass) - StringProperty = SimpleClassInstance.StringProperty - IntProperty = SimpleClassInstance.IntProperty - DatetimeProperty = SimpleClassInstance.DatetimeProperty - End Sub - - Public Property StringProperty As String - Get - Return stringField - End Get - Set - stringField = value - End Set - End Property - - Public Property IntProperty As Integer - Get - Return intField - End Get - Set - intField = value - End Set - End Property - - Public Property DatetimeProperty As DateTime - Get - Return datetimeField - End Get - Set - datetimeField = value - End Set - End Property - - Public ReadOnly Property TypeId As ExpandedNodeId - Get - Return New ExpandedNodeId(Guid.NewGuid) - End Get - End Property - - Public Sub Encode(ByVal encoder As IEncoder) - If encoder Isnot Nothing Then - 'our simple object has 3 properies: string, int and datetime - encoder.WriteString("StringProperty", Me.StringProperty) - encoder.WriteInt32("IntProperty", Me.IntProperty) - encoder.WriteDateTime("DateTimeProperty", Me.DatetimeProperty) - End If - End Sub - - Public Sub Decode(ByVal decoder As IDecoder) - If decoder Isnot Nothing Then - Me.StringProperty = decoder.ReadString("StringProperty") - Me.IntProperty = decoder.ReadInt16("IntProperty") - Me.DatetimeProperty = decoder.ReadDateTime("DateTimeProperty") - End If - End Sub - - Public Function IsEqual(ByVal encodeable As IEncodeable) As Boolean - Return encodeable.Equals(Me) - End Function - - Public Function Clone() As Object - Return New simpleClass(Me) - End Function - End Class - - Public Sub nodeid() - 'define an instance of our class object, defined above. - Dim mySimpleClassInstance1 As simpleClass = New simpleClass("String", int.MaxValue, DateTime.Now) - - 'define an object that will encapsulate/extend our simple instance above - Dim extendedSimpleClassInstance As ExtensionObject = New ExtensionObject(mySimpleClassInstance1) - - 'encode our class object into the stream - uaEncoderInstance.WriteExtensionObject("Extended1", extendedSimpleClassInstance) - End Sub - -
    -
    - - - Initializes the object with default values. - - - Initializes the object with default values. - - - - - Creates a deep copy of the value. - - The value to be copied. - - Creates a deep copy of the value. - - Thrown when the value is null - - - - Initializes the object with a . - - The type to copy and create an instance from - - - - Initializes the object with a body. - - The body of the object: IEncodeable, XmlElement or Byte-array - - - - Initializes the object with an encodeable object. - - The type describing the body - The underlying data/body to wrap - - Initializes the object with an encodeable object. - - - - - Initializes the object during deserialization. - - - - - The data type node id for the extension object. - - The type id. - - - - The encoding to use when the deserializing/serializing the body. - - The encoding for the embedd object. - - - - The body (embeded object) of the extension object. - - The object to be embeded. - - The body of the extension object. This property will work with objects of the - following types: - - - byte-array ( C# = byte[] or VB.NET Byte() ) - - - - Thrown when the body is not one of the types listed above - - - - Determines if the specified object is equal to the . - - The object to compare to this instance of object - - true if the specified is equal to the current embeded object; otherwise, false. - - - - - Returns a unique hashcode for the embeded object. - - - A hash code for the current embeded object. - - - - - Converts the value to a human readable string. - - - A that represents the current . - - - - - Returns the string representation of the embededobject. - - (Unused). Leave this as null - The provider of a mechanism for retrieving an object to control formatting. - - A containing the value of the current embeded instance in the specified format. - - Thrown if the format parameter is not null - - - - - - - Makes a deep copy of the object. - - - A new object that is a copy of this instance. - - - - - Tests if the extension or embedd objects are null value. - - The object to check if null - - true if the specified is null of the embeded object is null; otherwise, false. - - - Tests is the extension object is null value. - - - - - Converts an extension object to an encodeable object. - - The extension object to convert to an encodeable object - Instance of for the embeded object. - - Converts an extension object to an encodeable object. - - - - - Converts an array of extension objects to an array of the specified type. - - The array to convert. - The type of each element. - The new array - - Will add null elements if individual elements cannot be converted. - - - - - Converts an array of extension objects to a List of the specified type. - - The array to convert. - The new typed List - - Will add null elements if individual elements cannot be converted. - - - - - Returns an instance of a null ExtensionObject. - - - - - The types of encodings that may used with an object. - - - The types of encodings that may used with an object. - - - - - The extension object has no body. - - - - - The extension object has a binary encoded body. - - - - - The extension object has an XML encoded body. - - - - - The extension object has an encodeable object body. - - - - - The extension object has a JSON encoded body. - - - - - A collection of ExtensionObjects. - - - A strongly-typed collection of ExtensionObjects. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - The collection containing the objects to copy into this new instance - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - Max capacity of the collection - - - - Converts an array of ExtensionObjects to a collection. - - - Converts an array of ExtensionObjects to a collection. - - An array of ExtensionObjects to convert to a collection - - - - Converts an encodeable object to an extension object. - - - Converts an encodeable object to an extension object. - - An enumerable array of ExtensionObjects to convert to a collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - An interface to a object that can translate itself. - - - - - Returns a copy of the object with translateable strings replaced. - - The manager which provides the translations. - The locales to use. - A copy of the object - - The copy is not necessarily a deep copy and may reference components of the original object. - The original object is not changed. - - - - - An interface to a object that provides translations. - - - - - Translates the text and then formats it with the arguments provided. - - The list of preferred locales - The key used to look up the translation - The text to translate - The format argumente - The translated text - - If any error occur during format the unformatted text is used instead. - - - - - Translates the LocalizedText using the information in the TranslationInfo property. - - - - - - Translates a service result. - - The preferred locales. - The result. - The result with all localized text translated. - Recusively translates text in inner results. - - - - Stores the information requires to translate a string. - - - - - Creates an empty object. - - - - - Creates an object from a key and a LocalizedText. - - - - - Stores the arguments for uses with a SymbolicId that is used to look up default text. - - - - - Creates an object from a key and a text. - - - - - Creates an object from a key with text and format arguements. - - - - - The key used to look up translations. - - - - - The default locale for the text. - - - - - The text to translate. - - - - - The arguments that are used when formatting the text after translation. - - - - - Stores the type tree for a server. - - - - - Determines whether a node id is a known type id. - - The type extended identifier. - - true if the specified type id is known; otherwise, false. - - - - - Determines whether a node id is a known type id. - - The type identifier. - - true if the specified type id is known; otherwise, false. - - - - - Returns the immediate supertype for the type. - - The extended type identifier. - A type identifier of the - - - - Returns the immediate supertype for the type. - - The type identifier. - The immediate supertype idnetyfier for - - - - Returns the immediate subtypes for the type. - - The extended type identifier. - List of type identifiers for - - - - Determines whether a type is a subtype of another type. - - The subtype identifier. - The supertype identifier. - - true if is supertype of ; otherwise, false. - - - - - Determines whether a type is a subtype of another type. - - The subtype identifier. - The supertype identyfier. - - true if is supertype of ; otherwise, false. - - - - - Returns the qualified name for the reference type id. - - The reference type - A name qualified with a namespace for the reference . - - - - Returns the node identifier for the reference type with the specified browse name. - - Browse name of the reference. - The identifier for the - - - - Checks if the identifier represents a that provides encodings - for the . - - The id the encoding node . - The id of the DataType node. - - true if is encoding of the ; otherwise, false. - - - - - Determines if the value contained in an extension object matches the expected data type. - - The identifier of the expected type . - The value. - - true if the value contained in an extension object matches the - expected data type; otherwise, false. - - - - - Determines if the value is an encoding of the - - The expected type id. - The value. - - true the value is an encoding of the ; otherwise, false. - - - - - Returns the data type for the specified encoding. - - The encoding id. - - - - - Returns the data type for the specified encoding. - - The encoding id. - The data type for the - - - - Human readable qualified with a locale. - - - - The LocalizedText is defined in Part 3 - Address Space Model, Section 7.5, titled - LocalizedText. -
    - - This class provides a wrapper for posting text that is qualified with the locale that it is - intended for. -
    -
    - - The following example shows a very simple use of this class to localize a - welcome message - - LocalizedText welcomeUS = new LocalizedText( "Hi Everyone", "EN-US" ); - LocalizedText welcomeGB = new LocalizedText( "Hello Everyone", "EN-GB" ); - LocalizedText welcomeNoLocale = new LocalizedText( "Welcome" ); - - Utils.LogInfo( welcomeUS.ToString() ); - Utils.LogInfo( welcomeGB.ToString() ); - Utils.LogInfo( welcomeNoLocale.ToString() ); - - - Dim welcomeUS As LocalizedText = New LocalizedText( "Hi Everyone", "EN-GB" ) - Dim welcomeGB As LocalizedText = New LocalizedText( "Hello Everyone", "EN-GB" ) - Dim welcomeNoLocale As LocalizedText = New LocalizedText( "Welcome" ) - - Utils.LogInfo( welcomeUS.ToString() ) - Utils.LogInfo( welcomeGB.ToString() ) - Utils.LogInfo( welcomeNoLocale.ToString() ) - - - This produces the following output:
    - [EN-US]:Hi Everyone
    - [EN-GB]:Hello Everyone
    - Welcome
    -
    -
    -
    - - - Initializes the object with the default values. - - - Initializes the object with the default values. - - - - - Formats the text with the arguments using the specified locale. - - - - - Creates text from a TranslationInfo object. - - - - - Creates a deep copy of the value. - - - Creates a deep copy of the value. - - The text to create an instance from - Thrown when the value is null - - - - Initializes the object with a text and the default locale. - - - Initializes the object with a text and the default locale. - - The plain text stored within this object - - - - Initializes the object with a locale and text. - - - Initializes the object with a locale and text. - - The locale code applicable for the specified text - The text to store - - - - Initializes the locale with a key, locale and text. - - A key used to look up the text for different locales - The locale for the text provides - The localized text - - - - The locale used to create the text. - - - The locale used to create the text. - - - - - - - - The localized text. - - - The localized text. - - - - - - - - A key that can be used to look to the localized text in different locales. - - - This value is used within a process to facilite localization. It is not transmitted on the wire. - - - - - The information required to translate the text into other locales. - - - - - Returns true if the objects are equal. - - - Returns true if the objects are equal. - - The object to compare to this - - - - Returns true if the objects are equal. - - - Returns true if the two objects are equal. - - The first value to compare - The second value to compare - - - - Returns true if the objects are not equal. - - - Returns true if the two objects are not equal. - - The first value to compare - The second value to compare - - - - Returns a suitable hash code for the object. - - - Returns a suitable hash code for the object. - - - - - Returns the string representation of the object. - - - Returns the string representation of the object. - - - - - Returns the string representation of the object. - - - Returns the string representation of the object. - - (Unused). Always pass NULL/NOTHING - (Unused). Always pass NULL/NOTHING - Thrown if non-null parameters are used - - - - - - - Makes a deep copy of the object. - - - Makes a deep copy of the object. - - - - - Converts a string to a localized text. - - - Converts a string to a localized text. - - The string to store as localized text - - - - Converts a string to a localized text. - - - Converts a string to a localized text. - - The string to store as localized text - - - - Returns an instance of a null LocalizedText. - - - - - Returns true if the text is a null or empty string. - - - - - A collection of LocalizedText objects. - - - A strongly-typed collection of LocalizedText objects. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - The collection to copy into this new instance - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - The max capacity of this collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - Array of localized text values to convert to a collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - Array of localized text values to convert to a collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - Wraps a multi-dimensional array for use within a Variant. - - - - - Initializes the matrix with a multidimensional array. - - - - - Initializes the matrix with a one dimensional array and a list of dimensions. - - - - - The elements of the matrix. - - An array of elements. - - - - The dimensions of the matrix. - - The dimensions of the array. - - - - The type information for the matrix. - - The type information. - - - - Returns the flattened array as a multi-dimensional array. - - - - - Determines if the specified object is equal to the object. - - - Determines if the specified object is equal to the object. - - - - - Returns a unique hashcode for the object. - - - - - Returns the string representation of the object. - - (Unused) Always pass a NULL value - The format-provider to use. If unsure, pass an empty string or null - - A containing the value of the current instance in the specified format. - - - Returns the string representation of the object. - - Thrown when the 'format' argument is NOT null. - - - - - - - Makes a deep copy of the object. - - - A new object that is a copy of this instance. - - - - - Debug.Assert if the elements are assigned a valid BuiltInType. - - An array of elements to sanity check. - The builtInType used for the elements. - - - - A function that performes a validation on a given index into the dimensions array - - The index into the dimensions array - The dimensions collection describing a matrix - The validation result - - - - Validate the dimensions of a given matrix. - As a side effect will bring to 0 negative dimensions. - Throws ArgumentException if dimensions overflow and ServiceResultException if maxArrayLength is exceeded - - Allow zero value dimensions - Dimensions to be validated - The limit representing the maximum array length - Tuple with validation result and the calculated length of the flattended matrix - - - - - - Validate the dimensions of a matrix with a provided expected flattened length. - Throws ArgumentException if dimensions overflow and ServiceResultException if maxArrayLength is exceeded - - Dimensions to be validated - The flatLength against the validation occurs - The limit representing the maximum array length - Tuple with validation result and the calculated length of the flattended matrix - - - - - - Validate that dimensions do not overflow - - Collection of dimensions - Tuple with validation result and the calculated length of the flattended matrix - - - - - - Validate the dimensions of a matrix against a given validation function. - Throws ArgumentException if dimensions overflow and ServiceResultException if maxArrayLength is exceeded - - Dimensions to be validated - The limit representing the maximum array length - A custom validation method - The calculated length of the flattended matrix - - - - - - Uses to add the service message context to the operation context. - - - - - Initializes the object with the message context to use. - - - - - Returns the message context associated with the current operation context. - - - - - Returns the message context associated with the current operation context. - - - - - The message context to use. - - - - - Stores an identifier for a node in a server's address space. - - - - Please refer to OPC Specifications: - - Address Space Model setion 7.2 - Address Space Model setion 5.2.2 - - - - Stores the id of a Node, which resides within the server's address space. -
    - - The NodeId can be either: - - - - - [] - -
    - - Important: Keep in mind that the actual ID's of nodes should be unique such that no two - nodes within an address-space share the same ID's. - - - The NodeId can be assigned to a particular namespace index. This index is merely just a number and does - not represent some index within a collection that this node has any knowledge of. The assumption is - that the host of this object will manage that directly. -
    -
    -
    - - - Initializes the object with default values. - - - Creates a new instance of the class which will have the default values. The actual - Node Id will need to be defined as this constructor does not specify the id. - - - - - Creates a deep copy of the value. - - - Creates a new NodeId by copying the properties of the node specified in the parameter. - - The NodeId object whose properties will be copied. - Thrown when value is null - - - - Initializes a numeric node identifier. - - - Creates a new NodeId that will have a numeric (unsigned-int) id - - The numeric value of the id - - - - Initializes a numeric node identifier with a namespace index. - - - Creates a new NodeId that will use a numeric (unsigned int) for its Id, but also - specifies which namespace this node should belong to. - - The new (numeric) Id for the node being created - The index of the namespace that this node should belong to - - - - - Initializes a string node identifier with a namespace index. - - - Creates a new NodeId that will use a string for its Id, but also - specifies if the Id is a URI, and which namespace this node belongs to. - - The new (string) Id for the node being created - The index of the namespace that this node belongs to - - - - Initializes a guid node identifier. - - - Creates a new node whose Id will be a . - - The new Guid value of this nodes Id. - - - - Initializes a guid node identifier. - - - Creates a new node whose Id will be a . - - The new Guid value of this nodes Id. - The index of the namespace that this node belongs to - - - - Initializes an opaque node identifier. - - - Creates a new node whose Id will be a series of . - - An array of that will become this Node's ID - - - - Initializes an opaque node identifier with a namespace index. - - - Creates a new node whose Id will be a series of , while specifying - the index of the namespace that this node belongs to. - - An array of that will become this Node's ID - The index of the namespace that this node belongs to - - - - Initializes a node id by parsing a node id string. - - - Creates a new node with a String id. - - The string id of this new node - - - - Initializes a node identifier with a namespace index. - - - Throws an exception if the identifier type is not supported. - - The identifier - The index of the namespace that qualifies the node - - - - Initializes the object during deserialization. - - - - - Initializes the object during deserialization. - - - - - Converts an identifier and a namespaceUri to a local NodeId using the namespaceTable. - - The identifier for the node. - The URI to look up. - The table to use for the URI lookup. - A local NodeId - Thrown when the namespace cannot be found - - - - Converts an integer to a numeric node identifier. - - - Converts an integer to a numeric node identifier for comparissons. - - - - - //create some variables - uint id1 = 100, id2=101; - NodeId node1; - - //create our node - node1 = new NodeId(id1); - - //now to compare the node to the ids using a simple comparisson and Equals: - Utils.LogInfo("Comparing NodeId to uint"); - Utils.LogInfo("\tComparing 100 to 100 = [equals] {0}", node1.Equals(id1)); - Utils.LogInfo("\tComparing 100 to 100 = [ == ] {0}", node1 == id1); - Utils.LogInfo("\tComparing 100 to 101 = [equals] {0}", node1.Equals(id2)); - Utils.LogInfo("\tComparing 100 to 101 = [ == ] {0}", node1 == id2); - - - - - 'create some variables - Dim id1 As UInt = 100 - Dim id2 As UInt = 102 - Dim node1 As NodeId - - 'create our node - node1 = new NodeId(id1) - - 'now to compare the node to the ids using a simple comparisson and Equals: - Utils.LogInfo("Comparing NodeId to uint") - Utils.LogInfo( String.Format(" Comparing 100 to 100 = [equals] {0}", node1.Equals(id1)) ) - Utils.LogInfo( String.Format(" Comparing 100 to 100 = [ = ] {0}", node1 = id1) ) - Utils.LogInfo( String.Format(" Comparing 100 to 101 = [equals] {0}", node1.Equals(id2)) ) - Utils.LogInfo( String.Format(" Comparing 100 to 101 = [ = ] {0}", node1 = id2) ) - - - - This produces the following output (taken from C# example): -
    - - Comparing NodeId to uint
    - Comparing 100 to 100 = [equals] True
    - Comparing 100 to 100 = [ == ] True
    - Comparing 100 to 101 = [equals] False
    - Comparing 100 to 101 = [ == ] False
    -
    -
    - The to compare this node to. -
    - - - Converts a guid to a guid node identifier. - - - Converts a NodeId into a Guid allowing you to compare a Node against a Guid. - - - - - //define our 2 GUID ids, and then define our node to use the first id. - Guid id1 = Guid.NewGuid(), id2 = Guid.NewGuid(); - NodeId node1 = new NodeId(id1); - - //now to compare the node to the guids - Utils.LogInfo("\n\nComparing NodeId to GUID"); - Utils.LogInfo("\tComparing {0} to {0} = [equals] {2}", id1, id1, node1.Equals(id1)); - Utils.LogInfo("\tComparing {0} to {0} = [ == ] {2}", id1, id1, node1 == id1); - Utils.LogInfo("\tComparing {0} to {1} = [equals] {2}", id1, id2, node1.Equals(id2)); - Utils.LogInfo("\tComparing {0} to {1} = [ == ] {2}", id1, id2, node1 == id2); - - - - - 'define our 2 GUID ids, and then define our node to use the first id. - Dim id1 As Guid = Guid.NewGuid() - Dim id2 As Guid = Guid.NewGuid() - Dim node1 As NodeId = new NodeId(id1) - - 'now to compare the node to the guids - Utils.LogInfo("Comparing NodeId to GUID") - Utils.LogInfo( String.Format( " Comparing {0} to {0} = [equals] {2}", id1, id1, node1.Equals(id1)) ); - Utils.LogInfo( String.Format( " Comparing {0} to {0} = [ = ] {2}", id1, id1, node1 = id1) ); - Utils.LogInfo( String.Format( " Comparing {0} to {0} = [equals] {2}", id1, id2, node1.Equals(id2)) ); - Utils.LogInfo( String.Format( " Comparing {0} to {0} = [ = ] {2}", id1, id2, node1 = id2) ); - - - - This produces the following output (taken from C# example): -
    - - Comparing NodeId to GUID
    - Comparing bbe8b5f2-0f50-4302-877f-346afb07704c to bbe8b5f2-0f50-4302-877f-346afb07704c = [equals] True
    - Comparing bbe8b5f2-0f50-4302-877f-346afb07704c to bbe8b5f2-0f50-4302-877f-346afb07704c = [ = ] True
    - Comparing bbe8b5f2-0f50-4302-877f-346afb07704c to e707de86-4c11-4fe6-94b2-83638a9427e6 = [equals] False
    - Comparing bbe8b5f2-0f50-4302-877f-346afb07704c to e707de86-4c11-4fe6-94b2-83638a9427e6 = [ = ] False
    -
    -
    - The to compare this node to. -
    - - - Converts a byte array to an opaque node identifier. - - - This operator allows you to compare a NodeId to an array of Bytes. - - - - - //define our 2 Byte[] ids, and then define our node to use the first id. - byte[] id1 = new byte[] { 65, 66, 67, 68, 69 }; - byte[] id2 = new byte[] { 97, 98, 99, 100, 101 }; - NodeId node1 = new NodeId(id1); - - //convert our bytes to string so we can display them - string id1String = System.Text.ASCIIEncoding.ASCII.GetString(id1); - string id2String = System.Text.ASCIIEncoding.ASCII.GetString(id2); - - //now to compare the node to the guids - Utils.LogInfo("\n\nComparing NodeId to Byte[]"); - Utils.LogInfo("\tComparing {0} to {0} = [equals] {2}", id1String, id1String, node1.Equals(id1)); - Utils.LogInfo("\tComparing {0} to {0} = [ = ] {2}", id1String, id1String, node1 == id1); - Utils.LogInfo("\tComparing {0} to {1} = [equals] {2}", id1String, id2String, node1.Equals(id2)); - Utils.LogInfo("\tComparing {0} to {1} = [ = ] {2}", id1String, id2String, node1 == id2); - - - - - 'define our 2 Byte[] ids, and then define our node to use the first id. - Dim id1 As Byte() = New Byte() { 65, 66, 67, 68, 69 } - Dim id2 As Byte() = New Byte() { 97, 98, 99, 100, 101 } - Dim node1 As NodeId = New NodeId(id1) - - 'convert our bytes to string so we can display them - Dim id1String As String = System.Text.ASCIIEncoding.ASCII.GetString(id1) - Dim id2String As String = System.Text.ASCIIEncoding.ASCII.GetString(id2) - - 'now to compare the node to the guids - Utils.LogInfo("Comparing NodeId to Byte()") - Utils.LogInfo( String.Format("Comparing {0} to {0} = [equals] {2}", id1String, id1String, node1.Equals(id1)) ) - Utils.LogInfo( String.Format("Comparing {0} to {0} = [ = ] {2}", id1String, id1String, node1 = id1) ) - Utils.LogInfo( String.Format("Comparing {0} to {1} = [equals] {2}", id1String, id2String, node1.Equals(id2)) ) - Utils.LogInfo( String.Format("Comparing {0} to {1} = [ = ] {2}", id1String, id2String, node1 = id2) ) - - - - This produces the following output (taken from C# example): -
    - - Comparing NodeId to Byte[] - Comparing ABCDE to ABCDE = [equals] True - Comparing ABCDE to ABCDE = [ == ] True - Comparing ABCDE to abcde = [equals] False - Comparing ABCDE to abcde = [ == ] False -
    -
    - The [] array to compare this node to -
    - - - Parses a node id string and initializes a node id. - - - Compares a Node to a String - - - - - //define our 2 String ids, and then define our node to use the first id. - String id1 = "Hello", id2 = "World"; - NodeId node1 = new NodeId(id1); - - //now to compare the node to the guids - Utils.LogInfo("\n\nComparing NodeId to String"); - Utils.LogInfo("\tComparing {0} to {1} = [equals] {2}", id1, id1, node1.Equals(id1)); - Utils.LogInfo("\tComparing {0} to {1} = [ == ] {2}", id1, id1, node1 == id1); - Utils.LogInfo("\tComparing {0} to {1} = [equals] {2}", id1, id2, node1.Equals(id2)); - Utils.LogInfo("\tComparing {0} to {1} = [ == ] {2}", id1, id2, node1 == id2); - - - - - - 'define our 2 String ids, and then define our node to use the first id. - Dim id1 As String = "Hello" - Dim id2 As String = "World" - Dim node1 As NodeId = New NodeId(id1) - - 'now to compare the node to the guids - Utils.LogInfo("Comparing NodeId to String"); - Utils.LogInfo(String.Format("Comparing {0} to {1} = [equals] {2}", id1, id1, node1.Equals(id1))); - Utils.LogInfo(String.Format("Comparing {0} to {1} = [ = ] {2}", id1, id1, node1 = id1)); - Utils.LogInfo(String.Format("Comparing {0} to {1} = [equals] {2}", id1, id2, node1.Equals(id2))); - Utils.LogInfo(String.Format("Comparing {0} to {1} = [ = ] {2}", id1, id2, node1 = id2)); - - - - The to compare this node to. - - - - Checks if the node id represents a 'Null' node id. - - - Returns a true/false value to indicate if the specified NodeId is null. - - The NodeId to validate - - - - Checks if the node id represents a 'Null' node id. - - - Returns a true/false to indicate if the specified is null. - - The ExpandedNodeId to validate - - - - Parses a node id string and returns a node id object. - - - Parses a NodeId String and returns a NodeId object. - Valid NodeId strings are of the form: - "i=1234", "s=HelloWorld", "g=AF469096-F02A-4563-940B-603958363B81", "b=01020304", - "ns=2;s=HelloWorld", "ns=2;i=1234", "ns=2;g=AF469096-F02A-4563-940B-603958363B81", "ns=2;b=01020304" - Invalid NodeId strings will throw an exception, e.g. - "HelloWorld", "nsu=http://opcfoundation.org/UA/;i=1234" - - The NodeId value as a string. - Thrown under a variety of circumstances, each time with a specific message. - Thrown due to invalid text, each time with a specific message. - - - - Internal parse method. - - The NodeId value as string. - If the namespaceUri was already set. - - - - Returns an instance of a null NodeId. - - - - - Formats a node id as a string. - - - - Formats a NodeId as a string. -
    - - An example of this would be: -
    - - NodeId = "hello123"
    - NamespaceId = 1;
    -
    This would translate into:
    - ns=1;s=hello123 -
    -
    -
    - - - Formats the NodeId as a string and appends it to the buffer. - - - - - Formats the NodeId as a string and appends it to the buffer. - - - - - Returns the string representation of a NodeId. - - - Returns the Node represented as a String. This is the same as calling - . - - - - - Converts an node id to an expanded node id using a namespace table. - - - Returns an ExpandedNodeId based on the NodeId requested in the parameters. If the namespaceTable - is specified then the relevant namespace will be returned from the namespaceTable collection which is - also passed in as a parameter. - - null, if the nodeId parameter is null. Otherwise an ExpandedNodeId will be returned for the specified nodeId - The NodeId to return, wrapped in within the ExpandedNodeId. - The namespace tables collection that may be used to retrieve the namespace from that the specified NodeId belongs to - - - - Updates the namespace index. - - - - - Updates the identifier. - - - - - Updates the identifier. - - - - - Compares the current instance to the object. - - - Enables this object type to be compared to other types of object. - - - - - Returns true if a is greater than b. - - - Returns true if a is greater than b. - - - - - Returns true if a is less than b. - - - Returns true if a is less than b. - - - - - Returns the string representation of a NodeId. - - - Returns the string representation of a NodeId. This is the same as calling - . - - Thrown when the format is not null - - - - - - - Makes a deep copy of the object. - - - Returns a copy of this object. - - - - - Determines if the specified object is equal to the NodeId. - - - Returns a true/false if the specified NodeId is the same as this NodeId. - - The object (NodeId or ExpandedNodeId is desired) to compare to - - - - Determines if the specified NodeId is equal to the NodeId. - - - Returns a true/false if the specified NodeId is the same as this NodeId. - Null NodeIds are considered equal. - - The NodeId to compare to - - - - Returns a unique hashcode for the NodeId - - - Returns a unique hashcode for the NodeId - - - - - Returns true if the objects are equal. - - - Returns true if the objects are equal. - - - - - Returns true if the objects are not equal. - - - Returns true if the objects are not equal. - - - - - The node identifier formatted as a URI. - - - The node identifier formatted as a URI. - - - - - The index of the namespace URI in the server's namespace array. - - - The index of the namespace URI in the server's namespace array. - - - - - The type of node identifier used. - - - Returns the type of Id, whether it is: - - - - - [] - - - - - - - The node identifier. - - - Returns the Id in its native format, i.e. UInt, GUID, String etc. - - - - - Whether the object represents a Null NodeId. - - - Whether the NodeId represents a Null NodeId. - - - - - Compares two node identifiers. - - - - - Helper to determine if the identifier of specified type is greater/less. - - - - - - - Formats a node id as a string. - - - - - A collection of NodeIds. - - - Provides a strongly-typed collection of . - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - - Creates a new collection based on the referenced collection. - - The existing collection to use as the basis of creating this collection - - - - Initializes the collection with the specified capacity. - - - Creates a new collection while specifying the max size of the collection. - - The max. capacity of the collection - - - - Converts an array to a collection. - - - A quick-use method that will take an array of objects and will - return them within a . - - An array of to add to the collection - A containing the 's added via the parameters - - - - Converts an array to a collection. - - - Converts an array to a collection. - - An array of objects to compare - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - A dictionary designed to provide efficient lookups for objects identified by a NodeId - - - - - Creates an empty dictionary. - - - - - - - - - - - - - - - - - - - - - - - Gets or sets the value with the specified NodeId. - - - - - - - - - - - - - - - - - Checks that there is enough space in the array. - - - - - - - - - - - - - - - - - - - - Returns the dictionary set for the specified namespace. - - - - - Returns the dictionary set for String identifiers in the specified namespace. - - - - - Returns the dictionary set for Guid identifiers in the specified namespace. - - - - - Returns the dictionary set for Opaque identifiers in the specified namespace. - - - - - Stores the dictionaries for a single namespace index. - - - - - Wraps a byte array for use as a key in a dictionary. - - - - - Initializes the key with an array of bytes. - - - - - The array of bytes. - - - - - - - - - - - The enumerator for the node dictionary. - - - - - Constructs the enumerator for the specified dictionary. - - - - - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - - - - - - - - - - Releases and disposes the current enumerator. - - - - - Checks if the dictionary has changed. - - - - - A name qualified with a namespace. - - - - The QualifiedName is defined in Part 3 - Address Space Model, Section 7.3, titled - Qualified Name. -
    - - The QualifiedName is a simple wrapper class that is used to generate a fully-qualified name - for any type that has a name. -
    - - A Fully Qualified name is one that consists of a name, and an index of which namespace - (within a namespace table) this name belongs to. - For example
    - Namespace Index = 1
    - Name = MyName
    - becomes:
    - 1:MyName -
    -
    -
    - - - Initializes the object with default values. - - - Initializes the object with default values. - - - - - Creates a deep copy of the value. - - - Creates a deep copy of the value. - - The qualified name to copy - Thrown if the provided value is null - - - - Initializes the object with a name. - - - Initializes the object with a name. - - The name-portion to store as part of the fully qualified name - - - - Initializes the object with a name and a namespace index. - - - Initializes the object with a name and a namespace index. - - The name-portion of the fully qualified name - The index of the namespace within the namespace-table - - - - The index of the namespace that qualifies the name. - - - The index of the namespace that qualifies the name. - - - - - - - - The unqualified name. - - - The unqualified name. - - - - - - - - - - Compares two QualifiedNames. - - The object to compare to. - - Less than zero if the instance is less than the object. - Zero if the instance is equal to the object. - Greater than zero if the instance is greater than the object. - - - - - Implements the operator >. - - The value1. - The value2. - The result of the operator. - - - - Implements the operator <. - - The value1. - The value2. - The result of the operator. - - - - Returns a suitable hash value for the instance. - - - - - Returns true if the objects are equal. - - - Returns true if the objects are equal. - - The object to compare to this/me - - - - Returns true if the objects are equal. - - - Returns true if the objects are equal. - - The first value to compare - The second value to compare - - - - Returns true if the objects are not equal. - - - Returns true if the objects are equal. - - The first value to compare - The second value to compare - - - - Returns the string representation of the object. - - - Returns the string representation of the object. - - - - - Returns the string representation of the object. - - - Returns the string representation of the object. - - (Unused) Always pass null - (Unused) Always pass null - Thrown if non-null parameters are passed - - - - - - - Makes a deep copy of the object. - - - Makes a deep copy of the object. - - - - - Converts an expanded node id to a node id using a namespace table. - - - - - Returns true if the QualifiedName is valid. - - The name to be validated. - The table namespaces known to the server. - True if the name is value. - - - - Parses a string containing a QualifiedName with the syntax n:qname - - The QualifiedName value as a string. - Thrown under a variety of circumstances, each time with a specific message. - - - - Returns true if the value is null. - - The qualified name to check - - - - Converts a string to a qualified name. - - - Converts a string to a qualified name. - - The string to turn into a fully qualified name - - - - Converts a string to a qualified name. - - - Converts a string to a qualified name. - - The string to turn into a fully qualified name - - - - Returns an instance of a null QualifiedName. - - - - - A collection of QualifiedName objects. - - - A strongly-typed collection of QualifiedName objects. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - The enumerated collection of qualified names to add to this new collection - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - Max capacity of this collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - The array to turn into a collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - The array to turn into a collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - A session-less service message. - - - - - The VersionTime of the namespaces URIs on the server. - - - - - The namespaces URIs referenced by the message. - - - - - The server URIs referenced by the message. - - - - - The locale Ids referenced by the message. - - - - - The message to encode or the decoded message. - - - - - - - - - - - A numeric code that describes the result of a service or operation. - - - - The StatusCode is defined in OPC UA Specifications Part 4: Services, section 7.22 - titled StatusCode.
    -
    - - A numeric code that is used to describe the result of a service or operation. The - StatusCode uses bit-assignments, which are described below. -
    - - The StatusCode is a 32-bit number, with the top 16-bits (high word) representing the - numeric value of an error or condition, whereas the bottom 16-bits (low word) represents - additional flags to provide more information on the meaning of the status code. -
    - - The following list shows the bit-assignments, i.e. 0-7 means bit 0 to bit 7. - - 0 - 7:
    - InfoBits. Additional information bits that qualify the status code.
    - 8 - 9:
    - The type of information contained in the info bits. These bits have the following meanings:
    - - Binary Representation 00:
    - The info bits are not used and must be set to zero.
    - Binary Representation 01:
    - The status code and its info bits are associated with a data value returned from the Server.
    - Binary Representation 10 or 11:
    - Reserved for future use. The info bits must be ignored.
    -
    -
    - 10 - 13:
    - Reserved for future use. Must always be zero.
    - 14: - Indicates that the semantics of the associated data value have changed. Clients should not process the data value until they re-read the metadata associated with the Variable. - Servers should set this bit if the metadata has changed in way that could case application errors if the Client does not re-read the metadata. For example, a change to the engineering units could create problems if the Client uses the value to perform calculations. - [UA Part 8] defines the conditions where a Server must set this bit for a DA Variable. Other specifications may define additional conditions. A Server may define other conditions that cause this bit to be set. - This bit only has meaning for status codes returned as part of a data change Notification. Status codes used in other contexts must always set this bit to zero. - 15:
    - Indicates that the structure of the associated data value has changed since the last Notification. Clients should not process the data value unless they re-read the metadata. - Servers must set this bit if the DataTypeEncoding used for a Variable changes. Clause 7.14 describes how the DataTypeEncoding is specified for a Variable. - The bit is also set if the data type Attribute of the Variable changes. A Variable with data type BaseDataType does not require the bit to be set when the data type changes. - Servers must also set this bit if the length of a fixed length array Variable changes. - This bit is provided to warn Clients that parse complex data values that their parsing routines could fail because the serialized form of the data value has changed. - This bit only has meaning for status codes returned as part of a data change Notification. Status codes used in other contexts must always set this bit to zero.
    - 16 - 27:
    - The code is a numeric value assigned to represent different conditions. - Each code has a symbolic name and a numeric value. All descriptions in the UA specification refer - to the symbolic name. [UA Part 6] maps the symbolic names onto a numeric value.
    - 28 - 29:
    - Reserved for future use. Must always be zero.
    - 30 - 31:
    - Indicates whether the status code represents a good, bad or uncertain condition. - These bits have the following meanings:
    - - Binary Represntation 00:
    - Indicates that the operation was successful and the associated results may be used.
    - Binary Represntation 01:
    - Indicates that the operation was partially successful and that associated results may not be suitable for some purposes.
    - Binary Represntation 10:
    - Indicates that the operation failed and any associated results cannot be used.
    - Binary Represntation 11:
    - Reserved for future use. All Clients should treat a status code with this severity as �Bad�.
    -
    -
    -
    -
    -
    -
    - - - Initializes the object with a numeric value. - - - Initializes the object with a numeric value. - - The numeric code to apply to this status code - - - - Initializes the object from an exception. - - - Initializes the object from an exception and a numeric code. The numeric code - will be determined from the Exception if possible, otherwise the value passed in - will be used. - - The default code to apply if the routine cannot determine the code from the Exception - The exception to convert to a status code - - - - The entire 32-bit status value. - - - The entire 32-bit status value. - - - - - The 16 code bits of the status code. - - - The 16 code bits of the status code. - - - - - Returns a copy of the status code with the Code bits set. - - The value for the Code bits. - The status code with the Code bits set to the specified values. - - - - The 16 flag bits of the status code. - - - The 16 flag bits of the status code. - - - - - Returns a copy of the status code with the Flag bits set. - - The value for the Flag bits. - The status code with the Flag bits set to the specified values. - - - - The sub-code portion of the status code. - - - The sub-code portion of the status code. - - - - - Set to indicate that the structure of the data value has changed. - - - Set to indicate that the structure of the data value has changed. - - - - - Returns a copy of the status code with the StructureChanged bit set. - - The value for the StructureChanged bit. - The status code with the StructureChanged bit set to the specified value. - - - - Set to indicate that the semantics associated with the data value have changed. - - - Set to indicate that the semantics associated with the data value have changed. - - - - - Returns a copy of the status code with the SemanticsChanged bit set. - - The value for the SemanticsChanged bit. - The status code with the SemanticsChanged bit set to the specified value. - - - - The bits that indicate the meaning of the status code - - - The bits that indicate the meaning of the status code - - - - - The limit bits, indicating Hi/Lo etc. - - - The limit bits, indicating Hi/Lo etc. - - - - - - Returns a copy of the status code with the llimit bits set. - - The value for the limits bits - The status code with the limit bits set to the specified values. - - - - The overflow bit. - - - Specifies if there is an overflow or not - - - - - Returns a copy of the status code with the overflow bit set. - - The value for the overflow bit. - The status code with the overflow bit set to the specified value. - - - - The historian bits. - - - The historian bits. - - - - - - Returns a copy of the status code with the aggregate bits set. - - The bits to set. - The status code with the aggregate bits set to the specified values. - - - - Compares the instance to another object. - - - Compares the instance to another object. - - The object to compare to *this* object - - - - Compares the instance to another object. - - - Compares the instance to another object. - - The StatusCode to compare to *this* object - - - - Returns the string representation of the object. - - - Returns the string representation of the object. - - (Unused) The format of the string. Always specify null for this parameter - The provider to use for the formatting - Thrown if you specify a value for the Format parameter - - - - Determines if the specified object is equal to the object. - - - Determines if the specified object is equal to the object. - - The object to compare to *this* object - - - - Determines if the specified object is equal to the object. - - - Determines if the specified object is equal to the object. - - The StatusCode to compare to *this* object - - - - Returns a unique hashcode for the object. - - - Returns a unique hashcode for the object. - - - - - Converts the value to a human readable string. - - - Converts the value to a human readable string. - - - - - Converts a 32-bit code a StatusCode object. - - - Converts a 32-bit code a StatusCode object. - - The code to convert to a StatusCode - - - - Converts a StatusCode object to a 32-bit code. - - - Converts a StatusCode object to a 32-bit code. - - The StatusCode to convert to a 32-but number - - - - Looks up the symbolic name for a status code. - - - Looks up the symbolic name for a status code. - - The numeric error-code to convert to a textual description - - - - Returns true if the objects are not equal. - - - Returns true if the objects are not equal. - - The first object being compared - The second object being compared to - - - - Returns true if the objects are not equal. - - - Returns true if the objects are not equal. - - The first object being compared - The second object being compared to - - - - Returns true if the objects are not equal. - - - Returns true if the objects are not equal. - - The first object being compared - The second object being compared to - - - - Returns true if the objects are not equal. - - - Returns true if the objects are not equal. - - The first value being compared - The second value being compared to - - - - Returns true if the object a is less than object b. - - - Returns true if the object a is less than object b. - - The first value being compared - The second value being compared to - - - - Returns true if the object a is greater than object b. - - - Returns true if the object a is greater than object b. - - The first value being compared - The second value being compared to - - - - Returns true if the status code is good. - - - Returns true if the status code is good. - - The code to check - - - - Returns true if the status is bad or uncertain. - - - Returns true if the status is bad or uncertain. - - The code to check - - - - Returns true if the status code is uncertain. - - - Returns true if the status code is uncertain. - - The code to check - - - - Returns true if the status is good or uncertain. - - - Returns true if the status is good or uncertain. - - The code to check - - - - Returns true if the status code is bad. - - - Returns true if the status code is bad. - - The code to check - - - - Returns true if the status is good or uncertain. - - - Returns true if the status is good or uncertain. - - The code to check - - - - Flags that are set to indicate the limit status of the value. - - - - - The value is free to change. - - - - - The value is at the lower limit for the data source. - - - - - The value is at the higher limit for the data source. - - - - - The value is constant and cannot change. - - - - - Flags that are set by the historian when returning archived values. - - - - - A raw data value. - - - - - A raw data value. - - - - - A data value which was interpolated. - - - - - A mask that selects the bit which identify the source of the value (raw, calculated, interpolated). - - - - - A data value which was calculated with an incomplete interval. - - - - - A raw data value that hides other data at the same timestamp. - - - - - Multiple values match the aggregate criteria (i.e. multiple minimum values at different timestamps within the same interval) - - - - - A collection of StatusCodes. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - The collection to copy - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - The maximum capacity allowed for this instance of the collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - The array of values to return as a Collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - The array of values to return as a Collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - Defines standard status codes. - - - Defines standard status codes. - - - A class that defines constants used by UA applications. - - - A class that defines constants used by UA applications. - - - - - - The operation completed successfully. - - - - - The operation completed however its outputs may not be usable. - - - - - The operation failed. - - - - - Returns the browse name for the attribute. - - - - - Returns the browse names for all attributes. - - - - - Returns the id for the attribute with the specified browse name. - - - - - An unexpected error occurred. - - - - - An internal error occurred as a result of a programming or configuration error. - - - - - Not enough memory to complete the operation. - - - - - An operating system resource is not available. - - - - - A low level communication error occurred. - - - - - Encoding halted because of invalid data in the objects being serialized. - - - - - Decoding halted because of invalid data in the stream. - - - - - The message encoding/decoding limits imposed by the stack have been exceeded. - - - - - The request message size exceeds limits set by the server. - - - - - The response message size exceeds limits set by the client. - - - - - An unrecognized response was received from the server. - - - - - The operation timed out. - - - - - The server does not support the requested service. - - - - - The operation was cancelled because the application is shutting down. - - - - - The operation could not complete because the client is not connected to the server. - - - - - The server has stopped and cannot process any requests. - - - - - No processing could be done because there was nothing to do. - - - - - The request could not be processed because it specified too many operations. - - - - - The request could not be processed because there are too many monitored items in the subscription. - - - - - The extension object cannot be (de)serialized because the data type id is not recognized. - - - - - The certificate provided as a parameter is not valid. - - - - - An error occurred verifying security. - - - - - The certificate does not meet the requirements of the security policy. - - - - - The certificate has expired or is not yet valid. - - - - - An issuer certificate has expired or is not yet valid. - - - - - The HostName used to connect to a server does not match a HostName in the certificate. - - - - - The URI specified in the ApplicationDescription does not match the URI in the certificate. - - - - - The certificate may not be used for the requested operation. - - - - - The issuer certificate may not be used for the requested operation. - - - - - The certificate is not trusted. - - - - - It was not possible to determine if the certificate has been revoked. - - - - - It was not possible to determine if the issuer certificate has been revoked. - - - - - The certificate has been revoked. - - - - - The issuer certificate has been revoked. - - - - - The certificate chain is incomplete. - - - - - User does not have permission to perform the requested operation. - - - - - The user identity token is not valid. - - - - - The user identity token is valid but the server has rejected it. - - - - - The specified secure channel is no longer valid. - - - - - The timestamp is outside the range allowed by the server. - - - - - The nonce does appear to be not a random value or it is not the correct length. - - - - - The session id is not valid. - - - - - The session was closed by the client. - - - - - The session cannot be used because ActivateSession has not been called. - - - - - The subscription id is not valid. - - - - - The header for the request is missing or invalid. - - - - - The timestamps to return parameter is invalid. - - - - - The request was cancelled by the client. - - - - - Too many arguments were provided. - - - - - The server requires a license to operate in general or to perform a service or operation, but existing license is expired. - - - - - The server has limits on number of allowed operations / objects, based on installed licenses, and these limits where exceeded. - - - - - The server does not have a license which is required to operate in general or to perform a service or operation. - - - - - The Server does not have the resources to process the request at this time. - - - - - The log-on for the user succeeded but the user is required to change the password. - - - - - The subscription was transferred to another session. - - - - - The processing will complete asynchronously. - - - - - Sampling has slowed down due to resource limitations. - - - - - The value written was accepted but was clamped. - - - - - Communication with the data source is defined, but not established, and there is no last known value available. - - - - - Waiting for the server to obtain values from the underlying data source. - - - - - The syntax the node id is not valid or refers to a node that is not valid for the operation. - - - - - The node id refers to a node that does not exist in the server address space. - - - - - The attribute is not supported for the specified Node. - - - - - The syntax of the index range parameter is invalid. - - - - - No data exists within the range of indexes specified. - - - - - The written data does not match the IndexRange specified. - - - - - The data encoding is invalid. - - - - - The server does not support the requested data encoding for the node. - - - - - The access level does not allow reading or subscribing to the Node. - - - - - The access level does not allow writing to the Node. - - - - - The value was out of range. - - - - - The requested operation is not supported. - - - - - A requested item was not found or a search operation ended without success. - - - - - The object cannot be used because it has been deleted. - - - - - Requested operation is not implemented. - - - - - The monitoring mode is invalid. - - - - - The monitoring item id does not refer to a valid monitored item. - - - - - The monitored item filter parameter is not valid. - - - - - The server does not support the requested monitored item filter. - - - - - A monitoring filter cannot be used in combination with the attribute specified. - - - - - A mandatory structured parameter was missing or null. - - - - - The event filter is not valid. - - - - - The content filter is not valid. - - - - - An unrecognized operator was provided in a filter. - - - - - A valid operator was provided, but the server does not provide support for this filter operator. - - - - - The number of operands provided for the filter operator was less then expected for the operand provided. - - - - - The operand used in a content filter is not valid. - - - - - The referenced element is not a valid element in the content filter. - - - - - The referenced literal is not a valid value. - - - - - The continuation point provide is longer valid. - - - - - The operation could not be processed because all continuation points have been allocated. - - - - - The reference type id does not refer to a valid reference type node. - - - - - The browse direction is not valid. - - - - - The node is not part of the view. - - - - - The number was not accepted because of a numeric overflow. - - - - - The locale in the requested write operation is not supported. - - - - - The ServerUri is not a valid URI. - - - - - No ServerName was specified. - - - - - No DiscoveryUrl was specified. - - - - - The semaphore file specified by the client is not valid. - - - - - The security token request type is not valid. - - - - - The security mode does not meet the requirements set by the server. - - - - - The security policy does not meet the requirements set by the server. - - - - - The server has reached its maximum number of sessions. - - - - - The user token signature is missing or invalid. - - - - - The signature generated with the client certificate is missing or invalid. - - - - - The client did not provide at least one software certificate that is valid and meets the profile requirements for the server. - - - - - The server does not support changing the user identity assigned to the session. - - - - - The request was cancelled by the client with the Cancel service. - - - - - The parent node id does not to refer to a valid node. - - - - - The reference could not be created because it violates constraints imposed by the data model. - - - - - The requested node id was reject because it was either invalid or server does not allow node ids to be specified by the client. - - - - - The requested node id is already used by another node. - - - - - The node class is not valid. - - - - - The browse name is invalid. - - - - - The browse name is not unique among nodes that share the same relationship with the parent. - - - - - The node attributes are not valid for the node class. - - - - - The type definition node id does not reference an appropriate type node. - - - - - The source node id does not reference a valid node. - - - - - The target node id does not reference a valid node. - - - - - The reference type between the nodes is already defined. - - - - - The server does not allow this type of self reference on this node. - - - - - The reference type is not valid for a reference to a remote server. - - - - - The server will not allow the node to be deleted. - - - - - The server was not able to delete all target references. - - - - - The server index is not valid. - - - - - The view id does not refer to a valid view node. - - - - - The view timestamp is not available or not supported. - - - - - The view parameters are not consistent with each other. - - - - - The view version is not available or not supported. - - - - - The list of references may not be complete because the underlying system is not available. - - - - - The server should have followed a reference to a node in a remote server but did not. The result set may be incomplete. - - - - - The provided Nodeid was not a type definition nodeid. - - - - - One of the references to follow in the relative path references to a node in the address space in another server. - - - - - The requested operation has too many matches to return. - - - - - The requested operation requires too many resources in the server. - - - - - The requested operation has no match to return. - - - - - The max age parameter is invalid. - - - - - The operation is not permitted over the current secure channel. - - - - - The history details parameter is not valid. - - - - - The server does not support the requested operation. - - - - - The defined timestamp to return was invalid. - - - - - The server does not support writing the combination of value, status and timestamps provided. - - - - - The value supplied for the attribute is not of the same type as the attribute's value. - - - - - The method id does not refer to a method for the specified object. - - - - - The client did not specify all of the input arguments for the method. - - - - - The executable attribute does not allow the execution of the method. - - - - - The server has reached its maximum number of subscriptions. - - - - - The server has reached the maximum number of queued publish requests. - - - - - There is no subscription available for this session. - - - - - The sequence number is unknown to the server. - - - - - The Server does not support retransmission queue and acknowledgement of sequence numbers is not available. - - - - - The requested notification message is no longer available. - - - - - The client of the current session does not support one or more Profiles that are necessary for the subscription. - - - - - The sub-state machine is not currently active. - - - - - An equivalent rule already exists. - - - - - The server cannot process the request because it is too busy. - - - - - The type of the message specified in the header invalid. - - - - - The SecureChannelId and/or TokenId are not currently in use. - - - - - The size of the message chunk specified in the header is too large. - - - - - There are not enough resources to process the request. - - - - - An internal error occurred. - - - - - The server does not recognize the QueryString specified. - - - - - The request could not be sent because of a network interruption. - - - - - Timeout occurred while processing the request. - - - - - The secure channel has been closed. - - - - - The token has expired or is not recognized. - - - - - The sequence number is not valid. - - - - - The applications do not have compatible protocol versions. - - - - - There is a problem with the configuration that affects the usefulness of the value. - - - - - The variable should receive its value from another variable, but has never been configured to do so. - - - - - There has been a failure in the device/data source that generates the value that has affected the value. - - - - - There has been a failure in the sensor from which the value is derived by the device/data source. - - - - - The source of the data is not operational. - - - - - The deadband filter is not valid. - - - - - Communication to the data source has failed. The variable value is the last value that had a good quality. - - - - - Whatever was updating this value has stopped doing so. - - - - - The value is an operational value that was manually overwritten. - - - - - The value is an initial value for a variable that normally receives its value from another variable. - - - - - The value is at one of the sensor limits. - - - - - The value is outside of the range of values defined for this parameter. - - - - - The data value is derived from multiple sources and has less than the required number of Good sources. - - - - - The value has been overridden. - - - - - The value is derived from multiple sources and has the required number of Good sources, but less than the full number of Good sources. - - - - - This Condition refresh failed, a Condition refresh operation is already in progress. - - - - - This condition has already been disabled. - - - - - This condition has already been enabled. - - - - - Property not available, this condition is disabled. - - - - - The specified event id is not recognized. - - - - - The event cannot be acknowledged. - - - - - The dialog condition is not active. - - - - - The response is not valid for the dialog. - - - - - The condition branch has already been acknowledged. - - - - - The condition branch has already been confirmed. - - - - - The condition has already been shelved. - - - - - The condition is not currently shelved. - - - - - The shelving time not within an acceptable range. - - - - - No data exists for the requested time range or event filter. - - - - - No data found to provide upper or lower bound value. - - - - - The server cannot retrieve a bound for the variable. - - - - - Data is missing due to collection started/stopped/lost. - - - - - Expected data is unavailable for the requested time range due to an un-mounted volume, an off-line archive or tape, or similar reason for temporary unavailability. - - - - - The data or event was not successfully inserted because a matching entry exists. - - - - - The data or event was not successfully updated because no matching entry exists. - - - - - The Client requested history using a TimestampsToReturn the Server does not support. - - - - - The data or event was successfully inserted into the historical database. - - - - - The data or event field was successfully replaced in the historical database. - - - - - The aggregate value is derived from multiple values and has less than the required number of Good values. - - - - - No data exists for the requested time range or event filter. - - - - - More data is available in the time range beyond the number of values requested. - - - - - The requested number of Aggregates does not match the requested number of NodeIds. - - - - - The requested Aggregate is not support by the server. - - - - - The aggregate value could not be derived due to invalid data inputs. - - - - - The aggregate configuration is not valid for specified node. - - - - - The request specifies fields which are not valid for the EventType or cannot be saved by the historian. - - - - - The request was rejected by the server because it did not meet the criteria set by the server. - - - - - The request has not been processed by the server yet. - - - - - The operation is not allowed because a transaction is in progress. - - - - - The device identity needs a ticket before it can be accepted. - - - - - The device identity needs a ticket before it can be accepted. - - - - - The requested operation is not allowed, because the Node is locked by a different application. - - - - - The requested operation is not allowed, because the Node is not locked by the application. - - - - - The value does not come from the real source and has been edited by the server. - - - - - There was an error in execution of these post-actions. - - - - - The related EngineeringUnit has been changed but the Variable Value is still provided based on the previous unit. - - - - - A dependent value has been changed but the change has not been applied to the device. - - - - - The related EngineeringUnit has been changed but this change has not been applied to the device. The Variable Value is still dependent on the previous unit but its status is currently Bad. - - - - - A dependent value has been changed but the change has not been applied to the device. The quality of the dominant variable is uncertain. - - - - - A dependent value has been changed but the change has not been applied to the device. The quality of the dominant variable is Bad. - - - - - It is delivered with a dominant Variable value when a dependent Variable has changed but the change has not been applied. - - - - - It is delivered with a dependent Variable value when a dominant Variable has changed but the change has not been applied. - - - - - It is delivered with a dependent Variable value when a dominant or dependent Variable has changed but change has not been applied. - - - - - It is delivered with a Variable value when Variable has changed but the value is not legal. - - - - - It is delivered with a Variable value when a source Variable has changed but the value is not legal. - - - - - It is delivered with a dependent Variable value when a dominant Variable has changed and the value is not legal. - - - - - It is delivered with a dependent Variable value when a dominant Variable has changed, the value is not legal and the change has not been applied. - - - - - It is delivered with a dependent Variable value when a dominant or dependent Variable has changed and the value is not legal. - - - - - It is delivered with a dependent Variable value when a dominant or dependent Variable has changed, the value is not legal and the change has not been applied. - - - - - The communication layer has raised an event. - - - - - The system is shutting down. - - - - - The operation is not finished and needs to be called again. - - - - - A non-critical timeout occurred. - - - - - One or more arguments are invalid. - - - - - Could not establish a network connection to remote server. - - - - - The server has disconnected from the client. - - - - - The network connection has been closed. - - - - - The operation cannot be completed because the object is closed, uninitialized or in some other invalid state. - - - - - Cannot move beyond end of the stream. - - - - - No data is currently available for reading from a non-blocking stream. - - - - - The asynchronous operation is waiting for a response. - - - - - The asynchronous operation was abandoned by the caller. - - - - - The stream did not return all data requested (possibly because it is a non-blocking stream). - - - - - Non blocking behaviour is required and the operation would block. - - - - - A value had an invalid syntax. - - - - - The operation could not be finished because all available connections are in use. - - - - - The value may not be accurate because the transducer is in manual mode. - - - - - The value is simulated. - - - - - The value may not be accurate due to a sensor calibration fault. - - - - - The value may not be accurate due to a configuration issue. - - - - - The value source supports cascade handshaking and the value has been Initialized based on an initialization request from a cascade secondary. - - - - - The value source supports cascade handshaking and is requesting initialization of a cascade primary. - - - - - The value source supports cascade handshaking, however, the source’s current state does not allow for cascade. - - - - - The value source supports cascade handshaking, however, the source has not selected the corresponding cascade primary for use. - - - - - There is a fault state condition active in the value source. - - - - - A fault state condition is being requested of the destination. - - - - - The value is accurate, and the signal source supports cascade handshaking. - - - - - The DataSet specified for the DataSetWriter creation is invalid. - - - - - A wrapper for a GUID used during object serialization. - - - This class provides a wrapper around the object, allowing it to be serialized - and encoded/decoded to/from an underlying stream. - x - - - - Initializes the object with a string. - - - Initializes the object with a string. The string will be used to create a . - - The string that will be turned into a Guid - - - - Initializes the object with a Guid. - - - Initializes the object with a Guid. - - The Guid to wrap - - - - A constant containing an empty GUID. - - - A constant containing an empty GUID. - - - - - The GUID serialized as a string. - - - The GUID serialized as a string. - - - - - Converts Uuid to a Guid structure. - - - Converts Uuid to a Guid structure. - - The Guid to convert to a Uuid - - - - Converts Guid to a Uuid. - - - Converts Guid to a Uuid. - - The to convert to a - - - - Returns true if the objects are equal. - - - Returns true if the objects are equal. - - The first object to compare - The second object to compare - - - - Returns true if the objects are not equal. - - - Returns true if the objects are not equal. - - The first object to compare - The second object being compared to - - - - Returns true if the objects are not equal. - - - Returns true if the objects are not equal. - - The first object being compared - The second object being compared to - - - - Returns true if the objects are not equal. - - - Returns true if the objects are not equal. - - The first object being compared - The second object being compared to - - - - Returns true if the object a is less than object b. - - - Returns true if the object a is less than object b. - - The first object being compared - The second object being compared to - - - - Returns true if the object a is greater than object b. - - - Returns true if the object a is greater than object b. - - The first object being compared - The second object being compared to - - - - Returns true if the objects are equal. - - - Returns true if the objects are equal. - - The object being compared to *this* object - - - - Returns a hash code for the object. - - - Returns a unique hash code for the object. - - - - - Converts the object to a string. - - - Converts the object to a string. - - - - - Compares the current instance to the object. - - - Compares the current instance to the object. This function will check if the object - passed in is a or . - - The object being compared to *this* object - - - - Returns the string representation of the object. - - - Returns the string representation of the object. - - The format you want to apply to the string - The FormatProvider - - - - A collection of Uuids. - - - - - Initializes an empty collection. - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - - Initializes the collection from another collection. - - The collection to copy - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - The maximum size of the colletion - - - - Converts an array to a collection. - - - Converts an array to a collection. - - The array of values to return as a Collection - - - - Converts an array to a collection. - - - Converts an array to a collection. - - The array of values to return as a collection - - - - - - - Creates a deep copy of the collection. - - - Returns a new instance of the collection, copying the contents of this collection - - - - - A structure that could contain value with any of the UA built-in data types. - - - - The Variant is described in Part 6 - Mappings, Section 6.2.2.15, titled Variant -
    - - Variant is a data type in COM, but not within the .NET Framework. Therefore OPC UA has its own - Variant type that supports all of the OPC UA data-types. -
    -
    -
    - - - Creates a deep copy of the value. - - - Creates a new Variant instance, while deep-copying the contents of the specified Variant - - The Variant value to copy. - - - - Constructs a Variant - - The value to store. - The type information for the value. - - - - Initializes the object with an object value. - - - Creates a new variant instance while specifying the value. - - The value to encode within the variant - - - - Initializes the variant with matrix. - - The value to store within the variant - - - - Initializes the object with a bool value. - - - Creates a new Variant with a Boolean value. - - The value of the variant - - - - Initializes the object with a sbyte value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a byte value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a short value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a ushort value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with an int value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a uint value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a long value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a ulong value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a float value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a double value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a string value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a DateTime value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a Guid value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a Uuid value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a byte[] value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a XmlElement value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a NodeId value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a ExpandedNodeId value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a StatusCode value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a QualifiedName value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a LocalizedText value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a ExtensionObject value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a DataValue value. - - - Creates a new variant with a value - - The value of the Variant - - - - Initializes the object with a bool array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a sbyte array value. - - - Creates a new variant with a -arrat value - - The -array value of the Variant - - - - Initializes the object with a short array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a ushort array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with an int array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a uint array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a long array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a ulong array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a float array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a double array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a string array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a DateTime array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a Guid array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a Uuid array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a byte[] array value. - - - Creates a new variant with a 2-d -array value - - The 2-d -array value of the Variant - - - - Initializes the object with a XmlElement array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a NodeId array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a ExpandedNodeId array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a StatusCode array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a QualifiedName array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a LocalizedText array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a ExtensionObject array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a DataValue array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a Variant array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - Initializes the object with a object array value. - - - Creates a new variant with a -array value - - The -array value of the Variant - - - - The value stored in the object. - - - The value stored within the Variant object. - - - - - The value stored in the object. - - - The value stored -as - within the Variant object. - - - - - The type information for the matrix. - - - - - Returns the string representation of the object. - - - Returns the string representation of the object. - - Thrown when the 'format' argument is NOT null. - (Unused) Always pass a NULL value - The format-provider to use. If unsure, pass an empty string or null - - - - Append a ByteString as a hex string. - - - - - Formats a value as a string. - - - - - - - - Makes a deep copy of the object. - - - Makes a deep copy of the object. - - - - - Returns true if the objects are not equal. - - - Returns true if the objects are not equal. - - - - - Returns true if the objects are not equal. - - - Returns true if the objects are not equal. - - - - - Converts a bool value to an Variant object. - - - Converts a bool value to an Variant object. - - - - - Converts a sbyte value to an Variant object. - - - Converts a sbyte value to an Variant object. - - - - - Converts a byte value to an Variant object. - - - Converts a byte value to an Variant object. - - - - - Converts a short value to an Variant object. - - - Converts a short value to an Variant object. - - - - - Converts a ushort value to an Variant object. - - - Converts a ushort value to an Variant object. - - - - - Converts a int value to an Variant object. - - - Converts a int value to an Variant object. - - - - - Converts a uint value to an Variant object. - - - Converts a uint value to an Variant object. - - - - - Converts a long value to an Variant object. - - - Converts a long value to an Variant object. - - - - - Converts a ulong value to an Variant object. - - - Converts a ulong value to an Variant object. - - - - - Converts a float value to an Variant object. - - - Converts a float value to an Variant object. - - - - - Converts a double value to an Variant object. - - - Converts a double value to an Variant object. - - - - - Converts a string value to an Variant object. - - - Converts a string value to an Variant object. - - - - - Converts a DateTime value to an Variant object. - - - Converts a DateTime value to an Variant object. - - - - - Converts a Guid value to an Variant object. - - - Converts a Guid value to an Variant object. - - - - - Converts a Uuid value to an Variant object. - - - Converts a Uuid value to an Variant object. - - - - - Converts a byte[] value to an Variant object. - - - Converts a byte[] value to an Variant object. - - - - - Converts a XmlElement value to an Variant object. - - - Converts a XmlElement value to an Variant object. - - - - - Converts a NodeId value to an Variant object. - - - Converts a NodeId value to an Variant object. - - - - - Converts a ExpandedNodeId value to an Variant object. - - - Converts a ExpandedNodeId value to an Variant object. - - - - - Converts a StatusCode value to an Variant object. - - - Converts a StatusCode value to an Variant object. - - - - - Converts a QualifiedName value to an Variant object. - - - Converts a QualifiedName value to an Variant object. - - - - - Converts a LocalizedText value to an Variant object. - - - Converts a LocalizedText value to an Variant object. - - - - - Converts a ExtensionObject value to an Variant object. - - - Converts a ExtensionObject value to an Variant object. - - - - - Converts a DataValue value to an Variant object. - - - Converts a DataValue value to an Variant object. - - - - - Converts a bool[] value to an Variant object. - - - Converts a bool[] value to an Variant object. - - - - - Converts a sbyte[] value to an Variant object. - - - Converts a sbyte[] value to an Variant object. - - - - - Converts a short[] value to an Variant object. - - - Converts a short[] value to an Variant object. - - - - - Converts a ushort[] value to an Variant object. - - - Converts a ushort[] value to an Variant object. - - - - - Converts a int[] value to an Variant object. - - - Converts a int[] value to an Variant object. - - - - - Converts a uint[] value to an Variant object. - - - Converts a uint[] value to an Variant object. - - - - - Converts a long[] value to an Variant object. - - - Converts a long[] value to an Variant object. - - - - - Converts a ulong[] value to an Variant object. - - - Converts a ulong[] value to an Variant object. - - - - - Converts a float[] value to an Variant object. - - - Converts a float[] value to an Variant object. - - - - - Converts a double[] value to an Variant object. - - - Converts a double[] value to an Variant object. - - - - - Converts a string []value to an Variant object. - - - Converts a string []value to an Variant object. - - - - - Converts a DateTime[] value to an Variant object. - - - Converts a DateTime[] value to an Variant object. - - - - - Converts a Guid[] value to an Variant object. - - - Converts a Guid[] value to an Variant object. - - - - - Converts a Uuid[] value to an Variant object. - - - Converts a Uuid[] value to an Variant object. - - - - - Converts a byte[][] value to an Variant object. - - - Converts a byte[][] value to an Variant object. - - - - - Converts a XmlElement[] value to an Variant object. - - - Converts a XmlElement[] value to an Variant object. - - - - - Converts a NodeId[] value to an Variant object. - - - Converts a NodeId[] value to an Variant object. - - - - - Converts a ExpandedNodeId[] value to an Variant object. - - - Converts a ExpandedNodeId[] value to an Variant object. - - - - - Converts a StatusCode[] value to an Variant object. - - - Converts a StatusCode[] value to an Variant object. - - - - - Converts a QualifiedName[] value to an Variant object. - - - Converts a QualifiedName[] value to an Variant object. - - - - - Converts a LocalizedText[] value to an Variant object. - - - Converts a LocalizedText[] value to an Variant object. - - - - - Converts a ExtensionObject[] value to an Variant object. - - - Converts a ExtensionObject[] value to an Variant object. - - - - - Converts a DataValue[] value to an Variant object. - - - Converts a DataValue[] value to an Variant object. - - - - - Converts a Variant[] value to an Variant object. - - - Converts a Variant[] value to an Variant object. - - - - - Converts a object[] value to an Variant object. - - - Converts a object[] value to an Variant object. - - - - - Determines if the specified object is equal to the object. - Implements . - - - - - An constant containing a null Variant structure. - - - An constant containing a null Variant structure. - - - - - Determines if the specified object is equal to the object. - - - Determines if the specified object is equal to the object. - - - - - Returns a unique hashcode for the object. - - - - - Converts the value to a human readable string. - - - - - Initializes the object with a bool value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a sbyte value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a byte value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a short value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a ushort value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with an int value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a uint value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a long value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a ulong value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a float value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a double value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a string value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a DateTime value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a Guid value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a Uuid value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a byte[] value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a XmlElement value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a NodeId value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a ExpandedNodeId value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a StatusCode value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a QualifiedName value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a LocalizedText value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a ExtensionObject value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a DataValue value. - - - Initializes the object with a value. - - The value to set this Variant to - - - - Initializes the object with a bool array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a sbyte array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a short array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a ushort array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with an int array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a uint array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a long array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a ulong array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a float array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a double array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a string array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a DateTime array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a Guid array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a Uuid array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a byte[] array value. - - - Initializes the object with a 2-d -array value. - - The 2-d -array value to set this Variant to - - - - Initializes the object with a XmlElement array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a NodeId array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a ExpandedNodeId array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a StatusCode array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a QualifiedName array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a LocalizedText array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a ExtensionObject array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a DataValue array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a Variant array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Initializes the object with a object array value. - - - Initializes the object with a -array value. - - The -array value to set this Variant to - - - - Stores a scalar value in the variant. - - - - - Stores a on dimensional arrau value in the variant. - - - - - Initializes the object with a collection. - - - - - Initializes the object with an object. - - - - - A collection of Variant objects. - - - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - - Provides a strongly-typed collection of objects. - - - - - Initializes the collection with the specified capacity. - - - Initializes the collection with the specified capacity. - - The capacity to constrain the collection to - - - - Converts an array to a collection. - - - Converts an array of to a collection. - - An array of to convert to a collection - - - - Converts an array to a collection. - - - Converts an array of to a collection. - - An array of to convert to a collection - - - - - - - Creates a deep copy of the collection. - - - Creates a deep copy of the collection. - - - - - A class that defines constants used by UA applications. - - - A class that defines constants used by UA applications. - - - - - - Returns true is the attribute id is valid. - - - - - Returns the browse name for the attribute. - - - - - Returns the browse names for all attributes. - - - - - Returns the id for the attribute with the specified browse name. - - - - - Returns the ids for all attributes. - - - - - Returns the ids for all attributes which are valid for the at least one of the node classes specified by the mask. - - - - - Returns the built type required for an attribute. - - - - - Returns the data type id for the attribute. - - - - - Returns true if the corresponding bit is set in the attribute write mask. - - - - - Sets the corresponding bit in the attribute write mask and returns the result. - - - - - Returns the value rank for the attribute. - - - - - Checks if the attribute is valid for at least one of node classes specified in the mask. - - - - - Returns the AttributeWriteMask for the attribute. - - - - - The canonical identifier for the node. - - - - - The class of the node. - - - - - A non-localized, human readable name for the node. - - - - - A localized, human readable name for the node. - - - - - A localized description for the node. - - - - - Indicates which attributes are writable. - - - - - Indicates which attributes are writable by the current user. - - - - - Indicates that a type node may not be instantiated. - - - - - Indicates that forward and inverse references have the same meaning. - - - - - The browse name for an inverse reference. - - - - - Indicates that following forward references within a view will not cause a loop. - - - - - Indicates that the node can be used to subscribe to events. - - - - - The value of a variable. - - - - - The node id of the data type for the variable value. - - - - - The number of dimensions in the value. - - - - - The length for each dimension of an array value. - - - - - How a variable may be accessed. - - - - - How a variable may be accessed after taking the user's access rights into account. - - - - - Specifies (in milliseconds) how fast the server can reasonably sample the value for changes. - - - - - Specifies whether the server is actively collecting historical data for the variable. - - - - - Whether the method can be called. - - - - - Whether the method can be called by the current user. - - - - - Provides the metadata and encoding information for custom DataTypes. - - - - - The permissions for the node granted to roles. - - - - - The subset of permissions available for the roles available to the current session. - - - - - The access restrictions assigned to the node. - - - - - How a variable may be accessed. - - - - - Decodes objects from a UA Binary encoded stream. - - - - - Creates a decoder that reads from a memory buffer. - - - - - Creates a decoder that reads from a memory buffer. - - - - - Creates a decoder that reads from a stream. - - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - Initializes the tables used to map namespace and server uris during decoding. - - The namespaces URIs referenced by the data being decoded. - The server URIs referenced by the data being decoded. - - - - Completes reading and closes the stream. - - - - - Returns the current position in the stream. - - - - - Gets the stream that the decoder is reading from. - - - - - Decodes a message from a stream. - - - - - Decodes a session-less message from a buffer. - - - - - Decodes a message from a buffer. - - - - - Decodes an object from a buffer. - - - - - Loads a string table from a binary stream. - - - - - The type of encoding being used. - - - - - The message context associated with the decoder. - - - - - Pushes a namespace onto the namespace stack. - - - - - Pops a namespace from the namespace stack. - - - - - Reads a boolean from the stream. - - - - - Reads a sbyte from the stream. - - - - - Reads a byte from the stream. - - - - - Reads a short from the stream. - - - - - Reads a ushort from the stream. - - - - - Reads an int from the stream. - - - - - Reads a uint from the stream. - - - - - Reads a long from the stream. - - - - - Reads a ulong from the stream. - - - - - Reads a float from the stream. - - - - - Reads a double from the stream. - - - - - Reads a string from the stream. - - - - - Reads a string from the stream (throws an exception if its length exceeds the limit specified). - - - - - Reads a UTC date/time from the stream. - - - - - Reads a GUID from the stream. - - - - - Reads a byte string from the stream. - - - - - Reads a byte string from the stream. - - - - - Reads an XmlElement from the stream. - - - - - Reads an NodeId from the stream. - - - - - Reads an ExpandedNodeId from the stream. - - - - - Reads an StatusCode from the stream. - - - - - Reads an DiagnosticInfo from the stream. - - - - - Reads an QualifiedName from the stream. - - - - - Reads an LocalizedText from the stream. - - - - - Reads an Variant from the stream. - - - - - Reads an DataValue from the stream. - - - - - Reads an ExtensionObject from the stream. - - - - - Reads an encodeable object from the stream. - - The encodeable object field name - The system type of the encopdeable object to be read - The TypeId for the instance that will be read. - An object that was read from the stream. - - - - Reads an enumerated value from the stream. - - - - - Reads a boolean array from the stream. - - - - - Reads a sbyte array from the stream. - - - - - Reads a byte array from the stream. - - - - - Reads a short array from the stream. - - - - - Reads a ushort array from the stream. - - - - - Reads a int array from the stream. - - - - - Reads a uint array from the stream. - - - - - Reads a long array from the stream. - - - - - Reads a ulong array from the stream. - - - - - Reads a float array from the stream. - - - - - Reads a double array from the stream. - - - - - Reads a string array from the stream. - - - - - Reads a UTC date/time array from the stream. - - - - - Reads a GUID array from the stream. - - - - - Reads a byte string array from the stream. - - - - - Reads an XmlElement array from the stream. - - - - - Reads an NodeId array from the stream. - - - - - Reads an ExpandedNodeId array from the stream. - - - - - Reads an StatusCode array from the stream. - - - - - Reads an DiagnosticInfo array from the stream. - - - - - Reads an QualifiedName array from the stream. - - - - - Reads an LocalizedText array from the stream. - - - - - Reads an Variant array from the stream. - - - - - Reads an DataValue array from the stream. - - - - - Reads an extension object array from the stream. - - - - - Reads an encodeable array from the stream. - - The encodeable array field name - The system type of the encopdeable objects to be read object - The TypeId for the instances that will be read. - An array that was read from the stream. - - - - Reads an enumerated value array from the stream. - - - - - - - - Reads a DiagnosticInfo from the stream. - Limits the InnerDiagnosticInfo nesting level. - - - - - Get the system type from the type factory if not specified by caller. - - The reference to the system type, or null - The encodeable type id of the system type. - If the system type is assignable to - - - - Reads and returns an array of elements of the specified length and builtInType - - - - - Reads the length of an array. - - - - - Reads the body of a node id. - - - - - Reads an extension object from the stream. - - - - - Reads an Variant from the stream. - - - - - Test and increment the nesting level. - - - - - Encodes objects in a stream using the UA Binary encoding. - - - - - Creates an encoder that writes to a memory buffer. - - - - - Creates an encoder that writes to a fixed size memory buffer. - - - - - Creates an encoder that writes to the stream. - - The stream to which the encoder writes. - The message context to use for the encoding. - If the stream should be left open on dispose. - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - Initializes the tables used to map namespace and server uris during encoding. - - The namespaces URIs referenced by the data being encoded. - The server URIs referenced by the data being encoded. - - - - Completes writing and returns the buffer (if available). - - - - - Completes writing and returns the buffer as base64 encoded string. - - - - - Completes writing and returns position in the stream. - - - - - Gets or sets the position in the stream. - - - - - Writes raw bytes to the stream. - - - - - Encodes a message in a buffer. - - - - - Encodes a session-less message to a buffer. - - - - - Encodes a message in a stream. - - - - - Encodes a message with its header. - - - - - Saves a string table from a binary stream. - - - - - The type of encoding being used. - - - - - The message context associated with the encoder. - - - - - Binary Encoder always produces reversible encoding. - - - - - Pushes a namespace onto the namespace stack. - - - - - Pops a namespace from the namespace stack. - - - - - Writes a boolean to the stream. - - - - - Writes a sbyte to the stream. - - - - - Writes a byte to the stream. - - - - - Writes a short to the stream. - - - - - Writes a ushort to the stream. - - - - - Writes an int to the stream. - - - - - Writes a uint to the stream. - - - - - Writes a long to the stream. - - - - - Writes a ulong to the stream. - - - - - Writes a float to the stream. - - - - - Writes a double to the stream. - - - - - Writes a string to the stream. - - - - - Writes a UTC date/time to the stream. - - - - - Writes a GUID to the stream. - - - - - Writes a GUID to the stream. - - - - - Writes a byte string to the stream. - - - - - Writes an XmlElement to the stream. - - - - - Writes an NodeId to the stream. - - - - - Writes an ExpandedNodeId to the stream. - - - - - Writes an StatusCode to the stream. - - - - - Writes a DiagnosticInfo to the stream. - - - - - Writes an QualifiedName to the stream. - - - - - Writes an LocalizedText to the stream. - - - - - Writes an Variant to the stream. - - - - - Writes an DataValue array to the stream. - - - - - Writes an ExtensionObject to the stream. - - - - - Writes an encodeable object to the stream. - - - - - Writes an enumerated value array to the stream. - - - - - Writes a boolean array to the stream. - - - - - Writes a sbyte array to the stream. - - - - - Writes a sbyte array to the stream. - - - - - Writes a short array to the stream. - - - - - Writes a ushort array to the stream. - - - - - Writes a int array to the stream. - - - - - Writes a uint array to the stream. - - - - - Writes a long array to the stream. - - - - - Writes a ulong array to the stream. - - - - - Writes a float array to the stream. - - - - - Writes a double array to the stream. - - - - - Writes a string array to the stream. - - - - - Writes a UTC date/time array to the stream. - - - - - Writes a GUID array to the stream. - - - - - Writes a GUID array to the stream. - - - - - Writes a byte string array to the stream. - - - - - Writes an XmlElement array to the stream. - - - - - Writes an NodeId array to the stream. - - - - - Writes an ExpandedNodeId array to the stream. - - - - - Writes an StatusCode array to the stream. - - - - - Writes an DiagnosticInfo array to the stream. - - - - - Writes an QualifiedName array to the stream. - - - - - Writes an LocalizedText array to the stream. - - - - - Writes an Variant array to the stream. - - - - - Writes an DataValue array to the stream. - - - - - Writes an extension object array to the stream. - - - - - Writes an encodeable object array to the stream. - - - - - Writes an enumerated value array to the stream. - - - - - Encode an array according to its valueRank and BuiltInType - - - - - Writes a DiagnosticInfo to the stream. - Ignores InnerDiagnosticInfo field if the nesting level - is exceeded. - - - - - Writes an object array to the stream (converts to Variant first). - - - - - Write the length of an array. Returns true if the array is empty. - - - - - Write the length of an array. Returns true if the array is empty. - - - - - Returns the node id encoding byte for a node id value. - - - - - Writes the body of a node id to the stream. - - - - - Writes an Variant to the stream. - - - - - Test and increment the nesting level. - - - - - The possible values for the node id encoding byte. - - - - - The possible values for the diagnostic info encoding byte. - - - - - The possible values for the localized text encoding byte. - - - - - The possible values for the data value encoding byte. - - - - - The possible values for the data value encoding byte. - - - - - The possible values for Variant encoding bits. - - - - - A concrete base class used by the autogenerated code. - - - - - - - - - - - - - - - - - - - - Checks if the value has changed. - - - - - Applies the data encoding to the value. - - - - - Encodes the object in XML or Binary - - - - - Encodes the object in XML. - - - - - Encodes the object in binary - - - - - - - - Returns a deep copy of an encodeable object. - - - - - Creates encodeable objects based on the type id. - - - - This factory is used to store and retrieve underlying OPC UA system types. -
    - - You can manually add types. You can also import all types from a specified assembly. - Once the types exist within the factory, these types can be then easily queried. -
    -
    -
    - - - Creates a factory initialized with the types in the core library. - - - - - Creates a factory which is marked as shared and initialized with the types in the core library. - - - - - Creates a factory by copying the table from another factory. - - - - - Loads the types from an assembly. - - - - - Adds an extension type to the factory. - - The underlying system type to add to the factory - A dictionary of unbound typeIds, e.g. JSON type ids referenced by object name. - - - - The default factory for the process. - - - The default factory for the process. - - - - - Returns the xml qualified name for the specified system type id. - - - Returns the xml qualified name for the specified system type id. - - The underlying type to query and return the Xml qualified name of - - - - Returns the xml qualified name for the specified object. - - - Returns the xml qualified name for the specified object. - - The object to query and return the Xml qualified name of - - - - - Returns the object used to synchronize access to the factory. - - - Returns the object used to synchronize access to the factory. - - - - - Returns a unique identifier for the table instance. Used to debug problems with shared tables. - - - - - Adds an extension type to the factory. - - The underlying system type to add to the factory - - - - Associates an encodeable type with an encoding id. - - A NodeId for a Data Type Encoding node - The system type to use for the specified encoding. - - - - Adds all encodable types exported from an assembly to the factory. - - - - Adds all encodable types exported from an assembly to the factory. -
    - - This method uses reflection on the specified assembly to export all of the - types the assembly exposes, and automatically adds all types that implement - the interface, to the factory. -
    -
    - The assembly containing the types to add to the factory -
    - - - Adds an enumerable of extension types to the factory. - - The underlying system types to add to the factory - - - - Returns the system type for the specified type id. - - - Returns the system type for the specified type id. - - The type id to return the system-type of - - - - The dictionary of encodeabe types. - - - - - Interface implemented by complex data type instances. - - - - - Gets or sets the UA type identifier for the encodeable type. - - - The UA type identifier. - - - - - Interface implemented by complex data type instances that discover and provide type information dynamically - - - - - Returns the xml qualified name for the type instance - - The xml qualified name for the type instance - - - - Defines functions used to dencode objects from a stream. - - - - - The type of encoding being used. - - - - - The message context associated with the decoder. - - - - - Closes the stream used for reading. - - - - - Initializes the tables used to map namespace and server uris during decoding. - - The namespaces URIs referenced by the data being decoded. - The server URIs referenced by the data being decoded. - - - - Pushes a namespace onto the namespace stack. - - - - - Pops a namespace from the namespace stack. - - - - - Reads a boolean from the stream. - - - - - Reads a sbyte from the stream. - - - - - Reads a byte from the stream. - - - - - Reads a short from the stream. - - - - - Reads a ushort from the stream. - - - - - Reads an int from the stream. - - - - - Reads a uint from the stream. - - - - - Reads a long from the stream. - - - - - Reads a ulong from the stream. - - - - - Reads a float from the stream. - - - - - Reads a double from the stream. - - - - - Reads a string from the stream. - - - - - Reads a UTC date/time from the stream. - - - - - Reads a GUID from the stream. - - - - - Reads a byte string from the stream. - - - - - Reads an XmlElement from the stream. - - - - - Reads an NodeId from the stream. - - - - - Reads an ExpandedNodeId from the stream. - - - - - Reads an StatusCode from the stream. - - - - - Reads an DiagnosticInfo from the stream. - - - - - Reads an QualifiedName from the stream. - - - - - Reads an LocalizedText from the stream. - - - - - Reads an Variant from the stream. - - - - - Reads an DataValue from the stream. - - - - - Reads an ExtensionObject from the stream. - - - - - Reads an encodeable object from the stream. - - The encodeable object field name - The system type of the encopdeable object to be read - The TypeId for the instance that will be read. - An object that was read from the stream. - - - - Reads an enumerated value from the stream. - - - - - Reads a boolean array from the stream. - - - - - Reads a sbyte array from the stream. - - - - - Reads a sbyte array from the stream. - - - - - Reads a short array from the stream. - - - - - Reads a ushort array from the stream. - - - - - Reads a int array from the stream. - - - - - Reads a uint array from the stream. - - - - - Reads a long array from the stream. - - - - - Reads a ulong array from the stream. - - - - - Reads a float array from the stream. - - - - - Reads a double array from the stream. - - - - - Reads a string array from the stream. - - - - - Reads a UTC date/time array from the stream. - - - - - Reads a GUID array from the stream. - - - - - Reads a byte string array from the stream. - - - - - Reads an XmlElement array from the stream. - - - - - Reads an NodeId array from the stream. - - - - - Reads an ExpandedNodeId array from the stream. - - - - - Reads an StatusCode array from the stream. - - - - - Reads an DiagnosticInfo array from the stream. - - - - - Reads an QualifiedName array from the stream. - - - - - Reads an LocalizedText array from the stream. - - - - - Reads an Variant array from the stream. - - - - - Reads an DataValue array from the stream. - - - - - Reads an extension object array from the stream. - - - - - Reads an encodeable array from the stream. - - The encodeable array field name - The system type of the encopdeable objects to be read object - The TypeId for the instances that will be read. - An array that was read from the stream. - - - - Reads an enumerated value array from the stream. - - - - - Reads an array with the specified valueRank and the specified BuiltInType. - - The array field name. - The value rank of the array. - The builtInType of the array elements. - The system type of an encodeable or enum element of the array. - The type id of an encodeable or enum element of the array. - An array of the specified builtInType, systemType or encodeableTypeId. - - - - Defines methods used to encode and decode objects. - - - - - Returns the NodeId for the encodable type. - - The NodeId. - - - - Returns the NodeId for the default binary encoding for the type. - - The NodeId for binary encoding. - - - - Returns the NodeId for the default XML encoding for the type. - - The NodeId for the XML encoding id. - - - - Encodes the object in a stream. - - The encoder to be used for encoding the current value. - - - - Decodes the object from a stream. - - The decoder to be used for decoding the current value. - - - - Checks if the value is equal to the another encodeable object. - - The encodeable. - - true if the specified instance of the type is equal; otherwise false. - - - - - A collection of encodeable objects. - - - - - Initializes an empty collection. - - - - - Initializes the collection from another collection. - - The collection whose elements are copied to the new list. - - is null. - - - - - Initializes the collection with the specified capacity. - - The initial capacity of the collection. - - - - Converts an array to a collection. - - The values to be converted to an instance of . - Instance of the containing - - - - Converts an array to a collection. - - The values to be converted to new instance of . - The result of the conversion. - - - - Defines extensions to support the JSON encoding. - - - - - Returns the NodeId for the default JSON encoding for the type. - - The NodeId for the JSON encoding. - - - - Creates encodeable objects based on the type id. - - - - This factory is used to store and retrieve underlying OPC UA system types. -
    - - You can manually add types. You can also import all types from a specified assembly. - Once the types exist within the factory, these types can be then easily queried. -
    -
    -
    - - - Returns the object used to synchronize access to the factory. - - - Returns the object used to synchronize access to the factory. - - - - - Returns a unique identifier for the table instance. Used to debug problems with shared tables. - - - - - Adds an extension type to the factory. - - The underlying system type to add to the factory - - - - Associates an encodeable type with an encoding id. - - A NodeId for a Data Type Encoding node - The system type to use for the specified encoding. - - - - Adds all encodable types exported from an assembly to the factory. - - - - Adds all encodable types exported from an assembly to the factory. -
    - - This method uses reflection on the specified assembly to export all of the - types the assembly exposes, and automatically adds all types that implement - the interface, to the factory. -
    -
    - The assembly containing the types to add to the factory -
    - - - Adds an enumerable of extension types to the factory. - - The underlying system types to add to the factory - - - - Returns the system type for the specified type id. - - - Returns the system type for the specified type id. - - The type id to return the system-type of - - - - The dictionary of encodeable types. - - - - - Defines functions used to encode objects in a stream. - - - - - The type of encoding being used. - - - - - Selects the reversible encoding type. - - - - - The message context associated with the encoder. - - - - - Completes writing and returns the encoded length. - - - - - Completes writing and returns the encoded text. - - - - - Sets the mapping tables to use during decoding. - - The namespace uris. - The server uris. - - - - Pushes a namespace onto the namespace stack. - - - - - Pops a namespace from the namespace stack. - - - - - Writes a boolean to the stream. - - - - - Writes a sbyte to the stream. - - - - - Writes a byte to the stream. - - - - - Writes a short to the stream. - - - - - Writes a ushort to the stream. - - - - - Writes an int to the stream. - - - - - Writes a uint to the stream. - - - - - Writes a long to the stream. - - - - - Writes a ulong to the stream. - - - - - Writes a float to the stream. - - - - - Writes a double to the stream. - - - - - Writes a string to the stream. - - - - - Writes a UTC date/time to the stream. - - - - - Writes a GUID to the stream. - - - - - Writes a GUID to the stream. - - - - - Writes a byte string to the stream. - - - - - Writes an XmlElement to the stream. - - - - - Writes an NodeId to the stream. - - - - - Writes an ExpandedNodeId to the stream. - - - - - Writes an StatusCode to the stream. - - - - - Writes an DiagnosticInfo to the stream. - - - - - Writes an QualifiedName to the stream. - - - - - Writes an LocalizedText to the stream. - - - - - Writes an Variant array to the stream. - - - - - Writes an DataValue array to the stream. - - - - - Writes an ExtensionObject to the stream. - - - - - Writes an encodeable object to the stream. - - - - - Writes an enumerated value array to the stream. - - - - - Writes a boolean array to the stream. - - - - - Writes a sbyte array to the stream. - - - - - Writes a sbyte array to the stream. - - - - - Writes a short array to the stream. - - - - - Writes a ushort array to the stream. - - - - - Writes a int array to the stream. - - - - - Writes a uint array to the stream. - - - - - Writes a long array to the stream. - - - - - Writes a ulong array to the stream. - - - - - Writes a float array to the stream. - - - - - Writes a double array to the stream. - - - - - Writes a string array to the stream. - - - - - Writes a UTC date/time array to the stream. - - - - - Writes a GUID array to the stream. - - - - - Writes a GUID array to the stream. - - - - - Writes a byte string array to the stream. - - - - - Writes a XmlElement array to the stream. - - - - - Writes an NodeId array to the stream. - - - - - Writes an ExpandedNodeId array to the stream. - - - - - Writes an StatusCode array to the stream. - - - - - Writes an DiagnosticInfo array to the stream. - - - - - Writes an QualifiedName array to the stream. - - - - - Writes an LocalizedText array to the stream. - - - - - Writes an Variant array to the stream. - - - - - Writes an DataValue array to the stream. - - - - - Writes an extension object array to the stream. - - - - - Writes an encodeable object array to the stream. - - - - - Writes an enumerated value array to the stream. - - - - - Encode an array according to its valueRank and BuiltInType - - - - - The type of encoding used by an encoder/decoder. - - - - - The UA Binary encoding. - - - - - XML - - - - - JSON - - - - - A Json decoder extension to handle arrays and structures. - - - - - Push the specified structure on the Read Stack. - - The name of the object that shall be placed on the Read Stack - true if successful - - - - Push an Array item on the Read Stack - - The array name - The index of the item that shall be placed on the Read Stack - true if successful - - - - Pop the current object (structure/array) from the Read Stack. - - - - - Read a decoded JSON field. - - The name of the field. - The returned object token of the field. - - - - Interface for extended methods for JSON encoders based on IEncoder. - - - - - Force the Json encoder to encode namespace URI instead of - namespace Index in NodeIds. - - - - - Push the begin of an array on the encoder stack. - - The name of the array field. - - - - Push the begin of a structure on the encoder stack. - - The name of the structure field. - - - - Pop the array from the encoder stack. - - - - - Pop the structure from the encoder stack. - - - - - Call an IEncoder action where the reversible encoding is applied - before the call to the Action and restored before return. - - - - - Interface implemented by structured type instances. - - - - - Gets the structure type. - - - - - Reads objects from a JSON stream. - - - - - The name of the Root array if the json is defined as an array - - - - - Create a JSON decoder to decode a string. - - The JSON encoded string. - The service message context to use. - - - - Create a JSON decoder to decode a from a . - - The system type of the encoded JSON stram. - The text reader. - The service message context to use. - - - - Sets private members to default values. - - - - - Decodes a session-less message from a buffer. - - - - - Decodes a message from a buffer. - - - - - Decodes a message from a buffer. - - - - - Decodes an object from a buffer. - - - - - Initializes the tables used to map namespace and server uris during decoding. - - The namespaces URIs referenced by the data being decoded. - The server URIs referenced by the data being decoded. - - - - Closes the stream used for reading. - - - - - Closes the stream used for reading. - - - - - Reads the body extension object from the stream. - - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - The type of encoding being used. - - - - - The message context associated with the decoder. - - - - - Pushes a namespace onto the namespace stack. - - - - - Pops a namespace from the namespace stack. - - - - - Read a decoded JSON field. - - The name of the field. - The returned object token of the field. - - - - Reads a boolean from the stream. - - - - - Reads a sbyte from the stream. - - - - - Reads a byte from the stream. - - - - - Reads a short from the stream. - - - - - Reads a ushort from the stream. - - - - - Reads an int from the stream. - - - - - Reads a uint from the stream. - - - - - Reads a long from the stream. - - - - - Reads a ulong from the stream. - - - - - Reads a float from the stream. - - - - - Reads a double from the stream. - - - - - Reads a string from the stream. - - - - - Reads a UTC date/time from the stream. - - - - - Reads a GUID from the stream. - - - - - Reads a byte string from the stream. - - - - - Reads an XmlElement from the stream. - - - - - Reads an NodeId from the stream. - - - - - Reads an ExpandedNodeId from the stream. - - - - - Reads an StatusCode from the stream. - - - - - Reads a DiagnosticInfo from the stream. - - - - - Reads an QualifiedName from the stream. - - - - - Reads an LocalizedText from the stream. - - - - - Reads an Variant from the stream. - - - - - Reads an DataValue from the stream. - - - - - Reads an extension object from the stream. - - - - - Reads an encodeable object from the stream. - - The encodeable object field name - The system type of the encodeable object to be read - The TypeId for the instance that will be read. - An object that was read from the stream. - - - - Reads an enumerated value from the stream. - - - - - Reads a boolean array from the stream. - - - - - Reads a sbyte array from the stream. - - - - - Reads a byte array from the stream. - - - - - Reads a short array from the stream. - - - - - Reads a ushort array from the stream. - - - - - Reads a int array from the stream. - - - - - Reads a uint array from the stream. - - - - - Reads a long array from the stream. - - - - - Reads a ulong array from the stream. - - - - - Reads a float array from the stream. - - - - - Reads a double array from the stream. - - - - - Reads a string array from the stream. - - - - - Reads a UTC date/time array from the stream. - - - - - Reads a GUID array from the stream. - - - - - Reads a byte string array from the stream. - - - - - Reads an XmlElement array from the stream. - - - - - Reads an NodeId array from the stream. - - - - - Reads an ExpandedNodeId array from the stream. - - - - - Reads an StatusCode array from the stream. - - - - - Reads an DiagnosticInfo array from the stream. - - - - - Reads an QualifiedName array from the stream. - - - - - Reads an LocalizedText array from the stream. - - - - - Reads an Variant array from the stream. - - - - - Reads an DataValue array from the stream. - - - - - Reads an array of extension objects from the stream. - - - - - Reads an encodeable array from the stream. - - The encodeable array field name - The system type of the encopdeable objects to be read object - The TypeId for the instances that will be read. - An array that was read from the stream. - - - - Reads an enumerated value array from the stream. - - - - - - - - Push the specified structure on the Read Stack - - The name of the object that shall be placed on the Read Stack - true if successful - - - - Push an Array item on the Read Stack - - The array name - The index of the item that shall be placed on the Read Stack - true if successful - - - - Pop the current object from the Read Stack - - - - - Reads a DiagnosticInfo from the stream. - Limits the InnerDiagnosticInfos to the specified depth. - - - - - Get the system type from the type factory if not specified by caller. - - The reference to the system type, or null - The encodeable type id of the system type. - If the system type is assignable to - - - - Read the body of a Variant as a BuiltInType - - - - - Read the Body of a Variant as an Array - - - - - Reads the content of an Array from json stream - - - - - Reads an object from the json stream - - - - - - Read the Matrix part (simple array or array of arrays) - - - - - Get Default value for NodeId for diferent IdTypes - - new NodeId - - - - Test and increment the nesting level. - - - - - Writes objects to a JSON stream. - - - - - - - - - - - - Initializes the object with default values. - - - - - Initializes the object with default values. - - - - - Sets private members to default values. - - - - - Initialize Writer. - - - - - Encodes a session-less message to a buffer. - - - - - Encodes a message in a stream. - - - - - Encodes a message with its header. - - - - - Initializes the tables used to map namespace and server uris during encoding. - - The namespaces URIs referenced by the data being encoded. - The server URIs referenced by the data being encoded. - - - - Completes writing and returns the JSON text. - - - - - Completes writing and returns the text length. - - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - - - - - - - - - - - - - - - - The type of encoding being used. - - - - - The message context associated with the encoder. - - - - - The Json encoder reversible encoding option - - - - - The Json encoder to encoder namespace URI instead of - namespace Index in NodeIds. - - - - - The Json encoder to encode namespace URI for all - namespaces - - - - - The Json encoder default value option. - - - - - The Json encoder default value option. - - - - - Pushes a namespace onto the namespace stack. - - - - - Pops a namespace from the namespace stack. - - - - - Writes a boolean to the stream. - - - - - Writes a sbyte to the stream. - - - - - Writes a byte to the stream. - - - - - Writes a short to the stream. - - - - - Writes a ushort to the stream. - - - - - Writes an int to the stream. - - - - - Writes a uint to the stream. - - - - - Writes a long to the stream. - - - - - Writes a ulong to the stream. - - - - - Writes a float to the stream. - - - - - Writes a double to the stream. - - - - - Writes a string to the stream. - - - - - Writes a UTC date/time to the stream. - - - - - Writes a GUID to the stream. - - - - - Writes a GUID to the stream. - - - - - Writes a byte string to the stream. - - - - - Writes an XmlElement to the stream. - - - - - Writes an NodeId to the stream. - - - - - Writes an ExpandedNodeId to the stream. - - - - - Writes an StatusCode to the stream. - - - - - Writes a DiagnosticInfo to the stream. - - - - - Writes an QualifiedName to the stream. - - - - - Writes an LocalizedText to the stream. - - - - - Writes an Variant to the stream. - - - - - Writes an DataValue array to the stream. - - - - - Writes an ExtensionObject to the stream. - - - - - Writes an encodeable object to the stream. - - - - - Writes an enumerated value to the stream. - - - - - Writes an enumerated Int32 value to the stream. - - - - - Writes a boolean array to the stream. - - - - - Writes a sbyte array to the stream. - - - - - Writes a sbyte array to the stream. - - - - - Writes a short array to the stream. - - - - - Writes a ushort array to the stream. - - - - - Writes a int array to the stream. - - - - - Writes a uint array to the stream. - - - - - Writes a long array to the stream. - - - - - Writes a ulong array to the stream. - - - - - Writes a float array to the stream. - - - - - Writes a double array to the stream. - - - - - Writes a string array to the stream. - - - - - Writes a UTC date/time array to the stream. - - - - - Writes a GUID array to the stream. - - - - - Writes a GUID array to the stream. - - - - - Writes a byte string array to the stream. - - - - - Writes an XmlElement array to the stream. - - - - - Writes an NodeId array to the stream. - - - - - Writes an ExpandedNodeId array to the stream. - - - - - Writes an StatusCode array to the stream. - - - - - Writes an DiagnosticInfo array to the stream. - - - - - Writes an QualifiedName array to the stream. - - - - - Writes an LocalizedText array to the stream. - - - - - Writes an Variant array to the stream. - - - - - Writes an DataValue array to the stream. - - - - - Writes an extension object array to the stream. - - - - - Writes an encodeable object array to the stream. - - - - - Writes an enumerated value array to the stream. - - - - - Writes the contents of an Variant to the stream. - - - - - Writes an Variant array to the stream. - - - - - Encode an array according to its valueRank and BuiltInType - - - - - Writes a DiagnosticInfo to the stream. - Ignores InnerDiagnosticInfo field if the nesting level - is exceeded. - - - - - Write multi dimensional array in structure. - - - - - Test and increment the nesting level. - - - - - Reads objects from a XML stream. - - - - - Initializes the object with default values. - - - - - Initializes the object with an XML element to parse. - - - - - Initializes the object with a XML reader. - - - - - Sets private members to default values. - - - - - Initializes the tables used to map namespace and server uris during decoding. - - The namespaces URIs referenced by the data being decoded. - The server URIs referenced by the data being decoded. - - - - Initializes a string table from an XML stream. - - Name of the table. - Name of the element. - The string table. - True if the table was found. False otherwise. - - - - Closes the stream used for reading. - - - - - Closes the stream used for reading. - - - - - Returns the qualified name for the next element in the stream. - - - - - Returns true if the specified field is the next element to be extracted. - - - - - Returns the qualified name for the next element in the stream. - - - - - Skips to the end of the specified element. - - The qualified name of the element to skip. - - - - Reads the contents of an Variant object. - - - - - - Reads the body extension object from the stream. - - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - The type of encoding being used. - - - - - The message context associated with the decoder. - - - - - Pushes a namespace onto the namespace stack. - - - - - Pops a namespace from the namespace stack. - - - - - Reads a boolean from the stream. - - - - - Reads a sbyte from the stream. - - - - - Reads a byte from the stream. - - - - - Reads a short from the stream. - - - - - Reads a ushort from the stream. - - - - - Reads an int from the stream. - - - - - Reads a uint from the stream. - - - - - Reads a long from the stream. - - - - - Reads a ulong from the stream. - - - - - Reads a float from the stream. - - - - - Reads a double from the stream. - - - - - Reads a string from the stream. - - - - - Reads a UTC date/time from the stream. - - - - - Reads a GUID from the stream. - - - - - Reads a byte string from the stream. - - - - - Exracts the XML from the reader. - - - - - Reads an XmlElement from the stream. - - - - - Reads an NodeId from the stream. - - - - - Reads an ExpandedNodeId from the stream. - - - - - Reads an StatusCode from the stream. - - - - - Reads an DiagnosticInfo from the stream. - - - - - Reads an QualifiedName from the stream. - - - - - Reads an LocalizedText from the stream. - - - - - Reads an Variant from the stream. - - - - - Reads an DataValue from the stream. - - - - - Reads an extension object from the stream. - - - - - Reads an encodeable object from the stream. - - The encodeable object field name - The system type of the encodeable object to be read - The TypeId for the instance that will be read. - An object that was read from the stream. - - - - Reads an enumerated value from the stream. - - - - - Reads a boolean array from the stream. - - - - - Reads a sbyte array from the stream. - - - - - Reads a byte array from the stream. - - - - - Reads a short array from the stream. - - - - - Reads a ushort array from the stream. - - - - - Reads a int array from the stream. - - - - - Reads a uint array from the stream. - - - - - Reads a long array from the stream. - - - - - Reads a ulong array from the stream. - - - - - Reads a float array from the stream. - - - - - Reads a double array from the stream. - - - - - Reads a string array from the stream. - - - - - Reads a UTC date/time array from the stream. - - - - - Reads a GUID array from the stream. - - - - - Reads a byte string array from the stream. - - - - - Reads an XmlElement array from the stream. - - - - - Reads an NodeId array from the stream. - - - - - Reads an ExpandedNodeId array from the stream. - - - - - Reads an StatusCode array from the stream. - - - - - Reads an DiagnosticInfo array from the stream. - - - - - Reads an QualifiedName array from the stream. - - - - - Reads an LocalizedText array from the stream. - - - - - Reads an Variant array from the stream. - - - - - Reads an DataValue array from the stream. - - - - - Reads an array of extension objects from the stream. - - - - - Reads an encodeable array from the stream. - - The encodeable array field name - The system type of the encopdeable objects to be read object - The TypeId for the instances that will be read. - An array that was read from the stream. - - - - Reads an enumerated value array from the stream. - - - - - - - - Reads an DiagnosticInfo from the stream. - Limits the InnerDiagnosticInfo nesting level. - - - - - Reads an Matrix from the stream. - - - - - Read array items from current ListOf element - - provides the fieldName for the array - provides the BuiltInType of the elements that are read - The system type of the elements to read. - provides the type id of the encodeable element - - - - Reads a string from the stream. - - - - - Reads the start of filed where the presences of the xsi:nil attribute is not significant. - - - - - Reads the start of field. - - - - - Reads the end of a field. - - - - - Moves to the next start element. - - - - - Get the system type from the type factory if not specified by caller. - - The reference to the system type, or null - The encodeable type id of the system type. - If the system type is assignable to - - - - Test and increment the nesting level. - - - - - Writes objects to a XML stream. - - - - - Initializes the object with default values. - - - - - Initializes the object with a system type to encode and a XML writer. - - - - - Initializes the object with a system type to encode and a XML writer. - - - - - Sets private members to default values. - - - - - Writes the root element to the stream. - - - - - Initializes the tables used to map namespace and server uris during encoding. - - The namespaces URIs referenced by the data being encoded. - The server URIs referenced by the data being encoded. - - - - Saves a string table from an XML stream. - - Name of the table. - Name of the element. - The string table. - - - - Writes a start element. - - The name of the element. - The namespace that qualifies the element name. - - - - Writes an end element. - - - - - - - - - - - Frees any unmanaged resources. - - - - - An overrideable version of the Dispose. - - - - - The type of encoding being used. - - - - - The message context associated with the encoder. - - - - - Xml Encoder always produces reversible encoding. - - - - - Pushes a namespace onto the namespace stack. - - - - - Pops a namespace from the namespace stack. - - - - - Writes a boolean to the stream. - - - - - Writes a sbyte to the stream. - - - - - Writes a byte to the stream. - - - - - Writes a short to the stream. - - - - - Writes a ushort to the stream. - - - - - Writes an int to the stream. - - - - - Writes a uint to the stream. - - - - - Writes a long to the stream. - - - - - Writes a ulong to the stream. - - - - - Writes a float to the stream. - - - - - Writes a double to the stream. - - - - - Writes a string to the stream. - - - - - Writes a UTC date/time to the stream. - - - - - Writes a GUID to the stream. - - - - - Writes a GUID to the stream. - - - - - Writes a byte string to the stream. - - - - - Writes an XmlElement to the stream. - - - - - Writes an NodeId to the stream. - - - - - Writes an ExpandedNodeId to the stream. - - - - - Writes an StatusCode to the stream. - - - - - Writes an DiagnosticInfo to the stream. - - - - - Writes a DiagnosticInfo to the stream. - - - - - Writes an QualifiedName to the stream. - - - - - Writes an LocalizedText to the stream. - - - - - Writes an Variant array to the stream. - - - - - Writes an DataValue array to the stream. - - - - - Writes an ExtensionObject to the stream. - - - - - Writes an encodeable object to the stream. - - - - - Writes an enumerated value array to the stream. - - - - - Writes a boolean array to the stream. - - - - - Writes a sbyte array to the stream. - - - - - Writes a sbyte array to the stream. - - - - - Writes a short array to the stream. - - - - - Writes a ushort array to the stream. - - - - - Writes a int array to the stream. - - - - - Writes a uint array to the stream. - - - - - Writes a long array to the stream. - - - - - Writes a ulong array to the stream. - - - - - Writes a float array to the stream. - - - - - Writes a double array to the stream. - - - - - Writes a string array to the stream. - - - - - Writes a UTC date/time array to the stream. - - - - - Writes a GUID array to the stream. - - - - - Writes a GUID array to the stream. - - - - - Writes a byte string array to the stream. - - - - - Writes an XmlElement array to the stream. - - - - - Writes an NodeId array to the stream. - - - - - Writes an ExpandedNodeId array to the stream. - - - - - Writes an StatusCode array to the stream. - - - - - Writes an DiagnosticInfo array to the stream. - - - - - Writes an QualifiedName array to the stream. - - - - - Writes an LocalizedText array to the stream. - - - - - Writes an Variant array to the stream. - - - - - Writes an DataValue array to the stream. - - - - - Writes an extension object array to the stream. - - - - - Writes an encodeable object array to the stream. - - - - - Writes an enumerated value array to the stream. - - - - - Writes the contents of an Variant to the stream. - - - - - Writes the body of an ExtensionObject to the stream. - - - - - Writes an Variant array to the stream. - - - - - Encode an array according to its valueRank and BuiltInType - - - - - Writes a DataValue array to the stream. - - - - - Writes the start element for a field. - - - - - Writes the end element for a field. - - - - - Test and increment the nesting level. - - - - - An async version of based on - https://devblogs.microsoft.com/pfxteam/building-async-coordination-primitives-part-2-asyncautoresetevent/. - - - - - Task can wait for next event. - - - - - Set next waiting task. - - - - - Set all waiting tasks. - - - - - Compares values taking into account semantically equivalent values that would fail the simple IsEqual test. - - - - - Constructs an instance of the data comparer. - - - - - Gets or set a flag indicating whether an exception should be thrown on error. - - - - - This method compares two Boolean values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two SByte values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two Byte values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two Int16 values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two UInt16 values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two Int32 values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two UInt32 values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two Int64 values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two UInt64 values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two Float values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two Double values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two String values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two DateTime values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two Guid values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two ByteString values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two XmlElement values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two NodeId values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two ExpandedNodeId values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two StatusCode values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two DiagnosticInfo values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two QualifiedName values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two LocalizedText values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two Variant values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two DataValues. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - This method compares two DataValues. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - The factory to use when decoding extension objects. - - - - - Extracts the extension object body. - - Extension object. - IEncodeable object - - - - This method compares two ExtensionObject values. - - First Value. - Second Value. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - Compares the value of two extension object body. - - - - - The delegate used to compare two values. - - - - - This method compares two arrays. - - IEnumerable object of type T - IEnumerable object of type T - Method name to compare the arrays. - True in case of equal values. - False or ServiceResultException in case of unequal values. - - - - In case of errors, throw exception. - - First Value. - Second Value. - Throws ServiceResultException in case of unequal values. - - - - An interface to a source of random numbers. - - - - - Fills a range in array of bytes with random numbers. - - The array to update. - The start of the range generate. - The number of bytes to generate. - Thrown if the bytes parameter is null. - Thrown if the offset or count parameters do not specify a valid range within the bytes parameter. - - - - Returns a random non-negative integer which does not exeed the specified maximum. - - The maximum value to return. - A random value greater than 0 but less than or equal to max. - Thrown if the max parameter is less than zero. - - - - Uses the Pseudo random generator as a source. - - - - - Initializes the source with a time dependent seed. - - - - - Initializes the source with a seed. - - The number used to initialize the Pseudo random sequence. - - - - - - - - - - A class that generates data. - - - - - Initializes the data generator. - - - - - The maximum length for generated arrays. - - - - - The maximum length for generated strings. - - - - - The minimum value for generated date time values. - - - - - The maximum value for generated date time values. - - - - - The maximum number of attributes in generated XML elements. - - - - - The maximum number of child elements in generated XML elements. - - - - - The table namespace uris to use when generating NodeIds. - - - - - The table server uris to use when generating NodeIds. - - - - - How frequently boundary values should be used expressed as percentage between 0 and 100. - - - - - Returns true of a boundary value should be used. - - - - - Returns a random value of the specified built-in type. - - - - - Returns a random value of the specified built-in type. - - - - - Returns a random value of the specified built-in type. - - - - - Returns an array wrapped in a variant. - - - - - This method returns a random value of values for the type. - - - - - This method returns a random array of values for the type. - - - - - This method returns a random array of values for the type. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates a random string with a random locale. - - - - - Creates a random string for the locale. - - - - - Creates a random symbol with a random locale. - - - - - Creates a random symbol for the locale. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Returns a random variant containing a scalar or array value. - - - - - - - - Get a random DataValue. - - - - - Get random diagnostic info. - - - - - - - - - - - - - - Stores the boundary values for a data type. - - - - - Boundary values used or testing. - - - - - Loads some string data from a resource. - - - - - Randomly selects a boundary value for type. - - - - - Returns a positive integer between the specified values. - - - - - Returns a random value of the specified type. - - - - - Returns a random locale. - - - - - Creates a string from the tokens for the locale. - - - - - Produces high resolution timestamps. - - - - - Returns the current UTC time with a high resolution. - - - This Utc time does not change if the system time is changed. - It returns the Utc time elapsed since the application started. - - - - - Returns a monotonic increasing tick count in milliseconds. - - - - - Return the frequency of the ticks. - - - - - Return the number of ticks per millisecond. - - - - - Disables the hires clock. - - - - - Reset the baseline and allow a new initialization. - - - - - Constructs a HiRes clock class. - - - - - Defines a global instance. - - - - - Stores context information for message encoding and decoding. - - - - - Returns the object used to synchronize access to the context. - - - - - The maximum length for any string, byte string or xml element. - - - - - The maximum length for any array. - - - - - The maximum length for any ByteString. - - - - - The maximum length for any Message. - - - - - The maximum nesting level accepted while encoding or decoding objects. - - - - - The table of namespaces used by the server. - - - - - The table of servers used by the server. - - - - - The factory used to create encodeable objects. - - - - - Logger Utils methods. - - - To simplify porting from Utils.Trace and to avoid - name collisons with anything that is called 'Log' - the Utils class hosts the Logger class. - - - Defines various static utility functions. - - - - - The high performance EventSource log interface. - - - - - ILogger abstraction used by all Utils.LogXXX methods. - - - - - Sets the LogLevel for the TraceEventLogger. - - - The setting is ignored if ILogger is replaced. - - - - - Sets the ILogger. - - - - - If the legacy trace event handler should be used. - - By default true, however a call to SetLogger disables it. - - - - Formats and writes a log message for a certificate. - - The log message as string. - The certificate information to be logged. - An object array that contains zero or more objects to format. - - - - Formats and writes a log message for a certificate. - - Entry will be written on this level. - The log message as string. - The certificate information to be logged. - An object array that contains zero or more objects to format. - - - - Formats and writes a log message for a certificate. - - The event id associated with the log. - The log message as string. - The certificate information to be logged. - An object array that contains zero or more objects to format. - - - - Formats and writes a log message for a certificate. - - Entry will be written on this level. - The event id associated with the log. - The log message as string. - The certificate information to be logged. - An object array that contains zero or more objects to format. - - - - Formats and writes a debug log message. - - The event id associated with the log. - The exception to log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogDebug(0, exception, "Error while processing request from {Address}", address) - - - - Formats and writes a debug log message. - - The event id associated with the log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogDebug(0, "Processing request from {Address}", address) - - - - Formats and writes a debug log message. - - The exception to log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogDebug(exception, "Error while processing request from {Address}", address) - - - - Formats and writes a debug log message. - - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogDebug("Processing request from {Address}", address) - - - - Formats and writes a trace log message. - - The event id associated with the log. - The exception to log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogTrace(0, exception, "Error while processing request from {Address}", address) - - - - Formats and writes a trace log message. - - The event id associated with the log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogTrace(0, "Processing request from {Address}", address) - - - - Formats and writes a trace log message. - - The exception to log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogTrace(exception, "Error while processing request from {Address}", address) - - - - Formats and writes a trace log message. - - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogTrace("Processing request from {Address}", address) - - - - Formats and writes an informational log message. - - The event id associated with the log. - The exception to log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogInformation(0, exception, "Error while processing request from {Address}", address) - - - - Formats and writes an informational log message. - - The event id associated with the log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogInformation(0, "Processing request from {Address}", address) - - - - Formats and writes an informational log message. - - The exception to log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogInformation(exception, "Error while processing request from {Address}", address) - - - - Formats and writes an informational log message. - - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogInformation("Processing request from {Address}", address) - - - - Formats and writes a warning log message. - - The event id associated with the log. - The exception to log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogWarning(0, exception, "Error while processing request from {Address}", address) - - - - Formats and writes a warning log message. - - The event id associated with the log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogWarning(0, "Processing request from {Address}", address) - - - - Formats and writes a warning log message. - - The exception to log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogWarning(exception, "Error while processing request from {Address}", address) - - - - Formats and writes a warning log message. - - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogWarning("Processing request from {Address}", address) - - - - Formats and writes an error log message. - - The event id associated with the log. - The exception to log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogError(0, exception, "Error while processing request from {Address}", address) - - - - Formats and writes an error log message. - - The event id associated with the log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogError(0, "Processing request from {Address}", address) - - - - Formats and writes an error log message. - - The exception to log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogError(exception, "Error while processing request from {Address}", address) - - - - Formats and writes an error log message. - - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogError("Processing request from {Address}", address) - - - - Formats and writes a critical log message. - - The event id associated with the log. - The exception to log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogCritical(0, exception, "Error while processing request from {Address}", address) - - - - Formats and writes a critical log message. - - The event id associated with the log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogCritical(0, "Processing request from {Address}", address) - - - - Formats and writes a critical log message. - - The exception to log. - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogCritical(exception, "Error while processing request from {Address}", address) - - - - Formats and writes a critical log message. - - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - LogCritical("Processing request from {Address}", address) - - - - Formats and writes a log message at the specified log level. - - Entry will be written on this level. - Format string of the log message. - An object array that contains zero or more objects to format. - - - - Formats and writes a log message at the specified log level. - - Entry will be written on this level. - The event id associated with the log. - Format string of the log message. - An object array that contains zero or more objects to format. - - - - Formats and writes a log message at the specified log level. - - Entry will be written on this level. - The exception to log. - Format string of the log message. - An object array that contains zero or more objects to format. - - - - Formats and writes a log message at the specified log level. - - Entry will be written on this level. - The event id associated with the log. - The exception to log. - Format string of the log message. - An object array that contains zero or more objects to format. - - - - Formats the message and creates a scope. - - Format string of the log message in message template format. Example: "User {User} logged in from {Address}" - An object array that contains zero or more objects to format. - A disposable scope object. Can be null. - - using(BeginScope("Processing request from {Address}", address)) - { - } - - - - - To determine a mask from the log level. - - The event id. - The log level. - - - - The URI scheme for the HTTP protocol. - - - - - The URI scheme for the HTTPS protocol, used in some legacy https - clients and servers but not compliant to spec version 1.04. - - - - - The URI scheme for the UA HTTPS protocol. - - - - - The URI scheme for the UA TCP protocol. - - - - - The URI scheme for the UA TCP protocol over Secure WebSockets. - - - - - The URI scheme for the UDP protocol. - - - - - The URI scheme for the MQTT protocol. - - - - - The URI scheme for the MQTTS protocol. - - - - - The URI schemes which are supported in the core server. - - - - - The default port for the UA TCP protocol. - - - - - The default port for the UA TCP protocol over WebSockets. - - - - - The default port for the MQTT protocol. - - - - - The urls of the discovery servers on a node. - - - - - The default certificate store's type. - - - - - The path to the default certificate store. - - - - - The default LocalFolder. - - - - - The full name of the Opc.Ua.Core assembly. - - - - - The name of the Opc.Ua.Core assembly. - - - - - List of known default bindings hosted in other assemblies. - - - - - Returns true if the url starts with opc.https or https. - - The url - - - - The possible trace output mechanisms. - - - - - No tracing - - - - - Only write to file (if specified). Default for Release mode. - - - - - Write to debug trace listeners and a file (if specified). Default for Debug mode. - - - - - The masks used to filter trace messages. - - - - - Do not output any messages. - - - - - Output error messages. - - - - - Output informational messages. - - - - - Output stack traces. - - - - - Output basic messages for service calls. - - - - - Output detailed messages for service calls. - - - - - Output basic messages for each operation. - - - - - Output detailed messages for each operation. - - - - - Output messages related to application initialization or shutdown - - - - - Output messages related to a call to an external system. - - - - - Output messages related to security - - - - - Output all messages. - - - - - Sets the output for tracing (thread safe). - - - - - Gets the current trace mask settings. - - - - - Sets the mask for tracing (thread safe). - - - - - Returns Tracing class instance for event attaching. - - - - - Writes a trace statement. - - - - - Writes a trace statement. - - - - - Sets the path to the log file to use for tracing. - - - - - Writes an informational message to the trace log. - - - - - Writes an informational message to the trace log. - - - - - Writes an informational message to the trace log. - - - - - Writes an exception/error message to the trace log. - - - - - Writes an exception/error message to the trace log. - - - - - Create an exception/error message for a log. - - - - - Writes an exception/error message to the trace log. - - - - - Writes a message to the trace log. - - - - - Writes a message to the trace log. - - - - - Writes a message to the trace log. - - - - - Writes a message to the trace log. - - - - - Replaces a prefix enclosed in '%' with a special folder or environment variable path (e.g. %ProgramFiles%\MyCompany). - - - - - Maps a special folder to environment variable with folder path. - - - - - Replaces a prefix enclosed in '%' with a special folder or environment variable path (e.g. %ProgramFiles%\MyCompany). - - - - - Finds the file by search the common file folders and then bin directories in the source tree - - Name of the file. - The path to the file. Null if not found. - - - - Checks if the file path is a relative path and returns an absolute path relative to the EXE location. - - - - - Checks if the file path is a relative path and returns an absolute path relative to the EXE location. - - - - - Creates an empty file. - - - - - Checks if the file path is a relative path and returns an absolute path relative to the EXE location. - - - - - Checks if the file path is a relative path and returns an absolute path relative to the EXE location. - - - - - Truncates a file path so it can be displayed in a limited width view. - - - - - Supresses any exceptions while disposing the object. - - - Writes errors to trace output in DEBUG builds. - - - - - Supresses any exceptions while disposing the object. - - - Writes errors to trace output in DEBUG builds. - - - - - The earliest time that can be represented on with UA date/time values. - - - - - Normalize a DateTime to Opc Ua UniversalTime. - - - - - Returns an absolute deadline for a timeout. - - - - - Returns a timeout as integer number of milliseconds - - - - - - - - - - - If the platform returns a FQDN, only the host name is returned. - - - - Get the FQDN of the local computer. - - - - - Normalize ipv4/ipv6 address for comparisons. - - - - - Replaces the localhost domain with the current host name. - - - - - Replaces the cert subject name DC=localhost with the current host name. - - - - - Parses a URI string. Returns null if it is invalid. - - - - - Parses the URLs, returns true of they have the same domain. - - The first URL to compare. - The second URL to compare. - True if they have the same domain. - - - - Checks if the domains are equal. - - The first domain to compare. - The second domain to compare. - True if they are equal. - - - - Substitutes the local machine name if "localhost" is specified in the instance uri. - - - - - Sets the identifier to a lower limit if smaller. Thread safe. - - Returns the new value. - - - - Increments a identifier (wraps around if max exceeded). - - - - - Increments a identifier (wraps around if max exceeded). - - - - - Safely converts an UInt32 identifier to a Int32 identifier. - - - - - Safely converts an Int32 identifier to a UInt32 identifier. - - - - - Converts a multidimension array to a flat array. - - - The higher rank dimensions are written first. - e.g. a array with dimensions [2,2,2] is written in this order: - [0,0,0], [0,0,1], [0,1,0], [0,1,1], [1,0,0], [1,0,1], [1,1,0], [1,1,1] - - - - - Converts a buffer to a hexadecimal string. - - - - - Converts a hexadecimal string to an array of bytes. - - - - - Formats an object using the invariant locale. - - - - - Formats a message using the invariant locale. - - - - - Checks if a string is a valid locale identifier. - - - - - Returns the language identifier from a locale. - - - - - Returns the localized text from a list of available text - - - - - Returns a deep copy of the value. - - - - - Checks if two identities are equal. - - - - - Checks if two DateTime values are equal. - - - - - Checks if two values are equal. - - - - - Tests if the specified string matches the specified pattern. - - - - - Returns the TimeZone information for the current local time. - - The TimeZone information for the current local time. - - - - Looks for an extension with the specified type and uses the DataContractSerializer to parse it. - - The type of extension. - The list of extensions to search. - Name of the element (use type name if null). - - The deserialized extension. Null if an error occurs. - - - - - Looks for an extension with the specified type and uses the DataContractSerializer to serializes its replacement. - - The type of the extension. - The list of extensions to update. - Name of the element (use type name if null). - The value. - - Adds a new extension if the it does not already exist. - Deletes the extension if the value is null. - The containing element must use the name and namespace uri specified by the DataContractAttribute for the type. - - - - - Returns the public static field names for a class. - - - - - Returns the data member name for a property. - - - - - Returns the numeric constant associated with a name. - - - - - Returns the linker timestamp for an assembly. - - - - - Returns the major/minor version number for an assembly formatted as a string. - - - - - Returns the build/revision number for an assembly formatted as a string. - - - - - Returns a XmlReaderSetting with safe defaults. - DtdProcessing Prohibited, XmlResolver disabled and - ConformanceLevel Document. - - - - - Returns a XmlWriterSetting with deterministic defaults across .NET versions. - - - - - Safe version for assignment of InnerXml. - - The XmlDocument. - The Xml document string. - - - - Appends a list of byte arrays. - - - - - Creates a X509 certificate object from the DER encoded bytes. - - - - - Creates a X509 certificate collection object from the DER encoded bytes. - - The certificate data. - - - - - Compare Nonce for equality. - - - - - Cryptographic Nonce helper functions. - - - - - Generates a Nonce for cryptographic functions. - - - - - Returns the length of the symmetric encryption key for a security policy. - - - - - Validates the nonce for a message security mode and security policy. - - - - - Validates the nonce for a message security mode and a minimum length. - - - - - Generates a Pseudo random sequence of bits using the P_SHA1 alhorithm. - - - - - Generates a Pseudo random sequence of bits using the P_SHA256 alhorithm. - - - - - Generates a Pseudo random sequence of bits using the HMAC algorithm. - - - - - Checks if the target is in the list. Comparisons ignore case. - - - - - Lazy helper to allow runtime check for Mono. - - - - - Determine if assembly uses mono runtime. - - true if running on Mono runtime - - - - A thread safe table of string constants. - - - - - Creates an empty collection. - - - - - Creates an empty collection which is marked as shared. - - - - - Copies a list of strings. - - - - - The synchronization object. - - - - - Returns a unique identifier for the table instance. Used to debug problems with shared tables. - - - - - Updates the table of namespace uris. - - - - - Adds a string to the end of the table. - - - - - Returns the namespace uri at the specified index. - - - - - Returns the index of the specified namespace uri. - - - - - Returns the index of the specified namespace uri, adds it if it does not exist. - - - - - Returns the contexts of the table. - - - - - Returns the number of entries in the table. - - - - - Creates a mapping between the URIs in a source table and the indexes in the current table. - - The string table to map. - if set to true if missing URIs should be added to the current tables. - A list of indexes in the current table. - - - - The table of namespace uris for a server. - - - - - Creates an empty collection. - - - - - Creates an empty collection which is marked as shared. - - - - - Copies a list of strings. - - - - - Updates the table of namespace uris. - - - - - A class that stores a numeric range. - - - A class that stores a numeric range. - - - - - Initializes the object with a begin index. - - - Initializes the object with a begin index. - - The starting point of the range - Thrown when the parameter is less than -1 - - - - Initializes the object with a begin and end indexes. - - - Initializes the object with a begin and end indexes. - - The end of the range - The beginning of the range - - - - The begining of the numeric range. - - - The begining of the numeric range. - - Thrown when the value is less than -1, or when the value is greater than the end - - - - The end of the numeric range. - - - The end of the numeric range. - - Thrown when the value is less - than -1 or when the end is less than the beginning - - - - The number of elements specified by the range. - - - The number of elements specified by the range. - - - - - Gets the number of dimensions in the range. - - The number of dimensions. - - - - Gets or sets the sub ranges for multidimensional ranges. - - The sub ranges. - - - - Ensures the bounds are valid values for the object passed in. - - - Returns false if the object is not indexable or if the numeric range is out-of-bounds. - - The value to check - - - - Ensures the bounds are valid values for a collection with the specified length. - - - Returns false if the numeric range is out-of-bounds. - - The value to check is within range - - - - Returns true if the objects are equal. - - - Returns true if the objects are equal. - - The object to test against this - - - - Returns true if the objects are equal. - - - Returns true if the objects are equal. - - The NumericRange to test against this - - - - Returns true if the objects are equal. - - - Returns true if the objects are equal. - - The first value to compare - The second value to compare - - - - Returns true if the objects are not equal. - - - Returns true if the objects are not equal. - - The first value to compare - The second value to compare - - - - Returns a suitable hash code for the object. - - - Returns a suitable hash code for the object. - - - - - Returns the string representation of the object. - - - Returns the string representation of the object. - - - - - Formats the numeric range as a string. - - - Formats the numeric range as a string. - - (Unused) Always pass NULL/NOTHING - (Unused) Always pass NULL/NOTHING - Thrown when a non null/nothing is passed for either parameter - - - - An empty numeric range. - - - An empty numeric range. - - - - - Parses a string representing a numeric range. - - The text to parse, prior to checking it is within the allowed range - The parsed range. - The reason for any error. - - - - Applies the multidimensional index range. - - - - - Applies the multidimensional index range. - - - - - Applys the index range to an array value. - - - Replaces the value - - The array to subset. - The reason for the failure if the range could not be applied. - - - - Parses a string representing a numeric range. - - - Parses a string representing a numeric range. - - The text to parse, prior to checking it is within the allowed range - Thrown when the numeric value of the parsed text is out of range - - - - Event source for high performance logging. - - - - - The core event ids. - - - - - The core messages. - - - - - The Core ILogger event Ids used for event messages, when calling back to ILogger. - - - - - The task definitions. - - - - - Service Call Activity. - - - - - The keywords for message filters. - - - - - Turns on the 'FormatMessage' event when ILogger.Log() is called. It gives the formatted string version of the information. - - - - - Services events. - - - - - - - - - - - - - - - - - - - - - - - The helper to write the formatted message as event. - - - - - - - - - A server service call message. - - - - - The server service completed message. - - - - - A service message completed with a bad status code. - - - - - A service fault message. - - - - - The send response of a server channel. - - - - - A template list class that can be used to expose members of immutable classes. - - - - - Wraps an exising list. - - - - - Makes a shallow copy of an exising list. - - - - - The number of items in the list. - - - - - Adds new item to the list (not supported). - - - - - Removes all item from the list (not supported). - - - - - Returns true if the item is in the list. - - - - - Copies the elements of the list to an array. - - - - - Indicates that the list is read only. - - - - - Removes an item from the list (not supported). - - - - - Returns the list of the specified item in the list. - - - - - Inserts an item into the list (not supported). - - - - - Removes an item from the list (not supported). - - - - - Gets the item at the specified index. - - - - - Returns an enumerator for the list. - - - - - Returns an enumerator for the list. - - - - - Creates a read-only list from a list. - - The list of values. - The read-only list. - - - - Creates a read-only list from a list. - - The list of values. - The read-only list. - - - - Adds an item to the . - - - - - Removes all items from the . - - - - - Determines whether the contains a specific value. - - - - - Determines the index of a specific item in the . - - - - - Inserts an item to the at the specified index. - - - - - Gets a value indicating whether the has a fixed size. - - - - - Gets a value indicating whether the is read-only. - - - - - Removes the first occurrence of a specific object from the . - - - - - Removes the item at the specified index. - - - - - Gets or sets the at the specified index. - - - - - Copies the elements of the to an , starting at a particular index. - - - - - Gets the number of elements contained in the . - - - - - Gets a value indicating whether access to the is synchronized (thread safe). - - - - - Gets an object that can be used to synchronize access to the . - - - - - A class that stores a relative path string - - - - - Initializes the object the default values. - - - - - Initializes the object the default values. - - - - - The elements in the relative path. - - - The elements in the relative path. - - - - - Updates the namespace table with URI used in the relative path. - - The current table. - The target table. - - - - Updates the path to use the indexes from the target table. - - The NamespaceTable which the RelativePathString currently references - The NamespaceTable which the RelativePathString should reference - - - - Formats the relative path as a string. - - - Formats the relative path as a string. - - - - - Formats the relative path as a string. - - - Formats the relative path as a string. - - (Unused) Always pass null - (Unused) Always pass null - Thrown if non-null parameters are passed - - - - Returns true if the relative path does not specify any elements. - - - - - Parses a string representing a relative path and translates the namespace indexes. - - - Parses a string representing a relative path. - - Thrown if any errors occur during parsing - - - - Parses a string representing a relative path. - - - Parses a string representing a relative path. - - Thrown if any errors occur during parsing - - - - A element in a relative path string. - - - - - Initializes the object from a RelativePathElement - - - - - Initializes the object the default values. - - - - - The type of element. - - - - - The browse name of the reference type to follow. - - - - - Whether to include subtypes of the reference type. - - - - - The browse name of the target to find. - - - - - Formats the relative path element as a string. - - - - - Formats the numeric range as a string. - - (Unused) Always pass null - (Unused) Always pass null - Thrown if non-null parameters are passed - - - - Extracts a relative path element from a string. - - The string read stream containing the text to convert to a RelativePathStringElement - - - - Extracts a browse name with an optional namespace prefix from the reader. - - - - - Encodes a name using the relative path syntax. - - - - - The type of relative path element. - - - - - Any hierarchial reference should be followed ('/'). - - - - - Any component reference should be followed ('.'). - - - - - The forward reference identified by the browse name should be followed. - - - - - The inverse reference identified by the browse name should be followed. - - - - - Stores context information associated with a UA server that is used during message processing. - - - - - Initializes the object with default values. - - - - - The default context for the process (used only during XML serialization). - - - - - The default context for the thread (used only during XML serialization). - - - - - Returns the object used to synchronize access to the context. - - - - - The maximum length for any string, byte string or xml element. - - - - - The maximum length for any array. - - - - - The maximum length for any ByteString. - - - - - The maximum length for any Message. - - - - - The maximum nesting level accepted while encoding or decoding objects. - - - - - The table of namespaces used by the server. - - - - - The table of servers used by the server. - - - - - The factory used to create encodeable objects. - - - - - A class that combines the status code and diagnostic info structures. - - - - - Initializes the object with default values. - - - - - Constructs a object by specifying each property. - - - - - Copy constructor taking an inner result as second argument, to build chains of service results. - - - - - - - Constructs a object by specifying each property. - - - - - Constructs a object by specifying each property. - - - - - Constructs a object by specifying each property. - - - - - Constructs a object by specifying each property. - - - - - Constructs a object by specifying each property. - - - - - Constructs a object by specifying each property. - - - - - Constructs a object from a StatusCode. - - - - - Constructs a object from a StatusCode. - - - - - Constructs a object by specifying each property. - - - The innerException is used to construct the inner result. - - - - - Constructs a object by specifying each property. - - - The innerException is used to construct the innerResult. - - - - - Constructs a object by specifying each property. - - - The innerException is used to construct the innerResult. - - - - - Constructs a object by specifying each property. - - - The innerException is used to construct the innerResult. - - - - - Constructs a object by specifying each property. - - - The innerException is used to construct the innerResult. - - - - - Constructs a object from an exception. - - - The code, symbolicId, namespaceUri and localizedText parameters are ignored for ServiceResultExceptions. - - - - - Constructs a object from an exception. - - - The defaultCode and defaultLocalizedText parameters are ignored for ServiceResultExceptions. - - - - - Constructs a object from an exception. - - - The code, symbolicId and namespaceUri parameters are ignored for ServiceResultExceptions. - - - - - Constructs a object from an exception. - - - The code parameter is ignored for ServiceResultExceptions. - - - - - Constructs a object from an exception. - - - - - Initializes the object with a status code and a diagnostic info structure. - - - - - Initializes the object with a status code and a diagnostic info structure. - - - - - A result representing a good status. - - - - - Creates a new instance of a ServiceResult - - - - - Creates a new instance of a ServiceResult - - - - - Creates a new instance of a ServiceResult - - - - - Creates a new instance of a ServiceResult - - - - - Returns true if the status code is good. - - - - - Returns true if the status is bad or uncertain. - - - - - Returns true if the status code is uncertain. - - - - - Returns true if the status is good or uncertain. - - - - - Returns true if the status code is bad. - - - - - Returns true if the status is good or uncertain. - - - - - Converts a 32-bit code a ServiceResult object. - - - - - Converts a StatusCode a ServiceResult object. - - - - - Converts a StatusCode object to a 32-bit code. - - - - - Looks up the symbolic name for a status code. - - - - - Returns a string containing all nested exceptions. - - - - - The status code associated with the result. - - - - - The status code associated with the result. - - - - - The namespace that qualifies symbolic identifier. - - - - - The qualified name of the symbolic identifier associated with the status code. - - - - - The localized description for the status code. - - - - - Additional diagnostic/debugging information associated with the operation. - - - - - Nested error information. - - - - - Converts the value to a human readable string. - - - - - Returns a formatted string with the contents of exception. - - - - - Looks up a string in a string table. - - - - - Extract a default message from an exception. - - - - - - An exception thrown when a UA defined error occurs. - - - - - The default constructor. - - - - - Initializes the exception with a message. - - - - - Initializes the exception with a message and an exception. - - - - - Initializes the exception with a message and an exception. - - - - - Initializes the exception with a status code. - - - - - Initializes the exception with a status code and a message. - - - - - Initializes the exception with a status code and an inner exception. - - - - - Initializes the exception with a status code, a message and an inner exception. - - - - - Initializes the exception with a Result object. - - - - - The identifier for the status code. - - - - - The namespace that qualifies symbolic identifier. - - - - - The qualified name of the symbolic identifier associated with the status code. - - - - - The localized description for the status code. - - - - - Additional diagnostic/debugging information associated with the operation. - - - - - Returns the status result associated with the exception. - - - - - Nested error information. - - - - - Returns a formatted string with the contents of exception. - - - - - Creates a new instance of a ServiceResultException - - - - - Creates a new instance of a ServiceResultException - - - - - Creates a new instance of a ServiceResultException - - - - - Extracts an exception message from a Result object. - - - - - Wraps string constants defined in the class. - - - - - The event arguments provided when a trace event is raised. - - - - - Initializes a new instance of the TraceEventArgs class. - - The trace mask. - The format. - The message. - The exception. - The arguments. - - - - Gets the trace mask. - - - - - Gets the format. - - - - - Gets the arguments. - - - - - Gets the message. - - - - - Gets the exception. - - - - - The TraceEvent logger calls the legacy Utils.Trace API to - support applications which use TraceEvent or file/debug logging. - - - - - Set the log level - - - - - - - - - - - - - - Used as underlying tracing object for event processing. - - - - - Private constructor. - - - - - Whether the Trace Event Handler is active. - - - - - Public Singleton Instance getter. - - - - - Occurs when a trace call is made. - - - - - The set of built-in data types for UA type descriptions. - - - An enumeration that lists all of the built-in data types for OPC UA Type Descriptions. - - - - - An invalid or unspecified value. - - - - - A boolean logic value (true or false). - - - - - An 8 bit signed integer value. - - - - - An 8 bit unsigned integer value. - - - - - A 16 bit signed integer value. - - - - - A 16 bit signed integer value. - - - - - A 32 bit signed integer value. - - - - - A 32 bit unsigned integer value. - - - - - A 64 bit signed integer value. - - - - - A 64 bit unsigned integer value. - - - - - An IEEE single precision (32 bit) floating point value. - - - - - An IEEE double precision (64 bit) floating point value. - - - - - A sequence of Unicode characters. - - - - - An instance in time. - - - - - A 128-bit globally unique identifier. - - - - - A sequence of bytes. - - - - - An XML element. - - - - - An identifier for a node in the address space of a UA server. - - - - - A node id that stores the namespace URI instead of the namespace index. - - - - - A structured result code. - - - - - A string qualified with a namespace. - - - - - A localized text string with an locale identifier. - - - - - An opaque object with a syntax that may be unknown to the receiver. - - - - - A data value with an associated quality and timestamp. - - - - - Any of the other built-in types. - - - - - A diagnostic information associated with a result code. - - - - - The following BuiltInTypes are for coding convenience - internally used in the .NET Standard library. - The enumerations are not used for encoding/decoding. - - - Any numeric value. - - - - - A signed integer. - - - - - An unsigned integer. - - - - - An enumerated value - - - - - Stores information about a type. - - - - - Constructs an unknown type. - - - - - Construct the object with a built-in type and a value rank. - - Type of the built in. - The value rank. - - - - Returns the data type id that describes a value. - - The value instance to check the data type. - An data type identifier for a node in a server's address space. - - - - Returns the data type id that describes a value. - - The framework type. - An data type identifier for a node in a server's address space. - - - - Returns the data type id that describes a value. - - The type info. - An data type identifier for a node in a server's address space. - - - - Returns the array rank for a value. - - The value instance to check the array rank. - The array rank of the - - - - Returns the array rank for a type. - - The framework type to check the array rank. - The array rank of the - - - - Returns the BuiltInType type for the DataTypeId. - - The data type identifier. - An for - - - - Returns true if the built-in type is a numeric type. - - The built-in type to check. - - True if the built-in type is a numeric type. - - - - - Returns true if the built-in type is a type that cannot be null. - - The built in type to check. - - True if the built-in type is a type that cannot be null. - - - - - Returns true if a 'null' value exists for the built-in type - in all data encodings. - - The built in type to check. - - True if the built-in type is a type that is nullable. - - - - - Returns the BuiltInType type for the DataTypeId. - - The data type identyfier for a node in a server's address space.. - The type tree for a server. . - - A value for - - - - - Returns the system type for the datatype. - - The datatype id. - The factory used to store and retrieve underlying OPC UA system types. - The system type for the . - - - - A constant representing an unknown type. - - The constant representing an unknown type. - - - - The built-in type. - - The type of the type represented by this instance. - - - - The value rank. - - The value rank of the type represented by this instance. - - - - Returns the type info if the value is an instance of the data type with the specified value rank. - - The value instance to check. - The expected data type identifier for a node. - The expected value rank. - The namespace URI's. - The type tree for a server. - - An data type info if the value is an instance of the data type with the specified value rank; otherwise null. - - - - - Returns the data type id that describes a value. - - The value to describe. - The namespace uris. - The type tree for a server. - Returns the data type identifier that describes a value. - - - - Returns the system type a scalar or array instance of the built-in type. - - A built-in type. - The value rank. - A system type equivalent to the built-in type. - - - - Returns the type info for the provided value. - - The value. - instance storing information about the type. - - - - Returns the type info for the specified system type. - - The specified system (framework) type. - instance storing information equivalent to the type. - - - - Returns the default value for the specified built-in type. - - The Built-in type. - The default value. - - - - Returns the default value for the specified data type and value rank. - - The data type. - The value rank. - The default value. - - - - Returns the default value for the specified data type and value rank. - - The data type. - The value rank. - The type tree for a server. - A default value. - - - - Returns the default value for the specified built-in type. - - The built-in type. - The dimensions. - The default value for the specified built-in type - - - - Casts a value to the specified target type. - - The instance of a source value. - Type of the target. - Return casted value. - if imposible to cast. - - - - Casts a value to the specified target type. - - The instance of a source value. - Type of the source. - Type of the target. - Return casted value. - if imposible to cast. - - - - Converts the array using the specified conversion function. - - The destination array (must have the same size as the source array). - The data type of the elements in the destination array. - The source array. - The data type of the elements in the source array. - The handler which does the conversion. - - - - Converts the array. - - The source array. - The type of the source array. - The type of the converted array. - The handler which does the conversion. - The converted array. - - - - A delegate for a function that converts an array element. - - The element to be converted. - The type of the source element. - The type of the converted value. - The converted - - - - Maps the type name to a built-in type. - - - - - Converts a value to a Boolean - - - - - Converts a value to a SByte - - - - - Converts a value to a Byte - - - - - Converts a value to a Int16 - - - - - Converts a value to a UInt16 - - - - - Converts a value to a Int32 - - - - - Converts a value to a UInt32 - - - - - Converts a value to a Int64 - - - - - Converts a value to a UInt64 - - - - - Converts a value to a Float - - - - - Converts a value to a Double - - - - - Converts a value to a String - - - - - Converts a value to a DateTime - - - - - Converts a value to a Guid - - - - - Converts a value to a ByteString - - - - - Converts a value to a XmlElement - - - - - Converts a value to a NodeId - - - - - Converts a value to a ExpandedNodeId - - - - - Converts a value to a StatusCode - - - - - Converts a value to a QualifiedName - - - - - Converts a value to a LocalizedText - - - - - Converts a value to a Variant - - - - - Delegate for a function used to cast a value to the specified type. - - - - - Casts a scalar or array value to the specified type. - - - - - Casts an array to an array of the specified type. - - - - - Constants for scalar types. - - - - - A boolean logic value (true or false). - - - - - An 8 bit signed integer value. - - - - - An 8 bit unsigned integer value. - - - - - A 16 bit signed integer value. - - - - - A 16 bit signed integer value. - - - - - A 32 bit signed integer value. - - - - - A 32 bit unsigned integer value. - - - - - A 64 bit signed integer value. - - - - - A 64 bit unsigned integer value. - - - - - An IEEE single precision (32 bit) floating point value. - - - - - An IEEE double precision (64 bit) floating point value. - - - - - A sequence of Unicode characters. - - - - - An instance in time. - - - - - A 128-bit globally unique identifier. - - - - - A sequence of bytes. - - - - - An XML element. - - - - - An identifier for a node in the address space of a UA server. - - - - - A node id that stores the namespace URI instead of the namespace index. - - - - - A structured result code. - - - - - A string qualified with a namespace. - - - - - A localized text string with an locale identifier. - - - - - An opaque object with a syntax that may be unknown to the receiver. - - - - - A data value with an associated quality and timestamp. - - - - - Any of the other built-in types. - - - - - A diagnostic information associated with a result code. - - - - - Constants for one dimensional array types. - - - - - A boolean logic value (true or false). - - - - - An 8 bit signed integer value. - - - - - An 8 bit unsigned integer value. - - - - - A 16 bit signed integer value. - - - - - A 16 bit signed integer value. - - - - - A 32 bit signed integer value. - - - - - A 32 bit unsigned integer value. - - - - - A 64 bit signed integer value. - - - - - A 64 bit unsigned integer value. - - - - - An IEEE single precision (32 bit) floating point value. - - - - - An IEEE double precision (64 bit) floating point value. - - - - - A sequence of Unicode characters. - - - - - An instance in time. - - - - - A 128-bit globally unique identifier. - - - - - A sequence of bytes. - - - - - An XML element. - - - - - An identifier for a node in the address space of a UA server. - - - - - A node id that stores the namespace URI instead of the namespace index. - - - - - A structured result code. - - - - - A string qualified with a namespace. - - - - - A localized text string with an locale identifier. - - - - - An opaque object with a syntax that may be unknown to the receiver. - - - - - A data value with an associated quality and timestamp. - - - - - Any of the other built-in types. - - - - - A diagnostic information associated with a result code. - - - - - Formats the type information as a string. - - - - - Formats the type information as a string. - - - - - Determines if the specified object is equal to the object. - - - Determines if the specified object is equal to the object. - - - - - Returns a suitable hash code. - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Security.Certificates.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Security.Certificates.dll deleted file mode 100644 index d5351b1..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Security.Certificates.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Security.Certificates.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Security.Certificates.xml deleted file mode 100644 index f7fadaa..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/Opc.Ua.Security.Certificates.xml +++ /dev/null @@ -1,1893 +0,0 @@ - - - - Opc.Ua.Security.Certificates - - - - - Utils for ASN.1 encoding and decoding. - - - - - Converts a buffer to a hexadecimal string. - - - - - Converts a hexadecimal string to an array of bytes. - - - - - Writer for Public Key parameters. - - - https://www.itu.int/rec/T-REC-X.690-201508-I/en - section 8.3 (Encoding of an integer value). - - The writer - The key parameter - - - - Parse a X509 Tbs and signature from a byte blob with validation, - return the byte array which contains the X509 blob. - - The encoded CRL or certificate sequence. - - - - Oid constants defined for ASN encoding/decoding. - - - - - The Oid string of the Digital Signature Algorithm (DSA) subject public key. - - - - - The Oid string for the RSA encryption scheme with PKCS#1. - - - - - The Oid string for the RSA encryption scheme with OAEP. - - - - - The Oid string for the RSA encryption scheme with PSS. - - - - - The Oid string for RSA signature, PKCS#1 padding with SHA1 hash. - - - - - The Oid string for RSA signature, PKCS#1 padding with SHA256 hash. - - - - - The Oid string for RSA signature, PKCS#1 padding with SHA384 hash. - - - - - The Oid string for RSA signature, PKCS#1 padding with SHA512 hash. - - - - - The Oid string for a EC public key. - - - - - The Oid string for ECDsa signature with SHA1 hash. - - - - - The Oid string for ECDsa signature with SHA256 hash. - - - - - The Oid string for ECDsa signature with SHA384 hash. - - - - - The Oid string for ECDsa signature with SHA512 hash. - - - - - The Oid string for the CRL extension of a CRL Number. - - - - - The Oid string for the CRL extension of a CRL Reason Code. - - - - - The Oid string for Transport Layer Security(TLS) World Wide Web(WWW) - server authentication. - - - - - The Oid string for Transport Layer Security(TLS) World Wide Web(WWW) - client authentication. - - - - - The Oid string for Authority Information access. - - - - - The Oid string for Online Certificate Status Protocol. - - - - - The Oid string for Certificate Authority Issuer. - - - - - The Oid string for CRL Distribution Point. - - - - - Get the RSA oid for a hash algorithm signature. - - The hash algorithm name. - - - - Get the ECDsa oid for a hash algorithm signature. - - The hash algorithm name. - - - - Get the hash algorithm used to sign a certificate. - - The signature algorithm oid. - - - - The defaults used in the library for Certificates. - - - - - The default key size for RSA certificates in bits. - - - Supported values are 1024(deprecated), 2048, 3072 or 4096. - - - - - The min supported size for a RSA key. - - - - - The max supported size for a RSA key. - - - - - The default hash algorithm to use for signatures. - - - Supported values are SHA-1(deprecated) or 256, 384 and 512 for SHA-2. - - - - - The default lifetime of certificates in months. - - - - - The recommended min serial numbers length in octets. - - - - - The max serial numbers length in octets. - - - - - The Opc.Ua.Security.Certificates namespace defines classes which can be used to implement - functions to create X509 certificates, to encode and decode X509 Certificate Revocation Lists (CRL), - X509 Certificate Signing Requests (CSR) and related X509 extensions needed for the OPC UA certificate - specification. - - - - - - Stores the authority key identifier extension. - - - id-ce-authorityKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 35 } - AuthorityKeyIdentifier ::= SEQUENCE { - keyIdentifier[0] KeyIdentifier OPTIONAL, - authorityCertIssuer[1] GeneralNames OPTIONAL, - authorityCertSerialNumber[2] CertificateSerialNumber OPTIONAL - } - KeyIdentifier::= OCTET STRING - - - - - Creates an empty extension. - - - - - Creates an extension from ASN.1 encoded data. - - - - - Creates an extension from ASN.1 encoded data. - - - - - Build the X509 Authority Key extension. - - The subject key identifier - - - - Build the X509 Authority Key extension. - - - A null value for one of the parameters indicates that the optional - identifier can be ignored. Only keyId should be used for PKI use. - - The subject key identifier as a byte array. - The distinguished name of the issuer. - The serial number of the issuer certificate as little endian byte array. - - - - Creates an extension from ASN.1 encoded data. - - - - - Returns a formatted version of the Authority Key Identifier as a string. - - - - - Initializes the extension from ASN.1 encoded data. - - - - - The OID for a Authority Key Identifier extension. - - - - - The alternate OID for a Authority Key Identifier extension. - - - - - The identifier for the key as a little endian hexadecimal string. - - - - - The identifier for the key as a byte array. - - - - - A list of distinguished names for the issuer. - - - - - The serial number of the authority key as a big endian hexadecimal string. - - - - - The serial number of the authority key as a byte array in little endian order. - - - - - Authority Key Identifier extension string - definitions see RFC 5280 4.2.1.1 - - - - - The CRL Number extension. - - - id-ce-cRLNumber OBJECT IDENTIFIER::= { id-ce 20 } - CRLNumber::= INTEGER(0..MAX) - - - - - Creates an empty extension. - - - - - Creates an extension from ASN.1 encoded data. - - - - - Creates an extension from an Oid and ASN.1 encoded raw data. - - - - - Creates an extension from ASN.1 encoded data. - - - - - Build the CRL Number extension (for CRL extensions). - - - - - Returns a formatted version of the Abstract Syntax Notation One (ASN.1)-encoded data as a string. - - - - - Initializes the extension from ASN.1 encoded data. - - - - - The OID for a CRL Number extension. - - - - - Gets the CRL Number. - - The uris. - - - - Encode the CRL Number extension. - - - - - Decode CRL Number. - - - - - CRL Number extension string - definitions see RFC 5280 5.2.3 - - - - - Supporting functions for X509 extensions. - - - - - Find a typed extension in a certificate. - - The type of the extension. - The certificate with extensions. - - - - Find a typed extension in a extension collection. - - The type of the extension. - The extensions to search. - - - - Build the Authority information Access extension. - - Array of CA Issuer Urls - optional, the OCSP responder - - - - Build the CRL Distribution Point extension. - - The CRL distribution point - - - - Build the CRL Distribution Point extension with multiple distribution points. - - The CRL distribution points - - - - Read an ASN.1 extension sequence as X509Extension object. - - The ASN reader. - - - - Write an extension object as ASN.1. - - - - - - - Build the CRL Reason extension. - - - - - Build the Authority Key Identifier from an Issuer CA certificate. - - The issuer CA certificate - - - - Build the CRL number. - - - - - Patch serial number in a Url. byte version. - - - - - Patch serial number in a Url. string version. - - - - - The subject alternate name extension. - - - - id-ce-subjectAltName OBJECT IDENTIFIER::= { id-ce 17 } - - SubjectAltName::= GeneralNames - - GeneralNames::= SEQUENCE SIZE(1..MAX) OF GeneralName - - GeneralName ::= CHOICE { - otherName [0] OtherName, - rfc822Name[1] IA5String, - dNSName[2] IA5String, - x400Address[3] ORAddress, - directoryName[4] Name, - ediPartyName[5] EDIPartyName, - uniformResourceIdentifier[6] IA5String, - iPAddress[7] OCTET STRING, - registeredID[8] OBJECT IDENTIFIER - } - - OtherName::= SEQUENCE { - type-id OBJECT IDENTIFIER, - value[0] EXPLICIT ANY DEFINED BY type - id - } - - EDIPartyName::= SEQUENCE { - nameAssigner[0] DirectoryString OPTIONAL, - partyName[1] DirectoryString - } - - - - - - Creates an empty extension. - - - - - Creates an extension from ASN.1 encoded data. - - - - - Creates an extension from an Oid and ASN.1 encoded raw data. - - - - - Creates an extension from ASN.1 encoded data. - - - - - Build the Subject Alternative name extension (for OPC UA application certs). - - The application Uri - The domain names. DNS Hostnames, IPv4 or IPv6 addresses - - - - Returns a formatted version of the Abstract Syntax Notation One (ASN.1)-encoded data as a string. - - - - - Initializes the extension from ASN.1 encoded data. - - - - - The OID for a Subject Alternate Name extension. - - - - - The OID for a Subject Alternate Name 2 extension. - - - - - Gets the uris. - - The uris. - - - - Gets the domain names. - - The domain names. - - - - Gets the IP addresses. - - The IP addresses. - - - - Create a normalized IPv4 or IPv6 address from a 4 byte or 16 byte array. - - - - - Encode the Subject Alternative name extension. - - - - - Decode if RawData is yet undecoded. - - - - - Decode URI, DNS and IP from Subject Alternative Name. - - - Only general names relevant for Opc.Ua are decoded. - - - - - Initialize the Subject Alternative name extension. - - The application Uri - The general names. DNS Hostnames, IPv4 or IPv6 addresses - - - - Subject Alternate Name extension string - definitions see RFC 5280 4.2.1.7 - - - - - Builds a Certificate. - - - - - Create a Certificate builder. - - - - - Create a Certificate builder. - - - - - Initialize a Certificate builder. - - - - - Initialize a Certificate builder. - - - - - - - - - - - - - - Create a Pfx with a private key by combining - an existing X509Certificate2 and a RSA private key. - - - - - Creates a certificate signing request from an - existing certificate with a private key. - - - - - Create a new serial number and validate lifetime. - - - - - - Set all mandatory fields. - - The cert generator - - - - Create the extensions. - - The cert generator. - The public key to use for the extensions. - - - - Create the RSA certificate with a given public key. - - The signed certificate. - - - - Create the RSA certificate as Pfx byte array with a private key. - - - Returns the Pfx with certificate and private key. - - - - - Create a new random serial number. - - - - - Secure .Net Core Random Number generator wrapper for Bounce Castle. - Creates an instance of RNGCryptoServiceProvider or an OpenSSL based version on other OS. - - - - - Creates an instance of a crypthographic secure random number generator. - - - - - Dispose the random number generator. - - - - Add more seed material to the generator. Not needed here. - - - Add more seed material to the generator. Not needed here. - - - - Fills an array of bytes with a cryptographically strong - random sequence of values. - - Array to be filled. - - - - Fills an array of bytes with a cryptographically strong - random sequence of values. - - Array to receive bytes. - Index to start filling at. - Length of segment to fill. - - - - A converter class to create a X509Name object - from a X509Certificate subject. - - - Handles subtle differences in the string representation - of the .NET and the Bouncy Castle implementation. - - - - - Create the X509Name from a X500DistinguishedName - ASN.1 encoded distinguished name. - - The distinguished name. - - - - Create the X509Name from a distinguished name. - - The distinguished name. - - - - Create the X509Name from a distinguished name. - - Reverse the order of the names. - The distinguished name. - - - - Helper functions for X509 extensions using Org.BouncyCastle. - - - - - Build the Subject Alternate Name. - - - - - helper to build alternate name domains list for certs. - - - - - The signature factory for Bouncy Castle to sign a digest with a KeyVault key. - - - - - Constructor which also specifies a source of randomness to be used if one is required. - - The name of the signature algorithm to use. - The signature generator. - - - - - - - - - - Signs a Bouncy Castle digest stream with the .Net X509SignatureGenerator. - - - - - Ctor for the stream calculator. - - The X509SignatureGenerator to sign the digest. - The hash algorithm to use for the signature. - - - - The digest stream (MemoryStream). - - - - - Callback signs the digest with X509SignatureGenerator. - - - - - Helper for Bouncy Castle signing operation to store the result in a memory block. - - - - - - - - - - - - - - Helpers to create certificates, CRLs and extensions. - - - - - Create a Pfx blob with a private key by combining - a bouncy castle X509Certificate and a private key. - - - - - Helper to get the Bouncy Castle hash algorithm name by .NET name . - - - - - Get public key parameters from a X509Certificate2 - - - - - Get public key parameters from a RSA. - - - - - Get private key parameters from a X509Certificate2. - The private key must be exportable. - - - - - Get private key parameters from a RSA private key. - The private key must be exportable. - - - - - Get the serial number from a certificate as BigInteger. - - - - - Read the Common Name from a certificate. - - - - - Create secure temporary passcode. - - - - - Returns a RSA object with an imported public key. - - - - - Methods or read PEM data. - - - - - Import a private key from PEM. - - - - - Wrapper for a password string. - - - - - Write certificate data in PEM format. - - - Write certificate/crl data in PEM format. - - - - - Returns a byte array containing the private key in PEM format. - - - - - Returns a byte array containing the CRL in PEM format. - - - - - Returns a byte array containing the CSR in PEM format. - - - - - Returns a byte array containing the cert in PEM format. - - - - - Builds a Certificate. - - - - - Initialize a Certificate builder. - - - - - Initialize a Certificate builder. - - - - - Default constructor. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The issuer CA certificate. - - - - - Validate and adjust settings to avoid creation of invalid certificates. - - - - - Create a new cryptographic random serial number. - - - - - If the certificate is a CA. - - - - - The path length constraint to sue for a CA. - - - - - The serial number length in octets. - - - - - If the serial number is preset by the user. - - - - - The serial number as a little endian byte array. - - - - - The collection of X509Extension to add to the certificate. - - - - - The RSA public to use when if a certificate is signed. - - - - - The size of a RSA key pair to create. - - - - - The certificate builder interface. - - - - - The interface to set an issuer. - - - - - The interface to set a public key. - - - - - The interface to set key parameters. - - - - - The interface to create a certificate. - - - - - The interface to use a signature generator. - - - - - The interface to create a RSA based certifcate. - - - - - The interface to set the mandatory certificate - fields for a certificate builder. - - - - - Set the length of the serial number. - - - The length of the serial number shall - not exceed octets. - - - - - - Set the value of the serial number directly - using a byte array. - - - The length of the serial number shall - not exceed octets. - - The serial number as an array of bytes in little endian order. - - - - Create a new serial number and preserve - it until the certificate is created. - - - The serial number may be needed to create an extension. - This function makes it available before the - cert is created. - - - - - Set the date when the certificate becomes valid. - - The date. - - - - Set the certificate expiry date. - - The date after which the certificate is expired. - - - - Set the lifetime of the certificate using Timespan. - - The lifetime as . - - - - Set the lifetime of the certificate in month starting now. - - The lifetime in months. - - - - Set the hash algorithm to use for the signature. - - The hash algorithm name. - - - - Set the CA flag and the path length constraints of the certificate. - - - The path length constraint to use. - -1 corresponds to None, other values constrain the chain length. - - - - - Add an extension to the certificate in addition to the default extensions. - - - By default the following X509 extensions are added to a certificate, - some depending on certificate type: - CA/SubCA/OPC UA application: - X509BasicConstraintsExtension - X509SubjectKeyIdentifierExtension - X509AuthorityKeyIdentifierExtension - X509KeyUsageExtension - OPC UA application: - X509SubjectAltNameExtension - X509EnhancedKeyUsageExtension - Adding a default extension to the list overrides the default - value of the extensions. - Adding an extension with a already existing Oid overrides - the existing extension in the list. - - The extension to add - - - - The interface to select an issuer for the cert builder. - - - - - Set the issuer certificate which is used to sign the certificate. - - - The issuer certificate must contain a private key which matches - the selected sign algorithm if no generator is avilable. - If a is used for signing the - the issuer certificate can be set with a public key to create - the X509 extensions. - - The issuer certificate. - - - - The interface to select the RSA key size parameter. - - - - - Set the RSA key size in bits. - - The size of the RSA key. - - - - The interface to set a RSA public key for a certificate. - - - - - Set the public key using a ASN.1 encoded byte array. - - The public key as encoded byte array. - - - - Set the public key using a RSA public key. - - The RSA public key. - - - - The interface to create a certificate using the RSA algorithm. - - - - - Create the RSA certificate with signature. - - The signed certificate. - - - - The interface to create a certificate using a signature generator. - - - - - Create the RSA certificate with signature using an external generator. - - The signed certificate. - - - - Properties of a X.509v3 certificate. - - - - - The subject distinguished name from a certificate. - - - - - The distinguished name of the certificate issuer. - - - - - The date in UTC time on which a certificate becomes valid. - - - - - The date in UTC time after which a certificate is no longer valid. - - - - - The serial number of the certificate - as a big-endian hexadecimal string. - - - - - The serial number of the certificate - as an array of bytes in little-endian order. - - - - - The hash algorithm used to create the signature. - - - - - A collection of X509 extensions. - - - - - Utilities to create a Pfx. - - - - - The size of the block used to test a sign or encrypt operation. - - - - - Return the key usage flags of a certificate. - - - - - Verify RSA key pair of two certificates. - - - - - Creates a certificate from a PKCS #12 store with a private key. - - The raw PKCS #12 store data. - The password to use to access the store. - The certificate with a private key. - - - - Verify a RSA key pair using a encryption. - - - - - Verify a RSA key pair using a signature. - - - - - Builds a CRL. - - - - - Create a CRL builder initialized with a decoded CRL. - - The decoded CRL - - - - Initialize the CRL builder with Issuer. - - Issuer name - - - - Initialize the CRL builder with Issuer and hash algorithm. - - Issuer distinguished name - The signing algorithm to use. - - - - Create a CRL builder initialized with a decoded CRL. - - The decoded CRL - - - - Initialize the CRL builder with Issuer. - - Issuer name - - - - Initialize the CRL builder with Issuer and hash algorithm. - - Issuer distinguished name - The signing algorithm to use. - - - - Default constructor. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Set this update time. - - - - - Set next update time (optional). - - - - - Set the hash algorithm. - - - - - Add array of serialnumbers of revoked certificates. - - The array of serial numbers to revoke. - The revocation reason - - - - Add a revoked certificate. - - The certificate to revoke. - The revocation reason - - - - Add a revoked certificate. - - - - - Add a list of revoked certificate. - - - - - Add a revoked certificate. - - - - - Create the CRL with signature generator. - - The RSA or ECDsa signature generator to use. - The signed CRL. - - - - Create the CRL with signature for RSA. - - The signed CRL. - - - - Constructs Certificate Revocation List raw data in X509 ASN format. - - - CRL fields -- https://tools.ietf.org/html/rfc5280#section-5.1 - - CertificateList ::= SEQUENCE { - tbsCertList TBSCertList, - signatureAlgorithm AlgorithmIdentifier, - signatureValue BIT STRING - } - - TBSCertList ::= SEQUENCE { - version Version OPTIONAL, - -- if present, MUST be v2 - signature AlgorithmIdentifier, - issuer Name, - thisUpdate Time, - nextUpdate Time OPTIONAL, - revokedCertificates SEQUENCE OF SEQUENCE { - userCertificate CertificateSerialNumber, - revocationDate Time, - crlEntryExtensions Extensions OPTIONAL - -- if present, version MUST be v2 - } OPTIONAL, - crlExtensions [0] EXPLICIT Extensions OPTIONAL - -- if present, version MUST be v2 - } - - - - - Write either a UTC time or a Generalized time depending if DataTime is before or after 2050. - - The writer to write to. - The date time to write. - - - - CRL Reason codes. - - - id-ce-cRLReasons OBJECT IDENTIFIER ::= { id-ce 21 } - -- reasonCode::= { CRLReason } - CRLReason::= ENUMERATED { - unspecified(0), - keyCompromise(1), - cACompromise(2), - affiliationChanged(3), - superseded(4), - cessationOfOperation(5), - certificateHold(6), - --value 7 is not used - removeFromCRL(8), - privilegeWithdrawn(9), - aACompromise(10) } - - - - - Provides access to an X509 CRL object. - - - - - The name of the issuer for the CRL. - - - - - The name of the issuer for the CRL. - - - - - When the CRL was last updated. - - - - - When the CRL is due for its next update. - - - - - The hash algorithm used to sign the CRL. - - - - - The revoked user certificates - - - - - The X509Extensions of the CRL. - - - - - The raw data for the CRL. - - - - - Represents a revoked certificate in the - revoked certificates sequence of a CRL. - - - CRL fields -- https://tools.ietf.org/html/rfc5280#section-5.1 - - ... - revokedCertificates SEQUENCE OF SEQUENCE { - userCertificate CertificateSerialNumber, - revocationDate Time, - crlEntryExtensions Extensions OPTIONAL - -- if present, version MUST be v2 - } OPTIONAL, - ... - - - - - Construct revoked certificate with serialnumber, - actual UTC time and the CRL reason. - - The serial number - The reason for revocation - - - - Construct revoked certificate with serialnumber, - actual UTC time and the CRL reason. - - The serial number - The reason for revocation - - - - Construct minimal revoked certificate - with serialnumber and actual UTC time. - - - - - - Construct minimal revoked certificate - with serialnumber and actual UTC time. - - - - - - The serial number of the revoked certificate as - big endian hex string. - - - - - The serial number of the revoked user certificate - as a little endian byte array. - - - - - The UTC time of the revocation event. - - - - - The list of crl entry extensions. - - - - - Decodes a X509 CRL and provides access to information. - - - - - Loads a CRL from a file. - - - - - Loads a CRL from a memory buffer. - - - - - Create CRL from IX509CRL interface. - - - - - - Default constructor, also internal test hook. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Verifies the signature on the CRL. - - - - - Returns true if the certificate is revoked in the CRL. - - - - - Decode the complete CRL. - - The raw signed CRL - - - - Decode the Tbs of the CRL. - - The raw TbsCertList of the CRL. - - - - Read the time, UTC or local time - - - - The DateTime representing the tag - - - - Decode if RawData is yet undecoded. - - - - - A collection of X509CRL. - - - - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. - - - - - Create an empty X509CRL collection. - - - - - Create a crl collection from a single CRL. - - - - - Create a crl collection from a CRL collection. - - - - - Create a collection from an array. - - - - - Converts an array to a collection. - - - - - Converts an array to a collection. - - - - - Describes the three required fields of a X509 Certificate and CRL. - - - - - The field contains the ASN.1 data to be signed. - - - - - The signature of the data. - - - - - The encoded signature algorithm that was used for signing. - - - - - The signature algorithm as Oid string. - - - - - The hash algorithm used for signing. - - - - - Initialize and decode the sequence with binary ASN.1 encoded CRL or certificate. - - - - - - Initialize the X509 signature values. - - The data to be signed. - The signature of the data. - The algorithm used to create the signature. - - - - Encode Tbs with a signature in ASN format. - - X509 ASN format of EncodedData+SignatureOID+Signature bytes. - - - - Decoder for the signature sequence. - - The encoded CRL or certificate sequence. - - - - Verify the signature with the public key of the signer. - - - true if the signature is valid. - - - - Verify the signature with the RSA public key of the signer. - - - - - Verify the signature with the ECC public key of the signer. - - - - - Decode the algorithm that was used for encoding. - - The ASN.1 encoded algorithm oid. - - - - - Encode a ECDSA signature as ASN.1. - - The signature to encode as ASN.1 - - - - Decode a ECDSA signature from ASN.1. - - The signature to decode from ASN.1 - The keySize in bits. - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/OpenCvSharp.WpfExtensions.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/OpenCvSharp.WpfExtensions.dll deleted file mode 100644 index d7f952b..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/OpenCvSharp.WpfExtensions.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/OpenCvSharp.WpfExtensions.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/OpenCvSharp.WpfExtensions.xml deleted file mode 100644 index 66bc7cc..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/OpenCvSharp.WpfExtensions.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - OpenCvSharp.WpfExtensions - - - - - Static class which provides conversion between System.Windows.Media.Imaging.BitmapSource and IplImage - - - - - Converts Mat to BitmapSource. - - Input IplImage - BitmapSource - - - - Converts Mat to BitmapSource. - - Input IplImage - - - - - BitmapSource - - - - Converts System.Drawing.Bitmap to BitmapSource. - - Input System.Drawing.Bitmap - http://www.codeproject.com/Articles/104929/Bitmap-to-BitmapSource - BitmapSource - - - - Converts BitmapSource to Mat - - Input BitmapSource - IplImage - - - - Converts BitmapSource to Mat - - Input BitmapSource - Output Mat - - - - Copies pixel data from System.Windows.Media.Imaging.BitmapSource to IplImage instance - - - - - - - - Static class which provides conversion between System.Windows.Media.Imaging.WriteableBitmap and Mat - - - - - 指定したPixelFormatに適合するMatのチャンネル数を返す - - - - - - - 指定したPixelFormatに適合するMatTypeを返す - - - - - - - 指定したMatのビット深度・チャンネル数に適合するPixelFormatを返す - - - - - - - BGR -> RGB - - - - - - - Converts Mat to WriteableBitmap. - The arguments of this method corresponds the consructor of WriteableBitmap. - - Input Mat - Horizontal dots per inch - Vertical dots per inch - Pixel format of output WriteableBitmap - Bitmap palette - WriteableBitmap - - - - Converts Mat to WriteableBitmap (dpi=96, BitmapPalette=null) - - Input Mat - Pixel format of output WriteableBitmap - WriteableBitmap - - - - Converts Mat to WriteableBitmap (dpi=96, BitmapPalette=null) - - Input Mat - WriteableBitmap - - - - Converts Mat to WriteableBitmap. - This method is more efficient because new instance of WriteableBitmap is not allocated. - - Input Mat - Output WriteableBitmap - - - - Converts WriteableBitmap to IplImage - - Input WriteableBitmap - IplImage - - - - Converts WriteableBitmap to Mat - - Input WriteableBitmap - Output Mat - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/OpenCvSharp.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/OpenCvSharp.dll deleted file mode 100644 index 7a48f74..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/OpenCvSharp.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/OpenCvSharp.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/OpenCvSharp.xml deleted file mode 100644 index 2e23087..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/OpenCvSharp.xml +++ /dev/null @@ -1,38898 +0,0 @@ - - - - OpenCvSharp - - - - - OpenCV Functions of C++ I/F (cv::xxx) - - - - - The ratio of a circle's circumference to its diameter - - - - - - - - - - - - - - - 引数がnullの時はIntPtr.Zeroに変換する - - - - - - - converts rotation vector to rotation matrix or vice versa using Rodrigues transformation - - Input rotation vector (3x1 or 1x3) or rotation matrix (3x3). - Output rotation matrix (3x3) or rotation vector (3x1 or 1x3), respectively. - Optional output Jacobian matrix, 3x9 or 9x3, which is a matrix of partial derivatives of the output array components with respect to the input array components. - - - - converts rotation vector to rotation matrix using Rodrigues transformation - - Input rotation vector (3x1). - Output rotation matrix (3x3). - Optional output Jacobian matrix, 3x9, which is a matrix of partial derivatives of the output array components with respect to the input array components. - - - - converts rotation matrix to rotation vector using Rodrigues transformation - - Input rotation matrix (3x3). - Output rotation vector (3x1). - Optional output Jacobian matrix, 3x9, which is a matrix of partial derivatives of the output array components with respect to the input array components. - - - - computes the best-fit perspective transformation mapping srcPoints to dstPoints. - - Coordinates of the points in the original plane, a matrix of the type CV_32FC2 - Coordinates of the points in the target plane, a matrix of the type CV_32FC2 - Method used to computed a homography matrix. - Maximum allowed reprojection error to treat a point pair as an inlier (used in the RANSAC method only) - Optional output mask set by a robust method ( CV_RANSAC or CV_LMEDS ). Note that the input mask values are ignored. - The maximum number of RANSAC iterations. - Confidence level, between 0 and 1. - - - - - computes the best-fit perspective transformation mapping srcPoints to dstPoints. - - Coordinates of the points in the original plane - Coordinates of the points in the target plane - Method used to computed a homography matrix. - Maximum allowed reprojection error to treat a point pair as an inlier (used in the RANSAC method only) - Optional output mask set by a robust method ( CV_RANSAC or CV_LMEDS ). Note that the input mask values are ignored. - The maximum number of RANSAC iterations. - Confidence level, between 0 and 1. - - - - - computes the best-fit perspective transformation mapping srcPoints to dstPoints. - - Coordinates of the points in the original plane, a matrix of the type CV_32FC2 - Coordinates of the points in the target plane, a matrix of the type CV_32FC2 - Optional output mask set by a robust method ( CV_RANSAC or CV_LMEDS ). Note that the input mask values are ignored. - - - - - - - Computes RQ decomposition of 3x3 matrix - - 3x3 input matrix. - Output 3x3 upper-triangular matrix. - Output 3x3 orthogonal matrix. - Optional output 3x3 rotation matrix around x-axis. - Optional output 3x3 rotation matrix around y-axis. - Optional output 3x3 rotation matrix around z-axis. - - - - - Computes RQ decomposition of 3x3 matrix - - 3x3 input matrix. - Output 3x3 upper-triangular matrix. - Output 3x3 orthogonal matrix. - - - - - Computes RQ decomposition of 3x3 matrix - - 3x3 input matrix. - Output 3x3 upper-triangular matrix. - Output 3x3 orthogonal matrix. - Optional output 3x3 rotation matrix around x-axis. - Optional output 3x3 rotation matrix around y-axis. - Optional output 3x3 rotation matrix around z-axis. - - - - - Decomposes the projection matrix into camera matrix and the rotation martix and the translation vector - - 3x4 input projection matrix P. - Output 3x3 camera matrix K. - Output 3x3 external rotation matrix R. - Output 4x1 translation vector T. - Optional 3x3 rotation matrix around x-axis. - Optional 3x3 rotation matrix around y-axis. - Optional 3x3 rotation matrix around z-axis. - ptional three-element vector containing three Euler angles of rotation in degrees. - - - - Decomposes the projection matrix into camera matrix and the rotation martix and the translation vector - - 3x4 input projection matrix P. - Output 3x3 camera matrix K. - Output 3x3 external rotation matrix R. - Output 4x1 translation vector T. - Optional 3x3 rotation matrix around x-axis. - Optional 3x3 rotation matrix around y-axis. - Optional 3x3 rotation matrix around z-axis. - ptional three-element vector containing three Euler angles of rotation in degrees. - - - - Decomposes the projection matrix into camera matrix and the rotation martix and the translation vector - - 3x4 input projection matrix P. - Output 3x3 camera matrix K. - Output 3x3 external rotation matrix R. - Output 4x1 translation vector T. - - - - computes derivatives of the matrix product w.r.t each of the multiplied matrix coefficients - - First multiplied matrix. - Second multiplied matrix. - First output derivative matrix d(A*B)/dA of size A.rows*B.cols X A.rows*A.cols . - Second output derivative matrix d(A*B)/dB of size A.rows*B.cols X B.rows*B.cols . - - - - composes 2 [R|t] transformations together. Also computes the derivatives of the result w.r.t the arguments - - First rotation vector. - First translation vector. - Second rotation vector. - Second translation vector. - Output rotation vector of the superposition. - Output translation vector of the superposition. - Optional output derivatives of rvec3 or tvec3 with regard to rvec1, rvec2, tvec1 and tvec2, respectively. - Optional output derivatives of rvec3 or tvec3 with regard to rvec1, rvec2, tvec1 and tvec2, respectively. - Optional output derivatives of rvec3 or tvec3 with regard to rvec1, rvec2, tvec1 and tvec2, respectively. - Optional output derivatives of rvec3 or tvec3 with regard to rvec1, rvec2, tvec1 and tvec2, respectively. - Optional output derivatives of rvec3 or tvec3 with regard to rvec1, rvec2, tvec1 and tvec2, respectively. - Optional output derivatives of rvec3 or tvec3 with regard to rvec1, rvec2, tvec1 and tvec2, respectively. - Optional output derivatives of rvec3 or tvec3 with regard to rvec1, rvec2, tvec1 and tvec2, respectively. - Optional output derivatives of rvec3 or tvec3 with regard to rvec1, rvec2, tvec1 and tvec2, respectively. - - - - composes 2 [R|t] transformations together. Also computes the derivatives of the result w.r.t the arguments - - First rotation vector. - First translation vector. - Second rotation vector. - Second translation vector. - Output rotation vector of the superposition. - Output translation vector of the superposition. - Optional output derivatives of rvec3 or tvec3 with regard to rvec1, rvec2, tvec1 and tvec2, respectively. - Optional output derivatives of rvec3 or tvec3 with regard to rvec1, rvec2, tvec1 and tvec2, respectively. - Optional output derivatives of rvec3 or tvec3 with regard to rvec1, rvec2, tvec1 and tvec2, respectively. - Optional output derivatives of rvec3 or tvec3 with regard to rvec1, rvec2, tvec1 and tvec2, respectively. - Optional output derivatives of rvec3 or tvec3 with regard to rvec1, rvec2, tvec1 and tvec2, respectively. - Optional output derivatives of rvec3 or tvec3 with regard to rvec1, rvec2, tvec1 and tvec2, respectively. - Optional output derivatives of rvec3 or tvec3 with regard to rvec1, rvec2, tvec1 and tvec2, respectively. - Optional output derivatives of rvec3 or tvec3 with regard to rvec1, rvec2, tvec1 and tvec2, respectively. - - - - composes 2 [R|t] transformations together. Also computes the derivatives of the result w.r.t the arguments - - First rotation vector. - First translation vector. - Second rotation vector. - Second translation vector. - Output rotation vector of the superposition. - Output translation vector of the superposition. - - - - projects points from the model coordinate space to the image coordinates. - Also computes derivatives of the image coordinates w.r.t the intrinsic - and extrinsic camera parameters - - Array of object points, 3xN/Nx3 1-channel or - 1xN/Nx1 3-channel, where N is the number of points in the view. - Rotation vector (3x1). - Translation vector (3x1). - Camera matrix (3x3) - Input vector of distortion coefficients - (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, or 8 elements. - If the vector is null, the zero distortion coefficients are assumed. - Output array of image points, 2xN/Nx2 1-channel - or 1xN/Nx1 2-channel - Optional output 2Nx(10 + numDistCoeffs) jacobian matrix - of derivatives of image points with respect to components of the rotation vector, - translation vector, focal lengths, coordinates of the principal point and - the distortion coefficients. In the old interface different components of - the jacobian are returned via different output parameters. - Optional “fixed aspect ratio” parameter. - If the parameter is not 0, the function assumes that the aspect ratio (fx/fy) - is fixed and correspondingly adjusts the jacobian matrix. - - - - projects points from the model coordinate space to the image coordinates. - Also computes derivatives of the image coordinates w.r.t the intrinsic - and extrinsic camera parameters - - Array of object points, 3xN/Nx3 1-channel or - 1xN/Nx1 3-channel, where N is the number of points in the view. - Rotation vector (3x1). - Translation vector (3x1). - Camera matrix (3x3) - Input vector of distortion coefficients - (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, or 8 elements. - If the vector is null, the zero distortion coefficients are assumed. - Output array of image points, 2xN/Nx2 1-channel - or 1xN/Nx1 2-channel - Optional output 2Nx(10 + numDistCoeffs) jacobian matrix - of derivatives of image points with respect to components of the rotation vector, - translation vector, focal lengths, coordinates of the principal point and - the distortion coefficients. In the old interface different components of - the jacobian are returned via different output parameters. - Optional “fixed aspect ratio” parameter. - If the parameter is not 0, the function assumes that the aspect ratio (fx/fy) - is fixed and correspondingly adjusts the jacobian matrix. - - - - Finds an object pose from 3D-2D point correspondences. - - Array of object points in the object coordinate space, 3xN/Nx3 1-channel or 1xN/Nx1 3-channel, - where N is the number of points. vector<Point3f> can be also passed here. - Array of corresponding image points, 2xN/Nx2 1-channel or 1xN/Nx1 2-channel, - where N is the number of points. vector<Point2f> can be also passed here. - Input camera matrix - Input vector of distortion coefficients (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, or 8 elements. - If the vector is null, the zero distortion coefficients are assumed. - Output rotation vector that, together with tvec , brings points from the model coordinate system to the - camera coordinate system. - Output translation vector. - If true, the function uses the provided rvec and tvec values as initial approximations of - the rotation and translation vectors, respectively, and further optimizes them. - Method for solving a PnP problem: - - - - Finds an object pose from 3D-2D point correspondences. - - Array of object points in the object coordinate space, 3xN/Nx3 1-channel or 1xN/Nx1 3-channel, - where N is the number of points. vector<Point3f> can be also passed here. - Array of corresponding image points, 2xN/Nx2 1-channel or 1xN/Nx1 2-channel, - where N is the number of points. vector<Point2f> can be also passed here. - Input camera matrix - Input vector of distortion coefficients (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, or 8 elements. - If the vector is null, the zero distortion coefficients are assumed. - Output rotation vector that, together with tvec , brings points from the model coordinate system to the - camera coordinate system. - Output translation vector. - If true, the function uses the provided rvec and tvec values as initial approximations of - the rotation and translation vectors, respectively, and further optimizes them. - Method for solving a PnP problem - - - - computes the camera pose from a few 3D points and the corresponding projections. The outliers are possible. - - Array of object points in the object coordinate space, 3xN/Nx3 1-channel or 1xN/Nx1 3-channel, - where N is the number of points. List<Point3f> can be also passed here. - Array of corresponding image points, 2xN/Nx2 1-channel or 1xN/Nx1 2-channel, where N is the number of points. - List<Point2f> can be also passed here. - Input 3x3 camera matrix - Input vector of distortion coefficients (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, or 8 elements. - If the vector is null, the zero distortion coefficients are assumed. - Output rotation vector that, together with tvec , brings points from the model coordinate system - to the camera coordinate system. - Output translation vector. - If true, the function uses the provided rvec and tvec values as initial approximations - of the rotation and translation vectors, respectively, and further optimizes them. - Number of iterations. - Inlier threshold value used by the RANSAC procedure. - The parameter value is the maximum allowed distance between the observed and computed point projections to consider it an inlier. - The probability that the algorithm produces a useful result. - Output vector that contains indices of inliers in objectPoints and imagePoints . - Method for solving a PnP problem - - - - computes the camera pose from a few 3D points and the corresponding projections. The outliers are possible. - - Array of object points in the object coordinate space, 3xN/Nx3 1-channel or 1xN/Nx1 3-channel, - where N is the number of points. List<Point3f> can be also passed here. - Array of corresponding image points, 2xN/Nx2 1-channel or 1xN/Nx1 2-channel, where N is the number of points. - List<Point2f> can be also passed here. - Input 3x3 camera matrix - Input vector of distortion coefficients (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, or 8 elements. - If the vector is null, the zero distortion coefficients are assumed. - Output rotation vector that, together with tvec , brings points from the model coordinate system - to the camera coordinate system. - Output translation vector. - - - - computes the camera pose from a few 3D points and the corresponding projections. The outliers are possible. - - Array of object points in the object coordinate space, 3xN/Nx3 1-channel or 1xN/Nx1 3-channel, - where N is the number of points. List<Point3f> can be also passed here. - Array of corresponding image points, 2xN/Nx2 1-channel or 1xN/Nx1 2-channel, where N is the number of points. - List<Point2f> can be also passed here. - Input 3x3 camera matrix - Input vector of distortion coefficients (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, or 8 elements. - If the vector is null, the zero distortion coefficients are assumed. - Output rotation vector that, together with tvec , brings points from the model coordinate system - to the camera coordinate system. - Output translation vector. - If true, the function uses the provided rvec and tvec values as initial approximations - of the rotation and translation vectors, respectively, and further optimizes them. - Number of iterations. - Inlier threshold value used by the RANSAC procedure. - The parameter value is the maximum allowed distance between the observed and computed point projections to consider it an inlier. - The probability that the algorithm produces a useful result. - Output vector that contains indices of inliers in objectPoints and imagePoints . - Method for solving a PnP problem - - - - initializes camera matrix from a few 3D points and the corresponding projections. - - Vector of vectors (vector<vector<Point3d>>) of the calibration pattern points in the calibration pattern coordinate space. In the old interface all the per-view vectors are concatenated. - Vector of vectors (vector<vector<Point2d>>) of the projections of the calibration pattern points. In the old interface all the per-view vectors are concatenated. - Image size in pixels used to initialize the principal point. - If it is zero or negative, both f_x and f_y are estimated independently. Otherwise, f_x = f_y * aspectRatio . - - - - - initializes camera matrix from a few 3D points and the corresponding projections. - - Vector of vectors of the calibration pattern points in the calibration pattern coordinate space. In the old interface all the per-view vectors are concatenated. - Vector of vectors of the projections of the calibration pattern points. In the old interface all the per-view vectors are concatenated. - Image size in pixels used to initialize the principal point. - If it is zero or negative, both f_x and f_y are estimated independently. Otherwise, f_x = f_y * aspectRatio . - - - - - Finds the positions of internal corners of the chessboard. - - Source chessboard view. It must be an 8-bit grayscale or color image. - Number of inner corners per a chessboard row and column - ( patternSize = Size(points_per_row,points_per_colum) = Size(columns, rows) ). - Output array of detected corners. - Various operation flags that can be zero or a combination of the ChessboardFlag values - The function returns true if all of the corners are found and they are placed in a certain order (row by row, left to right in every row). - Otherwise, if the function fails to find all the corners or reorder them, it returns false. - - - - Finds the positions of internal corners of the chessboard. - - Source chessboard view. It must be an 8-bit grayscale or color image. - Number of inner corners per a chessboard row and column - ( patternSize = Size(points_per_row,points_per_colum) = Size(columns, rows) ). - Output array of detected corners. - Various operation flags that can be zero or a combination of the ChessboardFlag values - The function returns true if all of the corners are found and they are placed in a certain order (row by row, left to right in every row). - Otherwise, if the function fails to find all the corners or reorder them, it returns false. - - - - Checks whether the image contains chessboard of the specific size or not. - - - - - - - - Finds the positions of internal corners of the chessboard using a sector based approach. - - image Source chessboard view. It must be an 8-bit grayscale or color image. - Number of inner corners per a chessboard row and column - (patternSize = Size(points_per_row, points_per_column) = Size(columns, rows) ). - Output array of detected corners. - flags Various operation flags that can be zero or a combination of the ChessboardFlags values. - - - - - Finds the positions of internal corners of the chessboard using a sector based approach. - - image Source chessboard view. It must be an 8-bit grayscale or color image. - Number of inner corners per a chessboard row and column - (patternSize = Size(points_per_row, points_per_column) = Size(columns, rows) ). - Output array of detected corners. - flags Various operation flags that can be zero or a combination of the ChessboardFlags values. - - - - - finds subpixel-accurate positions of the chessboard corners - - - - - - - - - finds subpixel-accurate positions of the chessboard corners - - - - - - - - - Renders the detected chessboard corners. - - Destination image. It must be an 8-bit color image. - Number of inner corners per a chessboard row and column (patternSize = cv::Size(points_per_row,points_per_column)). - Array of detected corners, the output of findChessboardCorners. - Parameter indicating whether the complete board was found or not. The return value of findChessboardCorners() should be passed here. - - - - Renders the detected chessboard corners. - - Destination image. It must be an 8-bit color image. - Number of inner corners per a chessboard row and column (patternSize = cv::Size(points_per_row,points_per_column)). - Array of detected corners, the output of findChessboardCorners. - Parameter indicating whether the complete board was found or not. The return value of findChessboardCorners() should be passed here. - - - - Draw axes of the world/object coordinate system from pose estimation. - - Input/output image. It must have 1 or 3 channels. The number of channels is not altered. - Input 3x3 floating-point matrix of camera intrinsic parameters. - Input vector of distortion coefficients - \f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6[, s_1, s_2, s_3, s_4[, \tau_x, \tau_y]]]])\f$ of - 4, 5, 8, 12 or 14 elements.If the vector is empty, the zero distortion coefficients are assumed. - Rotation vector (see @ref Rodrigues ) that, together with tvec , brings points from - the model coordinate system to the camera coordinate system. - Translation vector. - Length of the painted axes in the same unit than tvec (usually in meters). - Line thickness of the painted axes. - This function draws the axes of the world/object coordinate system w.r.t. to the camera frame. - OX is drawn in red, OY in green and OZ in blue. - - - - Finds centers in the grid of circles. - - grid view of input circles; it must be an 8-bit grayscale or color image. - number of circles per row and column ( patternSize = Size(points_per_row, points_per_colum) ). - output array of detected centers. - various operation flags that can be one of the FindCirclesGridFlag values - feature detector that finds blobs like dark circles on light background. - - - - - Finds centers in the grid of circles. - - grid view of input circles; it must be an 8-bit grayscale or color image. - number of circles per row and column ( patternSize = Size(points_per_row, points_per_colum) ). - output array of detected centers. - various operation flags that can be one of the FindCirclesGridFlag values - feature detector that finds blobs like dark circles on light background. - - - - - finds intrinsic and extrinsic camera parameters from several fews of a known calibration pattern. - - In the new interface it is a vector of vectors of calibration pattern points in the calibration pattern coordinate space. - The outer vector contains as many elements as the number of the pattern views. If the same calibration pattern is shown in each view and - it is fully visible, all the vectors will be the same. Although, it is possible to use partially occluded patterns, or even different patterns - in different views. Then, the vectors will be different. The points are 3D, but since they are in a pattern coordinate system, then, - if the rig is planar, it may make sense to put the model to a XY coordinate plane so that Z-coordinate of each input object point is 0. - In the old interface all the vectors of object points from different views are concatenated together. - In the new interface it is a vector of vectors of the projections of calibration pattern points. - imagePoints.Count() and objectPoints.Count() and imagePoints[i].Count() must be equal to objectPoints[i].Count() for each i. - Size of the image used only to initialize the intrinsic camera matrix. - Output 3x3 floating-point camera matrix. - If CV_CALIB_USE_INTRINSIC_GUESS and/or CV_CALIB_FIX_ASPECT_RATIO are specified, some or all of fx, fy, cx, cy must be - initialized before calling the function. - Output vector of distortion coefficients (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, or 8 elements. - Output vector of rotation vectors (see Rodrigues() ) estimated for each pattern view. That is, each k-th rotation vector - together with the corresponding k-th translation vector (see the next output parameter description) brings the calibration pattern - from the model coordinate space (in which object points are specified) to the world coordinate space, that is, a real position of the - calibration pattern in the k-th pattern view (k=0.. M -1) - Output vector of translation vectors estimated for each pattern view. - Different flags that may be zero or a combination of the CalibrationFlag values - Termination criteria for the iterative optimization algorithm. - - - - - finds intrinsic and extrinsic camera parameters from several fews of a known calibration pattern. - - In the new interface it is a vector of vectors of calibration pattern points in the calibration pattern coordinate space. - The outer vector contains as many elements as the number of the pattern views. If the same calibration pattern is shown in each view and - it is fully visible, all the vectors will be the same. Although, it is possible to use partially occluded patterns, or even different patterns - in different views. Then, the vectors will be different. The points are 3D, but since they are in a pattern coordinate system, then, - if the rig is planar, it may make sense to put the model to a XY coordinate plane so that Z-coordinate of each input object point is 0. - In the old interface all the vectors of object points from different views are concatenated together. - In the new interface it is a vector of vectors of the projections of calibration pattern points. - imagePoints.Count() and objectPoints.Count() and imagePoints[i].Count() must be equal to objectPoints[i].Count() for each i. - Size of the image used only to initialize the intrinsic camera matrix. - Output 3x3 floating-point camera matrix. - If CV_CALIB_USE_INTRINSIC_GUESS and/or CV_CALIB_FIX_ASPECT_RATIO are specified, some or all of fx, fy, cx, cy must be - initialized before calling the function. - Output vector of distortion coefficients (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, or 8 elements. - Output vector of rotation vectors (see Rodrigues() ) estimated for each pattern view. That is, each k-th rotation vector - together with the corresponding k-th translation vector (see the next output parameter description) brings the calibration pattern - from the model coordinate space (in which object points are specified) to the world coordinate space, that is, a real position of the - calibration pattern in the k-th pattern view (k=0.. M -1) - Output vector of translation vectors estimated for each pattern view. - Different flags that may be zero or a combination of the CalibrationFlag values - Termination criteria for the iterative optimization algorithm. - - - - - computes several useful camera characteristics from the camera matrix, camera frame resolution and the physical sensor size. - - Input camera matrix that can be estimated by calibrateCamera() or stereoCalibrate() . - Input image size in pixels. - Physical width of the sensor. - Physical height of the sensor. - Output field of view in degrees along the horizontal sensor axis. - Output field of view in degrees along the vertical sensor axis. - Focal length of the lens in mm. - Principal point in pixels. - fy / fx - - - - computes several useful camera characteristics from the camera matrix, camera frame resolution and the physical sensor size. - - Input camera matrix that can be estimated by calibrateCamera() or stereoCalibrate() . - Input image size in pixels. - Physical width of the sensor. - Physical height of the sensor. - Output field of view in degrees along the horizontal sensor axis. - Output field of view in degrees along the vertical sensor axis. - Focal length of the lens in mm. - Principal point in pixels. - fy / fx - - - - finds intrinsic and extrinsic parameters of a stereo camera - - Vector of vectors of the calibration pattern points. - Vector of vectors of the projections of the calibration pattern points, observed by the first camera. - Vector of vectors of the projections of the calibration pattern points, observed by the second camera. - Input/output first camera matrix - Input/output vector of distortion coefficients (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, or 8 elements. - The output vector length depends on the flags. - Input/output second camera matrix. The parameter is similar to cameraMatrix1 . - Input/output lens distortion coefficients for the second camera. The parameter is similar to distCoeffs1 . - Size of the image used only to initialize intrinsic camera matrix. - Output rotation matrix between the 1st and the 2nd camera coordinate systems. - Output translation vector between the coordinate systems of the cameras. - Output essential matrix. - Output fundamental matrix. - Termination criteria for the iterative optimization algorithm. - Different flags that may be zero or a combination of the CalibrationFlag values - - - - - finds intrinsic and extrinsic parameters of a stereo camera - - Vector of vectors of the calibration pattern points. - Vector of vectors of the projections of the calibration pattern points, observed by the first camera. - Vector of vectors of the projections of the calibration pattern points, observed by the second camera. - Input/output first camera matrix - Input/output vector of distortion coefficients (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, or 8 elements. - The output vector length depends on the flags. - Input/output second camera matrix. The parameter is similar to cameraMatrix1 . - Input/output lens distortion coefficients for the second camera. The parameter is similar to distCoeffs1 . - Size of the image used only to initialize intrinsic camera matrix. - Output rotation matrix between the 1st and the 2nd camera coordinate systems. - Output translation vector between the coordinate systems of the cameras. - Output essential matrix. - Output fundamental matrix. - Termination criteria for the iterative optimization algorithm. - Different flags that may be zero or a combination of the CalibrationFlag values - - - - - computes the rectification transformation for a stereo camera from its intrinsic and extrinsic parameters - - First camera matrix. - First camera distortion parameters. - Second camera matrix. - Second camera distortion parameters. - Size of the image used for stereo calibration. - Rotation matrix between the coordinate systems of the first and the second cameras. - Translation vector between coordinate systems of the cameras. - Output 3x3 rectification transform (rotation matrix) for the first camera. - Output 3x3 rectification transform (rotation matrix) for the second camera. - Output 3x4 projection matrix in the new (rectified) coordinate systems for the first camera. - Output 3x4 projection matrix in the new (rectified) coordinate systems for the second camera. - Output 4x4 disparity-to-depth mapping matrix (see reprojectImageTo3D() ). - Operation flags that may be zero or CV_CALIB_ZERO_DISPARITY. - If the flag is set, the function makes the principal points of each camera have the same pixel coordinates in the rectified views. - And if the flag is not set, the function may still shift the images in the horizontal or vertical direction (depending on the orientation of epipolar lines) to maximize the useful image area. - Free scaling parameter. - If it is -1 or absent, the function performs the default scaling. Otherwise, the parameter should be between 0 and 1. - alpha=0 means that the rectified images are zoomed and shifted so that only valid pixels are visible (no black areas after rectification). - alpha=1 means that the rectified image is decimated and shifted so that all the pixels from the original images from the cameras are retained - in the rectified images (no source image pixels are lost). Obviously, any intermediate value yields an intermediate result between those two extreme cases. - New image resolution after rectification. The same size should be passed to initUndistortRectifyMap(). When (0,0) is passed (default), it is set to the original imageSize . - Setting it to larger value can help you preserve details in the original image, especially when there is a big radial distortion. - - - - computes the rectification transformation for a stereo camera from its intrinsic and extrinsic parameters - - First camera matrix. - First camera distortion parameters. - Second camera matrix. - Second camera distortion parameters. - Size of the image used for stereo calibration. - Rotation matrix between the coordinate systems of the first and the second cameras. - Translation vector between coordinate systems of the cameras. - Output 3x3 rectification transform (rotation matrix) for the first camera. - Output 3x3 rectification transform (rotation matrix) for the second camera. - Output 3x4 projection matrix in the new (rectified) coordinate systems for the first camera. - Output 3x4 projection matrix in the new (rectified) coordinate systems for the second camera. - Output 4x4 disparity-to-depth mapping matrix (see reprojectImageTo3D() ). - Operation flags that may be zero or CV_CALIB_ZERO_DISPARITY. - If the flag is set, the function makes the principal points of each camera have the same pixel coordinates in the rectified views. - And if the flag is not set, the function may still shift the images in the horizontal or vertical direction (depending on the orientation of epipolar lines) to maximize the useful image area. - Free scaling parameter. - If it is -1 or absent, the function performs the default scaling. Otherwise, the parameter should be between 0 and 1. - alpha=0 means that the rectified images are zoomed and shifted so that only valid pixels are visible (no black areas after rectification). - alpha=1 means that the rectified image is decimated and shifted so that all the pixels from the original images from the cameras are retained - in the rectified images (no source image pixels are lost). Obviously, any intermediate value yields an intermediate result between those two extreme cases. - New image resolution after rectification. The same size should be passed to initUndistortRectifyMap(). When (0,0) is passed (default), it is set to the original imageSize . - Setting it to larger value can help you preserve details in the original image, especially when there is a big radial distortion. - Optional output rectangles inside the rectified images where all the pixels are valid. If alpha=0 , the ROIs cover the whole images. - Otherwise, they are likely to be smaller. - Optional output rectangles inside the rectified images where all the pixels are valid. If alpha=0 , the ROIs cover the whole images. - Otherwise, they are likely to be smaller. - - - - computes the rectification transformation for a stereo camera from its intrinsic and extrinsic parameters - - First camera matrix. - First camera distortion parameters. - Second camera matrix. - Second camera distortion parameters. - Size of the image used for stereo calibration. - Rotation matrix between the coordinate systems of the first and the second cameras. - Translation vector between coordinate systems of the cameras. - Output 3x3 rectification transform (rotation matrix) for the first camera. - Output 3x3 rectification transform (rotation matrix) for the second camera. - Output 3x4 projection matrix in the new (rectified) coordinate systems for the first camera. - Output 3x4 projection matrix in the new (rectified) coordinate systems for the second camera. - Output 4x4 disparity-to-depth mapping matrix (see reprojectImageTo3D() ). - Operation flags that may be zero or CV_CALIB_ZERO_DISPARITY. - If the flag is set, the function makes the principal points of each camera have the same pixel coordinates in the rectified views. - And if the flag is not set, the function may still shift the images in the horizontal or vertical direction (depending on the orientation of epipolar lines) to maximize the useful image area. - Free scaling parameter. - If it is -1 or absent, the function performs the default scaling. Otherwise, the parameter should be between 0 and 1. - alpha=0 means that the rectified images are zoomed and shifted so that only valid pixels are visible (no black areas after rectification). - alpha=1 means that the rectified image is decimated and shifted so that all the pixels from the original images from the cameras are retained - in the rectified images (no source image pixels are lost). Obviously, any intermediate value yields an intermediate result between those two extreme cases. - New image resolution after rectification. The same size should be passed to initUndistortRectifyMap(). When (0,0) is passed (default), it is set to the original imageSize . - Setting it to larger value can help you preserve details in the original image, especially when there is a big radial distortion. - - - - computes the rectification transformation for a stereo camera from its intrinsic and extrinsic parameters - - First camera matrix. - First camera distortion parameters. - Second camera matrix. - Second camera distortion parameters. - Size of the image used for stereo calibration. - Rotation matrix between the coordinate systems of the first and the second cameras. - Translation vector between coordinate systems of the cameras. - Output 3x3 rectification transform (rotation matrix) for the first camera. - Output 3x3 rectification transform (rotation matrix) for the second camera. - Output 3x4 projection matrix in the new (rectified) coordinate systems for the first camera. - Output 3x4 projection matrix in the new (rectified) coordinate systems for the second camera. - Output 4x4 disparity-to-depth mapping matrix (see reprojectImageTo3D() ). - Operation flags that may be zero or CV_CALIB_ZERO_DISPARITY. - If the flag is set, the function makes the principal points of each camera have the same pixel coordinates in the rectified views. - And if the flag is not set, the function may still shift the images in the horizontal or vertical direction (depending on the orientation of epipolar lines) to maximize the useful image area. - Free scaling parameter. - If it is -1 or absent, the function performs the default scaling. Otherwise, the parameter should be between 0 and 1. - alpha=0 means that the rectified images are zoomed and shifted so that only valid pixels are visible (no black areas after rectification). - alpha=1 means that the rectified image is decimated and shifted so that all the pixels from the original images from the cameras are retained - in the rectified images (no source image pixels are lost). Obviously, any intermediate value yields an intermediate result between those two extreme cases. - New image resolution after rectification. The same size should be passed to initUndistortRectifyMap(). When (0,0) is passed (default), it is set to the original imageSize . - Setting it to larger value can help you preserve details in the original image, especially when there is a big radial distortion. - Optional output rectangles inside the rectified images where all the pixels are valid. If alpha=0 , the ROIs cover the whole images. - Otherwise, they are likely to be smaller. - Optional output rectangles inside the rectified images where all the pixels are valid. If alpha=0 , the ROIs cover the whole images. - Otherwise, they are likely to be smaller. - - - - computes the rectification transformation for an uncalibrated stereo camera (zero distortion is assumed) - - Array of feature points in the first image. - The corresponding points in the second image. - The same formats as in findFundamentalMat() are supported. - Input fundamental matrix. It can be computed from the same set - of point pairs using findFundamentalMat() . - Size of the image. - Output rectification homography matrix for the first image. - Output rectification homography matrix for the second image. - Optional threshold used to filter out the outliers. - If the parameter is greater than zero, all the point pairs that do not comply - with the epipolar geometry (that is, the points for which |points2[i]^T * F * points1[i]| > threshold ) - are rejected prior to computing the homographies. Otherwise, all the points are considered inliers. - - - - - computes the rectification transformation for an uncalibrated stereo camera (zero distortion is assumed) - - Array of feature points in the first image. - The corresponding points in the second image. - The same formats as in findFundamentalMat() are supported. - Input fundamental matrix. It can be computed from the same set - of point pairs using findFundamentalMat() . - Size of the image. - Output rectification homography matrix for the first image. - Output rectification homography matrix for the second image. - Optional threshold used to filter out the outliers. - If the parameter is greater than zero, all the point pairs that do not comply - with the epipolar geometry (that is, the points for which |points2[i]^T * F * points1[i]| > threshold ) - are rejected prior to computing the homographies. Otherwise, all the points are considered inliers. - - - - - computes the rectification transformations for 3-head camera, where all the heads are on the same line. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Returns the new camera matrix based on the free scaling parameter. - - Input camera matrix. - Input vector of distortion coefficients (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, or 8 elements. - If the array is null, the zero distortion coefficients are assumed. - Original image size. - Free scaling parameter between 0 (when all the pixels in the undistorted image are valid) - and 1 (when all the source image pixels are retained in the undistorted image). - Image size after rectification. By default,it is set to imageSize . - Optional output rectangle that outlines all-good-pixels region in the undistorted image. See roi1, roi2 description in stereoRectify() . - Optional flag that indicates whether in the new camera matrix the principal point - should be at the image center or not. By default, the principal point is chosen to best fit a - subset of the source image (determined by alpha) to the corrected image. - optimal new camera matrix - - - - Returns the new camera matrix based on the free scaling parameter. - - Input camera matrix. - Input vector of distortion coefficients (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, or 8 elements. - If the array is null, the zero distortion coefficients are assumed. - Original image size. - Free scaling parameter between 0 (when all the pixels in the undistorted image are valid) - and 1 (when all the source image pixels are retained in the undistorted image). - Image size after rectification. By default,it is set to imageSize . - Optional output rectangle that outlines all-good-pixels region in the undistorted image. See roi1, roi2 description in stereoRectify() . - Optional flag that indicates whether in the new camera matrix the principal point - should be at the image center or not. By default, the principal point is chosen to best fit a - subset of the source image (determined by alpha) to the corrected image. - optimal new camera matrix - - - - Computes Hand-Eye calibration. - - The function performs the Hand-Eye calibration using various methods. One approach consists in estimating the - rotation then the translation(separable solutions) and the following methods are implemented: - - R.Tsai, R.Lenz A New Technique for Fully Autonomous and Efficient 3D Robotics Hand/EyeCalibration \cite Tsai89 - - F.Park, B.Martin Robot Sensor Calibration: Solving AX = XB on the Euclidean Group \cite Park94 - - R.Horaud, F.Dornaika Hand-Eye Calibration \cite Horaud95 - - Another approach consists in estimating simultaneously the rotation and the translation(simultaneous solutions), - with the following implemented method: - - N.Andreff, R.Horaud, B.Espiau On-line Hand-Eye Calibration \cite Andreff99 - - K.Daniilidis Hand-Eye Calibration Using Dual Quaternions \cite Daniilidis98 - - Rotation part extracted from the homogeneous matrix that - transforms a pointexpressed in the gripper frame to the robot base frame that contains the rotation - matrices for all the transformationsfrom gripper frame to robot base frame. - Translation part extracted from the homogeneous matrix that transforms a point - expressed in the gripper frame to the robot base frame. - This is a vector(`vector<Mat>`) that contains the translation vectors for all the transformations - from gripper frame to robot base frame. - Rotation part extracted from the homogeneous matrix that transforms a point - expressed in the target frame to the camera frame. - This is a vector(`vector<Mat>`) that contains the rotation matrices for all the transformations - from calibration target frame to camera frame. - Rotation part extracted from the homogeneous matrix that transforms a point - expressed in the target frame to the camera frame. - This is a vector(`vector<Mat>`) that contains the translation vectors for all the transformations - from calibration target frame to camera frame. - Estimated rotation part extracted from the homogeneous matrix that transforms a point - expressed in the camera frame to the gripper frame. - Estimated translation part extracted from the homogeneous matrix that transforms a point - expressed in the camera frame to the gripper frame. - One of the implemented Hand-Eye calibration method - - - - Computes Robot-World/Hand-Eye calibration. - The function performs the Robot-World/Hand-Eye calibration using various methods. One approach consists in estimating the - rotation then the translation(separable solutions): - - M.Shah, Solving the robot-world/hand-eye calibration problem using the kronecker product \cite Shah2013SolvingTR - - [in] R_world2cam Rotation part extracted from the homogeneous matrix that transforms a point - expressed in the world frame to the camera frame. This is a vector of Mat that contains the rotation, - `(3x3)` rotation matrices or `(3x1)` rotation vectors,for all the transformations from world frame to the camera frame. - [in] Translation part extracted from the homogeneous matrix that transforms a point - expressed in the world frame to the camera frame. This is a vector (`vector<Mat>`) that contains the `(3x1)` - translation vectors for all the transformations from world frame to the camera frame. - [in] Rotation part extracted from the homogeneous matrix that transforms a point expressed - in the robot base frame to the gripper frame. This is a vector (`vector<Mat>`) that contains the rotation, - `(3x3)` rotation matrices or `(3x1)` rotation vectors, for all the transformations from robot base frame to the gripper frame. - [in] Rotation part extracted from the homogeneous matrix that transforms a point - expressed in the robot base frame to the gripper frame. This is a vector (`vector<Mat>`) that contains the - `(3x1)` translation vectors for all the transformations from robot base frame to the gripper frame. - [out] R_base2world Estimated `(3x3)` rotation part extracted from the homogeneous matrix - that transforms a point expressed in the robot base frame to the world frame. - [out] t_base2world Estimated `(3x1)` translation part extracted from the homogeneous matrix - that transforms a point expressed in the robot base frame to the world frame. - [out] R_gripper2cam Estimated `(3x3)` rotation part extracted from the homogeneous matrix - that transforms a point expressed in the gripper frame to the camera frame. - [out] Estimated `(3x1)` translation part extracted from the homogeneous matrix that - transforms a pointexpressed in the gripper frame to the camera frame. - One of the implemented Robot-World/Hand-Eye calibration method - - - - omputes Robot-World/Hand-Eye calibration. - The function performs the Robot-World/Hand-Eye calibration using various methods. One approach consists in estimating the - rotation then the translation(separable solutions): - - M.Shah, Solving the robot-world/hand-eye calibration problem using the kronecker product \cite Shah2013SolvingTR - - [in] R_world2cam Rotation part extracted from the homogeneous matrix that transforms a point - expressed in the world frame to the camera frame. This is a vector of Mat that contains the rotation, - `(3x3)` rotation matrices or `(3x1)` rotation vectors,for all the transformations from world frame to the camera frame. - [in] Translation part extracted from the homogeneous matrix that transforms a point - expressed in the world frame to the camera frame. This is a vector (`vector<Mat>`) that contains the `(3x1)` - translation vectors for all the transformations from world frame to the camera frame. - [in] Rotation part extracted from the homogeneous matrix that transforms a point expressed - in the robot base frame to the gripper frame. This is a vector (`vector<Mat>`) that contains the rotation, - `(3x3)` rotation matrices or `(3x1)` rotation vectors, for all the transformations from robot base frame to the gripper frame. - [in] Rotation part extracted from the homogeneous matrix that transforms a point - expressed in the robot base frame to the gripper frame. This is a vector (`vector<Mat>`) that contains the - `(3x1)` translation vectors for all the transformations from robot base frame to the gripper frame. - [out] R_base2world Estimated `(3x3)` rotation part extracted from the homogeneous matrix - that transforms a point expressed in the robot base frame to the world frame. - [out] t_base2world Estimated `(3x1)` translation part extracted from the homogeneous matrix - that transforms a point expressed in the robot base frame to the world frame. - [out] R_gripper2cam Estimated `(3x3)` rotation part extracted from the homogeneous matrix - that transforms a point expressed in the gripper frame to the camera frame. - [out] Estimated `(3x1)` translation part extracted from the homogeneous matrix that - transforms a pointexpressed in the gripper frame to the camera frame. - One of the implemented Robot-World/Hand-Eye calibration method - - - - converts point coordinates from normal pixel coordinates to homogeneous coordinates ((x,y)->(x,y,1)) - - Input vector of N-dimensional points. - Output vector of N+1-dimensional points. - - - - converts point coordinates from normal pixel coordinates to homogeneous coordinates ((x,y)->(x,y,1)) - - Input vector of N-dimensional points. - Output vector of N+1-dimensional points. - - - - converts point coordinates from normal pixel coordinates to homogeneous coordinates ((x,y)->(x,y,1)) - - Input vector of N-dimensional points. - Output vector of N+1-dimensional points. - - - - converts point coordinates from homogeneous to normal pixel coordinates ((x,y,z)->(x/z, y/z)) - - Input vector of N-dimensional points. - Output vector of N-1-dimensional points. - - - - converts point coordinates from homogeneous to normal pixel coordinates ((x,y,z)->(x/z, y/z)) - - Input vector of N-dimensional points. - Output vector of N-1-dimensional points. - - - - converts point coordinates from homogeneous to normal pixel coordinates ((x,y,z)->(x/z, y/z)) - - Input vector of N-dimensional points. - Output vector of N-1-dimensional points. - - - - Converts points to/from homogeneous coordinates. - - Input array or vector of 2D, 3D, or 4D points. - Output vector of 2D, 3D, or 4D points. - - - - Calculates a fundamental matrix from the corresponding points in two images. - - Array of N points from the first image. - The point coordinates should be floating-point (single or double precision). - Array of the second image points of the same size and format as points1 . - Method for computing a fundamental matrix. - Parameter used for RANSAC. - It is the maximum distance from a point to an epipolar line in pixels, beyond which the point is - considered an outlier and is not used for computing the final fundamental matrix. It can be set to - something like 1-3, depending on the accuracy of the point localization, image resolution, and the image noise. - Parameter used for the RANSAC or LMedS methods only. - It specifies a desirable level of confidence (probability) that the estimated matrix is correct. - Output array of N elements, every element of which is set to 0 for outliers and - to 1 for the other points. The array is computed only in the RANSAC and LMedS methods. For other methods, it is set to all 1’s. - fundamental matrix - - - - Calculates a fundamental matrix from the corresponding points in two images. - - Array of N points from the first image. - The point coordinates should be floating-point (single or double precision). - Array of the second image points of the same size and format as points1 . - Method for computing a fundamental matrix. - Parameter used for RANSAC. - It is the maximum distance from a point to an epipolar line in pixels, beyond which the point is - considered an outlier and is not used for computing the final fundamental matrix. It can be set to - something like 1-3, depending on the accuracy of the point localization, image resolution, and the image noise. - Parameter used for the RANSAC or LMedS methods only. - It specifies a desirable level of confidence (probability) that the estimated matrix is correct. - Output array of N elements, every element of which is set to 0 for outliers and - to 1 for the other points. The array is computed only in the RANSAC and LMedS methods. For other methods, it is set to all 1’s. - fundamental matrix - - - - Calculates a fundamental matrix from the corresponding points in two images. - - Array of N points from the first image. - The point coordinates should be floating-point (single or double precision). - Array of the second image points of the same size and format as points1 . - Method for computing a fundamental matrix. - Parameter used for RANSAC. - It is the maximum distance from a point to an epipolar line in pixels, beyond which the point is - considered an outlier and is not used for computing the final fundamental matrix. It can be set to - something like 1-3, depending on the accuracy of the point localization, image resolution, and the image noise. - Parameter used for the RANSAC or LMedS methods only. - It specifies a desirable level of confidence (probability) that the estimated matrix is correct. - Output array of N elements, every element of which is set to 0 for outliers and - to 1 for the other points. The array is computed only in the RANSAC and LMedS methods. For other methods, it is set to all 1’s. - fundamental matrix - - - - For points in an image of a stereo pair, computes the corresponding epilines in the other image. - - Input points. N \times 1 or 1 x N matrix of type CV_32FC2 or CV_64FC2. - Index of the image (1 or 2) that contains the points . - Fundamental matrix that can be estimated using findFundamentalMat() or stereoRectify() . - Output vector of the epipolar lines corresponding to the points in the other image. - Each line ax + by + c=0 is encoded by 3 numbers (a, b, c) . - - - - For points in an image of a stereo pair, computes the corresponding epilines in the other image. - - Input points. N \times 1 or 1 x N matrix of type CV_32FC2 or CV_64FC2. - Index of the image (1 or 2) that contains the points . - Fundamental matrix that can be estimated using findFundamentalMat() or stereoRectify() . - Output vector of the epipolar lines corresponding to the points in the other image. - Each line ax + by + c=0 is encoded by 3 numbers (a, b, c) . - - - - For points in an image of a stereo pair, computes the corresponding epilines in the other image. - - Input points. N \times 1 or 1 x N matrix of type CV_32FC2 or CV_64FC2. - Index of the image (1 or 2) that contains the points . - Fundamental matrix that can be estimated using findFundamentalMat() or stereoRectify() . - Output vector of the epipolar lines corresponding to the points in the other image. - Each line ax + by + c=0 is encoded by 3 numbers (a, b, c) . - - - - Reconstructs points by triangulation. - - 3x4 projection matrix of the first camera. - 3x4 projection matrix of the second camera. - 2xN array of feature points in the first image. In case of c++ version - it can be also a vector of feature points or two-channel matrix of size 1xN or Nx1. - 2xN array of corresponding points in the second image. In case of c++ version - it can be also a vector of feature points or two-channel matrix of size 1xN or Nx1. - 4xN array of reconstructed points in homogeneous coordinates. - - - - Reconstructs points by triangulation. - - 3x4 projection matrix of the first camera. - 3x4 projection matrix of the second camera. - 2xN array of feature points in the first image. In case of c++ version - it can be also a vector of feature points or two-channel matrix of size 1xN or Nx1. - 2xN array of corresponding points in the second image. In case of c++ version - it can be also a vector of feature points or two-channel matrix of size 1xN or Nx1. - 4xN array of reconstructed points in homogeneous coordinates. - - - - Refines coordinates of corresponding points. - - 3x3 fundamental matrix. - 1xN array containing the first set of points. - 1xN array containing the second set of points. - The optimized points1. - The optimized points2. - - - - Refines coordinates of corresponding points. - - 3x3 fundamental matrix. - 1xN array containing the first set of points. - 1xN array containing the second set of points. - The optimized points1. - The optimized points2. - - - - Recover relative camera rotation and translation from an estimated essential matrix and the corresponding points in two images, using cheirality check. - Returns the number of inliers which pass the check. - - The input essential matrix. - Array of N 2D points from the first image. The point coordinates should be floating-point (single or double precision). - Array of the second image points of the same size and format as points1. - Camera matrix K=⎡⎣⎢fx000fy0cxcy1⎤⎦⎥ . Note that this function assumes that points1 and points2 are feature points from cameras with the same camera matrix. - Recovered relative rotation. - Recovered relative translation. - Input/output mask for inliers in points1 and points2. : - If it is not empty, then it marks inliers in points1 and points2 for then given essential matrix E. - Only these inliers will be used to recover pose. In the output mask only inliers which pass the cheirality check. - This function decomposes an essential matrix using decomposeEssentialMat and then verifies possible pose hypotheses by doing cheirality check. - The cheirality check basically means that the triangulated 3D points should have positive depth. - - - - Recover relative camera rotation and translation from an estimated essential matrix and the corresponding points in two images, using cheirality check. - Returns the number of inliers which pass the check. - - The input essential matrix. - Array of N 2D points from the first image. The point coordinates should be floating-point (single or double precision). - Array of the second image points of the same size and format as points1. - Recovered relative rotation. - Recovered relative translation. - Focal length of the camera. Note that this function assumes that points1 and points2 are feature points from cameras with same focal length and principal point. - principal point of the camera. - Input/output mask for inliers in points1 and points2. : - If it is not empty, then it marks inliers in points1 and points2 for then given essential matrix E. - Only these inliers will be used to recover pose. In the output mask only inliers which pass the cheirality check. - This function decomposes an essential matrix using decomposeEssentialMat and then verifies possible pose hypotheses by doing cheirality check. - The cheirality check basically means that the triangulated 3D points should have positive depth. - - - - Recover relative camera rotation and translation from an estimated essential matrix and the corresponding points in two images, using cheirality check. - Returns the number of inliers which pass the check. - - The input essential matrix. - Array of N 2D points from the first image. The point coordinates should be floating-point (single or double precision). - Array of the second image points of the same size and format as points1. - Camera matrix K=⎡⎣⎢fx000fy0cxcy1⎤⎦⎥ . Note that this function assumes that points1 and points2 are feature points from cameras with the same camera matrix. - Recovered relative rotation. - Recovered relative translation. - threshold distance which is used to filter out far away points (i.e. infinite points). - Input/output mask for inliers in points1 and points2. : - If it is not empty, then it marks inliers in points1 and points2 for then given essential matrix E. - Only these inliers will be used to recover pose. In the output mask only inliers which pass the cheirality check. - This function decomposes an essential matrix using decomposeEssentialMat and then verifies possible pose hypotheses by doing cheirality check. - The cheirality check basically means that the triangulated 3D points should have positive depth. - 3d points which were reconstructed by triangulation. - - - - Calculates an essential matrix from the corresponding points in two images. - - Array of N (N >= 5) 2D points from the first image. - The point coordinates should be floating-point (single or double precision). - Array of the second image points of the same size and format as points1 . - Camera matrix K=⎡⎣⎢fx000fy0cxcy1⎤⎦⎥ . Note that this function assumes that points1 and points2 are feature points from cameras with the same camera matrix. - Method for computing an essential matrix. - RANSAC for the RANSAC algorithm. - LMEDS for the LMedS algorithm. - Parameter used for the RANSAC or LMedS methods only. - It specifies a desirable level of confidence (probability) that the estimated matrix is correct. - Parameter used for RANSAC. - It is the maximum distance from a point to an epipolar line in pixels, beyond which the point is considered an outlier and is not used for computing the final fundamental matrix. - It can be set to something like 1-3, depending on the accuracy of the point localization, image resolution, and the image noise. - Output array of N elements, every element of which is set to 0 for outliers and to 1 for the other points. The array is computed only in the RANSAC and LMedS methods. - essential matrix - - - - Calculates an essential matrix from the corresponding points in two images. - - Array of N (N >= 5) 2D points from the first image. - The point coordinates should be floating-point (single or double precision). - Array of the second image por LMedS methods only. - It specifies a desirable level of confidence (probability) that the estimated matrix is correct. - Parameter used for RANSAC. - It is the maximum distance from a point to an epipolar line in pixels, beyond which the point is considered an outlier and is not used for computing the final fundamental matrix. - It can be set to something like 1-3, depending on ints of the same size and format as points1 . - Focal length of the camera. Note that this function assumes that points1 and points2 are feature points from cameras with same focal length and principal point. - principal point of the camera. - Method for computing an essential matrix. - RANSAC for the RANSAC algorithm. - LMEDS for the LMedS algorithm. - Parameter used for the RANSAC othe accuracy of the point localization, image resolution, and the image noise. - Output array of N elements, every element of which is set to 0 for outliers and to 1 for the other points. The array is computed only in the RANSAC and LMedS methods. - essential matrix - - - - filters off speckles (small regions of incorrectly computed disparity) - - The input 16-bit signed disparity image - The disparity value used to paint-off the speckles - The maximum speckle size to consider it a speckle. Larger blobs are not affected by the algorithm - Maximum difference between neighbor disparity pixels to put them into the same blob. - Note that since StereoBM, StereoSGBM and may be other algorithms return a fixed-point disparity map, where disparity values - are multiplied by 16, this scale factor should be taken into account when specifying this parameter value. - The optional temporary buffer to avoid memory allocation within the function. - - - - computes valid disparity ROI from the valid ROIs of the rectified images (that are returned by cv::stereoRectify()) - - - - - - - - - - - validates disparity using the left-right check. The matrix "cost" should be computed by the stereo correspondence algorithm - - - - - - - - - - reprojects disparity image to 3D: (x,y,d)->(X,Y,Z) using the matrix Q returned by cv::stereoRectify - - Input single-channel 8-bit unsigned, 16-bit signed, 32-bit signed or 32-bit floating-point disparity image. - Output 3-channel floating-point image of the same size as disparity. - Each element of _3dImage(x,y) contains 3D coordinates of the point (x,y) computed from the disparity map. - 4 x 4 perspective transformation matrix that can be obtained with stereoRectify(). - Indicates, whether the function should handle missing values (i.e. points where the disparity was not computed). - If handleMissingValues=true, then pixels with the minimal disparity that corresponds to the outliers (see StereoBM::operator() ) are - transformed to 3D points with a very large Z value (currently set to 10000). - he optional output array depth. If it is -1, the output image will have CV_32F depth. - ddepth can also be set to CV_16S, CV_32S or CV_32F. - - - - Computes an optimal affine transformation between two 3D point sets. - - First input 3D point set. - Second input 3D point set. - Output 3D affine transformation matrix 3 x 4 . - Output vector indicating which points are inliers. - Maximum reprojection error in the RANSAC algorithm to consider a point as an inlier. - Confidence level, between 0 and 1, for the estimated transformation. - Anything between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation significantly. - Values lower than 0.8-0.9 can result in an incorrectly estimated transformation. - - - - - Calculates the Sampson Distance between two points. - - first homogeneous 2d point - second homogeneous 2d point - F fundamental matrix - The computed Sampson distance. - https://github.com/opencv/opencv/blob/master/modules/calib3d/src/fundam.cpp#L1109 - - - - Calculates the Sampson Distance between two points. - - first homogeneous 2d point - second homogeneous 2d point - F fundamental matrix - The computed Sampson distance. - https://github.com/opencv/opencv/blob/master/modules/calib3d/src/fundam.cpp#L1109 - - - - Computes an optimal affine transformation between two 2D point sets. - - First input 2D point set containing (X,Y). - Second input 2D point set containing (x,y). - Output vector indicating which points are inliers (1-inlier, 0-outlier). - Robust method used to compute transformation. - Maximum reprojection error in the RANSAC algorithm to consider a point as an inlier.Applies only to RANSAC. - The maximum number of robust method iterations. - Confidence level, between 0 and 1, for the estimated transformation. - Anything between 0.95 and 0.99 is usually good enough.Values too close to 1 can slow down the estimation - significantly.Values lower than 0.8-0.9 can result in an incorrectly estimated transformation. - Maximum number of iterations of refining algorithm (Levenberg-Marquardt). - Passing 0 will disable refining, so the output matrix will be output of robust method. - Output 2D affine transformation matrix \f$2 \times 3\f$ or empty matrix if transformation could not be estimated. - - - - Computes an optimal limited affine transformation with 4 degrees of freedom between two 2D point sets. - - First input 2D point set. - Second input 2D point set. - Output vector indicating which points are inliers. - Robust method used to compute transformation. - Maximum reprojection error in the RANSAC algorithm to consider a point as an inlier.Applies only to RANSAC. - The maximum number of robust method iterations. - Confidence level, between 0 and 1, for the estimated transformation. - Anything between 0.95 and 0.99 is usually good enough.Values too close to 1 can slow down the estimation - significantly.Values lower than 0.8-0.9 can result in an incorrectly estimated transformation. - - Output 2D affine transformation (4 degrees of freedom) matrix 2x3 or empty matrix if transformation could not be estimated. - - - - Decompose a homography matrix to rotation(s), translation(s) and plane normal(s). - - The input homography matrix between two images. - The input intrinsic camera calibration matrix. - Array of rotation matrices. - Array of translation matrices. - Array of plane normal matrices. - - - - - Filters homography decompositions based on additional information. - - Vector of rotation matrices. - Vector of plane normal matrices. - Vector of (rectified) visible reference points before the homography is applied - Vector of (rectified) visible reference points after the homography is applied - Vector of int indices representing the viable solution set after filtering - optional Mat/Vector of 8u type representing the mask for the inliers as given by the findHomography function - - - - corrects lens distortion for the given camera matrix and distortion coefficients - - Input (distorted) image. - Output (corrected) image that has the same size and type as src . - Input camera matrix - Input vector of distortion coefficients (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, - or 8 elements. If the vector is null, the zero distortion coefficients are assumed. - Camera matrix of the distorted image. - By default, it is the same as cameraMatrix but you may additionally scale - and shift the result by using a different matrix. - - - - initializes maps for cv::remap() to correct lens distortion and optionally rectify the image - - - - - - - - - - - - - initializes maps for cv::remap() for wide-angle - - - - - - - - - - - - - - - returns the default new camera matrix (by default it is the same as cameraMatrix unless centerPricipalPoint=true) - - Input camera matrix. - Camera view image size in pixels. - Location of the principal point in the new camera matrix. - The parameter indicates whether this location should be at the image center or not. - the camera matrix that is either an exact copy of the input cameraMatrix - (when centerPrinicipalPoint=false), or the modified one (when centerPrincipalPoint=true). - - - - Computes the ideal point coordinates from the observed point coordinates. - - Observed point coordinates, 1xN or Nx1 2-channel (CV_32FC2 or CV_64FC2). - Output ideal point coordinates after undistortion and reverse perspective transformation. - If matrix P is identity or omitted, dst will contain normalized point coordinates. - Camera matrix - Input vector of distortion coefficients (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, or 8 elements. - If the vector is null, the zero distortion coefficients are assumed. - Rectification transformation in the object space (3x3 matrix). - R1 or R2 computed by stereoRectify() can be passed here. - If the matrix is empty, the identity transformation is used. - New camera matrix (3x3) or new projection matrix (3x4). - P1 or P2 computed by stereoRectify() can be passed here. If the matrix is empty, - the identity new camera matrix is used. - - - - Computes the ideal point coordinates from the observed point coordinates. - - Observed point coordinates, 1xN or Nx1 2-channel (CV_32FC2 or CV_64FC2). - Output ideal point coordinates after undistortion and reverse perspective transformation. - If matrix P is identity or omitted, dst will contain normalized point coordinates. - Camera matrix - Input vector of distortion coefficients (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, or 8 elements. - If the vector is null, the zero distortion coefficients are assumed. - Rectification transformation in the object space (3x3 matrix). - R1 or R2 computed by stereoRectify() can be passed here. - If the matrix is empty, the identity transformation is used. - New camera matrix (3x3) or new projection matrix (3x4). - P1 or P2 computed by stereoRectify() can be passed here. If the matrix is empty, - the identity new camera matrix is used. - - - - - The methods in this class use a so-called fisheye camera model. - - - - - Projects points using fisheye model. - - The function computes projections of 3D points to the image plane given intrinsic and extrinsic - camera parameters.Optionally, the function computes Jacobians - matrices of partial derivatives of - image points coordinates(as functions of all the input parameters) with respect to the particular - parameters, intrinsic and/or extrinsic. - - Array of object points, 1xN/Nx1 3-channel (or vector<Point3f> ), - where N is the number of points in the view. - Output array of image points, 2xN/Nx2 1-channel or 1xN/Nx1 2-channel, - or vector<Point2f>. - - - Camera matrix - Input vector of distortion coefficients - The skew coefficient. - Optional output 2Nx15 jacobian matrix of derivatives of image points with respect - to components of the focal lengths, coordinates of the principal point, distortion coefficients, - rotation vector, translation vector, and the skew.In the old interface different components of - the jacobian are returned via different output parameters. - - - - Distorts 2D points using fisheye model. - - Array of object points, 1xN/Nx1 2-channel (or vector<Point2f> ), - where N is the number of points in the view. - Output array of image points, 1xN/Nx1 2-channel, or vector<Point2f> . - Camera matrix - Input vector of distortion coefficients - The skew coefficient. - - - - Undistorts 2D points using fisheye model - - Array of object points, 1xN/Nx1 2-channel (or vector<Point2f> ), - where N is the number of points in the view. - Output array of image points, 1xN/Nx1 2-channel, or vector>Point2f> . - Camera matrix - Input vector of distortion coefficients (k_1, k_2, k_3, k_4). - Rectification transformation in the object space: 3x3 1-channel, or vector: 3x1/1x3 1-channel or 1x1 3-channel - New camera matrix (3x3) or new projection matrix (3x4) - - - - Computes undistortion and rectification maps for image transform by cv::remap(). - If D is empty zero distortion is used, if R or P is empty identity matrixes are used. - - Camera matrix - Input vector of distortion coefficients (k_1, k_2, k_3, k_4). - Rectification transformation in the object space: 3x3 1-channel, or vector: 3x1/1x3 1-channel or 1x1 3-channel - New camera matrix (3x3) or new projection matrix (3x4) - Undistorted image size. - Type of the first output map that can be CV_32FC1 or CV_16SC2 . See convertMaps() for details. - The first output map. - The second output map. - - - - Transforms an image to compensate for fisheye lens distortion. - - image with fisheye lens distortion. - Output image with compensated fisheye lens distortion. - Camera matrix - Input vector of distortion coefficients (k_1, k_2, k_3, k_4). - Camera matrix of the distorted image. By default, it is the identity matrix but you - may additionally scale and shift the result by using a different matrix. - - - - - Estimates new camera matrix for undistortion or rectification. - - Camera matrix - Input vector of distortion coefficients (k_1, k_2, k_3, k_4). - - Rectification transformation in the object space: 3x3 1-channel, or vector: 3x1/1x3 - 1-channel or 1x1 3-channel - New camera matrix (3x3) or new projection matrix (3x4) - Sets the new focal length in range between the min focal length and the max focal - length.Balance is in range of[0, 1]. - - Divisor for new focal length. - - - - Performs camera calibaration - - vector of vectors of calibration pattern points in the calibration pattern coordinate space. - vector of vectors of the projections of calibration pattern points. - imagePoints.size() and objectPoints.size() and imagePoints[i].size() must be equal to - objectPoints[i].size() for each i. - Size of the image used only to initialize the intrinsic camera matrix. - Output 3x3 floating-point camera matrix - Output vector of distortion coefficients (k_1, k_2, k_3, k_4). - Output vector of rotation vectors (see Rodrigues ) estimated for each pattern view. - That is, each k-th rotation vector together with the corresponding k-th translation vector(see - the next output parameter description) brings the calibration pattern from the model coordinate - space(in which object points are specified) to the world coordinate space, that is, a real - position of the calibration pattern in the k-th pattern view(k= 0.. * M * -1). - Output vector of translation vectors estimated for each pattern view. - Different flags that may be zero or a combination of flag values - Termination criteria for the iterative optimization algorithm. - - - - - Stereo rectification for fisheye camera model - - First camera matrix. - First camera distortion parameters. - Second camera matrix. - Second camera distortion parameters. - Size of the image used for stereo calibration. - Rotation matrix between the coordinate systems of the first and the second cameras. - Translation vector between coordinate systems of the cameras. - Output 3x3 rectification transform (rotation matrix) for the first camera. - Output 3x3 rectification transform (rotation matrix) for the second camera. - Output 3x4 projection matrix in the new (rectified) coordinate systems for the first camera. - Output 3x4 projection matrix in the new (rectified) coordinate systems for the second camera. - Output 4x4 disparity-to-depth mapping matrix (see reprojectImageTo3D ). - Operation flags that may be zero or CALIB_ZERO_DISPARITY . If the flag is set, - the function makes the principal points of each camera have the same pixel coordinates in the - rectified views.And if the flag is not set, the function may still shift the images in the - horizontal or vertical direction(depending on the orientation of epipolar lines) to maximize the - useful image area. - New image resolution after rectification. The same size should be passed to - initUndistortRectifyMap(see the stereo_calib.cpp sample in OpenCV samples directory). When(0,0) - is passed(default), it is set to the original imageSize.Setting it to larger value can help you - preserve details in the original image, especially when there is a big radial distortion. - Sets the new focal length in range between the min focal length and the max focal - length.Balance is in range of[0, 1]. - Divisor for new focal length. - - - - Performs stereo calibration - - Vector of vectors of the calibration pattern points. - Vector of vectors of the projections of the calibration pattern points, - observed by the first camera. - Vector of vectors of the projections of the calibration pattern points, - observed by the second camera. - Input/output first camera matrix - Input/output vector of distortion coefficients (k_1, k_2, k_3, k_4) of 4 elements. - Input/output second camera matrix. The parameter is similar to K1 . - Input/output lens distortion coefficients for the second camera. The parameter is - similar to D1. - Size of the image used only to initialize intrinsic camera matrix. - Output rotation matrix between the 1st and the 2nd camera coordinate systems. - Output translation vector between the coordinate systems of the cameras. - Different flags that may be zero or a combination of the FishEyeCalibrationFlags values - Termination criteria for the iterative optimization algorithm. - - - - - Computes the source location of an extrapolated pixel. - - 0-based coordinate of the extrapolated pixel along one of the axes, likely <0 or >= len - Length of the array along the corresponding axis. - Border type, one of the #BorderTypes, except for #BORDER_TRANSPARENT and BORDER_ISOLATED. - When borderType==BORDER_CONSTANT, the function always returns -1, regardless - - - - - Forms a border around the image - - The source image - The destination image; will have the same type as src and - the size Size(src.cols+left+right, src.rows+top+bottom) - Specify how much pixels in each direction from the source image rectangle one needs to extrapolate - Specify how much pixels in each direction from the source image rectangle one needs to extrapolate - Specify how much pixels in each direction from the source image rectangle one needs to extrapolate - Specify how much pixels in each direction from the source image rectangle one needs to extrapolate - The border type - The border value if borderType == Constant - - - - Computes the per-element sum of two arrays or an array and a scalar. - - The first source array - The second source array. It must have the same size and same type as src1 - The destination array; it will have the same size and same type as src1 - The optional operation mask, 8-bit single channel array; specifies elements of the destination array to be changed. [By default this is null] - - - - - Calculates per-element difference between two arrays or array and a scalar - - The first source array - The second source array. It must have the same size and same type as src1 - The destination array; it will have the same size and same type as src1 - The optional operation mask, 8-bit single channel array; specifies elements of the destination array to be changed. [By default this is null] - - - - - Calculates per-element difference between two arrays or array and a scalar - - The first source array - The second source array. It must have the same size and same type as src1 - The destination array; it will have the same size and same type as src1 - The optional operation mask, 8-bit single channel array; specifies elements of the destination array to be changed. [By default this is null] - - - - - Calculates per-element difference between two arrays or array and a scalar - - The first source array - The second source array. It must have the same size and same type as src1 - The destination array; it will have the same size and same type as src1 - The optional operation mask, 8-bit single channel array; specifies elements of the destination array to be changed. [By default this is null] - - - - - Calculates the per-element scaled product of two arrays - - The first source array - The second source array of the same size and the same type as src1 - The destination array; will have the same size and the same type as src1 - The optional scale factor. [By default this is 1] - - - - - Performs per-element division of two arrays or a scalar by an array. - - The first source array - The second source array; should have the same size and same type as src1 - The destination array; will have the same size and same type as src2 - Scale factor [By default this is 1] - - - - - Performs per-element division of two arrays or a scalar by an array. - - Scale factor - The first source array - The destination array; will have the same size and same type as src2 - - - - - adds scaled array to another one (dst = alpha*src1 + src2) - - - - - - - - - computes weighted sum of two arrays (dst = alpha*src1 + beta*src2 + gamma) - - - - - - - - - - - - Scales, computes absolute values and converts the result to 8-bit. - - The source array - The destination array - The optional scale factor. [By default this is 1] - The optional delta added to the scaled values. [By default this is 0] - - - - Converts an array to half precision floating number. - - This function converts FP32(single precision floating point) from/to FP16(half precision floating point). CV_16S format is used to represent FP16 data. - There are two use modes(src -> dst) : CV_32F -> CV_16S and CV_16S -> CV_32F.The input array has to have type of CV_32F or - CV_16S to represent the bit depth.If the input array is neither of them, the function will raise an error. - The format of half precision floating point is defined in IEEE 754-2008. - - input array. - output array. - - - - transforms array of numbers using a lookup table: dst(i)=lut(src(i)) - - Source array of 8-bit elements - Look-up table of 256 elements. - In the case of multi-channel source array, the table should either have - a single channel (in this case the same table is used for all channels) - or the same number of channels as in the source array - Destination array; - will have the same size and the same number of channels as src, - and the same depth as lut - - - - transforms array of numbers using a lookup table: dst(i)=lut(src(i)) - - Source array of 8-bit elements - Look-up table of 256 elements. - In the case of multi-channel source array, the table should either have - a single channel (in this case the same table is used for all channels) - or the same number of channels as in the source array - Destination array; - will have the same size and the same number of channels as src, - and the same depth as lut - - - - computes sum of array elements - - The source array; must have 1 to 4 channels - - - - - computes the number of nonzero array elements - - Single-channel array - number of non-zero elements in mtx - - - - returns the list of locations of non-zero pixels - - - - - - - computes mean value of selected array elements - - The source array; it should have 1 to 4 channels - (so that the result can be stored in Scalar) - The optional operation mask - - - - - computes mean value and standard deviation of all or selected array elements - - The source array; it should have 1 to 4 channels - (so that the results can be stored in Scalar's) - The output parameter: computed mean value - The output parameter: computed standard deviation - The optional operation mask - - - - computes mean value and standard deviation of all or selected array elements - - The source array; it should have 1 to 4 channels - (so that the results can be stored in Scalar's) - The output parameter: computed mean value - The output parameter: computed standard deviation - The optional operation mask - - - - Calculates absolute array norm, absolute difference norm, or relative difference norm. - - The first source array - Type of the norm - The optional operation mask - - - - - computes norm of selected part of the difference between two arrays - - The first source array - The second source array of the same size and the same type as src1 - Type of the norm - The optional operation mask - - - - - Computes the Peak Signal-to-Noise Ratio (PSNR) image quality metric. - - This function calculates the Peak Signal-to-Noise Ratio(PSNR) image quality metric in decibels(dB), - between two input arrays src1 and src2.The arrays must have the same type. - - first input array. - second input array of the same size as src1. - the maximum pixel value (255 by default) - - - - - naive nearest neighbor finder - - - - - - - - - - - - - - - scales and shifts array elements so that either the specified norm (alpha) - or the minimum (alpha) and maximum (beta) array values get the specified values - - The source array - The destination array; will have the same size as src - The norm value to normalize to or the lower range boundary - in the case of range normalization - The upper range boundary in the case of range normalization; - not used for norm normalization - The normalization type - When the parameter is negative, - the destination array will have the same type as src, - otherwise it will have the same number of channels as src and the depth =CV_MAT_DEPTH(rtype) - The optional operation mask - - - - Finds indices of max elements along provided axis - - Input single-channel array - Output array of type CV_32SC1 with the same dimensionality as src, - except for axis being reduced - it should be set to 1. - Axis to reduce along - Whether to get the index of first or last occurrence of max - - - - Finds indices of min elements along provided axis - - Input single-channel array - Output array of type CV_32SC1 with the same dimensionality as src, - except for axis being reduced - it should be set to 1. - Axis to reduce along - Whether to get the index of first or last occurrence of min - - - - finds global minimum and maximum array elements and returns their values and their locations - - The source single-channel array - Pointer to returned minimum value - Pointer to returned maximum value - - - - finds global minimum and maximum array elements and returns their values and their locations - - The source single-channel array - Pointer to returned minimum location - Pointer to returned maximum location - - - - finds global minimum and maximum array elements and returns their values and their locations - - The source single-channel array - Pointer to returned minimum value - Pointer to returned maximum value - Pointer to returned minimum location - Pointer to returned maximum location - The optional mask used to select a sub-array - - - - finds global minimum and maximum array elements and returns their values and their locations - - The source single-channel array - Pointer to returned minimum value - Pointer to returned maximum value - - - - finds global minimum and maximum array elements and returns their values and their locations - - The source single-channel array - - - - - - finds global minimum and maximum array elements and returns their values and their locations - - The source single-channel array - Pointer to returned minimum value - Pointer to returned maximum value - - - - - - - transforms 2D matrix to 1D row or column vector by taking sum, minimum, maximum or mean value over all the rows - - The source 2D matrix - The destination vector. - Its size and type is defined by dim and dtype parameters - The dimension index along which the matrix is reduced. - 0 means that the matrix is reduced to a single row and 1 means that the matrix is reduced to a single column - - When it is negative, the destination vector will have - the same type as the source matrix, otherwise, its type will be CV_MAKE_TYPE(CV_MAT_DEPTH(dtype), mtx.channels()) - - - - makes multi-channel array out of several single-channel arrays - - - - - - - Copies each plane of a multi-channel array to a dedicated array - - The source multi-channel array - The destination array or vector of arrays; - The number of arrays must match mtx.channels() . - The arrays themselves will be reallocated if needed - - - - Copies each plane of a multi-channel array to a dedicated array - - The source multi-channel array - The number of arrays must match mtx.channels() . - The arrays themselves will be reallocated if needed - - - - copies selected channels from the input arrays to the selected channels of the output arrays - - - - - - - - extracts a single channel from src (coi is 0-based index) - - - - - - - - inserts a single channel to dst (coi is 0-based index) - - - - - - - - reverses the order of the rows, columns or both in a matrix - - The source array - The destination array; will have the same size and same type as src - Specifies how to flip the array: - 0 means flipping around the x-axis, positive (e.g., 1) means flipping around y-axis, - and negative (e.g., -1) means flipping around both axes. See also the discussion below for the formulas. - - - - Rotates a 2D array in multiples of 90 degrees. - - input array. - output array of the same type as src. - The size is the same with ROTATE_180, and the rows and cols are switched for - ROTATE_90_CLOCKWISE and ROTATE_90_COUNTERCLOCKWISE. - an enum to specify how to rotate the array. - - - - replicates the input matrix the specified number of times in the horizontal and/or vertical direction - - The source array to replicate - How many times the src is repeated along the vertical axis - How many times the src is repeated along the horizontal axis - The destination array; will have the same type as src - - - - replicates the input matrix the specified number of times in the horizontal and/or vertical direction - - The source array to replicate - How many times the src is repeated along the vertical axis - How many times the src is repeated along the horizontal axis - - - - - Applies horizontal concatenation to given matrices. - - input array or vector of matrices. all of the matrices must have the same number of rows and the same depth. - output array. It has the same number of rows and depth as the src, and the sum of cols of the src. - - - - Applies horizontal concatenation to given matrices. - - first input array to be considered for horizontal concatenation. - second input array to be considered for horizontal concatenation. - output array. It has the same number of rows and depth as the src1 and src2, and the sum of cols of the src1 and src2. - - - - Applies vertical concatenation to given matrices. - - input array or vector of matrices. all of the matrices must have the same number of cols and the same depth. - output array. It has the same number of cols and depth as the src, and the sum of rows of the src. - - - - Applies vertical concatenation to given matrices. - - first input array to be considered for vertical concatenation. - second input array to be considered for vertical concatenation. - output array. It has the same number of cols and depth as the src1 and src2, and the sum of rows of the src1 and src2. - - - - computes bitwise conjunction of the two arrays (dst = src1 & src2) - - first input array or a scalar. - second input array or a scalar. - output array that has the same size and type as the input - optional operation mask, 8-bit single channel array, that specifies elements of the output array to be changed. - - - - computes bitwise disjunction of the two arrays (dst = src1 | src2) - - first input array or a scalar. - second input array or a scalar. - output array that has the same size and type as the input - optional operation mask, 8-bit single channel array, that specifies elements of the output array to be changed. - - - - computes bitwise exclusive-or of the two arrays (dst = src1 ^ src2) - - first input array or a scalar. - second input array or a scalar. - output array that has the same size and type as the input - optional operation mask, 8-bit single channel array, that specifies elements of the output array to be changed. - - - - inverts each bit of array (dst = ~src) - - input array. - output array that has the same size and type as the input - optional operation mask, 8-bit single channel array, that specifies elements of the output array to be changed. - - - - Calculates the per-element absolute difference between two arrays or between an array and a scalar. - - first input array or a scalar. - second input array or a scalar. - output array that has the same size and type as input arrays. - - - - Copies the matrix to another one. - When the operation mask is specified, if the Mat::create call shown above reallocates the matrix, the newly allocated matrix is initialized with all zeros before copying the data. - - Source matrix. - Destination matrix. If it does not have a proper size or type before the operation, it is reallocated. - Operation mask of the same size as \*this. Its non-zero elements indicate which matrix - elements need to be copied.The mask has to be of type CV_8U and can have 1 or multiple channels. - - - - Checks if array elements lie between the elements of two other arrays. - - first input array. - inclusive lower boundary array or a scalar. - inclusive upper boundary array or a scalar. - output array of the same size as src and CV_8U type. - - - - Checks if array elements lie between the elements of two other arrays. - - first input array. - inclusive lower boundary array or a scalar. - inclusive upper boundary array or a scalar. - output array of the same size as src and CV_8U type. - - - - Performs the per-element comparison of two arrays or an array and scalar value. - - first input array or a scalar; when it is an array, it must have a single channel. - second input array or a scalar; when it is an array, it must have a single channel. - output array of type ref CV_8U that has the same size and the same number of channels as the input arrays. - a flag, that specifies correspondence between the arrays (cv::CmpTypes) - - - - computes per-element minimum of two arrays (dst = min(src1, src2)) - - - - - - - - computes per-element minimum of two arrays (dst = min(src1, src2)) - - - - - - - - computes per-element minimum of array and scalar (dst = min(src1, src2)) - - - - - - - - computes per-element maximum of two arrays (dst = max(src1, src2)) - - - - - - - - computes per-element maximum of two arrays (dst = max(src1, src2)) - - - - - - - - computes per-element maximum of array and scalar (dst = max(src1, src2)) - - - - - - - - computes square root of each matrix element (dst = src**0.5) - - The source floating-point array - The destination array; will have the same size and the same type as src - - - - raises the input matrix elements to the specified power (b = a**power) - - The source array - The exponent of power - The destination array; will have the same size and the same type as src - - - - computes exponent of each matrix element (dst = e**src) - - The source array - The destination array; will have the same size and same type as src - - - - computes natural logarithm of absolute value of each matrix element: dst = log(abs(src)) - - The source array - The destination array; will have the same size and same type as src - - - - Calculates x and y coordinates of 2D vectors from their magnitude and angle. - - input floating-point array of magnitudes of 2D vectors; - it can be an empty matrix(=Mat()), in this case, the function assumes that all the magnitudes are = 1; if it is not empty, - it must have the same size and type as angle. - input floating-point array of angles of 2D vectors. - output array of x-coordinates of 2D vectors; it has the same size and type as angle. - output array of y-coordinates of 2D vectors; it has the same size and type as angle. - when true, the input angles are measured in degrees, otherwise, they are measured in radians. - - - - Calculates the magnitude and angle of 2D vectors. - - array of x-coordinates; this must be a single-precision or double-precision floating-point array. - array of y-coordinates, that must have the same size and same type as x. - output array of magnitudes of the same size and type as x. - output array of angles that has the same size and type as x; - the angles are measured in radians(from 0 to 2\*Pi) or in degrees(0 to 360 degrees). - a flag, indicating whether the angles are measured in radians(which is by default), or in degrees. - - - - Calculates the rotation angle of 2D vectors. - - input floating-point array of x-coordinates of 2D vectors. - input array of y-coordinates of 2D vectors; it must have the same size and the same type as x. - output array of vector angles; it has the same size and same type as x. - when true, the function calculates the angle in degrees, otherwise, they are measured in radians. - - - - Calculates the magnitude of 2D vectors. - - floating-point array of x-coordinates of the vectors. - floating-point array of y-coordinates of the vectors; it must have the same size as x. - output array of the same size and type as x. - - - - checks that each matrix element is within the specified range. - - The array to check - The flag indicating whether the functions quietly - return false when the array elements are out of range, - or they throw an exception. - - - - - checks that each matrix element is within the specified range. - - The array to check - The flag indicating whether the functions quietly - return false when the array elements are out of range, - or they throw an exception. - The optional output parameter, where the position of - the first outlier is stored. - The inclusive lower boundary of valid values range - The exclusive upper boundary of valid values range - - - - - converts NaN's to the given number - - - - - - - implements generalized matrix product algorithm GEMM from BLAS - - - - - - - - - - - - multiplies matrix by its transposition from the left or from the right - - The source matrix - The destination square matrix - Specifies the multiplication ordering; see the description below - The optional delta matrix, subtracted from src before the - multiplication. When the matrix is empty ( delta=Mat() ), it’s assumed to be - zero, i.e. nothing is subtracted, otherwise if it has the same size as src, - then it’s simply subtracted, otherwise it is "repeated" to cover the full src - and then subtracted. Type of the delta matrix, when it's not empty, must be the - same as the type of created destination matrix, see the rtype description - The optional scale factor for the matrix product - When it’s negative, the destination matrix will have the - same type as src . Otherwise, it will have type=CV_MAT_DEPTH(rtype), - which should be either CV_32F or CV_64F - - - - transposes the matrix - - The source array - The destination array of the same type as src - - - - performs affine transformation of each element of multi-channel input matrix - - The source array; must have as many channels (1 to 4) as mtx.cols or mtx.cols-1 - The destination array; will have the same size and depth as src and as many channels as mtx.rows - The transformation matrix - - - - performs perspective transformation of each element of multi-channel input matrix - - The source two-channel or three-channel floating-point array; - each element is 2D/3D vector to be transformed - The destination array; it will have the same size and same type as src - 3x3 or 4x4 transformation matrix - - - - performs perspective transformation of each element of multi-channel input matrix - - The source two-channel or three-channel floating-point array; - each element is 2D/3D vector to be transformed - 3x3 or 4x4 transformation matrix - The destination array; it will have the same size and same type as src - - - - performs perspective transformation of each element of multi-channel input matrix - - The source two-channel or three-channel floating-point array; - each element is 2D/3D vector to be transformed - 3x3 or 4x4 transformation matrix - The destination array; it will have the same size and same type as src - - - - performs perspective transformation of each element of multi-channel input matrix - - The source two-channel or three-channel floating-point array; - each element is 2D/3D vector to be transformed - 3x3 or 4x4 transformation matrix - The destination array; it will have the same size and same type as src - - - - performs perspective transformation of each element of multi-channel input matrix - - The source two-channel or three-channel floating-point array; - each element is 2D/3D vector to be transformed - 3x3 or 4x4 transformation matrix - The destination array; it will have the same size and same type as src - - - - extends the symmetrical matrix from the lower half or from the upper half - - Input-output floating-point square matrix - If true, the lower half is copied to the upper half, - otherwise the upper half is copied to the lower half - - - - initializes scaled identity matrix - - The matrix to initialize (not necessarily square) - The value to assign to the diagonal elements - - - - computes determinant of a square matrix - - The input matrix; must have CV_32FC1 or CV_64FC1 type and square size - determinant of the specified matrix. - - - - computes trace of a matrix - - The source matrix - - - - - computes inverse or pseudo-inverse matrix - - The source floating-point MxN matrix - The destination matrix; will have NxM size and the same type as src - The inversion method - - - - - solves linear system or a least-square problem - - - - - - - - - - Solve given (non-integer) linear programming problem using the Simplex Algorithm (Simplex Method). - - This row-vector corresponds to \f$c\f$ in the LP problem formulation (see above). - It should contain 32- or 64-bit floating point numbers.As a convenience, column-vector may be also submitted, - in the latter case it is understood to correspond to \f$c^T\f$. - `m`-by-`n+1` matrix, whose rightmost column corresponds to \f$b\f$ in formulation above - and the remaining to \f$A\f$. It should containt 32- or 64-bit floating point numbers. - The solution will be returned here as a column-vector - it corresponds to \f$c\f$ in the - formulation above.It will contain 64-bit floating point numbers. - - - - - sorts independently each matrix row or each matrix column - - The source single-channel array - The destination array of the same size and the same type as src - The operation flags, a combination of the SortFlag values - - - - sorts independently each matrix row or each matrix column - - The source single-channel array - The destination integer array of the same size as src - The operation flags, a combination of SortFlag values - - - - finds real roots of a cubic polynomial - - The equation coefficients, an array of 3 or 4 elements - The destination array of real roots which will have 1 or 3 elements - - - - - finds real and complex roots of a polynomial - - The array of polynomial coefficients - The destination (complex) array of roots - The maximum number of iterations the algorithm does - - - - - Computes eigenvalues and eigenvectors of a symmetric matrix. - - The input matrix; must have CV_32FC1 or CV_64FC1 type, - square size and be symmetric: src^T == src - The output vector of eigenvalues of the same type as src; - The eigenvalues are stored in the descending order. - The output matrix of eigenvectors; - It will have the same size and the same type as src; The eigenvectors are stored - as subsequent matrix rows, in the same order as the corresponding eigenvalues - - - - - Calculates eigenvalues and eigenvectors of a non-symmetric matrix (real eigenvalues only). - - input matrix (CV_32FC1 or CV_64FC1 type). - output vector of eigenvalues (type is the same type as src). - output matrix of eigenvectors (type is the same type as src). The eigenvectors are stored as subsequent matrix rows, in the same order as the corresponding eigenvalues. - - - - computes covariation matrix of a set of samples - - samples stored as separate matrices - output covariance matrix of the type ctype and square size. - input or output (depending on the flags) array as the average value of the input vectors. - operation flags as a combination of CovarFlags - type of the matrixl; it equals 'CV_64F' by default. - - - - computes covariation matrix of a set of samples - - samples stored as rows/columns of a single matrix. - output covariance matrix of the type ctype and square size. - input or output (depending on the flags) array as the average value of the input vectors. - operation flags as a combination of CovarFlags - type of the matrixl; it equals 'CV_64F' by default. - - - - PCA of the supplied dataset. - - input samples stored as the matrix rows or as the matrix columns. - optional mean value; if the matrix is empty (noArray()), the mean is computed from the data. - eigenvectors of the covariation matrix - maximum number of components that PCA should - retain; by default, all the components are retained. - - - - PCA of the supplied dataset. - - input samples stored as the matrix rows or as the matrix columns. - optional mean value; if the matrix is empty (noArray()), the mean is computed from the data. - eigenvectors of the covariation matrix - eigenvalues of the covariation matrix - maximum number of components that PCA should - retain; by default, all the components are retained. - - - - PCA of the supplied dataset. - - input samples stored as the matrix rows or as the matrix columns. - optional mean value; if the matrix is empty (noArray()), the mean is computed from the data. - eigenvectors of the covariation matrix - Percentage of variance that PCA should retain. - Using this parameter will let the PCA decided how many components to retain but it will always keep at least 2. - - - - PCA of the supplied dataset. - - input samples stored as the matrix rows or as the matrix columns. - optional mean value; if the matrix is empty (noArray()), the mean is computed from the data. - eigenvectors of the covariation matrix - eigenvalues of the covariation matrix - Percentage of variance that PCA should retain. - Using this parameter will let the PCA decided how many components to retain but it will always keep at least 2. - - - - Projects vector(s) to the principal component subspace. - - input samples stored as the matrix rows or as the matrix columns. - optional mean value; if the matrix is empty (noArray()), the mean is computed from the data. - eigenvectors of the covariation matrix - output vectors - - - - Reconstructs vectors from their PC projections. - - input samples stored as the matrix rows or as the matrix columns. - optional mean value; if the matrix is empty (noArray()), the mean is computed from the data. - eigenvectors of the covariation matrix - output vectors - - - - decomposes matrix and stores the results to user-provided matrices - - decomposed matrix. The depth has to be CV_32F or CV_64F. - calculated singular values - calculated left singular vectors - transposed matrix of right singular vectors - peration flags - see SVD::Flags. - - - - performs back substitution for the previously computed SVD - - calculated singular values - calculated left singular vectors - transposed matrix of right singular vectors - right-hand side of a linear system (u*w*v')*dst = rhs to be solved, where A has been previously decomposed. - output - - - - Calculates the Mahalanobis distance between two vectors. - - first 1D input vector. - second 1D input vector. - inverse covariance matrix. - - - - - Performs a forward Discrete Fourier transform of 1D or 2D floating-point array. - - The source array, real or complex - The destination array, which size and type depends on the flags - Transformation flags, a combination of the DftFlag2 values - When the parameter != 0, the function assumes that - only the first nonzeroRows rows of the input array ( DFT_INVERSE is not set) - or only the first nonzeroRows of the output array ( DFT_INVERSE is set) contain non-zeros, - thus the function can handle the rest of the rows more efficiently and - thus save some time. This technique is very useful for computing array cross-correlation - or convolution using DFT - - - - Performs an inverse Discrete Fourier transform of 1D or 2D floating-point array. - - The source array, real or complex - The destination array, which size and type depends on the flags - Transformation flags, a combination of the DftFlag2 values - When the parameter != 0, the function assumes that - only the first nonzeroRows rows of the input array ( DFT_INVERSE is not set) - or only the first nonzeroRows of the output array ( DFT_INVERSE is set) contain non-zeros, - thus the function can handle the rest of the rows more efficiently and - thus save some time. This technique is very useful for computing array cross-correlation - or convolution using DFT - - - - Performs forward or inverse 1D or 2D Discrete Cosine Transformation - - The source floating-point array - The destination array; will have the same size and same type as src - Transformation flags, a combination of DctFlag2 values - - - - Performs inverse 1D or 2D Discrete Cosine Transformation - - The source floating-point array - The destination array; will have the same size and same type as src - Transformation flags, a combination of DctFlag2 values - - - - Performs the per-element multiplication of two Fourier spectrums. - - first input array. - second input array of the same size and type as src1. - output array of the same size and type as src1. - operation flags; currently, the only supported flag is cv::DFT_ROWS, which indicates that - each row of src1 and src2 is an independent 1D Fourier spectrum. If you do not want to use this flag, then simply add a `0` as value. - optional flag that conjugates the second input array before the multiplication (true) or not (false). - - - - Returns the optimal DFT size for a given vector size. - - vector size. - - - - - Returns the thread-local Random number generator - - - - - - Sets the thread-local Random number generator - - - - - - fills array with uniformly-distributed random numbers from the range [low, high) - - The output array of random numbers. - The array must be pre-allocated and have 1 to 4 channels - The inclusive lower boundary of the generated random numbers - The exclusive upper boundary of the generated random numbers - - - - fills array with uniformly-distributed random numbers from the range [low, high) - - The output array of random numbers. - The array must be pre-allocated and have 1 to 4 channels - The inclusive lower boundary of the generated random numbers - The exclusive upper boundary of the generated random numbers - - - - fills array with normally-distributed random numbers with the specified mean and the standard deviation - - The output array of random numbers. - The array must be pre-allocated and have 1 to 4 channels - The mean value (expectation) of the generated random numbers - The standard deviation of the generated random numbers - - - - fills array with normally-distributed random numbers with the specified mean and the standard deviation - - The output array of random numbers. - The array must be pre-allocated and have 1 to 4 channels - The mean value (expectation) of the generated random numbers - The standard deviation of the generated random numbers - - - - shuffles the input array elements - - The input/output numerical 1D array - The scale factor that determines the number of random swap operations. - - - - shuffles the input array elements - - The input/output numerical 1D array - The scale factor that determines the number of random swap operations. - The optional random number generator used for shuffling. - If it is null, theRng() is used instead. - - - - Finds centers of clusters and groups input samples around the clusters. - - Data for clustering. An array of N-Dimensional points with float coordinates is needed. - Number of clusters to split the set by. - Input/output integer array that stores the cluster indices for every sample. - The algorithm termination criteria, that is, the maximum number of iterations and/or - the desired accuracy. The accuracy is specified as criteria.epsilon. As soon as each of the cluster centers - moves by less than criteria.epsilon on some iteration, the algorithm stops. - Flag to specify the number of times the algorithm is executed using different - initial labellings. The algorithm returns the labels that yield the best compactness (see the last function parameter). - Flag that can take values of cv::KmeansFlags - Output matrix of the cluster centers, one row per each cluster center. - The function returns the compactness measure that is computed as - \f[\sum _i \| \texttt{samples} _i - \texttt{centers} _{ \texttt{labels} _i} \| ^2\f] - after every attempt. The best (minimum) value is chosen and the corresponding labels and the compactness - value are returned by the function. Basically, you can use only the core of the function, - set the number of attempts to 1, initialize labels each time using a custom algorithm, - pass them with the ( flags = #KMEANS_USE_INITIAL_LABELS ) flag, and then choose the best (most-compact) clustering. - - - - computes the angle in degrees (0..360) of the vector (x,y) - - - - - - - - computes cube root of the argument - - - - - - - OpenCV will try to set the number of threads for the next parallel region. - If threads == 0, OpenCV will disable threading optimizations and run all it's functions - sequentially.Passing threads < 0 will reset threads number to system default. This function must - be called outside of parallel region. - OpenCV will try to run its functions with specified threads number, but some behaviour differs from framework: - - `TBB` - User-defined parallel constructions will run with the same threads number, if another is not specified.If later on user creates his own scheduler, OpenCV will use it. - - `OpenMP` - No special defined behaviour. - - `Concurrency` - If threads == 1, OpenCV will disable threading optimizations and run its functions sequentially. - - `GCD` - Supports only values <= 0. - - `C=` - No special defined behaviour. - - Number of threads used by OpenCV. - - - - Returns the number of threads used by OpenCV for parallel regions. - - Always returns 1 if OpenCV is built without threading support. - The exact meaning of return value depends on the threading framework used by OpenCV library: - - `TBB` - The number of threads, that OpenCV will try to use for parallel regions. If there is - any tbb::thread_scheduler_init in user code conflicting with OpenCV, then function returns default - number of threads used by TBB library. - - `OpenMP` - An upper bound on the number of threads that could be used to form a new team. - - `Concurrency` - The number of threads, that OpenCV will try to use for parallel regions. - - `GCD` - Unsupported; returns the GCD thread pool limit(512) for compatibility. - - `C=` - The number of threads, that OpenCV will try to use for parallel regions, if before - called setNumThreads with threads > 0, otherwise returns the number of logical CPUs, - available for the process. - - - - - - Returns the index of the currently executed thread within the current parallel region. - Always returns 0 if called outside of parallel region. - @deprecated Current implementation doesn't corresponding to this documentation. - The exact meaning of the return value depends on the threading framework used by OpenCV library: - - `TBB` - Unsupported with current 4.1 TBB release.Maybe will be supported in future. - - `OpenMP` - The thread number, within the current team, of the calling thread. - - `Concurrency` - An ID for the virtual processor that the current context is executing - on(0 for master thread and unique number for others, but not necessary 1,2,3,...). - - `GCD` - System calling thread's ID. Never returns 0 inside parallel region. - - `C=` - The index of the current parallel task. - - - - - - Returns full configuration time cmake output. - - Returned value is raw cmake output including version control system revision, compiler version, - compiler flags, enabled modules and third party libraries, etc.Output format depends on target architecture. - - - - - - Returns library version string. - For example "3.4.1-dev". - - - - - - Returns major library version - - - - - - Returns minor library version - - - - - - Returns revision field of the library version - - - - - - Returns the number of ticks. - The function returns the number of ticks after the certain event (for example, when the machine was - turned on). It can be used to initialize RNG or to measure a function execution time by reading the - tick count before and after the function call. - - - - - - Returns the number of ticks per second. - The function returns the number of ticks per second.That is, the following code computes the execution time in seconds: - - - - - - Returns the number of CPU ticks. - - The function returns the current number of CPU ticks on some architectures(such as x86, x64, PowerPC). - On other platforms the function is equivalent to getTickCount.It can also be used for very accurate time - measurements, as well as for RNG initialization.Note that in case of multi-CPU systems a thread, from which - getCPUTickCount is called, can be suspended and resumed at another CPU with its own counter. So, - theoretically (and practically) the subsequent calls to the function do not necessary return the monotonously - increasing values. Also, since a modern CPU varies the CPU frequency depending on the load, the number of CPU - clocks spent in some code cannot be directly converted to time units.Therefore, getTickCount is generally - a preferable solution for measuringexecution time. - - - - - - Returns true if the specified feature is supported by the host hardware. - The function returns true if the host hardware supports the specified feature.When user calls - setUseOptimized(false), the subsequent calls to checkHardwareSupport() will return false until - setUseOptimized(true) is called.This way user can dynamically switch on and off the optimized code in OpenCV. - - The feature of interest, one of cv::CpuFeatures - - - - - Returns feature name by ID. - Returns empty string if feature is not defined - - - - - - - Returns list of CPU features enabled during compilation. - Returned value is a string containing space separated list of CPU features with following markers: - - no markers - baseline features - - prefix `*` - features enabled in dispatcher - - suffix `?` - features enabled but not available in HW - - - `SSE SSE2 SSE3* SSE4.1 *SSE4.2 *FP16* AVX *AVX2* AVX512-SKX?` - - - - - - Returns the number of logical CPUs available for the process. - - - - - - Turns on/off available optimization. - The function turns on or off the optimized code in OpenCV. Some optimization can not be enabled - or disabled, but, for example, most of SSE code in OpenCV can be temporarily turned on or off this way. - - - - - - Returns the current optimization status. - The function returns the current optimization status, which is controlled by cv::setUseOptimized(). - - - - - - Aligns buffer size by the certain number of bytes - This small inline function aligns a buffer size by - the certian number of bytes by enlarging it. - - - - - - - - Sets/resets the break-on-error mode. - When the break-on-error mode is set, the default error handler issues a hardware exception, - which can make debugging more convenient. - - - the previous state - - - - - - - - - - - - Set global logging level - - logging level - previous logging level - - - - Get global logging level - - logging level - - - - Computes absolute value of each matrix element - - matrix - - - - - Computes absolute value of each matrix element - - matrix expression - - - - - Equivalence predicate (a boolean function of two arguments). - The predicate returns true when the elements are certainly in the same class, and returns false if they may or may not be in the same class. - - - - - - - - - Splits an element set into equivalency classes. - Consider using GroupBy of Linq instead. - - - Set of elements stored as a vector. - Output vector of labels. It contains as many elements as vec. Each label labels[i] is a 0-based cluster index of vec[i] . - Equivalence predicate (a boolean function of two arguments). - The predicate returns true when the elements are certainly in the same class, and returns false if they may or may not be in the same class. - - - - - Detects corners using the FAST algorithm - - grayscale image where keypoints (corners) are detected. - threshold on difference between intensity of the central pixel - and pixels of a circle around this pixel. - if true, non-maximum suppression is applied to - detected corners (keypoints). - keypoints detected on the image. - - - - Detects corners using the FAST algorithm - - grayscale image where keypoints (corners) are detected. - threshold on difference between intensity of the central pixel - and pixels of a circle around this pixel. - if true, non-maximum suppression is applied to - detected corners (keypoints). - one of the three neighborhoods as defined in the paper - keypoints detected on the image. - - - - Detects corners using the AGAST algorithm - - grayscale image where keypoints (corners) are detected. - threshold on difference between intensity of the central pixel - and pixels of a circle around this pixel. - if true, non-maximum suppression is applied to - detected corners (keypoints). - one of the four neighborhoods as defined in the paper - keypoints detected on the image. - - - - Draw keypoints. - - Source image. - Keypoints from the source image. - Output image. Its content depends on the flags value defining what is drawn in the output image. See possible flags bit values below. - Color of keypoints. - Flags setting drawing features. Possible flags bit values are defined by DrawMatchesFlags. - - - - Draws the found matches of keypoints from two images. - - First source image. - Keypoints from the first source image. - Second source image. - Keypoints from the second source image. - Matches from the first image to the second one, which means that keypoints1[i] - has a corresponding point in keypoints2[matches[i]] . - Output image. Its content depends on the flags value defining what is drawn in the - output image. See possible flags bit values below. - Color of matches (lines and connected keypoints). If matchColor==Scalar::all(-1), - the color is generated randomly. - Color of single keypoints (circles), which means that keypoints do not - have the matches. If singlePointColor==Scalar::all(-1) , the color is generated randomly. - Mask determining which matches are drawn. If the mask is empty, all matches are drawn. - Flags setting drawing features. Possible flags bit values are defined by DrawMatchesFlags. - - - - Draws the found matches of keypoints from two images. - - First source image. - Keypoints from the first source image. - Second source image. - Keypoints from the second source image. - Matches from the first image to the second one, which means that keypoints1[i] - has a corresponding point in keypoints2[matches[i]] . - Output image. Its content depends on the flags value defining what is drawn in the - output image. See possible flags bit values below. - Color of matches (lines and connected keypoints). If matchColor==Scalar::all(-1), - the color is generated randomly. - Color of single keypoints (circles), which means that keypoints do not - have the matches. If singlePointColor==Scalar::all(-1) , the color is generated randomly. - Mask determining which matches are drawn. If the mask is empty, all matches are drawn. - Flags setting drawing features. Possible flags bit values are defined by DrawMatchesFlags. - - - - - - - - - - - - - - - - - - - - recallPrecisionCurve - - - - - - - - - - - - - - - - - - - - Creates a window. - - Name of the window in the window caption that may be used as a window identifier. - - Flags of the window. Currently the only supported flag is CV WINDOW AUTOSIZE. If this is set, - the window size is automatically adjusted to fit the displayed image (see imshow ), and the user can not change the window size manually. - - - - - Destroys the specified window. - - - - - - Destroys all of the HighGUI windows. - - - - - - - - - - - Waits for a pressed key. - Similar to #waitKey, but returns full key code. - Key code is implementation specific and depends on used backend: QT/GTK/Win32/etc - - Delay in milliseconds. 0 is the special value that means ”forever” - Returns the code of the pressed key or -1 if no key was pressed before the specified time had elapsed. - - - - Waits for a pressed key. - - Delay in milliseconds. 0 is the special value that means ”forever” - Returns the code of the pressed key or -1 if no key was pressed before the specified time had elapsed. - - - - Displays the image in the specified window - - Name of the window. - Image to be shown. - - - - Resizes window to the specified size - - Window name - The new window width - The new window height - - - - Resizes window to the specified size - - Window name - The new window size - - - - Moves window to the specified position - - Window name - The new x-coordinate of the window - The new y-coordinate of the window - - - - Changes parameters of a window dynamically. - - Name of the window. - Window property to retrieve. - New value of the window property. - - - - Updates window title - - Name of the window - New title - - - - Provides parameters of a window. - - Name of the window. - Window property to retrieve. - - - - - Provides rectangle of image in the window. - The function getWindowImageRect returns the client screen coordinates, width and height of the image rendering area. - - Name of the window. - - - - - Sets the callback function for mouse events occuring within the specified window. - - Name of the window. - Reference to the function to be called every time mouse event occurs in the specified window. - - - - - Gets the mouse-wheel motion delta, when handling mouse-wheel events cv::EVENT_MOUSEWHEEL and cv::EVENT_MOUSEHWHEEL. - - For regular mice with a scroll-wheel, delta will be a multiple of 120. The value 120 corresponds to - a one notch rotation of the wheel or the threshold for action to be taken and one such action should - occur for each delta.Some high-precision mice with higher-resolution freely-rotating wheels may - generate smaller values. - - For cv::EVENT_MOUSEWHEEL positive and negative values mean forward and backward scrolling, - respectively.For cv::EVENT_MOUSEHWHEEL, where available, positive and negative values mean right and - left scrolling, respectively. - - The mouse callback flags parameter. - - - - - Selects ROI on the given image. - Function creates a window and allows user to select a ROI using mouse. - Controls: use `space` or `enter` to finish selection, use key `c` to cancel selection (function will return the zero cv::Rect). - - name of the window where selection process will be shown. - image to select a ROI. - if true crosshair of selection rectangle will be shown. - if true center of selection will match initial mouse position. In opposite case a corner of - selection rectangle will correspond to the initial mouse position. - selected ROI or empty rect if selection canceled. - - - - Selects ROI on the given image. - Function creates a window and allows user to select a ROI using mouse. - Controls: use `space` or `enter` to finish selection, use key `c` to cancel selection (function will return the zero cv::Rect). - - image to select a ROI. - if true crosshair of selection rectangle will be shown. - if true center of selection will match initial mouse position. In opposite case a corner of - selection rectangle will correspond to the initial mouse position. - selected ROI or empty rect if selection canceled. - - - - Selects ROIs on the given image. - Function creates a window and allows user to select a ROIs using mouse. - Controls: use `space` or `enter` to finish current selection and start a new one, - use `esc` to terminate multiple ROI selection process. - - name of the window where selection process will be shown. - image to select a ROI. - if true crosshair of selection rectangle will be shown. - if true center of selection will match initial mouse position. In opposite case a corner of - selection rectangle will correspond to the initial mouse position. - selected ROIs. - - - - Creates a trackbar and attaches it to the specified window. - The function createTrackbar creates a trackbar(a slider or range control) with the specified name - and range, assigns a variable value to be a position synchronized with the trackbar and specifies - the callback function onChange to be called on the trackbar position change.The created trackbar is - displayed in the specified window winName. - - Name of the created trackbar. - Name of the window that will be used as a parent of the created trackbar. - Optional pointer to an integer variable whose value reflects the position of the slider.Upon creation, - the slider position is defined by this variable. - Maximal position of the slider. The minimal position is always 0. - Pointer to the function to be called every time the slider changes position. - This function should be prototyped as void Foo(int, void\*); , where the first parameter is the trackbar - position and the second parameter is the user data(see the next parameter). If the callback is - the NULL pointer, no callbacks are called, but only value is updated. - User data that is passed as is to the callback. It can be used to handle trackbar events without using global variables. - - - - - Creates a trackbar and attaches it to the specified window. - The function createTrackbar creates a trackbar(a slider or range control) with the specified name - and range, assigns a variable value to be a position synchronized with the trackbar and specifies - the callback function onChange to be called on the trackbar position change.The created trackbar is - displayed in the specified window winName. - - Name of the created trackbar. - Name of the window that will be used as a parent of the created trackbar. - Maximal position of the slider. The minimal position is always 0. - Pointer to the function to be called every time the slider changes position. - This function should be prototyped as void Foo(int, void\*); , where the first parameter is the trackbar - position and the second parameter is the user data(see the next parameter). If the callback is - the NULL pointer, no callbacks are called, but only value is updated. - User data that is passed as is to the callback. It can be used to handle trackbar events without using global variables. - - - - - Returns the trackbar position. - - Name of the trackbar. - Name of the window that is the parent of the trackbar. - trackbar position - - - - Sets the trackbar position. - - Name of the trackbar. - Name of the window that is the parent of trackbar. - New position. - - - - Sets the trackbar maximum position. - The function sets the maximum position of the specified trackbar in the specified window. - - Name of the trackbar. - Name of the window that is the parent of trackbar. - New maximum position. - - - - Sets the trackbar minimum position. - The function sets the minimum position of the specified trackbar in the specified window. - - Name of the trackbar. - Name of the window that is the parent of trackbar. - New minimum position. - - - - get native window handle (HWND in case of Win32 and Widget in case of X Window) - - - - - - Loads an image from a file. - - Name of file to be loaded. - Specifies color type of the loaded image - - - - - Loads a multi-page image from a file. - - Name of file to be loaded. - A vector of Mat objects holding each page, if more than one. - Flag that can take values of @ref cv::ImreadModes, default with IMREAD_ANYCOLOR. - - - - - Saves an image to a specified file. - - Name of the file. - Image to be saved. - Format-specific save parameters encoded as pairs - - - - - Saves an image to a specified file. - - Name of the file. - Image to be saved. - Format-specific save parameters encoded as pairs - - - - - Saves an image to a specified file. - - Name of the file. - Image to be saved. - Format-specific save parameters encoded as pairs - - - - - Saves an image to a specified file. - - Name of the file. - Image to be saved. - Format-specific save parameters encoded as pairs - - - - - Reads image from the specified buffer in memory. - - The input array of vector of bytes. - The same flags as in imread - - - - - Reads image from the specified buffer in memory. - - The input array of vector of bytes. - The same flags as in imread - - - - - Reads image from the specified buffer in memory. - - The input array of vector of bytes. - The same flags as in imread - - - - - Reads image from the specified buffer in memory. - - The input slice of bytes. - The same flags as in imread - - - - - Compresses the image and stores it in the memory buffer - - The file extension that defines the output format - The image to be written - Output buffer resized to fit the compressed image. - Format-specific parameters. - - - - Compresses the image and stores it in the memory buffer - - The file extension that defines the output format - The image to be written - Output buffer resized to fit the compressed image. - Format-specific parameters. - - - - - - - - - - - - - - - - - - Returns Gaussian filter coefficients. - - Aperture size. It should be odd and positive. - Gaussian standard deviation. - If it is non-positive, it is computed from ksize as `sigma = 0.3*((ksize-1)*0.5 - 1) + 0.8`. - Type of filter coefficients. It can be CV_32F or CV_64F. - - - - - Returns filter coefficients for computing spatial image derivatives. - - Output matrix of row filter coefficients. It has the type ktype. - Output matrix of column filter coefficients. It has the type ktype. - Derivative order in respect of x. - Derivative order in respect of y. - Aperture size. It can be CV_SCHARR, 1, 3, 5, or 7. - Flag indicating whether to normalize (scale down) the filter coefficients or not. - Theoretically, the coefficients should have the denominator \f$=2^{ksize*2-dx-dy-2}\f$. - If you are going to filter floating-point images, you are likely to use the normalized kernels. - But if you compute derivatives of an 8-bit image, store the results in a 16-bit image, - and wish to preserve all the fractional bits, you may want to set normalize = false. - Type of filter coefficients. It can be CV_32f or CV_64F. - - - - Returns Gabor filter coefficients. - - - For more details about gabor filter equations and parameters, see: https://en.wikipedia.org/wiki/Gabor_filter - - Size of the filter returned. - Standard deviation of the gaussian envelope. - Orientation of the normal to the parallel stripes of a Gabor function. - Wavelength of the sinusoidal factor. - Spatial aspect ratio. - Phase offset. - Type of filter coefficients. It can be CV_32F or CV_64F. - - - - - Returns a structuring element of the specified size and shape for morphological operations. - The function constructs and returns the structuring element that can be further passed to erode, - dilate or morphologyEx.But you can also construct an arbitrary binary mask yourself and use it as the structuring element. - - Element shape that could be one of MorphShapes - Size of the structuring element. - - - - - Returns a structuring element of the specified size and shape for morphological operations. - The function constructs and returns the structuring element that can be further passed to erode, - dilate or morphologyEx.But you can also construct an arbitrary binary mask yourself and use it as the structuring element. - - Element shape that could be one of MorphShapes - Size of the structuring element. - Anchor position within the element. The default value (−1,−1) means that the anchor is at the center. - Note that only the shape of a cross-shaped element depends on the anchor position. - In other cases the anchor just regulates how much the result of the morphological operation is shifted. - - - - - Smoothes image using median filter - - The source 1-, 3- or 4-channel image. - When ksize is 3 or 5, the image depth should be CV_8U , CV_16U or CV_32F. - For larger aperture sizes it can only be CV_8U - The destination array; will have the same size and the same type as src - The aperture linear size. It must be odd and more than 1, i.e. 3, 5, 7 ... - - - - Blurs an image using a Gaussian filter. - - input image; the image can have any number of channels, which are processed independently, - but the depth should be CV_8U, CV_16U, CV_16S, CV_32F or CV_64F. - output image of the same size and type as src. - Gaussian kernel size. ksize.width and ksize.height can differ but they both must be positive and odd. - Or, they can be zero’s and then they are computed from sigma* . - Gaussian kernel standard deviation in X direction. - Gaussian kernel standard deviation in Y direction; if sigmaY is zero, it is set to be equal to sigmaX, - if both sigmas are zeros, they are computed from ksize.width and ksize.height, - respectively (see getGaussianKernel() for details); to fully control the result - regardless of possible future modifications of all this semantics, it is recommended to specify all of ksize, sigmaX, and sigmaY. - pixel extrapolation method - - - - Applies bilateral filter to the image - - The source 8-bit or floating-point, 1-channel or 3-channel image - The destination image; will have the same size and the same type as src - The diameter of each pixel neighborhood, that is used during filtering. - If it is non-positive, it's computed from sigmaSpace - Filter sigma in the color space. - Larger value of the parameter means that farther colors within the pixel neighborhood - will be mixed together, resulting in larger areas of semi-equal color - Filter sigma in the coordinate space. - Larger value of the parameter means that farther pixels will influence each other - (as long as their colors are close enough; see sigmaColor). Then d>0 , it specifies - the neighborhood size regardless of sigmaSpace, otherwise d is proportional to sigmaSpace - - - - - Smoothes image using box filter - - The source image - The destination image; will have the same size and the same type as src - - The smoothing kernel size - The anchor point. The default value Point(-1,-1) means that the anchor is at the kernel center - Indicates, whether the kernel is normalized by its area or not - The border mode used to extrapolate pixels outside of the image - - - - Calculates the normalized sum of squares of the pixel values overlapping the filter. - - For every pixel f(x, y) in the source image, the function calculates the sum of squares of those neighboring - pixel values which overlap the filter placed over the pixel f(x, y). - - The unnormalized square box filter can be useful in computing local image statistics such as the the local - variance and standard deviation around the neighborhood of a pixel. - - - - - - - - - - - - Smoothes image using normalized box filter - - The source image - The destination image; will have the same size and the same type as src - The smoothing kernel size - The anchor point. The default value Point(-1,-1) means that the anchor is at the kernel center - The border mode used to extrapolate pixels outside of the image - - - - Convolves an image with the kernel - - The source image - The destination image. It will have the same size and the same number of channels as src - The desired depth of the destination image. If it is negative, it will be the same as src.depth() - Convolution kernel (or rather a correlation kernel), - a single-channel floating point matrix. If you want to apply different kernels to - different channels, split the image into separate color planes using split() and process them individually - The anchor of the kernel that indicates the relative position of - a filtered point within the kernel. The anchor should lie within the kernel. - The special default value (-1,-1) means that the anchor is at the kernel center - The optional value added to the filtered pixels before storing them in dst - The pixel extrapolation method - - - - Applies separable linear filter to an image - - The source image - The destination image; will have the same size and the same number of channels as src - The destination image depth - The coefficients for filtering each row - The coefficients for filtering each column - The anchor position within the kernel; The default value (-1, 1) means that the anchor is at the kernel center - The value added to the filtered results before storing them - The pixel extrapolation method - - - - Calculates the first, second, third or mixed image derivatives using an extended Sobel operator - - The source image - The destination image; will have the same size and the same number of channels as src - The destination image depth - Order of the derivative x - Order of the derivative y - Size of the extended Sobel kernel, must be 1, 3, 5 or 7 - The optional scale factor for the computed derivative values (by default, no scaling is applied - The optional delta value, added to the results prior to storing them in dst - The pixel extrapolation method - - - - Calculates the first order image derivative in both x and y using a Sobel operator - - input image. - output image with first-order derivative in x. - output image with first-order derivative in y. - size of Sobel kernel. It must be 3. - pixel extrapolation method - - - - Calculates the first x- or y- image derivative using Scharr operator - - The source image - The destination image; will have the same size and the same number of channels as src - The destination image depth - Order of the derivative x - Order of the derivative y - The optional scale factor for the computed derivative values (by default, no scaling is applie - The optional delta value, added to the results prior to storing them in dst - The pixel extrapolation method - - - - Calculates the Laplacian of an image - - Source image - Destination image; will have the same size and the same number of channels as src - The desired depth of the destination image - The aperture size used to compute the second-derivative filters - The optional scale factor for the computed Laplacian values (by default, no scaling is applied - The optional delta value, added to the results prior to storing them in dst - The pixel extrapolation method - - - - Finds edges in an image using Canny algorithm. - - Single-channel 8-bit input image - The output edge map. It will have the same size and the same type as image - The first threshold for the hysteresis procedure - The second threshold for the hysteresis procedure - Aperture size for the Sobel operator [By default this is ApertureSize.Size3] - Indicates, whether the more accurate L2 norm should be used to compute the image gradient magnitude (true), or a faster default L1 norm is enough (false). [By default this is false] - - - - Finds edges in an image using the Canny algorithm with custom image gradient. - - 16-bit x derivative of input image (CV_16SC1 or CV_16SC3). - 16-bit y derivative of input image (same type as dx). - output edge map; single channels 8-bit image, which has the same size as image. - first threshold for the hysteresis procedure. - second threshold for the hysteresis procedure. - Indicates, whether the more accurate L2 norm should be used to compute the image gradient magnitude (true), or a faster default L1 norm is enough (false). [By default this is false] - - - - Calculates the minimal eigenvalue of gradient matrices for corner detection. - - Input single-channel 8-bit or floating-point image. - Image to store the minimal eigenvalues. It has the type CV_32FC1 and the same size as src . - Neighborhood size (see the details on #cornerEigenValsAndVecs ). - Aperture parameter for the Sobel operator. - Pixel extrapolation method. See #BorderTypes. #BORDER_WRAP is not supported. - - - - Harris corner detector. - - Input single-channel 8-bit or floating-point image. - Image to store the Harris detector responses. - It has the type CV_32FC1 and the same size as src. - Neighborhood size (see the details on #cornerEigenValsAndVecs ). - Aperture parameter for the Sobel operator. - Harris detector free parameter. See the formula above. - Pixel extrapolation method. See #BorderTypes. #BORDER_WRAP is not supported. - - - - computes both eigenvalues and the eigenvectors of 2x2 derivative covariation matrix at each pixel. The output is stored as 6-channel matrix. - - - - - - - - - - computes another complex cornerness criteria at each pixel - - - - - - - - - adjusts the corner locations with sub-pixel accuracy to maximize the certain cornerness criteria - - Input image. - Initial coordinates of the input corners and refined coordinates provided for output. - Half of the side length of the search window. - Half of the size of the dead region in the middle of the search zone - over which the summation in the formula below is not done. It is used sometimes to avoid possible singularities - of the autocorrelation matrix. The value of (-1,-1) indicates that there is no such a size. - Criteria for termination of the iterative process of corner refinement. - That is, the process of corner position refinement stops either after criteria.maxCount iterations - or when the corner position moves by less than criteria.epsilon on some iteration. - - - - - finds the strong enough corners where the cornerMinEigenVal() or cornerHarris() report the local maxima - - Input 8-bit or floating-point 32-bit, single-channel image. - Maximum number of corners to return. If there are more corners than are found, - the strongest of them is returned. - Parameter characterizing the minimal accepted quality of image corners. - The parameter value is multiplied by the best corner quality measure, which is the minimal eigenvalue - or the Harris function response (see cornerHarris() ). The corners with the quality measure less than - the product are rejected. For example, if the best corner has the quality measure = 1500, and the qualityLevel=0.01, - then all the corners with the quality measure less than 15 are rejected. - Minimum possible Euclidean distance between the returned corners. - Optional region of interest. If the image is not empty - (it needs to have the type CV_8UC1 and the same size as image ), it specifies the region - in which the corners are detected. - Size of an average block for computing a derivative covariation matrix over each pixel neighborhood. - Parameter indicating whether to use a Harris detector - Free parameter of the Harris detector. - Output vector of detected corners. - - - - Finds lines in a binary image using standard Hough transform. - - The 8-bit, single-channel, binary source image. The image may be modified by the function - Distance resolution of the accumulator in pixels - Angle resolution of the accumulator in radians - The accumulator threshold parameter. Only those lines are returned that get enough votes ( > threshold ) - For the multi-scale Hough transform it is the divisor for the distance resolution rho. [By default this is 0] - For the multi-scale Hough transform it is the divisor for the distance resolution theta. [By default this is 0] - The output vector of lines. Each line is represented by a two-element vector (rho, theta) . - rho is the distance from the coordinate origin (0,0) (top-left corner of the image) and theta is the line rotation angle in radians - - - - Finds lines segments in a binary image using probabilistic Hough transform. - - - Distance resolution of the accumulator in pixels - Angle resolution of the accumulator in radians - The accumulator threshold parameter. Only those lines are returned that get enough votes ( > threshold ) - The minimum line length. Line segments shorter than that will be rejected. [By default this is 0] - The maximum allowed gap between points on the same line to link them. [By default this is 0] - The output lines. Each line is represented by a 4-element vector (x1, y1, x2, y2) - - - - Finds lines in a set of points using the standard Hough transform. - The function finds lines in a set of points using a modification of the Hough transform. - - Input vector of points. Each vector must be encoded as a Point vector \f$(x,y)\f$. Type must be CV_32FC2 or CV_32SC2. - Output vector of found lines. Each vector is encoded as a vector<Vec3d> - Max count of hough lines. - Accumulator threshold parameter. Only those lines are returned that get enough votes - Minimum Distance value of the accumulator in pixels. - Maximum Distance value of the accumulator in pixels. - Distance resolution of the accumulator in pixels. - Minimum angle value of the accumulator in radians. - Maximum angle value of the accumulator in radians. - Angle resolution of the accumulator in radians. - - - - Finds circles in a grayscale image using a Hough transform. - - The 8-bit, single-channel, grayscale input image - The available methods are HoughMethods.Gradient and HoughMethods.GradientAlt - The inverse ratio of the accumulator resolution to the image resolution. - Minimum distance between the centers of the detected circles. - The first method-specific parameter. [By default this is 100] - The second method-specific parameter. [By default this is 100] - Minimum circle radius. [By default this is 0] - Maximum circle radius. [By default this is 0] - The output vector found circles. Each vector is encoded as 3-element floating-point vector (x, y, radius) - - - - Default borderValue for Dilate/Erode - - - - - - Dilates an image by using a specific structuring element. - - The source image - The destination image. It will have the same size and the same type as src - The structuring element used for dilation. If element=new Mat() , a 3x3 rectangular structuring element is used - Position of the anchor within the element. The default value (-1, -1) means that the anchor is at the element center - The number of times dilation is applied. [By default this is 1] - The pixel extrapolation method. [By default this is BorderType.Constant] - The border value in case of a constant border. The default value has a special meaning. [By default this is CvCpp.MorphologyDefaultBorderValue()] - - - - Erodes an image by using a specific structuring element. - - The source image - The destination image. It will have the same size and the same type as src - The structuring element used for dilation. If element=new Mat(), a 3x3 rectangular structuring element is used - Position of the anchor within the element. The default value (-1, -1) means that the anchor is at the element center - The number of times erosion is applied - The pixel extrapolation method - The border value in case of a constant border. The default value has a special meaning. [By default this is CvCpp.MorphologyDefaultBorderValue()] - - - - Performs advanced morphological transformations - - Source image - Destination image. It will have the same size and the same type as src - Type of morphological operation - Structuring element - Position of the anchor within the element. The default value (-1, -1) means that the anchor is at the element center - Number of times erosion and dilation are applied. [By default this is 1] - The pixel extrapolation method. [By default this is BorderType.Constant] - The border value in case of a constant border. The default value has a special meaning. [By default this is CvCpp.MorphologyDefaultBorderValue()] - - - - Resizes an image. - - input image. - output image; it has the size dsize (when it is non-zero) or the size computed - from src.size(), fx, and fy; the type of dst is the same as of src. - output image size; if it equals zero, it is computed as: - dsize = Size(round(fx*src.cols), round(fy*src.rows)) - Either dsize or both fx and fy must be non-zero. - scale factor along the horizontal axis; when it equals 0, - it is computed as: (double)dsize.width/src.cols - scale factor along the vertical axis; when it equals 0, - it is computed as: (double)dsize.height/src.rows - interpolation method - - - - Applies an affine transformation to an image. - - input image. - output image that has the size dsize and the same type as src. - 2x3 transformation matrix. - size of the output image. - combination of interpolation methods and the optional flag - WARP_INVERSE_MAP that means that M is the inverse transformation (dst -> src) . - pixel extrapolation method; when borderMode=BORDER_TRANSPARENT, - it means that the pixels in the destination image corresponding to the "outliers" - in the source image are not modified by the function. - value used in case of a constant border; by default, it is 0. - - - - Applies a perspective transformation to an image. - - input image. - output image that has the size dsize and the same type as src. - 3x3 transformation matrix. - size of the output image. - combination of interpolation methods (INTER_LINEAR or INTER_NEAREST) - and the optional flag WARP_INVERSE_MAP, that sets M as the inverse transformation (dst -> src). - pixel extrapolation method (BORDER_CONSTANT or BORDER_REPLICATE). - value used in case of a constant border; by default, it equals 0. - - - - Applies a perspective transformation to an image. - - input image. - output image that has the size dsize and the same type as src. - 3x3 transformation matrix. - size of the output image. - combination of interpolation methods (INTER_LINEAR or INTER_NEAREST) - and the optional flag WARP_INVERSE_MAP, that sets M as the inverse transformation (dst -> src). - pixel extrapolation method (BORDER_CONSTANT or BORDER_REPLICATE). - value used in case of a constant border; by default, it equals 0. - - - - Applies a generic geometrical transformation to an image. - - Source image. - Destination image. It has the same size as map1 and the same type as src - The first map of either (x,y) points or just x values having the type CV_16SC2, CV_32FC1, or CV_32FC2. - The second map of y values having the type CV_16UC1, CV_32FC1, or none (empty map if map1 is (x,y) points), respectively. - Interpolation method. The method INTER_AREA is not supported by this function. - Pixel extrapolation method. When borderMode=BORDER_TRANSPARENT, - it means that the pixels in the destination image that corresponds to the "outliers" in - the source image are not modified by the function. - Value used in case of a constant border. By default, it is 0. - - - - Converts image transformation maps from one representation to another. - - The first input map of type CV_16SC2 , CV_32FC1 , or CV_32FC2 . - The second input map of type CV_16UC1 , CV_32FC1 , or none (empty matrix), respectively. - The first output map that has the type dstmap1type and the same size as src. - The second output map. - Type of the first output map that should be CV_16SC2 , CV_32FC1 , or CV_32FC2 . - Flag indicating whether the fixed-point maps are used for the nearest-neighbor or for a more complex interpolation. - - - - Calculates an affine matrix of 2D rotation. - - Center of the rotation in the source image. - Rotation angle in degrees. Positive values mean counter-clockwise rotation (the coordinate origin is assumed to be the top-left corner). - Isotropic scale factor. - - - - - Inverts an affine transformation. - - Original affine transformation. - Output reverse affine transformation. - - - - Calculates a perspective transform from four pairs of the corresponding points. - The function calculates the 3×3 matrix of a perspective transform. - - Coordinates of quadrangle vertices in the source image. - Coordinates of the corresponding quadrangle vertices in the destination image. - - - - - Calculates a perspective transform from four pairs of the corresponding points. - The function calculates the 3×3 matrix of a perspective transform. - - Coordinates of quadrangle vertices in the source image. - Coordinates of the corresponding quadrangle vertices in the destination image. - - - - - Calculates an affine transform from three pairs of the corresponding points. - The function calculates the 2×3 matrix of an affine transform. - - Coordinates of triangle vertices in the source image. - Coordinates of the corresponding triangle vertices in the destination image. - - - - - Calculates an affine transform from three pairs of the corresponding points. - The function calculates the 2×3 matrix of an affine transform. - - Coordinates of triangle vertices in the source image. - Coordinates of the corresponding triangle vertices in the destination image. - - - - - Retrieves a pixel rectangle from an image with sub-pixel accuracy. - - Source image. - Size of the extracted patch. - Floating point coordinates of the center of the extracted rectangle - within the source image. The center must be inside the image. - Extracted patch that has the size patchSize and the same number of channels as src . - Depth of the extracted pixels. By default, they have the same depth as src. - - - - Remaps an image to log-polar space. - - Source image - Destination image - The transformation center; where the output precision is maximal - Magnitude scale parameter. - A combination of interpolation methods, see cv::InterpolationFlags - - - - Remaps an image to polar space. - - Source image - Destination image - The transformation center - Inverse magnitude scale parameter - A combination of interpolation methods, see cv::InterpolationFlags - - - - Remaps an image to polar or semilog-polar coordinates space. - - - - The function can not operate in-place. - - To calculate magnitude and angle in degrees #cartToPolar is used internally thus angles are measured from 0 to 360 with accuracy about 0.3 degrees. - - This function uses #remap. Due to current implementation limitations the size of an input and output images should be less than 32767x32767. - - Source image. - Destination image. It will have same type as src. - The destination image size (see description for valid options). - The transformation center. - The radius of the bounding circle to transform. It determines the inverse magnitude scale parameter too. - interpolation methods. - interpolation methods. - - - - Calculates the integral of an image. - The function calculates one or more integral images for the source image. - - - - - - - - Calculates the integral of an image. - The function calculates one or more integral images for the source image. - - - - - - - - - Calculates the integral of an image. - The function calculates one or more integral images for the source image. - - input image as W×H, 8-bit or floating-point (32f or 64f). - integral image as (W+1)×(H+1) , 32-bit integer or floating-point (32f or 64f). - integral image for squared pixel values; it is (W+1)×(H+1), double-precision floating-point (64f) array. - integral for the image rotated by 45 degrees; it is (W+1)×(H+1) array with the same data type as sum. - desired depth of the integral and the tilted integral images, CV_32S, CV_32F, or CV_64F. - desired depth of the integral image of squared pixel values, CV_32F or CV_64F. - - - - Adds an image to the accumulator. - - Input image as 1- or 3-channel, 8-bit or 32-bit floating point. - Accumulator image with the same number of channels as input image, 32-bit or 64-bit floating-point. - Optional operation mask. - - - - Adds the square of a source image to the accumulator. - - Input image as 1- or 3-channel, 8-bit or 32-bit floating point. - Accumulator image with the same number of channels as input image, 32-bit or 64-bit floating-point. - Optional operation mask. - - - - Adds the per-element product of two input images to the accumulator. - - First input image, 1- or 3-channel, 8-bit or 32-bit floating point. - Second input image of the same type and the same size as src1 - Accumulator with the same number of channels as input images, 32-bit or 64-bit floating-point. - Optional operation mask. - - - - Updates a running average. - - Input image as 1- or 3-channel, 8-bit or 32-bit floating point. - Accumulator image with the same number of channels as input image, 32-bit or 64-bit floating-point. - Weight of the input image. - Optional operation mask. - - - - The function is used to detect translational shifts that occur between two images. - - The operation takes advantage of the Fourier shift theorem for detecting the translational shift in - the frequency domain.It can be used for fast image registration as well as motion estimation. - For more information please see http://en.wikipedia.org/wiki/Phase_correlation. - - Calculates the cross-power spectrum of two supplied source arrays. The arrays are padded if needed with getOptimalDFTSize. - - Source floating point array (CV_32FC1 or CV_64FC1) - Source floating point array (CV_32FC1 or CV_64FC1) - Floating point array with windowing coefficients to reduce edge effects (optional). - Signal power within the 5x5 centroid around the peak, between 0 and 1 (optional). - detected phase shift(sub-pixel) between the two arrays. - - - - Computes a Hanning window coefficients in two dimensions. - - Destination array to place Hann coefficients in - The window size specifications - Created array type - - - - Applies a fixed-level threshold to each array element. - - input array (single-channel, 8-bit or 32-bit floating point). - output array of the same size and type as src. - threshold value. - maximum value to use with the THRESH_BINARY and THRESH_BINARY_INV thresholding types. - thresholding type (see the details below). - the computed threshold value when type == OTSU - - - - Applies an adaptive threshold to an array. - - Source 8-bit single-channel image. - Destination image of the same size and the same type as src . - Non-zero value assigned to the pixels for which the condition is satisfied. See the details below. - Adaptive thresholding algorithm to use, ADAPTIVE_THRESH_MEAN_C or ADAPTIVE_THRESH_GAUSSIAN_C . - Thresholding type that must be either THRESH_BINARY or THRESH_BINARY_INV . - Size of a pixel neighborhood that is used to calculate a threshold value for the pixel: 3, 5, 7, and so on. - Constant subtracted from the mean or weighted mean (see the details below). - Normally, it is positive but may be zero or negative as well. - - - - Blurs an image and downsamples it. - - input image. - output image; it has the specified size and the same type as src. - size of the output image; by default, it is computed as Size((src.cols+1)/2 - - - - - - - - - - - - - - Upsamples an image and then blurs it. - - input image. - output image. It has the specified size and the same type as src. - size of the output image; by default, it is computed as Size(src.cols*2, (src.rows*2) - - - - - computes the joint dense histogram for a set of images. - - - - - - - - - - - - - - computes the joint dense histogram for a set of images. - - - - - - - - - - - - - - computes the joint dense histogram for a set of images. - - - - - - - - - - - compares two histograms stored in dense arrays - - The first compared histogram - The second compared histogram of the same size as h1 - The comparison method - - - - - normalizes the grayscale image brightness and contrast by normalizing its histogram - - The source 8-bit single channel image - The destination image; will have the same size and the same type as src - - - - Creates a predefined CLAHE object - - - - - - - - Computes the "minimal work" distance between two weighted point configurations. - - The function computes the earth mover distance and/or a lower boundary of the distance between the - two weighted point configurations.One of the applications described in @cite RubnerSept98, - @cite Rubner2000 is multi-dimensional histogram comparison for image retrieval.EMD is a transportation - problem that is solved using some modification of a simplex algorithm, thus the complexity is - exponential in the worst case, though, on average it is much faster.In the case of a real metric - the lower boundary can be calculated even faster (using linear-time algorithm) and it can be used - to determine roughly whether the two signatures are far enough so that they cannot relate to the same object. - - First signature, a \f$\texttt{size1}\times \texttt{dims}+1\f$ floating-point matrix. - Each row stores the point weight followed by the point coordinates.The matrix is allowed to have - a single column(weights only) if the user-defined cost matrix is used.The weights must be non-negative - and have at least one non-zero value. - Second signature of the same format as signature1 , though the number of rows - may be different.The total weights may be different.In this case an extra "dummy" point is added - to either signature1 or signature2. The weights must be non-negative and have at least one non-zero value. - Used metric. - - - - - Computes the "minimal work" distance between two weighted point configurations. - - The function computes the earth mover distance and/or a lower boundary of the distance between the - two weighted point configurations.One of the applications described in @cite RubnerSept98, - @cite Rubner2000 is multi-dimensional histogram comparison for image retrieval.EMD is a transportation - problem that is solved using some modification of a simplex algorithm, thus the complexity is - exponential in the worst case, though, on average it is much faster.In the case of a real metric - the lower boundary can be calculated even faster (using linear-time algorithm) and it can be used - to determine roughly whether the two signatures are far enough so that they cannot relate to the same object. - - First signature, a \f$\texttt{size1}\times \texttt{dims}+1\f$ floating-point matrix. - Each row stores the point weight followed by the point coordinates.The matrix is allowed to have - a single column(weights only) if the user-defined cost matrix is used.The weights must be non-negative - and have at least one non-zero value. - Second signature of the same format as signature1 , though the number of rows - may be different.The total weights may be different.In this case an extra "dummy" point is added - to either signature1 or signature2. The weights must be non-negative and have at least one non-zero value. - Used metric. - User-defined size1 x size2 cost matrix. Also, if a cost matrix - is used, lower boundary lowerBound cannot be calculated because it needs a metric function. - - - - - Computes the "minimal work" distance between two weighted point configurations. - - The function computes the earth mover distance and/or a lower boundary of the distance between the - two weighted point configurations.One of the applications described in @cite RubnerSept98, - @cite Rubner2000 is multi-dimensional histogram comparison for image retrieval.EMD is a transportation - problem that is solved using some modification of a simplex algorithm, thus the complexity is - exponential in the worst case, though, on average it is much faster.In the case of a real metric - the lower boundary can be calculated even faster (using linear-time algorithm) and it can be used - to determine roughly whether the two signatures are far enough so that they cannot relate to the same object. - - First signature, a \f$\texttt{size1}\times \texttt{dims}+1\f$ floating-point matrix. - Each row stores the point weight followed by the point coordinates.The matrix is allowed to have - a single column(weights only) if the user-defined cost matrix is used.The weights must be non-negative - and have at least one non-zero value. - Second signature of the same format as signature1 , though the number of rows - may be different.The total weights may be different.In this case an extra "dummy" point is added - to either signature1 or signature2. The weights must be non-negative and have at least one non-zero value. - Used metric. - User-defined size1 x size2 cost matrix. Also, if a cost matrix - is used, lower boundary lowerBound cannot be calculated because it needs a metric function. - Optional input/output parameter: lower boundary of a distance between the two - signatures that is a distance between mass centers.The lower boundary may not be calculated if - the user-defined cost matrix is used, the total weights of point configurations are not equal, or - if the signatures consist of weights only(the signature matrices have a single column). You ** must** - initialize \*lowerBound.If the calculated distance between mass centers is greater or equal to - \*lowerBound(it means that the signatures are far enough), the function does not calculate EMD. - In any case \*lowerBound is set to the calculated distance between mass centers on return. - Thus, if you want to calculate both distance between mass centers and EMD, \*lowerBound should be set to 0. - Resultant size1 x size2 flow matrix: flow[i,j] is a flow from i-th point of signature1 - to j-th point of signature2. - - - - - Performs a marker-based image segmentation using the watershed algorithm. - - Input 8-bit 3-channel image. - Input/output 32-bit single-channel image (map) of markers. - It should have the same size as image. - - - - Performs initial step of meanshift segmentation of an image. - - The source 8-bit, 3-channel image. - The destination image of the same format and the same size as the source. - The spatial window radius. - The color window radius. - Maximum level of the pyramid for the segmentation. - Termination criteria: when to stop meanshift iterations. - - - - Segments the image using GrabCut algorithm - - Input 8-bit 3-channel image. - Input/output 8-bit single-channel mask. - The mask is initialized by the function when mode is set to GC_INIT_WITH_RECT. - Its elements may have Cv2.GC_BGD / Cv2.GC_FGD / Cv2.GC_PR_BGD / Cv2.GC_PR_FGD - ROI containing a segmented object. The pixels outside of the ROI are - marked as "obvious background". The parameter is only used when mode==GC_INIT_WITH_RECT. - Temporary array for the background model. Do not modify it while you are processing the same image. - Temporary arrays for the foreground model. Do not modify it while you are processing the same image. - Number of iterations the algorithm should make before returning the result. - Note that the result can be refined with further calls with mode==GC_INIT_WITH_MASK or mode==GC_EVAL . - Operation mode that could be one of GrabCutFlag value. - - - - Calculates the distance to the closest zero pixel for each pixel of the source image. - - 8-bit, single-channel (binary) source image. - Output image with calculated distances. It is a 8-bit or 32-bit floating-point, - single-channel image of the same size as src. - Output 2D array of labels (the discrete Voronoi diagram). It has the type - CV_32SC1 and the same size as src. - Type of distance - Size of the distance transform mask, see #DistanceTransformMasks. - #DIST_MASK_PRECISE is not supported by this variant. In case of the #DIST_L1 or #DIST_C distance type, - the parameter is forced to 3 because a 3x3 mask gives the same result as 5x5 or any larger aperture. - Type of the label array to build - - - - computes the distance transform map - - 8-bit, single-channel (binary) source image. - Output image with calculated distances. It is a 8-bit or 32-bit floating-point, - single-channel image of the same size as src. - Type of distance - Size of the distance transform mask, see #DistanceTransformMasks. In case of the - #DIST_L1 or #DIST_C distance type, the parameter is forced to 3 because a 3x3 mask gives - the same result as 5x5 or any larger aperture. - Type of output image. It can be MatType.CV_8U or MatType.CV_32F. - Type CV_8U can be used only for the first variant of the function and distanceType == #DIST_L1. - - - - Fills a connected component with the given color. - - Input/output 1- or 3-channel, 8-bit, or floating-point image. - It is modified by the function unless the FLOODFILL_MASK_ONLY flag is set in the - second variant of the function. See the details below. - Starting point. - New value of the repainted domain pixels. - - - - - Fills a connected component with the given color. - - Input/output 1- or 3-channel, 8-bit, or floating-point image. - It is modified by the function unless the FLOODFILL_MASK_ONLY flag is set in the - second variant of the function. See the details below. - Starting point. - New value of the repainted domain pixels. - Optional output parameter set by the function to the - minimum bounding rectangle of the repainted domain. - Maximal lower brightness/color difference between the currently - observed pixel and one of its neighbors belonging to the component, or a seed pixel - being added to the component. - Maximal upper brightness/color difference between the currently - observed pixel and one of its neighbors belonging to the component, or a seed pixel - being added to the component. - Operation flags. Lower bits contain a connectivity value, - 4 (default) or 8, used within the function. Connectivity determines which - neighbors of a pixel are considered. Using FloodFillFlags.MaskOnly will - fill in the mask using the grey value 255 (white). - - - - - Fills a connected component with the given color. - - Input/output 1- or 3-channel, 8-bit, or floating-point image. - It is modified by the function unless the FLOODFILL_MASK_ONLY flag is set in the - second variant of the function. See the details below. - (For the second function only) Operation mask that should be a single-channel 8-bit image, - 2 pixels wider and 2 pixels taller. The function uses and updates the mask, so you take responsibility of - initializing the mask content. Flood-filling cannot go across non-zero pixels in the mask. For example, - an edge detector output can be used as a mask to stop filling at edges. It is possible to use the same mask - in multiple calls to the function to make sure the filled area does not overlap. - Starting point. - New value of the repainted domain pixels. - - - - - Fills a connected component with the given color. - - Input/output 1- or 3-channel, 8-bit, or floating-point image. - It is modified by the function unless the FLOODFILL_MASK_ONLY flag is set in the - second variant of the function. See the details below. - (For the second function only) Operation mask that should be a single-channel 8-bit image, - 2 pixels wider and 2 pixels taller. The function uses and updates the mask, so you take responsibility of - initializing the mask content. Flood-filling cannot go across non-zero pixels in the mask. For example, - an edge detector output can be used as a mask to stop filling at edges. It is possible to use the same mask - in multiple calls to the function to make sure the filled area does not overlap. - Starting point. - New value of the repainted domain pixels. - Optional output parameter set by the function to the - minimum bounding rectangle of the repainted domain. - Maximal lower brightness/color difference between the currently - observed pixel and one of its neighbors belonging to the component, or a seed pixel - being added to the component. - Maximal upper brightness/color difference between the currently - observed pixel and one of its neighbors belonging to the component, or a seed pixel - being added to the component. - Operation flags. Lower bits contain a connectivity value, - 4 (default) or 8, used within the function. Connectivity determines which - neighbors of a pixel are considered. Using FloodFillFlags.MaskOnly will - fill in the mask using the grey value 255 (white). - - - - - Performs linear blending of two images: - dst(i,j) = weights1(i,j)*src1(i,j) + weights2(i,j)*src2(i,j) - - It has a type of CV_8UC(n) or CV_32FC(n), where n is a positive integer. - It has the same type and size as src1. - It has a type of CV_32FC1 and the same size with src1. - It has a type of CV_32FC1 and the same size with src1. - It is created if it does not have the same size and type with src1. - - - - Converts image from one color space to another - - The source image, 8-bit unsigned, 16-bit unsigned or single-precision floating-point - The destination image; will have the same size and the same depth as src - The color space conversion code - The number of channels in the destination image; if the parameter is 0, the number of the channels will be derived automatically from src and the code - - - - Converts an image from one color space to another where the source image is stored in two planes. - This function only supports YUV420 to RGB conversion as of now. - - 8-bit image (#CV_8U) of the Y plane. - image containing interleaved U/V plane. - output image. - Specifies the type of conversion. It can take any of the following values: - - #COLOR_YUV2BGR_NV12 - - #COLOR_YUV2RGB_NV12 - - #COLOR_YUV2BGRA_NV12 - - #COLOR_YUV2RGBA_NV12 - - #COLOR_YUV2BGR_NV21 - - #COLOR_YUV2RGB_NV21 - - #COLOR_YUV2BGRA_NV21 - - #COLOR_YUV2RGBA_NV21 - - - - main function for all demosaicing processes - - input image: 8-bit unsigned or 16-bit unsigned. - output image of the same size and depth as src. - Color space conversion code (see the description below). - number of channels in the destination image; if the parameter is 0, - the number of the channels is derived automatically from src and code. - - The function can do the following transformations: - - - Demosaicing using bilinear interpolation - - #COLOR_BayerBG2BGR , #COLOR_BayerGB2BGR , #COLOR_BayerRG2BGR , #COLOR_BayerGR2BGR - #COLOR_BayerBG2GRAY , #COLOR_BayerGB2GRAY , #COLOR_BayerRG2GRAY , #COLOR_BayerGR2GRAY - - - Demosaicing using Variable Number of Gradients. - - #COLOR_BayerBG2BGR_VNG , #COLOR_BayerGB2BGR_VNG , #COLOR_BayerRG2BGR_VNG , #COLOR_BayerGR2BGR_VNG - - - Edge-Aware Demosaicing. - - #COLOR_BayerBG2BGR_EA , #COLOR_BayerGB2BGR_EA , #COLOR_BayerRG2BGR_EA , #COLOR_BayerGR2BGR_EA - - - Demosaicing with alpha channel - - # COLOR_BayerBG2BGRA , #COLOR_BayerGB2BGRA , #COLOR_BayerRG2BGRA , #COLOR_BayerGR2BGRA - - - - - Calculates all of the moments - up to the third order of a polygon or rasterized shape. - - A raster image (single-channel, 8-bit or floating-point - 2D array) or an array ( 1xN or Nx1 ) of 2D points ( Point or Point2f ) - If it is true, then all the non-zero image pixels are treated as 1’s - - - - - Calculates all of the moments - up to the third order of a polygon or rasterized shape. - - A raster image (8-bit) 2D array - If it is true, then all the non-zero image pixels are treated as 1’s - - - - - Calculates all of the moments - up to the third order of a polygon or rasterized shape. - - A raster image (floating-point) 2D array - If it is true, then all the non-zero image pixels are treated as 1’s - - - - - Calculates all of the moments - up to the third order of a polygon or rasterized shape. - - Array of 2D points - If it is true, then all the non-zero image pixels are treated as 1’s - - - - - Calculates all of the moments - up to the third order of a polygon or rasterized shape. - - Array of 2D points - If it is true, then all the non-zero image pixels are treated as 1’s - - - - - Computes the proximity map for the raster template and the image where the template is searched for - - Image where the search is running; should be 8-bit or 32-bit floating-point - Searched template; must be not greater than the source image and have the same data type - A map of comparison results; will be single-channel 32-bit floating-point. - If image is WxH and templ is wxh then result will be (W-w+1) x (H-h+1). - Specifies the comparison method - Mask of searched template. It must have the same datatype and size with templ. It is not set by default. - - - - Computes the connected components labeled image of boolean image. - - image with 4 or 8 way connectivity - returns N, the total number of labels[0, N - 1] where 0 - represents the background label.ltype specifies the output label image type, an important - consideration based on the total number of labels or alternatively the total number of pixels in - the source image.ccltype specifies the connected components labeling algorithm to use, currently - Grana (BBDT) and Wu's (SAUF) algorithms are supported, see the #ConnectedComponentsAlgorithmsTypes - for details.Note that SAUF algorithm forces a row major ordering of labels while BBDT does not. - This function uses parallel version of both Grana and Wu's algorithms if at least one allowed - parallel framework is enabled and if the rows of the image are at least twice the number returned by #getNumberOfCPUs. - - the 8-bit single-channel image to be labeled - destination labeled image - 8 or 4 for 8-way or 4-way connectivity respectively - output image label type. Currently CV_32S and CV_16U are supported. - connected components algorithm type. - - - - - computes the connected components labeled image of boolean image. - image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0 - represents the background label. ltype specifies the output label image type, an important - consideration based on the total number of labels or alternatively the total number of - pixels in the source image. - - the image to be labeled - destination labeled image - 8 or 4 for 8-way or 4-way connectivity respectively - The number of labels - - - - computes the connected components labeled image of boolean image. - image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0 - represents the background label. ltype specifies the output label image type, an important - consideration based on the total number of labels or alternatively the total number of - pixels in the source image. - - the image to be labeled - destination labeled image - 8 or 4 for 8-way or 4-way connectivity respectively - output image label type. Currently CV_32S and CV_16U are supported. - The number of labels - - - - computes the connected components labeled image of boolean image. - image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0 - represents the background label. ltype specifies the output label image type, an important - consideration based on the total number of labels or alternatively the total number of - pixels in the source image. - - the image to be labeled - destination labeled rectangular array - 8 or 4 for 8-way or 4-way connectivity respectively - The number of labels - - - - computes the connected components labeled image of boolean image and also produces a statistics output for each label. - - image with 4 or 8 way connectivity - returns N, the total number of labels[0, N - 1] where 0 - represents the background label.ltype specifies the output label image type, an important - consideration based on the total number of labels or alternatively the total number of pixels in - the source image.ccltype specifies the connected components labeling algorithm to use, currently - Grana's (BBDT) and Wu's (SAUF) algorithms are supported, see the #ConnectedComponentsAlgorithmsTypes - for details.Note that SAUF algorithm forces a row major ordering of labels while BBDT does not. - This function uses parallel version of both Grana and Wu's algorithms (statistics included) if at least one allowed - parallel framework is enabled and if the rows of the image are at least twice the number returned by #getNumberOfCPUs. - - the 8-bit single-channel image to be labeled - destination labeled image - statistics output for each label, including the background label, see below for - available statistics.Statistics are accessed via stats(label, COLUMN) where COLUMN is one of #ConnectedComponentsTypes. The data type is CV_32S. - centroid output for each label, including the background label. Centroids are - accessed via centroids(label, 0) for x and centroids(label, 1) for y.The data type CV_64F. - 8 or 4 for 8-way or 4-way connectivity respectively - output image label type. Currently CV_32S and CV_16U are supported. - connected components algorithm type. - - - - - computes the connected components labeled image of boolean image. - image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0 - represents the background label. ltype specifies the output label image type, an important - consideration based on the total number of labels or alternatively the total number of - pixels in the source image. - - the image to be labeled - destination labeled image - statistics output for each label, including the background label, - see below for available statistics. Statistics are accessed via stats(label, COLUMN) - where COLUMN is one of cv::ConnectedComponentsTypes - floating point centroid (x,y) output for each label, - including the background label - 8 or 4 for 8-way or 4-way connectivity respectively - - - - - computes the connected components labeled image of boolean image. - image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0 - represents the background label. ltype specifies the output label image type, an important - consideration based on the total number of labels or alternatively the total number of - pixels in the source image. - - the image to be labeled - destination labeled image - statistics output for each label, including the background label, - see below for available statistics. Statistics are accessed via stats(label, COLUMN) - where COLUMN is one of cv::ConnectedComponentsTypes - floating point centroid (x,y) output for each label, - including the background label - 8 or 4 for 8-way or 4-way connectivity respectively - output image label type. Currently CV_32S and CV_16U are supported. - - - - - computes the connected components labeled image of boolean image. - image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0 - represents the background label. ltype specifies the output label image type, an important - consideration based on the total number of labels or alternatively the total number of - pixels in the source image. - - the image to be labeled - 8 or 4 for 8-way or 4-way connectivity respectively - - - - - - Finds contours in a binary image. - - Source, an 8-bit single-channel image. Non-zero pixels are treated as 1’s. - Zero pixels remain 0’s, so the image is treated as binary. - The function modifies the image while extracting the contours. - Detected contours. Each contour is stored as a vector of points. - Optional output vector, containing information about the image topology. - It has as many elements as the number of contours. For each i-th contour contours[i], - the members of the elements hierarchy[i] are set to 0-based indices in contours of the next - and previous contours at the same hierarchical level, the first child contour and the parent contour, respectively. - If for the contour i there are no next, previous, parent, or nested contours, the corresponding elements of hierarchy[i] will be negative. - Contour retrieval mode - Contour approximation method - Optional offset by which every contour point is shifted. - This is useful if the contours are extracted from the image ROI and then they should be analyzed in the whole image context. - - - - Finds contours in a binary image. - - Source, an 8-bit single-channel image. Non-zero pixels are treated as 1’s. - Zero pixels remain 0’s, so the image is treated as binary. - The function modifies the image while extracting the contours. - Detected contours. Each contour is stored as a vector of points. - Optional output vector, containing information about the image topology. - It has as many elements as the number of contours. For each i-th contour contours[i], - the members of the elements hierarchy[i] are set to 0-based indices in contours of the next - and previous contours at the same hierarchical level, the first child contour and the parent contour, respectively. - If for the contour i there are no next, previous, parent, or nested contours, the corresponding elements of hierarchy[i] will be negative. - Contour retrieval mode - Contour approximation method - Optional offset by which every contour point is shifted. - This is useful if the contours are extracted from the image ROI and then they should be analyzed in the whole image context. - - - - Finds contours in a binary image. - - Source, an 8-bit single-channel image. Non-zero pixels are treated as 1’s. - Zero pixels remain 0’s, so the image is treated as binary. - The function modifies the image while extracting the contours. - Contour retrieval mode - Contour approximation method - Optional offset by which every contour point is shifted. - This is useful if the contours are extracted from the image ROI and then they should be analyzed in the whole image context. - Detected contours. Each contour is stored as a vector of points. - - - - Finds contours in a binary image. - - Source, an 8-bit single-channel image. Non-zero pixels are treated as 1’s. - Zero pixels remain 0’s, so the image is treated as binary. - The function modifies the image while extracting the contours. - Contour retrieval mode - Contour approximation method - Optional offset by which every contour point is shifted. - This is useful if the contours are extracted from the image ROI and then they should be analyzed in the whole image context. - Detected contours. Each contour is stored as a vector of points. - - - - Approximates contour or a curve using Douglas-Peucker algorithm - - The polygon or curve to approximate. - Must be 1 x N or N x 1 matrix of type CV_32SC2 or CV_32FC2. - The result of the approximation; - The type should match the type of the input curve - Specifies the approximation accuracy. - This is the maximum distance between the original curve and its approximation. - The result of the approximation; - The type should match the type of the input curve - - - - Approximates contour or a curve using Douglas-Peucker algorithm - - The polygon or curve to approximate. - Specifies the approximation accuracy. - This is the maximum distance between the original curve and its approximation. - The result of the approximation; - The type should match the type of the input curve - The result of the approximation; - The type should match the type of the input curve - - - - Approximates contour or a curve using Douglas-Peucker algorithm - - The polygon or curve to approximate. - Specifies the approximation accuracy. - This is the maximum distance between the original curve and its approximation. - If true, the approximated curve is closed - (i.e. its first and last vertices are connected), otherwise it’s not - The result of the approximation; - The type should match the type of the input curve - - - - Calculates a contour perimeter or a curve length. - - The input vector of 2D points, represented by CV_32SC2 or CV_32FC2 matrix. - Indicates, whether the curve is closed or not. - - - - - Calculates a contour perimeter or a curve length. - - The input vector of 2D points. - Indicates, whether the curve is closed or not. - - - - - Calculates a contour perimeter or a curve length. - - The input vector of 2D points. - Indicates, whether the curve is closed or not. - - - - - Calculates the up-right bounding rectangle of a point set. - - The input 2D point set, represented by CV_32SC2 or CV_32FC2 matrix. - Minimal up-right bounding rectangle for the specified point set. - - - - Calculates the up-right bounding rectangle of a point set. - - The input 2D point set, represented by CV_32SC2 or CV_32FC2 matrix. - Minimal up-right bounding rectangle for the specified point set. - - - - Calculates the up-right bounding rectangle of a point set. - - The input 2D point set, represented by CV_32SC2 or CV_32FC2 matrix. - Minimal up-right bounding rectangle for the specified point set. - - - - Calculates the contour area - - The contour vertices, represented by CV_32SC2 or CV_32FC2 matrix - - - - - - Calculates the contour area - - The contour vertices, represented by CV_32SC2 or CV_32FC2 matrix - - - - - - Calculates the contour area - - The contour vertices, represented by CV_32SC2 or CV_32FC2 matrix - - - - - - Finds the minimum area rotated rectangle enclosing a 2D point set. - - The input 2D point set, represented by CV_32SC2 or CV_32FC2 matrix. - - - - - Finds the minimum area rotated rectangle enclosing a 2D point set. - - The input 2D point set, represented by CV_32SC2 or CV_32FC2 matrix. - - - - - Finds the minimum area rotated rectangle enclosing a 2D point set. - - The input 2D point set, represented by CV_32SC2 or CV_32FC2 matrix. - - - - - Finds the four vertices of a rotated rect. Useful to draw the rotated rectangle. - - The function finds the four vertices of a rotated rectangle.This function is useful to draw the - rectangle.In C++, instead of using this function, you can directly use RotatedRect::points method. Please - visit the @ref tutorial_bounding_rotated_ellipses "tutorial on Creating Bounding rotated boxes and ellipses for contours" for more information. - - The input rotated rectangle. It may be the output of - The output array of four vertices of rectangles. - - - - - Finds the four vertices of a rotated rect. Useful to draw the rotated rectangle. - - The function finds the four vertices of a rotated rectangle.This function is useful to draw the - rectangle.In C++, instead of using this function, you can directly use RotatedRect::points method. Please - visit the @ref tutorial_bounding_rotated_ellipses "tutorial on Creating Bounding rotated boxes and ellipses for contours" for more information. - - The input rotated rectangle. It may be the output of - The output array of four vertices of rectangles. - - - - Finds the minimum area circle enclosing a 2D point set. - - The input 2D point set, represented by CV_32SC2 or CV_32FC2 matrix. - The output center of the circle - The output radius of the circle - - - - Finds the minimum area circle enclosing a 2D point set. - - The input 2D point set, represented by CV_32SC2 or CV_32FC2 matrix. - The output center of the circle - The output radius of the circle - - - - Finds the minimum area circle enclosing a 2D point set. - - The input 2D point set, represented by CV_32SC2 or CV_32FC2 matrix. - The output center of the circle - The output radius of the circle - - - - Finds a triangle of minimum area enclosing a 2D point set and returns its area. - - Input vector of 2D points with depth CV_32S or CV_32F, stored in std::vector or Mat - Output vector of three 2D points defining the vertices of the triangle. The depth - Triangle area - - - - Finds a triangle of minimum area enclosing a 2D point set and returns its area. - - Input vector of 2D points with depth CV_32S or CV_32F, stored in std::vector or Mat - Output vector of three 2D points defining the vertices of the triangle. The depth - Triangle area - - - - Finds a triangle of minimum area enclosing a 2D point set and returns its area. - - Input vector of 2D points with depth CV_32S or CV_32F, stored in std::vector or Mat - Output vector of three 2D points defining the vertices of the triangle. The depth - Triangle area - - - - Compares two shapes. - - First contour or grayscale image. - Second contour or grayscale image. - Comparison method - Method-specific parameter (not supported now) - - - - - Compares two shapes. - - First contour or grayscale image. - Second contour or grayscale image. - Comparison method - Method-specific parameter (not supported now) - - - - - Computes convex hull for a set of 2D points. - - The input 2D point set, represented by CV_32SC2 or CV_32FC2 matrix - The output convex hull. It is either a vector of points that form the - hull (must have the same type as the input points), or a vector of 0-based point - indices of the hull points in the original array (since the set of convex hull - points is a subset of the original point set). - If true, the output convex hull will be oriented clockwise, - otherwise it will be oriented counter-clockwise. Here, the usual screen coordinate - system is assumed - the origin is at the top-left corner, x axis is oriented to the right, - and y axis is oriented downwards. - - - - - Computes convex hull for a set of 2D points. - - The input 2D point set, represented by CV_32SC2 or CV_32FC2 matrix - If true, the output convex hull will be oriented clockwise, - otherwise it will be oriented counter-clockwise. Here, the usual screen coordinate - system is assumed - the origin is at the top-left corner, x axis is oriented to the right, - and y axis is oriented downwards. - The output convex hull. It is a vector of points that form - the hull (must have the same type as the input points). - - - - Computes convex hull for a set of 2D points. - - The input 2D point set, represented by CV_32SC2 or CV_32FC2 matrix - If true, the output convex hull will be oriented clockwise, - otherwise it will be oriented counter-clockwise. Here, the usual screen coordinate - system is assumed - the origin is at the top-left corner, x axis is oriented to the right, - and y axis is oriented downwards. - The output convex hull. It is a vector of points that form - the hull (must have the same type as the input points). - - - - Computes convex hull for a set of 2D points. - - The input 2D point set, represented by CV_32SC2 or CV_32FC2 matrix - If true, the output convex hull will be oriented clockwise, - otherwise it will be oriented counter-clockwise. Here, the usual screen coordinate - system is assumed - the origin is at the top-left corner, x axis is oriented to the right, - and y axis is oriented downwards. - The output convex hull. It is a vector of 0-based point indices of the - hull points in the original array (since the set of convex hull points is a subset of the original point set). - - - - Computes convex hull for a set of 2D points. - - The input 2D point set, represented by CV_32SC2 or CV_32FC2 matrix - If true, the output convex hull will be oriented clockwise, - otherwise it will be oriented counter-clockwise. Here, the usual screen coordinate - system is assumed - the origin is at the top-left corner, x axis is oriented to the right, - and y axis is oriented downwards. - The output convex hull. It is a vector of 0-based point indices of the - hull points in the original array (since the set of convex hull points is a subset of the original point set). - - - - Computes the contour convexity defects - - Input contour. - Convex hull obtained using convexHull() that - should contain indices of the contour points that make the hull. - - The output vector of convexity defects. - Each convexity defect is represented as 4-element integer vector - (a.k.a. cv::Vec4i): (start_index, end_index, farthest_pt_index, fixpt_depth), - where indices are 0-based indices in the original contour of the convexity defect beginning, - end and the farthest point, and fixpt_depth is fixed-point approximation - (with 8 fractional bits) of the distance between the farthest contour point and the hull. - That is, to get the floating-point value of the depth will be fixpt_depth/256.0. - - - - - Computes the contour convexity defects - - Input contour. - Convex hull obtained using convexHull() that - should contain indices of the contour points that make the hull. - The output vector of convexity defects. - Each convexity defect is represented as 4-element integer vector - (a.k.a. cv::Vec4i): (start_index, end_index, farthest_pt_index, fixpt_depth), - where indices are 0-based indices in the original contour of the convexity defect beginning, - end and the farthest point, and fixpt_depth is fixed-point approximation - (with 8 fractional bits) of the distance between the farthest contour point and the hull. - That is, to get the floating-point value of the depth will be fixpt_depth/256.0. - - - - Computes the contour convexity defects - - Input contour. - Convex hull obtained using convexHull() that - should contain indices of the contour points that make the hull. - The output vector of convexity defects. - Each convexity defect is represented as 4-element integer vector - (a.k.a. cv::Vec4i): (start_index, end_index, farthest_pt_index, fixpt_depth), - where indices are 0-based indices in the original contour of the convexity defect beginning, - end and the farthest point, and fixpt_depth is fixed-point approximation - (with 8 fractional bits) of the distance between the farthest contour point and the hull. - That is, to get the floating-point value of the depth will be fixpt_depth/256.0. - - - - returns true if the contour is convex. - Does not support contours with self-intersection - - Input vector of 2D points - - - - - returns true if the contour is convex. - Does not support contours with self-intersection - - Input vector of 2D points - - - - - returns true if the contour is convex. D - oes not support contours with self-intersection - - Input vector of 2D points - - - - - finds intersection of two convex polygons - - - - - - - - - - finds intersection of two convex polygons - - - - - - - - - - finds intersection of two convex polygons - - - - - - - - - - Fits ellipse to the set of 2D points. - - Input 2D point set - - - - - Fits ellipse to the set of 2D points. - - Input 2D point set - - - - - Fits ellipse to the set of 2D points. - - Input 2D point set - - - - - Fits an ellipse around a set of 2D points. - - The function calculates the ellipse that fits a set of 2D points. - It returns the rotated rectangle in which the ellipse is inscribed. - The Approximate Mean Square(AMS) proposed by @cite Taubin1991 is used. - - Input 2D point set - - - - - Fits an ellipse around a set of 2D points. - - The function calculates the ellipse that fits a set of 2D points. - It returns the rotated rectangle in which the ellipse is inscribed. - The Approximate Mean Square(AMS) proposed by @cite Taubin1991 is used. - - Input 2D point set - - - - - Fits an ellipse around a set of 2D points. - - The function calculates the ellipse that fits a set of 2D points. - It returns the rotated rectangle in which the ellipse is inscribed. - The Approximate Mean Square(AMS) proposed by @cite Taubin1991 is used. - - Input 2D point set - - - - - Fits an ellipse around a set of 2D points. - - The function calculates the ellipse that fits a set of 2D points. - It returns the rotated rectangle in which the ellipse is inscribed. - The Direct least square(Direct) method by @cite Fitzgibbon1999 is used. - - Input 2D point set - - - - - Fits an ellipse around a set of 2D points. - - The function calculates the ellipse that fits a set of 2D points. - It returns the rotated rectangle in which the ellipse is inscribed. - The Direct least square(Direct) method by @cite Fitzgibbon1999 is used. - - Input 2D point set - - - - - Fits an ellipse around a set of 2D points. - - The function calculates the ellipse that fits a set of 2D points. - It returns the rotated rectangle in which the ellipse is inscribed. - The Direct least square(Direct) method by @cite Fitzgibbon1999 is used. - - Input 2D point set - - - - - Fits line to the set of 2D points using M-estimator algorithm - - Input vector of 2D or 3D points - Output line parameters. - In case of 2D fitting, it should be a vector of 4 elements - (like Vec4f) - (vx, vy, x0, y0), where (vx, vy) is a normalized vector - collinear to the line and (x0, y0) is a point on the line. - In case of 3D fitting, it should be a vector of 6 elements - (like Vec6f) - (vx, vy, vz, x0, y0, z0), where (vx, vy, vz) is a - normalized vector collinear to the line and (x0, y0, z0) is a point on the line. - Distance used by the M-estimator - Numerical parameter ( C ) for some types of distances. - If it is 0, an optimal value is chosen. - Sufficient accuracy for the radius - (distance between the coordinate origin and the line). - Sufficient accuracy for the angle. - 0.01 would be a good default value for reps and aeps. - - - - Fits line to the set of 2D points using M-estimator algorithm - - Input vector of 2D or 3D points - Distance used by the M-estimator - Numerical parameter ( C ) for some types of distances. - If it is 0, an optimal value is chosen. - Sufficient accuracy for the radius - (distance between the coordinate origin and the line). - Sufficient accuracy for the angle. - 0.01 would be a good default value for reps and aeps. - Output line parameters. - - - - Fits line to the set of 2D points using M-estimator algorithm - - Input vector of 2D or 3D points - Distance used by the M-estimator - Numerical parameter ( C ) for some types of distances. - If it is 0, an optimal value is chosen. - Sufficient accuracy for the radius - (distance between the coordinate origin and the line). - Sufficient accuracy for the angle. - 0.01 would be a good default value for reps and aeps. - Output line parameters. - - - - Fits line to the set of 3D points using M-estimator algorithm - - Input vector of 2D or 3D points - Distance used by the M-estimator - Numerical parameter ( C ) for some types of distances. - If it is 0, an optimal value is chosen. - Sufficient accuracy for the radius - (distance between the coordinate origin and the line). - Sufficient accuracy for the angle. - 0.01 would be a good default value for reps and aeps. - Output line parameters. - - - - Fits line to the set of 3D points using M-estimator algorithm - - Input vector of 2D or 3D points - Distance used by the M-estimator - Numerical parameter ( C ) for some types of distances. - If it is 0, an optimal value is chosen. - Sufficient accuracy for the radius - (distance between the coordinate origin and the line). - Sufficient accuracy for the angle. - 0.01 would be a good default value for reps and aeps. - Output line parameters. - - - - Checks if the point is inside the contour. Optionally computes the signed distance from the point to the contour boundary - - - - - - - - - Checks if the point is inside the contour. Optionally computes the signed distance from the point to the contour boundary - - - - - - - - - Checks if the point is inside the contour. - Optionally computes the signed distance from the point to the contour boundary. - - Input contour. - Point tested against the contour. - If true, the function estimates the signed distance - from the point to the nearest contour edge. Otherwise, the function only checks - if the point is inside a contour or not. - Positive (inside), negative (outside), or zero (on an edge) value. - - - - Finds out if there is any intersection between two rotated rectangles. - If there is then the vertices of the interesecting region are returned as well. - Below are some examples of intersection configurations. - The hatched pattern indicates the intersecting region and the red - vertices are returned by the function. - - First rectangle - Second rectangle - - The output array of the verticies of the intersecting region. - It returns at most 8 vertices. - Stored as std::vector<cv::Point2f> or cv::Mat as Mx1 of type CV_32FC2. - - - - - Finds out if there is any intersection between two rotated rectangles. - If there is then the vertices of the interesecting region are returned as well. - Below are some examples of intersection configurations. - The hatched pattern indicates the intersecting region and the red - vertices are returned by the function. - - First rectangle - Second rectangle - - The output array of the verticies of the intersecting region. - It returns at most 8 vertices. - - - - - Applies a GNU Octave/MATLAB equivalent colormap on a given image. - - The source image, grayscale or colored of type CV_8UC1 or CV_8UC3. - The result is the colormapped source image. Note: Mat::create is called on dst. - colormap The colormap to apply - - - - Applies a user colormap on a given image. - - The source image, grayscale or colored of type CV_8UC1 or CV_8UC3. - The result is the colormapped source image. Note: Mat::create is called on dst. - The colormap to apply of type CV_8UC1 or CV_8UC3 and size 256 - - - - Draws a line segment connecting two points - - The image. - First point's x-coordinate of the line segment. - First point's y-coordinate of the line segment. - Second point's x-coordinate of the line segment. - Second point's y-coordinate of the line segment. - Line color. - Line thickness. [By default this is 1] - Type of the line. [By default this is LineType.Link8] - Number of fractional bits in the point coordinates. [By default this is 0] - - - - Draws a line segment connecting two points - - The image. - First point of the line segment. - Second point of the line segment. - Line color. - Line thickness. [By default this is 1] - Type of the line. [By default this is LineType.Link8] - Number of fractional bits in the point coordinates. [By default this is 0] - - - - Draws a arrow segment pointing from the first point to the second one. - The function arrowedLine draws an arrow between pt1 and pt2 points in the image. - See also cv::line. - - Image. - The point the arrow starts from. - The point the arrow points to. - Line color. - Line thickness. - Type of the line, see cv::LineTypes - Number of fractional bits in the point coordinates. - The length of the arrow tip in relation to the arrow length - - - - Draws simple, thick or filled rectangle - - Image. - One of the rectangle vertices. - Opposite rectangle vertex. - Line color (RGB) or brightness (grayscale image). - Thickness of lines that make up the rectangle. Negative values make the function to draw a filled rectangle. [By default this is 1] - Type of the line, see cvLine description. [By default this is LineType.Link8] - Number of fractional bits in the point coordinates. [By default this is 0] - - - - Draws simple, thick or filled rectangle - - Image. - Rectangle. - Line color (RGB) or brightness (grayscale image). - Thickness of lines that make up the rectangle. - Negative values make the function to draw a filled rectangle. [By default this is 1] - Type of the line, see cvLine description. [By default this is LineType.Link8] - Number of fractional bits in the point coordinates. [By default this is 0] - - - - Draws simple, thick or filled rectangle - - Image. - Rectangle. - Line color (RGB) or brightness (grayscale image). - Thickness of lines that make up the rectangle. - Negative values make the function to draw a filled rectangle. [By default this is 1] - Type of the line, see cvLine description. [By default this is LineType.Link8] - Number of fractional bits in the point coordinates. [By default this is 0] - - - - Draws simple, thick or filled rectangle - - Image. - One of the rectangle vertices. - Opposite rectangle vertex. - Line color (RGB) or brightness (grayscale image). - Thickness of lines that make up the rectangle. - Negative values make the function to draw a filled rectangle. [By default this is 1] - Type of the line, see cvLine description. [By default this is LineType.Link8] - Number of fractional bits in the point coordinates. [By default this is 0] - - - - Draws a circle - - Image where the circle is drawn. - X-coordinate of the center of the circle. - Y-coordinate of the center of the circle. - Radius of the circle. - Circle color. - Thickness of the circle outline if positive, otherwise indicates that a filled circle has to be drawn. [By default this is 1] - Type of the circle boundary. [By default this is LineType.Link8] - Number of fractional bits in the center coordinates and radius value. [By default this is 0] - - - - Draws a circle - - Image where the circle is drawn. - Center of the circle. - Radius of the circle. - Circle color. - Thickness of the circle outline if positive, otherwise indicates that a filled circle has to be drawn. [By default this is 1] - Type of the circle boundary. [By default this is LineType.Link8] - Number of fractional bits in the center coordinates and radius value. [By default this is 0] - - - - Draws simple or thick elliptic arc or fills ellipse sector - - Image. - Center of the ellipse. - Length of the ellipse axes. - Rotation angle. - Starting angle of the elliptic arc. - Ending angle of the elliptic arc. - Ellipse color. - Thickness of the ellipse arc. [By default this is 1] - Type of the ellipse boundary. [By default this is LineType.Link8] - Number of fractional bits in the center coordinates and axes' values. [By default this is 0] - - - - Draws simple or thick elliptic arc or fills ellipse sector - - Image. - The enclosing box of the ellipse drawn - Ellipse color. - Thickness of the ellipse boundary. [By default this is 1] - Type of the ellipse boundary. [By default this is LineType.Link8] - - - - Draws a marker on a predefined position in an image. - - The function cv::drawMarker draws a marker on a given position in the image.For the moment several - marker types are supported, see #MarkerTypes for more information. - - Image. - The point where the crosshair is positioned. - Line color. - The specific type of marker you want to use. - The length of the marker axis [default = 20 pixels] - Line thickness. - Type of the line. - - - - Fills a convex polygon. - - Image - The polygon vertices - Polygon color - Type of the polygon boundaries - The number of fractional bits in the vertex coordinates - - - - Fills a convex polygon. - - Image - The polygon vertices - Polygon color - Type of the polygon boundaries - The number of fractional bits in the vertex coordinates - - - - Fills the area bounded by one or more polygons - - Image - Array of polygons, each represented as an array of points - Polygon color - Type of the polygon boundaries - The number of fractional bits in the vertex coordinates - - - - - Fills the area bounded by one or more polygons - - Image - Array of polygons, each represented as an array of points - Polygon color - Type of the polygon boundaries - The number of fractional bits in the vertex coordinates - - - - - draws one or more polygonal curves - - - - - - - - - - - - draws one or more polygonal curves - - - - - - - - - - - - draws contours in the image - - Destination image. - All the input contours. Each contour is stored as a point vector. - Parameter indicating a contour to draw. If it is negative, all the contours are drawn. - Color of the contours. - Thickness of lines the contours are drawn with. If it is negative (for example, thickness=CV_FILLED ), - the contour interiors are drawn. - Line connectivity. - Optional information about hierarchy. It is only needed if you want to draw only some of the contours - Maximal level for drawn contours. If it is 0, only the specified contour is drawn. - If it is 1, the function draws the contour(s) and all the nested contours. If it is 2, the function draws the contours, - all the nested contours, all the nested-to-nested contours, and so on. This parameter is only taken into account - when there is hierarchy available. - Optional contour shift parameter. Shift all the drawn contours by the specified offset = (dx, dy) - - - - draws contours in the image - - Destination image. - All the input contours. Each contour is stored as a point vector. - Parameter indicating a contour to draw. If it is negative, all the contours are drawn. - Color of the contours. - Thickness of lines the contours are drawn with. If it is negative (for example, thickness=CV_FILLED ), - the contour interiors are drawn. - Line connectivity. - Optional information about hierarchy. It is only needed if you want to draw only some of the contours - Maximal level for drawn contours. If it is 0, only the specified contour is drawn. - If it is 1, the function draws the contour(s) and all the nested contours. If it is 2, the function draws the contours, - all the nested contours, all the nested-to-nested contours, and so on. This parameter is only taken into account - when there is hierarchy available. - Optional contour shift parameter. Shift all the drawn contours by the specified offset = (dx, dy) - - - - Clips the line against the image rectangle - - The image size - The first line point - The second line point - - - - - Clips the line against the image rectangle - - sThe image rectangle - The first line point - The second line point - - - - - Approximates an elliptic arc with a polyline. - The function ellipse2Poly computes the vertices of a polyline that - approximates the specified elliptic arc. It is used by cv::ellipse. - - Center of the arc. - Half of the size of the ellipse main axes. See the ellipse for details. - Rotation angle of the ellipse in degrees. See the ellipse for details. - Starting angle of the elliptic arc in degrees. - Ending angle of the elliptic arc in degrees. - Angle between the subsequent polyline vertices. It defines the approximation - Output vector of polyline vertices. - - - - Approximates an elliptic arc with a polyline. - The function ellipse2Poly computes the vertices of a polyline that - approximates the specified elliptic arc. It is used by cv::ellipse. - - Center of the arc. - Half of the size of the ellipse main axes. See the ellipse for details. - Rotation angle of the ellipse in degrees. See the ellipse for details. - Starting angle of the elliptic arc in degrees. - Ending angle of the elliptic arc in degrees. - Angle between the subsequent polyline vertices. It defines the approximation - Output vector of polyline vertices. - - - - renders text string in the image - - Image. - Text string to be drawn. - Bottom-left corner of the text string in the image. - Font type, see #HersheyFonts. - Font scale factor that is multiplied by the font-specific base size. - Text color. - Thickness of the lines used to draw a text. - Line type. See #LineTypes - When true, the image data origin is at the bottom-left corner. - Otherwise, it is at the top-left corner. - - - - returns bounding box of the text string - - Input text string. - Font to use, see #HersheyFonts. - Font scale factor that is multiplied by the font-specific base size. - Thickness of lines used to render the text. See #putText for details. - baseLine y-coordinate of the baseline relative to the bottom-most text - The size of a box that contains the specified text. - - - - Calculates the font-specific size to use to achieve a given height in pixels. - - Font to use, see cv::HersheyFonts. - Pixel height to compute the fontScale for - Thickness of lines used to render the text.See putText for details. - The fontSize to use for cv::putText - - - - Groups the object candidate rectangles. - - Input/output vector of rectangles. Output vector includes retained and grouped rectangles. - Minimum possible number of rectangles minus 1. The threshold is used in a group of rectangles to retain it. - - - - - Groups the object candidate rectangles. - - Input/output vector of rectangles. Output vector includes retained and grouped rectangles. - - Minimum possible number of rectangles minus 1. The threshold is used in a group of rectangles to retain it. - Relative difference between sides of the rectangles to merge them into a group. - - - - Groups the object candidate rectangles. - - - - - - - - - - Groups the object candidate rectangles. - - - - - - - - - - - - - - - - - - - - Restores the selected region in an image using the region neighborhood. - - Input 8-bit, 16-bit unsigned or 32-bit float 1-channel or 8-bit 3-channel image. - Inpainting mask, 8-bit 1-channel image. Non-zero pixels indicate the area that needs to be inpainted. - Output image with the same size and type as src. - Radius of a circular neighborhood of each point inpainted that is considered by the algorithm. - Inpainting method that could be cv::INPAINT_NS or cv::INPAINT_TELEA - - - - Perform image denoising using Non-local Means Denoising algorithm - with several computational optimizations. Noise expected to be a gaussian white noise - - Input 8-bit 1-channel, 2-channel or 3-channel image. - Output image with the same size and type as src . - - Parameter regulating filter strength. Big h value perfectly removes noise but also removes image details, - smaller h value preserves details but also preserves some noise - - Size in pixels of the template patch that is used to compute weights. Should be odd. Recommended value 7 pixels - - Size in pixels of the window that is used to compute weighted average for given pixel. - Should be odd. Affect performance linearly: greater searchWindowsSize - greater denoising time. Recommended value 21 pixels - - - - Modification of fastNlMeansDenoising function for colored images - - Input 8-bit 3-channel image. - Output image with the same size and type as src. - Parameter regulating filter strength for luminance component. - Bigger h value perfectly removes noise but also removes image details, smaller h value preserves details but also preserves some noise - The same as h but for color components. For most images value equals 10 will be enought - to remove colored noise and do not distort colors - - Size in pixels of the template patch that is used to compute weights. Should be odd. Recommended value 7 pixels - - Size in pixels of the window that is used to compute weighted average for given pixel. Should be odd. - Affect performance linearly: greater searchWindowsSize - greater denoising time. Recommended value 21 pixels - - - - Modification of fastNlMeansDenoising function for images sequence where consequtive images have been captured - in small period of time. For example video. This version of the function is for grayscale images or for manual manipulation with colorspaces. - - Input 8-bit 1-channel, 2-channel or 3-channel images sequence. All images should have the same type and size. - Output image with the same size and type as srcImgs images. - Target image to denoise index in srcImgs sequence - Number of surrounding images to use for target image denoising. - Should be odd. Images from imgToDenoiseIndex - temporalWindowSize / 2 to imgToDenoiseIndex - temporalWindowSize / 2 - from srcImgs will be used to denoise srcImgs[imgToDenoiseIndex] image. - Parameter regulating filter strength for luminance component. Bigger h value perfectly removes noise but also removes image details, - smaller h value preserves details but also preserves some noise - Size in pixels of the template patch that is used to compute weights. Should be odd. Recommended value 7 pixels - Size in pixels of the window that is used to compute weighted average for given pixel. - Should be odd. Affect performance linearly: greater searchWindowsSize - greater denoising time. Recommended value 21 pixels - - - - Modification of fastNlMeansDenoisingMulti function for colored images sequences - - Input 8-bit 3-channel images sequence. All images should have the same type and size. - Output image with the same size and type as srcImgs images. - Target image to denoise index in srcImgs sequence - Number of surrounding images to use for target image denoising. Should be odd. - Images from imgToDenoiseIndex - temporalWindowSize / 2 to imgToDenoiseIndex - temporalWindowSize / 2 from srcImgs - will be used to denoise srcImgs[imgToDenoiseIndex] image. - Parameter regulating filter strength for luminance component. Bigger h value perfectly removes noise - but also removes image details, smaller h value preserves details but also preserves some noise. - The same as h but for color components. - Size in pixels of the template patch that is used to compute weights. Should be odd. Recommended value 7 pixels - Size in pixels of the window that is used to compute weighted average for given pixel. - Should be odd. Affect performance linearly: greater searchWindowsSize - greater denoising time. Recommended value 21 pixels - - - - Primal-dual algorithm is an algorithm for solving special types of variational problems - (that is, finding a function to minimize some functional). As the image denoising, - in particular, may be seen as the variational problem, primal-dual algorithm then - can be used to perform denoising and this is exactly what is implemented. - - This array should contain one or more noised versions - of the image that is to be restored. - Here the denoised image will be stored. There is no need to - do pre-allocation of storage space, as it will be automatically allocated, if necessary. - Corresponds to \f$\lambda\f$ in the formulas above. - As it is enlarged, the smooth (blurred) images are treated more favorably than - detailed (but maybe more noised) ones. Roughly speaking, as it becomes smaller, - the result will be more blur but more sever outliers will be removed. - Number of iterations that the algorithm will run. - Of course, as more iterations as better, but it is hard to quantitatively - refine this statement, so just use the default and increase it if the results are poor. - - - - Transforms a color image to a grayscale image. It is a basic tool in digital - printing, stylized black-and-white photograph rendering, and in many single - channel image processing applications @cite CL12 . - - Input 8-bit 3-channel image. - Output 8-bit 1-channel image. - Output 8-bit 3-channel image. - - - - Image editing tasks concern either global changes (color/intensity corrections, - filters, deformations) or local changes concerned to a selection. Here we are - interested in achieving local changes, ones that are restricted to a region - manually selected (ROI), in a seamless and effortless manner. The extent of - the changes ranges from slight distortions to complete replacement by novel - content @cite PM03 . - - Input 8-bit 3-channel image. - Input 8-bit 3-channel image. - Input 8-bit 1 or 3-channel image. - Point in dst image where object is placed. - Output image with the same size and type as dst. - Cloning method - - - - Given an original color image, two differently colored versions of this - image can be mixed seamlessly. Multiplication factor is between 0.5 to 2.5. - - Input 8-bit 3-channel image. - Input 8-bit 1 or 3-channel image. - Output image with the same size and type as src. - R-channel multiply factor. - G-channel multiply factor. - B-channel multiply factor. - - - - Applying an appropriate non-linear transformation to the gradient field inside - the selection and then integrating back with a Poisson solver, modifies locally - the apparent illumination of an image. - - Input 8-bit 3-channel image. - Input 8-bit 1 or 3-channel image. - Output image with the same size and type as src. - Value ranges between 0-2. - Value ranges between 0-2. - - This is useful to highlight under-exposed foreground objects or to reduce specular reflections. - - - - - By retaining only the gradients at edge locations, before integrating with the - Poisson solver, one washes out the texture of the selected region, giving its - contents a flat aspect. Here Canny Edge Detector is used. - - Input 8-bit 3-channel image. - Input 8-bit 1 or 3-channel image. - Output image with the same size and type as src. - Range from 0 to 100. - Value > 100. - The size of the Sobel kernel to be used. - - - - Filtering is the fundamental operation in image and video processing. - Edge-preserving smoothing filters are used in many different applications @cite EM11 . - - Input 8-bit 3-channel image. - Output 8-bit 3-channel image. - Edge preserving filters - Range between 0 to 200. - Range between 0 to 1. - - - - This filter enhances the details of a particular image. - - Input 8-bit 3-channel image. - Output image with the same size and type as src. - Range between 0 to 200. - Range between 0 to 1. - - - - Pencil-like non-photorealistic line drawing - - Input 8-bit 3-channel image. - Output 8-bit 1-channel image. - Output image with the same size and type as src. - Range between 0 to 200. - Range between 0 to 1. - Range between 0 to 0.1. - - - - Stylization aims to produce digital imagery with a wide variety of effects - not focused on photorealism. Edge-aware filters are ideal for stylization, - as they can abstract regions of low contrast while preserving, or enhancing, - high-contrast features. - - Input 8-bit 3-channel image. - Output image with the same size and type as src. - Range between 0 to 200. - Range between 0 to 1. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Create Bilateral TV-L1 Super Resolution. - - - - - - Create Bilateral TV-L1 Super Resolution. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Finds an object center, size, and orientation. - - Back projection of the object histogram. - Initial search window. - Stop criteria for the underlying MeanShift() . - - - - - Finds an object on a back projection image. - - Back projection of the object histogram. - Initial search window. - Stop criteria for the iterative search algorithm. - Number of iterations CAMSHIFT took to converge. - - - - Constructs a pyramid which can be used as input for calcOpticalFlowPyrLK - - 8-bit input image. - output pyramid. - window size of optical flow algorithm. - Must be not less than winSize argument of calcOpticalFlowPyrLK(). - It is needed to calculate required padding for pyramid levels. - 0-based maximal pyramid level number. - set to precompute gradients for the every pyramid level. - If pyramid is constructed without the gradients then calcOpticalFlowPyrLK() will - calculate them internally. - the border mode for pyramid layers. - the border mode for gradients. - put ROI of input image into the pyramid if possible. - You can pass false to force data copying. - number of levels in constructed pyramid. Can be less than maxLevel. - - - - Constructs a pyramid which can be used as input for calcOpticalFlowPyrLK - - 8-bit input image. - output pyramid. - window size of optical flow algorithm. - Must be not less than winSize argument of calcOpticalFlowPyrLK(). - It is needed to calculate required padding for pyramid levels. - 0-based maximal pyramid level number. - set to precompute gradients for the every pyramid level. - If pyramid is constructed without the gradients then calcOpticalFlowPyrLK() will - calculate them internally. - the border mode for pyramid layers. - the border mode for gradients. - put ROI of input image into the pyramid if possible. - You can pass false to force data copying. - number of levels in constructed pyramid. Can be less than maxLevel. - - - - computes sparse optical flow using multi-scale Lucas-Kanade algorithm - - - - - - - - - - - - - - - - computes sparse optical flow using multi-scale Lucas-Kanade algorithm - - - - - - - - - - - - - - - - Computes a dense optical flow using the Gunnar Farneback's algorithm. - - first 8-bit single-channel input image. - second input image of the same size and the same type as prev. - computed flow image that has the same size as prev and type CV_32FC2. - parameter, specifying the image scale (<1) to build pyramids for each image; - pyrScale=0.5 means a classical pyramid, where each next layer is twice smaller than the previous one. - number of pyramid layers including the initial image; - levels=1 means that no extra layers are created and only the original images are used. - averaging window size; larger values increase the algorithm robustness to - image noise and give more chances for fast motion detection, but yield more blurred motion field. - number of iterations the algorithm does at each pyramid level. - size of the pixel neighborhood used to find polynomial expansion in each pixel; - larger values mean that the image will be approximated with smoother surfaces, - yielding more robust algorithm and more blurred motion field, typically poly_n =5 or 7. - standard deviation of the Gaussian that is used to smooth derivatives used as - a basis for the polynomial expansion; for polyN=5, you can set polySigma=1.1, - for polyN=7, a good value would be polySigma=1.5. - operation flags that can be a combination of OPTFLOW_USE_INITIAL_FLOW and/or OPTFLOW_FARNEBACK_GAUSSIAN - - - - Computes the Enhanced Correlation Coefficient value between two images @cite EP08 . - - single-channel template image; CV_8U or CV_32F array. - single-channel input image to be warped to provide an image similar to templateImage, same type as templateImage. - An optional mask to indicate valid values of inputImage. - - - - - Finds the geometric transform (warp) between two images in terms of the ECC criterion @cite EP08 . - - single-channel template image; CV_8U or CV_32F array. - single-channel input image which should be warped with the final warpMatrix in - order to provide an image similar to templateImage, same type as templateImage. - floating-point \f$2\times 3\f$ or \f$3\times 3\f$ mapping matrix (warp). - parameter, specifying the type of motion - parameter, specifying the termination criteria of the ECC algorithm; - criteria.epsilon defines the threshold of the increment in the correlation coefficient between two - iterations(a negative criteria.epsilon makes criteria.maxcount the only termination criterion). - Default values are shown in the declaration above. - An optional mask to indicate valid values of inputImage. - An optional value indicating size of gaussian blur filter; (DEFAULT: 5) - - - - - Finds the geometric transform (warp) between two images in terms of the ECC criterion @cite EP08 . - - single-channel template image; CV_8U or CV_32F array. - single-channel input image which should be warped with the final warpMatrix in - order to provide an image similar to templateImage, same type as templateImage. - floating-point \f$2\times 3\f$ or \f$3\times 3\f$ mapping matrix (warp). - parameter, specifying the type of motion - parameter, specifying the termination criteria of the ECC algorithm; - criteria.epsilon defines the threshold of the increment in the correlation coefficient between two - iterations(a negative criteria.epsilon makes criteria.maxcount the only termination criterion). - Default values are shown in the declaration above. - An optional mask to indicate valid values of inputImage. - - - - - A class which has a pointer of OpenCV structure - - - - - Data pointer - - - - - Default constructor - - - - - - - - - - - Native pointer of OpenCV structure - - - - - DisposableObject + ICvPtrHolder - - - - - Data pointer - - - - - Default constructor - - - - - Constructor - - - - - - Constructor - - - - - - Constructor - - - - - - - releases unmanaged resources - - - - - Native pointer of OpenCV structure - - - - - Represents a class which manages its own memory. - - - - - Gets or sets a handle which allocates using cvSetData. - - - - - Gets a value indicating whether this instance has been disposed. - - - - - Gets or sets a value indicating whether you permit disposing this instance. - - - - - Gets or sets a memory address allocated by AllocMemory. - - - - - Gets or sets the byte length of the allocated memory - - - - - Default constructor - - - - - Constructor - - true if you permit disposing this class by GC - - - - Releases the resources - - - - - Releases the resources - - - If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. - If false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. - - - - - Destructor - - - - - Releases managed resources - - - - - Releases unmanaged resources - - - - - Pins the object to be allocated by cvSetData. - - - - - - - Allocates the specified size of memory. - - - - - - - Notifies the allocated size of memory. - - - - - - If this object is disposed, then ObjectDisposedException is thrown. - - - - - Represents a OpenCV-based class which has a native pointer. - - - - - Unmanaged OpenCV data pointer - - - - - A MemoryManager over an OpenCvSharpMat - - The pointer is assumed to be fully unmanaged, or externally pinned - no attempt will be made to pin this data - - - - Create a new UnmanagedMemoryManager instance at the given pointer and size - - It is assumed that the span provided is already unmanaged or externally pinned - - - - - - - Provides access to a pointer that represents the data (note: no actual pin occurs) - - - - - Has no effect - - - - - Releases all resources associated with this object - - - - - The default exception to be thrown by OpenCV - - - - - The numeric code for error status - - - - - The source file name where error is encountered - - - - - A description of the error - - - - - The source file name where error is encountered - - - - - The line number in the source where error is encountered - - - - - Constructor - - The numeric code for error status - The source file name where error is encountered - A description of the error - The source file name where error is encountered - The line number in the source where error is encountered - - - - - - - - - - - - - - - - - - - The exception that is thrown by OpenCvSharp. - - - - - - - - - - - - - - - - - - - - - - Template class for smart reference-counting pointers - - - - - Constructor - - - - - - Returns Ptr<T>.get() pointer - - - - - Used for managing the resources of OpenCVSharp, like Mat, MatExpr, etc. - - - - - Trace the object obj, and return it - - - - - - - - Trace an array of objects , and return them - - - - - - - - Create a new Mat instance, and trace it - - - - - - Create a new Mat instance, and trace it - - size - matType - scalar - - - - - Create a new UMat instance, and trace it - - - - - - Create a new UMat instance, and trace it - - size - matType - scalar - - - - - Dispose all traced objects - - - - - Whether native methods for P/Invoke raises an exception - - - - - P/Invoke methods of OpenCV 2.x C++ interface - - - - - Is tried P/Invoke once - - - - - Static constructor - - - - - Load DLL files dynamically using Win32 LoadLibrary - - - - - - Checks whether PInvoke functions can be called - - - - - Returns whether the OS is Windows or not - - - - - - Returns whether the OS is *nix or not - - - - - - Returns whether the runtime is Mono or not - - - - - - Returns whether the architecture is Wasm or not - - - - - - Custom error handler to be thrown by OpenCV - - - - - Custom error handler to ignore all OpenCV errors - - - - - Default error handler - - - - - - C++ std::string - - - - - - - - - - - - - - - - Releases unmanaged resources - - - - - string.size() - - - - - Converts std::string to managed string - - - - - - Win32API Wrapper - - - - - Handles loading embedded dlls into memory, based on http://stackoverflow.com/questions/666799/embedding-unmanaged-dll-into-a-managed-c-sharp-dll. - - This code is based on https://github.com/charlesw/tesseract - - - - The default base directory name to copy the assemblies too. - - - - - Map processor - - - - - Used as a sanity check for the returned processor architecture to double check the returned value. - - - - - Additional user-defined DLL paths - - - - - constructor - - - - - - - - - - - - Determine if the OS is Windows - - - - - - Determine if the runtime is .NET Core - - - - - - - - - - - - - Get's the current process architecture while keeping track of any assumptions or possible errors. - - - - - - Determines if the dynamic link library file name requires a suffix - and adds it if necessary. - - - - - Given the processor architecture, returns the name of the platform. - - - - - - - - - - - Releases unmanaged resources - - - - - Class to get address of specified jagged array - - - - - - - - - - - - - - - - - - Releases unmanaged resources - - - - - - - - - - - - - - - - - enumerable as T[] ?? enumerable.ToArray() - - - - - - - - - - - - - Checks whether PInvoke functions can be called - - - - - DllImportの際にDllNotFoundExceptionかBadImageFormatExceptionが発生した際に呼び出されるメソッド。 - エラーメッセージを表示して解決策をユーザに示す。 - - - - - - - - - - - - Provides information for the platform which the user is using - - - - - OS type - - - - - Runtime type - - - - - Readonly rectangular array (T[,]) - - - - - - Constructor - - - - - - Indexer - - - - - - - - Gets the total number of elements in all the dimensions of the System.Array. - - - - - Gets a 32-bit integer that represents the number of elements in the specified dimension of the System.Array. - - - - - - - Returns internal buffer - - - - - - Original GCHandle that implement IDisposable - - - - - Constructor - - - - - - Constructor - - - - - - - Constructor - - - - - - Represents std::vector - - - - - vector.size() - - - - - Convert std::vector<T> to managed array T[] - - - - - - - - - - Constructor - - - - - Constructor - - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Constructor - - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Constructor - - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Constructor - - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Constructor - - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Constructor - - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Constructor - - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Constructor - - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Constructor - - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Constructor - - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Constructor - - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Constructor - - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Constructor - - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - Converts std::vector to managed array - - structure that has two float members (ex. CvLineSegmentPolar, CvPoint2D32f, PointF) - - - - - - - - - Constructor - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - Converts std::vector to managed array - - structure that has two float members (ex. CvLineSegmentPolar, CvPoint2D32f, PointF) - - - - - - - - - Constructor - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - Converts std::vector to managed array - - structure that has four int members (ex. CvLineSegmentPoint, CvRect) - - - - - - - - - Constructor - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - Converts std::vector to managed array - - structure that has four int members (ex. CvLineSegmentPoint, CvRect) - - - - - - - - - Constructor - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - &vector[0] - - - - - Converts std::vector to managed array - - - - - - Converts std::vector to managed array - - structure that has four int members (ex. CvLineSegmentPoint, CvRect) - - - - - - - - - Constructor - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - vector.size() - - - - - vector[i].size() - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - vector.size() - - - - - vector[i].size() - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - vector.size() - - - - - vector[i].size() - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - vector.size() - - - - - vector[i].size() - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - vector.size() - - - - - vector[i].size() - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - - - - - - vector.size() - - - - - Converts std::vector to managed array - - - - - - - - - - Constructor - - - - - Releases unmanaged resources - - - - - vector.size() - - - - - - - - - - vector[i].size() - - - - - Converts std::vector to managed array - - - - - - aruco module - - - - - Basic marker detection - - input image - indicates the type of markers that will be searched - vector of detected marker corners. - For each marker, its four corners are provided. For N detected markers, - the dimensions of this array is Nx4.The order of the corners is clockwise. - vector of identifiers of the detected markers. The identifier is of type int. - For N detected markers, the size of ids is also N. The identifiers have the same order than the markers in the imgPoints array. - marker detection parameters - contains the imgPoints of those squares whose inner code has not a - correct codification.Useful for debugging purposes. - - - - Pose estimation for single markers - - corners vector of already detected markers corners. - For each marker, its four corners are provided, (e.g std::vector<std::vector<cv::Point2f>> ). - For N detected markers, the dimensions of this array should be Nx4. The order of the corners should be clockwise. - the length of the markers' side. The returning translation vectors will - be in the same unit.Normally, unit is meters. - input 3x3 floating-point camera matrix - \f$A = \vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\f$ - vector of distortion coefficients - \f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6],[s_1, s_2, s_3, s_4]])\f$ of 4, 5, 8 or 12 elements - array of output rotation vectors (@sa Rodrigues) (e.g. std::vector<cv::Vec3d>). - Each element in rvecs corresponds to the specific marker in imgPoints. - array of output translation vectors (e.g. std::vector<cv::Vec3d>). - Each element in tvecs corresponds to the specific marker in imgPoints. - array of object points of all the marker corners - - - - Draw detected markers in image - - input/output image. It must have 1 or 3 channels. The number of channels is not altered. - positions of marker corners on input image. - For N detected markers, the dimensions of this array should be Nx4.The order of the corners should be clockwise. - vector of identifiers for markers in markersCorners. Optional, if not provided, ids are not painted. - - - - Draw detected markers in image - - input/output image. It must have 1 or 3 channels. The number of channels is not altered. - positions of marker corners on input image. - For N detected markers, the dimensions of this array should be Nx4.The order of the corners should be clockwise. - vector of identifiers for markers in markersCorners. Optional, if not provided, ids are not painted. - color of marker borders. Rest of colors (text color and first corner color) - are calculated based on this one to improve visualization. - - - - Returns one of the predefined dictionaries defined in PREDEFINED_DICTIONARY_NAME - - - - - - - Reads a new dictionary from FileNode. - - - Dictionary format is YAML see sample below - - nmarkers: 35 - markersize: 6 - maxCorrectionBits: 5 - marker_0: "101011111011111001001001101100000000" - ... - marker_34: "011111010000111011111110110101100101" - - - The path of the dictionary file - Instance of a Dictionary - - - - Detect ChArUco Diamond markers. - - input image necessary for corner subpixel. - list of detected marker corners from detectMarkers function. - list of marker ids in markerCorners. - rate between square and marker length: squareMarkerLengthRate = squareLength/markerLength. The real units are not necessary. - output list of detected diamond corners (4 corners per diamond). The order is the same than in marker corners: top left, top right, bottom right and bottom left. Similar format than the corners returned by detectMarkers (e.g std::vector<std::vector<cv::Point2f>>). - ids of the diamonds in diamondCorners. The id of each diamond is in fact of type Vec4i, so each diamond has 4 ids, which are the ids of the aruco markers composing the diamond. - Optional camera calibration matrix. - Optional camera distortion coefficients. - - - - Draw a set of detected ChArUco Diamond markers. - - input/output image. It must have 1 or 3 channels. The number of channels is not altered. - positions of diamond corners in the same format returned by detectCharucoDiamond(). (e.g std::vector<std::vector<cv::Point2f>>). For N detected markers, the dimensions of this array should be Nx4. The order of the corners should be clockwise. - vector of identifiers for diamonds in diamondCorners, in the same format returned by detectCharucoDiamond() (e.g. std::vector<Vec4i>). Optional, if not provided, ids are not painted. - - - - Draw a set of detected ChArUco Diamond markers. - - input/output image. It must have 1 or 3 channels. The number of channels is not altered. - positions of diamond corners in the same format returned by detectCharucoDiamond(). (e.g std::vector<std::vector<cv::Point2f>>). For N detected markers, the dimensions of this array should be Nx4. The order of the corners should be clockwise. - vector of identifiers for diamonds in diamondCorners, in the same format returned by detectCharucoDiamond() (e.g. std::vector<Vec4i>). Optional, if not provided, ids are not painted. - color of marker borders. Rest of colors (text color and first corner color) are calculated based on this one. - - - - Parameters for the detectMarker process - - - - - minimum window size for adaptive thresholding before finding contours (default 3). - - - - - adaptiveThreshWinSizeMax: maximum window size for adaptive thresholding before finding contours(default 23). - - - - - increments from adaptiveThreshWinSizeMin to adaptiveThreshWinSizeMax during the thresholding(default 10). - - - - - constant for adaptive thresholding before finding contours (default 7) - - - - - determine minimum perimeter for marker contour to be detected. - This is defined as a rate respect to the maximum dimension of the input image(default 0.03). - - - - - determine maximum perimeter for marker contour to be detected. - This is defined as a rate respect to the maximum dimension of the input image(default 4.0). - - - - - minimum accuracy during the polygonal approximation process to determine which contours are squares. - - - - - minimum distance between corners for detected markers relative to its perimeter(default 0.05) - - - - - minimum distance of any corner to the image border for detected markers (in pixels) (default 3) - - - - - minimum mean distance between two marker corners to be considered similar, - so that the smaller one is removed.The rate is relative to the smaller perimeter of the two markers(default 0.05). - - - - - corner refinement method. - (CORNER_REFINE_NONE, no refinement. CORNER_REFINE_SUBPIX, do subpixel refinement. CORNER_REFINE_CONTOUR use contour-Points) - - - - - window size for the corner refinement process (in pixels) (default 5). - - - - - maximum number of iterations for stop criteria of the corner refinement process(default 30). - - - - - minimum error for the stop criteria of the corner refinement process(default: 0.1) - - - - - number of bits of the marker border, i.e. marker border width (default 1). - - - - - number of bits (per dimension) for each cell of the marker when removing the perspective(default 8). - - - - - width of the margin of pixels on each cell not considered for the determination - of the cell bit.Represents the rate respect to the total size of the cell, - i.e. perspectiveRemovePixelPerCell (default 0.13) - - - - - maximum number of accepted erroneous bits in the border - (i.e. number of allowed white bits in the border). Represented as a rate respect to the total - number of bits per marker(default 0.35). - - - - - minimun standard deviation in pixels values during the decodification step to - apply Otsu thresholding(otherwise, all the bits are set to 0 or 1 depending on mean higher than 128 or not) (default 5.0) - - - - - errorCorrectionRate error correction rate respect to the maximun error correction capability for each dictionary. (default 0.6). - - - - - Detection of quads can be done on a lower-resolution image, improving speed at a cost of pose accuracy and a slight decrease in detection rate. - Decoding the binary payload is still done at full resolution. - - - - - What Gaussian blur should be applied to the segmented image (used for quad detection?) Parameter is the standard deviation in pixels. - Very noisy images benefit from non-zero values (e.g. 0.8). - - - - - reject quads containing too few pixels. - - - - - how many corner candidates to consider when segmenting a group of pixels into a quad. - - - - - Reject quads where pairs of edges have angles that are close to straight or close to 180 degrees. Zero means that no quads are rejected. (In radians). - - - - - When fitting lines to the contours, what is the maximum mean squared error allowed? - This is useful in rejecting contours that are far from being quad shaped; rejecting these quads "early" saves expensive decoding processing. - - - - - When we build our model of black & white pixels, we add an extra check that the white model must be (overall) brighter than the black model. - How much brighter? (in pixel values, [0,255]). - - - - - should the thresholded image be deglitched? Only useful for very noisy images - - - - - to check if there is a white marker. In order to generate a "white" marker just invert a normal marker by using a tilde, ~markerImage. (default false) - - - - - enable the new and faster Aruco detection strategy. - Proposed in the paper: - * Romero-Ramirez et al: Speeded up detection of squared fiducial markers (2018) - * https://www.researchgate.net/publication/325787310_Speeded_Up_Detection_of_Squared_Fiducial_Markers - - - - - minimum side length of a marker in the canonical image. Latter is the binarized image in which contours are searched. - - - - - range [0,1], eq (2) from paper. The parameter tau_i has a direct influence on the processing speed. - - - - - Constructor - - - - - Dictionary/Set of markers. It contains the inner codification - - - - - - - - - - Releases unmanaged resources - - - - - Marker code information - - - - - Number of bits per dimension. - - - - - Maximum number of bits that can be corrected. - - - - - Given a matrix of bits. Returns whether if marker is identified or not. - It returns by reference the correct id (if any) and the correct rotation - - - - - - - - - - Returns the distance of the input bits to the specific id. - If allRotations is true, the four possible bits rotation are considered - - - - - - - - - Generate a canonical marker image - - - - - - - - - Transform matrix of bits to list of bytes in the 4 rotations - - - - - - - Transform list of bytes to matrix of bits - - - - - - - - corner refinement method - - - - - Tag and corners detection based on the ArUco approach. - - - - - ArUco approach and refine the corners locations using corner subpixel accuracy. - - - - - ArUco approach and refine the corners locations using the contour-points line fitting. - - - - - Tag and corners detection based on the AprilTag 2 approach - - - - - PredefinedDictionaryName - - - - - Background Subtractor module. Takes a series of images and returns a sequence of mask (8UC1) - images of the same size, where 255 indicates Foreground and 0 represents Background. - - - - - cv::Ptr<T> - - - - - Creates a GMG Background Subtractor - - number of frames used to initialize the background models. - Threshold value, above which it is marked foreground, else background. - - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gaussian Mixture-based Backbround/Foreground Segmentation Algorithm - - - - - cv::Ptr<T> - - - - - Creates mixture-of-gaussian background subtractor - - Length of the history. - Number of Gaussian mixtures. - Background ratio. - Noise strength (standard deviation of the brightness or each color channel). 0 means some automatic value. - - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - - - - - - Different flags for cvCalibrateCamera2 and cvStereoCalibrate - - - - - - - - - - The flag allows the function to optimize some or all of the intrinsic parameters, depending on the other flags, but the initial values are provided by the user - - - - - fyk is optimized, but the ratio fxk/fyk is fixed. - - - - - The principal points are fixed during the optimization. - - - - - Tangential distortion coefficients are set to zeros and do not change during the optimization. - - - - - fxk and fyk are fixed. - - - - - The 0-th distortion coefficients (k1) are fixed - - - - - The 1-th distortion coefficients (k2) are fixed - - - - - The 4-th distortion coefficients (k3) are fixed - - - - - Do not change the corresponding radial distortion coefficient during the optimization. - If CV_CALIB_USE_INTRINSIC_GUESS is set, the coefficient from the supplied distCoeffs matrix is used, otherwise it is set to 0. - - - - - Do not change the corresponding radial distortion coefficient during the optimization. - If CV_CALIB_USE_INTRINSIC_GUESS is set, the coefficient from the supplied distCoeffs matrix is used, otherwise it is set to 0. - - - - - Do not change the corresponding radial distortion coefficient during the optimization. - If CV_CALIB_USE_INTRINSIC_GUESS is set, the coefficient from the supplied distCoeffs matrix is used, otherwise it is set to 0. - - - - - Enable coefficients k4, k5 and k6. - To provide the backward compatibility, this extra flag should be explicitly specified to make the calibration function - use the rational model and return 8 coefficients. If the flag is not set, the function will compute only 5 distortion coefficients. - - - - - - - - - - - - - - - If it is set, camera_matrix1,2, as well as dist_coeffs1,2 are fixed, so that only extrinsic parameters are optimized. - - - - - Enforces fx0=fx1 and fy0=fy1. CV_CALIB_ZERO_TANGENT_DIST - Tangential distortion coefficients for each camera are set to zeros and fixed there. - - - - - for stereo rectification - - - - - Various operation flags for cvFindChessboardCorners - - - - - - - - - - Use adaptive thresholding to convert the image to black-n-white, rather than a fixed threshold level (computed from the average image brightness). - - - - - Normalize the image using cvNormalizeHist before applying fixed or adaptive thresholding. - - - - - Use additional criteria (like contour area, perimeter, square-like shape) to filter out false quads - that are extracted at the contour retrieval stage. - - - - - Run a fast check on the image that looks for chessboard corners, and shortcut the call if none is found. - This can drastically speed up the call in the degenerate condition when no chessboard is observed. - - - - - Run an exhaustive search to improve detection rate. - - - - - Up sample input image to improve sub-pixel accuracy due to aliasing effects. - This should be used if an accurate camera calibration is required. - - - - - Method for computing the essential matrix - - - - - for LMedS algorithm. - - - - - for RANSAC algorithm. - - - - - Method for solving a PnP problem: - - - - - uses symmetric pattern of circles. - - - - - uses asymmetric pattern of circles. - - - - - uses a special algorithm for grid detection. It is more robust to perspective distortions but much more sensitive to background clutter. - - - - - Method for computing the fundamental matrix - - - - - for 7-point algorithm. N == 7 - - - - - for 8-point algorithm. N >= 8 - [CV_FM_8POINT] - - - - - for LMedS algorithm. N > 8 - - - - - for RANSAC algorithm. N > 8 - - - - - method One of the implemented Hand-Eye calibration method - - - - - A New Technique for Fully Autonomous and Efficient 3D Robotics Hand/Eye Calibration @cite Tsai89 - - - - - Robot Sensor Calibration: Solving AX = XB on the Euclidean Group @cite Park94 - - - - - Hand-eye Calibration @cite Horaud95 - - - - - On-line Hand-Eye Calibration @cite Andreff99 - - - - - Hand-Eye Calibration Using Dual Quaternions @cite Daniilidis98 - - - - - The method used to computed homography matrix - - - - - Regular method using all the point pairs - - - - - Least-Median robust method - - - - - RANSAC-based robust method - - - - - RHO algorithm - - - - - USAC algorithm, default settings - - - - - USAC, parallel version - - - - - USAC, fundamental matrix 8 points - - - - - USAC, fast settings - - - - - USAC, accurate settings - - - - - USAC, sorted points, runs PROSAC - - - - - USAC, runs MAGSAC++ - - - - - cv::initWideAngleProjMap flags - - - - - - - - - - - - - - - One of the implemented Robot-World/Hand-Eye calibration method - - - - - Solving the robot-world/hand-eye calibration problem using the kronecker product @cite Shah2013SolvingTR - - - - - Simultaneous robot-world and hand-eye calibration using dual-quaternions and kronecker product @cite Li2010SimultaneousRA - - - - - type of the robust estimation algorithm - - - - - least-median of squares algorithm - - - - - RANSAC algorithm - - - - - RHO algorithm - - - - - USAC algorithm, default settings - - - - - USAC, parallel version - - - - - USAC, fundamental matrix 8 points - - - - - USAC, fast settings - - - - - USAC, accurate settings - - - - - USAC, sorted points, runs PROSAC - - - - - USAC, runs MAGSAC++ - - - - - Method for solving a PnP problem: - - - - - Iterative method is based on Levenberg-Marquardt optimization. - In this case the function finds such a pose that minimizes reprojection error, - that is the sum of squared distances between the observed projections imagePoints and the projected (using projectPoints() ) objectPoints . - - - - - Method has been introduced by F.Moreno-Noguer, V.Lepetit and P.Fua in the paper “EPnP: Efficient Perspective-n-Point Camera Pose Estimation”. - - - - - Method is based on the paper of X.S. Gao, X.-R. Hou, J. Tang, H.-F. Chang“Complete Solution Classification for - the Perspective-Three-Point Problem”. In this case the function requires exactly four object and image points. - - - - - Joel A. Hesch and Stergios I. Roumeliotis. "A Direct Least-Squares (DLS) Method for PnP" - - - - - A.Penate-Sanchez, J.Andrade-Cetto, F.Moreno-Noguer. "Exhaustive Linearization for Robust Camera Pose and Focal Length Estimation" - - - - - The operation flags for cvStereoRectify - - - - - Default value (=0). - the function can shift one of the image in horizontal or vertical direction (depending on the orientation of epipolar lines) in order to maximise the useful image area. - - - - - the function makes the principal points of each camera have the same pixel coordinates in the rectified views. - - - - - Semi-Global Stereo Matching - - - - - constructor - - - - - - - - - - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The base class for stereo correspondence algorithms. - - - - - constructor - - - - - Computes disparity map for the specified stereo pair - - Left 8-bit single-channel image. - Right image of the same size and the same type as the left one. - Output disparity map. It has the same size as the input images. Some algorithms, - like StereoBM or StereoSGBM compute 16-bit fixed-point disparity map(where each disparity value has 4 fractional bits), - whereas other algorithms output 32 - bit floating - point disparity map. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Semi-Global Stereo Matching - - - - - constructor - - - - - - - - - - - - - - - - - - - - - - Releases managed resources - - - - - Truncation value for the prefiltered image pixels. The algorithm first - computes x-derivative at each pixel and clips its value by [-preFilterCap, preFilterCap] interval. - The result values are passed to the Birchfield-Tomasi pixel cost function. - - - - - Margin in percentage by which the best (minimum) computed cost function - value should "win" the second best value to consider the found match correct. Normally, a value - within the 5-15 range is good enough. - - - - - The first parameter controlling the disparity smoothness. See P2 description. - - - - - The second parameter controlling the disparity smoothness. The larger the values are, - the smoother the disparity is. P1 is the penalty on the disparity change by plus or minus 1 - between neighbor pixels. P2 is the penalty on the disparity change by more than 1 between neighbor - pixels. The algorithm requires P2 \> P1 . See stereo_match.cpp sample where some reasonably good - P1 and P2 values are shown (like 8\*number_of_image_channels\*SADWindowSize\*SADWindowSize and - 32\*number_of_image_channels\*SADWindowSize\*SADWindowSize , respectively). - - - - - Set it to StereoSGBM::MODE_HH to run the full-scale two-pass dynamic programming - algorithm. It will consume O(W\*H\*numDisparities) bytes, which is large for 640x480 stereo and - huge for HD-size pictures. By default, it is set to false . - - - - - Base class for high-level OpenCV algorithms - - - - - Stores algorithm parameters in a file storage - - - - - - Reads algorithm parameters from a file storage - - - - - - Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read - - - - - - Saves the algorithm to a file. - In order to make this method work, the derived class must - implement Algorithm::write(FileStorage fs). - - - - - - Returns the algorithm string identifier. - This string is used as top level xml/yml node tag when the object - is saved to a file or string. - - - - - - Error Handler - - The numeric code for error status - The source file name where error is encountered - A description of the error - The source file name where error is encountered - The line number in the source where error is encountered - Pointer to the user data. Ignored by the standard handlers - - - - cv::AccessFlag - - - - - cv::Algorithm parameter type - - - - - Type of the border to create around the copied source image rectangle - - - https://github.com/opencv/opencv/blob/fc1a15626226609babd128e043cf7c4e32f567ca/modules/core/include/opencv2/core/base.hpp#L268 - - - - - Border is filled with the fixed value, passed as last parameter of the function. - `iiiiii|abcdefgh|iiiiiii` with some specified `i` - - - - - The pixels from the top and bottom rows, the left-most and right-most columns are replicated to fill the border. - `aaaaaa|abcdefgh|hhhhhhh` - - - - - `fedcba|abcdefgh|hgfedcb` - - - - - `cdefgh|abcdefgh|abcdefg` - - - - - `gfedcb|abcdefgh|gfedcba` - - - - - `uvwxyz|absdefgh|ijklmno` - - - - - same as BORDER_REFLECT_101 - - - - - do not look outside of ROI - - - - - The flag specifying the relation between the elements to be checked - - - - - src1(I) "equal to" src2(I) - - - - - src1(I) "greater than" src2(I) - - - - - src1(I) "greater or equal" src2(I) - - - - - src1(I) "less than" src2(I) - - - - - src1(I) "less or equal" src2(I) - - - - - src1(I) "not equal to" src2(I) - - - - - Operation flags for Covariation - - - - - scale * [vects[0]-avg,vects[1]-avg,...]^T * [vects[0]-avg,vects[1]-avg,...] - that is, the covariation matrix is count×count. Such an unusual covariation matrix is used for fast PCA of a set of very large vectors - (see, for example, Eigen Faces technique for face recognition). Eigenvalues of this "scrambled" matrix will match to the eigenvalues of - the true covariation matrix and the "true" eigenvectors can be easily calculated from the eigenvectors of the "scrambled" covariation matrix. - - - - - scale * [vects[0]-avg,vects[1]-avg,...]*[vects[0]-avg,vects[1]-avg,...]^T - that is, cov_mat will be a usual covariation matrix with the same linear size as the total number of elements in every input vector. - One and only one of CV_COVAR_SCRAMBLED and CV_COVAR_NORMAL must be specified - - - - - If the flag is specified, the function does not calculate avg from the input vectors, - but, instead, uses the passed avg vector. This is useful if avg has been already calculated somehow, - or if the covariation matrix is calculated by parts - in this case, avg is not a mean vector of the input sub-set of vectors, - but rather the mean vector of the whole set. - - - - - If the flag is specified, the covariation matrix is scaled by the number of input vectors. - - - - - Means that all the input vectors are stored as rows of a single matrix, vects[0].count is ignored in this case, - and avg should be a single-row vector of an appropriate size. - - - - - Means that all the input vectors are stored as columns of a single matrix, vects[0].count is ignored in this case, - and avg should be a single-column vector of an appropriate size. - - - - - - - - - - Type of termination criteria - - - - - the maximum number of iterations or elements to compute - - - - - the maximum number of iterations or elements to compute - - - - - the desired accuracy or change in parameters at which the iterative algorithm stops - - - - - Transformation flags for cv::dct - - - - - - - - - - Do inverse 1D or 2D transform. - (Forward and Inverse are mutually exclusive, of course.) - - - - - Do forward or inverse transform of every individual row of the input matrix. - This flag allows user to transform multiple vectors simultaneously and can be used to decrease the overhead - (which is sometimes several times larger than the processing itself), to do 3D and higher-dimensional transforms etc. - [CV_DXT_ROWS] - - - - - Inversion methods - - - - - Gaussian elimination with the optimal pivot element chosen. - - - - - singular value decomposition (SVD) method; - the system can be over-defined and/or the matrix src1 can be singular - - - - - eigenvalue decomposition; the matrix src1 must be symmetrical - - - - - Cholesky \f$LL^T\f$ factorization; the matrix src1 must be symmetrical - and positively defined - - - - - QR factorization; the system can be over-defined and/or the matrix - src1 can be singular - - - - - while all the previous flags are mutually exclusive, - this flag can be used together with any of the previous - - - - - Transformation flags for cvDFT - - - - - - - - - - Do inverse 1D or 2D transform. The result is not scaled. - (Forward and Inverse are mutually exclusive, of course.) - - - - - Scale the result: divide it by the number of array elements. Usually, it is combined with Inverse. - - - - - Do forward or inverse transform of every individual row of the input matrix. - This flag allows user to transform multiple vectors simultaneously and can be used to decrease the overhead - (which is sometimes several times larger than the processing itself), to do 3D and higher-dimensional transforms etc. - - - - - performs a forward transformation of 1D or 2D real array; the result, - though being a complex array, has complex-conjugate symmetry (*CCS*, - see the function description below for details), and such an array can - be packed into a real array of the same size as input, which is the fastest - option and which is what the function does by default; however, you may - wish to get a full complex array (for simpler spectrum analysis, and so on) - - pass the flag to enable the function to produce a full-size complex output array. - - - - - performs an inverse transformation of a 1D or 2D complex array; - the result is normally a complex array of the same size, however, - if the input array has conjugate-complex symmetry (for example, - it is a result of forward transformation with DFT_COMPLEX_OUTPUT flag), - the output is a real array; while the function itself does not - check whether the input is symmetrical or not, you can pass the flag - and then the function will assume the symmetry and produce the real - output array (note that when the input is packed into a real array - and inverse transformation is executed, the function treats the input - as a packed complex-conjugate symmetrical array, and the output - will also be a real array). - - - - - Distribution type for cvRandArr, etc. - - - - - Uniform distribution - - - - - Normal or Gaussian distribution - - - - - Error status codes - - - - - everithing is ok [CV_StsOk] - - - - - pseudo error for back trace [CV_StsBackTrace] - - - - - unknown /unspecified error [CV_StsError] - - - - - internal error (bad state) [CV_StsInternal] - - - - - insufficient memory [CV_StsNoMem] - - - - - function arg/param is bad [CV_StsBadArg] - - - - - unsupported function [CV_StsBadFunc] - - - - - iter. didn't converge [CV_StsNoConv] - - - - - tracing [CV_StsAutoTrace] - - - - - image header is NULL [CV_HeaderIsNull] - - - - - image size is invalid [CV_BadImageSize] - - - - - offset is invalid [CV_BadOffset] - - - - - [CV_BadOffset] - - - - - [CV_BadStep] - - - - - [CV_BadModelOrChSeq] - - - - - [CV_BadNumChannels] - - - - - [CV_BadNumChannel1U] - - - - - [CV_BadDepth] - - - - - [CV_BadAlphaChannel] - - - - - [CV_BadOrder] - - - - - [CV_BadOrigin] - - - - - [CV_BadAlign] - - - - - [CV_BadCallBack] - - - - - [CV_BadTileSize] - - - - - [CV_BadCOI] - - - - - [CV_BadROISize] - - - - - [CV_MaskIsTiled] - - - - - null pointer [CV_StsNullPtr] - - - - - incorrect vector length [CV_StsVecLengthErr] - - - - - incorr. filter structure content [CV_StsFilterStructContentErr] - - - - - incorr. transform kernel content [CV_StsKernelStructContentErr] - - - - - incorrect filter ofset value [CV_StsFilterOffsetErr] - - - - - the input/output structure size is incorrect [CV_StsBadSize] - - - - - division by zero [CV_StsDivByZero] - - - - - in-place operation is not supported [CV_StsInplaceNotSupported] - - - - - request can't be completed [CV_StsObjectNotFound] - - - - - formats of input/output arrays differ [CV_StsUnmatchedFormats] - - - - - flag is wrong or not supported [CV_StsBadFlag] - - - - - bad CvPoint [CV_StsBadPoint] - - - - - bad format of mask (neither 8uC1 nor 8sC1) [CV_StsBadMask] - - - - - sizes of input/output structures do not match [CV_StsUnmatchedSizes] - - - - - the data format/type is not supported by the function [CV_StsUnsupportedFormat] - - - - - some of parameters are out of range [CV_StsOutOfRange] - - - - - invalid syntax/structure of the parsed file [CV_StsParseError] - - - - - the requested function/feature is not implemented [CV_StsNotImplemented] - - - - - an allocated block has been corrupted [CV_StsBadMemBlock] - - - - - assertion failed - - - - - Output string format of Mat.Dump() - - - - - Default format. - [1, 2, 3, 4, 5, 6; \n - 7, 8, 9, ... ] - - - - - - - - - - CSV format. - 1, 2, 3, 4, 5, 6\n - 7, 8, 9, ... - - - - - Python format. - [[[1, 2, 3], [4, 5, 6]], \n - [[7, 8, 9], ... ] - - - - - NumPy format. - array([[[1, 2, 3], [4, 5, 6]], \n - [[7, 8, 9], .... ]]], type='uint8'); - - - - - C language format. - {1, 2, 3, 4, 5, 6, \n - 7, 8, 9, ...}; - - - - - The operation flags for cv::GEMM - - - - - - - - - - Transpose src1 - - - - - Transpose src2 - - - - - Transpose src3 - - - - - Font name identifier. - Only a subset of Hershey fonts (http://sources.isc.org/utils/misc/hershey-font.txt) are supported now. - - - - - normal size sans-serif font - - - - - small size sans-serif font - - - - - normal size sans-serif font (more complex than HERSHEY_SIMPLEX) - - - - - normal size serif font - - - - - normal size serif font (more complex than HERSHEY_COMPLEX) - - - - - smaller version of HERSHEY_COMPLEX - - - - - hand-writing style font - - - - - more complex variant of HERSHEY_SCRIPT_SIMPLEX - - - - - flag for italic font - - - - - - - - - - Miscellaneous flags for cv::kmeans - - - - - Select random initial centers in each attempt. - - - - - Use kmeans++ center initialization by Arthur and Vassilvitskii [Arthur2007]. - - - - - During the first (and possibly the only) attempt, use the - user-supplied labels instead of computing them from the initial centers. - For the second and further attempts, use the random or semi-random centers. - Use one of KMEANS_\*_CENTERS flag to specify the exact method. - - - - - cv::utils::logging::LogLevel - - - - - for using in setLogVevel() call - - - - - Fatal (critical) error (unrecoverable internal error) - - - - - Error message. - - - - - Warning message. - - - - - Info message. - - - - - Debug message. Disabled in the "Release" build. - - - - - Verbose (trace) messages. Requires verbosity level. Disabled in the "Release" build. - - - - - diagonal type - - - - - a diagonal from the upper half - [< 0] - - - - - Main diagonal - [= 0] - - - - - a diagonal from the lower half - [> 0] - - - - - Type of norm - - - - - - - - - - The L1-norm (sum of absolute values) of the array is normalized. - - - - - The (Euclidean) L2-norm of the array is normalized. - - - - - - - - - - - - - - - - - - - - - - - - - The array values are scaled and shifted to the specified range. - - - - - The dimension index along which the matrix is reduce. - - - - - The matrix is reduced to a single row. - [= 0] - - - - - The matrix is reduced to a single column. - [= 1] - - - - - The dimension is chosen automatically by analysing the dst size. - [= -1] - - - - - The reduction operations for cvReduce - - - https://github.com/opencv/opencv/blob/37c12db3668a1fbbfdb286be59f662c67cfbfea1/modules/core/include/opencv2/core.hpp#L231 - - - - - The output is the sum of all the matrix rows/columns. - - - - - The output is the mean vector of all the matrix rows/columns. - - - - - The output is the maximum (column/row-wise) of all the matrix rows/columns. - - - - - The output is the minimum (column/row-wise) of all the matrix rows/columns. - - - - - an enum to specify how to rotate the array. - - - - - Rotate 90 degrees clockwise - - - - - Rotate 180 degrees clockwise - - - - - Rotate 270 degrees clockwise - - - - - return codes for cv::solveLP() function - - - - - problem is unbounded (target function can achieve arbitrary high values) - - - - - problem is unfeasible (there are no points that satisfy all the constraints imposed) - - - - - there is only one maximum for target function - - - - - there are multiple maxima for target function - the arbitrary one is returned - - - - - Signals an error and raises the exception. - - - - - each matrix row is sorted independently - - - - - each matrix column is sorted independently; - this flag and the previous one are mutually exclusive. - - - - - each matrix row is sorted in the ascending order. - - - - - each matrix row is sorted in the descending order; - this flag and the previous one are also mutually exclusive. - - - - - cv::UMatUsageFlags - - - - - File Storage Node class - - - - - The default constructor - - - - - Initializes from cv::FileNode* - - - - - - Releases unmanaged resources - - - - - Returns the node content as an integer. If the node stores floating-point number, it is rounded. - - - - - - - Returns the node content as an integer. If the node stores floating-point number, it is rounded. - - - - - - Returns the node content as float - - - - - - - Returns the node content as System.Single - - - - - - Returns the node content as double - - - - - - - Returns the node content as double - - - - - - Returns the node content as text string - - - - - - - Returns the node content as text string - - - - - - Returns the node content as OpenCV Mat - - - - - - - Returns the node content as OpenCV Mat - - - - - - returns element of a mapping node - - - - - returns element of a sequence node - - - - - Returns true if the node is empty - - - - - - Returns true if the node is a "none" object - - - - - - Returns true if the node is a sequence - - - - - - Returns true if the node is a mapping - - - - - - Returns true if the node is an integer - - - - - - Returns true if the node is a floating-point number - - - - - - Returns true if the node is a text string - - - - - - Returns true if the node has a name - - - - - - Returns the node name or an empty string if the node is nameless - - - - - - Returns the number of elements in the node, if it is a sequence or mapping, or 1 otherwise. - - - - - - Returns type of the node. - - Type of the node. - - - - returns iterator pointing to the first node element - - - - - - returns iterator pointing to the element following the last node element - - - - - - Get FileNode iterator - - - - - - Reads node elements to the buffer with the specified format - - - - - - - - Reads the node element as Int32 (int) - - - - - - - Reads the node element as Single (float) - - - - - - - Reads the node element as Double - - - - - - - Reads the node element as String - - - - - - - Reads the node element as Mat - - - - - - - Reads the node element as SparseMat - - - - - - - Reads the node element as KeyPoint[] - - - - - - Reads the node element as DMatch[] - - - - - - Reads the node element as Range - - - - - - Reads the node element as KeyPoint - - - - - - Reads the node element as DMatch - - - - - - Reads the node element as Point - - - - - - Reads the node element as Point2f - - - - - - Reads the node element as Point2d - - - - - - Reads the node element as Point3i - - - - - - Reads the node element as Point3f - - - - - - Reads the node element as Point3d - - - - - - Reads the node element as Size - - - - - - Reads the node element as Size2f - - - - - - Reads the node element as Size2d - - - - - - Reads the node element as Rect - - - - - - Reads the node element as Rect2f - - - - - - Reads the node element as Rect2d - - - - - - Reads the node element as Scalar - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - Reads the node element as Vector - - - - - - type of the file storage node - - - - - empty node - - - - - an integer - - - - - floating-point number - - - - - synonym or REAL - - - - - text string in UTF-8 encoding - - - - - synonym for STR - - - - - sequence - - - - - mapping - - - - - - - - - - compact representation of a sequence or mapping. Used only by YAML writer - - - - - if set, means that all the collection elements are numbers of the same type (real's or int's). - UNIFORM is used only when reading FileStorage; FLOW is used only when writing. So they share the same bit - - - - - empty structure (sequence or mapping) - - - - - the node has a name (i.e. it is element of a mapping) - - - - - - File Storage Node class - - - - - The default constructor - - - - - Initializes from cv::FileNode* - - - - - - Releases unmanaged resources - - - - - Reads node elements to the buffer with the specified format. - Usually it is more convenient to use operator `>>` instead of this method. - - Specification of each array element.See @ref format_spec "format specification" - Pointer to the destination array. - Number of elements to read. If it is greater than number of remaining elements then all of them will be read. - - - - - *iterator - - - - - IEnumerable<T>.Reset - - - - - iterator++ - - - - - - iterator += ofs - - - - - - - Reads node elements to the buffer with the specified format. - Usually it is more convenient to use operator `>>` instead of this method. - - Specification of each array element.See @ref format_spec "format specification" - Pointer to the destination array. - Number of elements to read. If it is greater than number of remaining elements then all of them will be read. - - - - - XML/YAML File Storage Class. - - - - - Default constructor. - You should call FileStorage::open() after initialization. - - - - - The full constructor - - Name of the file to open or the text string to read the data from. - Extension of the file (.xml or .yml/.yaml) determines its format - (XML or YAML respectively). Also you can append .gz to work with - compressed files, for example myHugeMatrix.xml.gz. - If both FileStorage::WRITE and FileStorage::MEMORY flags are specified, - source is used just to specify the output file format - (e.g. mydata.xml, .yml etc.). - - Encoding of the file. Note that UTF-16 XML encoding is not supported - currently and you should use 8-bit encoding instead of it. - - - - Releases unmanaged resources - - - - - Returns the specified element of the top-level mapping - - - - - - - the currently written element - - - - - the writer state - - - - - operator that performs PCA. The previously stored data, if any, is released - - Name of the file to open or the text string to read the data from. - Extension of the file (.xml, .yml/.yaml or .json) determines its format (XML, YAML or JSON respectively). - Also you can append .gz to work with compressed files, for example myHugeMatrix.xml.gz. - If both FileStorage::WRITE and FileStorage::MEMORY flags are specified, source is used just to specify the output file format (e.g. mydata.xml, .yml etc.). - A file name can also contain parameters. You can use this format, "*?base64" (e.g. "file.json?base64" (case sensitive)), - as an alternative to FileStorage::BASE64 flag. - Mode of operation. - Encoding of the file. Note that UTF-16 XML encoding is not supported - currently and you should use 8-bit encoding instead of it. - - - - - Returns true if the object is associated with currently opened file. - - - - - - Closes the file and releases all the memory buffers - - - - - Closes the file, releases all the memory buffers and returns the text string - - - - - - Returns the first element of the top-level mapping - - The first element of the top-level mapping. - - - - Returns the top-level mapping. YAML supports multiple streams - - Zero-based index of the stream. In most cases there is only one stream in the file. - However, YAML supports multiple streams and so there can be several. - The top-level mapping. - - - - Writes one or more numbers of the specified format to the currently written structure - - Specification of each array element, see @ref format_spec "format specification" - Pointer to the written array. - Number of the uchar elements to write. - - - - Writes a comment. - The function writes a comment into file storage. The comments are skipped when the storage is read. - - The written comment, single-line or multi-line - If true, the function tries to put the comment at the end of current line. - Else if the comment is multi-line, or if it does not fit at the end of the current line, the comment starts a new line. - - - - - - - - - - - - - - - - - Returns the normalized object name for the specified file name - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - /Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - Writes data to a file storage. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - File storage mode - - - - - The storage is open for reading - - - - - The storage is open for writing - - - - - The storage is open for appending - - - - - flag, read data from source or write data to the internal buffer - (which is returned by FileStorage::release) - - - - - flag, auto format - - - - - flag, XML format - - - - - flag, YAML format - - - - - flag, write rawdata in Base64 by default. (consider using WRITE_BASE64) - - - - - flag, enable both WRITE and BASE64 - - - - - Proxy data type for passing Mat's and vector<>'s as input parameters - - - - - Constructor - - - - - - Constructor - - - - - - Constructor - - - - - - Constructor - - - - - - Constructor - - - - - - Constructor - - - - - - Constructor - - - - - - Constructor - - - - - - Constructor - - - - - - Constructor - - - - - - Constructor - - - - - - Constructor - - - - - - - - - - - - Releases managed resources - - - - - Releases unmanaged resources - - - - - Creates a proxy class of the specified Mat - - - - - - - Creates a proxy class of the specified Mat - - - - - - - Creates a proxy class of the specified MatExpr - - - - - - - Creates a proxy class of the specified Scalar - - - - - - - Creates a proxy class of the specified double - - - - - - - Creates a proxy class of the specified array of Mat - - - - - - - Creates a proxy class of the specified list - - Array object - - - - - Creates a proxy class of the specified list - - Array object - Matrix depth and channels for converting array to cv::Mat - - - - - Creates a proxy class of the specified list - - Array object - - - - - Creates a proxy class of the specified list - - Array object - Matrix depth and channels for converting array to cv::Mat - - - - - Creates a proxy class of the specified list - - Array object - - - - - Creates a proxy class of the specified list - - Array object - Matrix depth and channels for converting array to cv::Mat - - - - - Creates a proxy class of the specified Vec*b - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Proxy data type for passing Mat's and vector<>'s as input parameters. - Synonym for OutputArray. - - - - - Constructor - - - - - - Constructor - - - - - - Creates a proxy class of the specified Mat - - - - - - - Creates a proxy class of the specified UMat - - - - - - - - - - - - - - - - - - - - - Linear Discriminant Analysis - - - - - constructor - - - - - - Initializes and performs a Discriminant Analysis with Fisher's - Optimization Criterion on given data in src and corresponding labels - in labels.If 0 (or less) number of components are given, they are - automatically determined for given data in computation. - - - - - - - - Releases unmanaged resources - - - - - Returns the eigenvectors of this LDA. - - - - - Returns the eigenvalues of this LDA. - - - - - Serializes this object to a given filename. - - - - - - Deserializes this object from a given filename. - - - - - - Serializes this object to a given cv::FileStorage. - - - - - - Deserializes this object from a given cv::FileStorage. - - - - - - Compute the discriminants for data in src (row aligned) and labels. - - - - - - - Projects samples into the LDA subspace. - src may be one or more row aligned samples. - - - - - - - Reconstructs projections from the LDA subspace. - src may be one or more row aligned projections. - - - - - - - - - - - - - - - - - - - - - - - - - Matrix expression - - - - - Constructor - - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - Convert to cv::Mat - - - - - - - Convert to cv::Mat - - - - - - Convert cv::Mat to cv::MatExpr - - - - - - - Convert cv::Mat to cv::MatExpr - - - - - - - Extracts a rectangular submatrix. - - - - - - - - - - Extracts a rectangular submatrix. - - - - - - - - Extracts a rectangular submatrix. - - - - - - - Creates a matrix header for the specified matrix row. - - A 0-based row index. - - - - - Creates a matrix header for the specified matrix column. - - A 0-based column index. - - - - - Extracts a diagonal from a matrix - - d index of the diagonal, with the following values: - - d=0 is the main diagonal. - - d<0 is a diagonal from the lower half. For example, d=-1 means the diagonal is set immediately below the main one. - - d>0 is a diagonal from the upper half. For example, d=1 means the diagonal is set immediately above the main one. - - - - - Extracts a rectangular submatrix. - - - - - - - - - - Extracts a rectangular submatrix. - - - - - - - - Extracts a rectangular submatrix. - - - - - - - Transposes a matrix. - - - - - - Inverses a matrix. - - - - - - - Performs an element-wise multiplication or division of the two matrices. - - Another array of the same type and the same size as this, or a matrix expression. - Optional scale factor. - - - - - Performs an element-wise multiplication or division of the two matrices. - - Another array of the same type and the same size as this, or a matrix expression. - Optional scale factor. - - - - - Computes a cross-product of two 3-element vectors. - - Another cross-product operand. - - - - - Computes a dot-product of two vectors. - - another dot-product operand. - - - - - Returns the size of a matrix element. - - - - - Returns the type of a matrix element. - - - - - Computes absolute value of each matrix element - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - OpenCV C++ n-dimensional dense array class (cv::Mat) - - - - - typeof(T) -> MatType - - - - - Creates from native cv::Mat* pointer - - - - - - Creates from native cv::Mat* pointer - - - - - - Creates empty Mat - - - - - - - - - - - Loads an image from a file. (cv::imread) - - Name of file to be loaded. - Specifies color type of the loaded image - - - - constructs 2D matrix of the specified size and type - - Number of rows in a 2D array. - Number of columns in a 2D array. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - - - - constructs 2D matrix of the specified size and type - - 2D array size: Size(cols, rows) . In the Size() constructor, - the number of rows and the number of columns go in the reverse order. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType.CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - - - - constructs 2D matrix and fills it with the specified Scalar value. - - Number of rows in a 2D array. - Number of columns in a 2D array. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - An optional value to initialize each matrix element with. - To set all the matrix elements to the particular value after the construction, use SetTo(Scalar s) method . - - - - constructs 2D matrix and fills it with the specified Scalar value. - - 2D array size: Size(cols, rows) . In the Size() constructor, - the number of rows and the number of columns go in the reverse order. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or CV_8UC(n), ..., CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices. - An optional value to initialize each matrix element with. - To set all the matrix elements to the particular value after the construction, use SetTo(Scalar s) method . - - - - creates a matrix header for a part of the bigger matrix - - Array that (as a whole or partly) is assigned to the constructed matrix. - No data is copied by these constructors. Instead, the header pointing to m data or its sub-array - is constructed and associated with it. The reference counter, if any, is incremented. - So, when you modify the matrix formed using such a constructor, you also modify the corresponding elements of m . - If you want to have an independent copy of the sub-array, use Mat::clone() . - Range of the m rows to take. As usual, the range start is inclusive and the range end is exclusive. - Use Range.All to take all the rows. - Range of the m columns to take. Use Range.All to take all the columns. - - - - creates a matrix header for a part of the bigger matrix - - Array that (as a whole or partly) is assigned to the constructed matrix. - No data is copied by these constructors. Instead, the header pointing to m data or its sub-array - is constructed and associated with it. The reference counter, if any, is incremented. - So, when you modify the matrix formed using such a constructor, you also modify the corresponding elements of m . - If you want to have an independent copy of the sub-array, use Mat.Clone() . - Array of selected ranges of m along each dimensionality. - - - - creates a matrix header for a part of the bigger matrix - - Array that (as a whole or partly) is assigned to the constructed matrix. - No data is copied by these constructors. Instead, the header pointing to m data or its sub-array - is constructed and associated with it. The reference counter, if any, is incremented. - So, when you modify the matrix formed using such a constructor, you also modify the corresponding elements of m . - If you want to have an independent copy of the sub-array, use Mat.Clone() . - Region of interest. - - - - constructor for matrix headers pointing to user-allocated data - - Number of rows in a 2D array. - Number of columns in a 2D array. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. - Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. - This operation is very efficient and can be used to process external data using OpenCV functions. - The external data is not automatically de-allocated, so you should take care of it. - Number of bytes each matrix row occupies. The value should include the padding bytes at the end of each row, if any. - If the parameter is missing (set to AUTO_STEP ), no padding is assumed and the actual step is calculated as cols*elemSize() . - - - - constructor for matrix headers pointing to user-allocated data - - Number of rows in a 2D array. - Number of columns in a 2D array. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. - Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. - This operation is very efficient and can be used to process external data using OpenCV functions. - The external data is not automatically de-allocated, so you should take care of it. - Number of bytes each matrix row occupies. The value should include the padding bytes at the end of each row, if any. - If the parameter is missing (set to AUTO_STEP ), no padding is assumed and the actual step is calculated as cols*elemSize() . - - - - constructor for matrix headers pointing to user-allocated data - - Number of rows in a 2D array. - Number of columns in a 2D array. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. - Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. - This operation is very efficient and can be used to process external data using OpenCV functions. - The external data is not automatically de-allocated, so you should take care of it. - Number of bytes each matrix row occupies. The value should include the padding bytes at the end of each row, if any. - If the parameter is missing (set to AUTO_STEP ), no padding is assumed and the actual step is calculated as cols*elemSize() . - - - - constructor for matrix headers pointing to user-allocated data - - Number of rows in a 2D array. - Number of columns in a 2D array. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. - Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. - This operation is very efficient and can be used to process external data using OpenCV functions. - The external data is not automatically de-allocated, so you should take care of it. - Number of bytes each matrix row occupies. The value should include the padding bytes at the end of each row, if any. - If the parameter is missing (set to AUTO_STEP ), no padding is assumed and the actual step is calculated as cols*elemSize() . - - - - constructor for matrix headers pointing to user-allocated data - - Array of integers specifying an n-dimensional array shape. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. - Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. - This operation is very efficient and can be used to process external data using OpenCV functions. - The external data is not automatically de-allocated, so you should take care of it. - Array of ndims-1 steps in case of a multi-dimensional array (the last step is always set to the element size). - If not specified, the matrix is assumed to be continuous. - - - - constructor for matrix headers pointing to user-allocated data - - Array of integers specifying an n-dimensional array shape. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. - Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. - This operation is very efficient and can be used to process external data using OpenCV functions. - The external data is not automatically de-allocated, so you should take care of it. - Array of ndims-1 steps in case of a multi-dimensional array (the last step is always set to the element size). - If not specified, the matrix is assumed to be continuous. - - - - constructor for matrix headers pointing to user-allocated data - - Array of integers specifying an n-dimensional array shape. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. - Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. - This operation is very efficient and can be used to process external data using OpenCV functions. - The external data is not automatically de-allocated, so you should take care of it. - Array of ndims-1 steps in case of a multi-dimensional array (the last step is always set to the element size). - If not specified, the matrix is assumed to be continuous. - - - - constructs n-dimensional matrix - - Array of integers specifying an n-dimensional array shape. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - - - - constructs n-dimensional matrix - - Array of integers specifying an n-dimensional array shape. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - An optional value to initialize each matrix element with. - To set all the matrix elements to the particular value after the construction, use SetTo(Scalar s) method . - - - - Releases the resources - - - - - - Releases unmanaged resources - - - - - Creates the Mat instance from System.IO.Stream - - - - - - - - Creates the Mat instance from image data (using cv::decode) - - - - - - - - Reads image from the specified buffer in memory. - - The input slice of bytes. - The same flags as in imread - - - - - Creates the Mat instance from image data (using cv::decode) - - - - - - - - Reads image from the specified buffer in memory. - - The input slice of bytes. - The same flags as in imread - - - - - Extracts a diagonal from a matrix, or creates a diagonal matrix. - - One-dimensional matrix that represents the main diagonal. - - - - - Returns a zero array of the specified size and type. - - Number of rows. - Number of columns. - Created matrix type. - - - - - Returns a zero array of the specified size and type. - - Alternative to the matrix size specification Size(cols, rows) . - Created matrix type. - - - - - Returns a zero array of the specified size and type. - - Created matrix type. - - - - - - Returns an array of all 1’s of the specified size and type. - - Number of rows. - Number of columns. - Created matrix type. - - - - - Returns an array of all 1’s of the specified size and type. - - Alternative to the matrix size specification Size(cols, rows) . - Created matrix type. - - - - - Returns an array of all 1’s of the specified size and type. - - Created matrix type. - Array of integers specifying the array shape. - - - - - Returns an identity matrix of the specified size and type. - - Alternative to the matrix size specification Size(cols, rows) . - Created matrix type. - - - - - Returns an identity matrix of the specified size and type. - - Number of rows. - Number of columns. - Created matrix type. - - - - - Initializes as N x 1 matrix and copies array data to this - - Source array data to be copied to this - - - - Initializes as M x N matrix and copies array data to this - - Source array data to be copied to this - - - - Initializes as N x 1 matrix and copies array data to this - - Source array data to be copied to this - - - - operator < - - - - - - - operator < - - - - - - - operator <= - - - - - - - operator <= - - - - - - - operator == - - - - - - - operator == - - - - - - - operator != - - - - - - - operator != - - - - - - - operator > - - - - - - - operator > - - - - - - - operator >= - - - - - - - operator >= - - - - - - - Extracts a rectangular submatrix. - - Start row of the extracted submatrix. The upper boundary is not included. - End row of the extracted submatrix. The upper boundary is not included. - Start column of the extracted submatrix. The upper boundary is not included. - End column of the extracted submatrix. The upper boundary is not included. - - - - - Extracts a rectangular submatrix. - - Start and end row of the extracted submatrix. The upper boundary is not included. - To select all the rows, use Range.All(). - Start and end column of the extracted submatrix. - The upper boundary is not included. To select all the columns, use Range.All(). - - - - - Extracts a rectangular submatrix. - - Extracted submatrix specified as a rectangle. - - - - - Extracts a rectangular submatrix. - - Array of selected ranges along each array dimension. - - - - - Retrieve UMat from Mat - - - - - - - - Creates a matrix header for the specified matrix column. - - A 0-based column index. - - - - - Creates a matrix header for the specified column span. - - An inclusive 0-based start index of the column span. - An exclusive 0-based ending index of the column span. - - - - - Creates a matrix header for the specified column span. - - - - - - - Creates a matrix header for the specified matrix row. - - A 0-based row index. - - - - - Creates a matrix header for the specified row span. - - - - - - - - Creates a matrix header for the specified row span. - - - - - - - Single-column matrix that forms a diagonal matrix or index of the diagonal, with the following values: - - Single-column matrix that forms a diagonal matrix or index of the diagonal, with the following values: - - - - - Creates a full copy of the matrix. - - - - - - Returns the partial Mat of the specified Mat - - - - - - - Copies the matrix to another one. - - Destination matrix. If it does not have a proper size or type before the operation, it is reallocated. - Operation mask. Its non-zero elements indicate which matrix elements need to be copied. - - - - Copies the matrix to another one. - - Destination matrix. If it does not have a proper size or type before the operation, it is reallocated. - Operation mask. Its non-zero elements indicate which matrix elements need to be copied. - - - - Converts an array to another data type with optional scaling. - - output matrix; if it does not have a proper size or type before the operation, it is reallocated. - desired output matrix type or, rather, the depth since the number of channels are the same as the input has; - if rtype is negative, the output matrix will have the same type as the input. - optional scale factor. - optional delta added to the scaled values. - - - - Provides a functional form of convertTo. - - Destination array. - Desired destination array depth (or -1 if it should be the same as the source type). - - - - Sets all or some of the array elements to the specified value. - - - - - - - - Sets all or some of the array elements to the specified value. - - - - - - - - Changes the shape and/or the number of channels of a 2D matrix without copying the data. - - New number of channels. If the parameter is 0, the number of channels remains the same. - New number of rows. If the parameter is 0, the number of rows remains the same. - - - - - Changes the shape and/or the number of channels of a 2D matrix without copying the data. - - New number of channels. If the parameter is 0, the number of channels remains the same. - New number of rows. If the parameter is 0, the number of rows remains the same. - - - - - Transposes a matrix. - - - - - - Inverses a matrix. - - Matrix inversion method - - - - - Performs an element-wise multiplication or division of the two matrices. - - - - - - - - Computes a cross-product of two 3-element vectors. - - Another cross-product operand. - - - - - Computes a dot-product of two vectors. - - another dot-product operand. - - - - - Allocates new array data if needed. - - New number of rows. - New number of columns. - New matrix type. - - - - Allocates new array data if needed. - - Alternative new matrix size specification: Size(cols, rows) - New matrix type. - - - - Allocates new array data if needed. - - Array of integers specifying a new array shape. - New matrix type. - - - - Reserves space for the certain number of rows. - - The method reserves space for sz rows. If the matrix already has enough space to store sz rows, - nothing happens. If the matrix is reallocated, the first Mat::rows rows are preserved. The method - emulates the corresponding method of the STL vector class. - - Number of rows. - - - - Reserves space for the certain number of bytes. - - The method reserves space for sz bytes. If the matrix already has enough space to store sz bytes, - nothing happens. If matrix has to be reallocated its previous content could be lost. - - Number of bytes. - - - - Changes the number of matrix rows. - - New number of rows. - - - - Changes the number of matrix rows. - - New number of rows. - Value assigned to the newly added elements. - - - - removes several hyper-planes from bottom of the matrix (Mat.pop_back) - - - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat::push_back) - - Added element - - - - Adds elements to the bottom of the matrix. (Mat.push_back) - - Added line(s) - - - - Locates the matrix header within a parent matrix. - - Output parameter that contains the size of the whole matrix containing *this as a part. - Output parameter that contains an offset of *this inside the whole matrix. - - - - Adjusts a submatrix size and position within the parent matrix. - - Shift of the top submatrix boundary upwards. - Shift of the bottom submatrix boundary downwards. - Shift of the left submatrix boundary to the left. - Shift of the right submatrix boundary to the right. - - - - - Extracts a rectangular submatrix. - - - - - - - - - - Extracts a rectangular submatrix. - - Start and end row of the extracted submatrix. The upper boundary is not included. - To select all the rows, use Range::all(). - Start and end column of the extracted submatrix. The upper boundary is not included. - To select all the columns, use Range::all(). - - - - - Extracts a rectangular submatrix. - - Extracted submatrix specified as a rectangle. - - - - - Extracts a rectangular submatrix. - - Array of selected ranges along each array dimension. - - - - - Reports whether the matrix is continuous or not. - - - - - - Returns whether this matrix is a part of other matrix or not. - - - - - - Returns the matrix element size in bytes. - - - - - - Returns the size of each matrix element channel in bytes. - - - - - - Returns the type of a matrix element. - - - - - - Returns the depth of a matrix element. - - - - - - Returns the number of matrix channels. - - - - - - Returns a normalized step. - - - - - - - Returns true if the array has no elements. - - - - - - Returns the total number of array elements. - - - - - - Returns the total number of array elements. - The method returns the number of elements within a certain sub-array slice with startDim <= dim < endDim - - - - - - - - - - Number of channels or number of columns the matrix should have. - For a 2-D matrix, when the matrix has only 1 column, then it should have - elemChannels channels; When the matrix has only 1 channel, - then it should have elemChannels columns. For a 3-D matrix, it should have only one channel. - Furthermore, if the number of planes is not one, then the number of rows within every - plane has to be 1; if the number of rows within every plane is not 1, - then the number of planes has to be 1. - The depth the matrix should have. Set it to -1 when any depth is fine. - Set it to true to require the matrix to be continuous - -1 if the requirement is not satisfied. - Otherwise, it returns the number of elements in the matrix. Note that an element may have multiple channels. - - - - Returns a pointer to the specified matrix row. - - Index along the dimension 0 - - - - - Returns a pointer to the specified matrix element. - - Index along the dimension 0 - Index along the dimension 1 - - - - - Returns a pointer to the specified matrix element. - - Index along the dimension 0 - Index along the dimension 1 - Index along the dimension 2 - - - - - Returns a pointer to the specified matrix element. - - Array of Mat::dims indices. - - - - - includes several bit-fields: - - the magic signature - - continuity flag - - depth - - number of channels - - - - - the array dimensionality, >= 2 - - - - - the number of rows or -1 when the array has more than 2 dimensions - - - - - the number of rows or -1 when the array has more than 2 dimensions - - - - - - the number of columns or -1 when the array has more than 2 dimensions - - - - - - the number of columns or -1 when the array has more than 2 dimensions - - - - - - pointer to the data - - - - - unsafe pointer to the data - - - - - The pointer that is possible to compute a relative sub-array position in the main container array using locateROI() - - - - - The pointer that is possible to compute a relative sub-array position in the main container array using locateROI() - - - - - The pointer that is possible to compute a relative sub-array position in the main container array using locateROI() - - - - - Returns a matrix size. - - - - - - Returns a matrix size. - - - - - - - Returns number of bytes each matrix row occupies. - - - - - - Returns number of bytes each matrix row occupies. - - - - - - - Returns a string that represents this Mat. - - - - - - Returns a string that represents each element value of Mat. - This method corresponds to std::ostream << Mat - - - - - - - Makes a Mat that have the same size, depth and channels as this image - - - - - - Gets a type-specific indexer. The indexer has getters/setters to access each matrix element. - - - - - - - Gets a type-specific unsafe indexer. The indexer has getters/setters to access each matrix element. - - - - - - - Mat Indexer - - - - - - 1-dimensional indexer - - Index along the dimension 0 - A value to the specified array element. - - - - 2-dimensional indexer - - Index along the dimension 0 - Index along the dimension 1 - A value to the specified array element. - - - - 3-dimensional indexer - - Index along the dimension 0 - Index along the dimension 1 - Index along the dimension 2 - A value to the specified array element. - - - - n-dimensional indexer - - Array of Mat::dims indices. - A value to the specified array element. - - - - Mat Indexer - - - - - - 1-dimensional indexer - - Index along the dimension 0 - A value to the specified array element. - - - - 2-dimensional indexer - - Index along the dimension 0 - Index along the dimension 1 - A value to the specified array element. - - - - 3-dimensional indexer - - Index along the dimension 0 - Index along the dimension 1 - Index along the dimension 2 - A value to the specified array element. - - - - n-dimensional indexer - - Array of Mat::dims indices. - A value to the specified array element. - - - - Returns a value to the specified array element. - - - Index along the dimension 0 - A value to the specified array element. - - - - Returns a value to the specified array element. - - - Index along the dimension 0 - Index along the dimension 1 - A value to the specified array element. - - - - Returns a value to the specified array element. - - - Index along the dimension 0 - Index along the dimension 1 - Index along the dimension 2 - A value to the specified array element. - - - - Returns a value to the specified array element. - - - Array of Mat::dims indices. - A value to the specified array element. - - - - Returns a value to the specified array element. - - - Index along the dimension 0 - A value to the specified array element. - - - - Returns a value to the specified array element. - - - Index along the dimension 0 - Index along the dimension 1 - A value to the specified array element. - - - - Returns a value to the specified array element. - - - Index along the dimension 0 - Index along the dimension 1 - Index along the dimension 2 - A value to the specified array element. - - - - Returns a value to the specified array element. - - - Array of Mat::dims indices. - A value to the specified array element. - - - - Set a value to the specified array element. - - - Index along the dimension 0 - - - - - Set a value to the specified array element. - - - Index along the dimension 0 - Index along the dimension 1 - - - - - Set a value to the specified array element. - - - Index along the dimension 0 - Index along the dimension 1 - Index along the dimension 2 - - - - - Set a value to the specified array element. - - - Array of Mat::dims indices. - - - - - Get the data of this matrix as array - - Primitive or Vec array to be copied - Length of copied bytes - - using var m1 = new Mat(1, 1, MatType.CV_8UC1); - m1.GetArray(out byte[] array); - - using var m2 = new Mat(1, 1, MatType.CV_32SC1); - m2.GetArray(out int[] array); - - using var m3 = new Mat(1, 1, MatType.CV_8UC(6)); - m3.GetArray(out Vec6b[] array); - - using var m4 = new Mat(1, 1, MatType.CV_64FC4); - m4.GetArray(out Vec4d[] array); - - - - - Get the data of this matrix as array - - Primitive or Vec array to be copied - Length of copied bytes - - using var m1 = new Mat(1, 1, MatType.CV_8UC1); - m1.GetRectangularArray(out byte[,] array); - - using var m2 = new Mat(1, 1, MatType.CV_32SC1); - m2.GetRectangularArray(out int[,] array); - - using var m3 = new Mat(1, 1, MatType.CV_8UC(6)); - m3.GetRectangularArray(out Vec6b[,] array); - - using var m4 = new Mat(1, 1, MatType.CV_64FC4); - m4.GetRectangularArray(out Vec4d[,] array); - - - - - Set the specified array data to this matrix - - Primitive or Vec array to be copied - Length of copied bytes - - - - Set the specified array data to this matrix - - Primitive or Vec array to be copied - Length of copied bytes - - - - Encodes an image into a memory buffer. - - Encodes an image into a memory buffer. - Format-specific parameters. - - - - - Encodes an image into a memory buffer. - - Encodes an image into a memory buffer. - Format-specific parameters. - - - - - Converts Mat to System.IO.MemoryStream - - - - - - - - Writes image data encoded from this Mat to System.IO.Stream - - - - - - - - - - - - - - - - Creates type-specific Mat instance from this. - - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Runs the given functor over all matrix elements in parallel. - - - - - - Creates a new span over the Mat. - - - - - - - Computes absolute value of each matrix element - - - - - - Scales, computes absolute values and converts the result to 8-bit. - - The optional scale factor. [By default this is 1] - The optional delta added to the scaled values. [By default this is 0] - - - - - transforms array of numbers using a lookup table: dst(i)=lut(src(i)) - - Look-up table of 256 elements. - In the case of multi-channel source array, the table should either have - a single channel (in this case the same table is used for all channels) - or the same number of channels as in the source array - - - - - transforms array of numbers using a lookup table: dst(i)=lut(src(i)) - - Look-up table of 256 elements. - In the case of multi-channel source array, the table should either have - a single channel (in this case the same table is used for all channels) - or the same number of channels as in the source array - - - - - computes sum of array elements - - - - - - computes the number of nonzero array elements - - number of non-zero elements in mtx - - - - returns the list of locations of non-zero pixels - - - - - - computes mean value of selected array elements - - The optional operation mask - - - - - computes mean value and standard deviation of all or selected array elements - - The output parameter: computed mean value - The output parameter: computed standard deviation - The optional operation mask - - - - computes norm of the selected array part - - Type of the norm - The optional operation mask - - - - - scales and shifts array elements so that either the specified norm (alpha) - or the minimum (alpha) and maximum (beta) array values get the specified values - - The norm value to normalize to or the lower range boundary - in the case of range normalization - The upper range boundary in the case of range normalization; - not used for norm normalization - The normalization type - When the parameter is negative, - the destination array will have the same type as src, - otherwise it will have the same number of channels as src and the depth =CV_MAT_DEPTH(rtype) - The optional operation mask - - - - - finds global minimum and maximum array elements and returns their values and their locations - - Pointer to returned minimum value - Pointer to returned maximum value - - - - finds global minimum and maximum array elements and returns their values and their locations - - Pointer to returned minimum location - Pointer to returned maximum location - - - - finds global minimum and maximum array elements and returns their values and their locations - - Pointer to returned minimum value - Pointer to returned maximum value - Pointer to returned minimum location - Pointer to returned maximum location - The optional mask used to select a sub-array - - - - finds global minimum and maximum array elements and returns their values and their locations - - Pointer to returned minimum value - Pointer to returned maximum value - - - - finds global minimum and maximum array elements and returns their values and their locations - - - - - - - finds global minimum and maximum array elements and returns their values and their locations - - Pointer to returned minimum value - Pointer to returned maximum value - - - - - - - transforms 2D matrix to 1D row or column vector by taking sum, minimum, maximum or mean value over all the rows - - The dimension index along which the matrix is reduced. - 0 means that the matrix is reduced to a single row and 1 means that the matrix is reduced to a single column - - When it is negative, the destination vector will have - the same type as the source matrix, otherwise, its type will be CV_MAKE_TYPE(CV_MAT_DEPTH(dtype), mtx.channels()) - - - - - Copies each plane of a multi-channel array to a dedicated array - - The number of arrays must match mtx.channels() . - The arrays themselves will be reallocated if needed - - - - extracts a single channel from src (coi is 0-based index) - - - - - - - inserts a single channel to dst (coi is 0-based index) - - - - - - - reverses the order of the rows, columns or both in a matrix - - Specifies how to flip the array: - 0 means flipping around the x-axis, positive (e.g., 1) means flipping around y-axis, - and negative (e.g., -1) means flipping around both axes. See also the discussion below for the formulas. - The destination array; will have the same size and same type as src - - - - replicates the input matrix the specified number of times in the horizontal and/or vertical direction - - How many times the src is repeated along the vertical axis - How many times the src is repeated along the horizontal axis - - - - - Checks if array elements lie between the elements of two other arrays. - - inclusive lower boundary array or a scalar. - inclusive upper boundary array or a scalar. - The destination array, will have the same size as src and CV_8U type - - - - Checks if array elements lie between the elements of two other arrays. - - inclusive lower boundary array or a scalar. - inclusive upper boundary array or a scalar. - The destination array, will have the same size as src and CV_8U type - - - - computes square root of each matrix element (dst = src**0.5) - - The destination array; will have the same size and the same type as src - - - - raises the input matrix elements to the specified power (b = a**power) - - The exponent of power - The destination array; will have the same size and the same type as src - - - - computes exponent of each matrix element (dst = e**src) - - The destination array; will have the same size and same type as src - - - - computes natural logarithm of absolute value of each matrix element: dst = log(abs(src)) - - The destination array; will have the same size and same type as src - - - - checks that each matrix element is within the specified range. - - The flag indicating whether the functions quietly - return false when the array elements are out of range, - or they throw an exception. - - - - - checks that each matrix element is within the specified range. - - The flag indicating whether the functions quietly - return false when the array elements are out of range, - or they throw an exception. - The optional output parameter, where the position of - the first outlier is stored. - The inclusive lower boundary of valid values range - The exclusive upper boundary of valid values range - - - - - converts NaN's to the given number - - - - - - multiplies matrix by its transposition from the left or from the right - - Specifies the multiplication ordering; see the description below - The optional delta matrix, subtracted from src before the - multiplication. When the matrix is empty ( delta=Mat() ), it’s assumed to be - zero, i.e. nothing is subtracted, otherwise if it has the same size as src, - then it’s simply subtracted, otherwise it is "repeated" to cover the full src - and then subtracted. Type of the delta matrix, when it's not empty, must be the - same as the type of created destination matrix, see the rtype description - The optional scale factor for the matrix product - When it’s negative, the destination matrix will have the - same type as src . Otherwise, it will have type=CV_MAT_DEPTH(rtype), - which should be either CV_32F or CV_64F - - - - transposes the matrix - - The destination array of the same type as src - - - - performs affine transformation of each element of multi-channel input matrix - - The transformation matrix - The destination array; will have the same size and depth as src and as many channels as mtx.rows - - - - performs perspective transformation of each element of multi-channel input matrix - - 3x3 or 4x4 transformation matrix - The destination array; it will have the same size and same type as src - - - - extends the symmetrical matrix from the lower half or from the upper half - - If true, the lower half is copied to the upper half, - otherwise the upper half is copied to the lower half - - - - initializes scaled identity matrix (not necessarily square). - - The value to assign to the diagonal elements - - - - computes determinant of a square matrix. - The input matrix must have CV_32FC1 or CV_64FC1 type and square size. - - determinant of the specified matrix. - - - - computes trace of a matrix - - - - - - sorts independently each matrix row or each matrix column - - The operation flags, a combination of the SortFlag values - The destination array of the same size and the same type as src - - - - sorts independently each matrix row or each matrix column - - The operation flags, a combination of SortFlag values - The destination integer array of the same size as src - - - - Performs a forward Discrete Fourier transform of 1D or 2D floating-point array. - - Transformation flags, a combination of the DftFlag2 values - When the parameter != 0, the function assumes that - only the first nonzeroRows rows of the input array ( DFT_INVERSE is not set) - or only the first nonzeroRows of the output array ( DFT_INVERSE is set) contain non-zeros, - thus the function can handle the rest of the rows more efficiently and - thus save some time. This technique is very useful for computing array cross-correlation - or convolution using DFT - The destination array, which size and type depends on the flags - - - - Performs an inverse Discrete Fourier transform of 1D or 2D floating-point array. - - Transformation flags, a combination of the DftFlag2 values - When the parameter != 0, the function assumes that - only the first nonzeroRows rows of the input array ( DFT_INVERSE is not set) - or only the first nonzeroRows of the output array ( DFT_INVERSE is set) contain non-zeros, - thus the function can handle the rest of the rows more efficiently and - thus save some time. This technique is very useful for computing array cross-correlation - or convolution using DFT - The destination array, which size and type depends on the flags - - - - performs forward or inverse 1D or 2D Discrete Cosine Transformation - - Transformation flags, a combination of DctFlag2 values - The destination array; will have the same size and same type as src - - - - performs inverse 1D or 2D Discrete Cosine Transformation - - Transformation flags, a combination of DctFlag2 values - The destination array; will have the same size and same type as src - - - - fills array with uniformly-distributed random numbers from the range [low, high) - - The inclusive lower boundary of the generated random numbers - The exclusive upper boundary of the generated random numbers - - - - fills array with uniformly-distributed random numbers from the range [low, high) - - The inclusive lower boundary of the generated random numbers - The exclusive upper boundary of the generated random numbers - - - - fills array with normally-distributed random numbers with the specified mean and the standard deviation - - The mean value (expectation) of the generated random numbers - The standard deviation of the generated random numbers - - - - fills array with normally-distributed random numbers with the specified mean and the standard deviation - - The mean value (expectation) of the generated random numbers - The standard deviation of the generated random numbers - - - - shuffles the input array elements - - The scale factor that determines the number of random swap operations. - The input/output numerical 1D array - - - - shuffles the input array elements - - The scale factor that determines the number of random swap operations. - The optional random number generator used for shuffling. - If it is null, theRng() is used instead. - The input/output numerical 1D array - - - - Draws a line segment connecting two points - - First point's x-coordinate of the line segment. - First point's y-coordinate of the line segment. - Second point's x-coordinate of the line segment. - Second point's y-coordinate of the line segment. - Line color. - Line thickness. [By default this is 1] - Type of the line. [By default this is LineType.Link8] - Number of fractional bits in the point coordinates. [By default this is 0] - - - - Draws a line segment connecting two points - - First point of the line segment. - Second point of the line segment. - Line color. - Line thickness. [By default this is 1] - Type of the line. [By default this is LineType.Link8] - Number of fractional bits in the point coordinates. [By default this is 0] - - - - Draws simple, thick or filled rectangle - - One of the rectangle vertices. - Opposite rectangle vertex. - Line color (RGB) or brightness (grayscale image). - Thickness of lines that make up the rectangle. Negative values make the function to draw a filled rectangle. [By default this is 1] - Type of the line, see cvLine description. [By default this is LineType.Link8] - Number of fractional bits in the point coordinates. [By default this is 0] - - - - Draws simple, thick or filled rectangle - - Rectangle. - Line color (RGB) or brightness (grayscale image). - Thickness of lines that make up the rectangle. Negative values make the function to draw a filled rectangle. [By default this is 1] - Type of the line, see cvLine description. [By default this is LineType.Link8] - Number of fractional bits in the point coordinates. [By default this is 0] - - - - Draws a circle - - X-coordinate of the center of the circle. - Y-coordinate of the center of the circle. - Radius of the circle. - Circle color. - Thickness of the circle outline if positive, otherwise indicates that a filled circle has to be drawn. [By default this is 1] - Type of the circle boundary. [By default this is LineType.Link8] - Number of fractional bits in the center coordinates and radius value. [By default this is 0] - - - - Draws a circle - - Center of the circle. - Radius of the circle. - Circle color. - Thickness of the circle outline if positive, otherwise indicates that a filled circle has to be drawn. [By default this is 1] - Type of the circle boundary. [By default this is LineType.Link8] - Number of fractional bits in the center coordinates and radius value. [By default this is 0] - - - - Draws simple or thick elliptic arc or fills ellipse sector - - Center of the ellipse. - Length of the ellipse axes. - Rotation angle. - Starting angle of the elliptic arc. - Ending angle of the elliptic arc. - Ellipse color. - Thickness of the ellipse arc. [By default this is 1] - Type of the ellipse boundary. [By default this is LineType.Link8] - Number of fractional bits in the center coordinates and axes' values. [By default this is 0] - - - - Draws simple or thick elliptic arc or fills ellipse sector - - The enclosing box of the ellipse drawn - Ellipse color. - Thickness of the ellipse boundary. [By default this is 1] - Type of the ellipse boundary. [By default this is LineType.Link8] - - - - Draws a marker on a predefined position in an image. - - The function cv::drawMarker draws a marker on a given position in the image.For the moment several - marker types are supported, see #MarkerTypes for more information. - - The point where the crosshair is positioned. - Line color. - The specific type of marker you want to use. - The length of the marker axis [default = 20 pixels] - Line thickness. - Type of the line. - - - - Fills a convex polygon. - - The polygon vertices - Polygon color - Type of the polygon boundaries - The number of fractional bits in the vertex coordinates - - - - Fills the area bounded by one or more polygons - - Array of polygons, each represented as an array of points - Polygon color - Type of the polygon boundaries - The number of fractional bits in the vertex coordinates - - - - - draws one or more polygonal curves - - - - - - - - - - - renders text string in the image - - - - - - - - - - - - - Encodes an image into a memory buffer. - - Encodes an image into a memory buffer. - Format-specific parameters. - - - - - Encodes an image into a memory buffer. - - Encodes an image into a memory buffer. - Format-specific parameters. - - - - - Saves an image to a specified file. - - - - - - - - Saves an image to a specified file. - - - - - - - - Saves an image to a specified file. - - - - - - - - Saves an image to a specified file. - - - - - - - - Forms a border around the image - - Specify how much pixels in each direction from the source image rectangle one needs to extrapolate - Specify how much pixels in each direction from the source image rectangle one needs to extrapolate - Specify how much pixels in each direction from the source image rectangle one needs to extrapolate - Specify how much pixels in each direction from the source image rectangle one needs to extrapolate - The border type - The border value if borderType == Constant - - - - Smoothes image using median filter. - The source image must have 1-, 3- or 4-channel and - its depth should be CV_8U , CV_16U or CV_32F. - - The aperture linear size. It must be odd and more than 1, i.e. 3, 5, 7 ... - The destination array; will have the same size and the same type as src. - - - - Blurs an image using a Gaussian filter. - The input image can have any number of channels, which are processed independently, - but the depth should be CV_8U, CV_16U, CV_16S, CV_32F or CV_64F. - - Gaussian kernel size. ksize.width and ksize.height can differ but they both must be positive and odd. - Or, they can be zero’s and then they are computed from sigma* . - Gaussian kernel standard deviation in X direction. - Gaussian kernel standard deviation in Y direction; if sigmaY is zero, it is set to be equal to sigmaX, - if both sigmas are zeros, they are computed from ksize.width and ksize.height, - respectively (see getGaussianKernel() for details); to fully control the result - regardless of possible future modifications of all this semantics, it is recommended to specify all of ksize, sigmaX, and sigmaY. - pixel extrapolation method - - - - Applies bilateral filter to the image - The source image must be a 8-bit or floating-point, 1-channel or 3-channel image. - - The diameter of each pixel neighborhood, that is used during filtering. - If it is non-positive, it's computed from sigmaSpace - Filter sigma in the color space. - Larger value of the parameter means that farther colors within the pixel neighborhood - will be mixed together, resulting in larger areas of semi-equal color - Filter sigma in the coordinate space. - Larger value of the parameter means that farther pixels will influence each other - (as long as their colors are close enough; see sigmaColor). Then d>0 , it specifies - the neighborhood size regardless of sigmaSpace, otherwise d is proportional to sigmaSpace - - The destination image; will have the same size and the same type as src - - - - Smoothes image using box filter - - - The smoothing kernel size - The anchor point. The default value Point(-1,-1) means that the anchor is at the kernel center - Indicates, whether the kernel is normalized by its area or not - The border mode used to extrapolate pixels outside of the image - The destination image; will have the same size and the same type as src - - - - Smoothes image using normalized box filter - - The smoothing kernel size - The anchor point. The default value Point(-1,-1) means that the anchor is at the kernel center - The border mode used to extrapolate pixels outside of the image - The destination image; will have the same size and the same type as src - - - - Convolves an image with the kernel - - The desired depth of the destination image. If it is negative, it will be the same as src.depth() - Convolution kernel (or rather a correlation kernel), - a single-channel floating point matrix. If you want to apply different kernels to - different channels, split the image into separate color planes using split() and process them individually - The anchor of the kernel that indicates the relative position of - a filtered point within the kernel. The anchor should lie within the kernel. - The special default value (-1,-1) means that the anchor is at the kernel center - The optional value added to the filtered pixels before storing them in dst - The pixel extrapolation method - The destination image. It will have the same size and the same number of channels as src - - - - Applies separable linear filter to an image - - The destination image depth - The coefficients for filtering each row - The coefficients for filtering each column - The anchor position within the kernel; The default value (-1, 1) means that the anchor is at the kernel center - The value added to the filtered results before storing them - The pixel extrapolation method - The destination image; will have the same size and the same number of channels as src - - - - Calculates the first, second, third or mixed image derivatives using an extended Sobel operator - - The destination image depth - Order of the derivative x - Order of the derivative y - Size of the extended Sobel kernel, must be 1, 3, 5 or 7 - The optional scale factor for the computed derivative values (by default, no scaling is applied - The optional delta value, added to the results prior to storing them in dst - The pixel extrapolation method - The destination image; will have the same size and the same number of channels as src - - - - Calculates the first x- or y- image derivative using Scharr operator - - The destination image depth - Order of the derivative x - Order of the derivative y - The optional scale factor for the computed derivative values (by default, no scaling is applie - The optional delta value, added to the results prior to storing them in dst - The pixel extrapolation method - The destination image; will have the same size and the same number of channels as src - - - - Calculates the Laplacian of an image - - The desired depth of the destination image - The aperture size used to compute the second-derivative filters - The optional scale factor for the computed Laplacian values (by default, no scaling is applied - The optional delta value, added to the results prior to storing them in dst - The pixel extrapolation method - Destination image; will have the same size and the same number of channels as src - - - - Finds edges in an image using Canny algorithm. - - The first threshold for the hysteresis procedure - The second threshold for the hysteresis procedure - Aperture size for the Sobel operator [By default this is ApertureSize.Size3] - Indicates, whether the more accurate L2 norm should be used to compute the image gradient magnitude (true), or a faster default L1 norm is enough (false). [By default this is false] - The output edge map. It will have the same size and the same type as image - - - - computes both eigenvalues and the eigenvectors of 2x2 derivative covariation matrix at each pixel. The output is stored as 6-channel matrix. - - - - - - - - computes another complex cornerness criteria at each pixel - - - - - - - adjusts the corner locations with sub-pixel accuracy to maximize the certain cornerness criteria - - Initial coordinates of the input corners and refined coordinates provided for output. - Half of the side length of the search window. - Half of the size of the dead region in the middle of the search zone - over which the summation in the formula below is not done. It is used sometimes to avoid possible singularities - of the autocorrelation matrix. The value of (-1,-1) indicates that there is no such a size. - Criteria for termination of the iterative process of corner refinement. - That is, the process of corner position refinement stops either after criteria.maxCount iterations - or when the corner position moves by less than criteria.epsilon on some iteration. - - - - - Finds the strong enough corners where the cornerMinEigenVal() or cornerHarris() report the local maxima. - Input matrix must be 8-bit or floating-point 32-bit, single-channel image. - - Maximum number of corners to return. If there are more corners than are found, - the strongest of them is returned. - Parameter characterizing the minimal accepted quality of image corners. - The parameter value is multiplied by the best corner quality measure, which is the minimal eigenvalue - or the Harris function response (see cornerHarris() ). The corners with the quality measure less than - the product are rejected. For example, if the best corner has the quality measure = 1500, and the qualityLevel=0.01, - then all the corners with the quality measure less than 15 are rejected. - Minimum possible Euclidean distance between the returned corners. - Optional region of interest. If the image is not empty - (it needs to have the type CV_8UC1 and the same size as image ), it specifies the region - in which the corners are detected. - Size of an average block for computing a derivative covariation matrix over each pixel neighborhood. - Parameter indicating whether to use a Harris detector - Free parameter of the Harris detector. - Output vector of detected corners. - - - - Finds lines in a binary image using standard Hough transform. - The input matrix must be 8-bit, single-channel, binary source image. - This image may be modified by the function. - - Distance resolution of the accumulator in pixels - Angle resolution of the accumulator in radians - The accumulator threshold parameter. Only those lines are returned that get enough votes ( > threshold ) - For the multi-scale Hough transform it is the divisor for the distance resolution rho. [By default this is 0] - For the multi-scale Hough transform it is the divisor for the distance resolution theta. [By default this is 0] - The output vector of lines. Each line is represented by a two-element vector (rho, theta) . - rho is the distance from the coordinate origin (0,0) (top-left corner of the image) and theta is the line rotation angle in radians - - - - Finds lines segments in a binary image using probabilistic Hough transform. - - Distance resolution of the accumulator in pixels - Angle resolution of the accumulator in radians - The accumulator threshold parameter. Only those lines are returned that get enough votes ( > threshold ) - The minimum line length. Line segments shorter than that will be rejected. [By default this is 0] - The maximum allowed gap between points on the same line to link them. [By default this is 0] - The output lines. Each line is represented by a 4-element vector (x1, y1, x2, y2) - - - - Finds circles in a grayscale image using a Hough transform. - The input matrix must be 8-bit, single-channel and grayscale. - - The available methods are HoughMethods.Gradient and HoughMethods.GradientAlt - The inverse ratio of the accumulator resolution to the image resolution. - Minimum distance between the centers of the detected circles. - The first method-specific parameter. [By default this is 100] - The second method-specific parameter. [By default this is 100] - Minimum circle radius. [By default this is 0] - Maximum circle radius. [By default this is 0] - The output vector found circles. Each vector is encoded as 3-element floating-point vector (x, y, radius) - - - - Dilates an image by using a specific structuring element. - - The structuring element used for dilation. If element=new Mat() , a 3x3 rectangular structuring element is used - Position of the anchor within the element. The default value (-1, -1) means that the anchor is at the element center - The number of times dilation is applied. [By default this is 1] - The pixel extrapolation method. [By default this is BorderTypes.Constant] - The border value in case of a constant border. The default value has a special meaning. [By default this is CvCpp.MorphologyDefaultBorderValue()] - The destination image. It will have the same size and the same type as src - - - - Erodes an image by using a specific structuring element. - - The structuring element used for dilation. If element=new Mat(), a 3x3 rectangular structuring element is used - Position of the anchor within the element. The default value (-1, -1) means that the anchor is at the element center - The number of times erosion is applied - The pixel extrapolation method - The border value in case of a constant border. The default value has a special meaning. [By default this is CvCpp.MorphologyDefaultBorderValue()] - The destination image. It will have the same size and the same type as src - - - - Performs advanced morphological transformations - - Type of morphological operation - Structuring element - Position of the anchor within the element. The default value (-1, -1) means that the anchor is at the element center - Number of times erosion and dilation are applied. [By default this is 1] - The pixel extrapolation method. [By default this is BorderTypes.Constant] - The border value in case of a constant border. The default value has a special meaning. [By default this is CvCpp.MorphologyDefaultBorderValue()] - Destination image. It will have the same size and the same type as src - - - - Resizes an image. - - output image size; if it equals zero, it is computed as: - dsize = Size(round(fx*src.cols), round(fy*src.rows)) - Either dsize or both fx and fy must be non-zero. - scale factor along the horizontal axis; when it equals 0, - it is computed as: (double)dsize.width/src.cols - scale factor along the vertical axis; when it equals 0, - it is computed as: (double)dsize.height/src.rows - interpolation method - output image; it has the size dsize (when it is non-zero) or the size computed - from src.size(), fx, and fy; the type of dst is the same as of src. - - - - Applies an affine transformation to an image. - - output image that has the size dsize and the same type as src. - 2x3 transformation matrix. - size of the output image. - combination of interpolation methods and the optional flag - WARP_INVERSE_MAP that means that M is the inverse transformation (dst -> src) . - pixel extrapolation method; when borderMode=BORDER_TRANSPARENT, - it means that the pixels in the destination image corresponding to the "outliers" - in the source image are not modified by the function. - value used in case of a constant border; by default, it is 0. - - - - Applies a perspective transformation to an image. - - 3x3 transformation matrix. - size of the output image. - combination of interpolation methods (INTER_LINEAR or INTER_NEAREST) - and the optional flag WARP_INVERSE_MAP, that sets M as the inverse transformation (dst -> src). - pixel extrapolation method (BORDER_CONSTANT or BORDER_REPLICATE). - value used in case of a constant border; by default, it equals 0. - output image that has the size dsize and the same type as src. - - - - Applies a generic geometrical transformation to an image. - - The first map of either (x,y) points or just x values having the type CV_16SC2, CV_32FC1, or CV_32FC2. - The second map of y values having the type CV_16UC1, CV_32FC1, or none (empty map if map1 is (x,y) points), respectively. - Interpolation method. The method INTER_AREA is not supported by this function. - Pixel extrapolation method. When borderMode=BORDER_TRANSPARENT, - it means that the pixels in the destination image that corresponds to the "outliers" in - the source image are not modified by the function. - Value used in case of a constant border. By default, it is 0. - Destination image. It has the same size as map1 and the same type as src - - - - Inverts an affine transformation. - - Output reverse affine transformation. - - - - Retrieves a pixel rectangle from an image with sub-pixel accuracy. - - Size of the extracted patch. - Floating point coordinates of the center of the extracted rectangle - within the source image. The center must be inside the image. - Depth of the extracted pixels. By default, they have the same depth as src. - Extracted patch that has the size patchSize and the same number of channels as src . - - - - Adds an image to the accumulator. - - Optional operation mask. - Accumulator image with the same number of channels as input image, 32-bit or 64-bit floating-point. - - - - Adds the square of a source image to the accumulator. - - Optional operation mask. - Accumulator image with the same number of channels as input image, 32-bit or 64-bit floating-point. - - - - Computes a Hanning window coefficients in two dimensions. - - The window size specifications - Created array type - - - - Applies a fixed-level threshold to each array element. - The input matrix must be single-channel, 8-bit or 32-bit floating point. - - threshold value. - maximum value to use with the THRESH_BINARY and THRESH_BINARY_INV thresholding types. - thresholding type (see the details below). - output array of the same size and type as src. - - - - Applies an adaptive threshold to an array. - Source matrix must be 8-bit single-channel image. - - Non-zero value assigned to the pixels for which the condition is satisfied. See the details below. - Adaptive thresholding algorithm to use, ADAPTIVE_THRESH_MEAN_C or ADAPTIVE_THRESH_GAUSSIAN_C . - Thresholding type that must be either THRESH_BINARY or THRESH_BINARY_INV . - Size of a pixel neighborhood that is used to calculate a threshold value for the pixel: 3, 5, 7, and so on. - Constant subtracted from the mean or weighted mean (see the details below). - Normally, it is positive but may be zero or negative as well. - Destination image of the same size and the same type as src. - - - - Blurs an image and downsamples it. - - size of the output image; by default, it is computed as Size((src.cols+1)/2 - - - - - - Upsamples an image and then blurs it. - - size of the output image; by default, it is computed as Size(src.cols*2, (src.rows*2) - - - - - - Upsamples an image and then blurs it. - - - - - - - - corrects lens distortion for the given camera matrix and distortion coefficients - - Input camera matrix - Input vector of distortion coefficients (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, - or 8 elements. If the vector is null, the zero distortion coefficients are assumed. - Camera matrix of the distorted image. - By default, it is the same as cameraMatrix but you may additionally scale - and shift the result by using a different matrix. - Output (corrected) image that has the same size and type as src . - - - - returns the default new camera matrix (by default it is the same as cameraMatrix unless centerPricipalPoint=true) - - Camera view image size in pixels. - Location of the principal point in the new camera matrix. - The parameter indicates whether this location should be at the image center or not. - the camera matrix that is either an exact copy of the input cameraMatrix - (when centerPrinicipalPoint=false), or the modified one (when centerPrincipalPoint=true). - - - - Computes the ideal point coordinates from the observed point coordinates. - Input matrix is an observed point coordinates, 1xN or Nx1 2-channel (CV_32FC2 or CV_64FC2). - - Camera matrix - Input vector of distortion coefficients (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6]]) of 4, 5, or 8 elements. - If the vector is null, the zero distortion coefficients are assumed. - Rectification transformation in the object space (3x3 matrix). - R1 or R2 computed by stereoRectify() can be passed here. - If the matrix is empty, the identity transformation is used. - New camera matrix (3x3) or new projection matrix (3x4). - P1 or P2 computed by stereoRectify() can be passed here. If the matrix is empty, - the identity new camera matrix is used. - Output ideal point coordinates after undistortion and reverse perspective transformation. - If matrix P is identity or omitted, dst will contain normalized point coordinates. - - - - Normalizes the grayscale image brightness and contrast by normalizing its histogram. - The source matrix is 8-bit single channel image. - - The destination image; will have the same size and the same type as src - - - - Performs a marker-based image segmentation using the watershed algorithm. - Input matrix is 8-bit 3-channel image. - - Input/output 32-bit single-channel image (map) of markers. - It should have the same size as image. - - - - Performs initial step of meanshift segmentation of an image. - The source matrix is 8-bit, 3-channel image. - - The spatial window radius. - The color window radius. - Maximum level of the pyramid for the segmentation. - Termination criteria: when to stop meanshift iterations. - The destination image of the same format and the same size as the source. - - - - Segments the image using GrabCut algorithm. - The input is 8-bit 3-channel image. - - Input/output 8-bit single-channel mask. - The mask is initialized by the function when mode is set to GC_INIT_WITH_RECT. - Its elements may have Cv2.GC_BGD / Cv2.GC_FGD / Cv2.GC_PR_BGD / Cv2.GC_PR_FGD - ROI containing a segmented object. The pixels outside of the ROI are - marked as "obvious background". The parameter is only used when mode==GC_INIT_WITH_RECT. - Temporary array for the background model. Do not modify it while you are processing the same image. - Temporary arrays for the foreground model. Do not modify it while you are processing the same image. - Number of iterations the algorithm should make before returning the result. - Note that the result can be refined with further calls with mode==GC_INIT_WITH_MASK or mode==GC_EVAL . - Operation mode that could be one of GrabCutFlag value. - - - - Fills a connected component with the given color. - Input/output 1- or 3-channel, 8-bit, or floating-point image. - It is modified by the function unless the FLOODFILL_MASK_ONLY flag is set in the - second variant of the function. See the details below. - - Starting point. - New value of the repainted domain pixels. - - - - - Fills a connected component with the given color. - Input/output 1- or 3-channel, 8-bit, or floating-point image. - It is modified by the function unless the FLOODFILL_MASK_ONLY flag is set in the - second variant of the function. See the details below. - - Starting point. - New value of the repainted domain pixels. - Optional output parameter set by the function to the - minimum bounding rectangle of the repainted domain. - Maximal lower brightness/color difference between the currently - observed pixel and one of its neighbors belonging to the component, or a seed pixel - being added to the component. - Maximal upper brightness/color difference between the currently - observed pixel and one of its neighbors belonging to the component, or a seed pixel - being added to the component. - Operation flags. Lower bits contain a connectivity value, - 4 (default) or 8, used within the function. Connectivity determines which - neighbors of a pixel are considered. - - - - - Fills a connected component with the given color. - Input/output 1- or 3-channel, 8-bit, or floating-point image. - It is modified by the function unless the FLOODFILL_MASK_ONLY flag is set in the - second variant of the function. See the details below. - - (For the second function only) Operation mask that should be a single-channel 8-bit image, - 2 pixels wider and 2 pixels taller. The function uses and updates the mask, so you take responsibility of - initializing the mask content. Flood-filling cannot go across non-zero pixels in the mask. For example, - an edge detector output can be used as a mask to stop filling at edges. It is possible to use the same mask - in multiple calls to the function to make sure the filled area does not overlap. - Starting point. - New value of the repainted domain pixels. - - - - - Fills a connected component with the given color. - Input/output 1- or 3-channel, 8-bit, or floating-point image. - It is modified by the function unless the FLOODFILL_MASK_ONLY flag is set in the - second variant of the function. See the details below. - - (For the second function only) Operation mask that should be a single-channel 8-bit image, - 2 pixels wider and 2 pixels taller. The function uses and updates the mask, so you take responsibility of - initializing the mask content. Flood-filling cannot go across non-zero pixels in the mask. For example, - an edge detector output can be used as a mask to stop filling at edges. It is possible to use the same mask - in multiple calls to the function to make sure the filled area does not overlap. - Starting point. - New value of the repainted domain pixels. - Optional output parameter set by the function to the - minimum bounding rectangle of the repainted domain. - Maximal lower brightness/color difference between the currently - observed pixel and one of its neighbors belonging to the component, or a seed pixel - being added to the component. - Maximal upper brightness/color difference between the currently - observed pixel and one of its neighbors belonging to the component, or a seed pixel - being added to the component. - Operation flags. Lower bits contain a connectivity value, - 4 (default) or 8, used within the function. Connectivity determines which - neighbors of a pixel are considered. - - - - - Converts image from one color space to another - - The color space conversion code - The number of channels in the destination image; if the parameter is 0, the number of the channels will be derived automatically from src and the code - The destination image; will have the same size and the same depth as src - - - - Calculates all of the moments - up to the third order of a polygon or rasterized shape. - The input is a raster image (single-channel, 8-bit or floating-point 2D array). - - If it is true, then all the non-zero image pixels are treated as 1’s - - - - - Computes the proximity map for the raster template and the image where the template is searched for - The input is Image where the search is running; should be 8-bit or 32-bit floating-point. - - Searched template; must be not greater than the source image and have the same data type - Specifies the comparison method - Mask of searched template. It must have the same datatype and size with templ. It is not set by default. - A map of comparison results; will be single-channel 32-bit floating-point. - If image is WxH and templ is wxh then result will be (W-w+1) x (H-h+1). - - - - computes the connected components labeled image of boolean image. - image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0 - represents the background label. ltype specifies the output label image type, an important - consideration based on the total number of labels or alternatively the total number of - pixels in the source image. - - destination labeled image - 8 or 4 for 8-way or 4-way connectivity respectively - The number of labels - - - - computes the connected components labeled image of boolean image. - image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0 - represents the background label. ltype specifies the output label image type, an important - consideration based on the total number of labels or alternatively the total number of - pixels in the source image. - - destination labeled image - 8 or 4 for 8-way or 4-way connectivity respectively - output image label type. Currently CV_32S and CV_16U are supported. - The number of labels - - - - computes the connected components labeled image of boolean image. - image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0 - represents the background label. ltype specifies the output label image type, an important - consideration based on the total number of labels or alternatively the total number of - pixels in the source image. - - destination labeled rectangular array - 8 or 4 for 8-way or 4-way connectivity respectively - The number of labels - - - - computes the connected components labeled image of boolean image. - image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0 - represents the background label. ltype specifies the output label image type, an important - consideration based on the total number of labels or alternatively the total number of - pixels in the source image. - - destination labeled image - statistics output for each label, including the background label, - see below for available statistics. Statistics are accessed via stats(label, COLUMN) - where COLUMN is one of cv::ConnectedComponentsTypes - floating point centroid (x,y) output for each label, - including the background label - 8 or 4 for 8-way or 4-way connectivity respectively - - - - - computes the connected components labeled image of boolean image. - image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0 - represents the background label. ltype specifies the output label image type, an important - consideration based on the total number of labels or alternatively the total number of - pixels in the source image. - - destination labeled image - statistics output for each label, including the background label, - see below for available statistics. Statistics are accessed via stats(label, COLUMN) - where COLUMN is one of cv::ConnectedComponentsTypes - floating point centroid (x,y) output for each label, - including the background label - 8 or 4 for 8-way or 4-way connectivity respectively - output image label type. Currently CV_32S and CV_16U are supported. - - - - - computes the connected components labeled image of boolean image. - image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0 - represents the background label. ltype specifies the output label image type, an important - consideration based on the total number of labels or alternatively the total number of - pixels in the source image. - - 8 or 4 for 8-way or 4-way connectivity respectively - - - - - Finds contours in a binary image. - The source is an 8-bit single-channel image. Non-zero pixels are treated as 1’s. - Zero pixels remain 0’s, so the image is treated as binary. The function modifies this image while extracting the contours. - - Detected contours. Each contour is stored as a vector of points. - Optional output vector, containing information about the image topology. - It has as many elements as the number of contours. For each i-th contour contours[i], - the members of the elements hierarchy[i] are set to 0-based indices in contours of the next - and previous contours at the same hierarchical level, the first child contour and the parent contour, respectively. - If for the contour i there are no next, previous, parent, or nested contours, the corresponding elements of hierarchy[i] will be negative. - Contour retrieval mode - Contour approximation method - Optional offset by which every contour point is shifted. - This is useful if the contours are extracted from the image ROI and then they should be analyzed in the whole image context. - - - - Finds contours in a binary image. - The source is an 8-bit single-channel image. Non-zero pixels are treated as 1’s. - Zero pixels remain 0’s, so the image is treated as binary. The function modifies this image while extracting the contours. - - Detected contours. Each contour is stored as a vector of points. - Optional output vector, containing information about the image topology. - It has as many elements as the number of contours. For each i-th contour contours[i], - the members of the elements hierarchy[i] are set to 0-based indices in contours of the next - and previous contours at the same hierarchical level, the first child contour and the parent contour, respectively. - If for the contour i there are no next, previous, parent, or nested contours, the corresponding elements of hierarchy[i] will be negative. - Contour retrieval mode - Contour approximation method - Optional offset by which every contour point is shifted. - This is useful if the contours are extracted from the image ROI and then they should be analyzed in the whole image context. - - - - Finds contours in a binary image. - The source is an 8-bit single-channel image. Non-zero pixels are treated as 1’s. - Zero pixels remain 0’s, so the image is treated as binary. The function modifies this image while extracting the contours. - - Contour retrieval mode - Contour approximation method - Optional offset by which every contour point is shifted. - This is useful if the contours are extracted from the image ROI and then they should be analyzed in the whole image context. - Detected contours. Each contour is stored as a vector of points. - - - - Finds contours in a binary image. - The source is an 8-bit single-channel image. Non-zero pixels are treated as 1’s. - Zero pixels remain 0’s, so the image is treated as binary. The function modifies this image while extracting the contours. - - Contour retrieval mode - Contour approximation method - Optional offset by which every contour point is shifted. - This is useful if the contours are extracted from the image ROI and then they should be analyzed in the whole image context. - Detected contours. Each contour is stored as a vector of points. - - - - Draws contours in the image - - All the input contours. Each contour is stored as a point vector. - Parameter indicating a contour to draw. If it is negative, all the contours are drawn. - Color of the contours. - Thickness of lines the contours are drawn with. If it is negative (for example, thickness=CV_FILLED ), - the contour interiors are drawn. - Line connectivity. - Optional information about hierarchy. It is only needed if you want to draw only some of the contours - Maximal level for drawn contours. If it is 0, only the specified contour is drawn. - If it is 1, the function draws the contour(s) and all the nested contours. If it is 2, the function draws the contours, - all the nested contours, all the nested-to-nested contours, and so on. This parameter is only taken into account - when there is hierarchy available. - Optional contour shift parameter. Shift all the drawn contours by the specified offset = (dx, dy) - - - - Draws contours in the image - - All the input contours. Each contour is stored as a point vector. - Parameter indicating a contour to draw. If it is negative, all the contours are drawn. - Color of the contours. - Thickness of lines the contours are drawn with. If it is negative (for example, thickness=CV_FILLED ), - the contour interiors are drawn. - Line connectivity. - Optional information about hierarchy. It is only needed if you want to draw only some of the contours - Maximal level for drawn contours. If it is 0, only the specified contour is drawn. - If it is 1, the function draws the contour(s) and all the nested contours. If it is 2, the function draws the contours, - all the nested contours, all the nested-to-nested contours, and so on. This parameter is only taken into account - when there is hierarchy available. - Optional contour shift parameter. Shift all the drawn contours by the specified offset = (dx, dy) - - - - Approximates contour or a curve using Douglas-Peucker algorithm. - The input is the polygon or curve to approximate and - it must be 1 x N or N x 1 matrix of type CV_32SC2 or CV_32FC2. - - Specifies the approximation accuracy. - This is the maximum distance between the original curve and its approximation. - The result of the approximation; - The type should match the type of the input curve - The result of the approximation; - The type should match the type of the input curve - - - - Calculates a contour perimeter or a curve length. - The input is 2D point set, represented by CV_32SC2 or CV_32FC2 matrix. - - Indicates, whether the curve is closed or not - - - - - Calculates the up-right bounding rectangle of a point set. - The input is 2D point set, represented by CV_32SC2 or CV_32FC2 matrix. - - Minimal up-right bounding rectangle for the specified point set. - - - - Calculates the contour area. - The input is 2D point set, represented by CV_32SC2 or CV_32FC2 matrix. - - - - - - - Finds the minimum area rotated rectangle enclosing a 2D point set. - The input is 2D point set, represented by CV_32SC2 or CV_32FC2 matrix. - - - - - - Finds the minimum area circle enclosing a 2D point set. - The input is 2D point set, represented by CV_32SC2 or CV_32FC2 matrix. - - The output center of the circle - The output radius of the circle - - - - Computes convex hull for a set of 2D points. - - If true, the output convex hull will be oriented clockwise, - otherwise it will be oriented counter-clockwise. Here, the usual screen coordinate - system is assumed - the origin is at the top-left corner, x axis is oriented to the right, - and y axis is oriented downwards. - - The output convex hull. It is either a vector of points that form the - hull (must have the same type as the input points), or a vector of 0-based point - indices of the hull points in the original array (since the set of convex hull - points is a subset of the original point set). - - - - Computes convex hull for a set of 2D points. - - If true, the output convex hull will be oriented clockwise, - otherwise it will be oriented counter-clockwise. Here, the usual screen coordinate - system is assumed - the origin is at the top-left corner, x axis is oriented to the right, - and y axis is oriented downwards. - The output convex hull. It is a vector of points that form the - hull (must have the same type as the input points). - - - - Computes convex hull for a set of 2D points. - - If true, the output convex hull will be oriented clockwise, - otherwise it will be oriented counter-clockwise. Here, the usual screen coordinate - system is assumed - the origin is at the top-left corner, x axis is oriented to the right, - and y axis is oriented downwards. - The output convex hull. It is a vector of points that form the - hull (must have the same type as the input points). - - - - Computes convex hull for a set of 2D points. - - If true, the output convex hull will be oriented clockwise, - otherwise it will be oriented counter-clockwise. Here, the usual screen coordinate - system is assumed - the origin is at the top-left corner, x axis is oriented to the right, - and y axis is oriented downwards. - The output convex hull. It is a vector of 0-based point - indices of the hull points in the original array (since the set of convex hull - points is a subset of the original point set). - - - - Computes the contour convexity defects - - Convex hull obtained using convexHull() that - should contain indices of the contour points that make the hull. - The output vector of convexity defects. - Each convexity defect is represented as 4-element integer vector - (a.k.a. cv::Vec4i): (start_index, end_index, farthest_pt_index, fixpt_depth), - where indices are 0-based indices in the original contour of the convexity defect beginning, - end and the farthest point, and fixpt_depth is fixed-point approximation - (with 8 fractional bits) of the distance between the farthest contour point and the hull. - That is, to get the floating-point value of the depth will be fixpt_depth/256.0. - - - - Computes the contour convexity defects - - Convex hull obtained using convexHull() that - should contain indices of the contour points that make the hull. - The output vector of convexity defects. - Each convexity defect is represented as 4-element integer vector - (a.k.a. cv::Vec4i): (start_index, end_index, farthest_pt_index, fixpt_depth), - where indices are 0-based indices in the original contour of the convexity defect beginning, - end and the farthest point, and fixpt_depth is fixed-point approximation - (with 8 fractional bits) of the distance between the farthest contour point and the hull. - That is, to get the floating-point value of the depth will be fixpt_depth/256.0. - - - - Returns true if the contour is convex. - Does not support contours with self-intersection - - - - - - Fits ellipse to the set of 2D points. - - - - - - Fits line to the set of 2D points using M-estimator algorithm. - The input is vector of 2D points. - - Distance used by the M-estimator - Numerical parameter ( C ) for some types of distances. - If it is 0, an optimal value is chosen. - Sufficient accuracy for the radius - (distance between the coordinate origin and the line). - Sufficient accuracy for the angle. - 0.01 would be a good default value for reps and aeps. - Output line parameters. - - - - Fits line to the set of 3D points using M-estimator algorithm. - The input is vector of 3D points. - - Distance used by the M-estimator - Numerical parameter ( C ) for some types of distances. - If it is 0, an optimal value is chosen. - Sufficient accuracy for the radius - (distance between the coordinate origin and the line). - Sufficient accuracy for the angle. - 0.01 would be a good default value for reps and aeps. - Output line parameters. - - - - Checks if the point is inside the contour. - Optionally computes the signed distance from the point to the contour boundary. - - Point tested against the contour. - If true, the function estimates the signed distance - from the point to the nearest contour edge. Otherwise, the function only checks - if the point is inside a contour or not. - Positive (inside), negative (outside), or zero (on an edge) value. - - - - Computes the distance transform map - - - - - - - Abstract definition of Mat indexer - - - - - - 1-dimensional indexer - - Index along the dimension 0 - A value to the specified array element. - - - - 2-dimensional indexer - - Index along the dimension 0 - Index along the dimension 1 - A value to the specified array element. - - - - 3-dimensional indexer - - Index along the dimension 0 - Index along the dimension 1 - Index along the dimension 2 - A value to the specified array element. - - - - n-dimensional indexer - - Array of Mat::dims indices. - A value to the specified array element. - - - - Parent matrix object - - - - - Step byte length for each dimension - - - - - Constructor - - - - - - Type-specific abstract matrix - - Element Type - - - - Creates empty Mat - - - - - Creates from native cv::Mat* pointer - - - - - - Creates from native cv::Mat* pointer - - - - - - Initializes by Mat object - - Managed Mat object - - - - constructs 2D matrix of the specified size and type - - Number of rows in a 2D array. - Number of columns in a 2D array. - - - - constructs 2D matrix of the specified size and type - - 2D array size: Size(cols, rows) . In the Size() constructor, - the number of rows and the number of columns go in the reverse order. - - - - constructs 2D matrix and fills it with the specified Scalar value. - - Number of rows in a 2D array. - Number of columns in a 2D array. - An optional value to initialize each matrix element with. - To set all the matrix elements to the particular value after the construction, use SetTo(Scalar s) method . - - - - constructs 2D matrix and fills it with the specified Scalar value. - - 2D array size: Size(cols, rows) . In the Size() constructor, - the number of rows and the number of columns go in the reverse order. - An optional value to initialize each matrix element with. - To set all the matrix elements to the particular value after the construction, use SetTo(Scalar s) method . - - - - creates a matrix header for a part of the bigger matrix - - Array that (as a whole or partly) is assigned to the constructed matrix. - No data is copied by these constructors. Instead, the header pointing to m data or its sub-array - is constructed and associated with it. The reference counter, if any, is incremented. - So, when you modify the matrix formed using such a constructor, you also modify the corresponding elements of m . - If you want to have an independent copy of the sub-array, use Mat::clone() . - Range of the m rows to take. As usual, the range start is inclusive and the range end is exclusive. - Use Range.All to take all the rows. - Range of the m columns to take. Use Range.All to take all the columns. - - - - creates a matrix header for a part of the bigger matrix - - Array that (as a whole or partly) is assigned to the constructed matrix. - No data is copied by these constructors. Instead, the header pointing to m data or its sub-array - is constructed and associated with it. The reference counter, if any, is incremented. - So, when you modify the matrix formed using such a constructor, you also modify the corresponding elements of m . - If you want to have an independent copy of the sub-array, use Mat.Clone() . - Array of selected ranges of m along each dimensionality. - - - - creates a matrix header for a part of the bigger matrix - - Array that (as a whole or partly) is assigned to the constructed matrix. - No data is copied by these constructors. Instead, the header pointing to m data or its sub-array - is constructed and associated with it. The reference counter, if any, is incremented. - So, when you modify the matrix formed using such a constructor, you also modify the corresponding elements of m . - If you want to have an independent copy of the sub-array, use Mat.Clone() . - Region of interest. - - - - constructor for matrix headers pointing to user-allocated data - - Number of rows in a 2D array. - Number of columns in a 2D array. - Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. - Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. - This operation is very efficient and can be used to process external data using OpenCV functions. - The external data is not automatically de-allocated, so you should take care of it. - Number of bytes each matrix row occupies. The value should include the padding bytes at the end of each row, if any. - If the parameter is missing (set to AUTO_STEP ), no padding is assumed and the actual step is calculated as cols*elemSize() . - - - - constructor for matrix headers pointing to user-allocated data - - Number of rows in a 2D array. - Number of columns in a 2D array. - Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. - Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. - This operation is very efficient and can be used to process external data using OpenCV functions. - The external data is not automatically de-allocated, so you should take care of it. - Number of bytes each matrix row occupies. The value should include the padding bytes at the end of each row, if any. - If the parameter is missing (set to AUTO_STEP ), no padding is assumed and the actual step is calculated as cols*elemSize() . - - - - constructor for matrix headers pointing to user-allocated data - - Number of rows in a 2D array. - Number of columns in a 2D array. - Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. - Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. - This operation is very efficient and can be used to process external data using OpenCV functions. - The external data is not automatically de-allocated, so you should take care of it. - Number of bytes each matrix row occupies. The value should include the padding bytes at the end of each row, if any. - If the parameter is missing (set to AUTO_STEP ), no padding is assumed and the actual step is calculated as cols*elemSize() . - - - - constructor for matrix headers pointing to user-allocated data - - Array of integers specifying an n-dimensional array shape. - Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. - Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. - This operation is very efficient and can be used to process external data using OpenCV functions. - The external data is not automatically de-allocated, so you should take care of it. - Array of ndims-1 steps in case of a multi-dimensional array (the last step is always set to the element size). - If not specified, the matrix is assumed to be continuous. - - - - constructor for matrix headers pointing to user-allocated data - - Array of integers specifying an n-dimensional array shape. - Pointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. - Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. - This operation is very efficient and can be used to process external data using OpenCV functions. - The external data is not automatically de-allocated, so you should take care of it. - Array of ndims-1 steps in case of a multi-dimensional array (the last step is always set to the element size). - If not specified, the matrix is assumed to be continuous. - - - - constructs n-dimensional matrix - - Array of integers specifying an n-dimensional array shape. - - - - constructs n-dimensional matrix - - Array of integers specifying an n-dimensional array shape. - An optional value to initialize each matrix element with. - To set all the matrix elements to the particular value after the construction, use SetTo(Scalar s) method . - - - - Matrix indexer - - - - - 1-dimensional indexer - - Index along the dimension 0 - A value to the specified array element. - - - - 2-dimensional indexer - - Index along the dimension 0 - Index along the dimension 1 - A value to the specified array element. - - - - 3-dimensional indexer - - Index along the dimension 0 - Index along the dimension 1 - Index along the dimension 2 - A value to the specified array element. - - - - n-dimensional indexer - - Array of Mat::dims indices. - A value to the specified array element. - - - - Gets a type-specific indexer. The indexer has getters/setters to access each matrix element. - - - - - - Gets read-only enumerator - - - - - - Convert this mat to managed array - - - - - - Convert this mat to managed rectangular array - - - - - - - - - - - - - Creates a full copy of the matrix. - - - - - - Changes the shape of channels of a 2D matrix without copying the data. - - New number of rows. If the parameter is 0, the number of rows remains the same. - - - - - Changes the shape of a 2D matrix without copying the data. - - New number of rows. If the parameter is 0, the number of rows remains the same. - - - - - Transposes a matrix. - - - - - - Extracts a rectangular submatrix. - - Start row of the extracted submatrix. The upper boundary is not included. - End row of the extracted submatrix. The upper boundary is not included. - Start column of the extracted submatrix. The upper boundary is not included. - End column of the extracted submatrix. The upper boundary is not included. - - - - - Extracts a rectangular submatrix. - - Start and end row of the extracted submatrix. The upper boundary is not included. - To select all the rows, use Range.All(). - Start and end column of the extracted submatrix. - The upper boundary is not included. To select all the columns, use Range.All(). - - - - - Extracts a rectangular submatrix. - - Extracted submatrix specified as a rectangle. - - - - - Extracts a rectangular submatrix. - - Array of selected ranges along each array dimension. - - - - - Extracts a rectangular submatrix. - - Start row of the extracted submatrix. The upper boundary is not included. - End row of the extracted submatrix. The upper boundary is not included. - Start column of the extracted submatrix. The upper boundary is not included. - End column of the extracted submatrix. The upper boundary is not included. - - - - - Extracts a rectangular submatrix. - - Start and end row of the extracted submatrix. The upper boundary is not included. - To select all the rows, use Range.All(). - Start and end column of the extracted submatrix. - The upper boundary is not included. To select all the columns, use Range.All(). - - - - - Extracts a rectangular submatrix. - - Extracted submatrix specified as a rectangle. - - - - - Extracts a rectangular submatrix. - - Array of selected ranges along each array dimension. - - - - - OpenCV C++ n-dimensional dense array class (cv::Mat) - - - - - typeof(T) -> MatType - - - - - Creates from native cv::Mat* pointer - - - - - - Creates from native cv::UMat* pointer - - - - - - Creates empty Mat - - - - - - - - - - - constructs 2D matrix of the specified size and type - - Number of rows in a 2D array. - Number of columns in a 2D array. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - usage flags for allocator - - - - constructs 2D matrix of the specified size and type - - 2D array size: Size(cols, rows) . In the Size() constructor, - the number of rows and the number of columns go in the reverse order. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType.CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - usage flags for allocator - - - - constructs 2D matrix and fills it with the specified Scalar value. - - Number of rows in a 2D array. - Number of columns in a 2D array. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - An optional value to initialize each matrix element with. - To set all the matrix elements to the particular value after the construction, use SetTo(Scalar s) method . - usage flags for allocator - - - - constructs 2D matrix and fills it with the specified Scalar value. - - 2D array size: Size(cols, rows) . In the Size() constructor, - the number of rows and the number of columns go in the reverse order. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or CV_8UC(n), ..., CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices. - An optional value to initialize each matrix element with. - To set all the matrix elements to the particular value after the construction, use SetTo(Scalar s) method . - usage flags for allocator - - - - creates a matrix header for a part of the bigger matrix - - Array that (as a whole or partly) is assigned to the constructed matrix. - No data is copied by these constructors. Instead, the header pointing to m data or its sub-array - is constructed and associated with it. The reference counter, if any, is incremented. - So, when you modify the matrix formed using such a constructor, you also modify the corresponding elements of m . - If you want to have an independent copy of the sub-array, use Mat::clone() . - Range of the m rows to take. As usual, the range start is inclusive and the range end is exclusive. - Use Range.All to take all the rows. - Range of the m columns to take. Use Range.All to take all the columns. - usage flags for allocator - - - - creates a matrix header for a part of the bigger matrix - - Array that (as a whole or partly) is assigned to the constructed matrix. - No data is copied by these constructors. Instead, the header pointing to m data or its sub-array - is constructed and associated with it. The reference counter, if any, is incremented. - So, when you modify the matrix formed using such a constructor, you also modify the corresponding elements of m . - If you want to have an independent copy of the sub-array, use Mat.Clone() . - Array of selected ranges of m along each dimensionality. - - - - creates a matrix header for a part of the bigger matrix - - Array that (as a whole or partly) is assigned to the constructed matrix. - No data is copied by these constructors. Instead, the header pointing to m data or its sub-array - is constructed and associated with it. The reference counter, if any, is incremented. - So, when you modify the matrix formed using such a constructor, you also modify the corresponding elements of m . - If you want to have an independent copy of the sub-array, use Mat.Clone() . - Region of interest. - - - - constructs n-dimensional matrix - - Array of integers specifying an n-dimensional array shape. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - - - - constructs n-dimensional matrix - - Array of integers specifying an n-dimensional array shape. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - An optional value to initialize each matrix element with. - To set all the matrix elements to the particular value after the construction, use SetTo(Scalar s) method . - - - - Releases the resources - - - - - - Releases unmanaged resources - - - - - Extracts a diagonal from a matrix, or creates a diagonal matrix. - - One-dimensional matrix that represents the main diagonal. - - - - - Returns a zero array of the specified size and type. - - Number of rows. - Number of columns. - Created matrix type. - - - - - Returns a zero array of the specified size and type. - - Alternative to the matrix size specification Size(cols, rows) . - Created matrix type. - - - - - Returns a zero array of the specified size and type. - - Created matrix type. - - - - - - Returns an array of all 1’s of the specified size and type. - - Number of rows. - Number of columns. - Created matrix type. - - - - - Returns an array of all 1’s of the specified size and type. - - Alternative to the matrix size specification Size(cols, rows) . - Created matrix type. - - - - - Returns an array of all 1’s of the specified size and type. - - Created matrix type. - Array of integers specifying the array shape. - - - - - Returns an identity matrix of the specified size and type. - - Alternative to the matrix size specification Size(cols, rows) . - Created matrix type. - - - - - Returns an identity matrix of the specified size and type. - - Number of rows. - Number of columns. - Created matrix type. - - - - - Extracts a rectangular submatrix. - - Start row of the extracted submatrix. The upper boundary is not included. - End row of the extracted submatrix. The upper boundary is not included. - Start column of the extracted submatrix. The upper boundary is not included. - End column of the extracted submatrix. The upper boundary is not included. - - - - - Extracts a rectangular submatrix. - - Start and end row of the extracted submatrix. The upper boundary is not included. - To select all the rows, use Range.All(). - Start and end column of the extracted submatrix. - The upper boundary is not included. To select all the columns, use Range.All(). - - - - - Extracts a rectangular submatrix. - - Extracted submatrix specified as a rectangle. - - - - - Extracts a rectangular submatrix. - - Array of selected ranges along each array dimension. - - - - - Returns the UMat data as a Mat. - - AccessFlag determining the mode in which the data is to be acquired - - - - - Creates a matrix header for the specified matrix column. - - A 0-based column index. - - - - - Creates a matrix header for the specified column span. - - An inclusive 0-based start index of the column span. - An exclusive 0-based ending index of the column span. - - - - - Creates a matrix header for the specified column span. - - - - - - - Creates a matrix header for the specified matrix row. - - A 0-based row index. - - - - - Creates a matrix header for the specified row span. - - - - - - - - Creates a matrix header for the specified row span. - - - - - - - Single-column matrix that forms a diagonal matrix or index of the diagonal, with the following values: - - Single-column matrix that forms a diagonal matrix or index of the diagonal, with the following values: - - - - - Creates a full copy of the matrix. - - - - - - Returns the partial Mat of the specified Mat - - - - - - - Copies the matrix to another one. - - Destination matrix. If it does not have a proper size or type before the operation, it is reallocated. - Operation mask. Its non-zero elements indicate which matrix elements need to be copied. - - - - Copies the matrix to another one. - - Destination matrix. If it does not have a proper size or type before the operation, it is reallocated. - Operation mask. Its non-zero elements indicate which matrix elements need to be copied. - - - - Converts an array to another data type with optional scaling. - - output matrix; if it does not have a proper size or type before the operation, it is reallocated. - desired output matrix type or, rather, the depth since the number of channels are the same as the input has; - if rtype is negative, the output matrix will have the same type as the input. - optional scale factor. - optional delta added to the scaled values. - - - - Provides a functional form of convertTo. - - Destination array. - Desired destination array depth (or -1 if it should be the same as the source type). - - - - Sets all or some of the array elements to the specified value. - - - - - - - - Sets all or some of the array elements to the specified value. - - - - - - - - Changes the shape and/or the number of channels of a 2D matrix without copying the data. - - New number of channels. If the parameter is 0, the number of channels remains the same. - New number of rows. If the parameter is 0, the number of rows remains the same. - - - - - Changes the shape and/or the number of channels of a 2D matrix without copying the data. - - New number of channels. If the parameter is 0, the number of channels remains the same. - New number of rows. If the parameter is 0, the number of rows remains the same. - - - - - Transposes a matrix. - - - - - - Inverses a matrix. - - Matrix inversion method - - - - - Performs an element-wise multiplication or division of the two matrices. - - - - - - - - Computes a dot-product of two vectors. - - another dot-product operand. - - - - - Allocates new array data if needed. - - New number of rows. - New number of columns. - New matrix type. - - - - Allocates new array data if needed. - - Alternative new matrix size specification: Size(cols, rows) - New matrix type. - - - - Allocates new array data if needed. - - Array of integers specifying a new array shape. - New matrix type. - - - - Locates the matrix header within a parent matrix. - - Output parameter that contains the size of the whole matrix containing *this as a part. - Output parameter that contains an offset of *this inside the whole matrix. - - - - Adjusts a submatrix size and position within the parent matrix. - - Shift of the top submatrix boundary upwards. - Shift of the bottom submatrix boundary downwards. - Shift of the left submatrix boundary to the left. - Shift of the right submatrix boundary to the right. - - - - - Extracts a rectangular submatrix. - - - - - - - - - - Extracts a rectangular submatrix. - - Start and end row of the extracted submatrix. The upper boundary is not included. - To select all the rows, use Range::all(). - Start and end column of the extracted submatrix. The upper boundary is not included. - To select all the columns, use Range::all(). - - - - - Extracts a rectangular submatrix. - - Extracted submatrix specified as a rectangle. - - - - - Extracts a rectangular submatrix. - - Array of selected ranges along each array dimension. - - - - - Reports whether the matrix is continuous or not. - - - - - - Returns whether this matrix is a part of other matrix or not. - - - - - - Returns the matrix element size in bytes. - - - - - - Returns the size of each matrix element channel in bytes. - - - - - - Returns the type of a matrix element. - - - - - - Returns the depth of a matrix element. - - - - - - Returns the number of matrix channels. - - - - - - Returns a normalized step. - - - - - - - Returns true if the array has no elements. - - - - - - Returns the total number of array elements. - - - - - - - - Number of channels or number of columns the matrix should have. - For a 2-D matrix, when the matrix has only 1 column, then it should have - elemChannels channels; When the matrix has only 1 channel, - then it should have elemChannels columns. For a 3-D matrix, it should have only one channel. - Furthermore, if the number of planes is not one, then the number of rows within every - plane has to be 1; if the number of rows within every plane is not 1, - then the number of planes has to be 1. - The depth the matrix should have. Set it to -1 when any depth is fine. - Set it to true to require the matrix to be continuous - -1 if the requirement is not satisfied. - Otherwise, it returns the number of elements in the matrix. Note that an element may have multiple channels. - - - - includes several bit-fields: - - the magic signature - - continuity flag - - depth - - number of channels - - - - - the array dimensionality, >= 2 - - - - - the number of rows or -1 when the array has more than 2 dimensions - - - - - the number of rows or -1 when the array has more than 2 dimensions - - - - - - the number of columns or -1 when the array has more than 2 dimensions - - - - - - the number of columns or -1 when the array has more than 2 dimensions - - - - - - Returns a matrix size. - - - - - - Returns a matrix size. - - - - - - - Returns number of bytes each matrix row occupies. - - - - - - Returns number of bytes each matrix row occupies. - - - - - - - Returns a string that represents this Mat. - - - - - - Makes a Mat that have the same size, depth and channels as this image - - - - - - - - - usage flags for allocator - - - - - Proxy datatype for passing Mat's and List<>'s as output parameters - - - - - Constructor - - - - - - Constructor - - - - - - Constructor - - - - - - Releases unmanaged resources - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates a proxy class of the specified matrix - - - - - - - Creates a proxy class of the specified matrix - - - - - - - Creates a proxy class of the specified list - - - - - - - - Creates a proxy class of the specified list - - - - - - - Proxy datatype for passing Mat's and List<>'s as output parameters - - - - - - - - - - - - - - - - - - - - - - Proxy datatype for passing Mat's and List<>'s as output parameters - - - - - - - - - - - - - - - - Principal Component Analysis - - - - - default constructor. - - The default constructor initializes an empty PCA structure. - The other constructors initialize the structure and call PCA::operator()(). - - - - - Constructor - - input samples stored as matrix rows or matrix columns. - optional mean value; if the matrix is empty (@c noArray()), the mean is computed from the data. - operation flags; currently the parameter is only used to specify the data layout (PCA::Flags) - maximum number of components that PCA should retain; by default, all the components are retained. - - - - Constructor - - input samples stored as matrix rows or matrix columns. - optional mean value; if the matrix is empty (noArray()), the mean is computed from the data. - operation flags; currently the parameter is only used to specify the data layout (PCA::Flags) - Percentage of variance that PCA should retain. - Using this parameter will let the PCA decided how many components to retain but it will always keep at least 2. - - - - Releases unmanaged resources - - - - - eigenvalues of the covariation matrix - - - - - eigenvalues of the covariation matrix - - - - - mean value subtracted before the projection and added after the back projection - - - - - Performs PCA. - - The operator performs %PCA of the supplied dataset. It is safe to reuse - the same PCA structure for multiple datasets. That is, if the structure - has been previously used with another dataset, the existing internal - data is reclaimed and the new @ref eigenvalues, @ref eigenvectors and @ref - mean are allocated and computed. - - The computed @ref eigenvalues are sorted from the largest to the smallest and - the corresponding @ref eigenvectors are stored as eigenvectors rows. - - input samples stored as the matrix rows or as the matrix columns. - optional mean value; if the matrix is empty (noArray()), the mean is computed from the data. - operation flags; currently the parameter is only used to specify the data layout. (Flags) - maximum number of components that PCA should retain; - by default, all the components are retained. - - - - - Performs PCA. - - The operator performs %PCA of the supplied dataset. It is safe to reuse - the same PCA structure for multiple datasets. That is, if the structure - has been previously used with another dataset, the existing internal - data is reclaimed and the new @ref eigenvalues, @ref eigenvectors and @ref - mean are allocated and computed. - - The computed @ref eigenvalues are sorted from the largest to the smallest and - the corresponding @ref eigenvectors are stored as eigenvectors rows. - - input samples stored as the matrix rows or as the matrix columns. - optional mean value; if the matrix is empty (noArray()), - the mean is computed from the data. - operation flags; currently the parameter is only used to - specify the data layout. (PCA::Flags) - Percentage of variance that %PCA should retain. - Using this parameter will let the %PCA decided how many components to - retain but it will always keep at least 2. - - - - - Projects vector(s) to the principal component subspace. - - The methods project one or more vectors to the principal component - subspace, where each vector projection is represented by coefficients in - the principal component basis. The first form of the method returns the - matrix that the second form writes to the result. So the first form can - be used as a part of expression while the second form can be more - efficient in a processing loop. - - input vector(s); must have the same dimensionality and the - same layout as the input data used at %PCA phase, that is, if - DATA_AS_ROW are specified, then `vec.cols==data.cols` - (vector dimensionality) and `vec.rows` is the number of vectors to - project, and the same is true for the PCA::DATA_AS_COL case. - - - - - Projects vector(s) to the principal component subspace. - - input vector(s); must have the same dimensionality and the - same layout as the input data used at PCA phase, that is, if DATA_AS_ROW are - specified, then `vec.cols==data.cols` (vector dimensionality) and `vec.rows` - is the number of vectors to project, and the same is true for the PCA::DATA_AS_COL case. - output vectors; in case of PCA::DATA_AS_COL, the - output matrix has as many columns as the number of input vectors, this - means that `result.cols==vec.cols` and the number of rows match the - number of principal components (for example, `maxComponents` parameter - passed to the constructor). - - - - Reconstructs vectors from their PC projections. - - The methods are inverse operations to PCA::project. They take PC - coordinates of projected vectors and reconstruct the original vectors. - Unless all the principal components have been retained, the - reconstructed vectors are different from the originals. But typically, - the difference is small if the number of components is large enough (but - still much smaller than the original vector dimensionality). As a result, PCA is used. - - coordinates of the vectors in the principal component subspace, - the layout and size are the same as of PCA::project output vectors. - - - - - Reconstructs vectors from their PC projections. - - The methods are inverse operations to PCA::project. They take PC - coordinates of projected vectors and reconstruct the original vectors. - Unless all the principal components have been retained, the - reconstructed vectors are different from the originals. But typically, - the difference is small if the number of components is large enough (but - still much smaller than the original vector dimensionality). As a result, PCA is used. - - coordinates of the vectors in the principal component subspace, - the layout and size are the same as of PCA::project output vectors. - reconstructed vectors; the layout and size are the same as - of PCA::project input vectors. - - - - Write PCA objects. - Writes @ref eigenvalues @ref eigenvectors and @ref mean to specified FileStorage - - - - - - Load PCA objects. - Loads @ref eigenvalues @ref eigenvectors and @ref mean from specified FileNode - - - - - - Flags for PCA operations - - - - - The vectors are stored as rows (i.e. all the components of a certain vector are stored continously) - - - - - The vectors are stored as columns (i.e. values of a certain vector component are stored continuously) - - - - - Use pre-computed average vector - - - - - Random Number Generator. - The class implements RNG using Multiply-with-Carry algorithm. - - operations.hpp - - - - - - - - Constructor - - 64-bit value used to initialize the RNG. - - - - (byte)RNG.next() - - - - - - - (byte)RNG.next() - - - - - - (sbyte)RNG.next() - - - - - - - (sbyte)RNG.next() - - - - - - (ushort)RNG.next() - - - - - - - (ushort)RNG.next() - - - - - - (short)RNG.next() - - - - - - - (short)RNG.next() - - - - - - (uint)RNG.next() - - - - - - - (uint)RNG.next() - - - - - - (int)RNG.next() - - - - - - - (int)RNG.next() - - - - - - returns a next random value as float (System.Single) - - - - - - - returns a next random value as float (System.Single) - - - - - - returns a next random value as double (System.Double) - - - - - - - returns a next random value as double (System.Double) - - - - - - updates the state and returns the next 32-bit unsigned integer random number - - - - - - returns a random integer sampled uniformly from [0, N). - - - - - - - - - - - - - returns uniformly distributed integer random number from [a,b) range - - - - - - - - returns uniformly distributed floating-point random number from [a,b) range - - - - - - - - returns uniformly distributed double-precision floating-point random number from [a,b) range - - - - - - - - Fills arrays with random numbers. - - 2D or N-dimensional matrix; currently matrices with more than - 4 channels are not supported by the methods, use Mat::reshape as a possible workaround. - distribution type, RNG::UNIFORM or RNG::NORMAL. - first distribution parameter; in case of the uniform distribution, - this is an inclusive lower boundary, in case of the normal distribution, this is a mean value. - second distribution parameter; in case of the uniform distribution, this is - a non-inclusive upper boundary, in case of the normal distribution, this is a standard deviation - (diagonal of the standard deviation matrix or the full standard deviation matrix). - pre-saturation flag; for uniform distribution only; - if true, the method will first convert a and b to the acceptable value range (according to the - mat datatype) and then will generate uniformly distributed random numbers within the range - [saturate(a), saturate(b)), if saturateRange=false, the method will generate uniformly distributed - random numbers in the original range [a, b) and then will saturate them, it means, for example, that - theRNG().fill(mat_8u, RNG::UNIFORM, -DBL_MAX, DBL_MAX) will likely produce array mostly filled - with 0's and 255's, since the range (0, 255) is significantly smaller than [-DBL_MAX, DBL_MAX). - - - - Returns the next random number sampled from the Gaussian distribution. - - The method transforms the state using the MWC algorithm and returns the next random number - from the Gaussian distribution N(0,sigma) . That is, the mean value of the returned random - numbers is zero and the standard deviation is the specified sigma. - - standard deviation of the distribution. - - - - - - - - - - - - - - - - - - - - - - - - - - - - Mersenne Twister random number generator - - operations.hpp - - - - Constructor - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - updates the state and returns the next 32-bit unsigned integer random number - - - - - - returns a random integer sampled uniformly from [0, N). - - - - - - - - - - - - - returns uniformly distributed integer random number from [a,b) range - - - - - - - - returns uniformly distributed floating-point random number from [a,b) range - - - - - - - - returns uniformly distributed double-precision floating-point random number from [a,b) range - - - - - - - - Sparse matrix class. - - - - - Creates from native cv::SparseMat* pointer - - - - - - Creates empty SparseMat - - - - - constructs n-dimensional sparse matrix - - Array of integers specifying an n-dimensional array shape. - Array type. Use MatType.CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, - or MatType. CV_8UC(n), ..., CV_64FC(n) to create multi-channel matrices. - - - - converts old-style CvMat to the new matrix; the data is not copied by default - - cv::Mat object - - - - Releases the resources - - - - - Releases unmanaged resources - - - - - Create SparseMat from Mat - - - - - - - Assignment operator. This is O(1) operation, i.e. no data is copied - - - - - - - Assignment operator. equivalent to the corresponding constructor. - - - - - - - creates full copy of the matrix - - - - - - copies all the data to the destination matrix. All the previous content of m is erased. - - - - - - converts sparse matrix to dense matrix. - - - - - - multiplies all the matrix elements by the specified scale factor alpha and converts the results to the specified data type - - - - - - - - converts sparse matrix to dense n-dim matrix with optional type conversion and scaling. - - - The output matrix data type. When it is =-1, the output array will have the same data type as (*this) - The scale factor - The optional delta added to the scaled values before the conversion - - - - not used now - - - - - - - Reallocates sparse matrix. - If the matrix already had the proper size and type, - it is simply cleared with clear(), otherwise, - the old matrix is released (using release()) and the new one is allocated. - - - - - - - sets all the sparse matrix elements to 0, which means clearing the hash table. - - - - - manually increments the reference counter to the header. - - - - - returns the size of each element in bytes (not including the overhead - the space occupied by SparseMat::Node elements) - - - - - - returns elemSize()/channels() - - - - - - Returns the type of sparse matrix element. - - - - - - Returns the depth of sparse matrix element. - - - - - - Returns the matrix dimensionality - - - - - Returns the number of sparse matrix channels. - - - - - - Returns the array of sizes, or null if the matrix is not allocated - - - - - - Returns the size of i-th matrix dimension (or 0) - - - - - - - returns the number of non-zero elements (=the number of hash table nodes) - - - - - - Computes the element hash value (1D case) - - Index along the dimension 0 - - - - - Computes the element hash value (2D case) - - Index along the dimension 0 - Index along the dimension 1 - - - - - Computes the element hash value (3D case) - - Index along the dimension 0 - Index along the dimension 1 - Index along the dimension 2 - - - - - Computes the element hash value (nD case) - - Array of Mat::dims indices. - - - - - Low-level element-access function. - - Index along the dimension 0 - Create new element with 0 value if it does not exist in SparseMat. - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - - - - - Low-level element-access function. - - Index along the dimension 0 - Index along the dimension 1 - Create new element with 0 value if it does not exist in SparseMat. - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - - - - - Low-level element-access function. - - Index along the dimension 0 - Index along the dimension 1 - Index along the dimension 2 - Create new element with 0 value if it does not exist in SparseMat. - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - - - - - Low-level element-access function. - - Array of Mat::dims indices. - Create new element with 0 value if it does not exist in SparseMat. - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - - - - - Return pthe specified sparse matrix element if it exists; otherwise, null. - - Index along the dimension 0 - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - - - - - Return pthe specified sparse matrix element if it exists; otherwise, null. - - Index along the dimension 0 - Index along the dimension 1 - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - - - - - Return pthe specified sparse matrix element if it exists; otherwise, null. - - Index along the dimension 0 - Index along the dimension 1 - Index along the dimension 2 - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - - - - - Return pthe specified sparse matrix element if it exists; otherwise, null. - - Array of Mat::dims indices. - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - - - - - Return pthe specified sparse matrix element if it exists; otherwise, default(T). - - Index along the dimension 0 - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - - - - - Return pthe specified sparse matrix element if it exists; otherwise, default(T). - - Index along the dimension 0 - Index along the dimension 1 - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - - - - - Return pthe specified sparse matrix element if it exists; otherwise, default(T). - - Index along the dimension 0 - Index along the dimension 1 - Index along the dimension 2 - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - - - - - Return pthe specified sparse matrix element if it exists; otherwise, default(T). - - Array of Mat::dims indices. - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - - - - - Mat Indexer - - - - - - 1-dimensional indexer - - Index along the dimension 0 - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - A value to the specified array element. - - - - 2-dimensional indexer - - Index along the dimension 0 - Index along the dimension 1 - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - A value to the specified array element. - - - - 3-dimensional indexer - - Index along the dimension 0 - Index along the dimension 1 - Index along the dimension 2 - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - A value to the specified array element. - - - - n-dimensional indexer - - Array of Mat::dims indices. - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - A value to the specified array element. - - - - Gets a type-specific indexer. - The indexer has getters/setters to access each matrix element. - - - - - - - Gets a type-specific indexer. - The indexer has getters/setters to access each matrix element. - - - - - - - Returns a value to the specified array element. - - - Index along the dimension 0 - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - A value to the specified array element. - - - - Returns a value to the specified array element. - - - Index along the dimension 0 - Index along the dimension 1 - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - A value to the specified array element. - - - - Returns a value to the specified array element. - - - Index along the dimension 0 - Index along the dimension 1 - Index along the dimension 2 - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - A value to the specified array element. - - - - Returns a value to the specified array element. - - - Array of Mat::dims indices. - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - A value to the specified array element. - - - - Set a value to the specified array element. - - - Index along the dimension 0 - - - - - - Set a value to the specified array element. - - - Index along the dimension 0 - Index along the dimension 1 - - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - - - - Set a value to the specified array element. - - - Index along the dimension 0 - Index along the dimension 1 - Index along the dimension 2 - - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - - - - Set a value to the specified array element. - - - Array of Mat::dims indices. - - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - - - - Returns a string that represents this Mat. - - - - - - Abstract definition of Mat indexer - - - - - - 1-dimensional indexer - - Index along the dimension 0 - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - A value to the specified array element. - - - - 2-dimensional indexer - - Index along the dimension 0 - Index along the dimension 1 - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - A value to the specified array element. - - - - 3-dimensional indexer - - Index along the dimension 0 - Index along the dimension 1 - Index along the dimension 2 - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - A value to the specified array element. - - - - n-dimensional indexer - - Array of Mat::dims indices. - If hashVal is not null, the element hash value is not computed but hashval is taken instead. - A value to the specified array element. - - - - Parent matrix object - - - - - Constructor - - - - - - Struct for matching: query descriptor index, train descriptor index, train image index and distance between descriptors. - - - Constructor - - - - - Struct for matching: query descriptor index, train descriptor index, train image index and distance between descriptors. - - - Constructor - - - - - query descriptor index - - - - - train descriptor index - - - - - train image index - - - - - - - - - - - - - - - - Constructor - - - - - - - - Compares by distance (less is better) - - - - - - - - Compares by distance (less is better) - - - - - - - - Compares by distance (less is better) - - - - - - - Data structure for salient point detectors - - - Complete constructor - - Coordinate of the point - Feature size - Feature orientation in degrees (has negative value if the orientation is not defined/not computed) - Feature strength (can be used to select only the most prominent key points) - Scale-space octave in which the feature has been found; may correlate with the size - Point class (can be used by feature classifiers or object detectors) - - - - Data structure for salient point detectors - - - Complete constructor - - Coordinate of the point - Feature size - Feature orientation in degrees (has negative value if the orientation is not defined/not computed) - Feature strength (can be used to select only the most prominent key points) - Scale-space octave in which the feature has been found; may correlate with the size - Point class (can be used by feature classifiers or object detectors) - - - - Coordinate of the point - - - - - Feature size - - - - - Feature orientation in degrees (has negative value if the orientation is not defined/not computed) - - - - - Feature strength (can be used to select only the most prominent key points) - - - - - Scale-space octave in which the feature has been found; may correlate with the size - - - - - Point class (can be used by feature classifiers or object detectors) - - - - - Complete constructor - - X-coordinate of the point - Y-coordinate of the point - Feature size - Feature orientation in degrees (has negative value if the orientation is not defined/not computed) - Feature strength (can be used to select only the most prominent key points) - Scale-space octave in which the feature has been found; may correlate with the size - Point class (can be used by feature classifiers or object detectors) - - - - Matrix data type (depth and number of channels) - - - - - Matrix data type (depth and number of channels) - - - - - Entity value - - - - - Entity value - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - type depth constants - - - - - type depth constants - - - - - type depth constants - - - - - type depth constants - - - - - type depth constants - - - - - type depth constants - - - - - type depth constants - - - - - type depth constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - predefined type constants - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Unary plus operator - - - - - - Unary plus operator - - - - - - - Unary minus operator - - - - - - Unary minus operator - - - - - - - Shifts point by a certain offset - - - - - - - Shifts point by a certain offset - - - - - - - - Shifts point by a certain offset - - - - - - - Shifts point by a certain offset - - - - - - - - Shifts point by a certain offset - - - - - - - Shifts point by a certain offset - - - - - - - - Returns the distance between the specified two points - - - - - - - - Returns the distance between the specified two points - - - - - - - Calculates the dot product of two 2D vectors. - - - - - - - - Calculates the dot product of two 2D vectors. - - - - - - - Calculates the cross product of two 2D vectors. - - - - - - - - Calculates the cross product of two 2D vectors. - - - - - - /// - - - - /// - - - - - - - - - - - - - - - Unary plus operator - - - - - - Unary plus operator - - - - - - - Unary minus operator - - - - - - Unary minus operator - - - - - - - Shifts point by a certain offset - - - - - - - Shifts point by a certain offset - - - - - - - - Shifts point by a certain offset - - - - - - - Shifts point by a certain offset - - - - - - - - Shifts point by a certain offset - - - - - - - Shifts point by a certain offset - - - - - - - - Returns the distance between the specified two points - - - - - - - - Returns the distance between the specified two points - - - - - - - Calculates the dot product of two 2D vectors. - - - - - - - - Calculates the dot product of two 2D vectors. - - - - - - - Calculates the cross product of two 2D vectors. - - - - - - - - Calculates the cross product of two 2D vectors. - - - - - - - - - - - - - - - - - - - - - - - - - - - Unary plus operator - - - - - - Unary plus operator - - - - - - - Unary minus operator - - - - - - Unary minus operator - - - - - - - Shifts point by a certain offset - - - - - - - Shifts point by a certain offset - - - - - - - - Shifts point by a certain offset - - - - - - - Shifts point by a certain offset - - - - - - - - Shifts point by a certain offset - - - - - - - Shifts point by a certain offset - - - - - - - - Returns the distance between the specified two points - - - - - - - - Returns the distance between the specified two points - - - - - - - Calculates the dot product of two 2D vectors. - - - - - - - - Calculates the dot product of two 2D vectors. - - - - - - - Calculates the cross product of two 2D vectors. - - - - - - - - Calculates the cross product of two 2D vectors. - - - - - - /// - - - - /// - - - - - - - - - - - - - - - - - - - - Unary plus operator - - - - - - - Unary plus operator - - - - - - Unary minus operator - - - - - - - Unary minus operator - - - - - - Shifts point by a certain offset - - - - - - - - Shifts point by a certain offset - - - - - - - Shifts point by a certain offset - - - - - - - - Shifts point by a certain offset - - - - - - - Shifts point by a certain offset - - - - - - - - Shifts point by a certain offset - - - - - - /// - - - - /// - - - - - - - - - - - - - - - - - - - - Unary plus operator - - - - - - Unary plus operator - - - - - - - Unary minus operator - - - - - - Unary minus operator - - - - - - - Shifts point by a certain offset - - - - - - - Shifts point by a certain offset - - - - - - - - Shifts point by a certain offset - - - - - - - Shifts point by a certain offset - - - - - - - - Shifts point by a certain offset - - - - - - - Shifts point by a certain offset - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Unary plus operator - - - - - - - Unary plus operator - - - - - - Unary minus operator - - - - - - - Unary minus operator - - - - - - Shifts point by a certain offset - - - - - - - - Shifts point by a certain offset - - - - - - - Shifts point by a certain offset - - - - - - - - Shifts point by a certain offset - - - - - - - Shifts point by a certain offset - - - - - - - - Shifts point by a certain offset - - - - - - - Template class specifying a continuous subsequence (slice) of a sequence. - - - - - Template class specifying a continuous subsequence (slice) of a sequence. - - - - - - - - - - - - - - - - - - - - float Range class - - - - - float Range class - - - - - - - - - - - - - - - Convert to Range - - - - - - Implicit operator (Range)this - - - - - - - Range(int.MinValue, int.MaxValue) - - - - - Stores a set of four integers that represent the location and size of a rectangle - - The x-coordinate of the upper-left corner of the rectangle. - The y-coordinate of the upper-left corner of the rectangle. - The width of the rectangle. - The height of the rectangle. - - - - Stores a set of four integers that represent the location and size of a rectangle - - The x-coordinate of the upper-left corner of the rectangle. - The y-coordinate of the upper-left corner of the rectangle. - The width of the rectangle. - The height of the rectangle. - - - - The x-coordinate of the upper-left corner of the rectangle. - - - - - The y-coordinate of the upper-left corner of the rectangle. - - - - - The width of the rectangle. - - - - - The height of the rectangle. - - - - - Initializes a new instance of the Rectangle class with the specified location and size. - - A Point that represents the upper-left corner of the rectangular region. - A Size that represents the width and height of the rectangular region. - - - - Creates a Rectangle structure with the specified edge locations. - - The x-coordinate of the upper-left corner of this Rectangle structure. - The y-coordinate of the upper-left corner of this Rectangle structure. - The x-coordinate of the lower-right corner of this Rectangle structure. - The y-coordinate of the lower-right corner of this Rectangle structure. - - - - Shifts rectangle by a certain offset - - - - - - - - Shifts rectangle by a certain offset - - - - - - - Shifts rectangle by a certain offset - - - - - - - - Shifts rectangle by a certain offset - - - - - - - Expands or shrinks rectangle by a certain amount - - - - - - - - Expands or shrinks rectangle by a certain amount - - - - - - - Expands or shrinks rectangle by a certain amount - - - - - - - - Expands or shrinks rectangle by a certain amount - - - - - - - Determines the Rect structure that represents the intersection of two rectangles. - - A rectangle to intersect. - A rectangle to intersect. - - - - - Gets a Rect structure that contains the union of two Rect structures. - - A rectangle to union. - A rectangle to union. - - - - - Gets the y-coordinate of the top edge of this Rect structure. - - - - - Gets the y-coordinate that is the sum of the Y and Height property values of this Rect structure. - - - - - Gets the x-coordinate of the left edge of this Rect structure. - - - - - Gets the x-coordinate that is the sum of X and Width property values of this Rect structure. - - - - - Coordinate of the left-most rectangle corner [Point(X, Y)] - - - - - Size of the rectangle [CvSize(Width, Height)] - - - - - Coordinate of the left-most rectangle corner [Point(X, Y)] - - - - - Coordinate of the right-most rectangle corner [Point(X+Width, Y+Height)] - - - - - Determines if the specified point is contained within the rectangular region defined by this Rectangle. - - x-coordinate of the point - y-coordinate of the point - - - - - Determines if the specified point is contained within the rectangular region defined by this Rectangle. - - point - - - - - Determines if the specified rectangle is contained within the rectangular region defined by this Rectangle. - - rectangle - - - - - Inflates this Rect by the specified amount. - - The amount to inflate this Rectangle horizontally. - The amount to inflate this Rectangle vertically. - - - - Inflates this Rect by the specified amount. - - The amount to inflate this rectangle. - - - - Creates and returns an inflated copy of the specified Rect structure. - - The Rectangle with which to start. This rectangle is not modified. - The amount to inflate this Rectangle horizontally. - The amount to inflate this Rectangle vertically. - - - - - Determines the Rect structure that represents the intersection of two rectangles. - - A rectangle to intersect. - A rectangle to intersect. - - - - - Determines the Rect structure that represents the intersection of two rectangles. - - A rectangle to intersect. - - - - - Determines if this rectangle intersects with rect. - - Rectangle - - - - - Gets a Rect structure that contains the union of two Rect structures. - - A rectangle to union. - - - - - Gets a Rect structure that contains the union of two Rect structures. - - A rectangle to union. - A rectangle to union. - - - - - Stores a set of four double-precision floating-point numbers that represent the location and size of a rectangle - - The x-coordinate of the upper-left corner of the rectangle. - The y-coordinate of the upper-left corner of the rectangle. - The width of the rectangle. - The height of the rectangle. - - - - Stores a set of four double-precision floating-point numbers that represent the location and size of a rectangle - - The x-coordinate of the upper-left corner of the rectangle. - The y-coordinate of the upper-left corner of the rectangle. - The width of the rectangle. - The height of the rectangle. - - - - The x-coordinate of the upper-left corner of the rectangle. - - - - - The y-coordinate of the upper-left corner of the rectangle. - - - - - The width of the rectangle. - - - - - The height of the rectangle. - - - - - Constructor - - - - - - - - - - - - - - - - Shifts rectangle by a certain offset - - - - - - - - Shifts rectangle by a certain offset - - - - - - - Shifts rectangle by a certain offset - - - - - - - - Shifts rectangle by a certain offset - - - - - - - Expands or shrinks rectangle by a certain amount - - - - - - - - Shifts rectangle by a certain offset - - - - - - - Expands or shrinks rectangle by a certain amount - - - - - - - - Shifts rectangle by a certain offset - - - - - - - Determines the Rect2d structure that represents the intersection of two rectangles. - - A rectangle to intersect. - A rectangle to intersect. - - - - - Gets a Rect2d structure that contains the union of two Rect2d structures. - - A rectangle to union. - A rectangle to union. - - - - - Gets the y-coordinate of the top edge of this Rect2d structure. - - - - - Gets the y-coordinate that is the sum of the Y and Height property values of this Rect2d structure. - - - - - Gets the x-coordinate of the left edge of this Rect2d structure. - - - - - Gets the x-coordinate that is the sum of X and Width property values of this Rect2d structure. - - - - - Coordinate of the left-most rectangle corner [Point2d(X, Y)] - - - - - Size of the rectangle [CvSize(Width, Height)] - - - - - Coordinate of the left-most rectangle corner [Point2d(X, Y)] - - - - - Coordinate of the right-most rectangle corner [Point2d(X+Width, Y+Height)] - - - - - - - - - - - Determines if the specified point is contained within the rectangular region defined by this Rectangle. - - x-coordinate of the point - y-coordinate of the point - - - - - Determines if the specified point is contained within the rectangular region defined by this Rectangle. - - point - - - - - Determines if the specified rectangle is contained within the rectangular region defined by this Rectangle. - - rectangle - - - - - Inflates this Rect by the specified amount. - - The amount to inflate this Rectangle horizontally. - The amount to inflate this Rectangle vertically. - - - - Inflates this Rect by the specified amount. - - The amount to inflate this rectangle. - - - - Creates and returns an inflated copy of the specified Rect2d structure. - - The Rectangle with which to start. This rectangle is not modified. - The amount to inflate this Rectangle horizontally. - The amount to inflate this Rectangle vertically. - - - - - Determines the Rect2d structure that represents the intersection of two rectangles. - - A rectangle to intersect. - A rectangle to intersect. - - - - - Determines the Rect2d structure that represents the intersection of two rectangles. - - A rectangle to intersect. - - - - - Determines if this rectangle intersects with rect. - - Rectangle - - - - - Gets a Rect2d structure that contains the union of two Rect2d structures. - - A rectangle to union. - - - - - Gets a Rect2d structure that contains the union of two Rect2d structures. - - A rectangle to union. - A rectangle to union. - - - - - A rectangle with float type coordinates in 2D space - - The x-coordinate of the upper-left corner of the rectangle. - The y-coordinate of the upper-left corner of the rectangle. - The width of the rectangle. - The height of the rectangle. - - - - A rectangle with float type coordinates in 2D space - - The x-coordinate of the upper-left corner of the rectangle. - The y-coordinate of the upper-left corner of the rectangle. - The width of the rectangle. - The height of the rectangle. - - - - The x-coordinate of the upper-left corner of the rectangle. - - - - - The y-coordinate of the upper-left corner of the rectangle. - - - - - The width of the rectangle. - - - - - The height of the rectangle. - - - - - Constructor - - - - - - - - - - - - - - - - Shifts rectangle by a certain offset - - - - - - - Shifts rectangle by a certain offset - - - - - - - - Shifts rectangle by a certain offset - - - - - - - Shifts rectangle by a certain offset - - - - - - - - Expands or shrinks rectangle by a certain amount - - - - - - - Expands or shrinks rectangle by a certain amount - - - - - - - - Expands or shrinks rectangle by a certain amount - - - - - - - Expands or shrinks rectangle by a certain amount - - - - - - - - Determines the Rect2f structure that represents the intersection of two rectangles. - - A rectangle to intersect. - A rectangle to intersect. - - - - - Gets a Rect2f structure that contains the union of two Rect2f structures. - - A rectangle to union. - A rectangle to union. - - - - - Gets the y-coordinate of the top edge of this Rect2f structure. - - - - - Gets the y-coordinate that is the sum of the Y and Height property values of this Rect2f structure. - - - - - Gets the x-coordinate of the left edge of this Rect2f structure. - - - - - Gets the x-coordinate that is the sum of X and Width property values of this Rect2f structure. - - - - - Coordinate of the left-most rectangle corner [Point2f(X, Y)] - - - - - Size of the rectangle [CvSize(Width, Height)] - - - - - Coordinate of the left-most rectangle corner [Point2f(X, Y)] - - - - - Coordinate of the right-most rectangle corner [Point2f(X+Width, Y+Height)] - - - - - Determines if the specified point is contained within the rectangular region defined by this Rectangle. - - x-coordinate of the point - y-coordinate of the point - - - - - Determines if the specified point is contained within the rectangular region defined by this Rectangle. - - point - - - - - Determines if the specified rectangle is contained within the rectangular region defined by this Rectangle. - - rectangle - - - - - Inflates this Rect by the specified amount. - - The amount to inflate this Rectangle horizontally. - The amount to inflate this Rectangle vertically. - - - - Inflates this Rect by the specified amount. - - The amount to inflate this rectangle. - - - - Creates and returns an inflated copy of the specified Rect2f structure. - - The Rectangle with which to start. This rectangle is not modified. - The amount to inflate this Rectangle horizontally. - The amount to inflate this Rectangle vertically. - - - - - Determines the Rect2f structure that represents the intersection of two rectangles. - - A rectangle to intersect. - A rectangle to intersect. - - - - - Determines the Rect2f structure that represents the intersection of two rectangles. - - A rectangle to intersect. - - - - - Determines if this rectangle intersects with rect. - - Rectangle - - - - - Gets a Rect2f structure that contains the union of two Rect2f structures. - - A rectangle to union. - - - - - Gets a Rect2f structure that contains the union of two Rect2f structures. - - A rectangle to union. - A rectangle to union. - - - - - The class represents rotated (i.e. not up-right) rectangles on a plane. - - - - - the rectangle mass center - - - - - width and height of the rectangle - - - - - the rotation angle. When the angle is 0, 90, 180, 270 etc., the rectangle becomes an up-right rectangle. - - - - - Constructor - - - - - - - - Any 3 end points of the RotatedRect. They must be given in order (either clockwise or anticlockwise). - - - - - Any 3 end points of the RotatedRect. They must be given in order (either clockwise or anticlockwise). - - - - - returns 4 vertices of the rectangle - - - - - - returns the minimal up-right rectangle containing the rotated rectangle - - - - - - Template class for a 4-element vector derived from Vec. - - - - - Template class for a 4-element vector derived from Vec. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets random color - - - - - Gets random color - - .NET random number generator. This method uses Random.NextBytes() - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #F0F8FF - - - - - #FAEBD7 - - - - - #00FFFF - - - - - #7FFFD4 - - - - - #F0FFFF - - - - - #F5F5DC - - - - - #FFE4C4 - - - - - #000000 - - - - - #FFEBCD - - - - - #0000FF - - - - - #8A2BE2 - - - - - #A52A2A - - - - - #DEB887 - - - - - #5F9EA0 - - - - - #7FFF00 - - - - - #D2691E - - - - - #FF7F50 - - - - - #6495ED - - - - - #FFF8DC - - - - - #DC143C - - - - - #00FFFF - - - - - #00008B - - - - - #008B8B - - - - - #B8860B - - - - - #A9A9A9 - - - - - #006400 - - - - - #BDB76B - - - - - #8B008B - - - - - #556B2F - - - - - #FF8C00 - - - - - #9932CC - - - - - #8B0000 - - - - - #E9967A - - - - - #8FBC8F - - - - - #483D8B - - - - - #2F4F4F - - - - - #00CED1 - - - - - #9400D3 - - - - - #FF1493 - - - - - #00BFFF - - - - - #696969 - - - - - #1E90FF - - - - - #B22222 - - - - - #FFFAF0 - - - - - #228B22 - - - - - #FF00FF - - - - - #DCDCDC - - - - - #F8F8FF - - - - - #FFD700 - - - - - #DAA520 - - - - - #808080 - - - - - #008000 - - - - - #ADFF2F - - - - - #F0FFF0 - - - - - #FF69B4 - - - - - #CD5C5C - - - - - #4B0082 - - - - - #FFFFF0 - - - - - #F0E68C - - - - - #E6E6FA - - - - - #FFF0F5 - - - - - #7CFC00 - - - - - #FFFACD - - - - - #ADD8E6 - - - - - #F08080 - - - - - #E0FFFF - - - - - #FAFAD2 - - - - - #D3D3D3 - - - - - #90EE90 - - - - - #FFB6C1 - - - - - #FFA07A - - - - - #20B2AA - - - - - #87CEFA - - - - - #778899 - - - - - #B0C4DE - - - - - #FFFFE0 - - - - - #00FF00 - - - - - #32CD32 - - - - - #FAF0E6 - - - - - #FF00FF - - - - - #800000 - - - - - #66CDAA - - - - - #0000CD - - - - - #BA55D3 - - - - - #9370DB - - - - - #3CB371 - - - - - #7B68EE - - - - - #00FA9A - - - - - #48D1CC - - - - - #C71585 - - - - - #191970 - - - - - #F5FFFA - - - - - #FFE4E1 - - - - - #FFE4B5 - - - - - #FFDEAD - - - - - #000080 - - - - - #FDF5E6 - - - - - #808000 - - - - - #6B8E23 - - - - - #FFA500 - - - - - #FF4500 - - - - - #DA70D6 - - - - - #EEE8AA - - - - - #98FB98 - - - - - #AFEEEE - - - - - #DB7093 - - - - - #FFEFD5 - - - - - #FFDAB9 - - - - - #CD853F - - - - - #FFC0CB - - - - - #DDA0DD - - - - - #B0E0E6 - - - - - #800080 - - - - - #FF0000 - - - - - #BC8F8F - - - - - #4169E1 - - - - - #8B4513 - - - - - #FA8072 - - - - - #F4A460 - - - - - #2E8B57 - - - - - #FFF5EE - - - - - #A0522D - - - - - #C0C0C0 - - - - - #87CEEB - - - - - #6A5ACD - - - - - #708090 - - - - - #FFFAFA - - - - - #00FF7F - - - - - #4682B4 - - - - - #D2B48C - - - - - #008080 - - - - - #D8BFD8 - - - - - #FF6347 - - - - - #40E0D0 - - - - - #EE82EE - - - - - #F5DEB3 - - - - - #FFFFFF - - - - - #F5F5F5 - - - - - #FFFF00 - - - - - #9ACD32 - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - - - - - - - - - - - - - - - - - - - - - - - - - - The class defining termination criteria for iterative algorithms. - - - - - The class defining termination criteria for iterative algorithms. - - - - - the type of termination criteria: COUNT, EPS or COUNT + EPS - - - - - the maximum number of iterations/elements - - - - - the desired accuracy - - - - - full constructor with both type (count | epsilon) - - - - - - - Vec empty interface - - - - - Vec** interface - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this * alpha - - - - - - - indexer - - - - - - - 2-Tuple of byte (System.Byte) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - Deconstructing a Vector - - - - - - - Initializer - - - - - - - returns a Vec with all elements set to v0 - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2-Tuple of double (System.Double) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - Deconstructing a Vector - - - - - - - Initializer - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2-Tuple of float (System.Single) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - Deconstructing a Vector - - - - - - - Initializer - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2-Tuple of int (System.Int32) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - Deconstructing a Vector - - - - - - - Initializer - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2-Tuple of short (System.Int16) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - Deconstructing a Vector - - - - - - - Initializer - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2-Tuple of ushort (System.UInt16) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - Deconstructing a Vector - - - - - - - Initializer - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 3-Tuple of byte (System.Byte) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - Deconstructing a Vector - - - - - - - - Initializer - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 3-Tuple of double (System.Double) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - Deconstructing a Vector - - - - - - - - Initializer - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 3-Tuple of float (System.Single) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - Deconstructing a Vector - - - - - - - - Initializer - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 3-Tuple of int (System.Int32) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - Deconstructing a Vector - - - - - - - - Initializer - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 3-Tuple of short (System.Int16) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - Deconstructing a Vector - - - - - - - - Initializer - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 3-Tuple of ushort (System.UInt16) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - Deconstructing a Vector - - - - - - - - Initializer - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 4-Tuple of byte (System.Byte) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - The value of the fourth component of this object. - - - - - Deconstructing a Vector - - - - - - - - - Initializer - - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 4-Tuple of double (System.Double) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - The value of the fourth component of this object. - - - - - Deconstructing a Vector - - - - - - - - - Initializer - - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 4-Tuple of float (System.Single) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - The value of the fourth component of this object. - - - - - Deconstructing a Vector - - - - - - - - - Initializer - - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 4-Tuple of int (System.Int32) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - The value of the fourth component of this object. - - - - - Deconstructing a Vector - - - - - - - - - Initializer - - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 4-Tuple of short (System.Int16) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - The value of the fourth component of this object. - - - - - Deconstructing a Vector - - - - - - - - - Initializer - - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 4-Tuple of ushort (System.UInt16) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - The value of the fourth component of this object. - - - - - Deconstructing a Vector - - - - - - - - - Initializer - - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 6-Tuple of byte (System.Byte) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - The value of the fourth component of this object. - - - - - The value of the fifth component of this object. - - - - - The value of the sixth component of this object. - - - - - Deconstructing a Vector - - - - - - - - - - - Initializer - - - - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 6-Tuple of double (System.Double) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - The value of the fourth component of this object. - - - - - The value of the fifth component of this object. - - - - - The value of the sixth component of this object. - - - - - Deconstructing a Vector - - - - - - - - - - - Initializer - - - - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 6-Tuple of float (System.Single) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - The value of the fourth component of this object. - - - - - The value of the fifth component of this object. - - - - - The value of the sixth component of this object. - - - - - Deconstructing a Vector - - - - - - - - - - - Initializer - - - - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 6-Tuple of int (System.Int32) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - The value of the fourth component of this object. - - - - - The value of the fourth component of this object. - - - - - The value of the sixth component of this object. - - - - - Deconstructing a Vector - - - - - - - - - - - Initializer - - - - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 6-Tuple of short (System.Int16) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - The value of the fourth component of this object. - - - - - The value of the fifth component of this object. - - - - - The value of the sixth component of this object. - - - - - Deconstructing a Vector - - - - - - - - - - - Initializer - - - - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 4-Tuple of ushort (System.UInt16) - - - - - The value of the first component of this object. - - - - - The value of the second component of this object. - - - - - The value of the third component of this object. - - - - - The value of the fourth component of this object. - - - - - The value of the fifth component of this object. - - - - - The value of the sixth component of this object. - - - - - Deconstructing a Vector - - - - - - - - - - - Initializer - - - - - - - - - - - this + other - - - - - - - this - other - - - - - - - this * alpha - - - - - - - this / alpha - - - - - - - Indexer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Singular Value Decomposition class - - - - - the default constructor - - - - - the constructor that performs SVD - - - - - - - Releases unmanaged resources - - - - - eigenvalues of the covariation matrix - - - - - eigenvalues of the covariation matrix - - - - - mean value subtracted before the projection and added after the back projection - - - - - the operator that performs SVD. The previously allocated SVD::u, SVD::w are SVD::vt are released. - - - - - - - - performs back substitution, so that dst is the solution or pseudo-solution of m*dst = rhs, where m is the decomposed matrix - - - - - - - - decomposes matrix and stores the results to user-provided matrices - - - - - - - - - - computes singular values of a matrix - - - - - - - - performs back substitution - - - - - - - - - - finds dst = arg min_{|dst|=1} |m*dst| - - - - - - - Operation flags for SVD - - - - - - - - - - enables modification of matrix src1 during the operation. It speeds up the processing. - - - - - indicates that only a vector of singular values `w` is to be processed, - while u and vt will be set to empty matrices - - - - - when the matrix is not square, by default the algorithm produces u and - vt matrices of sufficiently large size for the further A reconstruction; - if, however, FULL_UV flag is specified, u and vt will be full-size square - orthogonal matrices. - - - - - Enum of computation backends supported by layers. - - - DNN_BACKEND_DEFAULT equals to DNN_BACKEND_INFERENCE_ENGINE if - OpenCV is built with Intel's Inference Engine library or - DNN_BACKEND_OPENCV otherwise. - - - - - cv::dnn functions - - - - - Reads a network model stored in Darknet (https://pjreddie.com/darknet/) model files. - - path to the .cfg file with text description of the network architecture. - path to the .weights file with learned network. - Network object that ready to do forward, throw an exception in failure cases. - This is shortcut consisting from DarknetImporter and Net::populateNet calls. - - - - Reads a network model stored in Darknet (https://pjreddie.com/darknet/) model files from memory. - - A buffer contains a content of .cfg file with text description of the network architecture. - A buffer contains a content of .weights file with learned network. - - This is shortcut consisting from DarknetImporter and Net::populateNet calls. - - - - Reads a network model stored in Darknet (https://pjreddie.com/darknet/) model files from stream. - - A buffer contains a content of .cfg file with text description of the network architecture. - A buffer contains a content of .weights file with learned network. - - This is shortcut consisting from DarknetImporter and Net::populateNet calls. - - - - Reads a network model stored in Caffe model files. - - path to the .prototxt file with text description of the network architecture. - path to the .caffemodel file with learned network. - - This is shortcut consisting from createCaffeImporter and Net::populateNet calls. - - - - Reads a network model stored in Caffe model files from memory. - - buffer containing the content of the .prototxt file - buffer containing the content of the .caffemodel file - - This is shortcut consisting from createCaffeImporter and Net::populateNet calls. - - - - Reads a network model stored in Caffe model files from memory. - - buffer containing the content of the .prototxt file - buffer containing the content of the .caffemodel file - - This is shortcut consisting from createCaffeImporter and Net::populateNet calls. - - - - Reads a network model stored in Caffe model files from Stream. - - buffer containing the content of the .prototxt file - buffer containing the content of the .caffemodel file - - This is shortcut consisting from createCaffeImporter and Net::populateNet calls. - - - - Reads a network model stored in Tensorflow model file. - - path to the .pb file with binary protobuf description of the network architecture - path to the .pbtxt file that contains text graph definition in protobuf format. - Resulting Net object is built by text graph using weights from a binary one that - let us make it more flexible. - This is shortcut consisting from createTensorflowImporter and Net::populateNet calls. - - - - Reads a network model stored in Tensorflow model file from memory. - - buffer containing the content of the pb file - buffer containing the content of the pbtxt file (optional) - - This is shortcut consisting from createTensorflowImporter and Net::populateNet calls. - - - - Reads a network model stored in Tensorflow model file from stream. - - buffer containing the content of the pb file - buffer containing the content of the pbtxt file (optional) - - This is shortcut consisting from createTensorflowImporter and Net::populateNet calls. - - - - Reads a network model stored in Torch model file. - - - - - This is shortcut consisting from createTorchImporter and Net::populateNet calls. - - - - Read deep learning network represented in one of the supported formats. - - This function automatically detects an origin framework of trained model - and calls an appropriate function such @ref readNetFromCaffe, @ref readNetFromTensorflow, - - Binary file contains trained weights. The following file - * extensions are expected for models from different frameworks: - * * `*.caffemodel` (Caffe, http://caffe.berkeleyvision.org/) - * * `*.pb` (TensorFlow, https://www.tensorflow.org/) - * * `*.t7` | `*.net` (Torch, http://torch.ch/) - * * `*.weights` (Darknet, https://pjreddie.com/darknet/) - * * `*.bin` (DLDT, https://software.intel.com/openvino-toolkit) - Text file contains network configuration. It could be a - * file with the following extensions: - * * `*.prototxt` (Caffe, http://caffe.berkeleyvision.org/) - * * `*.pbtxt` (TensorFlow, https://www.tensorflow.org/) - * * `*.cfg` (Darknet, https://pjreddie.com/darknet/) - * * `*.xml` (DLDT, https://software.intel.com/openvino-toolkit) - Explicit framework name tag to determine a format. - - - - - Loads blob which was serialized as torch.Tensor object of Torch7 framework. - - - - - - This function has the same limitations as createTorchImporter(). - - - - - Reads a network model ONNX https://onnx.ai/ from memory - - - - - - - Reads a network model ONNX https://onnx.ai/ from memory - - memory of the first byte of the buffer. - - - - - Reads a network model ONNX https://onnx.ai/ from memory - - memory of the first byte of the buffer. - - - - - Reads a network model ONNX https://onnx.ai/ from stream. - - memory of the first byte of the buffer. - - - - - Creates blob from .pb file. - - path to the .pb file with input tensor. - - - - - Creates 4-dimensional blob from image. Optionally resizes and crops @p image from center, - subtract @p mean values, scales values by @p scalefactor, swap Blue and Red channels. - - input image (with 1- or 3-channels). - multiplier for @p image values. - spatial size for output image - scalar with mean values which are subtracted from channels. Values are intended - to be in (mean-R, mean-G, mean-B) order if @p image has BGR ordering and @p swapRB is true. - flag which indicates that swap first and last channels in 3-channel image is necessary. - flag which indicates whether image will be cropped after resize or not - 4-dimansional Mat with NCHW dimensions order. - if @p crop is true, input image is resized so one side after resize is equal to corresponing - dimension in @p size and another one is equal or larger.Then, crop from the center is performed. - If @p crop is false, direct resize without cropping and preserving aspect ratio is performed. - - - - Creates 4-dimensional blob from series of images. Optionally resizes and - crops @p images from center, subtract @p mean values, scales values by @p scalefactor, swap Blue and Red channels. - - input images (all with 1- or 3-channels). - multiplier for @p image values. - spatial size for output image - scalar with mean values which are subtracted from channels. Values are intended - to be in (mean-R, mean-G, mean-B) order if @p image has BGR ordering and @p swapRB is true. - flag which indicates that swap first and last channels in 3-channel image is necessary. - flag which indicates whether image will be cropped after resize or not - 4-dimansional Mat with NCHW dimensions order. - if @p crop is true, input image is resized so one side after resize is equal to corresponing - dimension in @p size and another one is equal or larger.Then, crop from the center is performed. - If @p crop is false, direct resize without cropping and preserving aspect ratio is performed. - - - - Convert all weights of Caffe network to half precision floating point. - - Path to origin model from Caffe framework contains single - precision floating point weights(usually has `.caffemodel` extension). - Path to destination model with updated weights. - Set of layers types which parameters will be converted. - By default, converts only Convolutional and Fully-Connected layers' weights. - - Shrinked model has no origin float32 weights so it can't be used - in origin Caffe framework anymore.However the structure of data - is taken from NVidia's Caffe fork: https://github.com/NVIDIA/caffe. - So the resulting model may be used there. - - - - - Create a text representation for a binary network stored in protocol buffer format. - - A path to binary network. - A path to output text file to be created. - - - - Performs non maximum suppression given boxes and corresponding scores. - - a set of bounding boxes to apply NMS. - a set of corresponding confidences. - a threshold used to filter boxes by score. - a threshold used in non maximum suppression. - the kept indices of bboxes after NMS. - a coefficient in adaptive threshold formula - if `>0`, keep at most @p top_k picked indices. - - - - Performs non maximum suppression given boxes and corresponding scores. - - a set of bounding boxes to apply NMS. - a set of corresponding confidences. - a threshold used to filter boxes by score. - a threshold used in non maximum suppression. - the kept indices of bboxes after NMS. - a coefficient in adaptive threshold formula - if `>0`, keep at most @p top_k picked indices. - - - - Performs non maximum suppression given boxes and corresponding scores. - - a set of bounding boxes to apply NMS. - a set of corresponding confidences. - a threshold used to filter boxes by score. - a threshold used in non maximum suppression. - the kept indices of bboxes after NMS. - a coefficient in adaptive threshold formula - if `>0`, keep at most @p top_k picked indices. - - - - Release a Myriad device is binded by OpenCV. - - Single Myriad device cannot be shared across multiple processes which uses Inference Engine's Myriad plugin. - - - - - - This class allows to create and manipulate comprehensive artificial neural networks. - - - Neural network is presented as directed acyclic graph(DAG), where vertices are Layer instances, - and edges specify relationships between layers inputs and outputs. - - Each network layer has unique integer id and unique string name inside its network. - LayerId can store either layer name or layer id. - This class supports reference counting of its instances, i.e.copies point to the same instance. - - - - - - Default constructor. - - - - - - - - - - - - - - - Create a network from Intel's Model Optimizer intermediate representation (IR). - Networks imported from Intel's Model Optimizer are launched in Intel's Inference Engine backend. - - XML configuration file with network's topology. - Binary file with trained weights. - - - - - Reads a network model stored in Darknet (https://pjreddie.com/darknet/) model files. - - path to the .cfg file with text description of the network architecture. - path to the .weights file with learned network. - Network object that ready to do forward, throw an exception in failure cases. - This is shortcut consisting from DarknetImporter and Net::populateNet calls. - - - - Reads a network model stored in Caffe model files from memory. - - A buffer contains a content of .cfg file with text description of the network architecture. - A buffer contains a content of .weights file with learned network. - - This is shortcut consisting from createCaffeImporter and Net::populateNet calls. - - - - Reads a network model stored in Caffe model files from memory. - - A buffer contains a content of .cfg file with text description of the network architecture. - A buffer contains a content of .weights file with learned network. - - This is shortcut consisting from createCaffeImporter and Net::populateNet calls. - - - - Reads a network model stored in Caffe model files. - - path to the .prototxt file with text description of the network architecture. - path to the .caffemodel file with learned network. - - This is shortcut consisting from createCaffeImporter and Net::populateNet calls. - - - - Reads a network model stored in Caffe model in memory. - - buffer containing the content of the .prototxt file - buffer containing the content of the .caffemodel file - - This is shortcut consisting from createCaffeImporter and Net::populateNet calls. - - - - Reads a network model stored in Caffe model files from memory. - - buffer containing the content of the .prototxt file - buffer containing the content of the .caffemodel file - - This is shortcut consisting from createCaffeImporter and Net::populateNet calls. - - - - Reads a network model stored in Tensorflow model file. - - path to the .pb file with binary protobuf description of the network architecture - path to the .pbtxt file that contains text graph definition in protobuf format. - Resulting Net object is built by text graph using weights from a binary one that - let us make it more flexible. - This is shortcut consisting from createTensorflowImporter and Net::populateNet calls. - - - - Reads a network model stored in Tensorflow model from memory. - - buffer containing the content of the pb file - buffer containing the content of the pbtxt file (optional) - - This is shortcut consisting from createTensorflowImporter and Net::populateNet calls. - - - - Reads a network model stored in Tensorflow model from memory. - - buffer containing the content of the pb file - buffer containing the content of the pbtxt file (optional) - - This is shortcut consisting from createTensorflowImporter and Net::populateNet calls. - - - - Reads a network model stored in Torch model file. - - - - - This is shortcut consisting from createTorchImporter and Net::populateNet calls. - - - - Read deep learning network represented in one of the supported formats. - - This function automatically detects an origin framework of trained model - and calls an appropriate function such @ref readNetFromCaffe, @ref readNetFromTensorflow, - - Binary file contains trained weights. The following file - * extensions are expected for models from different frameworks: - * * `*.caffemodel` (Caffe, http://caffe.berkeleyvision.org/) - * * `*.pb` (TensorFlow, https://www.tensorflow.org/) - * * `*.t7` | `*.net` (Torch, http://torch.ch/) - * * `*.weights` (Darknet, https://pjreddie.com/darknet/) - * * `*.bin` (DLDT, https://software.intel.com/openvino-toolkit) - Text file contains network configuration. It could be a - * file with the following extensions: - * * `*.prototxt` (Caffe, http://caffe.berkeleyvision.org/) - * * `*.pbtxt` (TensorFlow, https://www.tensorflow.org/) - * * `*.cfg` (Darknet, https://pjreddie.com/darknet/) - * * `*.xml` (DLDT, https://software.intel.com/openvino-toolkit) - Explicit framework name tag to determine a format. - - - - - Load a network from Intel's Model Optimizer intermediate representation. - Networks imported from Intel's Model Optimizer are launched in Intel's Inference Engine backend. - - XML configuration file with network's topology. - Binary file with trained weights. - - - - - Reads a network model ONNX https://onnx.ai/ - - path to the .onnx file with text description of the network architecture. - Network object that ready to do forward, throw an exception in failure cases. - - - - Reads a network model ONNX https://onnx.ai/ from memory - - memory of the first byte of the buffer. - Network object that ready to do forward, throw an exception in failure cases. - - - - Reads a network model ONNX https://onnx.ai/ from memory - - memory of the first byte of the buffer. - Network object that ready to do forward, throw an exception in failure cases. - - - - Returns true if there are no layers in the network. - - - - - - Dump net to String. - Call method after setInput(). To see correct backend, target and fusion run after forward(). - - String with structure, hyperparameters, backend, target and fusion - - - - Dump net structure, hyperparameters, backend, target and fusion to dot file - - path to output file with .dot extension - - - - Converts string name of the layer to the integer identifier. - - - id of the layer, or -1 if the layer wasn't found. - - - - - - - - - - Connects output of the first layer to input of the second layer. - - descriptor of the first layer output. - descriptor of the second layer input. - - - - Connects #@p outNum output of the first layer to #@p inNum input of the second layer. - - identifier of the first layer - identifier of the second layer - number of the first layer output - number of the second layer input - - - - Sets outputs names of the network input pseudo layer. - - - - * Each net always has special own the network input pseudo layer with id=0. - * This layer stores the user blobs only and don't make any computations. - * In fact, this layer provides the only way to pass user data into the network. - * As any other layer, this layer can label its outputs and this function provides an easy way to do this. - - - - - Runs forward pass to compute output of layer with name @p outputName. - By default runs forward pass for the whole network. - - name for layer which output is needed to get - blob for first output of specified layer. - - - - Runs forward pass to compute output of layer with name @p outputName. - - contains all output blobs for specified layer. - name for layer which output is needed to get. - If outputName is empty, runs forward pass for the whole network. - - - - Runs forward pass to compute outputs of layers listed in @p outBlobNames. - - contains blobs for first outputs of specified layers. - names for layers which outputs are needed to get - - - - Compile Halide layers. - Schedule layers that support Halide backend. Then compile them for - specific target.For layers that not represented in scheduling file - or if no manual scheduling used at all, automatic scheduling will be applied. - - Path to YAML file with scheduling directives. - - - - Ask network to use specific computation backend where it supported. - - backend identifier. - - - - Ask network to make computations on specific target device. - - target identifier. - - - - Sets the new value for the layer output blob - - new blob. - descriptor of the updating layer output blob. - - connect(String, String) to know format of the descriptor. - If updating blob is not empty then @p blob must have the same shape, - because network reshaping is not implemented yet. - - - - - Returns indexes of layers with unconnected outputs. - - - - - - Returns names of layers with unconnected outputs. - - - - - - Enables or disables layer fusion in the network. - - true to enable the fusion, false to disable. The fusion is enabled by default. - - - - Returns overall time for inference and timings (in ticks) for layers. - Indexes in returned vector correspond to layers ids.Some layers can be fused with others, - in this case zero ticks count will be return for that skipped layers. - - vector for tick timings for all layers. - overall ticks for model inference. - - - - Enum of target devices for computations. - - - - - FPGA device with CPU fallbacks using Inference Engine's Heterogeneous plugin. - - - - - A class to upscale images via convolutional neural networks. - The following four models are implemented: - - edsr - - espcn - - fsrcnn - - lapsrn - - - - - - Empty constructor - - - - - - Constructor which immediately sets the desired model - - String containing one of the desired models: - - edsr - - espcn - - fsrcnn - - lapsrn - Integer specifying the upscale factor - - - - - - - - - - - - - - Read the model from the given path - - Path to the model file. - - - - - Read the model from the given path - - Path to the model weights file. - Path to the model definition file. - - - - - Set desired model - - String containing one of the desired models: - - edsr - - espcn - - fsrcnn - - lapsrn - Integer specifying the upscale factor - - - - - Ask network to use specific computation backend where it supported. - - backend identifier. - - - - Ask network to make computations on specific target device. - - target identifier. - - - - Upsample via neural network - - Image to upscale - Destination upscaled image - - - - Upsample via neural network of multiple outputs - - Image to upscale - Destination upscaled images - Scaling factors of the output nodes - Names of the output nodes in the neural network - - - - Returns the scale factor of the model - - Current scale factor. - - - - Returns the scale factor of the model - - Current algorithm. - - - - Abstract base class for all facemark models. - - All facemark models in OpenCV are derived from the abstract base class Facemark, which - provides a unified access to all facemark algorithms in OpenCV. - To utilize this API in your program, please take a look at the @ref tutorial_table_of_content_facemark - - - - - A function to load the trained model before the fitting process. - - A string represent the filename of a trained model. - - - - Trains a Facemark algorithm using the given dataset. - - Input image. - Output of the function which represent region of interest of the detected faces. Each face is stored in cv::Rect container. - The detected landmark points for each faces. - - - - - - - - - - - - - - - - Releases managed resources - - - - - - - - - - - - - - - - - Constructor - - - - - Releases managed resources - - - - - filename of the model - - - - - - - - - - - - - - - - - - - - show the training print-out - - - - - flag to save the trained model or not - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Releases managed resources - - - - - - - - - - - - - - - - - Constructor - - - - - Releases managed resources - - - - - offset for the loaded face landmark points - - - - - filename of the face detector model - - - - - show the training print-out - - - - - number of landmark points - - - - - multiplier for augment the training data - - - - - number of refinement stages - - - - - number of tree in the model for each landmark point refinement - - - - - the depth of decision tree, defines the size of feature - - - - - overlap ratio for training the LBF feature - - - - - filename where the trained model will be saved - - - - - flag to save the trained model or not - - - - - seed for shuffling the training data - - - - - - - - - - - - - - - index of facemark points on pupils of left and right eye - - - - - index of facemark points on pupils of left and right eye - - - - - - - - - - - - - - - - - - - - - - base for two FaceRecognizer classes - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Training and prediction must be done on grayscale images, use cvtColor to convert between the - color spaces. - - **THE EIGENFACES METHOD MAKES THE ASSUMPTION, THAT THE TRAINING AND TEST IMAGES ARE OF EQUAL SIZE. - ** (caps-lock, because I got so many mails asking for this). You have to make sure your - input data has the correct shape, else a meaningful exception is thrown.Use resize to resize the images. - - This model does not support updating. - - - - - - - - - - - - - - - Releases managed resources - - - - - Training and prediction must be done on grayscale images, use cvtColor to convert between the - color spaces. - - **THE EIGENFACES METHOD MAKES THE ASSUMPTION, THAT THE TRAINING AND TEST IMAGES ARE OF EQUAL SIZE. - ** (caps-lock, because I got so many mails asking for this). You have to make sure your - input data has the correct shape, else a meaningful exception is thrown.Use resize to resize the images. - - This model does not support updating. - - The number of components (read: Eigenfaces) kept for this Principal Component Analysis. - As a hint: There's no rule how many components (read: Eigenfaces) should be kept for good reconstruction capabilities. - It is based on your input data, so experiment with the number. Keeping 80 components should almost always be sufficient. - The threshold applied in the prediction. - - - - - Abstract base class for all face recognition models. - All face recognition models in OpenCV are derived from the abstract base class FaceRecognizer, which - provides a unified access to all face recongition algorithms in OpenCV. - - - - - Trains a FaceRecognizer with given data and associated labels. - - - - - - - Updates a FaceRecognizer with given data and associated labels. - - - - - - - Gets a prediction from a FaceRecognizer. - - - - - - - Predicts the label and confidence for a given sample. - - - - - - - - Serializes this object to a given filename. - - - - - - Deserializes this object from a given filename. - - - - - - - Serializes this object to a given cv::FileStorage. - - - - - - - Deserializes this object from a given cv::FileNode. - - - - - - Sets string info for the specified model's label. - The string info is replaced by the provided value if it was set before for the specified label. - - - - - - - Gets string information by label. - If an unknown label id is provided or there is no label information associated with the specified - label id the method returns an empty string. - - - - - - - Gets vector of labels by string. - The function searches for the labels containing the specified sub-string in the associated string info. - - - - - - - threshold parameter accessor - required for default BestMinDist collector - - - - - - Sets threshold of model - - - - - - - Training and prediction must be done on grayscale images, use cvtColor to convert between the color spaces. - - **THE FISHERFACES METHOD MAKES THE ASSUMPTION, THAT THE TRAINING AND TEST IMAGES ARE OF EQUAL SIZE. - ** (caps-lock, because I got so many mails asking for this). You have to make sure your input data - has the correct shape, else a meaningful exception is thrown.Use resize to resize the images. - - This model does not support updating. - - - - - - - - - - - - - - - Releases managed resources - - - - - Training and prediction must be done on grayscale images, use cvtColor to convert between the color spaces. - - **THE FISHERFACES METHOD MAKES THE ASSUMPTION, THAT THE TRAINING AND TEST IMAGES ARE OF EQUAL SIZE. - ** (caps-lock, because I got so many mails asking for this). You have to make sure your input data - has the correct shape, else a meaningful exception is thrown.Use resize to resize the images. - - This model does not support updating. - - The number of components (read: Fisherfaces) kept for this Linear Discriminant Analysis - with the Fisherfaces criterion. It's useful to keep all components, that means the number of your classes c - (read: subjects, persons you want to recognize). If you leave this at the default (0) or set it - to a value less-equal 0 or greater (c-1), it will be set to the correct number (c-1) automatically. - The threshold applied in the prediction. If the distance to the nearest neighbor - is larger than the threshold, this method returns -1. - - - - - - The Circular Local Binary Patterns (used in training and prediction) expect the data given as - grayscale images, use cvtColor to convert between the color spaces. - This model supports updating. - - - - - - - - - - - - - - - Releases managed resources - - - - - The Circular Local Binary Patterns (used in training and prediction) expect the data given as - grayscale images, use cvtColor to convert between the color spaces. - This model supports updating. - - The radius used for building the Circular Local Binary Pattern. The greater the radius, the - The number of sample points to build a Circular Local Binary Pattern from. - An appropriate value is to use `8` sample points.Keep in mind: the more sample points you include, the higher the computational cost. - The number of cells in the horizontal direction, 8 is a common value used in publications. - The more cells, the finer the grid, the higher the dimensionality of the resulting feature vector. - The number of cells in the vertical direction, 8 is a common value used in publications. - The more cells, the finer the grid, the higher the dimensionality of the resulting feature vector. - The threshold applied in the prediction. If the distance to the nearest neighbor - is larger than the threshold, this method returns -1. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Detects corners using the AGAST algorithm - - - - - Constructor - - - - - The AgastFeatureDetector constructor - - threshold on difference between intensity of the central pixel - and pixels of a circle around this pixel. - if true, non-maximum suppression is applied to detected corners (keypoints). - - - - - Releases managed resources - - - - - threshold on difference between intensity of the central pixel and pixels of a circle around this pixel. - - - - - if true, non-maximum suppression is applied to detected corners (keypoints). - - - - - type one of the four neighborhoods as defined in the paper - - - - - AGAST type one of the four neighborhoods as defined in the paper - - - - - Class implementing the AKAZE keypoint detector and descriptor extractor, - described in @cite ANB13 - - - AKAZE descriptors can only be used with KAZE or AKAZE keypoints. - Try to avoid using *extract* and *detect* instead of *operator()* due to performance reasons. - .. [ANB13] Fast Explicit Diffusion for Accelerated Features in Nonlinear Scale - Spaces. Pablo F. Alcantarilla, Jesús Nuevo and Adrien Bartoli. - In British Machine Vision Conference (BMVC), Bristol, UK, September 2013. - - - - - Constructor - - - - - The AKAZE constructor - - Type of the extracted descriptor: DESCRIPTOR_KAZE, - DESCRIPTOR_KAZE_UPRIGHT, DESCRIPTOR_MLDB or DESCRIPTOR_MLDB_UPRIGHT. - Size of the descriptor in bits. 0 -> Full size - Number of channels in the descriptor (1, 2, 3) - Detector response threshold to accept point - Maximum octave evolution of the image - Default number of sublevels per scale level - Diffusivity type. DIFF_PM_G1, DIFF_PM_G2, DIFF_WEICKERT or DIFF_CHARBONNIER - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Brute-force descriptor matcher. - For each descriptor in the first set, this matcher finds the closest descriptor in the second set by trying each one. - - - - - - - - - - - - Creates instance by cv::Ptr<T> - - - - - Creates instance by raw pointer T* - - - - - Creates instance from cv::Ptr<T> . - ptr is disposed when the wrapper disposes. - - - - - - Releases managed resources - - - - - Releases managed resources - - - - - Return true if the matcher supports mask in match methods. - - - - - - Brute-force descriptor matcher. - For each descriptor in the first set, this matcher finds the closest descriptor in the second set by trying each one. - - - - - The constructor. - - Descriptor extractor that is used to compute descriptors for an input image and its keypoints. - Descriptor matcher that is used to find the nearest word of the trained vocabulary for each keypoint descriptor of the image. - - - - The constructor. - - Descriptor matcher that is used to find the nearest word of the trained vocabulary for each keypoint descriptor of the image. - - - - Releases unmanaged resources - - - - - Sets a visual vocabulary. - - Vocabulary (can be trained using the inheritor of BOWTrainer ). - Each row of the vocabulary is a visual word(cluster center). - - - - Returns the set vocabulary. - - - - - - Computes an image descriptor using the set visual vocabulary. - - Image, for which the descriptor is computed. - Keypoints detected in the input image. - Computed output image descriptor. - pointIdxsOfClusters Indices of keypoints that belong to the cluster. - This means that pointIdxsOfClusters[i] are keypoint indices that belong to the i -th cluster(word of vocabulary) returned if it is non-zero. - Descriptors of the image keypoints that are returned if they are non-zero. - - - - Computes an image descriptor using the set visual vocabulary. - - Computed descriptors to match with vocabulary. - Computed output image descriptor. - Indices of keypoints that belong to the cluster. - This means that pointIdxsOfClusters[i] are keypoint indices that belong to the i -th cluster(word of vocabulary) returned if it is non-zero. - - - - Computes an image descriptor using the set visual vocabulary. - - Image, for which the descriptor is computed. - Keypoints detected in the input image. - Computed output image descriptor. - - - - Returns an image descriptor size if the vocabulary is set. Otherwise, it returns 0. - - - - - - Returns an image descriptor type. - - - - - - Brute-force descriptor matcher. - For each descriptor in the first set, this matcher finds the closest descriptor in the second set by trying each one. - - - - - The constructor. - - - - - - - - - Releases unmanaged resources - - - - - Clusters train descriptors. - - - - - - Clusters train descriptors. - - Descriptors to cluster. Each row of the descriptors matrix is a descriptor. Descriptors are not added to the inner train descriptor set. - The vocabulary consists of cluster centers. So, this method returns the vocabulary. In the first variant of the method, train descriptors stored in the object - are clustered.In the second variant, input descriptors are clustered. - - - - - Brute-force descriptor matcher. - For each descriptor in the first set, this matcher finds the closest descriptor in the second set by trying each one. - - - - - Adds descriptors to a training set. - - descriptors Descriptors to add to a training set. Each row of the descriptors matrix is a descriptor. - The training set is clustered using clustermethod to construct the vocabulary. - - - - Returns a training set of descriptors. - - - - - - Returns the count of all descriptors stored in the training set. - - - - - - - - - - - Clusters train descriptors. - - - - - - Clusters train descriptors. - - Descriptors to cluster. Each row of the descriptors matrix is a descriptor. Descriptors are not added to the inner train descriptor set. - The vocabulary consists of cluster centers. So, this method returns the vocabulary. In the first variant of the method, train descriptors stored in the object - are clustered.In the second variant, input descriptors are clustered. - - - - - BRISK implementation - - - - - - - - - Construct from native cv::Ptr<T>* - - - - - - The BRISK constructor - - AGAST detection threshold score. - detection octaves. Use 0 to do single scale. - apply this scale to the pattern used for sampling the neighbourhood of a keypoint. - - - - The BRISK constructor for a custom pattern - - defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1). - defines the number of sampling points on the sampling circle. Must be the same size as radiusList.. - threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1). - threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1). - index remapping of the bits. - - - - - The BRISK constructor for a custom pattern, detection threshold and octaves - - AGAST detection threshold score. - detection octaves. Use 0 to do single scale. - defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1). - defines the number of sampling points on the sampling circle. Must be the same size as radiusList.. - threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1). - threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1). - index remapping of the bits. - - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - Create descriptor matcher by type name. - - - - - - - Creates instance from cv::Ptr<T> . - ptr is disposed when the wrapper disposes. - - - - - - Creates instance from raw pointer T* - - - - - - Releases managed resources - - - - - Add descriptors to train descriptor collection. - - Descriptors to add. Each descriptors[i] is a descriptors set from one image. - - - - Get train descriptors collection. - - - - - - Clear train descriptors collection. - - - - - Return true if there are not train descriptors in collection. - - - - - - Return true if the matcher supports mask in match methods. - - - - - - Train matcher (e.g. train flann index). - In all methods to match the method train() is run every time before matching. - Some descriptor matchers (e.g. BruteForceMatcher) have empty implementation - of this method, other matchers really train their inner structures - (e.g. FlannBasedMatcher trains flann::Index). So nonempty implementation - of train() should check the class object state and do traing/retraining - only if the state requires that (e.g. FlannBasedMatcher trains flann::Index - if it has not trained yet or if new descriptors have been added to the train collection). - - - - - Find one best match for each query descriptor (if mask is empty). - - - - - - - - - Find k best matches for each query descriptor (in increasing order of distances). - compactResult is used when mask is not empty. If compactResult is false matches - vector will have the same size as queryDescriptors rows. If compactResult is true - matches vector will not contain matches for fully masked out query descriptors. - - - - - - - - - - - Find best matches for each query descriptor which have distance less than - maxDistance (in increasing order of distances). - - - - - - - - - - - Find one best match for each query descriptor (if mask is empty). - - - - - - - - Find k best matches for each query descriptor (in increasing order of distances). - compactResult is used when mask is not empty. If compactResult is false matches - vector will have the same size as queryDescriptors rows. If compactResult is true - matches vector will not contain matches for fully masked out query descriptors. - - - - - - - - - - Find best matches for each query descriptor which have distance less than - maxDistance (in increasing order of distances). - - - - - - - - - - cv::AKAZE descriptor type - - - - - Upright descriptors, not invariant to rotation - - - - - - - - - - - - - - - Upright descriptors, not invariant to rotation - - - - - - - - - - Output image matrix will be created (Mat::create), - i.e. existing memory of output image may be reused. - Two source image, matches and single keypoints will be drawn. - For each keypoint only the center point will be drawn (without - the circle around keypoint with keypoint size and orientation). - - - - - Output image matrix will not be created (Mat::create). - Matches will be drawn on existing content of output image. - - - - - Single keypoints will not be drawn. - - - - - For each keypoint the circle around keypoint with keypoint size and - orientation will be drawn. - - - - - AGAST type one of the four neighborhoods as defined in the paper - - - - - cv::KAZE diffusivity type - - - - - - - - - - - - - - - - - - - - - - - - - cv::ORB score flags - - - - - - - - - - - - - - - Detects corners using FAST algorithm by E. Rosten - - - - - Constructor - - - - - Constructs FastFeatureDetector - - threshold on difference between intensity of the central pixel and pixels of a circle around this pixel. - if true, non-maximum suppression is applied to detected corners (keypoints). - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - Abstract base class for 2D image feature detectors and descriptor extractors - - - - - - - - - - - - - - - - - - - - - - - Return true if detector object is empty - - - - - - Detect keypoints in an image. - - The image. - Mask specifying where to look for keypoints (optional). - Must be a char matrix with non-zero values in the region of interest. - The detected keypoints. - - - - Detect keypoints in an image. - - The image. - Mask specifying where to look for keypoints (optional). - Must be a char matrix with non-zero values in the region of interest. - The detected keypoints. - - - - Detect keypoints in an image set. - - Image collection. - Masks for image set. masks[i] is a mask for images[i]. - Collection of keypoints detected in an input images. keypoints[i] is a set of keypoints detected in an images[i]. - - - - Compute the descriptors for a set of keypoints in an image. - - The image. - The input keypoints. Keypoints for which a descriptor cannot be computed are removed. - Computed descriptors. Row i is the descriptor for KeyPoint i.param> - - - - Compute the descriptors for a keypoints collection detected in image collection. - - Image collection. - Input keypoints collection. keypoints[i] is keypoints detected in images[i]. - Keypoints for which a descriptor cannot be computed are removed. - Descriptor collection. descriptors[i] are descriptors computed for set keypoints[i]. - - - - Detects keypoints and computes the descriptors - - - - - - - - - - - - - - - - - - - - - - - - - - - - Brute-force descriptor matcher. - For each descriptor in the first set, this matcher finds the closest descriptor in the second set by trying each one. - - - - - - - - - - - - Creates instance by cv::Ptr<T> - - - - - Creates instance by raw pointer T* - - - - - Creates instance from cv::Ptr<T> . - ptr is disposed when the wrapper disposes. - - - - - - Releases managed resources - - - - - Releases managed resources - - - - - Return true if the matcher supports mask in match methods. - - - - - - Add descriptors to train descriptor collection. - - Descriptors to add. Each descriptors[i] is a descriptors set from one image. - - - - Clear train descriptors collection. - - - - - Train matcher (e.g. train flann index). - In all methods to match the method train() is run every time before matching. - Some descriptor matchers (e.g. BruteForceMatcher) have empty implementation - of this method, other matchers really train their inner structures - (e.g. FlannBasedMatcher trains flann::Index). So nonempty implementation - of train() should check the class object state and do traing/retraining - only if the state requires that (e.g. FlannBasedMatcher trains flann::Index - if it has not trained yet or if new descriptors have been added to the train collection). - - - - - Good Features To Track Detector - - - - - Construct GFTT processor - - - - - - - - - - - Constructor - - - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Class implementing the KAZE keypoint detector and descriptor extractor - - - - - Constructor - - - - - The KAZE constructor - - Set to enable extraction of extended (128-byte) descriptor. - Set to enable use of upright descriptors (non rotation-invariant). - Detector response threshold to accept point - Maximum octave evolution of the image - Default number of sublevels per scale level - Diffusivity type. DIFF_PM_G1, DIFF_PM_G2, DIFF_WEICKERT or DIFF_CHARBONNIER - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A class filters a vector of keypoints. - - - - - Remove keypoints within borderPixels of an image edge. - - - - - - - - - Remove keypoints of sizes out of range. - - - - - - - - - Remove keypoints from some image by mask for pixels of this image. - - - - - - - - Remove duplicated keypoints. - - - - - - - Remove duplicated keypoints and sort the remaining keypoints - - - - - - - Retain the specified number of the best keypoints (according to the response) - - - - - - - - Maximal Stable Extremal Regions class - - - - - Creates instance by raw pointer cv::MSER* - - - - - Creates MSER parameters - - delta, in the code, it compares (size_{i}-size_{i-delta})/size_{i-delta} - prune the area which smaller than min_area - prune the area which bigger than max_area - prune the area have simliar size to its children - trace back to cut off mser with diversity < min_diversity - for color image, the evolution steps - the area threshold to cause re-initialize - ignore too small margin - the aperture size for edge blur - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - - - - - - Detect MSER regions - - input image (8UC1, 8UC3 or 8UC4, must be greater or equal than 3x3) - resulting list of point sets - resulting bounding boxes - - - - Class implementing the ORB (*oriented BRIEF*) keypoint detector and descriptor extractor. - - described in @cite RRKB11 . The algorithm uses FAST in pyramids to detect stable keypoints, selects - the strongest features using FAST or Harris response, finds their orientation using first-order - moments and computes the descriptors using BRIEF (where the coordinates of random point pairs (or - k-tuples) are rotated according to the measured orientation). - - - - - - - - - - The ORB constructor - - The maximum number of features to retain. - Pyramid decimation ratio, greater than 1. scaleFactor==2 means the classical - pyramid, where each next level has 4x less pixels than the previous, but such a big scale factor - will degrade feature matching scores dramatically. On the other hand, too close to 1 scale factor - will mean that to cover certain scale range you will need more pyramid levels and so the speed will suffer. - The number of pyramid levels. The smallest level will have linear size equal to - input_image_linear_size/pow(scaleFactor, nlevels - firstLevel). - This is size of the border where the features are not detected. It should - roughly match the patchSize parameter. - The level of pyramid to put source image to. Previous layers are filled - with upscaled source image. - The number of points that produce each element of the oriented BRIEF descriptor. The - default value 2 means the BRIEF where we take a random point pair and compare their brightnesses, - so we get 0/1 response. Other possible values are 3 and 4. For example, 3 means that we take 3 - random points (of course, those point coordinates are random, but they are generated from the - pre-defined seed, so each element of BRIEF descriptor is computed deterministically from the pixel - rectangle), find point of maximum brightness and output index of the winner (0, 1 or 2). Such - output will occupy 2 bits, and therefore it will need a special variant of Hamming distance, - denoted as NORM_HAMMING2 (2 bits per bin). When WTA_K=4, we take 4 random points to compute each - bin (that will also occupy 2 bits with possible values 0, 1, 2 or 3). - The default HARRIS_SCORE means that Harris algorithm is used to rank features - (the score is written to KeyPoint::score and is used to retain best nfeatures features); - FAST_SCORE is alternative value of the parameter that produces slightly less stable keypoints, - but it is a little faster to compute. - size of the patch used by the oriented BRIEF descriptor. Of course, on smaller - pyramid layers the perceived image area covered by a feature will be larger. - the fast threshold - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - SIFT implementation. - - - - - Creates instance by raw pointer cv::SIFT* - - - - - The SIFT constructor. - - The number of best features to retain. - The features are ranked by their scores (measured in SIFT algorithm as the local contrast) - The number of layers in each octave. 3 is the value used in D. Lowe paper. - The number of octaves is computed automatically from the image resolution. - The contrast threshold used to filter out weak features in semi-uniform - (low-contrast) regions. The larger the threshold, the less features are produced by the detector. - The threshold used to filter out edge-like features. Note that the its meaning is - different from the contrastThreshold, i.e. the larger the edgeThreshold, the less features are filtered out (more features are retained). - The sigma of the Gaussian applied to the input image at the octave #0. - If your image is captured with a weak camera with soft lenses, you might want to reduce the number. - - - - Releases managed resources - - - - - Class for extracting blobs from an image. - - - - - SimpleBlobDetector parameters - - - - - - - - - - Constructor - - - - - Construct a SimpleBlobDetector instance - - - - - - Releases managed resources - - - - - The algorithm to use for selecting the initial centers when performing a k-means clustering step. - - - - - picks the initial cluster centers randomly - [flann_centers_init_t::CENTERS_RANDOM] - - - - - picks the initial centers using Gonzales’ algorithm - [flann_centers_init_t::CENTERS_GONZALES] - - - - - picks the initial centers using the algorithm suggested in [arthur_kmeanspp_2007] - [flann_centers_init_t::CENTERS_KMEANSPP] - - - - - The FLANN nearest neighbor index class. - - - - - Constructs a nearest neighbor search index for a given dataset. - - features – Matrix of type CV _ 32F containing the features(points) to index. The size of the matrix is num _ features x feature _ dimensionality. - Structure containing the index parameters. The type of index that will be constructed depends on the type of this parameter. - - - - - Releases unmanaged resources - - - - - Performs a K-nearest neighbor search for multiple query points. - - The query points, one per row - Indices of the nearest neighbors found - Distances to the nearest neighbors found - Number of nearest neighbors to search for - Search parameters - - - - Performs a K-nearest neighbor search for multiple query points. - - The query points, one per row - Indices of the nearest neighbors found - Distances to the nearest neighbors found - Number of nearest neighbors to search for - Search parameters - - - - Performs a K-nearest neighbor search for multiple query points. - - The query points, one per row - Indices of the nearest neighbors found - Distances to the nearest neighbors found - Number of nearest neighbors to search for - Search parameters - - - - Performs a radius nearest neighbor search for a given query point. - - The query point - Indices of the nearest neighbors found - Distances to the nearest neighbors found - Number of nearest neighbors to search for - - Search parameters - - - - Performs a radius nearest neighbor search for a given query point. - - The query point - Indices of the nearest neighbors found - Distances to the nearest neighbors found - Number of nearest neighbors to search for - - Search parameters - - - - Performs a radius nearest neighbor search for a given query point. - - The query point - Indices of the nearest neighbors found - Distances to the nearest neighbors found - Number of nearest neighbors to search for - - Search parameters - - - - Saves the index to a file. - - The file to save the index to - - - - hierarchical k-means tree. - - - - - - - Is a number between 0 and 1 specifying the percentage of the approximate nearest-neighbor searches that return the exact nearest-neighbor. - Using a higher value for this parameter gives more accurate results, but the search takes longer. The optimum value usually depends on the application. - Specifies the importance of the index build time raported to the nearest-neighbor search time. - In some applications it’s acceptable for the index build step to take a long time if the subsequent searches in the index can be performed very fast. - In other applications it’s required that the index be build as fast as possible even if that leads to slightly longer search times. - Is used to specify the tradeoff between time (index build time and search time) and memory used by the index. - A value less than 1 gives more importance to the time spent and a value greater than 1 gives more importance to the memory usage. - Is a number between 0 and 1 indicating what fraction of the dataset to use in the automatic parameter configuration algorithm. - Running the algorithm on the full dataset gives the most accurate results, but for very large datasets can take longer than desired. - In such case using just a fraction of the data helps speeding up this algorithm while still giving good approximations of the optimum parameters. - - - - - - - - - When using a parameters object of this type the index created combines the randomized kd-trees and the hierarchical k-means tree. - - - - - - - The number of parallel kd-trees to use. Good values are in the range [1..16] - The branching factor to use for the hierarchical k-means tree - The maximum number of iterations to use in the k-means clustering stage when building the k-means tree. A value of -1 used here means that the k-means clustering should be iterated until convergence - The algorithm to use for selecting the initial centers when performing a k-means clustering step. - This parameter (cluster boundary index) influences the way exploration is performed in the hierarchical kmeans tree. When cb_index is zero the next kmeans domain to be explored is choosen to be the one with the closest center. A value greater then zero also takes into account the size of the domain. - - - - - - - - - - - - - - - - - - - - - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - When passing an object of this type the index constructed will consist of a set - of randomized kd-trees which will be searched in parallel. - - - - - Constructor - - The number of parallel kd-trees to use. Good values are in the range [1..16] - - - - - - - - - When passing an object of this type the index constructed will be a hierarchical k-means tree. - - - - - Constructor - - The branching factor to use for the hierarchical k-means tree - The maximum number of iterations to use in the k-means clustering stage when building the k-means tree. A value of -1 used here means that the k-means clustering should be iterated until convergence - The algorithm to use for selecting the initial centers when performing a k-means clustering step. - This parameter (cluster boundary index) influences the way exploration is performed in the hierarchical kmeans tree. When cb_index is zero the next kmeans domain to be explored is choosen to be the one with the closest center. A value greater then zero also takes into account the size of the domain. - - - - - - - - - the index will perform a linear, brute-force search. - - - - - Constructor - - - - - - - - - - When using a parameters object of this type the index created uses multi-probe LSH (by Multi-Probe LSH: Efficient Indexing for High-Dimensional Similarity Search by Qin Lv, William Josephson, Zhe Wang, Moses Charikar, Kai Li., Proceedings of the 33rd International Conference on Very Large Data Bases (VLDB). Vienna, Austria. September 2007) - - - - - Constructor - - The number of hash tables to use (between 10 and 30 usually). - The size of the hash key in bits (between 10 and 20 usually). - The number of bits to shift to check for neighboring buckets (0 is regular LSH, 2 is recommended). - - - - - - - - - This object type is used for loading a previously saved index from the disk. - - - - - Constructor - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Trackbar that is shown on OpenCV Window - - - - - Name of this trackbar - - - - - Name of parent window - - - - - - - - - - Gets or sets a numeric value that represents the current position of the scroll box on the track bar. - - - - - Result value of cv::createTrackbar - - - - - Constructor (value=0, max=100) - - Trackbar name - Window name - Callback handler - - - - Constructor - - Trackbar name - Window name - Initial slider position - The upper limit of the range this trackbar is working with. - Callback handler - - - - Releases unmanaged resources - - - - - Sets the trackbar maximum position. - The function sets the maximum position of the specified trackbar in the specified window. - - New maximum position. - - - - Sets the trackbar minimum position. - The function sets the minimum position of the specified trackbar in the specified window. - - New minimum position. - - - - Button type flags (cv::createButton) - - - - - The button will be a push button. - - - - - The button will be a checkbox button. - - - - - The button will be a radiobox button. The radiobox on the same buttonbar (same line) are exclusive; one on can be select at the time. - - - - - Mouse Event Flags see cv::MouseCallback - - - - - indicates that the left mouse button is down. - - - - - indicates that the right mouse button is down. - - - - - indicates that the middle mouse button is down. - - - - - indicates that CTRL Key is pressed. - - - - - indicates that SHIFT Key is pressed. - - - - - indicates that ALT Key is pressed. - - - - - Mouse Events - - - - - indicates that the mouse pointer has moved over the window. - - - - - indicates that the left mouse button is pressed. - - - - - indicates that the right mouse button is pressed. - - - - - indicates that the middle mouse button is pressed. - - - - - indicates that left mouse button is released. - - - - - indicates that right mouse button is released. - - - - - indicates that middle mouse button is released. - - - - - indicates that left mouse button is double clicked. - - - - - indicates that right mouse button is double clicked. - - - - - indicates that middle mouse button is double clicked. - - - - - positive and negative values mean forward and backward scrolling, respectively. - - - - - positive and negative values mean right and left scrolling, respectively. - - - - - Flags for cv::namedWindow - - - - - the user can resize the window (no constraint) / - also use to switch a fullscreen window to a normal size - - - - - the user cannot resize the window, the size is constrainted by the image displayed. - - - - - window with opengl support - - - - - change the window to fullscreen - - - - - the image expends as much as it can (no ratio constraint) - - - - - the ratio of the image is respected - - - - - status bar and tool bar - - - - - old fashious way - - - - - Property identifiers for cvGetWindowProperty/cvSetWindowProperty - - - - - fullscreen property (can be WINDOW_NORMAL or WINDOW_FULLSCREEN) - - - - - autosize property (can be WINDOW_NORMAL or WINDOW_AUTOSIZE) - - - - - window's aspect ration (can be set to WINDOW_FREERATIO or WINDOW_KEEPRATIO) - - - - - opengl support - - - - - checks whether the window exists and is visible - - - - - property to toggle normal window being topmost or not - - - - - Delegate to be called every time mouse event occurs in the specified window. - - one of MouseEventTypes - x-coordinates of mouse pointer in image coordinates - y-coordinates of mouse pointer in image coordinates - a combination of MouseEventFlags - - - - - Delegate to be called every time the slider changes the position. - - - - - - - - - - - - - Wrapper of HighGUI window - - - - - Creates a window with a random name - - - - - Creates a window - - Name of the window which is used as window identifier and appears in the window caption. - - - - Creates a window - - Name of the window which is used as window identifier and appears in the window caption. - Flags of the window. Currently the only supported flag is WindowMode.AutoSize. - If it is set, window size is automatically adjusted to fit the displayed image (see cvShowImage), while user can not change the window size manually. - - - - Creates a window - - Name of the window which is used as window identifier and appears in the window caption. - Image to be shown. - - - - Creates a window - - Name of the window which is used as window identifier and appears in the window caption. - Image to be shown. - Flags of the window. Currently the only supported flag is WindowMode.AutoSize. - If it is set, window size is automatically adjusted to fit the displayed image (see cvShowImage), while user can not change the window size manually. - - - - ウィンドウ名が指定されなかったときに、適当な名前を作成して返す. - - - - - - Releases managed resources - - - - - Destroys this window. - - - - - Destroys all the opened HighGUI windows. - - - - - Gets or sets an image to be shown - - - - - Gets window name - - - - - - - - - - Creates the trackbar and attaches it to this window - - Name of created trackbar. - the function to be called every time the slider changes the position. This function should be prototyped as void Foo(int); - - - - - Creates the trackbar and attaches it to this window - - Name of created trackbar. - The position of the slider - Maximal position of the slider. Minimal position is always 0. - the function to be called every time the slider changes the position. This function should be prototyped as void Foo(int); - - - - - Display text on the window's image as an overlay for delay milliseconds. This is not editing the image's data. The text is display on the top of the image. - - Overlay text to write on the window’s image - Delay to display the overlay text. If this function is called before the previous overlay text time out, the timer is restarted and the text updated. - If this value is zero, the text never disappears. - - - - - - Text to write on the window’s statusbar - Delay to display the text. If this function is called before the previous text time out, the timer is restarted and the text updated. If this value is zero, the text never disapers. - - - - Get Property of the window - - Property identifier - Value of the specified property - - - - Sets window position - - New x coordinate of top-left corner - New y coordinate of top-left corner - - - - Sets window size - - New width - New height - - - - Set Property of the window - - Property identifier - New value of the specified property - - - - Shows the image in this window - - Image to be shown. - - - - Shows the image in this window - - Image to be shown. - - - - get native window handle (HWND in case of Win32 and Widget in case of X Window) - - - - - Waits for a pressed key - - Delay in milliseconds. - Key code - - - - Waits for a pressed key. - Similar to #waitKey, but returns full key code. - Key code is implementation specific and depends on used backend: QT/GTK/Win32/etc - - Delay in milliseconds. 0 is the special value that means ”forever” - Returns the code of the pressed key or -1 if no key was pressed before the specified time had elapsed. - - - - - - - - - - - - - - - - - Retrieves a created window by name - - - - - - - Sets the callback function for mouse events occuting within the specified window. - - Reference to the function to be called every time mouse event occurs in the specified window. - - - - - - - - - - - - - - - - - - - - - - - - - Specifies colorness and Depth of the loaded image - - - - - If set, return the loaded image as is (with alpha channel, otherwise it gets cropped). - - - - - If set, always convert image to the single channel grayscale image. - - - - - If set, always convert image to the 3 channel BGR color image. - - - - - If set, return 16-bit/32-bit image when the input has the corresponding depth, otherwise convert it to 8-bit. - - - - - If set, the image is read in any possible color format. - - - - - If set, use the gdal driver for loading the image. - - - - - If set, always convert image to the single channel grayscale image and the image size reduced 1/2. - - - - - If set, always convert image to the 3 channel BGR color image and the image size reduced 1/2. - - - - - If set, always convert image to the single channel grayscale image and the image size reduced 1/4. - - - - - If set, always convert image to the 3 channel BGR color image and the image size reduced 1/4. - - - - - If set, always convert image to the single channel grayscale image and the image size reduced 1/8. - - - - - If set, always convert image to the 3 channel BGR color image and the image size reduced 1/8. - - - - - If set, do not rotate the image according to EXIF's orientation flag. - - - - - - - - - - store as HALF (FP16) - - - - - store as FP32 (default) - - - - - The format type IDs for cv::imwrite and cv::inencode - - - - - For JPEG, it can be a quality from 0 to 100 (the higher is the better). Default value is 95. - - - - - Enable JPEG features, 0 or 1, default is False. - - - - - Enable JPEG features, 0 or 1, default is False. - - - - - JPEG restart interval, 0 - 65535, default is 0 - no restart. - - - - - Separate luma quality level, 0 - 100, default is 0 - don't use. - - - - - Separate chroma quality level, 0 - 100, default is 0 - don't use. - - - - - For PNG, it can be the compression level from 0 to 9. - A higher value means a smaller size and longer compression time. Default value is 3. - - - - - One of cv::ImwritePNGFlags, default is IMWRITE_PNG_StrategyDEFAULT. - - - - - Binary level PNG, 0 or 1, default is 0. - - - - - For PPM, PGM, or PBM, it can be a binary format flag, 0 or 1. Default value is 1. - - - - - [48] override EXR storage type (FLOAT (FP32) is default) - - - - - For WEBP, it can be a quality from 1 to 100 (the higher is the better). By default (without any parameter) and for quality above 100 the lossless compression is used. - - - - - For PAM, sets the TUPLETYPE field to the corresponding string value that is defined for the format - - - - - For TIFF, use to specify which DPI resolution unit to set; see libtiff documentation for valid values - - - - - For TIFF, use to specify the X direction DPI - - - - - For TIFF, use to specify the Y direction DPI - - - - - For TIFF, use to specify the image compression scheme. - See libtiff for integer constants corresponding to compression formats. - Note, for images whose depth is CV_32F, only libtiff's SGILOG compression scheme is used. - For other supported depths, the compression scheme can be specified by this flag; LZW compression is the default. - - - - - For JPEG2000, use to specify the target compression rate (multiplied by 1000). - The value can be from 0 to 1000. Default is 1000. - - - - - Imwrite PAM specific tupletype flags used to define the 'TUPETYPE' field of a PAM file. - - - - - Imwrite PNG specific flags used to tune the compression algorithm. - - These flags will be modify the way of PNG image compression and will be passed to the underlying zlib processing stage. - The effect of IMWRITE_PNG_StrategyFILTERED is to force more Huffman coding and less string matching; it is somewhat - intermediate between IMWRITE_PNG_StrategyDEFAULT and IMWRITE_PNG_StrategyHUFFMAN_ONLY. - IMWRITE_PNG_StrategyRLE is designed to be almost as fast as IMWRITE_PNG_StrategyHUFFMAN_ONLY, but give better compression for PNG - image data. The strategy parameter only affects the compression ratio but not the correctness of the compressed output even - if it is not set appropriately. IMWRITE_PNG_StrategyFIXED prevents the use of dynamic Huffman codes, allowing for a simpler - decoder for special applications. - - - - - Use this value for normal data. - - - - - Use this value for data produced by a filter (or predictor).Filtered data consists mostly of small values with a somewhat - random distribution. In this case, the compression algorithm is tuned to compress them better. - - - - - Use this value to force Huffman encoding only (no string match). - - - - - Use this value to limit match distances to one (run-length encoding). - - - - - Using this value prevents the use of dynamic Huffman codes, allowing for a simpler decoder for special applications. - - - - - The format-specific save parameters for cv::imwrite and cv::imencode - - - - - format type ID - - - - - value of parameter - - - - - Constructor - - format type ID - value of parameter - - - - Contrast Limited Adaptive Histogram Equalization - - - - - cv::Ptr<CLAHE> - - - - - - - - - - Creates a predefined CLAHE object - - - - - - - - Releases managed resources - - - - - Equalizes the histogram of a grayscale image using Contrast Limited Adaptive Histogram Equalization. - - Source image of type CV_8UC1 or CV_16UC1. - Destination image. - - - - Gets or sets threshold for contrast limiting. - - - - - Gets or sets size of grid for histogram equalization. Input image will be divided into equally sized rectangular tiles. - - - - - - - - - - connected components that is returned from Cv2.ConnectedComponentsEx - - - - - All blobs - - - - - destination labeled value - - - - - The number of labels -1 - - - - - Constructor - - - - - - - - Filter a image with the specified label value. - - Source image. - Destination image. - Label value. - Filtered image. - - - - Filter a image with the specified label values. - - Source image. - Destination image. - Label values. - Filtered image. - - - - Filter a image with the specified blob object. - - Source image. - Destination image. - Blob value. - Filtered image. - - - - Filter a image with the specified blob objects. - - Source image. - Destination image. - Blob values. - Filtered image. - - - - Draws all blobs to the specified image. - - The target image to be drawn. - - - - Find the largest blob. - - the largest blob - - - - 指定したラベル値のところのみを非0で残したマスク画像を返す - - - - - - - One blob - - - - - Label value - - - - - Floating point centroid (x,y) - - - - - The leftmost (x) coordinate which is the inclusive start of the bounding box in the horizontal direction. - - - - - The topmost (y) coordinate which is the inclusive start of the bounding box in the vertical direction. - - - - - The horizontal size of the bounding box. - - - - - The vertical size of the bounding box. - - - - - The bounding box. - - - - - The total area (in pixels) of the connected component. - - - - - Adaptive thresholding algorithms - - - https://github.com/opencv/opencv/blob/d3bc563c6e01c2bc153f23e7393322a95c7d3974/modules/imgproc/include/opencv2/imgproc.hpp#L333 - - - - - It is a mean of block_size × block_size pixel neighborhood, subtracted by param1. - - - - - it is a weighted sum (Gaussian) of block_size × block_size pixel neighborhood, subtracted by param1. - - - - - Color conversion operation for cv::cvtColor - - - https://github.com/opencv/opencv/blob/d3bc563c6e01c2bc153f23e7393322a95c7d3974/modules/imgproc/include/opencv2/imgproc.hpp#L528 - - - - - GNU Octave/MATLAB equivalent colormaps - - - - - connected components algorithm - - - - - SAUF algorithm for 8-way connectivity, SAUF algorithm for 4-way connectivity - - - - - BBDT algorithm for 8-way connectivity, SAUF algorithm for 4-way connectivity - - - - - BBDT algorithm for 8-way connectivity, SAUF algorithm for 4-way connectivity - - - - - Spaghetti @cite Bolelli2019 algorithm for 8-way connectivity, SAUF algorithm for 4-way connectivity. - - - - - Same as CCL_WU. It is preferable to use the flag with the name of the algorithm (CCL_SAUF) rather than the one with the name of the first author (CCL_WU). - - - - - Same as CCL_GRANA. It is preferable to use the flag with the name of the algorithm (CCL_BBDT) rather than the one with the name of the first author (CCL_GRANA). - - - - - Same as CCL_BOLELLI. It is preferable to use the flag with the name of the algorithm (CCL_SPAGHETTI) rather than the one with the name of the first author (CCL_BOLELLI). - - - - - components algorithm output formats - - - - - The leftmost (x) coordinate which is the inclusive start of the bounding - box in the horizontal direction. - - - - - The topmost (y) coordinate which is the inclusive start of the bounding - box in the vertical direction. - - - - - The horizontal size of the bounding box - - - - - The vertical size of the bounding box - - - - - The total area (in pixels) of the connected component - - - - - Approximation method (for all the modes, except CV_RETR_RUNS, which uses built-in approximation). - - - https://github.com/opencv/opencv/blob/d3bc563c6e01c2bc153f23e7393322a95c7d3974/modules/imgproc/include/opencv2/imgproc.hpp#L431 - - - - - CHAIN_APPROX_NONE - translate all the points from the chain code into points; - - - - - CHAIN_APPROX_SIMPLE - compress horizontal, vertical, and diagonal segments, that is, the function leaves only their ending points; - - - - - CHAIN_APPROX_TC89_L1 - apply one of the flavors of Teh-Chin chain approximation algorithm. - - - - - CHAIN_APPROX_TC89_KCOS - apply one of the flavors of Teh-Chin chain approximation algorithm. - - - - - distanceTransform algorithm flags - - - - - each connected component of zeros in src - (as well as all the non-zero pixels closest to the connected component) - will be assigned the same label - - - - - each zero pixel (and all the non-zero pixels closest to it) gets its own label. - - - - - Mask size for distance transform - - - https://github.com/opencv/opencv/blob/d3bc563c6e01c2bc153f23e7393322a95c7d3974/modules/imgproc/include/opencv2/imgproc.hpp#L312 - - - - - 3 - - - - - 5 - - - - - - - - - - Type of distance for cvDistTransform - - - https://github.com/opencv/opencv/blob/d3bc563c6e01c2bc153f23e7393322a95c7d3974/modules/imgproc/include/opencv2/imgproc.hpp#L300 - - - - - User defined distance [CV_DIST_USER] - - - - - distance = |x1-x2| + |y1-y2| [CV_DIST_L1] - - - - - the simple euclidean distance [CV_DIST_L2] - - - - - distance = max(|x1-x2|,|y1-y2|) [CV_DIST_C] - - - - - L1-L2 metric: distance = 2(sqrt(1+x*x/2) - 1)) [CV_DIST_L12] - - - - - distance = c^2(|x|/c-log(1+|x|/c)), c = 1.3998 [CV_DIST_FAIR] - - - - - distance = c^2/2(1-exp(-(x/c)^2)), c = 2.9846 [CV_DIST_WELSCH] - - - - - distance = |x|<c ? x^2/2 : c(|x|-c/2), c=1.345 [CV_DIST_HUBER] - - - - - Specifies how to flip the array - - - - - means flipping around x-axis - - - - - means flipping around y-axis - - - - - means flipping around both axises - - - - - floodFill Operation flags. Lower bits contain a connectivity value, 4 (default) or 8, used within the function. Connectivity determines which neighbors of a pixel are considered. Upper bits can be 0 or a combination of the following flags: - - - - - 4-connected line. - [= 4] - - - - - 8-connected line. - [= 8] - - - - - If set, the difference between the current pixel and seed pixel is considered. Otherwise, the difference between neighbor pixels is considered (that is, the range is floating). - [CV_FLOODFILL_FIXED_RANGE] - - - - - If set, the function does not change the image ( newVal is ignored), but fills the mask. The flag can be used for the second variant only. - [CV_FLOODFILL_MASK_ONLY] - - - - - class of the pixel in GrabCut algorithm - - - - - an obvious background pixels - - - - - an obvious foreground (object) pixel - - - - - a possible background pixel - - - - - a possible foreground pixel - - - - - GrabCut algorithm flags - - - - - The function initializes the state and the mask using the provided rectangle. - After that it runs iterCount iterations of the algorithm. - - - - - The function initializes the state using the provided mask. - Note that GC_INIT_WITH_RECT and GC_INIT_WITH_MASK can be combined. - Then, all the pixels outside of the ROI are automatically initialized with GC_BGD . - - - - - The value means that the algorithm should just resume. - - - - - Comparison methods for cvCompareHist - - - https://github.com/opencv/opencv/blob/d3bc563c6e01c2bc153f23e7393322a95c7d3974/modules/imgproc/include/opencv2/imgproc.hpp#L497 - - - - - Correlation [CV_COMP_CORREL] - - - - - Chi-Square [CV_COMP_CHISQR] - - - - - Intersection [CV_COMP_INTERSECT] - - - - - Bhattacharyya distance [CV_COMP_BHATTACHARYYA] - - - - - Synonym for HISTCMP_BHATTACHARYYA - - - - - Alternative Chi-Square - \f[d(H_1,H_2) = 2 * \sum _I \frac{\left(H_1(I)-H_2(I)\right)^2}{H_1(I)+H_2(I)}\f] - This alternative formula is regularly used for texture comparison. See e.g. @cite Puzicha1997 - - - - - Kullback-Leibler divergence - \f[d(H_1,H_2) = \sum _I H_1(I) \log \left(\frac{H_1(I)}{H_2(I)}\right)\f] - - - - - Variants of a Hough transform - - - https://github.com/opencv/opencv/blob/d3bc563c6e01c2bc153f23e7393322a95c7d3974/modules/imgproc/include/opencv2/imgproc.hpp#L465 - - - - - classical or standard Hough transform. - Every line is represented by two floating-point numbers \f$(\rho, \theta)\f$ , - where \f$\rho\f$ is a distance between (0,0) point and the line, - and \f$\theta\f$ is the angle between x-axis and the normal to the line. - Thus, the matrix must be (the created sequence will be) of CV_32FC2 type - - - - - probabilistic Hough transform (more efficient in case if the picture contains - a few long linear segments). It returns line segments rather than the whole line. - Each segment is represented by starting and ending points, and the matrix must be - (the created sequence will be) of the CV_32SC4 type. - - - - - multi-scale variant of the classical Hough transform. - The lines are encoded the same way as HOUGH_STANDARD. - - - - - basically *21HT*, described in @cite Yuen90 - - - - - variation of HOUGH_GRADIENT to get better accuracy - - - - - Interpolation algorithm - - - - - Nearest-neighbor interpolation, - - - - - Bilinear interpolation (used by default) - - - - - Bicubic interpolation. - - - - - Resampling using pixel area relation. It is the preferred method for image decimation that gives moire-free results. In case of zooming it is similar to CV_INTER_NN method. - - - - - Lanczos interpolation over 8x8 neighborhood - - - - - Bit exact bilinear interpolation - - - - - mask for interpolation codes - - - - - Fill all the destination image pixels. If some of them correspond to outliers in the source image, they are set to fillval. - - - - - Indicates that matrix is inverse transform from destination image to source and, - thus, can be used directly for pixel interpolation. Otherwise, the function finds the inverse transform from map_matrix. - - - - - Variants of Line Segment %Detector - - - - - No refinement applied - - - - - Standard refinement is applied. E.g. breaking arches into smaller straighter line approximations. - - - - - Advanced refinement. Number of false alarms is calculated, lines are - refined through increase of precision, decrement in size, etc. - - - - - Type of the line - - - https://github.com/opencv/opencv/blob/d3bc563c6e01c2bc153f23e7393322a95c7d3974/modules/imgproc/include/opencv2/imgproc.hpp#L808 - - - - - 8-connected line. - - - - - 4-connected line. - - - - - Anti-aliased line. - - - - - Possible set of marker types used for the cv::drawMarker function - - - - - A crosshair marker shape - - - - - A 45 degree tilted crosshair marker shape - - - - - A star marker shape, combination of cross and tilted cross - - - - - A diamond marker shape - - - - - A square marker shape - - - - - An upwards pointing triangle marker shape - - - - - A downwards pointing triangle marker shape - - - - - Shape of the structuring element - - - https://github.com/opencv/opencv/blob/d3bc563c6e01c2bc153f23e7393322a95c7d3974/modules/imgproc/include/opencv2/imgproc.hpp#L231 - - - - - A rectangular element - - - - - A cross-shaped element - - - - - An elliptic element - - - - - Type of morphological operation - - - - - - - - - - - - - - - an opening operation - - - - - a closing operation - - - - - Morphological gradient - - - - - "Top hat" - - - - - "Black hat" - - - - - "hit and miss" - - - - - PixelConnectivity for LineIterator - - - - - Connectivity 4 (N,S,E,W) - - - - - Connectivity 8 (N,S,E,W,NE,SE,SW,NW) - - - - - types of intersection between rectangles - - - - - No intersection - - - - - There is a partial intersection - - - - - One of the rectangle is fully enclosed in the other - - - - - mode of the contour retrieval algorithm - - - https://github.com/opencv/opencv/blob/d3bc563c6e01c2bc153f23e7393322a95c7d3974/modules/imgproc/include/opencv2/imgproc.hpp#L414 - - - - - retrieves only the extreme outer contours. - It sets `hierarchy[i][2]=hierarchy[i][3]=-1` for all the contours. - - - - - retrieves all of the contours without establishing any hierarchical relationships. - - - - - retrieves all of the contours and organizes them into a two-level hierarchy. - At the top level, there are external boundaries of the components. - At the second level, there are boundaries of the holes. If there is another - contour inside a hole of a connected component, it is still put at the top level. - - - - - retrieves all of the contours and reconstructs a full hierarchy - of nested contours. - - - - - - - - - - Comparison methods for cv::matchShapes - - - https://github.com/opencv/opencv/blob/d3bc563c6e01c2bc153f23e7393322a95c7d3974/modules/imgproc/include/opencv2/imgproc.hpp#L453 - - - - - \f[I_1(A,B) = \sum _{i=1...7} \left | \frac{1}{m^A_i} - \frac{1}{m^B_i} \right |\f] - - - - - \f[I_2(A,B) = \sum _{i=1...7} \left | m^A_i - m^B_i \right |\f] - - - - - \f[I_3(A,B) = \max _{i=1...7} \frac{ \left| m^A_i - m^B_i \right| }{ \left| m^A_i \right| }\f] - - - - - Specifies the way the template must be compared with image regions - - - https://github.com/opencv/opencv/blob/d3bc563c6e01c2bc153f23e7393322a95c7d3974/modules/imgproc/include/opencv2/imgproc.hpp#L3672 - - - - - \f[R(x,y)= \sum _{x',y'} (T(x',y')-I(x+x',y+y'))^2\f] - - - - - \f[R(x,y)= \frac{\sum_{x',y'} (T(x',y')-I(x+x',y+y'))^2}{\sqrt{\sum_{x',y'}T(x',y')^2 \cdot \sum_{x',y'} I(x+x',y+y')^2}}\f] - - - - - \f[R(x,y)= \sum _{x',y'} (T(x',y') \cdot I(x+x',y+y'))\f] - - - - - \f[R(x,y)= \frac{\sum_{x',y'} (T(x',y') \cdot I(x+x',y+y'))}{\sqrt{\sum_{x',y'}T(x',y')^2 \cdot \sum_{x',y'} I(x+x',y+y')^2}}\f] - - - - - \f[R(x,y)= \sum _{x',y'} (T'(x',y') \cdot I'(x+x',y+y'))\f] - where - \f[\begin{array}{l} T'(x',y')=T(x',y') - 1/(w \cdot h) \cdot \sum _{x'',y''} T(x'',y'') \\ I'(x+x',y+y')=I(x+x',y+y') - 1/(w \cdot h) \cdot \sum _{x'',y''} I(x+x'',y+y'') \end{array}\f] - - - - - \f[R(x,y)= \frac{ \sum_{x',y'} (T'(x',y') \cdot I'(x+x',y+y')) }{ \sqrt{\sum_{x',y'}T'(x',y')^2 \cdot \sum_{x',y'} I'(x+x',y+y')^2} }\f] - - - - - Thresholding type - - - - - \f[\texttt{dst} (x,y) = \fork{\texttt{maxval}}{if \(\texttt{src}(x,y) > \texttt{thresh}\)}{0}{otherwise}\f] - - - - - \f[\texttt{dst} (x,y) = \fork{0}{if \(\texttt{src}(x,y) > \texttt{thresh}\)}{\texttt{maxval}}{otherwise}\f] - - - - - \f[\texttt{dst} (x,y) = \fork{\texttt{threshold}}{if \(\texttt{src}(x,y) > \texttt{thresh}\)}{\texttt{src}(x,y)}{otherwise}\f] - - - - - \f[\texttt{dst} (x,y) = \fork{\texttt{src}(x,y)}{if \(\texttt{src}(x,y) > \texttt{thresh}\)}{0}{otherwise}\f] - - - - - \f[\texttt{dst} (x,y) = \fork{0}{if \(\texttt{src}(x,y) > \texttt{thresh}\)}{\texttt{src}(x,y)}{otherwise}\f] - - - - - - - - - - flag, use Otsu algorithm to choose the optimal threshold value - - - - - flag, use Triangle algorithm to choose the optimal threshold value - - - - - Specify the polar mapping mode - - - - - Remaps an image to/from polar space. - - - - - Remaps an image to/from semilog-polar space. - - - - - finds arbitrary template in the grayscale image using Generalized Hough Transform - - - - - Canny low threshold. - - - - - - Canny high threshold. - - - - - - Minimum distance between the centers of the detected objects. - - - - - - Inverse ratio of the accumulator resolution to the image resolution. - - - - - - Maximal size of inner buffers. - - - - - - set template to search - - - - - - - set template to search - - - - - - - - - find template on image - - - - - - - - find template on image - - - - - - - - - - Ballard, D.H. (1981). Generalizing the Hough transform to detect arbitrary shapes. - Pattern Recognition 13 (2): 111-122. - Detects position only without traslation and rotation - - - - - cv::Ptr<T> object - - - - - - - - - - Creates a predefined GeneralizedHoughBallard object - - - - - - Releases managed resources - - - - - R-Table levels. - - - - - - The accumulator threshold for the template centers at the detection stage. - The smaller it is, the more false positions may be detected. - - - - - - Guil, N., González-Linares, J.M. and Zapata, E.L. (1999). - Bidimensional shape detection using an invariant approach. - Pattern Recognition 32 (6): 1025-1038. - Detects position, translation and rotation - - - - - cv::Ptr<T> object - - - - - - - - - - Creates a predefined GeneralizedHoughBallard object - - - - - - Releases managed resources - - - - - Angle difference in degrees between two points in feature. - - - - - - Feature table levels. - - - - - - Maximal difference between angles that treated as equal. - - - - - - Minimal rotation angle to detect in degrees. - - - - - - Maximal rotation angle to detect in degrees. - - - - - - Angle step in degrees. - - - - - - Angle votes threshold. - - - - - - Minimal scale to detect. - - - - - - Maximal scale to detect. - - - - - - Scale step. - - - - - - Scale votes threshold. - - - - - - Position votes threshold. - - - - - - Intelligent Scissors image segmentation - - This class is used to find the path (contour) between two points - which can be used for image segmentation. - - Usage example: - @snippet snippets/imgproc_segmentation.cpp usage_example_intelligent_scissors - - Reference: Intelligent Scissors for Image Composition http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.138.3811&rep=rep1&type=pdf - algorithm designed by Eric N. Mortensen and William A. Barrett, Brigham Young University - @cite Mortensen95intelligentscissors - - - - - Constructor - - - - - Releases unmanaged resources - - - - - Specify weights of feature functions - - Consider keeping weights normalized (sum of weights equals to 1.0) - Discrete dynamic programming (DP) goal is minimization of costs between pixels. - - Specify cost of non-edge pixels (default: 0.43f) - Specify cost of gradient direction function (default: 0.43f) - Specify cost of gradient magnitude function (default: 0.14f) - - - - - Specify gradient magnitude max value threshold - - Zero limit value is used to disable gradient magnitude thresholding (default behavior, as described in original article). - Otherwize pixels with `gradient magnitude >= threshold` have zero cost. - - @note Thresholding should be used for images with irregular regions (to avoid stuck on parameters from high-contract areas, like embedded logos). - - Specify gradient magnitude max value threshold (default: 0, disabled) - - - - - Switch to "Laplacian Zero-Crossing" edge feature extractor and specify its parameters - - This feature extractor is used by default according to article. - - Implementation has additional filtering for regions with low-amplitude noise. - This filtering is enabled through parameter of minimal gradient amplitude (use some small value 4, 8, 16). - - @note Current implementation of this feature extractor is based on processing of grayscale images (color image is converted to grayscale image first). - - @note Canny edge detector is a bit slower, but provides better results (especially on color images): use setEdgeFeatureCannyParameters(). - - Minimal gradient magnitude value for edge pixels (default: 0, check is disabled) - - - - - Switch edge feature extractor to use Canny edge detector - Note: "Laplacian Zero-Crossing" feature extractor is used by default (following to original article) - - - - - - - - - - Specify input image and extract image features - - input image. Type is #CV_8UC1 / #CV_8UC3 - - - - - Specify custom features of imput image - Customized advanced variant of applyImage() call. - - Specify cost of non-edge pixels. Type is CV_8UC1. Expected values are `{0, 1}`. - Specify gradient direction feature. Type is CV_32FC2. Values are expected to be normalized: `x^2 + y^2 == 1` - Specify cost of gradient magnitude function: Type is CV_32FC1. Values should be in range `[0, 1]`. - Optional parameter. Must be specified if subset of features is specified (non-specified features are calculated internally) - - - - - Prepares a map of optimal paths for the given source point on the image - Note: applyImage() / applyImageFeatures() must be called before this call - - The source point used to find the paths - - - - Extracts optimal contour for the given target point on the image - Note: buildMap() must be called before this call - - The target point - contour The list of pixels which contains optimal path between the source and the target points of the image. - Type is CV_32SC2 (compatible with `std::vector<Point>`) - Flag to indicate reverse order of retrived pixels (use "true" value to fetch points from the target to the source point) - - - - Contrast Limited Adaptive Histogram Equalization - - - - - Constructor - - - - - - - - - - - Initializes the iterator - - - - - - Releases unmanaged resources - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - LineIterator pixel data - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - - - - - - Line segment detector class - - - - - cv::Ptr<LineSegmentDetector> - - - - - - - - - - Creates a smart pointer to a LineSegmentDetector object and initializes it. - - The way found lines will be refined, see cv::LineSegmentDetectorModes - The scale of the image that will be used to find the lines. Range (0..1]. - Sigma for Gaussian filter. It is computed as sigma = _sigma_scale/_scale. - Bound to the quantization error on the gradient norm. - Gradient angle tolerance in degrees. - Detection threshold: -log10(NFA) \> log_eps. - Used only when advancent refinement is chosen. - Minimal density of aligned region points in the enclosing rectangle. - Number of bins in pseudo-ordering of gradient modulus. - - - - - Releases managed resources - - - - - Finds lines in the input image. - This is the output of the default parameters of the algorithm on the above shown image. - - A grayscale (CV_8UC1) input image. - A vector of Vec4i or Vec4f elements specifying the beginning and ending point of a line. - Where Vec4i/Vec4f is (x1, y1, x2, y2), point 1 is the start, point 2 - end. Returned lines are strictly oriented depending on the gradient. - Vector of widths of the regions, where the lines are found. E.g. Width of line. - Vector of precisions with which the lines are found. - Vector containing number of false alarms in the line region, - with precision of 10%. The bigger the value, logarithmically better the detection. - - - - Finds lines in the input image. - This is the output of the default parameters of the algorithm on the above shown image. - - A grayscale (CV_8UC1) input image. - A vector of Vec4i or Vec4f elements specifying the beginning and ending point of a line. - Where Vec4i/Vec4f is (x1, y1, x2, y2), point 1 is the start, point 2 - end. Returned lines are strictly oriented depending on the gradient. - Vector of widths of the regions, where the lines are found. E.g. Width of line. - Vector of precisions with which the lines are found. - Vector containing number of false alarms in the line region, - with precision of 10%. The bigger the value, logarithmically better the detection. - - - - Draws the line segments on a given image. - - The image, where the liens will be drawn. - Should be bigger or equal to the image, where the lines were found. - A vector of the lines that needed to be drawn. - - - - Draws two groups of lines in blue and red, counting the non overlapping (mismatching) pixels. - - The size of the image, where lines1 and lines2 were found. - The first group of lines that needs to be drawn. It is visualized in blue color. - The second group of lines. They visualized in red color. - Optional image, where the lines will be drawn. - The image should be color(3-channel) in order for lines1 and lines2 to be drawn - in the above mentioned colors. - - - - - circle structure retrieved from cvHoughCircle - - - - - Center coordinate of the circle - - - - - Radius - - - - - Constructor - - center - radius - - - - Specifies whether this object contains the same members as the specified Object. - - The Object to test. - This method returns true if obj is the same type as this object and has the same members as this object. - - - - Compares two CvPoint objects. The result specifies whether the members of each object are equal. - - A Point to compare. - A Point to compare. - This operator returns true if the members of left and right are equal; otherwise, false. - - - - Compares two CvPoint objects. The result specifies whether the members of each object are unequal. - - A Point to compare. - A Point to compare. - This operator returns true if the members of left and right are unequal; otherwise, false. - - - - Specifies whether this object contains the same members as the specified Object. - - The Object to test. - This method returns true if obj is the same type as this object and has the same members as this object. - - - - Returns a hash code for this object. - - An integer value that specifies a hash value for this object. - - - - Converts this object to a human readable string. - - A string that represents this object. - - - - Information about the image topology for cv::findContours - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2-dimentional line vector - - - - - The X component of the normalized vector collinear to the line - - - - - The Y component of the normalized vector collinear to the line - - - - - X-coordinate of some point on the line - - - - - Y-coordinate of some point on the line - - - - - Initializes this object - - The X component of the normalized vector collinear to the line - The Y component of the normalized vector collinear to the line - Z-coordinate of some point on the line - Z-coordinate of some point on the line - - - - Initializes by cvFitLine output - - The returned value from cvFitLineparam> - - - - - - - - - - - - - - - - Returns the distance between this line and the specified point - - - - - - Returns the distance between this line and the specified point - - - - - - Returns the distance between this line and the specified point - - - - - - Returns the distance between this line and the specified point - - - - - - - Fits this line to the specified size (for drawing) - - Width of fit size - Height of fit size - 1st edge point of fitted line - 2nd edge point of fitted line - - - - A 3-dimensional line object - - - - - The X component of the normalized vector collinear to the line - - - - - The Y component of the normalized vector collinear to the line - - - - - The Z component of the normalized vector collinear to the line - - - - - X-coordinate of some point on the line - - - - - Y-coordinate of some point on the line - - - - - Z-coordinate of some point on the line - - - - - Initializes this object - - The X component of the normalized vector collinear to the line - The Y component of the normalized vector collinear to the line - The Z component of the normalized vector collinear to the line - Z-coordinate of some point on the line - Z-coordinate of some point on the line - Z-coordinate of some point on the line - - - - Initializes by cvFitLine output - - The returned value from cvFitLineparam> - - - - Perpendicular foot - - - - - - Perpendicular foot - - - - - - Perpendicular foot - - - - - - - - Returns the distance between this line and the specified point - - - - - - Returns the distance between this line and the specified point - - - - - - Returns the distance between this line and the specified point - - - - - - - - ベクトルの外積 - - - - - - - - ベクトルの長さ(原点からの距離) - - - - - - - 2点間(2ベクトル)の距離 - - - - - - - - Line segment structure retrieved from cvHoughLines2 - - - - - 1st Point - - - - - 2nd Point - - - - - Constructor - - 1st Point - 2nd Point - - - - Specifies whether this object contains the same members as the specified Object. - - The Object to test. - This method returns true if obj is the same type as this object and has the same members as this object. - - - - Compares two CvPoint objects. The result specifies whether the members of each object are equal. - - A Point to compare. - A Point to compare. - This operator returns true if the members of left and right are equal; otherwise, false. - - - - Compares two CvPoint objects. The result specifies whether the members of each object are unequal. - - A Point to compare. - A Point to compare. - This operator returns true if the members of left and right are unequal; otherwise, false. - - - - Specifies whether this object contains the same members as the specified Object. - - The Object to test. - This method returns true if obj is the same type as this object and has the same members as this object. - - - - Returns a hash code for this object. - - An integer value that specifies a hash value for this object. - - - - Converts this object to a human readable string. - - A string that represents this object. - - - - Calculates a intersection of the specified two lines - - - - - - - - Calculates a intersection of the specified two lines - - - - - - - Calculates a intersection of the specified two segments - - - - - - - - Calculates a intersection of the specified two segments - - - - - - - Returns a boolean value indicating whether the specified two segments intersect. - - - - - - - - Returns a boolean value indicating whether the specified two segments intersect. - - - - - - - Returns a boolean value indicating whether a line and a segment intersect. - - Line - Segment - - - - - Calculates a intersection of a line and a segment - - - - - - - - - - - - - - Translates the Point by the specified amount. - - The amount to offset the x-coordinate. - The amount to offset the y-coordinate. - - - - - Translates the Point by the specified amount. - - The Point used offset this CvPoint. - - - - - Polar line segment retrieved from cvHoughLines2 - - - - - Length of the line - - - - - Angle of the line (radian) - - - - - Constructor - - Length of the line - Angle of the line (radian) - - - - Specifies whether this object contains the same members as the specified Object. - - The Object to test. - This method returns true if obj is the same type as this object and has the same members as this object. - - - - Compares two CvPoint objects. The result specifies whether the members of each object are equal. - - A Point to compare. - A Point to compare. - This operator returns true if the members of left and right are equal; otherwise, false. - - - - Compares two CvPoint objects. The result specifies whether the members of each object are unequal. - - A Point to compare. - A Point to compare. - This operator returns true if the members of left and right are unequal; otherwise, false. - - - - Specifies whether this object contains the same members as the specified Object. - - The Object to test. - This method returns true if obj is the same type as this object and has the same members as this object. - - - - Returns a hash code for this object. - - An integer value that specifies a hash value for this object. - - - - Converts this object to a human readable string. - - A string that represents this object. - - - - Calculates a intersection of the specified two lines - - - - - - - - Calculates a intersection of the specified two lines - - - - - - - Convert To LineSegmentPoint - - - - - - - Converts to a line segment with the specified x coordinates at both ends - - - - - - - - Converts to a line segment with the specified y coordinates at both ends - - - - - - - - - - - - - - - - - - - - - - Raster image moments - - - - - spatial moments - - - - - spatial moments - - - - - spatial moments - - - - - spatial moments - - - - - spatial moments - - - - - spatial moments - - - - - spatial moments - - - - - spatial moments - - - - - spatial moments - - - - - spatial moments - - - - - central moments - - - - - central moments - - - - - central moments - - - - - central moments - - - - - central moments - - - - - central moments - - - - - central moments - - - - - central normalized moments - - - - - central normalized moments - - - - - central normalized moments - - - - - central normalized moments - - - - - central normalized moments - - - - - central normalized moments - - - - - central normalized moments - - - - - Default constructor. - All moment values are set to 0. - - - - - - - - - - - - - - - - - - - - Calculates all of the moments - up to the third order of a polygon or rasterized shape. - - A raster image (single-channel, 8-bit or floating-point - 2D array) or an array ( 1xN or Nx1 ) of 2D points ( Point or Point2f ) - If it is true, then all the non-zero image pixels are treated as 1’s - - - - - Calculates all of the moments - up to the third order of a polygon or rasterized shape. - - A raster image (8-bit) 2D array - If it is true, then all the non-zero image pixels are treated as 1’s - - - - - Calculates all of the moments - up to the third order of a polygon or rasterized shape. - - A raster image (floating-point) 2D array - If it is true, then all the non-zero image pixels are treated as 1’s - - - - - Calculates all of the moments - up to the third order of a polygon or rasterized shape. - - Array of 2D points - If it is true, then all the non-zero image pixels are treated as 1’s - - - - - Calculates all of the moments - up to the third order of a polygon or rasterized shape. - - Array of 2D points - If it is true, then all the non-zero image pixels are treated as 1’s - - - - - Calculates all of the moments - up to the third order of a polygon or rasterized shape. - - A raster image (single-channel, 8-bit or floating-point - 2D array) or an array ( 1xN or Nx1 ) of 2D points ( Point or Point2f ) - If it is true, then all the non-zero image pixels are treated as 1’s - - - - - - - - - - - - - - - - - - - - computes 7 Hu invariants from the moments - - - - - - Planar Subdivision - - - - - Creates an empty Subdiv2D object. - To create a new empty Delaunay subdivision you need to use the #initDelaunay function. - - - - - Creates an empty Subdiv2D object. - - Rectangle that includes all of the 2D points that are to be added to the subdivision. - - - - Clean up any resources being used. - - - - - Releases unmanaged resources - - - - - Creates a new empty Delaunay subdivision - - Rectangle that includes all of the 2D points that are to be added to the subdivision. - - - - Insert a single point into a Delaunay triangulation. - - Point to insert. - - - - - Insert multiple points into a Delaunay triangulation. - - Points to insert. - - - - Returns the location of a point within a Delaunay triangulation. - - Point to locate. - Output edge that the point belongs to or is located to the right of it. - Optional output vertex the input point coincides with. - an integer which specify one of the following five cases for point location: - - The point falls into some facet. The function returns #PTLOC_INSIDE and edge will contain one of edges of the facet. - - The point falls onto the edge. The function returns #PTLOC_ON_EDGE and edge will contain this edge. - - The point coincides with one of the subdivision vertices. The function returns #PTLOC_VERTEX and vertex will contain a pointer to the vertex. - - The point is outside the subdivision reference rectangle. The function returns #PTLOC_OUTSIDE_RECT and no pointers are filled. - - One of input arguments is invalid. A runtime error is raised or, if silent or "parent" error processing mode is selected, #PTLOC_ERROR is returned. - - - - Finds the subdivision vertex closest to the given point. - - Input point. - Output subdivision vertex point. - vertex ID. - - - - Returns a list of all edges. - - Output vector. - - - - Returns a list of the leading edge ID connected to each triangle. - The function gives one edge ID for each triangle. - - Output vector. - - - - Returns a list of all triangles. - - Output vector. - - - - Returns a list of all Voronoi facets. - - Vector of vertices IDs to consider. For all vertices you can pass empty vector. - Output vector of the Voronoi facets. - Output vector of the Voronoi facets center points. - - - - Returns vertex location from vertex ID. - - vertex ID. - The first edge ID which is connected to the vertex. - vertex (x,y) - - - - Returns one of the edges related to the given edge. - - Subdivision edge ID. - Parameter specifying which of the related edges to return. - The following values are possible: - - NEXT_AROUND_ORG next around the edge origin ( eOnext on the picture below if e is the input edge) - - NEXT_AROUND_DST next around the edge vertex ( eDnext ) - - PREV_AROUND_ORG previous around the edge origin (reversed eRnext ) - - PREV_AROUND_DST previous around the edge destination (reversed eLnext ) - - NEXT_AROUND_LEFT next around the left facet ( eLnext ) - - NEXT_AROUND_RIGHT next around the right facet ( eRnext ) - - PREV_AROUND_LEFT previous around the left facet (reversed eOnext ) - - PREV_AROUND_RIGHT previous around the right facet (reversed eDnext ) - - - - - Subdivision edge ID. - - Subdivision edge ID. - an integer which is next edge ID around the edge origin: eOnext on the picture above if e is the input edge). - - - - Returns another edge of the same quad-edge. - - Subdivision edge ID. - Parameter specifying which of the edges of the same quad-edge as the input - one to return. The following values are possible: - - 0 - the input edge ( e on the picture below if e is the input edge) - - 1 - the rotated edge ( eRot ) - - 2 - the reversed edge (reversed e (in green)) - - 3 - the reversed rotated edge (reversed eRot (in green)) - one of the edges ID of the same quad-edge as the input edge. - - - - - - - - - - - Returns the edge origin. - - Subdivision edge ID. - Output vertex location. - vertex ID. - - - - Returns the edge destination. - - Subdivision edge ID. - Output vertex location. - vertex ID. - - - - Parameter for Subdiv2D.GetEdge() specifying which of the related edges to return. - - - - - next around the edge origin ( eOnext on the picture below if e is the input edge) - - - - - next around the edge vertex ( eDnext ) - - - - - previous around the edge origin (reversed eRnext ) - - - - - previous around the edge destination (reversed eLnext ) - - - - - next around the left facet ( eLnext ) - - - - - next around the right facet ( eRnext ) - - - - - previous around the left facet (reversed eOnext ) - - - - - previous around the right facet (reversed eDnext ) - - - - - - Computes average hash value of the input image. - This is a fast image hashing algorithm, but only work on simple case. For more details, - please refer to @cite lookslikeit - - - - - cv::Ptr<T> - - - - - - - - - - Constructor - - - - - - - Releases managed resources - - - - - - Image hash based on block mean. - - - - - cv::Ptr<T> - - - - - - - - - - Create BlockMeanHash object - - - - - - - - Releases managed resources - - - - - - - - - - - - - - - - - - Image hash based on color moments. - - - - - cv::Ptr<T> - - - - - - - - - - Constructor - - - - - - - Releases managed resources - - - - - - Computes color moment hash of the input, the algorithm is come from the paper "Perceptual Hashing for Color Images Using Invariant Moments" - - input image want to compute hash value, type should be CV_8UC4, CV_8UC3 or CV_8UC1. - 42 hash values with type CV_64F(double) - - - - - - - - - - use fewer block and generate 16*16/8 uchar hash value - - - - - use block blocks(step sizes/2), generate 31*31/8 + 1 uchar hash value - - - - - - The base class for image hash algorithms - - - - - Computes hash of the input image - - input image want to compute hash value - hash of the image - - - - - Compare the hash value between inOne and inTwo - - Hash value one - Hash value two - value indicate similarity between inOne and inTwo, the meaning of the value vary from algorithms to algorithms - - - - - Marr-Hildreth Operator Based Hash, slowest but more discriminative. - - - - - cv::Ptr<T> - - - - - - - - - - Create BlockMeanHash object - - int scale factor for marr wavelet (default=2). - int level of scale factor (default = 1) - - - - - - Releases managed resources - - - - - - - int scale factor for marr wavelet (default=2). - int level of scale factor (default = 1) - - - - int scale factor for marr wavelet (default=2). - - - - - int level of scale factor (default = 1) - - - - - - Computes average hash value of the input image - - input image want to compute hash value, type should be CV_8UC4, CV_8UC3, CV_8UC1. - Hash value of input, it will contain 16 hex decimal number, return type is CV_8U - - - - - - pHash: Slower than average_hash, but tolerant of minor modifications. - This algorithm can combat more variation than averageHash, for more details please refer to @cite lookslikeit - - - - - cv::Ptr<T> - - - - - - - - - - Constructor - - - - - - - Releases managed resources - - - - - - Computes pHash value of the input image - - input image want to compute hash value, type should be CV_8UC4, CV_8UC3, CV_8UC1. - Hash value of input, it will contain 8 uchar value - - - - - - Image hash based on Radon transform. - - - - - cv::Ptr<T> - - - - - - - - - - Create BlockMeanHash object - - Gaussian kernel standard deviation - The number of angles to consider - - - - - - Releases managed resources - - - - - Gaussian kernel standard deviation - - - - - The number of angles to consider - - - - - - Computes average hash value of the input image - - input image want to compute hash value, type should be CV_8UC4, CV_8UC3, CV_8UC1. - Hash value of input - - - - - A class to represent a line - - As aformentioned, it is been necessary to design a class that fully stores the information needed to - characterize completely a line and plot it on image it was extracted from, when required. - - *KeyLine* class has been created for such goal; it is mainly inspired to Feature2d's KeyPoint class, - since KeyLine shares some of* KeyPoint*'s fields, even if a part of them assumes a different - meaning, when speaking about lines.In particular: - - - the* class_id* field is used to gather lines extracted from different octaves which refer to - same line inside original image (such lines and the one they represent in original image share - the same* class_id* value) - - the* angle* field represents line's slope with respect to (positive) X axis - - the* pt* field represents line's midpoint - - the* response* field is computed as the ratio between the line's length and maximum between - image's width and height - - the* size* field is the area of the smallest rectangle containing line - - Apart from fields inspired to KeyPoint class, KeyLines stores information about extremes of line in - original image and in octave it was extracted from, about line's length and number of pixels it - covers. - - - - - orientation of the line - - - - - object ID, that can be used to cluster keylines by the line they represent - - - - - octave (pyramid layer), from which the keyline has been extracted - - - - - coordinates of the middlepoint - - - - - the response, by which the strongest keylines have been selected. - It's represented by the ratio between line's length and maximum between - image's width and height - - - - - minimum area containing line - - - - - lines' extremes in original image - - - - - lines' extremes in original image - - - - - lines' extremes in original image - - - - - lines' extremes in original image - - - - - line's extremes in image it was extracted from - - - - - line's extremes in image it was extracted from - - - - - line's extremes in image it was extracted from - - - - - line's extremes in image it was extracted from - - - - - the length of line - - - - - number of pixels covered by the line - - - - - Returns the start point of the line in the original image - - - - - Returns the end point of the line in the original image - - - - - Returns the start point of the line in the octave it was extracted from - - - - - Returns the end point of the line in the octave it was extracted from - - - - - Constructor - - - - - - - - - - - - - - - - - - - - - Artificial Neural Networks - Multi-Layer Perceptrons. - - - - - Creates instance by raw pointer cv::ml::ANN_MLP* - - - - - Creates the empty model. - - - - - - Loads and creates a serialized ANN from a file. - Use ANN::save to serialize and store an ANN to disk. - Load the ANN from this file again, by calling this function with the path to the file. - - path to serialized ANN - - - - - Loads algorithm from a String. - - he string variable containing the model you want to load. - - - - - Releases managed resources - - - - - Termination criteria of the training algorithm. - - - - - Strength of the weight gradient term. - The recommended value is about 0.1. Default value is 0.1. - - - - - Strength of the momentum term (the difference between weights on the 2 previous iterations). - This parameter provides some inertia to smooth the random fluctuations of the weights. - It can vary from 0 (the feature is disabled) to 1 and beyond. The value 0.1 or - so is good enough. Default value is 0.1. - - - - - Initial value Delta_0 of update-values Delta_{ij}. Default value is 0.1. - - - - - Increase factor eta^+. - It must be >1. Default value is 1.2. - - - - - Decrease factor eta^-. - It must be \>1. Default value is 0.5. - - - - - Update-values lower limit Delta_{min}. - It must be positive. Default value is FLT_EPSILON. - - - - - Update-values upper limit Delta_{max}. - It must be >1. Default value is 50. - - - - - Sets training method and common parameters. - - Default value is ANN_MLP::RPROP. See ANN_MLP::TrainingMethods. - passed to setRpropDW0 for ANN_MLP::RPROP and to setBackpropWeightScale for ANN_MLP::BACKPROP and to initialT for ANN_MLP::ANNEAL. - passed to setRpropDWMin for ANN_MLP::RPROP and to setBackpropMomentumScale for ANN_MLP::BACKPROP and to finalT for ANN_MLP::ANNEAL. - - - - Returns current training method - - - - - - Initialize the activation function for each neuron. - Currently the default and the only fully supported activation function is ANN_MLP::SIGMOID_SYM. - - The type of activation function. See ANN_MLP::ActivationFunctions. - The first parameter of the activation function, \f$\alpha\f$. Default value is 0. - The second parameter of the activation function, \f$\beta\f$. Default value is 0. - - - - Integer vector specifying the number of neurons in each layer including the input and output layers. - The very first element specifies the number of elements in the input layer. - The last element - number of elements in the output layer.Default value is empty Mat. - - - - - - Integer vector specifying the number of neurons in each layer including the input and output layers. - The very first element specifies the number of elements in the input layer. - The last element - number of elements in the output layer. - - - - - - possible activation functions - - - - - Identity function: $f(x)=x - - - - - Symmetrical sigmoid: f(x)=\beta*(1-e^{-\alpha x})/(1+e^{-\alpha x} - - - - - Gaussian function: f(x)=\beta e^{-\alpha x*x} - - - - - Train options - - - - - Update the network weights, rather than compute them from scratch. - In the latter case the weights are initialized using the Nguyen-Widrow algorithm. - - - - - Do not normalize the input vectors. - If this flag is not set, the training algorithm normalizes each input feature - independently, shifting its mean value to 0 and making the standard deviation - equal to 1. If the network is assumed to be updated frequently, the new - training data could be much different from original one. In this case, - you should take care of proper normalization. - - - - - Do not normalize the output vectors. If the flag is not set, - the training algorithm normalizes each output feature independently, - by transforming it to the certain range depending on the used activation function. - - - - - Available training methods - - - - - The back-propagation algorithm. - - - - - The RPROP algorithm. See @cite RPROP93 for details. - - - - - Boosted tree classifier derived from DTrees - - - - - Creates instance by raw pointer cv::ml::Boost* - - - - - Creates the empty model. - - - - - - Loads and creates a serialized model from a file. - - - - - - - Loads algorithm from a String. - - he string variable containing the model you want to load. - - - - - Releases managed resources - - - - - Type of the boosting algorithm. - See Boost::Types. Default value is Boost::REAL. - - - - - The number of weak classifiers. - Default value is 100. - - - - - A threshold between 0 and 1 used to save computational time. - Samples with summary weight \f$\leq 1 - weight_trim_rate - do not participate in the *next* iteration of training. - Set this parameter to 0 to turn off this functionality. Default value is 0.95. - - - - - Boosting type. - Gentle AdaBoost and Real AdaBoost are often the preferable choices. - - - - - Discrete AdaBoost. - - - - - Real AdaBoost. It is a technique that utilizes confidence-rated predictions - and works well with categorical data. - - - - - LogitBoost. It can produce good regression fits. - - - - - Gentle AdaBoost. It puts less weight on outlier data points and for that - reason is often good with regression data. - - - - - Decision tree - - - - - - - - - - Creates instance by raw pointer cv::ml::SVM* - - - - - Creates the empty model. - - - - - - Loads and creates a serialized model from a file. - - - - - - - Loads algorithm from a String. - - he string variable containing the model you want to load. - - - - - Releases managed resources - - - - - Cluster possible values of a categorical variable into - K < =maxCategories clusters to find a suboptimal split. - - - - - The maximum possible depth of the tree. - - - - - If the number of samples in a node is less than this parameter then the - node will not be split. Default value is 10. - - - - - If CVFolds \> 1 then algorithms prunes the built decision tree using K-fold - cross-validation procedure where K is equal to CVFolds. Default value is 10. - - - - - If true then surrogate splits will be built. - These splits allow to work with missing data and compute variable - importance correctly. Default value is false. - - - - - If true then a pruning will be harsher. - This will make a tree more compact and more resistant to the training - data noise but a bit less accurate. Default value is true. - - - - - If true then pruned branches are physically removed from the tree. - Otherwise they are retained and it is possible to get results from the - original unpruned (or pruned less aggressively) tree. Default value is true. - - - - - Termination criteria for regression trees. - If all absolute differences between an estimated value in a node and - values of train samples in this node are less than this parameter - then the node will not be split further. Default value is 0.01f. - - - - - The array of a priori class probabilities, sorted by the class label value. - - - - - Returns indices of root nodes - - - - - - Returns all the nodes. - all the node indices are indices in the returned vector - - - - - Returns all the splits. - all the split indices are indices in the returned vector - - - - - - Returns all the bitsets for categorical splits. - Split::subsetOfs is an offset in the returned vector - - - - - - The class represents a decision tree node. - - - - - Value at the node: a class label in case of classification or estimated - function value in case of regression. - - - - - Class index normalized to 0..class_count-1 range and assigned to the - node. It is used internally in classification trees and tree ensembles. - - - - - Index of the parent node - - - - - Index of the left child node - - - - - Index of right child node - - - - - Default direction where to go (-1: left or +1: right). It helps in the - case of missing values. - - - - - Index of the first split - - - - - The class represents split in a decision tree. - - - - - Index of variable on which the split is created. - - - - - If not 0, then the inverse split rule is used (i.e. left and right - branches are exchanged in the rule expressions below). - - - - - The split quality, a positive number. It is used to choose the best split. - - - - - Index of the next split in the list of splits for the node - - - - - The threshold value in case of split on an ordered variable. - - - - - Offset of the bitset used by the split on a categorical variable. - - - - - Sample types - - - - - each training sample is a row of samples - - - - - each training sample occupies a column of samples - - - - - K nearest neighbors classifier - - - - - Creates instance by raw pointer cv::ml::KNearest* - - - - - Creates the empty model - - - - - - Loads and creates a serialized model from a file. - - - - - - - Loads algorithm from a String. - - he string variable containing the model you want to load. - - - - - Releases managed resources - - - - - Default number of neighbors to use in predict method. - - - - - Whether classification or regression model should be trained. - - - - - Parameter for KDTree implementation - - - - - Algorithm type, one of KNearest::Types. - - - - - Finds the neighbors and predicts responses for input vectors. - - Input samples stored by rows. - It is a single-precision floating-point matrix of `[number_of_samples] * k` size. - Number of used nearest neighbors. Should be greater than 1. - Vector with results of prediction (regression or classification) for each - input sample. It is a single-precision floating-point vector with `[number_of_samples]` elements. - neighborResponses Optional output values for corresponding neighbors. - It is a single-precision floating-point matrix of `[number_of_samples] * k` size. - Optional output distances from the input vectors to the corresponding neighbors. - It is a single-precision floating-point matrix of `[number_of_samples] * k` size. - - - - - Implementations of KNearest algorithm - - - - - Implements Logistic Regression classifier. - - - - - Creates instance by raw pointer cv::ml::LogisticRegression* - - - - - Creates the empty model. - - - - - - Loads and creates a serialized model from a file. - - - - - - - Loads algorithm from a String. - - he string variable containing the model you want to load. - - - - - Releases managed resources - - - - - Learning rate - - - - - Number of iterations. - - - - - Kind of regularization to be applied. See LogisticRegression::RegKinds. - - - - - Kind of training method used. See LogisticRegression::Methods. - - - - - Specifies the number of training samples taken in each step of Mini-Batch Gradient. - Descent. Will only be used if using LogisticRegression::MINI_BATCH training algorithm. - It has to take values less than the total number of training samples. - - - - - Termination criteria of the training algorithm. - - - - - Predicts responses for input samples and returns a float type. - - The input data for the prediction algorithm. Matrix [m x n], - where each row contains variables (features) of one object being classified. - Should have data type CV_32F. - Predicted labels as a column matrix of type CV_32S. - Not used. - - - - - This function returns the trained parameters arranged across rows. - For a two class classification problem, it returns a row matrix. - It returns learnt parameters of the Logistic Regression as a matrix of type CV_32F. - - - - - - Regularization kinds - - - - - Regularization disabled - - - - - L1 norm - - - - - L2 norm - - - - - Training methods - - - - - - - - - - Set MiniBatchSize to a positive integer when using this method. - - - - - Bayes classifier for normally distributed data - - - - - Creates instance by raw pointer cv::ml::NormalBayesClassifier* - - - - - Creates empty model. - Use StatModel::train to train the model after creation. - - - - - - Loads and creates a serialized model from a file. - - - - - - - Loads algorithm from a String. - - he string variable containing the model you want to load. - - - - - Releases managed resources - - - - - Predicts the response for sample(s). - - - - - - - - The method estimates the most probable classes for input vectors. Input vectors (one or more) - are stored as rows of the matrix inputs. In case of multiple input vectors, there should be one - output vector outputs. The predicted class for a single input vector is returned by the method. - The vector outputProbs contains the output probabilities corresponding to each element of result. - - - - - The structure represents the logarithmic grid range of statmodel parameters. - - - - - Minimum value of the statmodel parameter. Default value is 0. - - - - - Maximum value of the statmodel parameter. Default value is 0. - - - - - Logarithmic step for iterating the statmodel parameter. - - - The grid determines the following iteration sequence of the statmodel parameter values: - \f[(minVal, minVal*step, minVal*{step}^2, \dots, minVal*{logStep}^n),\f] - where \f$n\f$ is the maximal index satisfying - \f[\texttt{minVal} * \texttt{logStep} ^n < \texttt{maxVal}\f] - The grid is logarithmic, so logStep must always be greater then 1. Default value is 1. - - - - - Constructor with parameters - - - - - - - - The class implements the random forest predictor. - - - - - Creates instance by raw pointer cv::ml::RTrees* - - - - - Creates the empty model. - - - - - - Loads and creates a serialized model from a file. - - - - - - - Loads algorithm from a String. - - he string variable containing the model you want to load. - - - - - Releases managed resources - - - - - If true then variable importance will be calculated and then - it can be retrieved by RTrees::getVarImportance. Default value is false. - - - - - The size of the randomly selected subset of features at each tree node - and that are used to find the best split(s). - - - - - The termination criteria that specifies when the training algorithm stops. - - - - - Returns the variable importance array. - The method returns the variable importance vector, computed at the training - stage when CalculateVarImportance is set to true. If this flag was set to false, - the empty matrix is returned. - - - - - - Base class for statistical models in ML - - - - - Returns the number of variables in training samples - - - - - - - - - - - - Returns true if the model is trained - - - - - - Returns true if the model is classifier - - - - - - Trains the statistical model - - training data that can be loaded from file using TrainData::loadFromCSV - or created with TrainData::create. - optional flags, depending on the model. Some of the models can be updated with the - new training samples, not completely overwritten (such as NormalBayesClassifier or ANN_MLP). - - - - - Trains the statistical model - - training samples - SampleTypes value - vector of responses associated with the training samples. - - - - - Computes error on the training or test dataset - - the training data - if true, the error is computed over the test subset of the data, - otherwise it's computed over the training subset of the data. Please note that if you - loaded a completely different dataset to evaluate already trained classifier, you will - probably want not to set the test subset at all with TrainData::setTrainTestSplitRatio - and specify test=false, so that the error is computed for the whole new set. Yes, this - sounds a bit confusing. - the optional output responses. - - - - - Predicts response(s) for the provided sample(s) - - The input samples, floating-point matrix - The optional output matrix of results. - The optional flags, model-dependent. - - - - - Predict options - - - - - makes the method return the raw results (the sum), not the class label - - - - - Support Vector Machines - - - - - Creates instance by raw pointer cv::ml::SVM* - - - - - Creates empty model. - Use StatModel::Train to train the model. - Since %SVM has several parameters, you may want to find the best - parameters for your problem, it can be done with SVM::TrainAuto. - - - - - - Loads and creates a serialized svm from a file. - Use SVM::save to serialize and store an SVM to disk. - Load the SVM from this file again, by calling this function with the path to the file. - - - - - - - Loads algorithm from a String. - - The string variable containing the model you want to load. - - - - - Releases managed resources - - - - - Type of a %SVM formulation. - Default value is SVM::C_SVC. - - - - - Parameter gamma of a kernel function. - For SVM::POLY, SVM::RBF, SVM::SIGMOID or SVM::CHI2. Default value is 1. - - - - - Parameter coef0 of a kernel function. - For SVM::POLY or SVM::SIGMOID. Default value is 0. - - - - - Parameter degree of a kernel function. - For SVM::POLY. Default value is 0. - - - - - Parameter C of a %SVM optimization problem. - For SVM::C_SVC, SVM::EPS_SVR or SVM::NU_SVR. Default value is 0. - - - - - Parameter nu of a %SVM optimization problem. - For SVM::NU_SVC, SVM::ONE_CLASS or SVM::NU_SVR. Default value is 0. - - - - - Parameter epsilon of a %SVM optimization problem. - For SVM::EPS_SVR. Default value is 0. - - - - - Optional weights in the SVM::C_SVC problem, assigned to particular classes. - - - They are multiplied by _C_ so the parameter _C_ of class _i_ becomes `classWeights(i) * C`. - Thus these weights affect the misclassification penalty for different classes. - The larger weight, the larger penalty on misclassification of data from the - corresponding class. Default value is empty Mat. - - - - - Termination criteria of the iterative SVM training procedure - which solves a partial case of constrained quadratic optimization problem. - - - You can specify tolerance and/or the maximum number of iterations. - Default value is `TermCriteria( TermCriteria::MAX_ITER + TermCriteria::EPS, 1000, FLT_EPSILON )`; - - - - - Type of a %SVM kernel. See SVM::KernelTypes. Default value is SVM::RBF. - - - - - Trains an %SVM with optimal parameters. - - the training data that can be constructed using - TrainData::create or TrainData::loadFromCSV. - Cross-validation parameter. The training set is divided into kFold subsets. - One subset is used to test the model, the others form the train set. So, the %SVM algorithm is - executed kFold times. - grid for C - grid for gamma - grid for p - grid for nu - grid for coeff - grid for degree - If true and the problem is 2-class classification then the method creates - more balanced cross-validation subsets that is proportions between classes in subsets are close - to such proportion in the whole train dataset. - - - - - Retrieves all the support vectors - - - - - - Retrieves the decision function - - i the index of the decision function. - If the problem solved is regression, 1-class or 2-class classification, then - there will be just one decision function and the index should always be 0. - Otherwise, in the case of N-class classification, there will be N(N-1)/2 decision functions. - alpha the optional output vector for weights, corresponding to - different support vectors. In the case of linear %SVM all the alpha's will be 1's. - the optional output vector of indices of support vectors - within the matrix of support vectors (which can be retrieved by SVM::getSupportVectors). - In the case of linear %SVM each decision function consists of a single "compressed" support vector. - - - - - Generates a grid for SVM parameters. - - SVM parameters IDs that must be one of the SVM::ParamTypes. - The grid is generated for the parameter with this ID. - - - - - SVM type - - - - - C-Support Vector Classification. n-class classification (n \f$\geq\f$ 2), - allows imperfect separation of classes with penalty multiplier C for outliers. - - - - - nu-Support Vector Classification. n-class classification with possible - imperfect separation. Parameter \f$\nu\f$ (in the range 0..1, the larger - the value, the smoother the decision boundary) is used instead of C. - - - - - Distribution Estimation (One-class %SVM). All the training data are from - the same class, %SVM builds a boundary that separates the class from the - rest of the feature space. - - - - - epsilon-Support Vector Regression. - The distance between feature vectors from the training set and the fitting - hyper-plane must be less than p. For outliers the penalty multiplier C is used. - - - - - nu-Support Vector Regression. \f$\nu\f$ is used instead of p. - See @cite LibSVM for details. - - - - - SVM kernel type - - - - - Returned by SVM::getKernelType in case when custom kernel has been set - - - - - Linear kernel. No mapping is done, linear discrimination (or regression) is - done in the original feature space. It is the fastest option. \f$K(x_i, x_j) = x_i^T x_j\f$. - - - - - Polynomial kernel: - \f$K(x_i, x_j) = (\gamma x_i^T x_j + coef0)^{degree}, \gamma > 0\f$. - - - - - Radial basis function (RBF), a good choice in most cases. - \f$K(x_i, x_j) = e^{-\gamma ||x_i - x_j||^2}, \gamma > 0\f$. - - - - - Sigmoid kernel: - \f$K(x_i, x_j) = \tanh(\gamma x_i^T x_j + coef0)\f$. - - - - - Exponential Chi2 kernel, similar to the RBF kernel: - \f$K(x_i, x_j) = e^{-\gamma \chi^2(x_i,x_j)}, \chi^2(x_i,x_j) = (x_i-x_j)^2/(x_i+x_j), \gamma > 0\f$. - - - - - Histogram intersection kernel. - A fast kernel. \f$K(x_i, x_j) = min(x_i,x_j)\f$. - - - - - SVM params type - - - - - - - - - - - - - - - The class implements the Expectation Maximization algorithm. - - - - - Creates instance by pointer cv::Ptr<EM> - - - - - Creates empty EM model. - - - - - - Loads and creates a serialized model from a file. - - - - - - - Loads algorithm from a String. - - he string variable containing the model you want to load. - - - - - Releases managed resources - - - - - The number of mixture components in the Gaussian mixture model. - Default value of the parameter is EM::DEFAULT_NCLUSTERS=5. - Some of EM implementation could determine the optimal number of mixtures - within a specified value range, but that is not the case in ML yet. - - - - - Constraint on covariance matrices which defines type of matrices. - - - - - The termination criteria of the %EM algorithm. - The EM algorithm can be terminated by the number of iterations - termCrit.maxCount (number of M-steps) or when relative change of likelihood - logarithm is less than termCrit.epsilon. - Default maximum number of iterations is EM::DEFAULT_MAX_ITERS=100. - - - - - Returns weights of the mixtures. - Returns vector with the number of elements equal to the number of mixtures. - - - - - - Returns the cluster centers (means of the Gaussian mixture). - Returns matrix with the number of rows equal to the number of mixtures and - number of columns equal to the space dimensionality. - - - - - - Returns covariation matrices. - Returns vector of covariation matrices. Number of matrices is the number of - gaussian mixtures, each matrix is a square floating-point matrix NxN, where N is the space dimensionality. - - - - - Estimate the Gaussian mixture parameters from a samples set. - - Samples from which the Gaussian mixture model will be estimated. It should be a - one-channel matrix, each row of which is a sample. If the matrix does not have CV_64F type - it will be converted to the inner matrix of such type for the further computing. - The optional output matrix that contains a likelihood logarithm value for - each sample. It has \f$nsamples \times 1\f$ size and CV_64FC1 type. - The optional output "class label" for each sample: - \f$\texttt{labels}_i=\texttt{arg max}_k(p_{i,k}), i=1..N\f$ (indices of the most probable - mixture component for each sample). It has \f$nsamples \times 1\f$ size and CV_32SC1 type. - The optional output matrix that contains posterior probabilities of each Gaussian - mixture component given the each sample. It has \f$nsamples \times nclusters\f$ size and CV_64FC1 type. - - - - - Estimate the Gaussian mixture parameters from a samples set. - - Samples from which the Gaussian mixture model will be estimated. It should be a - one-channel matrix, each row of which is a sample. If the matrix does not have CV_64F type - it will be converted to the inner matrix of such type for the further computing. - Initial means \f$a_k\f$ of mixture components. It is a one-channel matrix of - \f$nclusters \times dims\f$ size. If the matrix does not have CV_64F type it will be - converted to the inner matrix of such type for the further computing. - The vector of initial covariance matrices \f$S_k\f$ of mixture components. Each of - covariance matrices is a one-channel matrix of \f$dims \times dims\f$ size. If the matrices - do not have CV_64F type they will be converted to the inner matrices of such type for the further computing. - Initial weights \f$\pi_k\f$ of mixture components. It should be a one-channel - floating-point matrix with \f$1 \times nclusters\f$ or \f$nclusters \times 1\f$ size. - The optional output matrix that contains a likelihood logarithm value for - each sample. It has \f$nsamples \times 1\f$ size and CV_64FC1 type. - The optional output "class label" for each sample: - \f$\texttt{labels}_i=\texttt{arg max}_k(p_{i,k}), i=1..N\f$ (indices of the most probable - mixture component for each sample). It has \f$nsamples \times 1\f$ size and CV_32SC1 type. - The optional output matrix that contains posterior probabilities of each Gaussian - mixture component given the each sample. It has \f$nsamples \times nclusters\f$ size and CV_64FC1 type. - - - - Estimate the Gaussian mixture parameters from a samples set. - - Samples from which the Gaussian mixture model will be estimated. It should be a - one-channel matrix, each row of which is a sample. If the matrix does not have CV_64F type - it will be converted to the inner matrix of such type for the further computing. - the probabilities - The optional output matrix that contains a likelihood logarithm value for - each sample. It has \f$nsamples \times 1\f$ size and CV_64FC1 type. - The optional output "class label" for each sample: - \f$\texttt{labels}_i=\texttt{arg max}_k(p_{i,k}), i=1..N\f$ (indices of the most probable - mixture component for each sample). It has \f$nsamples \times 1\f$ size and CV_32SC1 type. - The optional output matrix that contains posterior probabilities of each Gaussian - mixture component given the each sample. It has \f$nsamples \times nclusters\f$ size and CV_64FC1 type. - - - - Predicts the response for sample - - A sample for classification. It should be a one-channel matrix of - \f$1 \times dims\f$ or \f$dims \times 1\f$ size. - Optional output matrix that contains posterior probabilities of each component - given the sample. It has \f$1 \times nclusters\f$ size and CV_64FC1 type. - - - - Type of covariation matrices - - - - - A scaled identity matrix \f$\mu_k * I\f$. - There is the only parameter \f$\mu_k\f$ to be estimated for each matrix. - The option may be used in special cases, when the constraint is relevant, - or as a first step in the optimization (for example in case when the data is - preprocessed with PCA). The results of such preliminary estimation may be - passed again to the optimization procedure, this time with covMatType=EM::COV_MAT_DIAGONAL. - - - - - A diagonal matrix with positive diagonal elements. - The number of free parameters is d for each matrix. - This is most commonly used option yielding good estimation results. - - - - - A symmetric positively defined matrix. The number of free parameters in each - matrix is about \f$d^2/2\f$. It is not recommended to use this option, unless - there is pretty accurate initial estimation of the parameters and/or a huge number - of training samples. - - - - - - - - - - The initial step the algorithm starts from - - - - - The algorithm starts with E-step. - At least, the initial values of mean vectors, CvEMParams.Means must be passed. - Optionally, the user may also provide initial values for weights (CvEMParams.Weights) - and/or covariation matrices (CvEMParams.Covs). - [CvEM::START_E_STEP] - - - - - The algorithm starts with M-step. The initial probabilities p_i,k must be provided. - [CvEM::START_M_STEP] - - - - - No values are required from the user, k-means algorithm is used to estimate initial mixtures parameters. - [CvEM::START_AUTO_STEP] - - - - - Cascade classifier class for object detection. - - - - - Default constructor - - - - - Loads a classifier from a file. - - Name of the file from which the classifier is loaded. - - - - Releases unmanaged resources - - - - - Checks whether the classifier has been loaded. - - - - - - Loads a classifier from a file. - - Name of the file from which the classifier is loaded. - The file may contain an old HAAR classifier trained by the haartraining application - or a new cascade classifier trained by the traincascade application. - - - - - Reads a classifier parameters from a file storage - - - - - - Detects objects of different sizes in the input image. The detected objects are returned as a list of rectangles. - - Matrix of the type CV_8U containing an image where objects are detected. - Parameter specifying how much the image size is reduced at each image scale. - Parameter specifying how many neighbors each candidate rectangle should have to retain it. - Parameter with the same meaning for an old cascade as in the function cvHaarDetectObjects. - It is not used for a new cascade. - Minimum possible object size. Objects smaller than that are ignored. - Maximum possible object size. Objects larger than that are ignored. - Vector of rectangles where each rectangle contains the detected object. - - - - Detects objects of different sizes in the input image. The detected objects are returned as a list of rectangles. - - Matrix of the type CV_8U containing an image where objects are detected. - - - Parameter specifying how much the image size is reduced at each image scale. - Parameter specifying how many neighbors each candidate rectangle should have to retain it. - Parameter with the same meaning for an old cascade as in the function cvHaarDetectObjects. - It is not used for a new cascade. - Minimum possible object size. Objects smaller than that are ignored. - Maximum possible object size. Objects larger than that are ignored. - - Vector of rectangles where each rectangle contains the detected object. - - - - - - - - - - - - - - - - - - - - - - Modes of operation for cvHaarDetectObjects - - - - - If it is set, the function uses Canny edge detector to reject some image regions that contain too few or too much edges and thus can not contain the searched object. - The particular threshold values are tuned for face detection and in this case the pruning speeds up the processing. - [CV_HAAR_DO_CANNY_PRUNING] - - - - - For each scale factor used the function will downscale the image rather than "zoom" the feature coordinates in the classifier cascade. - Currently, the option can only be used alone, i.e. the flag can not be set together with the others. - [CV_HAAR_SCALE_IMAGE] - - - - - If it is set, the function finds the largest object (if any) in the image. That is, the output sequence will contain one (or zero) element(s). - [CV_HAAR_FIND_BIGGEST_OBJECT] - - - - - It should be used only when FindBiggestObject is set and min_neighbors > 0. - If the flag is set, the function does not look for candidates of a smaller size - as soon as it has found the object (with enough neighbor candidates) at the current scale. - Typically, when min_neighbors is fixed, the mode yields less accurate (a bit larger) object rectangle - than the regular single-object mode (flags=FindBiggestObject), - but it is much faster, up to an order of magnitude. A greater value of min_neighbors may be specified to improve the accuracy. - [CV_HAAR_DO_ROUGH_SEARCH] - - - - - L2-Hys normalization method - - - - - [HOGDescriptor::L2Hys] - - - - - HOG (Histogram-of-Oriented-Gradients) Descriptor and Object Detector - - - - - - - - - - - - - - - Returns coefficients of the classifier trained for people detection (for default window size). - - - - - This field returns 1981 SVM coeffs obtained from daimler's base. - To use these coeffs the detection window size should be (48,96) - - - - - Default constructor - - - - - Creates the HOG descriptor and detector. - - Detection window size. Align to block size and block stride. - Block size in pixels. Align to cell size. Only (16,16) is supported for now. - Block stride. It must be a multiple of cell size. - Cell size. Only (8, 8) is supported for now. - Number of bins. Only 9 bins per cell are supported for now. - - Gaussian smoothing window parameter. - - L2-Hys normalization method shrinkage. - Flag to specify whether the gamma correction preprocessing is required or not. - Maximum number of detection window increases. - - - - Construct from a file containing HOGDescriptor properties and coefficients for the linear SVM classifier. - - The file name containing HOGDescriptor properties and coefficients for the linear SVM classifier. - - - - Releases unmanaged resources - - - - - Detection window size. Align to block size and block stride. Default value is Size(64,128). - - - - - Block size in pixels. Align to cell size. Default value is Size(16,16). - - - - - Block stride. It must be a multiple of cell size. Default value is Size(8,8). - - - - - Cell size. Default value is Size(8,8). - - - - - Number of bins used in the calculation of histogram of gradients. Default value is 9. - - - - - - - - - - Gaussian smoothing window parameter. - - - - - HistogramNormType - - - - - L2-Hys normalization method shrinkage. - - - - - Flag to specify whether the gamma correction preprocessing is required or not. - - - - - Maximum number of detection window increases. Default value is 64 - - - - - Indicates signed gradient will be used or not - - - - - Returns coefficients of the classifier trained for people detection (for default window size). - - - - - - This method returns 1981 SVM coeffs obtained from daimler's base. - To use these coeffs the detection window size should be (48,96) - - - - - - Sets coefficients for the linear SVM classifier. - - coefficients for the linear SVM classifier. - - - - loads HOGDescriptor parameters and coefficients for the linear SVM classifier from a file. - - Path of the file to read. - The optional name of the node to read (if empty, the first top-level node will be used). - - - - - saves HOGDescriptor parameters and coefficients for the linear SVM classifier to a file - - File name - Object name - - - - - - - - - - - - - - - - - - - - - - Computes HOG descriptors of given image. - - Matrix of the type CV_8U containing an image where HOG features will be calculated. - Window stride. It must be a multiple of block stride. - Padding - Vector of Point - Matrix of the type CV_32F - - - - Performs object detection without a multi-scale window. - - Source image. CV_8UC1 and CV_8UC4 types are supported for now. - Threshold for the distance between features and SVM classifying plane. - Usually it is 0 and should be specified in the detector coefficients (as the last free coefficient). - But if the free coefficient is omitted (which is allowed), you can specify it manually here. - Window stride. It must be a multiple of block stride. - Mock parameter to keep the CPU interface compatibility. It must be (0,0). - - Left-top corner points of detected objects boundaries. - - - - Performs object detection without a multi-scale window. - - Source image. CV_8UC1 and CV_8UC4 types are supported for now. - - Threshold for the distance between features and SVM classifying plane. - Usually it is 0 and should be specfied in the detector coefficients (as the last free coefficient). - But if the free coefficient is omitted (which is allowed), you can specify it manually here. - Window stride. It must be a multiple of block stride. - Mock parameter to keep the CPU interface compatibility. It must be (0,0). - - Left-top corner points of detected objects boundaries. - - - - Performs object detection with a multi-scale window. - - Source image. CV_8UC1 and CV_8UC4 types are supported for now. - Threshold for the distance between features and SVM classifying plane. - Window stride. It must be a multiple of block stride. - Mock parameter to keep the CPU interface compatibility. It must be (0,0). - Coefficient of the detection window increase. - Coefficient to regulate the similarity threshold. - When detected, some objects can be covered by many rectangles. 0 means not to perform grouping. - Detected objects boundaries. - - - - Performs object detection with a multi-scale window. - - Source image. CV_8UC1 and CV_8UC4 types are supported for now. - - Threshold for the distance between features and SVM classifying plane. - Window stride. It must be a multiple of block stride. - Mock parameter to keep the CPU interface compatibility. It must be (0,0). - Coefficient of the detection window increase. - Coefficient to regulate the similarity threshold. - When detected, some objects can be covered by many rectangles. 0 means not to perform grouping. - Detected objects boundaries. - - - - Computes gradients and quantized gradient orientations. - - Matrix contains the image to be computed - Matrix of type CV_32FC2 contains computed gradients - Matrix of type CV_8UC2 contains quantized gradient orientations - Padding from top-left - Padding from bottom-right - - - - evaluate specified ROI and return confidence value for each location - - Matrix of the type CV_8U or CV_8UC3 containing an image where objects are detected. - Vector of Point - Vector of Point where each Point is detected object's top-left point. - confidences - Threshold for the distance between features and SVM classifying plane. Usually - it is 0 and should be specified in the detector coefficients (as the last free coefficient). But if - the free coefficient is omitted (which is allowed), you can specify it manually here - winStride - padding - - - - evaluate specified ROI and return confidence value for each location in multiple scales - - Matrix of the type CV_8U or CV_8UC3 containing an image where objects are detected. - Vector of rectangles where each rectangle contains the detected object. - Vector of DetectionROI - Threshold for the distance between features and SVM classifying plane. Usually it is 0 and should be specified - in the detector coefficients (as the last free coefficient). But if the free coefficient is omitted (which is allowed), you can specify it manually here. - Minimum possible number of rectangles minus 1. The threshold is used in a group of rectangles to retain it. - - - - Groups the object candidate rectangles. - - Input/output vector of rectangles. Output vector includes retained and grouped rectangles. (The Python list is not modified in place.) - Input/output vector of weights of rectangles. Output vector includes weights of retained and grouped rectangles. (The Python list is not modified in place.) - Minimum possible number of rectangles minus 1. The threshold is used in a group of rectangles to retain it. - Relative difference between sides of the rectangles to merge them into a group. - - - - struct for detection region of interest (ROI) - - - - - scale(size) of the bounding box - - - - - set of requested locations to be evaluated - - - - - vector that will contain confidence values for each location - - - - - Constructor - - - - - - - - - - - - - - - Releases unmanaged resources - - - - - sets the epsilon used during the horizontal scan of QR code stop marker detection. - - Epsilon neighborhood, which allows you to determine the horizontal pattern - of the scheme 1:1:3:1:1 according to QR code standard. - - - - sets the epsilon used during the vertical scan of QR code stop marker detection. - - Epsilon neighborhood, which allows you to determine the vertical pattern - of the scheme 1:1:3:1:1 according to QR code standard. - - - - Detects QR code in image and returns the quadrangle containing the code. - - grayscale or color (BGR) image containing (or not) QR code. - Output vector of vertices of the minimum-area quadrangle containing the code. - - - - - Decodes QR code in image once it's found by the detect() method. - Returns UTF8-encoded output string or empty string if the code cannot be decoded. - - grayscale or color (BGR) image containing QR code. - Quadrangle vertices found by detect() method (or some other algorithm). - The optional output image containing rectified and binarized QR code - - - - - Both detects and decodes QR code - - grayscale or color (BGR) image containing QR code. - optional output array of vertices of the found QR code quadrangle. Will be empty if not found. - The optional output image containing rectified and binarized QR code - - - - - Detects QR codes in image and returns the quadrangles containing the codes. - - grayscale or color (BGR) image containing (or not) QR code. - Output vector of vertices of the minimum-area quadrangle containing the codes. - - - - - Decodes QR codes in image once it's found by the detect() method. - Returns UTF8-encoded output string or empty string if the code cannot be decoded. - - grayscale or color (BGR) image containing QR code. - Quadrangle vertices found by detect() method (or some other algorithm). - UTF8-encoded output vector of string or empty vector of string if the codes cannot be decoded. - - - - - Decodes QR codes in image once it's found by the detect() method. - Returns UTF8-encoded output string or empty string if the code cannot be decoded. - - grayscale or color (BGR) image containing QR code. - Quadrangle vertices found by detect() method (or some other algorithm). - UTF8-encoded output vector of string or empty vector of string if the codes cannot be decoded. - The optional output image containing rectified and binarized QR code - - - - - Decodes QR codes in image once it's found by the detect() method. - Returns UTF8-encoded output string or empty string if the code cannot be decoded. - - grayscale or color (BGR) image containing QR code. - Quadrangle vertices found by detect() method (or some other algorithm). - UTF8-encoded output vector of string or empty vector of string if the codes cannot be decoded. - The optional output image containing rectified and binarized QR code - to output - - - - - Class for grouping object candidates, detected by Cascade Classifier, HOG etc. - instance of the class is to be passed to cv::partition (see cxoperations.hpp) - - - - - - - - - - - - - - cv::optflow functions - - - - - Updates motion history image using the current silhouette - - Silhouette mask that has non-zero pixels where the motion occurs. - Motion history image that is updated by the function (single-channel, 32-bit floating-point). - Current time in milliseconds or other units. - Maximal duration of the motion track in the same units as timestamp . - - - - Computes the motion gradient orientation image from the motion history image - - Motion history single-channel floating-point image. - Output mask image that has the type CV_8UC1 and the same size as mhi. - Its non-zero elements mark pixels where the motion gradient data is correct. - Output motion gradient orientation image that has the same type and the same size as mhi. - Each pixel of the image is a motion orientation, from 0 to 360 degrees. - Minimal (or maximal) allowed difference between mhi values within a pixel neighborhood. - Maximal (or minimal) allowed difference between mhi values within a pixel neighborhood. - That is, the function finds the minimum ( m(x,y) ) and maximum ( M(x,y) ) mhi values over 3x3 neighborhood of each pixel - and marks the motion orientation at (x, y) as valid only if: - min(delta1, delta2) <= M(x,y)-m(x,y) <= max(delta1, delta2). - - - - - Computes the global orientation of the selected motion history image part - - Motion gradient orientation image calculated by the function CalcMotionGradient() . - Mask image. It may be a conjunction of a valid gradient mask, also calculated by CalcMotionGradient() , - and the mask of a region whose direction needs to be calculated. - Motion history image calculated by UpdateMotionHistory() . - Timestamp passed to UpdateMotionHistory() . - Maximum duration of a motion track in milliseconds, passed to UpdateMotionHistory() . - - - - - Splits a motion history image into a few parts corresponding to separate independent motions - (for example, left hand, right hand). - - Motion history image. - Image where the found mask should be stored, single-channel, 32-bit floating-point. - Vector containing ROIs of motion connected components. - Current time in milliseconds or other units. - Segmentation threshold that is recommended to be equal to the interval between motion history “steps” or greater. - - - - computes dense optical flow using Simple Flow algorithm - - First 8-bit 3-channel image. - Second 8-bit 3-channel image - Estimated flow - Number of layers - Size of block through which we sum up when calculate cost function for pixel - maximal flow that we search at each level - - - - computes dense optical flow using Simple Flow algorithm - - First 8-bit 3-channel image. - Second 8-bit 3-channel image - Estimated flow - Number of layers - Size of block through which we sum up when calculate cost function for pixel - maximal flow that we search at each level - vector smooth spatial sigma parameter - vector smooth color sigma parameter - window size for postprocess cross bilateral filter - spatial sigma for postprocess cross bilateralf filter - color sigma for postprocess cross bilateral filter - threshold for detecting occlusions - window size for bilateral upscale operation - spatial sigma for bilateral upscale operation - color sigma for bilateral upscale operation - threshold to detect point with irregular flow - where flow should be recalculated after upscale - - - - Fast dense optical flow based on PyrLK sparse matches interpolation. - - first 8-bit 3-channel or 1-channel image. - second 8-bit 3-channel or 1-channel image of the same size as from - computed flow image that has the same size as from and CV_32FC2 type - stride used in sparse match computation. Lower values usually - result in higher quality but slow down the algorithm. - number of nearest-neighbor matches considered, when fitting a locally affine - model. Lower values can make the algorithm noticeably faster at the cost of some quality degradation. - parameter defining how fast the weights decrease in the locally-weighted affine - fitting. Higher values can help preserve fine details, lower values can help to get rid of the noise in the output flow. - defines whether the ximgproc::fastGlobalSmootherFilter() is used for post-processing after interpolation - see the respective parameter of the ximgproc::fastGlobalSmootherFilter() - see the respective parameter of the ximgproc::fastGlobalSmootherFilter() - - - - The base class for camera response calibration algorithms. - - - - - Recovers inverse camera response. - - vector of input images - 256x1 matrix with inverse camera response function - vector of exposure time values for each image - - - - CalibrateDebevec object - - - - - Creates instance by raw pointer cv::CalibrateDebevec* - - - - - Creates the empty model. - - number of pixel locations to use - smoothness term weight. Greater values produce smoother results, - but can alter the response. - if true sample pixel locations are chosen at random, - otherwise the form a rectangular grid. - - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - CalibrateRobertson object - - - - - Creates instance by raw pointer cv::CalibrateRobertson* - - - - - Creates CalibrateRobertson object - - maximal number of Gauss-Seidel solver iterations. - target difference between results of two successive steps of the minimization. - - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - Edge preserving filters - - - - - Recursive Filtering - - - - - Normalized Convolution Filtering - - - - - The inpainting method - - - - - Navier-Stokes based method. - - - - - The method by Alexandru Telea - - - - - The resulting HDR image is calculated as weighted average of the exposures considering exposure - values and camera response. - - For more information see @cite DM97 . - - - - - Creates instance by MergeDebevec* - - - - - Creates the empty model. - - - - - - Releases managed resources - - - - - The base class algorithms that can merge exposure sequence to a single image. - - - - - Merges images. - - vector of input images - result image - vector of exposure time values for each image - 256x1 matrix with inverse camera response function for each pixel value, it should have the same number of channels as images. - - - - Pixels are weighted using contrast, saturation and well-exposedness measures, than images are combined using laplacian pyramids. - - The resulting image weight is constructed as weighted average of contrast, saturation and well-exposedness measures. - - The resulting image doesn't require tonemapping and can be converted to 8-bit image by multiplying by 255, - but it's recommended to apply gamma correction and/or linear tonemapping. - - For more information see @cite MK07 . - - - - - Creates instance by MergeMertens* - - - - - Creates the empty model. - - - - - - Short version of process, that doesn't take extra arguments. - - vector of input images - result image - - - - Releases managed resources - - - - - SeamlessClone method - - - - - The power of the method is fully expressed when inserting objects with - complex outlines into a new background. - - - - - The classic method, color-based selection and alpha masking might be time - consuming and often leaves an undesirable halo. Seamless cloning, even averaged - with the original image, is not effective. Mixed seamless cloning based on a - loose selection proves effective. - - - - - Feature exchange allows the user to easily replace certain features of one - object by alternative features. - - - - - Base class for tonemapping algorithms - tools that are used to map HDR image to 8-bit range. - - - - - Constructor used by Tonemap.Create - - - - - Constructor used by subclasses - - - - - Creates simple linear mapper with gamma correction - - positive value for gamma correction. - Gamma value of 1.0 implies no correction, gamma equal to 2.2f is suitable for most displays. - Generally gamma > 1 brightens the image and gamma < 1 darkens it. - - - - - Releases managed resources - - - - - Tonemaps image - - source image - CV_32FC3 Mat (float 32 bits 3 channels) - destination image - CV_32FC3 Mat with values in [0, 1] range - - - - Gets or sets positive value for gamma correction. Gamma value of 1.0 implies no correction, gamma - equal to 2.2f is suitable for most displays. - Generally gamma > 1 brightens the image and gamma < 1 darkens it. - - - - - Adaptive logarithmic mapping is a fast global tonemapping algorithm that scales the image in logarithmic domain. - - Since it's a global operator the same function is applied to all the pixels, it is controlled by the bias parameter. - Optional saturation enhancement is possible as described in @cite FL02. For more information see @cite DM03. - - - - - Constructor - - - - - Creates TonemapDrago object - - positive value for gamma correction. Gamma value of 1.0 implies no correction, gamma - equal to 2.2f is suitable for most displays. - Generally gamma > 1 brightens the image and gamma < 1 darkens it. - positive saturation enhancement value. 1.0 preserves saturation, values greater - than 1 increase saturation and values less than 1 decrease it. - value for bias function in [0, 1] range. Values from 0.7 to 0.9 usually give best - results, default value is 0.85. - - - - - Releases managed resources - - - - - Gets or sets positive saturation enhancement value. 1.0 preserves saturation, values greater - than 1 increase saturation and values less than 1 decrease it. - - - - - Gets or sets value for bias function in [0, 1] range. Values from 0.7 to 0.9 usually give best - results, default value is 0.85. - - - - - This algorithm transforms image to contrast using gradients on all levels of gaussian pyramid, - transforms contrast values to HVS response and scales the response. After this the image is - reconstructed from new contrast values. - - For more information see @cite MM06. - - - - - Constructor - - - - - Creates TonemapMantiuk object - - positive value for gamma correction. Gamma value of 1.0 implies no correction, gamma - equal to 2.2f is suitable for most displays. - Generally gamma > 1 brightens the image and gamma < 1 darkens it. - contrast scale factor. HVS response is multiplied by this parameter, thus compressing - dynamic range. Values from 0.6 to 0.9 produce best results. - - - - - - Releases managed resources - - - - - Gets or sets contrast scale factor. HVS response is multiplied by this parameter, thus compressing - dynamic range. Values from 0.6 to 0.9 produce best results. - - - - - Gets or sets positive saturation enhancement value. 1.0 preserves saturation, values greater - than 1 increase saturation and values less than 1 decrease it. - - - - - This is a global tonemapping operator that models human visual system. - - Mapping function is controlled by adaptation parameter, that is computed using light adaptation and - color adaptation. For more information see @cite RD05. - - - - - Constructor - - - - - Creates TonemapReinhard object - - positive value for gamma correction. Gamma value of 1.0 implies no correction, gamma - equal to 2.2f is suitable for most displays. - Generally gamma > 1 brightens the image and gamma < 1 darkens it. - result intensity in [-8, 8] range. Greater intensity produces brighter results. - light adaptation in [0, 1] range. If 1 adaptation is based only on pixel - value, if 0 it's global, otherwise it's a weighted mean of this two cases. - chromatic adaptation in [0, 1] range. If 1 channels are treated independently, - if 0 adaptation level is the same for each channel. - - - - - Releases managed resources - - - - - Gets or sets result intensity in [-8, 8] range. Greater intensity produces brighter results. - - - - - Gets or sets light adaptation in [0, 1] range. If 1 adaptation is based only on pixel - value, if 0 it's global, otherwise it's a weighted mean of this two cases. - - - - - Gets or sets chromatic adaptation in [0, 1] range. If 1 channels are treated independently, - if 0 adaptation level is the same for each channel. - - - - - Quality Base Class - - - - - Implements Algorithm::empty() - - - - - - Returns output quality map that was generated during computation, if supported by the algorithm - - - - - - Compute quality score per channel with the per-channel score in each element of the resulting cv::Scalar. - See specific algorithm for interpreting result scores - - comparison image, or image to evaluate for no-reference quality algorithms - - - - Implements Algorithm::clear() - - - - - BRISQUE (Blind/Referenceless Image Spatial Quality Evaluator) is a No Reference Image Quality Assessment (NR-IQA) algorithm. - BRISQUE computes a score based on extracting Natural Scene Statistics(https://en.wikipedia.org/wiki/Scene_statistics) - and calculating feature vectors. See Mittal et al. @cite Mittal2 for original paper and original implementation @cite Mittal2_software. - A trained model is provided in the /samples/ directory and is trained on the LIVE-R2 database @cite Sheikh as in the original implementation. - When evaluated against the TID2008 database @cite Ponomarenko, the SROCC is -0.8424 versus the SROCC of -0.8354 in the original implementation. - C++ code for the BRISQUE LIVE-R2 trainer and TID2008 evaluator are also provided in the /samples/ directory. - - - - - Creates instance by raw pointer - - - - - Create an object which calculates quality - - String which contains a path to the BRISQUE model data, eg. /path/to/brisque_model_live.yml - String which contains a path to the BRISQUE range data, eg. /path/to/brisque_range_live.yml - - - - - Create an object which calculates quality - - cv::ml::SVM* which contains a loaded BRISQUE model - cv::Mat which contains BRISQUE range data - - - - - static method for computing quality - - image for which to compute quality - String which contains a path to the BRISQUE model data, eg. /path/to/brisque_model_live.yml - cv::String which contains a path to the BRISQUE range data, eg. /path/to/brisque_range_live.yml - cv::Scalar with the score in the first element. The score ranges from 0 (best quality) to 100 (worst quality) - - - - static method for computing image features used by the BRISQUE algorithm - - image (BGR(A) or grayscale) for which to compute features - output row vector of features to cv::Mat or cv::UMat - - - - Releases managed resources - - - - - Full reference GMSD algorithm - - - - - Creates instance by raw pointer - - - - - Create an object which calculates quality - - input image to use as the source for comparison - - - - - static method for computing quality - - - - output quality map, or null - cv::Scalar with per-channel quality values. Values range from 0 (worst) to 1 (best) - - - - Releases managed resources - - - - - Full reference mean square error algorithm https://en.wikipedia.org/wiki/Mean_squared_error - - - - - Creates instance by raw pointer - - - - - Create an object which calculates quality - - input image to use as the source for comparison - - - - - static method for computing quality - - - - output quality map, or null - cv::Scalar with per-channel quality values. Values range from 0 (worst) to 1 (best) - - - - Releases managed resources - - - - - Full reference peak signal to noise ratio (PSNR) algorithm https://en.wikipedia.org/wiki/Peak_signal-to-noise_ratio - - - - - Creates instance by raw pointer - - - - - get or set the maximum pixel value used for PSNR computation - - - - - - Create an object which calculates quality - - input image to use as the source for comparison - maximum per-channel value for any individual pixel; eg 255 for uint8 image - - - - - static method for computing quality - - - - output quality map, or null - maximum per-channel value for any individual pixel; eg 255 for uint8 image - PSNR value, or double.PositiveInfinity if the MSE between the two images == 0 - - - - Releases managed resources - - - - - Full reference structural similarity algorithm https://en.wikipedia.org/wiki/Structural_similarity - - - - - Creates instance by raw pointer - - - - - Create an object which calculates quality - - input image to use as the source for comparison - - - - - static method for computing quality - - - - output quality map, or null - cv::Scalar with per-channel quality values. Values range from 0 (worst) to 1 (best) - - - - Releases managed resources - - - - - A simple Hausdorff distance measure between shapes defined by contours - - - according to the paper "Comparing Images using the Hausdorff distance." - by D.P. Huttenlocher, G.A. Klanderman, and W.J. Rucklidge. (PAMI 1993). : - - - - - - - - - - Complete constructor - - Flag indicating which norm is used to compute the Hausdorff distance (NORM_L1, NORM_L2). - fractional value (between 0 and 1). - - - - - Releases managed resources - - - - - Flag indicating which norm is used to compute the Hausdorff distance (NORM_L1, NORM_L2). - - - - - fractional value (between 0 and 1). - - - - - Implementation of the Shape Context descriptor and matching algorithm - - - proposed by Belongie et al. in "Shape Matching and Object Recognition Using Shape Contexts" - (PAMI2002). This implementation is packaged in a generic scheme, in order to allow - you the implementation of the common variations of the original pipeline. - - - - - - - - - - Complete constructor - - The number of angular bins in the shape context descriptor. - The number of radial bins in the shape context descriptor. - The value of the inner radius. - The value of the outer radius. - - - - - - Releases managed resources - - - - - The number of angular bins in the shape context descriptor. - - - - - The number of radial bins in the shape context descriptor. - - - - - The value of the inner radius. - - - - - The value of the outer radius. - - - - - - - - - - The weight of the shape context distance in the final distance value. - - - - - The weight of the appearance cost in the final distance value. - - - - - The weight of the Bending Energy in the final distance value. - - - - - - - - - - The value of the standard deviation for the Gaussian window for the image appearance cost. - - - - - Set the images that correspond to each shape. - This images are used in the calculation of the Image Appearance cost. - - Image corresponding to the shape defined by contours1. - Image corresponding to the shape defined by contours2. - - - - Get the images that correspond to each shape. - This images are used in the calculation of the Image Appearance cost. - - Image corresponding to the shape defined by contours1. - Image corresponding to the shape defined by contours2. - - - - Abstract base class for shape distance algorithms. - - - - - Compute the shape distance between two shapes defined by its contours. - - Contour defining first shape. - Contour defining second shape. - - - - - Features matcher similar to cv::detail::BestOf2NearestMatcher which - finds two best matches for each feature and leaves the best one only if the - ratio between descriptor distances is greater than the threshold match_conf. - - Unlike cv::detail::BestOf2NearestMatcher this matcher uses affine - transformation (affine transformation estimate will be placed in matches_info). - - - - - Constructs a "best of 2 nearest" matcher that expects affine transformation between images - - whether to use full affine transformation with 6 degress of freedom - or reduced transformation with 4 degrees of freedom using only rotation, translation and - uniform scaling - Should try to use GPU or not - Match distances ration threshold - Minimum number of matches required for the 2D affine transform - estimation used in the inliers classification step - - - - releases unmanaged resources - - - - - Features matcher which finds two best matches for each feature and leaves the best one only if the - ratio between descriptor distances is greater than the threshold match_conf - - - - - Constructs a "best of 2 nearest" matcher. - - Should try to use GPU or not - Match distances ration threshold - Minimum number of matches required for the 2D projective transform - estimation used in the inliers classification step - Minimum number of matches required for the 2D projective transform - re-estimation on inliers - - - - Constructor - - - - - - releases unmanaged resources - - - - - Frees unused memory allocated before if there is any. - - - - - cv::detail functions - - - - - - - - - - - - - - - - - - - - - Feature matchers base class. - - - - - Constructor - - - - - - Performs images matching. - - First image features - Second image features - Found matches - - - - Performs images matching. - - Features of the source images - Mask indicating which image pairs must be matched - Found pairwise matches - - - - True, if it's possible to use the same matcher instance in parallel, false otherwise - - - - - - Frees unused memory allocated before if there is any. - - - - - Structure containing image keypoints and descriptors. - - - - - Constructor - - - - - - - - - Destructor - - - - - - - - - - - - - Structure containing information about matches between two images. - - It's assumed that there is a transformation between those images. Transformation may be - homography or affine transformation based on selected matcher. - - - - - Images indices (optional) - - - - - Images indices (optional) - - - - - - - - - - Geometrically consistent matches mask - - - - - Number of geometrically consistent matches - - - - - Estimated transformation - - - - - Confidence two images are from the same panorama - - - - - Constructor - - - - - - - - - - - - Copy constructor - - - - - - Dispose H - - - - - High level image stitcher. - It's possible to use this class without being aware of the entire stitching - pipeline. However, to be able to achieve higher stitching stability and - quality of the final images at least being familiar with the theory is recommended - - - - - Status code - - - - - Mode for creating photo panoramas. Expects images under perspective - transformation and projects resulting pano to sphere. - - - - - Mode for composing scans. Expects images under affine transformation does - not compensate exposure by default. - - - - - Constructor - - cv::Stitcher* - - - - Creates a Stitcher configured in one of the stitching modes. - - Scenario for stitcher operation. This is usually determined by source of images - to stitch and their transformation.Default parameters will be chosen for operation in given scenario. - - - - Releases managed resources - - - - - Try to stitch the given images. - - Input images. - Final pano. - Status code. - - - - Try to stitch the given images. - - Input images. - Final pano. - Status code. - - - - Try to stitch the given images. - - Input images. - Region of interest rectangles. - Final pano. - Status code. - - - - Try to stitch the given images. - - Input images. - Region of interest rectangles. - Final pano. - Status code. - - - - - - - - - - - - - - - - - - - Creates instance from cv::Ptr<T> . - ptr is disposed when the wrapper disposes. - - - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Clear all inner buffers. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates instance from cv::Ptr<T> . - ptr is disposed when the wrapper disposes. - - - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates instance from cv::Ptr<T> . - ptr is disposed when the wrapper disposes. - - - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates instance from cv::Ptr<T> . - ptr is disposed when the wrapper disposes. - - - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates instance from cv::Ptr<T> . - ptr is disposed when the wrapper disposes. - - - - - - Releases managed resources - - - - - - - - - - - - - - - - - - - - Base class for Super Resolution algorithms. - - - - - Constructor - - - - - Creates instance from cv::Ptr<T> . - ptr is disposed when the wrapper disposes. - - - - - - - Releases managed resources - - - - - Create Bilateral TV-L1 Super Resolution. - - - - - - Create Bilateral TV-L1 Super Resolution. - - - - - - Set input frame source for Super Resolution algorithm. - - Input frame source - - - - Process next frame from input and return output result. - - Output result - - - - - - - - Clear all inner buffers. - - - - - - - - - - - - - - - - Scale factor - - - - - Iterations count - - - - - Asymptotic value of steepest descent method - - - - - Weight parameter to balance data term and smoothness term - - - - - Parameter of spacial distribution in Bilateral-TV - - - - - Kernel size of Bilateral-TV filter - - - - - Gaussian blur kernel size - - - - - Gaussian blur sigma - - - - - Radius of the temporal search area - - - - - base class BaseOCR declares a common API that would be used in a typical text recognition scenario - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - cv::text functions - - - - - Applies the Stroke Width Transform operator followed by filtering of connected components of similar Stroke Widths to - return letter candidates. It also chain them by proximity and size, saving the result in chainBBs. - - input the input image with 3 channels. - a boolean value signifying whether the text is darker or lighter than the background, - it is observed to reverse the gradient obtained from Scharr operator, and significantly affect the result. - an optional Mat of type CV_8UC3 which visualises the detected letters using bounding boxes. - an optional parameter which chains the letter candidates according to heuristics in the - paper and returns all possible regions where text is likely to occur. - a vector of resulting bounding boxes where probability of finding text is high - - - - Recognize text using the tesseract-ocr API. - - Takes image on input and returns recognized text in the output_text parameter. - Optionallyprovides also the Rects for individual text elements found(e.g.words), - and the list of those text elements with their confidence values. - - - - - Constructor - - - - - - Creates an instance of the OCRTesseract class. Initializes Tesseract. - - datapath the name of the parent directory of tessdata ended with "/", or null to use the system's default directory. - an ISO 639-3 code or NULL will default to "eng". - specifies the list of characters used for recognition. - null defaults to "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ". - tesseract-ocr offers different OCR Engine Modes (OEM), - by deffault tesseract::OEM_DEFAULT is used.See the tesseract-ocr API documentation for other possible values. - tesseract-ocr offers different Page Segmentation Modes (PSM) tesseract::PSM_AUTO (fully automatic layout analysis) is used. - See the tesseract-ocr API documentation for other possible values. - - - - Releases managed resources - - - - - Recognize text using the tesseract-ocr API. - Takes image on input and returns recognized text in the output_text parameter. - Optionally provides also the Rects for individual text elements found(e.g.words), - and the list of those text elements with their confidence values. - - Input image CV_8UC1 or CV_8UC3 - Output text of the tesseract-ocr. - If provided the method will output a list of Rects for the individual - text elements found(e.g.words or text lines). - If provided the method will output a list of text strings for the - recognition of individual text elements found(e.g.words or text lines). - If provided the method will output a list of confidence values - for the recognition of individual text elements found(e.g.words or text lines). - OCR_LEVEL_WORD (by default), or OCR_LEVEL_TEXT_LINE. - - - - Recognize text using the tesseract-ocr API. - Takes image on input and returns recognized text in the output_text parameter. - Optionally provides also the Rects for individual text elements found(e.g.words), - and the list of those text elements with their confidence values. - - Input image CV_8UC1 or CV_8UC3 - - Output text of the tesseract-ocr. - If provided the method will output a list of Rects for the individual - text elements found(e.g.words or text lines). - If provided the method will output a list of text strings for the - recognition of individual text elements found(e.g.words or text lines). - If provided the method will output a list of confidence values - for the recognition of individual text elements found(e.g.words or text lines). - OCR_LEVEL_WORD (by default), or OCR_LEVEL_TEXT_LINE. - - - - - - - - - - An abstract class providing interface for text detection algorithms - - - - - Method that provides a quick and simple interface to detect text inside an image - - an image to process - a vector of Rect that will store the detected word bounding box - a vector of float that will be updated with the confidence the classifier has for the selected bounding box - - - - TextDetectorCNN class provides the functionality of text bounding box detection. - - - This class is representing to find bounding boxes of text words given an input image. - This class uses OpenCV dnn module to load pre-trained model described in @cite LiaoSBWL17. - The original repository with the modified SSD Caffe version: https://github.com/MhLiao/TextBoxes. - Model can be downloaded from[DropBox](https://www.dropbox.com/s/g8pjzv2de9gty8g/TextBoxes_icdar13.caffemodel?dl=0). - Modified.prototxt file with the model description can be found in `opencv_contrib/modules/text/samples/textbox.prototxt`. - - - - - cv::Ptr<T> - - - - - Creates an instance of the TextDetectorCNN class using the provided parameters. - - the relative or absolute path to the prototxt file describing the classifiers architecture. - the relative or absolute path to the file containing the pretrained weights of the model in caffe-binary form. - a list of sizes for multiscale detection. The values`[(300,300),(700,500),(700,300),(700,700),(1600,1600)]` - are recommended in @cite LiaoSBWL17 to achieve the best quality. - - - - - Creates an instance of the TextDetectorCNN class using the provided parameters. - - the relative or absolute path to the prototxt file describing the classifiers architecture. - the relative or absolute path to the file containing the pretrained weights of the model in caffe-binary form. - - - - - Releases managed resources - - - - - Method that provides a quick and simple interface to detect text inside an image - - an image to process - a vector of Rect that will store the detected word bounding box - a vector of float that will be updated with the confidence the classifier has for the selected bounding box - - - - - the CSRT tracker - The implementation is based on @cite Lukezic_IJCV2018 Discriminative Correlation Filter with Channel and Spatial Reliability - - - - - - - - - - Constructor - - - - - - Constructor - - CSRT parameters - - - - - - - - - - - CSRT Params - - - - - Window function: "hann", "cheb", "kaiser" - - - - - we lost the target, if the psr is lower than this. - - - - - - KCF is a novel tracking framework that utilizes properties of circulant matrix to enhance the processing speed. - * This tracking method is an implementation of @cite KCF_ECCV which is extended to KFC with color-names features(@cite KCF_CN). - * The original paper of KCF is available at [http://www.robots.ox.ac.uk/~joao/publications/henriques_tpami2015.pdf] - * as well as the matlab implementation.For more information about KCF with color-names features, please refer to - * [http://www.cvl.isy.liu.se/research/objrec/visualtracking/colvistrack/index.html]. - - - - - - - - - - Constructor - - - - - - Constructor - - KCF parameters TrackerKCF::Params - - - - - - - - - detection confidence threshold - - - - - gaussian kernel bandwidth - - - - - regularization - - - - - linear interpolation factor for adaptation - - - - - spatial bandwidth (proportional to target) - - - - - compression learning rate - - - - - activate the resize feature to improve the processing speed - - - - - split the training coefficients into two matrices - - - - - wrap around the kernel values - - - - - activate the pca method to compress the features - - - - - threshold for the ROI size - - - - - feature size after compression - - - - - compressed descriptors of TrackerKCF::MODE - - - - - non-compressed descriptors of TrackerKCF::MODE - - - - - channel indices for multi-head camera live streams - - - - - Depth values in mm (CV_16UC1) - - - - - XYZ in meters (CV_32FC3) - - - - - Disparity in pixels (CV_8UC1) - - - - - Disparity in pixels (CV_32FC1) - - - - - CV_8UC1 - - - - - Position in relative units - - - - - Start of the file - - - - - End of the file - - - - - Capture type of CvCapture (Camera or AVI file) - - - - - Captures from an AVI file - - - - - Captures from digital camera - - - - - - - - - - Video Acceleration type - Used as value in #CAP_PROP_HW_ACCELERATION and #VIDEOWRITER_PROP_HW_ACCELERATION - note In case of FFmpeg backend, it translated to enum AVHWDeviceType (https://github.com/FFmpeg/FFmpeg/blob/master/libavutil/hwcontext.h) - - - - - Do not require any specific H/W acceleration, prefer software processing. - Reading of this value means that special H/W accelerated handling is not added or not detected by OpenCV. - - - - - Prefer to use H/W acceleration. If no one supported, then fallback to software processing. - note H/W acceleration may require special configuration of used environment. - note Results in encoding scenario may differ between software and hardware accelerated encoders. - - - - - DirectX 11 - - - - - VAAPI - - - - - libmfx (Intel MediaSDK/oneVPL) - - - - - Camera device types - - - https://github.com/opencv/opencv/blob/d3bc563c6e01c2bc153f23e7393322a95c7d3974/modules/videoio/include/opencv2/videoio.hpp#L89 - - - - - Auto detect == 0 - - - - - V4L/V4L2 capturing support - - - - - Same as CAP_V4L - - - - - IEEE 1394 drivers - - - - - Same value as CAP_FIREWIRE - - - - - Same value as CAP_FIREWIRE - - - - - Same value as CAP_FIREWIRE - - - - - Same value as CAP_FIREWIRE - - - - - DirectShow (via videoInput) - - - - - PvAPI, Prosilica GigE SDK - - - - - OpenNI (for Kinect) - - - - - OpenNI (for Asus Xtion) - - - - - Android - not used - - - - - XIMEA Camera API - - - - - AVFoundation framework for iOS (OS X Lion will have the same API) - - - - - Smartek Giganetix GigEVisionSDK - - - - - Microsoft Media Foundation (via videoInput) - - - - - Microsoft Windows Runtime using Media Foundation - - - - - RealSense (former Intel Perceptual Computing SDK) - - - - - Synonym for CAP_INTELPERC - - - - - OpenNI2 (for Kinect) - - - - - OpenNI2 (for Asus Xtion and Occipital Structure sensors) - - - - - gPhoto2 connection - - - - - GStreamer - - - - - Open and record video file or stream using the FFMPEG library - - - - - OpenCV Image Sequence (e.g. img_%02d.jpg) - - - - - Aravis SDK - - - - - Built-in OpenCV MotionJPEG codec - - - - - Intel MediaSDK - - - - - XINE engine (Linux) - - - - - uEye Camera API - - - - - Parameters of VideoCature for hardware acceleration - Please check the link below for current HW acceleration types support matrix - https://github.com/opencv/opencv/wiki/Video-IO-hardware-acceleration - - - - - Used as value in #CAP_PROP_HW_ACCELERATION and #VIDEOWRITER_PROP_HW_ACCELERATION - note In case of FFmpeg backend, it translated to enum AVHWDeviceType (https://github.com/FFmpeg/FFmpeg/blob/master/libavutil/hwcontext.h) - - - - - Hardware device index (select GPU if multiple available). Device enumeration is acceleration type specific. - - - - - Constructor, parameter of VideoCature for hardware acceleration - - - - - Constructor, parameter of VideoCature for hardware acceleration - - Video Acceleration type - Hardware device index - - - - Get parameters of VideoCature for hardware acceleration - - - - - Property identifiers for CvCapture - - - https://github.com/opencv/opencv/blob/d3bc563c6e01c2bc153f23e7393322a95c7d3974/modules/videoio/include/opencv2/videoio.hpp#L133 - - - - - Position in milliseconds from the file beginning - - - - - Position in frames (only for video files) - - - - - Position in relative units (0 - start of the file, 1 - end of the file) - - - - - Width of frames in the video stream (only for cameras) - - - - - Height of frames in the video stream (only for cameras) - - - - - Frame rate (only for cameras) - - - - - 4-character code of codec (only for cameras). - - - - - Number of frames in the video stream - - - - - The format of the Mat objects returned by retrieve() - - - - - A backend-specific value indicating the current capture mode - - - - - Brightness of image (only for cameras) - - - - - contrast of image (only for cameras) - - - - - Saturation of image (only for cameras) - - - - - hue of image (only for cameras) - - - - - Gain of the image (only for cameras) - - - - - Exposure (only for cameras) - - - - - Boolean flags indicating whether images should be converted to RGB - - - - - - - - - - TOWRITE (note: only supported by DC1394 v 2.x backend currently) - - - - - - - - - - - - - - - exposure control done by camera, - user can adjust refernce level using this feature - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Pop up video/camera filter dialog (note: only supported by DSHOW backend currently. Property value is ignored) - - - - - - - - - - - - - - - Sample aspect ratio: num/den (num) - - - - - Sample aspect ratio: num/den (den) - - - - - Current backend (enum VideoCaptureAPIs). Read-only property - - - - - Video input or Channel Number (only for those cameras that support) - - - - - enable/ disable auto white-balance - - - - - white-balance color temperature - - - - - (read-only) codec's pixel format. 4-character code - see VideoWriter::fourcc . Subset of [AV_PIX_FMT_*](https://github.com/FFmpeg/FFmpeg/blob/master/libavcodec/raw.c) or -1 if unknown - - - - - (read-only) Video bitrate in kbits/s - - - - - (read-only) Frame rotation defined by stream meta (applicable for FFmpeg back-end only) - - - - - if true - rotates output frames of CvCapture considering video file's metadata (applicable for FFmpeg back-end only) (https://github.com/opencv/opencv/issues/15499) - - - - - (open-only) Hardware acceleration type (see VideoAccelerationType). - Setting supported only via params parameter in cv::VideoCapture constructor / .open() method. - Default value is backend-specific. - - - - - (open-only) Hardware device index (select GPU if multiple available). Device enumeration is acceleration type specific. - - - - - - - - - - in mm - - - - - in mm - - - - - in pixels - - - - - flag that synchronizes the remapping depth map to image map - by changing depth generator's view point (if the flag is "on") or - sets this view point to its normal one (if the flag is "off"). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - default is 1 - - - - - ip for anable multicast master mode. 0 for disable multicast - - - - - Determines how a frame is initiated - - - - - Horizontal sub-sampling of the image - - - - - Vertical sub-sampling of the image - - - - - Horizontal binning factor - - - - - Vertical binning factor - - - - - Pixel format - - - - - Change image resolution by binning or skipping. - - - - - Output data format. - - - - - Horizontal offset from the origin to the area of interest (in pixels). - - - - - Vertical offset from the origin to the area of interest (in pixels). - - - - - Defines source of trigger. - - - - - Generates an internal trigger. PRM_TRG_SOURCE must be set to TRG_SOFTWARE. - - - - - Selects general purpose input - - - - - Set general purpose input mode - - - - - Get general purpose level - - - - - Selects general purpose output - - - - - Set general purpose output mode - - - - - Selects camera signalling LED - - - - - Define camera signalling LED functionality - - - - - Calculates White Balance(must be called during acquisition) - - - - - Automatic white balance - - - - - Automatic exposure/gain - - - - - Exposure priority (0.5 - exposure 50%, gain 50%). - - - - - Maximum limit of exposure in AEAG procedure - - - - - Maximum limit of gain in AEAG procedure - - - - - Average intensity of output signal AEAG should achieve(in %) - - - - - Image capture timeout in milliseconds - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Capture only preview from liveview mode. - - - - - Readonly, returns (const char *). - - - - - Trigger, only by set. Reload camera settings. - - - - - Reload all settings on set. - - - - - Collect messages with details. - - - - - Readonly, returns (const char *). - - - - - Exposure speed. Can be readonly, depends on camera program. - - - - - Aperture. Can be readonly, depends on camera program. - - - - - Camera exposure program. - - - - - Enter liveview mode. - - - - - Parameters of VideoWriter for hardware acceleration - Please check the link below for current HW acceleration types support matrix - https://github.com/opencv/opencv/wiki/Video-IO-hardware-acceleration - - - - - Used as value in #CAP_PROP_HW_ACCELERATION and #VIDEOWRITER_PROP_HW_ACCELERATION - note In case of FFmpeg backend, it translated to enum AVHWDeviceType (https://github.com/FFmpeg/FFmpeg/blob/master/libavutil/hwcontext.h) - - - - - Hardware device index (select GPU if multiple available). Device enumeration is acceleration type specific. - - - - - Constructor, parameter of VideoWriter for hardware acceleration - - - - - Constructor, parameter of VideoWriter for hardware acceleration - - Video Acceleration type - Hardware device index - - - - Get parameters of VideoWriter for hardware acceleration - - - - - VideoWriter generic properties identifier. - - - - - Current quality (0..100%) of the encoded video stream. Can be adjusted dynamically in some codecs. - - - - - (Read-only): Size of just encoded video frame. Note that the encoding order may be different from representation order. - - - - - Number of stripes for parallel encoding. -1 for auto detection. - - - - - If it is not zero, the encoder will expect and encode color frames, otherwise it will work with grayscale frames. - - - - - Defaults to CV_8U. - - - - - (open-only) Hardware acceleration type (see VideoAccelerationType). - Setting supported only via params parameter in cv::VideoCapture constructor / .open() method. - Default value is backend-specific. - - - - - (open-only) Hardware device index (select GPU if multiple available). Device enumeration is acceleration type specific. - - - - - 4-character code of codec used to compress the frames. - - - - - int value - - - - - Constructor - - - - - - Create from four characters - - - - - - - - - - Create from string (length == 4) - - - - - - - implicit cast to int - - - - - - cast to int - - - - - - implicit cast from int - - - - - - cast from int - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Video capturing class - - - - - Capture type (File or Camera) - - - - - Initializes empty capture. - To use this, you should call Open. - - - - - - Opens a camera for video capturing - - id of the video capturing device to open. To open default camera using default backend just pass 0. - (to backward compatibility usage of camera_id + domain_offset (CAP_*) is valid when apiPreference is CAP_ANY) - preferred Capture API backends to use. Can be used to enforce a specific reader implementation - if multiple are available: e.g. cv::CAP_DSHOW or cv::CAP_MSMF or cv::CAP_V4L. - - - - - Opens a camera for video capturing with API Preference and parameters - - id of the video capturing device to open. To open default camera using default backend just pass 0. - (to backward compatibility usage of camera_id + domain_offset (CAP_*) is valid when apiPreference is CAP_ANY) - preferred Capture API backends to use. Can be used to enforce a specific reader implementation - if multiple are available: e.g. cv::CAP_DSHOW or cv::CAP_MSMF or cv::CAP_V4L. - The `params` parameter allows to specify extra parameters encoded as pairs `(paramId_1, paramValue_1, paramId_2, paramValue_2, ...)`. - See cv::VideoCaptureProperties - - - - - Opens a camera for video capturing with API Preference and parameters - - id of the video capturing device to open. To open default camera using default backend just pass 0. - (to backward compatibility usage of camera_id + domain_offset (CAP_*) is valid when apiPreference is CAP_ANY) - preferred Capture API backends to use. Can be used to enforce a specific reader implementation - if multiple are available: e.g. cv::CAP_DSHOW or cv::CAP_MSMF or cv::CAP_V4L. - Parameters of VideoCature for hardware acceleration - - - - - Opens a camera for video capturing - - id of the video capturing device to open. To open default camera using default backend just pass 0. - (to backward compatibility usage of camera_id + domain_offset (CAP_*) is valid when apiPreference is CAP_ANY) - preferred Capture API backends to use. Can be used to enforce a specific reader implementation - if multiple are available: e.g. cv::CAP_DSHOW or cv::CAP_MSMF or cv::CAP_V4L. - - - - - Opens a video file or a capturing device or an IP video stream for video capturing with API Preference - - it can be: - - name of video file (eg. `video.avi`) - - or image sequence (eg. `img_%02d.jpg`, which will read samples like `img_00.jpg, img_01.jpg, img_02.jpg, ...`) - - or URL of video stream (eg. `protocol://host:port/script_name?script_params|auth`). - Note that each video stream or IP camera feed has its own URL scheme. Please refer to the - documentation of source stream to know the right URL. - apiPreference preferred Capture API backends to use. Can be used to enforce a specific reader - implementation if multiple are available: e.g. cv::CAP_FFMPEG or cv::CAP_IMAGES or cv::CAP_DSHOW. - - - - - Opens a video file or a capturing device or an IP video stream for video capturing with API Preference - - it can be: - - name of video file (eg. `video.avi`) - - or image sequence (eg. `img_%02d.jpg`, which will read samples like `img_00.jpg, img_01.jpg, img_02.jpg, ...`) - - or URL of video stream (eg. `protocol://host:port/script_name?script_params|auth`). - Note that each video stream or IP camera feed has its own URL scheme. Please refer to the - documentation of source stream to know the right URL. - apiPreference preferred Capture API backends to use. Can be used to enforce a specific reader - implementation if multiple are available: e.g. cv::CAP_FFMPEG or cv::CAP_IMAGES or cv::CAP_DSHOW. - The `params` parameter allows to specify extra parameters encoded as pairs `(paramId_1, paramValue_1, paramId_2, paramValue_2, ...)`. - See cv::VideoCaptureProperties - - - - - Opens a video file or a capturing device or an IP video stream for video capturing with API Preference - - it can be: - - name of video file (eg. `video.avi`) - - or image sequence (eg. `img_%02d.jpg`, which will read samples like `img_00.jpg, img_01.jpg, img_02.jpg, ...`) - - or URL of video stream (eg. `protocol://host:port/script_name?script_params|auth`). - Note that each video stream or IP camera feed has its own URL scheme. Please refer to the - documentation of source stream to know the right URL. - apiPreference preferred Capture API backends to use. Can be used to enforce a specific reader - implementation if multiple are available: e.g. cv::CAP_FFMPEG or cv::CAP_IMAGES or cv::CAP_DSHOW. - Parameters of VideoCature for hardware acceleration - - - - - Opens a video file or a capturing device or an IP video stream for video capturing with API Preference - - it can be: - - name of video file (eg. `video.avi`) - - or image sequence (eg. `img_%02d.jpg`, which will read samples like `img_00.jpg, img_01.jpg, img_02.jpg, ...`) - - or URL of video stream (eg. `protocol://host:port/script_name?script_params|auth`). - Note that each video stream or IP camera feed has its own URL scheme. Please refer to the - documentation of source stream to know the right URL. - apiPreference preferred Capture API backends to use. Can be used to enforce a specific reader - implementation if multiple are available: e.g. cv::CAP_FFMPEG or cv::CAP_IMAGES or cv::CAP_DSHOW. - - - - - Initializes from native pointer - - CvCapture* - - - - Releases unmanaged resources - - - - - Gets the capture type (File or Camera) - - - - - Gets or sets film current position in milliseconds or video capture timestamp - - - - - Gets or sets 0-based index of the frame to be decoded/captured next - - - - - Gets or sets relative position of video file - - - - - Gets or sets width of frames in the video stream - - - - - Gets or sets height of frames in the video stream - - - - - Gets or sets frame rate - - - - - Gets or sets 4-character code of codec - - - - - Gets number of frames in video file - - - - - Gets or sets brightness of image (only for cameras) - - - - - Gets or sets contrast of image (only for cameras) - - - - - Gets or sets saturation of image (only for cameras) - - - - - Gets or sets hue of image (only for cameras) - - - - - The format of the Mat objects returned by retrieve() - - - - - A backend-specific value indicating the current capture mode - - - - - Gain of the image (only for cameras) - - - - - Exposure (only for cameras) - - - - - Boolean flags indicating whether images should be converted to RGB - - - - - - - - - - TOWRITE (note: only supported by DC1394 v 2.x backend currently) - - - - - - - - - - - - - - - exposure control done by camera, - user can adjust refernce level using this feature - [CV_CAP_PROP_AUTO_EXPOSURE] - - - - - - - - - - - [CV_CAP_PROP_TEMPERATURE] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [CV_CAP_PROP_OPENNI_OUTPUT_MODE] - - - - - in mm - [CV_CAP_PROP_OPENNI_FRAME_MAX_DEPTH] - - - - - in mm - [CV_CAP_PROP_OPENNI_BASELINE] - - - - - in pixels - [CV_CAP_PROP_OPENNI_FOCAL_LENGTH] - - - - - flag that synchronizes the remapping depth map to image map - by changing depth generator's view point (if the flag is "on") or - sets this view point to its normal one (if the flag is "off"). - [CV_CAP_PROP_OPENNI_REGISTRATION] - - - - - - [CV_CAP_OPENNI_IMAGE_GENERATOR_OUTPUT_MODE] - - - - - - [CV_CAP_OPENNI_DEPTH_GENERATOR_BASELINE] - - - - - - [CV_CAP_OPENNI_DEPTH_GENERATOR_FOCAL_LENGTH] - - - - - - [CV_CAP_OPENNI_DEPTH_GENERATOR_REGISTRATION_ON] - - - - - default is 1 - [CV_CAP_GSTREAMER_QUEUE_LENGTH] - - - - - ip for anable multicast master mode. 0 for disable multicast - [CV_CAP_PROP_PVAPI_MULTICASTIP] - - - - - Change image resolution by binning or skipping. - [CV_CAP_PROP_XI_DOWNSAMPLING] - - - - - Output data format. - [CV_CAP_PROP_XI_DATA_FORMAT] - - - - - Horizontal offset from the origin to the area of interest (in pixels). - [CV_CAP_PROP_XI_OFFSET_X] - - - - - Vertical offset from the origin to the area of interest (in pixels). - [CV_CAP_PROP_XI_OFFSET_Y] - - - - - Defines source of trigger. - [CV_CAP_PROP_XI_TRG_SOURCE] - - - - - Generates an internal trigger. PRM_TRG_SOURCE must be set to TRG_SOFTWARE. - [CV_CAP_PROP_XI_TRG_SOFTWARE] - - - - - Selects general purpose input - [CV_CAP_PROP_XI_GPI_SELECTOR] - - - - - Set general purpose input mode - [CV_CAP_PROP_XI_GPI_MODE] - - - - - Get general purpose level - [CV_CAP_PROP_XI_GPI_LEVEL] - - - - - Selects general purpose output - [CV_CAP_PROP_XI_GPO_SELECTOR] - - - - - Set general purpose output mode - [CV_CAP_PROP_XI_GPO_MODE] - - - - - Selects camera signalling LED - [CV_CAP_PROP_XI_LED_SELECTOR] - - - - - Define camera signalling LED functionality - [CV_CAP_PROP_XI_LED_MODE] - - - - - Calculates White Balance(must be called during acquisition) - [CV_CAP_PROP_XI_MANUAL_WB] - - - - - Automatic white balance - [CV_CAP_PROP_XI_AUTO_WB] - - - - - Automatic exposure/gain - [CV_CAP_PROP_XI_AEAG] - - - - - Exposure priority (0.5 - exposure 50%, gain 50%). - [CV_CAP_PROP_XI_EXP_PRIORITY] - - - - - Maximum limit of exposure in AEAG procedure - [CV_CAP_PROP_XI_AE_MAX_LIMIT] - - - - - Maximum limit of gain in AEAG procedure - [CV_CAP_PROP_XI_AG_MAX_LIMIT] - - - - - default is 1 - [CV_CAP_PROP_XI_AEAG_LEVEL] - - - - - default is 1 - [CV_CAP_PROP_XI_TIMEOUT] - - - - - Opens a video file or a capturing device or an IP video stream for video capturing. - - it can be: - - name of video file (eg. `video.avi`) - - or image sequence (eg. `img_%02d.jpg`, which will read samples like `img_00.jpg, img_01.jpg, img_02.jpg, ...`) - - or URL of video stream (eg. `protocol://host:port/script_name?script_params|auth`). - Note that each video stream or IP camera feed has its own URL scheme. Please refer to the - documentation of source stream to know the right URL. - apiPreference preferred Capture API backends to use. Can be used to enforce a specific reader - implementation if multiple are available: e.g. cv::CAP_FFMPEG or cv::CAP_IMAGES or cv::CAP_DSHOW. - `true` if the file has been successfully opened - - - - Opens a camera for video capturing - - id of the video capturing device to open. To open default camera using default backend just pass 0. - (to backward compatibility usage of camera_id + domain_offset (CAP_*) is valid when apiPreference is CAP_ANY) - preferred Capture API backends to use. Can be used to enforce a specific reader implementation - if multiple are available: e.g. cv::CAP_DSHOW or cv::CAP_MSMF or cv::CAP_V4L. - `true` if the file has been successfully opened - - - - Returns true if video capturing has been initialized already. - - - - - - Closes video file or capturing device. - - - - - - Grabs the next frame from video file or capturing device. - - The method/function grabs the next frame from video file or camera and returns true (non-zero) in the case of success. - - The primary use of the function is in multi-camera environments, especially when the cameras do not - have hardware synchronization. That is, you call VideoCapture::grab() for each camera and after that - call the slower method VideoCapture::retrieve() to decode and get frame from each camera. This way - the overhead on demosaicing or motion jpeg decompression etc. is eliminated and the retrieved frames - from different cameras will be closer in time. - - Also, when a connected camera is multi-head (for example, a stereo camera or a Kinect device), the - correct way of retrieving data from it is to call VideoCapture::grab() first and then call - VideoCapture::retrieve() one or more times with different values of the channel parameter. - - `true` (non-zero) in the case of success. - - - - Decodes and returns the grabbed video frame. - - The method decodes and returns the just grabbed frame. If no frames has been grabbed - (camera has been disconnected, or there are no more frames in video file), the method returns false - and the function returns an empty image (with %cv::Mat, test it with Mat::empty()). - - the video frame is returned here. If no frames has been grabbed the image will be empty. - it could be a frame index or a driver specific flag - - - - - Decodes and returns the grabbed video frame. - - The method decodes and returns the just grabbed frame. If no frames has been grabbed - (camera has been disconnected, or there are no more frames in video file), the method returns false - and the function returns an empty image (with %cv::Mat, test it with Mat::empty()). - - the video frame is returned here. If no frames has been grabbed the image will be empty. - non-zero streamIdx is only valid for multi-head camera live streams - - - - - Decodes and returns the grabbed video frame. - - The method decodes and returns the just grabbed frame. If no frames has been grabbed - (camera has been disconnected, or there are no more frames in video file), the method returns false - and the function returns an empty image (with %cv::Mat, test it with Mat::empty()). - - the video frame is returned here. If no frames has been grabbed the image will be empty. - it could be a frame index or a driver specific flag - - - - - Decodes and returns the grabbed video frame. - - The method decodes and returns the just grabbed frame. If no frames has been grabbed - (camera has been disconnected, or there are no more frames in video file), the method returns false - and the function returns an empty image (with %cv::Mat, test it with Mat::empty()). - - the video frame is returned here. If no frames has been grabbed the image will be empty. - non-zero streamIdx is only valid for multi-head camera live streams - - - - - Decodes and returns the grabbed video frame. - - The method decodes and returns the just grabbed frame. If no frames has been grabbed - (camera has been disconnected, or there are no more frames in video file), the method returns false - and the function returns an empty image (with %cv::Mat, test it with Mat::empty()). - - the video frame is returned here. If no frames has been grabbed the image will be empty. - - - - Grabs, decodes and returns the next video frame. - - The method/function combines VideoCapture::grab() and VideoCapture::retrieve() in one call. This is the - most convenient method for reading video files or capturing data from decode and returns the just - grabbed frame. If no frames has been grabbed (camera has been disconnected, or there are no more - frames in video file), the method returns false and the function returns empty image (with %cv::Mat, test it with Mat::empty()). - - `false` if no frames has been grabbed - - - - Grabs, decodes and returns the next video frame. - - The method/function combines VideoCapture::grab() and VideoCapture::retrieve() in one call. This is the - most convenient method for reading video files or capturing data from decode and returns the just - grabbed frame. If no frames has been grabbed (camera has been disconnected, or there are no more - frames in video file), the method returns false and the function returns empty image (with %cv::Mat, test it with Mat::empty()). - - `false` if no frames has been grabbed - - - - Sets a property in the VideoCapture. - - Property identifier from cv::VideoCaptureProperties (eg. cv::CAP_PROP_POS_MSEC, cv::CAP_PROP_POS_FRAMES, ...) - or one from @ref videoio_flags_others - Value of the property. - `true` if the property is supported by backend used by the VideoCapture instance. - - - - Sets a property in the VideoCapture. - - Property identifier from cv::VideoCaptureProperties (eg. cv::CAP_PROP_POS_MSEC, cv::CAP_PROP_POS_FRAMES, ...) - or one from @ref videoio_flags_others - Value of the property. - `true` if the property is supported by backend used by the VideoCapture instance. - - - - Returns the specified VideoCapture property - - Property identifier from cv::VideoCaptureProperties (eg. cv::CAP_PROP_POS_MSEC, cv::CAP_PROP_POS_FRAMES, ...) - or one from @ref videoio_flags_others - Value for the specified property. Value 0 is returned when querying a property that is not supported by the backend used by the VideoCapture instance. - - - - Returns the specified VideoCapture property - - Property identifier from cv::VideoCaptureProperties (eg. cv::CAP_PROP_POS_MSEC, cv::CAP_PROP_POS_FRAMES, ...) - or one from @ref videoio_flags_others - Value for the specified property. Value 0 is returned when querying a property that is not supported by the backend used by the VideoCapture instance. - - - - Returns used backend API name. - Note that stream should be opened. - - - - - - Switches exceptions mode. - methods raise exceptions if not successful instead of returning an error code - - - - - - query if exception mode is active - - - - - - Wait for ready frames from VideoCapture. - - The primary use of the function is in multi-camera environments. - The method fills the ready state vector, grabs video frame, if camera is ready. - - After this call use VideoCapture::retrieve() to decode and fetch frame data. - - input video streams - stream indexes with grabbed frames (ready to use .retrieve() to fetch actual frame) - number of nanoseconds (0 - infinite) - Exception %Exception on stream errors (check .isOpened() - to filter out malformed streams) or VideoCapture type is not supported - `true if streamReady is not empty - - - - For accessing each byte of Int32 value - - - - - AVI Video File Writer - - - - - - - - - - Creates video writer structure. - - Name of the output video file. - 4-character code of codec used to compress the frames. For example, "PIM1" is MPEG-1 codec, "MJPG" is motion-jpeg codec etc. - Under Win32 it is possible to pass null in order to choose compression method and additional compression parameters from dialog. - Frame rate of the created video stream. - Size of video frames. - If it is true, the encoder will expect and encode color frames, otherwise it will work with grayscale frames (the flag is currently supported on Windows only). - - - - - Creates video writer structure. - - Name of the output video file. - allows to specify API backends to use. Can be used to enforce a specific reader implementation - if multiple are available: e.g. cv::CAP_FFMPEG or cv::CAP_GSTREAMER. - 4-character code of codec used to compress the frames. For example, "PIM1" is MPEG-1 codec, "MJPG" is motion-jpeg codec etc. - Under Win32 it is possible to pass null in order to choose compression method and additional compression parameters from dialog. - Frame rate of the created video stream. - Size of video frames. - If it is true, the encoder will expect and encode color frames, otherwise it will work with grayscale frames (the flag is currently supported on Windows only). - - - - - Creates video writer structure. - - Name of the output video file. - 4-character code of codec used to compress the frames. For example, "PIM1" is MPEG-1 codec, "MJPG" is motion-jpeg codec etc. - Under Win32 it is possible to pass null in order to choose compression method and additional compression parameters from dialog. - Frame rate of the created video stream. - Size of video frames. - The `params` parameter allows to specify extra encoder parameters encoded as pairs (paramId_1, paramValue_1, paramId_2, paramValue_2, ... .) - see cv::VideoWriterProperties - - - - - Creates video writer structure. - - Name of the output video file. - 4-character code of codec used to compress the frames. For example, "PIM1" is MPEG-1 codec, "MJPG" is motion-jpeg codec etc. - Under Win32 it is possible to pass null in order to choose compression method and additional compression parameters from dialog. - Frame rate of the created video stream. - Size of video frames. - Parameters of VideoWriter for hardware acceleration - - - - - Creates video writer structure. - - Name of the output video file. - allows to specify API backends to use. Can be used to enforce a specific reader implementation - if multiple are available: e.g. cv::CAP_FFMPEG or cv::CAP_GSTREAMER. - 4-character code of codec used to compress the frames. For example, "PIM1" is MPEG-1 codec, "MJPG" is motion-jpeg codec etc. - Under Win32 it is possible to pass null in order to choose compression method and additional compression parameters from dialog. - Frame rate of the created video stream. - Size of video frames. - The `params` parameter allows to specify extra encoder parameters encoded as pairs (paramId_1, paramValue_1, paramId_2, paramValue_2, ... .) - see cv::VideoWriterProperties - - - - - Creates video writer structure. - - Name of the output video file. - allows to specify API backends to use. Can be used to enforce a specific reader implementation - if multiple are available: e.g. cv::CAP_FFMPEG or cv::CAP_GSTREAMER. - 4-character code of codec used to compress the frames. For example, "PIM1" is MPEG-1 codec, "MJPG" is motion-jpeg codec etc. - Under Win32 it is possible to pass null in order to choose compression method and additional compression parameters from dialog. - Frame rate of the created video stream. - Size of video frames. - Parameters of VideoWriter for hardware acceleration - - - - - Initializes from native pointer - - CvVideoWriter* - - - - Releases unmanaged resources - - - - - Get output video file name - - - - - Frames per second of the output video - - - - - Get size of frame image - - - - - Get whether output frames is color or not - - - - - Creates video writer structure. - - Name of the output video file. - 4-character code of codec used to compress the frames. For example, "PIM1" is MPEG-1 codec, "MJPG" is motion-jpeg codec etc. - Under Win32 it is possible to pass null in order to choose compression method and additional compression parameters from dialog. - Frame rate of the created video stream. - Size of video frames. - If it is true, the encoder will expect and encode color frames, otherwise it will work with grayscale frames (the flag is currently supported on Windows only). - - - - - Creates video writer structure. - - Name of the output video file. - allows to specify API backends to use. Can be used to enforce a specific reader implementation - if multiple are available: e.g. cv::CAP_FFMPEG or cv::CAP_GSTREAMER. - 4-character code of codec used to compress the frames. For example, "PIM1" is MPEG-1 codec, "MJPG" is motion-jpeg codec etc. - Under Win32 it is possible to pass null in order to choose compression method and additional compression parameters from dialog. - Frame rate of the created video stream. - Size of video frames. - If it is true, the encoder will expect and encode color frames, otherwise it will work with grayscale frames (the flag is currently supported on Windows only). - - - - - Returns true if video writer has been successfully initialized. - - - - - - - - - - - - Writes/appends one frame to video file. - - the written frame. - - - - - Sets a property in the VideoWriter. - - Property identifier from cv::VideoWriterProperties (eg. cv::VIDEOWRITER_PROP_QUALITY) or one of @ref videoio_flags_others - Value of the property. - `true` if the property is supported by the backend used by the VideoWriter instance. - - - - Returns the specified VideoWriter property - - Property identifier from cv::VideoWriterProperties (eg. cv::VIDEOWRITER_PROP_QUALITY) or one of @ref videoio_flags_others - Value for the specified property. Value 0 is returned when querying a property that is not supported by the backend used by the VideoWriter instance. - - - - Concatenates 4 chars to a fourcc code. - This static method constructs the fourcc code of the codec to be used in - the constructor VideoWriter::VideoWriter or VideoWriter::open. - - - - - Concatenates 4 chars to a fourcc code. - This static method constructs the fourcc code of the codec to be used in - the constructor VideoWriter::VideoWriter or VideoWriter::open. - - - - - - - Returns used backend API name. - Note that stream should be opened. - - - - - - The Base Class for Background/Foreground Segmentation. - The class is only used to define the common interface for - the whole family of background/foreground segmentation algorithms. - - - - - the update operator that takes the next video frame and returns the current foreground mask as 8-bit binary image. - - - - - - - - computes a background image - - - - - - K nearest neigbours algorithm - - - - - cv::Ptr<T> - - - - - Creates KNN Background Subtractor - - Length of the history. - Threshold on the squared distance between the pixel and the sample to decide - whether a pixel is close to that sample. This parameter does not affect the background update. - If true, the algorithm will detect shadows and mark them. It decreases the - speed a bit, so if you do not need this feature, set the parameter to false. - - - - - Releases managed resources - - - - - Gets or sets the number of last frames that affect the background model. - - - - - Gets or sets the number of data samples in the background model - - - - - Gets or sets the threshold on the squared distance between the pixel and the sample. - The threshold on the squared distance between the pixel and the sample to decide whether a pixel is close to a data sample. - - - - - Returns the number of neighbours, the k in the kNN. - K is the number of samples that need to be within dist2Threshold in order to decide that that - pixel is matching the kNN background model. - - - - - Returns the shadow detection flag. - If true, the algorithm detects shadows and marks them. See createBackgroundSubtractorKNN for details. - - - - - Gets or sets the shadow value. - Shadow value is the value used to mark shadows in the foreground mask. Default value is 127. - Value 0 in the mask always means background, 255 means foreground. - - - - - Gets or sets the shadow threshold. - A shadow is detected if pixel is a darker version of the background. The shadow threshold (Tau in - the paper) is a threshold defining how much darker the shadow can be. Tau= 0.5 means that if a pixel - is more than twice darker then it is not shadow. See Prati, Mikic, Trivedi and Cucchiara, - *Detecting Moving Shadows...*, IEEE PAMI,2003. - - - - - The Base Class for Background/Foreground Segmentation. - The class is only used to define the common interface for - the whole family of background/foreground segmentation algorithms. - - - - - cv::Ptr<T> - - - - - Creates MOG2 Background Subtractor. - - Length of the history. - Threshold on the squared Mahalanobis distance between the pixel and the model - to decide whether a pixel is well described by the background model. This parameter does not affect the background update. - If true, the algorithm will detect shadows and mark them. It decreases the speed a bit, - so if you do not need this feature, set the parameter to false. - - - - - Releases managed resources - - - - - Gets or sets the number of last frames that affect the background model. - - - - - Gets or sets the number of gaussian components in the background model. - - - - - Gets or sets the "background ratio" parameter of the algorithm. - If a foreground pixel keeps semi-constant value for about backgroundRatio\*history frames, it's - considered background and added to the model as a center of a new component. It corresponds to TB - parameter in the paper. - - - - - Gets or sets the variance threshold for the pixel-model match. - The main threshold on the squared Mahalanobis distance to decide if the sample is well described by - the background model or not. Related to Cthr from the paper. - - - - - Gets or sets the variance threshold for the pixel-model match used for new mixture component generation. - Threshold for the squared Mahalanobis distance that helps decide when a sample is close to the - existing components (corresponds to Tg in the paper). If a pixel is not close to any component, it - is considered foreground or added as a new component. 3 sigma =\> Tg=3\*3=9 is default. A smaller Tg - value generates more components. A higher Tg value may result in a small number of components but they can grow too large. - - - - - Gets or sets the initial variance of each gaussian component. - - - - - - - - - - - - - - - Gets or sets the complexity reduction threshold. - This parameter defines the number of samples needed to accept to prove the component exists. CT=0.05 - is a default value for all the samples. By setting CT=0 you get an algorithm very similar to the standard Stauffer&Grimson algorithm. - - - - - Gets or sets the shadow detection flag. - If true, the algorithm detects shadows and marks them. See createBackgroundSubtractorKNN for details. - - - - - Gets or sets the shadow value. - Shadow value is the value used to mark shadows in the foreground mask. Default value is 127. - Value 0 in the mask always means background, 255 means foreground. - - - - - Gets or sets the shadow threshold. - A shadow is detected if pixel is a darker version of the background. The shadow threshold (Tau in - the paper) is a threshold defining how much darker the shadow can be. Tau= 0.5 means that if a pixel - is more than twice darker then it is not shadow. See Prati, Mikic, Trivedi and Cucchiara, - *Detecting Moving Shadows...*, IEEE PAMI,2003. - - - - - [findTransformECC] specifying the type of motion - - - - - sets a translational motion model; warpMatrix is \f$2\times 3\f$ with - the first \f$2\times 2\f$ part being the unity matrix and the rest two parameters being estimated. - - - - - sets a Euclidean (rigid) transformation as motion model; three parameters are estimated; warpMatrix is \f$2\times 3\f$. - - - - - sets an affine motion model (DEFAULT); six parameters are estimated; warpMatrix is \f$2\times 3\f$. - - - - - sets a homography as a motion model; eight parameters are estimated;\`warpMatrix\` is \f$3\times 3\f$. - - - - - cv::calcOpticalFlowPyrLK flags - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Kalman filter. - The class implements standard Kalman filter \url{http://en.wikipedia.org/wiki/Kalman_filter}. - However, you can modify KalmanFilter::transitionMatrix, KalmanFilter::controlMatrix and - KalmanFilter::measurementMatrix to get the extended Kalman filter functionality. - - - - - the default constructor - - - - - the full constructor taking the dimensionality of the state, of the measurement and of the control vector - - - - - - - - - Releases unmanaged resources - - - - - predicted state (x'(k)): x(k)=A*x(k-1)+B*u(k) - - - - - corrected state (x(k)): x(k)=x'(k)+K(k)*(z(k)-H*x'(k)) - - - - - state transition matrix (A) - - - - - control matrix (B) (not used if there is no control) - - - - - measurement matrix (H) - - - - - process noise covariance matrix (Q) - - - - - measurement noise covariance matrix (R) - - - - - priori error estimate covariance matrix (P'(k)): P'(k)=A*P(k-1)*At + Q)*/ - - - - - Kalman gain matrix (K(k)): K(k)=P'(k)*Ht*inv(H*P'(k)*Ht+R) - - - - - posteriori error estimate covariance matrix (P(k)): P(k)=(I-K(k)*H)*P'(k) - - - - - re-initializes Kalman filter. The previous content is destroyed. - - - - - - - - - computes predicted state - - - - - - - updates the predicted state from the measurement - - - - - - - Base abstract class for the long-term tracker - - - - - - - - - - - Releases managed resources - - - - - Initialize the tracker with a know bounding box that surrounding the target - - The initial frame - The initial bounding box - - - - - Update the tracker, find the new most likely bounding box for the target - - The current frame - The bounding box that represent the new target location, if true was returned, not modified otherwise - True means that target was located and false means that tracker cannot locate target in - current frame.Note, that latter *does not* imply that tracker has failed, maybe target is indeed - missing from the frame (say, out of sight) - - - - - GOTURN (@cite GOTURN) is kind of trackers based on Convolutional Neural Networks (CNN). - - - * While taking all advantages of CNN trackers, GOTURN is much faster due to offline training without online fine-tuning nature. - * GOTURN tracker addresses the problem of single target tracking: given a bounding box label of an object in the first frame of the video, - - * we track that object through the rest of the video.NOTE: Current method of GOTURN does not handle occlusions; however, it is fairly - * robust to viewpoint changes, lighting changes, and deformations. - - * Inputs of GOTURN are two RGB patches representing Target and Search patches resized to 227x227. - * Outputs of GOTURN are predicted bounding box coordinates, relative to Search patch coordinate system, in format X1, Y1, X2, Y2. - * Original paper is here: [http://davheld.github.io/GOTURN/GOTURN.pdf] - * As long as original authors implementation: [https://github.com/davheld/GOTURN#train-the-tracker] - * Implementation of training algorithm is placed in separately here due to 3d-party dependencies: - * [https://github.com/Auron-X/GOTURN_Training_Toolkit] - * GOTURN architecture goturn.prototxt and trained model goturn.caffemodel are accessible on opencv_extra GitHub repository. - - - - - - - - - - Constructor - - - - - - Constructor - - GOTURN parameters - - - - - - - - - - - The MIL algorithm trains a classifier in an online manner to separate the object from the background. - Multiple Instance Learning avoids the drift problem for a robust tracking.The implementation is based on @cite MIL. - Original code can be found here [http://vision.ucsd.edu/~bbabenko/project_miltrack.shtml] - - - - - - - - - - Constructor - - - - - - Constructor - - MIL parameters - - - - - - - - - radius for gathering positive instances during init - - - - - # negative samples to use during init - - - - - size of search window - - - - - radius for gathering positive instances during tracking - - - - - # positive samples to use during tracking - - - - - # negative samples to use during tracking - - - - - # features - - - - - WeChat QRCode includes two CNN-based models: - A object detection model and a super resolution model. - Object detection model is applied to detect QRCode with the bounding box. - super resolution model is applied to zoom in QRCode when it is small. - - - - - Initialize the WeChatQRCode. - It includes two models, which are packaged with caffe format. - Therefore, there are prototxt and caffe models (In total, four paramenters). - - prototxt file path for the detector - caffe model file path for the detector - prototxt file path for the super resolution model - caffe file path for the super resolution model - - - - - - Both detects and decodes QR code. - To simplify the usage, there is a only API: detectAndDecode - - supports grayscale or color(BGR) image. - optional output array of vertices of the found QR code quadrangle.Will be empty if not found. - list of decoded string. - - - - - - - BRIEF Descriptor - - - - - cv::Ptr<T> - - - - - - - - - - Constructor - - - - - - bytes is a length of descriptor in bytes. It can be equal 16, 32 or 64 bytes. - - - - - - Releases managed resources - - - - - FREAK implementation - - - - - - - - - - Constructor - - enable orientation normalization - enable scale normalization - scaling of the description pattern - number of octaves covered by the detected keypoints - (optional) user defined selected pairs - - - - Releases managed resources - - - - - LATCH Descriptor. - - latch Class for computing the LATCH descriptor. - If you find this code useful, please add a reference to the following paper in your work: - Gil Levi and Tal Hassner, "LATCH: Learned Arrangements of Three Patch Codes", arXiv preprint arXiv:1501.03719, 15 Jan. 2015. - - Note: a complete example can be found under /samples/cpp/tutorial_code/xfeatures2D/latch_match.cpp - - - - - - - - - - Constructor - - the size of the descriptor - can be 64, 32, 16, 8, 4, 2 or 1 - whether or not the descriptor should compansate for orientation changes. - the size of half of the mini-patches size. For example, if we would like to compare triplets of patches of size 7x7x - then the half_ssd_size should be (7-1)/2 = 3. - sigma value for GaussianBlur smoothing of the source image. Source image will be used without smoothing in case sigma value is 0. - Note: the descriptor can be coupled with any keypoint extractor. The only demand is that if you use set rotationInvariance = True then - you will have to use an extractor which estimates the patch orientation (in degrees). Examples for such extractors are ORB and SIFT. - - - - Releases managed resources - - - - - Class implementing the locally uniform comparison image descriptor, described in @cite LUCID. - - An image descriptor that can be computed very fast, while being - about as robust as, for example, SURF or BRIEF. - @note It requires a color image as input. - - - - - - - - - - Constructor - - kernel for descriptor construction, where 1=3x3, 2=5x5, 3=7x7 and so forth - kernel for blurring image prior to descriptor construction, where 1=3x3, 2=5x5, 3=7x7 and so forth - - - - Releases managed resources - - - - - The "Star" Detector - - - - - - - - - - Constructor - - - - - - - - - - Releases managed resources - - - - - Class for extracting Speeded Up Robust Features from an image. - - - - - Creates instance by raw pointer cv::SURF* - - - - - The SURF constructor. - - Only features with keypoint.hessian larger than that are extracted. - The number of a gaussian pyramid octaves that the detector uses. It is set to 4 by default. - If you want to get very large features, use the larger value. If you want just small features, decrease it. - The number of images within each octave of a gaussian pyramid. It is set to 2 by default. - false means basic descriptors (64 elements each), true means extended descriptors (128 elements each) - false means that detector computes orientation of each feature. - true means that the orientation is not computed (which is much, much faster). - - - - Releases managed resources - - - - - Threshold for the keypoint detector. Only features, whose hessian is larger than hessianThreshold - are retained by the detector. Therefore, the larger the value, the less keypoints you will get. - A good default value could be from 300 to 500, depending from the image contrast. - - - - - The number of a gaussian pyramid octaves that the detector uses. It is set to 4 by default. - If you want to get very large features, use the larger value. If you want just small features, decrease it. - - - - - The number of images within each octave of a gaussian pyramid. It is set to 2 by default. - - - - - false means that the basic descriptors (64 elements each) shall be computed. - true means that the extended descriptors (128 elements each) shall be computed - - - - - false means that detector computes orientation of each feature. - true means that the orientation is not computed (which is much, much faster). - For example, if you match images from a stereo pair, or do image stitching, the matched features - likely have very similar angles, and you can speed up feature extraction by setting upright=true. - - - - - cv::ximgproc functions - - - - - Strategy for the selective search segmentation algorithm. - - - - - Create a new color-based strategy - - - - - - Create a new size-based strategy - - - - - - Create a new size-based strategy - - - - - - Create a new fill-based strategy - - - - - - Create a new multiple strategy - - - - - - Create a new multiple strategy and set one subtrategy - - The first strategy - - - - - Create a new multiple strategy and set one subtrategy - - The first strategy - The second strategy - - - - - Create a new multiple strategy and set one subtrategy - - The first strategy - The second strategy - The third strategy - - - - - Create a new multiple strategy and set one subtrategy - - The first strategy - The second strategy - The third strategy - The forth strategy - - - - - run_length_morphology.hpp - - - - - Applies a fixed-level threshold to each array element. - - input array (single-channel). - resulting run length encoded image. - threshold value. - thresholding type (only cv::THRESH_BINARY and cv::THRESH_BINARY_INV are supported) - - - - Dilates an run-length encoded binary image by using a specific structuring element. - - input image - result - kernel - position of the anchor within the element; default value (0, 0) is usually the element center. - - - - Erodes an run-length encoded binary image by using a specific structuring element. - - input image - result - kernel - indicates whether pixel outside the image boundary are assumed to be on - (True: works in the same way as the default of cv::erode, False: is a little faster) - position of the anchor within the element; default value (0, 0) - is usually the element center. - - - - Returns a run length encoded structuring element of the specified size and shape. - - Element shape that can be one of cv::MorphShapes - Size of the structuring element. - - - - - Paint run length encoded binary image into an image. - - image to paint into (currently only single channel images). - run length encoded image - all foreground pixel of the binary image are set to this value - - - - Check whether a custom made structuring element can be used with run length morphological operations. - (It must consist of a continuous array of single runs per row) - - - - - - - Creates a run-length encoded image from a vector of runs (column begin, column end, row) - - vector of runs - result - image size (to be used if an "on" boundary should be used in erosion, using the default - means that the size is computed from the extension of the input) - - - - Applies a morphological operation to a run-length encoded binary image. - - input image - result - all operations supported by cv::morphologyEx (except cv::MORPH_HITMISS) - kernel - indicates whether pixel outside the image boundary are assumed - to be on for erosion operations (True: works in the same way as the default of cv::erode, False: is a little faster) - position of the anchor within the element; default value (0, 0) is usually the element center. - - - - Applies Niblack thresholding to input image. - - T(x, y)\)}{0}{otherwise}\f] - - ** THRESH_BINARY_INV** - \f[dst(x, y) = \fork{0}{if \(src(x, y) > T(x, y)\)}{\texttt{maxValue}}{otherwise}\f] - where \f$T(x, y)\f$ is a threshold calculated individually for each pixel. - The threshold value \f$T(x, y)\f$ is the mean minus \f$ delta \f$ times standard deviation - of \f$\texttt{blockSize} \times\texttt{blockSize}\f$ neighborhood of \f$(x, y)\f$. - The function can't process the image in-place. - ]]> - Source 8-bit single-channel image. - Destination image of the same size and the same type as src. - Non-zero value assigned to the pixels for which the condition is satisfied, - used with the THRESH_BINARY and THRESH_BINARY_INV thresholding types. - Thresholding type, see cv::ThresholdTypes. - Size of a pixel neighborhood that is used to calculate a threshold value for the pixel: 3, 5, 7, and so on. - The user-adjustable parameter used by Niblack and inspired techniques.For Niblack, - this is normally a value between 0 and 1 that is multiplied with the standard deviation and subtracted from the mean. - Binarization method to use. By default, Niblack's technique is used. - Other techniques can be specified, see cv::ximgproc::LocalBinarizationMethods. - The user-adjustable parameter used by Sauvola's technique. This is the dynamic range of standard deviation. - - - - Applies a binary blob thinning operation, to achieve a skeletization of the input image. - The function transforms a binary blob image into a skeletized form using the technique of Zhang-Suen. - - Source 8-bit single-channel image, containing binary blobs, with blobs having 255 pixel values. - Destination image of the same size and the same type as src. The function can work in-place. - Value that defines which thinning algorithm should be used. - - - - Performs anisotropic diffusian on an image. - The function applies Perona-Malik anisotropic diffusion to an image. - - Grayscale Source image. - Destination image of the same size and the same number of channels as src. - The amount of time to step forward by on each iteration (normally, it's between 0 and 1). - sensitivity to the edges - The number of iterations - - - - - - - - - - - - - - creates a quaternion image. - - Source 8-bit, 32-bit or 64-bit image, with 3-channel image. - result CV_64FC4 a quaternion image( 4 chanels zero channel and B,G,R). - - - - calculates conjugate of a quaternion image. - - quaternion image. - conjugate of qimg - - - - divides each element by its modulus. - - quaternion image. - conjugate of qimg - - - - Calculates the per-element quaternion product of two arrays - - quaternion image. - quaternion image. - product dst(I)=src1(I) . src2(I) - - - - Performs a forward or inverse Discrete quaternion Fourier transform of a 2D quaternion array. - - quaternion image. - quaternion image in dual space. - quaternion image in dual space. only DFT_INVERSE flags is supported - true the hypercomplex exponential is to be multiplied on the left (false on the right ). - - - - Compares a color template against overlapped color image regions. - - Image where the search is running. It must be 3 channels image - Searched template. It must be not greater than the source image and have 3 channels - Map of comparison results. It must be single-channel 64-bit floating-point - - - - Applies Y Deriche filter to an image. - - Source 8-bit or 16bit image, 1-channel or 3-channel image. - result CV_32FC image with same number of channel than _op. - double see paper - double see paper - - - - Applies X Deriche filter to an image. - - Source 8-bit or 16bit image, 1-channel or 3-channel image. - result CV_32FC image with same number of channel than _op. - double see paper - double see paper - - - - Creates a EdgeBoxes - - step size of sliding window search. - nms threshold for object proposals. - adaptation rate for nms threshold. - min score of boxes to detect. - max number of boxes to detect. - edge min magnitude. Increase to trade off accuracy for speed. - edge merge threshold. Increase to trade off accuracy for speed. - cluster min magnitude. Increase to trade off accuracy for speed. - max aspect ratio of boxes. - minimum area of boxes. - affinity sensitivity. - scale sensitivity. - - - - - Factory method, create instance of DTFilter and produce initialization routines. - - guided image (used to build transformed distance, which describes edge structure of - guided image). - sigma_H parameter in the original article, it's similar to the sigma in the - coordinate space into bilateralFilter. - sigma_r parameter in the original article, it's similar to the sigma in the - color space into bilateralFilter. - one form three modes DTF_NC, DTF_RF and DTF_IC which corresponds to three modes for - filtering 2D signals in the article. - optional number of iterations used for filtering, 3 is quite enough. - - - - - Simple one-line Domain Transform filter call. If you have multiple images to filter with the same - guided image then use DTFilter interface to avoid extra computations on initialization stage. - - guided image (also called as joint image) with unsigned 8-bit or floating-point 32-bit - depth and up to 4 channels. - filtering image with unsigned 8-bit or floating-point 32-bit depth and up to 4 channels. - destination image - sigma_H parameter in the original article, it's similar to the sigma in the - coordinate space into bilateralFilter. - sigma_r parameter in the original article, it's similar to the sigma in the - color space into bilateralFilter. - one form three modes DTF_NC, DTF_RF and DTF_IC which corresponds to three modes for - filtering 2D signals in the article. - optional number of iterations used for filtering, 3 is quite enough. - - - - Factory method, create instance of GuidedFilter and produce initialization routines. - - guided image (or array of images) with up to 3 channels, if it have more then 3 - channels then only first 3 channels will be used. - radius of Guided Filter. - regularization term of Guided Filter. eps^2 is similar to the sigma in the color - space into bilateralFilter. - - - - - Simple one-line Guided Filter call. - - If you have multiple images to filter with the same guided image then use GuidedFilter interface to - avoid extra computations on initialization stage. - - guided image (or array of images) with up to 3 channels, if it have more then 3 - channels then only first 3 channels will be used. - filtering image with any numbers of channels. - output image. - radius of Guided Filter. - regularization term of Guided Filter. eps^2 is similar to the sigma in the color - space into bilateralFilter. - optional depth of the output image. - - - - Factory method, create instance of AdaptiveManifoldFilter and produce some initialization routines. - - spatial standard deviation. - color space standard deviation, it is similar to the sigma in the color space into - bilateralFilter. - optional, specify perform outliers adjust operation or not, (Eq. 9) in the - original paper. - - - - - Simple one-line Adaptive Manifold Filter call. - - joint (also called as guided) image or array of images with any numbers of channels. - filtering image with any numbers of channels. - output image. - spatial standard deviation. - color space standard deviation, it is similar to the sigma in the color space into - bilateralFilter. - optional, specify perform outliers adjust operation or not, (Eq. 9) in the - original paper. - - - - Applies the joint bilateral filter to an image. - - Joint 8-bit or floating-point, 1-channel or 3-channel image. - Source 8-bit or floating-point, 1-channel or 3-channel image with the same depth as joint image. - Destination image of the same size and type as src. - Diameter of each pixel neighborhood that is used during filtering. If it is non-positive, - it is computed from sigmaSpace. - Filter sigma in the color space. A larger value of the parameter means that - farther colors within the pixel neighborhood(see sigmaSpace) will be mixed together, resulting in - larger areas of semi-equal color. - Filter sigma in the coordinate space. A larger value of the parameter means that - farther pixels will influence each other as long as their colors are close enough(see sigmaColor). - When d\>0 , it specifies the neighborhood size regardless of sigmaSpace.Otherwise, d is - proportional to sigmaSpace. - - - - - Applies the bilateral texture filter to an image. It performs structure-preserving texture filter. - For more details about this filter see @cite Cho2014. - - Source image whose depth is 8-bit UINT or 32-bit FLOAT - Destination image of the same size and type as src. - Radius of kernel to be used for filtering. It should be positive integer - Number of iterations of algorithm, It should be positive integer - Controls the sharpness of the weight transition from edges to smooth/texture regions, where - a bigger value means sharper transition.When the value is negative, it is automatically calculated. - Range blur parameter for texture blurring. Larger value makes result to be more blurred. When the - value is negative, it is automatically calculated as described in the paper. - - - - Applies the rolling guidance filter to an image. - - 8-bit or floating-point, 1-channel or 3-channel image. - Destination image of the same size and type as src. - Diameter of each pixel neighborhood that is used during filtering. If it is non-positive, - it is computed from sigmaSpace. - Filter sigma in the color space. A larger value of the parameter means that - farther colors within the pixel neighborhood(see sigmaSpace) will be mixed together, resulting in - larger areas of semi-equal color. - Filter sigma in the coordinate space. A larger value of the parameter means that - farther pixels will influence each other as long as their colors are close enough(see sigmaColor). - When d\>0 , it specifies the neighborhood size regardless of sigmaSpace.Otherwise, d is - proportional to sigmaSpace. - Number of iterations of joint edge-preserving filtering applied on the source image. - - - - - Simple one-line Fast Bilateral Solver filter call. If you have multiple images to filter with the same - guide then use FastBilateralSolverFilter interface to avoid extra computations. - - image serving as guide for filtering. It should have 8-bit depth and either 1 or 3 channels. - source image for filtering with unsigned 8-bit or signed 16-bit or floating-point 32-bit depth and up to 4 channels. - confidence image with unsigned 8-bit or floating-point 32-bit confidence and 1 channel. - destination image. - parameter, that is similar to spatial space sigma (bandwidth) in bilateralFilter. - parameter, that is similar to luma space sigma (bandwidth) in bilateralFilter. - parameter, that is similar to chroma space sigma (bandwidth) in bilateralFilter. - smoothness strength parameter for solver. - number of iterations used for solver, 25 is usually enough. - convergence tolerance used for solver. - - - - Factory method, create instance of FastGlobalSmootherFilter and execute the initialization routines. - - image serving as guide for filtering. It should have 8-bit depth and either 1 or 3 channels. - parameter defining the amount of regularization - parameter, that is similar to color space sigma in bilateralFilter. - internal parameter, defining how much lambda decreases after each iteration. Normally, - it should be 0.25. Setting it to 1.0 may lead to streaking artifacts. - number of iterations used for filtering, 3 is usually enough. - - - - - Simple one-line Fast Global Smoother filter call. If you have multiple images to filter with the same - guide then use FastGlobalSmootherFilter interface to avoid extra computations. - - image serving as guide for filtering. It should have 8-bit depth and either 1 or 3 channels. - source image for filtering with unsigned 8-bit or signed 16-bit or floating-point 32-bit depth and up to 4 channels. - destination image. - parameter defining the amount of regularization - parameter, that is similar to color space sigma in bilateralFilter. - internal parameter, defining how much lambda decreases after each iteration. Normally, - it should be 0.25. Setting it to 1.0 may lead to streaking artifacts. - number of iterations used for filtering, 3 is usually enough. - - - - Global image smoothing via L0 gradient minimization. - - source image for filtering with unsigned 8-bit or signed 16-bit or floating-point depth. - destination image. - parameter defining the smooth term weight. - parameter defining the increasing factor of the weight of the gradient data term. - - - - Smoothes an image using the Edge-Preserving filter. - - Source 8-bit 3-channel image. - Destination image of the same size and type as src. - Diameter of each pixel neighborhood that is used during filtering. Must be greater or equal 3. - Threshold, which distinguishes between noise, outliers, and data. - - - - Computes the estimated covariance matrix of an image using the sliding window forumlation. - - - The window size parameters control the accuracy of the estimation. - The sliding window moves over the entire image from the top-left corner - to the bottom right corner.Each location of the window represents a sample. - If the window is the size of the image, then this gives the exact covariance matrix. - For all other cases, the sizes of the window will impact the number of samples - and the number of elements in the estimated covariance matrix. - - The source image. Input image must be of a complex type. - The destination estimated covariance matrix. Output matrix will be size (windowRows*windowCols, windowRows*windowCols). - The number of rows in the window. - The number of cols in the window. - - - - Calculates 2D Fast Hough transform of an image. - - The source (input) image. - The destination image, result of transformation. - The depth of destination image - The part of Hough space to calculate, see cv::AngleRangeOption - The operation to be applied, see cv::HoughOp - Specifies to do or not to do image skewing, see cv::HoughDeskewOption - - - - Calculates coordinates of line segment corresponded by point in Hough space. - - - If rules parameter set to RO_STRICT then returned line cut along the border of source image. - If rules parameter set to RO_WEAK then in case of point, which belongs - the incorrect part of Hough image, returned line will not intersect source image. - - Point in Hough space. - The source (input) image of Hough transform. - The part of Hough space where point is situated, see cv::AngleRangeOption - Specifies to do or not to do image skewing, see cv::HoughDeskewOption - Specifies strictness of line segment calculating, see cv::RulesOption - Coordinates of line segment corresponded by point in Hough space. - - - - Creates a smart pointer to a FastLineDetector object and initializes it - - Segment shorter than this will be discarded - A point placed from a hypothesis line segment farther than - this will be regarded as an outlier - First threshold for hysteresis procedure in Canny() - Second threshold for hysteresis procedure in Canny() - Aperture size for the sobel operator in Canny() - If true, incremental merging of segments will be performed - - - - - Class implementing the LSC (Linear Spectral Clustering) superpixels. - - The function initializes a SuperpixelLSC object for the input image. It sets the parameters of - superpixel algorithm, which are: region_size and ruler.It preallocate some buffers for future - computing iterations over the given image.An example of LSC is illustrated in the following picture. - For enhanced results it is recommended for color images to preprocess image with little gaussian blur - with a small 3 x 3 kernel and additional conversion into CieLAB color space. - - image Image to segment - Chooses an average superpixel size measured in pixels - Chooses the enforcement of superpixel compactness factor of superpixel - - - - - Applies Paillou filter to an image. - - Source CV_8U(S) or CV_16U(S), 1-channel or 3-channels image. - Result CV_32F image with same number of channel than op. - double see paper - double see paper - - - - Applies Paillou filter to an image. - - Source CV_8U(S) or CV_16U(S), 1-channel or 3-channels image. - Result CV_32F image with same number of channel than op. - double see paper - double see paper - - - - Calculates an affine transformation that normalize given image using Pei&Lin Normalization. - - Given transformed image. - Transformation matrix corresponding to inversed image transformation - - - - Calculates an affine transformation that normalize given image using Pei&Lin Normalization. - - Given transformed image. - Inversed image transformation. - - - - Initializes a SuperpixelSEEDS object. - - The function initializes a SuperpixelSEEDS object for the input image. It stores the parameters of - the image: image_width, image_height and image_channels.It also sets the parameters of the SEEDS - superpixel algorithm, which are: num_superpixels, num_levels, use_prior, histogram_bins and - double_step. - - The number of levels in num_levels defines the amount of block levels that the algorithm use in the - optimization.The initialization is a grid, in which the superpixels are equally distributed through - the width and the height of the image.The larger blocks correspond to the superpixel size, and the - levels with smaller blocks are formed by dividing the larger blocks into 2 x 2 blocks of pixels, - recursively until the smaller block level. An example of initialization of 4 block levels is - illustrated in the following figure. - - Image width. - Image height. - Number of channels of the image. - Desired number of superpixels. Note that the actual number may be smaller - due to restrictions(depending on the image size and num_levels). Use getNumberOfSuperpixels() to - get the actual number. - Number of block levels. The more levels, the more accurate is the segmentation, - but needs more memory and CPU time. - enable 3x3 shape smoothing term if \>0. A larger value leads to smoother shapes. prior - must be in the range[0, 5]. - Number of histogram bins. - If true, iterate each block level twice for higher accuracy. - - - - - Creates a RFFeatureGetter - - - - - - Creates a StructuredEdgeDetection - - name of the file where the model is stored - optional object inheriting from RFFeatureGetter. - You need it only if you would like to train your own forest, pass null otherwise - - - - - Applies weighted median filter to an image. - - - For more details about this implementation, please see @cite zhang2014100+ - - Joint 8-bit, 1-channel or 3-channel image. - Source 8-bit or floating-point, 1-channel or 3-channel image. - Destination image. - Radius of filtering kernel, should be a positive integer. - Filter range standard deviation for the joint image. - The type of weight definition, see WMFWeightType - A 0-1 mask that has the same size with I. This mask is used to ignore the effect of some pixels. If the pixel value on mask is 0, - the pixel will be ignored when maintaining the joint-histogram.This is useful for applications like optical flow occlusion handling. - - - - Class implementing EdgeBoxes algorithm from @cite ZitnickECCV14edgeBoxes - - - - - Creates instance by raw pointer - - - - - Releases managed resources - - - - - Creates a EdgeBoxes - - step size of sliding window search. - nms threshold for object proposals. - adaptation rate for nms threshold. - min score of boxes to detect. - max number of boxes to detect. - edge min magnitude. Increase to trade off accuracy for speed. - edge merge threshold. Increase to trade off accuracy for speed. - cluster min magnitude. Increase to trade off accuracy for speed. - max aspect ratio of boxes. - minimum area of boxes. - affinity sensitivity. - scale sensitivity. - - - - - Gets or sets the step size of sliding window search. - - - - - Gets or sets the nms threshold for object proposals. - - - - - Gets or sets adaptation rate for nms threshold. - - - - - Gets or sets the min score of boxes to detect. - - - - - Gets or sets the max number of boxes to detect. - - - - - Gets or sets the edge min magnitude. - - - - - Gets or sets the edge merge threshold. - - - - - Gets or sets the cluster min magnitude. - - - - - Gets or sets the max aspect ratio of boxes. - - - - - Gets or sets the minimum area of boxes. - - - - - Gets or sets the affinity sensitivity. - - - - - Gets or sets the scale sensitivity. - - - - - Returns array containing proposal boxes. - - edge image. - orientation map. - proposal boxes. - - - - Interface for Adaptive Manifold Filter realizations. - - Below listed optional parameters which may be set up with Algorithm::set function. - - member double sigma_s = 16.0 - Spatial standard deviation. - - member double sigma_r = 0.2 - Color space standard deviation. - - member int tree_height = -1 - Height of the manifold tree (default = -1 : automatically computed). - - member int num_pca_iterations = 1 - Number of iterations to computed the eigenvector. - - member bool adjust_outliers = false - Specify adjust outliers using Eq. 9 or not. - - member bool use_RNG = true - Specify use random number generator to compute eigenvector or not. - - - - - Creates instance by raw pointer - - - - - Releases managed resources - - - - - Factory method, create instance of AdaptiveManifoldFilter and produce some initialization routines. - - spatial standard deviation. - color space standard deviation, it is similar to the sigma in the color space into - bilateralFilter. - optional, specify perform outliers adjust operation or not, (Eq. 9) in the - original paper. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Apply high-dimensional filtering using adaptive manifolds. - - filtering image with any numbers of channels. - output image. - optional joint (also called as guided) image with any numbers of channels. - - - - Interface for realizations of Domain Transform filter. - - - - - Creates instance by raw pointer - - - - - Releases managed resources - - - - - Factory method, create instance of DTFilter and produce initialization routines. - - guided image (used to build transformed distance, which describes edge structure of - guided image). - sigma_H parameter in the original article, it's similar to the sigma in the - coordinate space into bilateralFilter. - sigma_r parameter in the original article, it's similar to the sigma in the - color space into bilateralFilter. - one form three modes DTF_NC, DTF_RF and DTF_IC which corresponds to three modes for - filtering 2D signals in the article. - optional number of iterations used for filtering, 3 is quite enough. - - - - - Simple one-line Domain Transform filter call. If you have multiple images to filter with the same - guided image then use DTFilter interface to avoid extra computations on initialization stage. - - - - - - - - Interface for implementations of Fast Bilateral Solver. - - - - - Creates instance by raw pointer - - - - - Releases managed resources - - - - - Factory method, create instance of FastBilateralSolverFilter and execute the initialization routines. - - image serving as guide for filtering. It should have 8-bit depth and either 1 or 3 channels. - parameter, that is similar to spatial space sigma (bandwidth) in bilateralFilter. - parameter, that is similar to luma space sigma (bandwidth) in bilateralFilter. - parameter, that is similar to chroma space sigma (bandwidth) in bilateralFilter. - smoothness strength parameter for solver. - number of iterations used for solver, 25 is usually enough. - convergence tolerance used for solver. - - - - - Apply smoothing operation to the source image. - - source image for filtering with unsigned 8-bit or signed 16-bit or floating-point 32-bit depth and up to 3 channels. - confidence image with unsigned 8-bit or floating-point 32-bit confidence and 1 channel. - destination image. - - - - Interface for implementations of Fast Global Smoother filter. - - - - - Creates instance by raw pointer - - - - - Releases managed resources - - - - - Factory method, create instance of FastGlobalSmootherFilter and execute the initialization routines. - - image serving as guide for filtering. It should have 8-bit depth and either 1 or 3 channels. - parameter defining the amount of regularization - parameter, that is similar to color space sigma in bilateralFilter. - internal parameter, defining how much lambda decreases after each iteration. Normally, - it should be 0.25. Setting it to 1.0 may lead to streaking artifacts. - number of iterations used for filtering, 3 is usually enough. - - - - - Apply smoothing operation to the source image. - - source image for filtering with unsigned 8-bit or signed 16-bit or floating-point 32-bit depth and up to 4 channels. - destination image. - - - - Interface for realizations of Guided Filter. - - - - - Creates instance by raw pointer - - - - - Releases managed resources - - - - - Factory method, create instance of GuidedFilter and produce initialization routines. - - guided image (or array of images) with up to 3 channels, if it have more then 3 - channels then only first 3 channels will be used. - radius of Guided Filter. - regularization term of Guided Filter. eps^2 is similar to the sigma in the color - space into bilateralFilter. - - - - - Apply Guided Filter to the filtering image. - - filtering image with any numbers of channels. - output image. - optional depth of the output image. dDepth can be set to -1, which will be equivalent to src.depth(). - - - - Specifies the part of Hough space to calculate - - - The enum specifies the part of Hough space to calculate. - Each member specifies primarily direction of lines(horizontal or vertical) - and the direction of angle changes. - Direction of angle changes is from multiples of 90 to odd multiples of 45. - The image considered to be written top-down and left-to-right. - Angles are started from vertical line and go clockwise. - Separate quarters and halves are written in orientation they should be in full Hough space. - - - - - Vertical primarily direction and clockwise angle changes - - - - - Horizontal primarily direction and counterclockwise angle changes - - - - - Horizontal primarily direction and clockwise angle changes - - - - - Vertical primarily direction and counterclockwise angle changes - - - - - Vertical primarily direction - - - - - Horizontal primarily direction - - - - - Full set of directions - - - - - 90 +/- atan(0.5), interval approximately from 64.5 to 116.5 degrees. - It is used for calculating Fast Hough Transform for images skewed by atan(0.5). - - - - - +/- atan(0.5), interval approximately from 333.5(-26.5) to 26.5 degrees - It is used for calculating Fast Hough Transform for images skewed by atan(0.5). - - - - - one form three modes DTF_NC, DTF_RF and DTF_IC which corresponds to three modes for - filtering 2D signals in the article. - - - - - Specifies to do or not to do skewing of Hough transform image - - - The enum specifies to do or not to do skewing of Hough transform image - so it would be no cycling in Hough transform image through borders of image. - - - - - Use raw cyclic image - - - - - Prepare deskewed image - - - - - Specifies binary operations. - - - The enum specifies binary operations, that is such ones which involve - two operands. Formally, a binary operation @f$ f @f$ on a set @f$ S @f$ - is a binary relation that maps elements of the Cartesian product - @f$ S \times S @f$ to @f$ S @f$: - @f[ f: S \times S \to S @f] - - - - - Binary minimum operation. The constant specifies the binary minimum operation - @f$ f @f$ that is defined as follows: @f[ f(x, y) = \min(x, y) @f] - - - - - Binary maximum operation. The constant specifies the binary maximum operation - @f$ f @f$ that is defined as follows: @f[ f(x, y) = \max(x, y) @f] - - - - - Binary addition operation. The constant specifies the binary addition operation - @f$ f @f$ that is defined as follows: @f[ f(x, y) = x + y @f] - - - - - Binary average operation. The constant specifies the binary average operation - @f$ f @f$ that is defined as follows: @f[ f(x, y) = \frac{x + y}{2} @f] - - - - - Specifies the binarization method to use in cv::ximgproc::niBlackThreshold - - - - - Classic Niblack binarization. See @cite Niblack1985 . - - - - - Sauvola's technique. See @cite Sauvola1997 . - - - - - Wolf's technique. See @cite Wolf2004 . - - - - - NICK technique. See @cite Khurshid2009 . - - - - - Specifies the degree of rules validation. - - - The enum specifies the degree of rules validation. This can be used, for example, to choose a proper way of input arguments validation. - - - - - Validate each rule in a proper way. - - - - - Skip validations of image borders. - - - - - The algorithm variant to use for SuperpixelSLIC: - SLIC segments image using a desired region_size, and in addition SLICO will optimize using adaptive compactness factor, - while MSLIC will optimize using manifold methods resulting in more content-sensitive superpixels. - - - - - SLIC(Simple Linear Iterative Clustering) clusters pixels using pixel channels and image plane space - to efficiently generate compact, nearly uniform superpixels.The simplicity of approach makes it - extremely easy to use a lone parameter specifies the number of superpixels and the efficiency of - the algorithm makes it very practical. - - - - - SLICO stands for "Zero parameter SLIC" and it is an optimization of baseline SLIC described in @cite Achanta2012. - - - - - MSLIC stands for "Manifold SLIC" and it is an optimization of baseline SLIC described in @cite Liu_2017_IEEE. - - - - - thinning algorithm - - - - - Thinning technique of Zhang-Suen - - - - - Thinning technique of Guo-Hall - - - - - Specifies weight types of weighted median filter. - - - - - \f$exp(-|I1-I2|^2/(2*sigma^2))\f$ - - - - - \f$(|I1-I2|+sigma)^-1\f$ - - - - - \f$(|I1-I2|^2+sigma^2)^-1\f$ - - - - - \f$dot(I1,I2)/(|I1|*|I2|)\f$ - - - - - \f$(min(r1,r2)+min(g1,g2)+min(b1,b2))/(max(r1,r2)+max(g1,g2)+max(b1,b2))\f$ - - - - - unweighted - - - - - Class implementing the FLD (Fast Line Detector) algorithm described in @cite Lee14. - - - - - Creates instance by raw pointer - - - - - Releases managed resources - - - - - Creates a smart pointer to a FastLineDetector object and initializes it - - Segment shorter than this will be discarded - A point placed from a hypothesis line segment farther than - this will be regarded as an outlier - First threshold for hysteresis procedure in Canny() - Second threshold for hysteresis procedure in Canny() - Aperturesize for the sobel operator in Canny() - If true, incremental merging of segments will be perfomred - - - - - Finds lines in the input image. - This is the output of the default parameters of the algorithm on the above shown image. - - A grayscale (CV_8UC1) input image. If only a roi needs to be - selected, use: `fld_ptr-\>detect(image(roi), lines, ...); - lines += Scalar(roi.x, roi.y, roi.x, roi.y);` - A vector of Vec4f elements specifying the beginning - and ending point of a line. Where Vec4f is (x1, y1, x2, y2), - point 1 is the start, point 2 - end.Returned lines are directed so that the - brighter side is on their left. - - - - Finds lines in the input image. - This is the output of the default parameters of the algorithm on the above shown image. - - A grayscale (CV_8UC1) input image. If only a roi needs to be - selected, use: `fld_ptr-\>detect(image(roi), lines, ...); - lines += Scalar(roi.x, roi.y, roi.x, roi.y);` - A vector of Vec4f elements specifying the beginning - and ending point of a line. Where Vec4f is (x1, y1, x2, y2), - point 1 is the start, point 2 - end.Returned lines are directed so that the - brighter side is on their left. - - - - Draws the line segments on a given image. - - The image, where the lines will be drawn. Should be bigger or equal to the image, where the lines were found. - A vector of the lines that needed to be drawn. - If true, arrow heads will be drawn. - - - - Draws the line segments on a given image. - - The image, where the lines will be drawn. Should be bigger or equal to the image, where the lines were found. - A vector of the lines that needed to be drawn. - If true, arrow heads will be drawn. - - - - Helper class for training part of [P. Dollar and C. L. Zitnick. Structured Forests for Fast Edge Detection, 2013]. - - - - - Creates instance by raw pointer - - - - - Releases managed resources - - - - - Creates a RFFeatureGetter - - - - - - Extracts feature channels from src. - Than StructureEdgeDetection uses this feature space to detect edges. - - source image to extract features - output n-channel floating point feature matrix. - gradientNormalizationRadius - gradientSmoothingRadius - shrinkNumber - numberOfOutputChannels - numberOfGradientOrientations - - - - Graph Based Segmentation Algorithm. - The class implements the algorithm described in @cite PFF2004. - - - - - Creates instance by raw pointer - - - - - Releases managed resources - - - - - Creates a graph based segmentor - - The sigma parameter, used to smooth image - The k parameter of the algorithm - The minimum size of segments - - - - - - - - - - - - - - - - - - - - Segment an image and store output in dst - - The input image. Any number of channel (1 (Eg: Gray), 3 (Eg: RGB), 4 (Eg: RGB-D)) can be provided - The output segmentation. It's a CV_32SC1 Mat with the same number of cols and rows as input image, with an unique, sequential, id for each pixel. - - - - Selective search segmentation algorithm. - The class implements the algorithm described in @cite uijlings2013selective. - - - - - Creates instance by raw pointer - - - - - Releases managed resources - - - - - Create a new SelectiveSearchSegmentation class. - - - - - - Set a image used by switch* functions to initialize the class - - The image - - - - Initialize the class with the 'Single stragegy' parameters describled in @cite uijlings2013selective. - - The k parameter for the graph segmentation - The sigma parameter for the graph segmentation - - - - Initialize the class with the 'Selective search fast' parameters describled in @cite uijlings2013selective. - - The k parameter for the first graph segmentation - The increment of the k parameter for all graph segmentations - The sigma parameter for the graph segmentation - - - - Initialize the class with the 'Selective search fast' parameters describled in @cite uijlings2013selective. - - The k parameter for the first graph segmentation - The increment of the k parameter for all graph segmentations - The sigma parameter for the graph segmentation - - - - Add a new image in the list of images to process. - - The image - - - - Clear the list of images to process - - - - - Add a new graph segmentation in the list of graph segementations to process. - - The graph segmentation - - - - Clear the list of graph segmentations to process - - - - - Add a new strategy in the list of strategy to process. - - The strategy - - - - Clear the list of strategy to process; - - - - - Based on all images, graph segmentations and stragies, computes all possible rects and return them - - The list of rects. The first ones are more relevents than the lasts ones. - - - - - Strategy for the selective search segmentation algorithm. - The class implements a generic stragery for the algorithm described in @cite uijlings2013selective. - - - - - - - - - - Creates instance by raw pointer - - - - - Releases managed resources - - - - - Set a initial image, with a segementation. - - The input image. Any number of channel can be provided - A segementation of the image. The parameter must be the same size of img. - The sizes of different regions - If not set to -1, try to cache pre-computations. If the same set og (img, regions, size) is used, the image_id need to be the same. - - - - Return the score between two regions (between 0 and 1) - - The first region - The second region - - - - Inform the strategy that two regions will be merged - - The first region - The second region - - - - - Color-based strategy for the selective search segmentation algorithm. - The class is implemented from the algorithm described in @cite uijlings2013selective. - - - - - - Creates instance by raw pointer - - - - - Create a new color-based strategy - - - - - - - Size-based strategy for the selective search segmentation algorithm. - The class is implemented from the algorithm described in @cite uijlings2013selective. - - - - - - Creates instance by raw pointer - - - - - Create a new size-based strategy - - - - - - Texture-based strategy for the selective search segmentation algorithm. - The class is implemented from the algorithm described in @cite uijlings2013selective. - - - - - - Creates instance by raw pointer - - - - - Create a new size-based strategy - - - - - - Fill-based strategy for the selective search segmentation algorithm. - The class is implemented from the algorithm described in @cite uijlings2013selective. - - - - - - Creates instance by raw pointer - - - - - Create a new fill-based strategy - - - - - - - Regroup multiple strategies for the selective search segmentation algorithm - - - - - Creates instance by raw pointer - - - - - Set a initial image, with a segementation. - - The input image. Any number of channel can be provided - A segementation of the image. The parameter must be the same size of img. - The sizes of different regions - If not set to -1, try to cache pre-computations. If the same set og (img, regions, size) is used, the image_id need to be the same. - - - - Return the score between two regions (between 0 and 1) - - The first region - The second region - - - - Inform the strategy that two regions will be merged - - The first region - The second region - - - - Create a new multiple strategy - - - - - - Create a new multiple strategy and set one subtrategy - - The first strategy - - - - - Create a new multiple strategy and set one subtrategy - - The first strategy - The second strategy - - - - - Create a new multiple strategy and set one subtrategy - - The first strategy - The second strategy - The third strategy - - - - - Create a new multiple strategy and set one subtrategy - - The first strategy - The second strategy - The third strategy - The forth strategy - - - - - Class implementing edge detection algorithm from @cite Dollar2013 : - - - - - Creates instance by raw pointer - - - - - Releases managed resources - - - - - Creates a StructuredEdgeDetection - - name of the file where the model is stored - optional object inheriting from RFFeatureGetter. - You need it only if you would like to train your own forest, pass null otherwise - - - - - Returns array containing proposal boxes. - - edge image. - orientation map. - proposal boxes. - - - - The function detects edges in src and draw them to dst. - The algorithm underlies this function is much more robust to texture presence, than common approaches, e.g.Sobel - - source image (RGB, float, in [0;1]) to detect edges - destination image (grayscale, float, in [0;1]) where edges are drawn - - - - The function computes orientation from edge image. - - edge image. - orientation image. - - - - The function edgenms in edge image and suppress edges where edge is stronger in orthogonal direction. - - edge image from detectEdges function. - orientation image from computeOrientation function. - suppressed image (grayscale, float, in [0;1]) - radius for NMS suppression. - radius for boundary suppression. - multiplier for conservative suppression. - enables/disables parallel computing. - - - - Class implementing the LSC (Linear Spectral Clustering) superpixels - algorithm described in @cite LiCVPR2015LSC. - - LSC(Linear Spectral Clustering) produces compact and uniform superpixels with low - computational costs.Basically, a normalized cuts formulation of the superpixel - segmentation is adopted based on a similarity metric that measures the color - similarity and space proximity between image pixels.LSC is of linear computational - complexity and high memory efficiency and is able to preserve global properties of images. - - - - - Creates instance by raw pointer - - - - - Releases managed resources - - - - - Class implementing the LSC (Linear Spectral Clustering) superpixels. - - The function initializes a SuperpixelLSC object for the input image. It sets the parameters of - superpixel algorithm, which are: region_size and ruler.It preallocate some buffers for future - computing iterations over the given image.An example of LSC is illustrated in the following picture. - For enhanced results it is recommended for color images to preprocess image with little gaussian blur - with a small 3 x 3 kernel and additional conversion into CieLAB color space. - - image Image to segment - Chooses an average superpixel size measured in pixels - Chooses the enforcement of superpixel compactness factor of superpixel - - - - - Calculates the actual amount of superpixels on a given segmentation computed and stored in SuperpixelLSC object. - - - - - - Calculates the superpixel segmentation on a given image with the initialized - parameters in the SuperpixelLSC object. - - This function can be called again without the need of initializing the algorithm with - createSuperpixelLSC(). This save the computational cost of allocating memory for all the - structures of the algorithm. - - The function computes the superpixels segmentation of an image with the parameters initialized - with the function createSuperpixelLSC(). The algorithms starts from a grid of superpixels and - then refines the boundaries by proposing updates of edges boundaries. - - Number of iterations. Higher number improves the result. - - - - Returns the segmentation labeling of the image. - Each label represents a superpixel, and each pixel is assigned to one superpixel label. - - The function returns an image with the labels of the superpixel segmentation.The labels are in - the range [0, getNumberOfSuperpixels()]. - - Return: A CV_32SC1 integer array containing the labels of the superpixel - segmentation.The labels are in the range[0, getNumberOfSuperpixels()]. - - - - Returns the mask of the superpixel segmentation stored in SuperpixelLSC object. - The function return the boundaries of the superpixel segmentation. - - Return: CV_8U1 image mask where -1 indicates that the pixel is a superpixel border, and 0 otherwise. - If false, the border is only one pixel wide, otherwise all pixels at the border are masked. - - - - Enforce label connectivity. - The function merge component that is too small, assigning the previously found adjacent label - to this component.Calling this function may change the final number of superpixels. - - The minimum element size in percents that should be absorbed into a bigger - superpixel.Given resulted average superpixel size valid value should be in 0-100 range, 25 means - that less then a quarter sized superpixel should be absorbed, this is default. - - - - Class implementing the SEEDS (Superpixels Extracted via Energy-Driven Sampling) superpixels - algorithm described in @cite VBRV14. - - The algorithm uses an efficient hill-climbing algorithm to optimize the superpixels' energy - function that is based on color histograms and a boundary term, which is optional.The energy - function encourages superpixels to be of the same color, and if the boundary term is activated, the - superpixels have smooth boundaries and are of similar shape. In practice it starts from a regular - grid of superpixels and moves the pixels or blocks of pixels at the boundaries to refine the - solution.The algorithm runs in real-time using a single CPU. - - - - - Creates instance by raw pointer - - - - - Releases managed resources - - - - - Initializes a SuperpixelSEEDS object. - - The function initializes a SuperpixelSEEDS object for the input image. It stores the parameters of - the image: image_width, image_height and image_channels.It also sets the parameters of the SEEDS - superpixel algorithm, which are: num_superpixels, num_levels, use_prior, histogram_bins and - double_step. - - The number of levels in num_levels defines the amount of block levels that the algorithm use in the - optimization.The initialization is a grid, in which the superpixels are equally distributed through - the width and the height of the image.The larger blocks correspond to the superpixel size, and the - levels with smaller blocks are formed by dividing the larger blocks into 2 x 2 blocks of pixels, - recursively until the smaller block level. An example of initialization of 4 block levels is - illustrated in the following figure. - - Image width. - Image height. - Number of channels of the image. - Desired number of superpixels. Note that the actual number may be smaller - due to restrictions(depending on the image size and num_levels). Use getNumberOfSuperpixels() to - get the actual number. - Number of block levels. The more levels, the more accurate is the segmentation, - but needs more memory and CPU time. - enable 3x3 shape smoothing term if \>0. A larger value leads to smoother shapes. prior - must be in the range[0, 5]. - Number of histogram bins. - If true, iterate each block level twice for higher accuracy. - - - - - Calculates the superpixel segmentation on a given image stored in SuperpixelSEEDS object. - - The function computes the superpixels segmentation of an image with the parameters initialized - with the function createSuperpixelSEEDS(). - - - - - - Input image. Supported formats: CV_8U, CV_16U, CV_32F. Image size & number of - channels must match with the initialized image size & channels with the function - createSuperpixelSEEDS(). It should be in HSV or Lab color space.Lab is a bit better, but also slower. - - Supported formats: CV_8U, CV_16U, CV_32F. Image size & number of - channels must match with the initialized image size & channels with the function - createSuperpixelSEEDS(). It should be in HSV or Lab color space.Lab is a bit better, but also slower. - Number of pixel level iterations. Higher number improves the result. - - - - Returns the segmentation labeling of the image. - Each label represents a superpixel, and each pixel is assigned to one superpixel label. - - The function returns an image with ssthe labels of the superpixel segmentation. The labels are in - the range[0, getNumberOfSuperpixels()]. - - Return: A CV_32UC1 integer array containing the labels of the superpixel - segmentation.The labels are in the range[0, getNumberOfSuperpixels()]. - - - - Returns the mask of the superpixel segmentation stored in SuperpixelSEEDS object. - The function return the boundaries of the superpixel segmentation. - - Return: CV_8U1 image mask where -1 indicates that the pixel is a superpixel border, and 0 otherwise. - If false, the border is only one pixel wide, otherwise all pixels at the border are masked. - - - - Class implementing the SLIC (Simple Linear Iterative Clustering) superpixels - algorithm described in @cite Achanta2012. - - - - - Creates instance by raw pointer - - - - - Releases managed resources - - - - - Initialize a SuperpixelSLIC object. - - The function initializes a SuperpixelSLIC object for the input image. It sets the parameters of chosen - superpixel algorithm, which are: region_size and ruler.It preallocate some buffers for future - computing iterations over the given image.For enanched results it is recommended for color images to - preprocess image with little gaussian blur using a small 3 x 3 kernel and additional conversion into - CieLAB color space.An example of SLIC versus SLICO and MSLIC is ilustrated in the following picture. - - Image to segment - Chooses the algorithm variant to use: - SLIC segments image using a desired region_size, and in addition SLICO will optimize using adaptive compactness factor, - while MSLIC will optimize using manifold methods resulting in more content-sensitive superpixels. - Chooses an average superpixel size measured in pixels - Chooses the enforcement of superpixel smoothness factor of superpixel - - - - - Calculates the actual amount of superpixels on a given segmentation computed - and stored in SuperpixelSLIC object. - - - - - - Calculates the superpixel segmentation on a given image with the initialized - parameters in the SuperpixelSLIC object. - - This function can be called again without the need of initializing the algorithm with - createSuperpixelSLIC(). This save the computational cost of allocating memory for all the - structures of the algorithm. - - The function computes the superpixels segmentation of an image with the parameters initialized - with the function createSuperpixelSLIC(). The algorithms starts from a grid of superpixels and - then refines the boundaries by proposing updates of edges boundaries. - - Number of iterations. Higher number improves the result. - - - - Returns the segmentation labeling of the image. - Each label represents a superpixel, and each pixel is assigned to one superpixel label. - - The function returns an image with the labels of the superpixel segmentation. The labels are in - the range[0, getNumberOfSuperpixels()]. - - - - - - Returns the mask of the superpixel segmentation stored in SuperpixelSLIC object. - The function return the boundaries of the superpixel segmentation. - - Return: CV_8U1 image mask where -1 indicates that the pixel is a superpixel border, and 0 otherwise. - If false, the border is only one pixel wide, otherwise all pixels at the border are masked. - - - - Enforce label connectivity. - - The function merge component that is too small, assigning the previously found adjacent label - to this component.Calling this function may change the final number of superpixels. - - The minimum element size in percents that should be absorbed into a bigger - superpixel.Given resulted average superpixel size valid value should be in 0-100 range, 25 means - that less then a quarter sized superpixel should be absorbed, this is default. - - - - Applies Ridge Detection Filter to an input image. - - Implements Ridge detection similar to the one in [Mathematica](http://reference.wolfram.com/language/ref/RidgeFilter.html) - using the eigen values from the Hessian Matrix of the input image using Sobel Derivatives. - Additional refinement can be done using Skeletonization and Binarization. Adapted from @cite segleafvein and @cite M_RF - - - - - Constructor - - - - - Create pointer to the Ridge detection filter. - - Specifies output image depth. Defualt is CV_32FC1 - Order of derivative x, default is 1 - Order of derivative y, default is 1 - Sobel kernel size , default is 3 - Converted format for output, default is CV_8UC1 - Optional scale value for derivative values, default is 1 - Optional bias added to output, default is 0 - Pixel extrapolation method, default is BORDER_DEFAULT - - - - - Releases managed resources - - - - - Apply Ridge detection filter on input image. - - InputArray as supported by Sobel. img can be 1-Channel or 3-Channels. - OutputAray of structure as RidgeDetectionFilter::ddepth. Output image with ridges. - - - - cv::xphoto functions - - - - - Performs image denoising using the Block-Matching and 3D-filtering algorithm - (http://www.cs.tut.fi/~foi/GCF-BM3D/BM3D_TIP_2007.pdf) with several computational - optimizations.Noise expected to be a gaussian white noise. - - Input 8-bit or 16-bit 1-channel image. - Output image of the first step of BM3D with the same size and type as src. - Output image of the second step of BM3D with the same size and type as src. - Parameter regulating filter strength. Big h value perfectly removes noise but also - removes image details, smaller h value preserves details but also preserves some noise. - Size in pixels of the template patch that is used for block-matching. Should be power of 2. - Size in pixels of the window that is used to perform block-matching. - Affect performance linearly: greater searchWindowsSize - greater denoising time. Must be larger than templateWindowSize. - Block matching threshold for the first step of BM3D (hard thresholding), - i.e.maximum distance for which two blocks are considered similar.Value expressed in euclidean distance. - Block matching threshold for the second step of BM3D (Wiener filtering), - i.e.maximum distance for which two blocks are considered similar. Value expressed in euclidean distance. - Maximum size of the 3D group for collaborative filtering. - Sliding step to process every next reference block. - Kaiser window parameter that affects the sidelobe attenuation of the transform of the - window.Kaiser window is used in order to reduce border effects.To prevent usage of the window, set beta to zero. - Norm used to calculate distance between blocks. L2 is slower than L1 but yields more accurate results. - Step of BM3D to be executed. Allowed are only BM3D_STEP1 and BM3D_STEPALL. - BM3D_STEP2 is not allowed as it requires basic estimate to be present. - Type of the orthogonal transform used in collaborative filtering step. - Currently only Haar transform is supported. - - - - Performs image denoising using the Block-Matching and 3D-filtering algorithm - (http://www.cs.tut.fi/~foi/GCF-BM3D/BM3D_TIP_2007.pdf) with several computational optimizations.Noise expected to be a gaussian white noise. - - Input 8-bit or 16-bit 1-channel image. - Output image with the same size and type as src. - Parameter regulating filter strength. Big h value perfectly removes noise but also - removes image details, smaller h value preserves details but also preserves some noise. - Size in pixels of the template patch that is used for block-matching. Should be power of 2. - Size in pixels of the window that is used to perform block-matching. - Affect performance linearly: greater searchWindowsSize - greater denoising time. Must be larger than templateWindowSize. - Block matching threshold for the first step of BM3D (hard thresholding), - i.e.maximum distance for which two blocks are considered similar.Value expressed in euclidean distance. - Block matching threshold for the second step of BM3D (Wiener filtering), - i.e.maximum distance for which two blocks are considered similar. Value expressed in euclidean distance. - Maximum size of the 3D group for collaborative filtering. - Sliding step to process every next reference block. - Kaiser window parameter that affects the sidelobe attenuation of the transform of the - window.Kaiser window is used in order to reduce border effects.To prevent usage of the window, set beta to zero. - Norm used to calculate distance between blocks. L2 is slower than L1 but yields more accurate results. - Step of BM3D to be executed. Allowed are only BM3D_STEP1 and BM3D_STEPALL. - BM3D_STEP2 is not allowed as it requires basic estimate to be present. - Type of the orthogonal transform used in collaborative filtering step. - Currently only Haar transform is supported. - - - - The function implements simple dct-based denoising - - - http://www.ipol.im/pub/art/2011/ys-dct/ - - source image - destination image - expected noise standard deviation - size of block side where dct is computed - - - - The function implements different single-image inpainting algorithms. - - source image, it could be of any type and any number of channels from 1 to 4. In case of 3- and 4-channels images the function expect them in CIELab colorspace or similar one, where first color component shows intensity, while second and third shows colors. Nonetheless you can try any colorspaces. - mask (CV_8UC1), where non-zero pixels indicate valid image area, while zero pixels indicate area to be inpainted - destination image - see OpenCvSharp.XPhoto.InpaintTypes - - - - oilPainting. - See the book @cite Holzmann1988 for details. - - Input three-channel or one channel image (either CV_8UC3 or CV_8UC1) - Output image of the same size and type as src. - neighbouring size is 2-size+1 - image is divided by dynRatio before histogram processing - color space conversion code(see ColorConversionCodes). Histogram will used only first plane - - - - Implements an efficient fixed-point approximation for applying channel gains, - which is the last step of multiple white balance algorithms. - - Input three-channel image in the BGR color space (either CV_8UC3 or CV_16UC3) - Output image of the same size and type as src. - gain for the B channel - gain for the G channel - gain for the R channel - - - - Creates an instance of GrayworldWB - - - - - - Creates an instance of LearningBasedWB - - Path to a .yml file with the model. If not specified, the default model is used - - - - - Creates an instance of SimpleWB - - - - - - BM3D algorithm steps - - - - - Execute all steps of the algorithm - - - - - Execute only first step of the algorithm - - - - - Execute only second step of the algorithm - - - - - various inpainting algorithms - - - - - This algorithm searches for dominant correspondences(transformations) of image patches - and tries to seamlessly fill-in the area to be inpainted using this transformations inpaint - - - - - Performs Frequency Selective Reconstruction (FSR). - One of the two quality profiles BEST and FAST can be chosen, depending on the time available for reconstruction. - See @cite GenserPCS2018 and @cite SeilerTIP2015 for details. - - The algorithm may be utilized for the following areas of application: - 1. %Error Concealment (Inpainting). - The sampling mask indicates the missing pixels of the distorted input - image to be reconstructed. - 2. Non-Regular Sampling. - For more information on how to choose a good sampling mask, please review - @cite GroscheICIP2018 and @cite GroscheIST2018. - - 1-channel grayscale or 3-channel BGR image are accepted. - - Conventional accepted ranges: - - 0-255 for CV_8U - - 0-65535 for CV_16U - - 0-1 for CV_32F/CV_64F. - - - - - See #INPAINT_FSR_BEST - - - - - BM3D transform types - - - - - Un-normalized Haar transform - - - - - Gray-world white balance algorithm. - - - - - Constructor - - - - - Creates an instance of GrayworldWB - - - - - - - - - Maximum saturation for a pixel to be included in the gray-world assumption. - - - - - Applies white balancing to the input image. - - Input image - White balancing result - - - - More sophisticated learning-based automatic white balance algorithm. - - - - - Constructor - - - - - Creates an instance of LearningBasedWB - - Path to a .yml file with the model. If not specified, the default model is used - - - - - - - - Defines the size of one dimension of a three-dimensional RGB histogram that is used internally by the algorithm. It often makes sense to increase the number of bins for images with higher bit depth (e.g. 256 bins for a 12 bit image). - - - - - Maximum possible value of the input image (e.g. 255 for 8 bit images, 4095 for 12 bit images) - - - - - Threshold that is used to determine saturated pixels, i.e. pixels where at least one of the channels exceeds - - - - - Applies white balancing to the input image. - - Input image - White balancing result - - - - Implements the feature extraction part of the algorithm. - - Input three-channel image (BGR color space is assumed). - An array of four (r,g) chromaticity tuples corresponding to the features listed above. - - - - A simple white balance algorithm that works by independently stretching each of the input image channels to the specified range. For increased robustness it ignores the top and bottom p% of pixel values. - - - - - Constructor - - - - - Creates an instance of SimpleWB - - - - - - Releases managed resources - - - - - Input image range maximum value. - - - - - Input image range minimum value. - - - - - Output image range maximum value. - - - - - Output image range minimum value. - - - - - Percent of top/bottom values to ignore. - - - - - Applies white balancing to the input image. - - Input image - White balancing result - - - - This algorithm decomposes image into two layers: base layer and detail layer using bilateral filter - and compresses contrast of the base layer thus preserving all the details. - - This implementation uses regular bilateral filter from OpenCV. - - Saturation enhancement is possible as in cv::TonemapDrago. - - For more information see @cite DD02 . - - - - - Constructor - - - - - Creates TonemapDurand object - - positive value for gamma correction. Gamma value of 1.0 implies no correction, gamma - equal to 2.2f is suitable for most displays. - Generally gamma > 1 brightens the image and gamma < 1 darkens it. - resulting contrast on logarithmic scale, i. e. log(max / min), where max and min - positive saturation enhancement value. 1.0 preserves saturation, values greater - than 1 increase saturation and values less than 1 decrease it. - bilateral filter sigma in coordinate space - bilateral filter sigma in color space - - - - - Releases managed resources - - - - - Gets or sets positive saturation enhancement value. 1.0 preserves saturation, values greater - than 1 increase saturation and values less than 1 decrease it. - - - - - Gets or sets resulting contrast on logarithmic scale, i. e. log(max / min), where max and min - - - - - Gets or sets bilateral filter sigma in coordinate space - - - - - Gets or sets bilateral filter sigma in color space - - - - - The base class for auto white balance algorithms. - - - - - Applies white balancing to the input image. - - Input image - White balancing result - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/OpenCvSharpExtern.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/OpenCvSharpExtern.dll deleted file mode 100644 index ee514cc..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/OpenCvSharpExtern.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/OxyPlot.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/OxyPlot.dll deleted file mode 100644 index c6b8663..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/OxyPlot.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/OxyPlot.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/OxyPlot.xml deleted file mode 100644 index 12060ea..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/OxyPlot.xml +++ /dev/null @@ -1,20905 +0,0 @@ - - - - OxyPlot - - - - - Provides an abstract base class for annotations. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the rendering layer of the annotation. The default value is . - - - - - Gets the X axis. - - The X axis. - - - - Gets or sets the X axis key. - - The X axis key. - - - - Gets the Y axis. - - The Y axis. - - - - Gets or sets a value indicating whether to clip the annotation by the X axis range. - - true if clipping by the X axis is enabled; otherwise, false. - - - - Gets or sets a value indicating whether to clip the annotation by the Y axis range. - - true if clipping by the Y axis is enabled; otherwise, false. - - - - Gets or sets the Y axis key. - - The Y axis key. - - - - Ensures that the annotation axes are set. - - - - - Renders the annotation on the specified context. - - The render context. - - - - - - - - - - - - - Specifies the layer for an . - - - - - Render the annotation below the gridlines of the axes. - - - - - Render the annotation below the series. - - - - - Render the annotation above the series. - - - - - Specifies the orientation of the text in an annotation. - - - - - Horizontal text. - - - - - Vertical text. - - - - - Oriented along the line. - - - - - Represents an annotation that shows an arrow. - - - - - The end point in screen coordinates. - - - - - The start point in screen coordinates. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the arrow direction. - - Setting this property overrides the property. - - - - Gets or sets the color of the arrow. - - - - - Gets or sets the end point of the arrow. - - - - - Gets or sets the length of the head (relative to the stroke thickness) (the default value is 10). - - The length of the head. - - - - Gets or sets the width of the head (relative to the stroke thickness) (the default value is 3). - - The width of the head. - - - - Gets or sets the line join type. - - The line join type. - - - - Gets or sets the line style. - - The line style. - - - - Gets or sets the start point of the arrow. - - This property is overridden by the ArrowDirection property, if set. - - - - Gets or sets the stroke thickness (the default value is 2). - - The stroke thickness. - - - - Gets or sets the 'veeness' of the arrow head (relative to thickness) (the default value is 0). - - The 'veeness'. - - - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Represents an annotation that shows an ellipse. - - - - - The rectangle transformed to screen coordinates. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the x-coordinate of the center. - - - - - Gets or sets the y-coordinate of the center. - - - - - Gets or sets the width of the ellipse. - - - - - Gets or sets the height of the ellipse. - - - - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Represents an annotation that shows a function rendered as a path. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the type of function. Can be either f(x) or f(y). - - The type of the function. - - - - Gets or sets the y=f(x) equation when Type is Equation. - - - - - Gets or sets the resolution. - - The resolution. - - - - Gets the screen points. - - The list of screen points defined by this function annotation. - - - - Defines the definition of function in a . - - - - - Curve equation x=f(y) given by the Equation property - - - - - Curve equation y=f(x) given by the Equation property - - - - - Represents an annotation that shows an image. - - - - - The actual bounds of the rendered image. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the image source. - - The image source. - - - - Gets or sets the horizontal alignment. - - The horizontal alignment. - - - - Gets or sets the X position of the image. - - The X. - - - - Gets or sets the Y position of the image. - - The Y. - - - - Gets or sets the X offset. - - The offset X. - - - - Gets or sets the Y offset. - - The offset Y. - - - - Gets or sets the width. - - The width. - - - - Gets or sets the height. - - The height. - - - - Gets or sets the opacity (0-1). - - The opacity value. - - - - Gets or sets a value indicating whether to apply smooth interpolation to the image. - - true if the image should be interpolated (using a high-quality bi-cubic interpolation); false if the nearest neighbor should be used. - - - - Gets or sets the vertical alignment. - - The vertical alignment. - - - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Gets the point. - - The x. - The y. - The model. - The point in screen coordinates. - - - - Gets the vector. - - The x component. - The y component. - The model. - The vector in screen coordinates. - - - - - - - Represents an annotation that shows a straight line. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the y-intercept when Type is LinearEquation. - - The intercept value. - Linear equation y-intercept (the b in y=mx+b). - http://en.wikipedia.org/wiki/Linear_equation - - - - Gets or sets the slope when Type is LinearEquation. - - The slope value. - Linear equation slope (the m in y=mx+b) - http://en.wikipedia.org/wiki/Linear_equation - - - - Gets or sets the type of line equation. - - - - - Gets or sets the X position for vertical lines (only for Type==Vertical). - - - - - Gets or sets the Y position for horizontal lines (only for Type==Horizontal) - - - - - Gets the screen points. - - The list of points to display on screen for this path. - - - - Specifies the definition of the line in a . - - - - - Horizontal line given by the Y property - - - - - Vertical line given by the X property - - - - - Linear equation y=mx+b given by the Slope and Intercept properties - - - - - Provides an abstract base class for all annotations that contain paths (lines, functions or polylines). - - - - - The points of the line, transformed to screen coordinates. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color of the line. - - - - - Gets or sets the line join. - - The line join. - - - - Gets or sets the line style. - - The line style. - - - - Gets or sets the maximum X coordinate for the line. - - - - - Gets or sets the maximum Y coordinate for the line. - - - - - Gets or sets the minimum X coordinate for the line. - - - - - Gets or sets the minimum Y coordinate for the line. - - - - - Gets or sets the stroke thickness. - - The stroke thickness. - - - - Gets or sets the text margin (along the line). - - The text margin. - - - - Gets or sets the text padding (in the direction of the text). - - The text padding. - - - - Gets or sets the text orientation. - - The text orientation. - - - - Gets or sets the text position relative to the line. - - The text position in the interval [0,1]. - Positions smaller than 0.25 are left aligned at the start of the line - Positions larger than 0.75 are right aligned at the end of the line - Other positions are center aligned at the specified position - - - - Gets or sets the actual minimum value on the x axis. - - The actual minimum value on the x axis. - - - - Gets or sets the actual minimum value on the y axis. - - The actual minimum value on the y axis. - - - - Gets or sets the actual maximum value on the x axis. - - The actual maximum value on the x axis. - - - - Gets or sets the actual maximum value on the y axis. - - The actual maximum value on the y axis. - - - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Gets the screen points. - - The list of points to display on screen for this path. - - - - Calculates the actual minimums and maximums. - - - - - Gets the point on a curve at the specified relative distance along the curve. - - The curve points. - The relative distance along the curve. - The margins. - The position. - The angle. - True if a position was found. - - - - Represents an annotation that shows a point. - - - - - The position transformed to screen coordinates. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the x-coordinate of the center. - - - - - Gets or sets the y-coordinate of the center. - - - - - Gets or sets the size of the rendered point. - - - - - Gets or sets the distance between the rendered point and the text. - - - - - Gets or sets the shape of the rendered point. - - The shape. - - - - Gets or sets a custom polygon outline for the point marker. Set to to use this property. - - A polyline. The default is null. - - - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Represents an annotation that shows a polygon. - - - - - The polygon points transformed to screen coordinates. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the line join. - - The line join. - - - - Gets or sets the line style. - - The line style. - - - - Gets the points. - - The points. - - - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Represents an annotation that shows a polyline. - - - - - The points. - - - - - Gets the points. - - The points. - - - - Gets or sets the minimum length of the segment. - Increasing this number will increase performance, - but make the curve less accurate. - - The minimum length of the segment. - - - - Gets or sets the interpolation algorithm. - - An interpolation algorithm. - - - - Gets the screen points. - - The list of points to display on screen for this path. - - - - Represents an annotation that shows a rectangle. - - - - - The rectangle transformed to screen coordinates. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the minimum X. - - The minimum X. - - - - Gets or sets the maximum X. - - The maximum X. - - - - Gets or sets the minimum Y. - - The minimum Y. - - - - Gets or sets the maximum Y. - - The maximum Y. - - - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Provides an abstract base class for shape annotations, such as , , and . - - - - - Initializes a new instance of the class. - - - - - Gets or sets the fill color. - - The fill color. - - - - Gets or sets the stroke color. - - - - - Gets or sets the stroke thickness. - - - - - Represents an annotation that shows text. - - - - - The actual bounds of the text. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the fill color of the background rectangle. - - The background. - - - - Gets or sets the position offset (screen coordinates). - - The offset. - - - - Gets or sets the padding of the background rectangle. - - The padding. - - - - Gets or sets the stroke color of the background rectangle. - - The stroke color. - - - - Gets or sets the stroke thickness of the background rectangle. - - The stroke thickness. - - - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Gets the coordinates of the (rotated) background rectangle. - - The position. - The size. - The padding. - The rotation. - The horizontal alignment. - The vertical alignment. - The background rectangle coordinates. - - - - Provides an abstract base class for annotations that contains text. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the annotation text. - - The text. - - - - Gets or sets the position of the text. - - If the value is DataPoint.Undefined, the default position of the text will be used. - - - - Gets or sets the horizontal alignment of the text. - - - - - Gets or sets the vertical alignment of the text. - - - - - Gets or sets the rotation of the text. - - The text rotation in degrees. - - - - Gets the actual position of the text. - - A function that returns the default position. This is used if is undefined. - The actual position of the text, in screen space. - - - - Gets the actual text alignment. - - The horizontal alignment. - The vertical alignment. - - - - Provides an abstract base class for transposable annotations. - - - - - - - - - - - - - - Represents an angular axis for polar plots. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the start angle (degrees). - - - - - Gets or sets the end angle (degrees). - - - - - Gets the coordinates used to draw ticks and tick labels (numbers or category names). - - The major label values. - The major tick values. - The minor tick values. - - - - Inverse transforms the specified screen point. - - The x coordinate. - The y coordinate. - The y-axis. - The data point. - Angle axis should always be the y-axis. - - - - Determines whether the axis is used for X/Y values. - - true if it is an XY axis; otherwise, false . - - - - Renders the axis on the specified render context. - - The render context. - The pass. - - - - Transforms the specified point to screen coordinates. - - The x value (for the current axis). - The y value. - The y axis. - The transformed point. - - - - Updates the scale and offset properties of the transform from the specified boundary rectangle. - - The bounds. - - - - Represents an angular axis that covers the whole plot area. - - - - - Renders the axis on the specified render context. - - The render context. - The pass. - - - - Provides an abstract base class for axes. - - - - - Exponent function. - - - - - Mantissa function. - - - - - Rounds a value if the difference between the rounded value and the original value is less than 1e-6. - - - - - The offset. - - - - - The scale. - - - - - The position of the axis. - - - - - Initializes a new instance of the class. - - - - - Occurs when the axis has been changed (by zooming, panning or resetting). - - - - - Occurs when the transform changed (size or axis range was changed). - - - - - Gets or sets the absolute maximum. This is only used for the UI control. It will not be possible to zoom/pan beyond this limit. The default value is double.MaxValue. - - - - - Gets or sets the absolute minimum. This is only used for the UI control. It will not be possible to zoom/pan beyond this limit. The default value is double.MinValue. - - - - - Gets or sets the actual major step. - - - - - Gets or sets the actual maximum value of the axis. - - If is not NaN, this value will be defined by . - Otherwise, if is not NaN, this value will be defined by . - Otherwise, this value will be defined by the maximum (+padding) of the data. - - - - Gets or sets the actual minimum value of the axis. - - If is not NaN, this value will be defined by . - Otherwise, if is not NaN, this value will be defined by . - Otherwise this value will be defined by the minimum (+padding) of the data. - - - - Gets or sets the maximum displayed value on the axis, as determined by the and . - - - The value is refreshed by , which is called before any plot elements are rendered. - - - - - Gets or sets the minimum displayed value on the axis, as determined by the and . - - - The value is refreshed by , which is called before any plot elements are rendered. - - - - - Gets or sets the actual minor step. - - - - - Gets or sets the actual string format being used. - - - - - Gets the actual title of the axis. - - If the property is set, the property is used to format the actual title. - - - - Gets or sets the orientation angle (degrees) for the axis labels. The default value is 0. - - - - - Gets or sets the distance from the end of the tick lines to the labels. The default value is 4. - - - - - Gets or sets the minimum distance from the axis labels to the axis title. The default value is 4. - - - - - Gets or sets the distance between the plot area and the axis. The default value is 0. - - - - - Gets or sets the color of the axis line. The default value is . - - - - - Gets or sets the line style of the axis line. The default value is . - - - - - Gets or sets the thickness of the axis line. The default value is 1. - - - - - Gets or sets a value indicating whether to clip the axis title. The default value is true. - - - - - Gets or sets a value indicating whether to crop gridlines with perpendicular axes Start/EndPositions. The default value is false. - - - - - Gets or sets the maximum value of the data displayed on this axis. - - - - - Gets or sets the minimum value of the data displayed on this axis. - - - - - Gets or sets the end position of the axis on the plot area. The default value is 1. - - The position is defined by a fraction in the range from 0 to 1, where 0 is at the bottom/left - and 1 is at the top/right. - - - - Gets or sets the color of the extra gridlines. The default value is . - - - - - Gets or sets the line style of the extra gridlines. The default value is . - - - - - Gets or sets the thickness of the extra gridlines. The default value is 1. - - - - - Gets or sets the values for the extra gridlines. The default value is null. - - - - - Gets or sets the filter function. The default value is null. - - - - - Gets or sets the maximum value that can be shown using this axis. Values greater or equal to this value will not be shown. The default value is double.MaxValue. - - - - - Gets or sets the minimum value that can be shown using this axis. Values smaller or equal to this value will not be shown. The default value is double.MinValue. - - - - - Gets or sets the maximum length (screen space) of the intervals. The available length of the axis will be divided by this length to get the approximate number of major intervals on the axis. The default value is 60. - - - - - Gets or sets a value indicating whether this axis is visible. The default value is true. - - - - - Gets or sets a value indicating whether panning is enabled. The default value is true. - - - - - Gets a value indicating whether this axis is reversed. It is reversed if > . - - - - - Gets or sets a value indicating whether zooming is enabled. The default value is true. - - - - - Gets or sets the key of the axis. This can be used to specify an axis if you have defined multiple axes in a plot. The default value is null. - - - - - Gets or sets the formatting function for the labels. The default value is null. - - This function can be used instead of overriding the method. - - - - Gets or sets the layer of the axis. The default value is . - - - - - Gets or sets the color of the major gridlines. The default value is #40000000. - - - - - Gets or sets the line style of the major gridlines. The default value is . - - - - - Gets or sets the thickness of the major gridlines. The default value is 1. - - - - - Gets or sets the interval between major ticks. The default value is double.NaN. - - - - - Gets or sets the size of the major ticks. The default value is 7. - - - - - Gets or sets the maximum value of the axis. The default value is double.NaN. - - - - - Gets or sets the 'padding' fraction of the maximum value. The default value is 0.01. - - A value of 0.01 gives 1% more space on the maximum end of the axis. This property is not used if the property is set. - - - - Gets or sets the screen-space data margin at the maximum. The default value is 0. - - The number of device independent units to included between the and . - - - - Gets or sets the screen-space margin at the maximum. The default value is 0. - - The number of device independent units to be left empty between the axis and the . - - - - Gets or sets the maximum range of the axis. Setting this property ensures that ActualMaximum-ActualMinimum < MaximumRange. The default value is double.PositiveInfinity. - - - - - Gets or sets the minimum value of the axis. The default value is double.NaN. - - - - - Gets or sets the minimum value for the interval between major ticks. The default value is 0. - - - - - Gets or sets the minimum value for the interval between minor ticks. The default value is 0. - - - - - Gets or sets the 'padding' fraction of the minimum value. The default value is 0.01. - - A value of 0.01 gives 1% more space on the minimum end of the axis. This property is not used if the property is set. - - - - Gets or sets the screen-space data margin at the minimum. The default value is 0. - - The number of device independent units to included between the and . - - - - Gets or sets the screen-space margin at the minimum. The default value is 0. - - The number of device independent units to be left empty between the axis the . - - - - Gets or sets the minimum range of the axis. Setting this property ensures that ActualMaximum-ActualMinimum > MinimumRange. The default value is 0. - - - - - Gets or sets the color of the minor gridlines. The default value is #20000000. - - - - - Gets or sets the line style of the minor gridlines. The default value is . - - - - - Gets or sets the thickness of the minor gridlines. The default value is 1. - - - - - Gets or sets the interval between minor ticks. The default value is double.NaN. - - - - - Gets or sets the color of the minor ticks. The default value is . - - If the value is , the value of - will be used. - - - - Gets or sets the size of the minor ticks. The default value is 4. - - - - - Gets the offset. This is used to transform between data and screen coordinates. - - - - - Gets or sets the position of the axis. The default value is . - - - - - Gets or sets a value indicating whether the axis should be positioned at the zero-crossing of the related axis. The default value is false. - - - - - Gets or sets the position tier which defines in which tier the axis is displayed. The default value is 0. - - The bigger the value the further afar is the axis from the graph. - - - - Gets the scaling factor of the axis. This is used to transform between data and screen coordinates. - - - - - Gets or sets the screen coordinate of the maximum end of the axis. - - - - - Gets or sets the screen coordinate of the minimum end of the axis. - - - - - Gets or sets the start position of the axis on the plot area. The default value is 0. - - The position is defined by a fraction in the range from 0 to 1, where 0 is at the bottom/left - and 1 is at the top/right. - - - - Gets or sets the string format used for formatting the axis values. The default value is null. - - - - - Gets or sets the tick style for major and minor ticks. The default value is . - - - - - Gets or sets the color of the major and minor ticks. The default value is . - - - - - Gets or sets the title of the axis. The default value is null. - - - - - Gets or sets the length of the title clipping rectangle (fraction of the available length of the axis). The default value is 0.9. - - - - - Gets or sets the color of the title. The default value is . - - If the value is null, the will be used. - - - - Gets or sets the title font. The default value is null. - - - - - Gets or sets the size of the title font. The default value is double.NaN. - - - - - Gets or sets the weight of the title font. The default value is . - - - - - Gets or sets the format string used for formatting the title and unit when is defined. - The default value is "{0} [{1}]", where {0} refers to the and {1} refers to the . - - If is null, the actual title is defined by only. - - - - Gets or sets the position of the title. The default value is 0.5. - - The position is defined by a fraction in the range 0 to 1. - - - - Gets or sets the unit of the axis. The default value is null. - - The is used to format the title including this unit. - - - - Gets or sets a value indicating whether to use superscript exponential format. The default value is false. - - - This format will convert 1.5E+03 to 1.5·10^{3} and render the superscript properly. - If is null, 1.0E+03 will be converted to 10^{3}, otherwise it will use the format string for the mantissa. - - - - - Gets or sets the desired margins such that the axis text ticks will not be clipped. - The actual margins may be smaller or larger than the desired margins if they are set manually. - - - - - Gets or sets the position tier max shift. - - - - - Gets or sets the position tier min shift. - - - - - Gets or sets the size of the position tier. - - - - - Gets the actual color of the title. - - - - - Gets the actual title font. - - - - - Gets the actual size of the title font. - - - - - Gets the actual title font weight. - - - - - Gets or sets the current view's maximum. This value is used when the user zooms or pans. - - The view maximum. - - - - Gets or sets the current view's minimum. This value is used when the user zooms or pans. - - The view minimum. - - - - Converts the value of the specified object to a double precision floating point number. DateTime objects are converted using DateTimeAxis.ToDouble and TimeSpan objects are converted using TimeSpanAxis.ToDouble. - - The value. - The floating point number value. - - - - Transforms the specified point from screen space to data space. - - The point. - The x axis. - The y axis. - The data point. - - - - Formats the value to be used on the axis. - - The value. - The formatted value. - - - - Gets the coordinates used to draw ticks and tick labels (numbers or category names). - - The major label values. - The major tick values. - The minor tick values. - - - - Gets the value from an axis coordinate, converts from a coordinate value to the actual data type. - - The coordinate. - The converted value. - Examples: The returns the and returns category strings. - - - - Inverse transform the specified screen point. - - The x coordinate. - The y coordinate. - The y-axis. - The data point. - - - - Inverse transforms the specified screen coordinate. This method can only be used with non-polar coordinate systems. - - The screen coordinate. - The value. - - - - Determines whether the axis is horizontal. - - true if the axis is horizontal; otherwise, false . - - - - Determines whether the specified value is valid. - - The value. - true if the specified value is valid; otherwise, false . - - - - Determines whether the axis is vertical. - - true if the axis is vertical; otherwise, false . - - - - Determines whether the axis is used for X/Y values. - - true if it is an XY axis; otherwise, false . - - - - Determines whether the axis is logarithmic. - - true if it is a logarithmic axis; otherwise, false . - - - - Measures the size of the axis and updates accordingly. This takes into account the axis title as well as tick labels - potentially exceeding the axis range. - - The render context. - - - - Pans the specified axis. - - The previous point (screen coordinates). - The current point (screen coordinates). - - - - Pans the specified axis. - - The delta. - - - - Renders the axis on the specified render context. - - The render context. - The pass. - - - - Resets the user's modification (zooming/panning) to minimum and maximum of this axis. - - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Transforms the specified point to screen coordinates. - - The x value (for the current axis). - The y value. - The y axis. - The transformed point. - - - - Transforms the specified coordinate to screen coordinates. This method can only be used with non-polar coordinate systems. - - The value. - The transformed value (screen coordinate). - - - - Zoom to the specified scale. - - The new scale. - - - - Zooms the axis to the range [x0,x1]. - - The new minimum. - The new maximum. - - - - Zooms the axis at the specified coordinate. - - The zoom factor. - The coordinate to zoom at. - - - - Zooms the axis with the specified zoom factor at the center of the axis. - - The zoom factor. - - - - Modifies the data range of the axis [DataMinimum,DataMaximum] to includes the specified value. - - The value. - - - - Resets the and values. - - - - - Updates the and values. - - If the user has zoomed/panned the axis, the internal ViewMaximum/ViewMinimum - values will be used. If Maximum or Minimum have been set, these values will be used. Otherwise the maximum and minimum values - of the series will be used, including the 'padding'. - - - - Updates the actual minor and major step intervals. - - The plot area rectangle. - - - - Updates the scale and offset properties of the transform from the specified boundary rectangle. - - The bounds. - - - - Invoked when , , , and are changed. - - - - - Gets the default format string. - - A format string. - This format string is used if the StringFormat is not set. - - - - Applies a transformation after the inverse transform of the value. - - The value to transform. - The transformed value. - If this method is overridden, the method must also be overridden. - See for examples on how to implement this. - - - - Applies a transformation before the transform the value. - - The value to transform. - The transformed value. - If this method is overridden, the method must also be overridden. - See for examples on how to implement this. - - - - Calculates the minor interval. - - The major interval. - The minor interval. - - - - Creates tick values at the specified interval. - - The start value. - The end value. - The interval. - The maximum number of ticks (optional). The default value is 1000. - A sequence of values. - Step cannot be zero or negative. - - - - Coerces the actual maximum and minimum values. - - - - - Formats the value to be used on the axis. - - The value to format. - The formatted value. - - - - Calculates the actual maximum value of the axis, including the . - - The new actual maximum value of the axis. - - Must be called before - - - - - Calculates the actual minimum value of the axis, including the . - - The new actual minimum value of the axis. - - Must be called after - - - - - Sets the transform. - - The new scale. - The new offset. - - - - Calculates the actual interval. - - Size of the available area. - Maximum length of the intervals. - The calculate actual interval. - - - - Returns the actual interval to use to determine which values are displayed in the axis. - - The available size. - The maximum interval size. - The range. - Actual interval to use to determine which values are displayed in the axis. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Provides additional data for the event. - - - - - Initializes a new instance of the class. - - Type of the change. - The delta minimum. - The delta maximum. - - - - Gets the type of the change. - - The type of the change. - - - - Gets the delta for the minimum. - - The delta. - - - - Gets the delta for the maximum. - - The delta. - - - - Defines change types for the event. - - - - - The axis was zoomed by the user. - - - - - The axis was panned by the user. - - - - - The axis zoom/pan was reset by the user. - - - - - Specifies the layer of an . - - - - - Below all series. - - - - - Above all series. - - - - - Specifies the position of an . - - - - - No position. - - - - - Left of the plot area. - - - - - Right of the plot area. - - - - - Top of the plot area. - - - - - Bottom of the plot area. - - - - - All positions. - - - - - Static utility methods for the classes. - - - - - Calculates the minor interval. - - The major interval. - The minor interval. - - - - Creates tick values at the specified interval. - - The start value. - The end value. - The interval. - The maximum number of ticks (optional). The default value is 1000. - A sequence of values. - Step cannot be zero or negative.;step - - - - Analyses two lists of major and minor ticks and creates a new containing the subset of the minor ticks which are not too close to any of the major ticks. - - The major ticks. Must be monotonically ascending or descending. - The minor ticks. Must be monotonically ascending or descending (same direction as major ticks). - A new list containing a subset of the original minor ticks such that there are no minor ticks too close to a major tick. - - - - Represents a category axis. - - The category axis is using the index of the label collection items as coordinates. - If you have 5 categories in the Labels collection, the categories will be placed at coordinates 0 to 4. - The range of the axis will be from -0.5 to 4.5 (excluding padding). - - - - The auto-generated labels. - - - - - The labels from the . - - - - - Initializes a new instance of the class. - - - - - Gets the actual category labels. - - - - - Gets or sets the gap width. - - The default value is 1.0 (100%). The gap width is given as a fraction of the total width/height of the items in a category. - - - - Gets or sets a value indicating whether the ticks are centered. If this is false, ticks will be drawn between each category. If this is true, ticks will be drawn in the middle of each category. - - - - - Gets or sets the items source (used to update the Labels collection). - - The items source. - - - - Gets or sets the data field for the labels. - - - - - Gets the list of category labels. - - - - - - - - - - - - - - Updates the category labels. - - The number of categories. - - - - - - - Represents a categorized color axis. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the invalid category color. - - The color. - - - - Gets or sets the palette. - - The palette. - - - - Gets the color of the specified index in the color palette. - - The color map index (less than NumberOfEntries). - The color. - - - - Gets the palette index of the specified value. - - The value. - The palette index. - If the value is less than minimum, 0 is returned. If the value is greater than maximum, Palette.Colors.Count+1 is returned. - - - - Renders the axis on the specified render context. - - The render context. - The pass. - - - - Gets the high value of the specified palette index. - - Index of the palette. - The value. - - - - Gets the high value. - - Index of the palette. - The major label values. - The value. - - - - Gets the low value. - - Index of the palette. - The major label values. - The value. - - - - Provides extension methods for . - - - - - Gets the color for the specified value. - - The axis. - The value. - The color. - - - - Represents an axis presenting values. - - The actual numeric values on the axis are days since 1900/01/01. - Use the static ToDouble and ToDateTime to convert numeric values to and from DateTimes. - The StringFormat value can be used to force formatting of the axis values - "yyyy-MM-dd" shows date - "w" or "ww" shows week number - "h:mm" shows hours and minutes - - - - The time origin. - - This gives the same numeric date values as Excel - - - - The maximum day value - - - - - The minimum day value - - - - - The actual interval type. - - - - - The actual minor interval type. - - - - - Initializes a new instance of the class. - - - - - Gets or sets CalendarWeekRule. - - - - - Gets or sets FirstDayOfWeek. - - - - - Gets or sets IntervalType. - - - - - Gets or sets MinorIntervalType. - - - - - Gets or sets the time zone (used when formatting date/time values). - - The time zone info. - No date/time conversion will be performed if this property is null. - - - - Creates a data point. - - The x value. - The y value. - A data point. - - - - Creates a data point. - - The x value. - The y value. - A data point. - - - - Creates a data point. - - The x value. - The y value. - A data point. - - - - Converts a numeric representation of the date (number of days after the time origin) to a DateTime structure. - - The number of days after the time origin. - A structure. Ticks = 0 if the value is invalid. - - - - Converts a DateTime to days after the time origin. - - The date/time structure. - The number of days after the time origin. - - - - Gets the tick values. - - The major label values. - The major tick values. - The minor tick values. - - - - Gets the value from an axis coordinate, converts from double to the correct data type if necessary. - e.g. DateTimeAxis returns the DateTime and CategoryAxis returns category strings. - - The coordinate. - The value. - - - - Updates the intervals. - - The plot area. - - - - Gets the default string format. - - - The format string. - - - - - Formats the value to be used on the axis. - - The value to format. - The formatted value. - - - - Calculates the actual interval. - - Size of the available area. - Maximum length of the intervals. - The calculate actual interval. - - - - Creates the date tick values. - - The min. - The max. - The step. - Type of the interval. - Date tick values. - - - - Creates tick values. - - The min. - The max. - The interval. - The interval type. - A list of tick values. - - - - Gets the week number for the specified date. - - The date. - The week number for the current culture. - - - - Specifies the interval for a . - - - - - Automatically determine interval. - - - - - Manual definition of intervals. - - - - - Interval type is milliseconds. - - - - - Interval type is seconds. - - - - - Interval type is minutes. - - - - - Interval type is hours. - - - - - Interval type is days. - - - - - Interval type is weeks. - - - - - Interval type is months. - - - - - Interval type is years. - - - - - Specifies functionality for color axes. - - - - - Gets the color of the specified index in the color palette. - - The color map index (less than NumberOfEntries). - The color. - - - - Gets the palette index of the specified value. - - The value. - The palette index. - If the value is less than minimum, 0 is returned. If the value is greater than maximum, Palette.Colors.Count+1 is returned. - - - - Represents an axis with linear scale. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether to format numbers as fractions. - - - - - Gets or sets the fraction unit. Remember to set FormatAsFractions to true. - - The fraction unit. - - - - Gets or sets the fraction unit symbol. Use FractionUnit = Math.PI and FractionUnitSymbol = "π" if you want the axis to show "π/2,π,3π/2,2π" etc. Use FractionUnit = 1 and FractionUnitSymbol = "L" if you want the axis to show "0,L/2,L" etc. Remember to set FormatAsFractions to true. - - The fraction unit symbol. - - - - Determines whether the axis is used for X/Y values. - - true if it is an XY axis; otherwise, false . - - - - Determines whether the axis is logarithmic. - - true if it is a logarithmic axis; otherwise, false . - - - - Formats the value to be used on the axis. - - The value to format. - The formatted value. - - - - Represents a linear color axis. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color used to represent NaN values. - - A that defines the color. The default value is OxyColors.Gray. - - - - Gets or sets the color of values above the maximum value. - - The color of the high values. - - - - Gets or sets the color of values below the minimum value. - - The color of the low values. - - - - Gets or sets the palette. - - The palette. - - - - Gets or sets a value indicating whether to render the colors as an image. - - true if the rendering should use an image; otherwise, false. - - - - Determines whether the axis is used for X/Y values. - - true if it is an XY axis; otherwise, false . - - - - Gets the color. - - The color map index (less than NumberOfEntries). - The color. - - - - Gets the colors. - - The colors. - - - - Gets the palette index of the specified value. - - The value. - The palette index. - If the value is less than minimum, 0 is returned. If the value is greater than maximum, Palette.Colors.Count+1 is returned. - - - - Renders the axis on the specified render context. - - The render context. - The render pass. - - - - Gets the high value of the specified palette index. - - Index of the palette. - The value. - - - - Gets the low value of the specified palette index. - - Index of the palette. - The value. - - - - Generates the image used to render the color axis. - - Reverse the colors if set to true. - An used to render the color axis. - - - - Represents an axis with logarithmic scale. - - - - - - Initializes a new instance of the class. - - - - - Gets or sets the logarithmic base (normally 10). - - The logarithmic base. - - - - - Gets or sets a value indicating whether the ActualMaximum and ActualMinimum values should be padded to the nearest power of the Base. - - - - - Gets or sets the logarithmic actual maximum value of the axis. - - - - - Gets or sets the logarithmic actual minimum value of the axis. - - - - - Gets or sets the logarithmic clip maximum value of the axis. - - - - - Gets or sets the logarithmic clip minimum value of the axis. - - - - - Gets the coordinates used to draw ticks and tick labels (numbers or category names). - - The major label values. - The major tick values. - The minor tick values. - - - - Determines whether the axis is used for X/Y values. - - true if it is an XY axis; otherwise, false . - - - - Determines whether the axis is logarithmic. - - true if it is a logarithmic axis; otherwise, false . - - - - Pans the specified axis. - - The previous point (screen coordinates). - The current point (screen coordinates). - - - - Inverse transforms the specified screen coordinate. This method can only be used with non-polar coordinate systems. - - The screen coordinate. - The value. - - - - Transforms the specified coordinate to screen coordinates. - - The value. - The transformed value (screen coordinate). - - - - Zooms the axis at the specified coordinate. - - The zoom factor. - The coordinate to zoom at. - - - - Raises all elements of a List to the power of this.Base. - - The input values. - If true, discards all values that are not in the axis range. - A new IList containing the resulting values. - - - - Applies the logarithm with this.Base to all elements of a List. - - The input values. - If true, discards all values that are not in the axis range. - A new IList containing the resulting values. - - - - Calculates ticks of the decades in the axis range with a specified step size. - - The step size. - A new IList containing the decade ticks. - - - - Calculates logarithmic ticks of the decades in the axis range with a specified step size. - - The step size. - A new IList containing the logarithmic decade ticks. - - - - Calculates logarithmic ticks of all decades in the axis range and their subdivisions. - - If true (default), the lowest and highest decade are clipped to the axis range. - A new IList containing the logarithmic decade ticks. - - - - Calculates ticks of all decades in the axis range and their subdivisions. - - If true (default), the lowest and highest decade are clipped to the axis range. - A new IList containing the decade ticks. - - - - Chooses from a list of candidates so that the resulting List matches the as far as possible. - - The candidates. - The desired logarithmic step size. - A new IList containing the chosen candidates. - - - - Chooses from a list of candidates so that the resulting List matches the as far as possible. - - The candidates. - The desired logarithmic step size. - A new IList containing the chosen logarithmic candidates. - - - - Calculates minor tick candidates for a given set of major candidates. - - The major candidates. - The desired major step size. - A new IList containing the minor candidates. - - - - Subdivides a logarithmic range into multiple, evenly-spaced (in linear scale!) ticks. The number of ticks and the tick intervals are adapted so - that the resulting steps are "nice" numbers. - - The IList the computed steps will be added to. - The minimum number of steps. - The start of the range. - The end of the range. - - - - Updates the and values. - - - If the user has zoomed/panned the axis, the internal ViewMaximum/ViewMinimum - values will be used. If Maximum or Minimum have been set, these values will be used. Otherwise the maximum and minimum values - of the series will be used, including the 'padding'. - - - - - - - - Applies a transformation after the inverse transform of the value. This is used in logarithmic axis. - - The value to transform. - The transformed value. - - - - Applies a transformation before the transform the value. This is used in logarithmic axis. - - The value to transform. - The transformed value. - - - - Coerces the actual maximum and minimum values. - - - - - Represents a magnitude axis for polar plots. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the midpoint (screen coordinates) of the plot area. This is used by polar coordinate systems. - - - - - Inverse transform the specified screen point. - - The x coordinate. - The y coordinate. - The y-axis. - The data point. - - - - Determines whether the axis is used for X/Y values. - - true if it is an XY axis; otherwise, false . - - - - Renders the axis on the specified render context. - - The render context. - The rendering pass. - - - - Transforms the specified point to screen coordinates. - - The x value (for the current axis). - The y value. - The y axis. - The transformed point. - - - - Updates the scale and offset properties of the transform from the specified boundary rectangle. - - The bounds. - - - - Represents a magnitude axis that covers the whole plot area. - - - - - Portion to shift the center in horizontal direction relative to the plot area size (from -0.5 to +0.5 meaning +-50% of the width) - - - - - Portion to shift the center in vertical direction relative to the plot area size (from -0.5 to +0.5 meaning +-50% of the height) - - - - - Initializes a new instance of the class. - - - - - Renders the axis on the specified render context. - - The render context. - The rendering pass. - - - - - - - Updates the scale and offset properties of the transform from the specified boundary rectangle. - - The bounds. - - - - Pans the specified axis. - - The previous point (screen coordinates). - The current point (screen coordinates). - - - - Zooms the axis at the specified coordinate. - - The zoom factor. - The coordinate to zoom at. - - - - Represents a color axis that contains colors for specified ranges. - - - - - The ranges - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color used to represent NaN values. - - A that defines the color. The default value is OxyColors.Gray. - - - - Gets or sets the color of values above the maximum value. - - The color of the high values. - - - - Gets or sets the color of values below the minimum value. - - The color of the low values. - - - - Adds a range. - - The lower bound. - The upper bound. - The color. - - - - Clears the ranges. - - - - - Gets the palette index of the specified value. - - The value. - The palette index. - If the value is less than minimum, 0 is returned. If the value is greater than maximum, Palette.Colors.Count+1 is returned. - - - - Gets the color. - - The color map index. - The color. - - - - Renders the axis on the specified render context. - - The render context. - The render pass. - - - - Defines a range. - - - - - Gets or sets the color. - - The color. - - - - Gets or sets the lower bound. - - The lower bound. - - - - Gets or sets the upper bound. - - The upper bound. - - - - Provides functionality to render using the full plot area. - - - - - Initializes a new instance of the class. - - The render context. - The plot. - - - - Renders the specified axis. - - The axis. - The render pass. - Magnitude axis not defined. - - - - Transforms the specified point to screen coordinates. - - - - - - - - - - - Provides functionality to render . - - - - - Initializes a new instance of the class. - - The render context. - The plot. - - - - Renders the specified axis. - - The axis. - The render pass. - Magnitude axis not defined. - - - - Provides an abstract base class for axis renderers. - - - - - The plot. - - - - - The render context. - - - - - The major label values - - - - - The major tick values - - - - - The minor tick values - - - - - Initializes a new instance of the class. - - The render context. - The plot. - - - - Gets the plot. - - The plot. - - - - Gets the render context. - - The render context. - - - - Gets or sets the axis lines pen. - - - - - Gets or sets the extra grid lines pen. - - - - - Gets or sets the major label values. - - - - - Gets or sets the major grid lines pen. - - - - - Gets or sets the major tick pen. - - - - - Gets or sets the major tick values. - - - - - Gets or sets the minor grid lines pen. - - - - - Gets or sets the minor tick pen. - - - - - Gets or sets the minor tick values. - - - - - Gets or sets the zero grid line pen. - - - - - Renders the specified axis. - - The axis. - The pass. - - - - Creates the pens. - - The axis. - - - - Gets the tick positions. - - The axis. - The tick style. - The tick size. - The position. - The x 0. - The x 1. - - - - Determines whether the specified value is within the specified range. - - The value to check. - The minimum value of the range. - The maximum value of the range. - true if the specified value is within the range; otherwise, false. - - - - Provides functionality to render horizontal and vertical axes. - - - - - Initializes a new instance of the class. - - The render context. - The plot. - - - - Renders the specified axis. - - The axis. - The pass. - - - - Interpolates linearly between two values. - - The x0. - The x1. - The interpolation factor. - The interpolated value. - - - - Snaps v to value if it is within the specified distance. - - The target value. - The value to snap. - The distance tolerance. - - - - Gets the axis title position, rotation and alignment. - - The axis. - The title position. - The angle. - The horizontal alignment. - The vertical alignment. - The . - - - - Renders the axis title. - - The axis. - The title position. - - - - Renders the major items. - - The axis. - The axis position. - The title position. - Draw the axis line if set to true. - - - - Renders the minor items. - - The axis. - The axis position. - - - - Adds segments to array. - If is true, then lines will be cropped with lists axes. - - The target segments. - Perpendicular axes list. - True, if current axis is horizontal. - True, if gridlines should be cropped. - Starting point position. - Plot area left position. - Plot area right position. - Plot area top position. - Plot area bottom position. - - - - Gets the alignments given the specified rotation angle. - - The angle of a box to rotate (usually it is label angle). - - The axis angle, the original angle belongs to. The Top axis should have 0, next angles are computed clockwise. - The angle should be in [-180, 180). (T, R, B, L) is (0, 90, -180, -90). - - Horizontal alignment. - Vertical alignment. - - This method is supposed to compute the alignment of the labels that are put near axis. - Because such labels can have different angles, and the axis can have different angles as well, - computing the alignment is not straightforward. - - - - - Provides functionality to render using the full plot area. - - - - - constants to simplify angular calculations - - - - - this constant limit the number of segments to draw a tick arc - - - - - Initializes a new instance of the class. - - The render context. - The plot. - - - - Renders the specified axis. - - The axis. - The pass. - Angle axis should not be null. - - - - Returns the angle (in radian) of the axis line in screen coordinate - - The axis. - The angle axis. - The angle (in radians). - - - - Choose the most appropriate alignment for tick text - - The actual angle. - The horizontal alignment. - The vertical alignment. - - - - Renders a tick by drawing an lot of segments - - The axis. - The angle axis. - The x-value. - The pen. - The start angle. - The end angle. - - - - Renders major tick text - - The axis. - The x-value. - The angle axis. - - - - Provides functionality to render . - - - - - Initializes a new instance of the class. - - The render context. - The plot. - - - - Renders the specified axis. - - The axis. - The pass. - Angle axis should not be null. - - - - Returns the angle (in radian) of the axis line in screen coordinate - - The axis. - The angle axis. - The angle (in radians). - - - - Choose the most appropriate alignment for tick text - - The actual angle. - The horizontal alignment. - The vertical alignment. - - - - Renders a tick, chooses the best implementation - - The axis. - The angle axis. - The x-value. - The pen. - - - - Renders a tick by drawing an ellipse - - The axis. - The angle axis. - The x-value. - The pen. - - - - Renders a tick by drawing an lot of segments - - The axis. - The angle axis. - The x-value. - The pen. - - - - Renders major tick text - - The axis. - The x-value. - The angle axis. - - - - Defines the style of axis ticks. - - - - - The ticks are rendered crossing the axis line. - - - - - The ticks are rendered inside of the plot area. - - - - - The ticks are rendered Outside the plot area. - - - - - The ticks are not rendered. - - - - - Represents an axis presenting values. - - The values should be in seconds. - The StringFormat value can be used to force formatting of the axis values - "h:mm" shows hours and minutes - "m:ss" shows minutes and seconds - - - - Converts a time span to a double. - - The time span. - A double value. - - - - Converts a double to a time span. - - The value. - A time span. - - - - Gets the value from an axis coordinate, converts from double to the correct data type if necessary. e.g. DateTimeAxis returns the DateTime and CategoryAxis returns category strings. - - The coordinate. - The value. - - - - Gets the default format string. - - - The default format string. - - - - - Formats the value to be used on the axis. - - The value to format. - The formatted value. - - - - Calculates the actual interval. - - Size of the available area. - Maximum length of the intervals. - The calculate actual interval. - - - - Specifies whether code should be generated for the property. - - - - - Initializes a new instance of the class. - - The generate code. - - - - Gets or sets a value indicating whether GenerateCode. - - - - - Provides functionality to generate C# code for the specified . - - This is useful for creating examples or unit tests. Press Ctrl+Alt+C in a plot to copy code to the clipboard. - Usage: - - var cg = new CodeGenerator(myPlotModel); - Clipboard.SetText(cg.ToCode()); - - - - - The string builder. - - - - - The variables. - - - - - The indent string. - - - - - The current number of indents. - - - - - Initializes a new instance of the class. - - The model. - - - - Gets or sets the number of indents. - - - - - Formats the code. - - The format. - The values. - The format code. - - - - Formats a constructor. - - The type. - The format of the constructor arguments. - The argument values. - The format constructor. - - - - Returns the c# code for this model. - - C# code. - - - - Adds the specified object to the generated code. - - The object. - The variable name. - - - - Adds the children. - - The name. - Name of the collection. - The children. - - - - Adds the items. - - The name. - The list. - - - - Creates and sets the elements of an array. - - The name. - The array. - - - - Appends the line. - - The format string. - The args. - - - - Determines if the two specified lists are equal. - - The first list. - The second list. - True if all items are equal. - - - - Get the first attribute of the specified type. - - The type. - The property info. - The attribute, or null if no attribute was found. - - - - Gets a new variable name of the specified type. - - The type. - The variable name. - - - - Makes a valid variable name of a string. Invalid characters will simply be removed. - - The title. - A valid variable name. - - - - The set properties. - - The instance. - The variable name. - The default values. - - - - Sets the property. - - The property name. - The value. - - - - Provides extension methods for code generation. - - - - - Converts the value of this instance to c# code. - - The instance. - C# code. - - - - Converts the value of this instance to c# code. - - The value. - C# code. - - - - Converts the value of this instance to c# code. - - The instance. - C# code. - - - - Converts the value of this instance to c# code. - - The instance. - C# code. - - - - Converts the value of this instance to c# code. - - The instance. - C# code. - - - - Converts the value of this instance to c# code. - - The instance. - C# code. - - - - Provides functionality to generate C# code of an object. - - - - - Returns C# code that generates this instance. - - The C# code. - - - - Represents a point in the data space. - - s are transformed to s. - - - - The undefined. - - - - - The x-coordinate. - - - - - The y-coordinate. - - - - - Initializes a new instance of the struct. - - The x. - The y. - - - - Gets the X-coordinate of the point. - - The X-coordinate. - - - - Gets the Y-coordinate of the point. - - The Y-coordinate. - - - - Returns C# code that generates this instance. - - The to code. - - - - Determines whether this instance and another specified object have the same value. - - The point to compare to this instance. - true if the value of the parameter is the same as the value of this instance; otherwise, false. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Determines whether this point is defined. - - true if this point is defined; otherwise, false. - - - - Specifies functionality to provide a . - - - - - Gets the that represents the element. - - A . - - - - Defines functionality to export a . - - - - - Exports the specified to a . - - The model to export. - The target stream. - - - - Defines the marker type. - - - - - Do not render markers. - - - - - Render markers as circles. - - - - - Render markers as squares. - - - - - Render markers as diamonds. - - - - - Render markers as triangles. - - - - - Render markers as crosses (note: this marker type requires the stroke color to be set). - - This marker type requires the stroke color to be set. - - - - Renders markers as plus signs (note: this marker type requires the stroke color to be set). - - This marker type requires the stroke color to be set. - - - - Renders markers as stars (note: this marker type requires the stroke color to be set). - - This marker type requires the stroke color to be set. - - - - Render markers by a custom shape (defined by outline). - - - - - Represents absolute or relative lengths in data or screen space. - - - - - The unit type - - - - - The value - - - - - Initializes a new instance of the struct. - - The value. - The unit. - - - - Gets the value. - - The value. - - - - Gets the type of the unit. - - The type of the unit. - - - - Determines whether this instance and another specified object have the same value. - - The length to compare to this instance. - true if the value of the parameter is the same as the value of this instance; otherwise, false. - - - - Defines the kind of value that a object is holding. - - - - - The value is in data space (transformed by x/y axis) - - - - - The value is in screen units - - - - - The value is relative to the plot viewport (0-1) - - - - - The value is relative to the plot area (0-1) - - - - - Provides functionality to handle input events. - - - - - A synchronization object that is used when the actual model in the current view is null. - - - - - Initializes a new instance of the class. - - - - - Gets the input bindings. - - This collection is used to specify the customized input gestures (both key, mouse and touch). - - - - Gets the manipulators that are created by mouse down events. These manipulators are removed when the mouse button is released. - - - - - Gets the manipulators that are created by mouse enter events. These manipulators are removed when the mouse leaves the control. - - - - - Gets the manipulators that are created by touch events. These manipulators are removed when the touch gesture is completed. - - - - - Handles the specified gesture. - - The plot view. - The gesture. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse down events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse enter events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse leave events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse move events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse up events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse wheel events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles touch started events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles touch delta events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles touch completed events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles key down events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Adds the specified mouse manipulator and invokes the method with the specified mouse down event arguments. - - The plot view. - The manipulator to add. - The instance containing the event data. - - - - Adds the specified mouse hover manipulator and invokes the method with the specified mouse event arguments. - - The plot view. - The manipulator. - The instance containing the event data. - - - - Adds the specified mouse hover manipulator and invokes the method with the specified mouse event arguments. - - The plot view. - The manipulator. - The instance containing the event data. - - - - Binds the specified command to the specified mouse gesture. Removes old bindings to the gesture. - - The gesture. - The command. If null, the binding will be removed. - - - - Binds the specified command to the specified mouse enter gesture. Removes old bindings to the gesture. - - The gesture. - The command. If null, the binding will be removed. - - - - Binds the specified command to the specified mouse wheel gesture. Removes old bindings to the gesture. - - The gesture. - The command. If null, the binding will be removed. - - - - Binds the specified command to the specified touch gesture. Removes old bindings to the gesture. - - The gesture. - The command. If null, the binding will be removed. - - - - Binds the specified command to the specified key gesture. Removes old bindings to the gesture. - - The gesture. - The command. If null, the binding will be removed. - - - - Unbinds the specified gesture. - - The gesture to unbind. - - - - Unbinds the specified command from all gestures. - - The command to unbind. - - - - Unbinds all commands. - - - - - Binds the specified command to the specified gesture. Removes old bindings to the gesture. - - The gesture. - The command. If null, the binding will be removed. - This method was created to avoid calling a virtual method in the constructor. - - - - Gets the command for the specified . - - The input gesture. - A command. - - - - Handles a command triggered by an input gesture. - - The command. - The plot view. - The instance containing the event data. - true if the command was handled. - - - - Gets the synchronization object for the specified view. - - The view. - An object that can be used to synchronize access to the actual model of the view. - This object is used to ensure that events are not handled when the model is being updated. - - - - Provides extension methods for the . - - - - - Binds the specified key to the specified command. - - The plot controller. - The key. - A plot controller command that takes key event arguments. - - - - Binds the specified modifier+key to the specified command. - - The plot controller. - The key. - The key modifiers. - A plot controller command that takes key event arguments. - - - - Binds the specified mouse button to the specified command. - - The plot controller. - The mouse button. - A plot controller command that takes mouse event arguments. - - - - Binds the specified modifier+mouse button gesture to the specified command. - - The plot controller. - The mouse button. - The modifiers. - A plot controller command that takes mouse event arguments. - - - - Binds the specified modifiers+mouse button+click count gesture to the specified command. - - The plot controller. - The mouse button. - The modifiers. - The click count. - A plot controller command that takes mouse event arguments. - - - - Binds the touch down event to the specified command. - - The plot controller. - A plot controller command that takes touch event arguments. - - - - Binds the mouse enter event to the specified command. - - The plot controller. - A plot controller command that takes mouse event arguments. - - - - Binds the mouse wheel event to the specified command. - - The plot controller. - A plot controller command that takes mouse wheel event arguments. - - - - Binds the modifier+mouse wheel event to the specified command. - - The plot controller. - The modifier key(s). - A plot controller command that takes mouse wheel event arguments. - - - - Unbinds the specified mouse down gesture. - - The controller. - The mouse button. - The modifier keys. - The click count. - - - - Unbinds the specified key down gesture. - - The controller. - The key. - The modifier keys. - - - - Unbinds the mouse enter gesture. - - The controller. - - - - Unbinds the touch down gesture. - - The controller. - - - - Unbinds the mouse wheel gesture. - - The controller. - - - - Defines the cursor type. - - - - - The default cursor - - - - - The pan cursor - - - - - The zoom rectangle cursor - - - - - The horizontal zoom cursor - - - - - The vertical zoom cursor - - - - - Provides a implemented by a delegate. - - The type of the event arguments. - - - - The handler - - - - - Initializes a new instance of the class. - - The handler. - - - - Executes the command on the specified plot. - - The plot view. - The plot controller. - The instance containing the event data. - - - - Executes the command on the specified plot. - - The plot view. - The plot controller. - The instance containing the event data. - - - - Provides an abstract base class for graphics elements. - - - Provides an abstract base class for graphics elements. - - - Provides an abstract base class for graphics elements. - - - - - Gets the parent model of the element. - - - The that is the parent of the element. - - - - - Tests if the plot element is hit by the specified point. - - The hit test arguments. - - A hit test result. - - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Occurs when a key is pressed down when the plot view is in focus. - - - - - Occurs when a mouse button is pressed down on the model. - - - - - Occurs when the mouse is moved on the plot element (only occurs after MouseDown). - - - - - Occurs when the mouse button is released on the plot element. - - - - - Occurs when a touch gesture starts. - - - - - Occurs when a touch gesture is changed. - - - - - Occurs when the touch gesture is completed. - - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - The selection - - - - - Occurs when the selected items is changed. - - - - - Gets or sets a value indicating whether this element can be selected. The default is true. - - - - - Gets or sets the selection mode of items in this element. The default is SelectionMode.All. - - The selection mode. - This is only used by the select/unselect functionality, not by the rendering. - - - - Gets the actual selection color. - - The actual selection color. - - - - Determines whether any part of this element is selected. - - true if this element is selected; otherwise, false. - - - - Gets the indices of the selected items in this element. - - Enumerator of item indices. - - - - Clears the selection. - - - - - Unselects all items in this element. - - - - - Determines whether the specified item is selected. - - The index of the item. - true if the item is selected; otherwise, false. - - - - Selects all items in this element. - - - - - Selects the specified item. - - The index. - - - - Unselects the specified item. - - The index. - - - - Gets the selection color if the item is selected, or the specified color if it is not. - - The unselected color of the element. - The index of the item to check (use -1 for all items). - A color. - - - - Gets the selection fill color it the element is selected, or the specified fill color if it is not. - - The unselected fill color of the element. - The index of the item to check (use -1 for all items). - A fill color. - - - - Ensures that the selection field is not null. - - - - - Raises the event. - - The instance containing the event data. - - - - The element collection changed event args. - - The type. - - - - Initializes a new instance of the class. - - The added items. - The removed items. - - - - Gets the added items. - - The added items. - - - - Gets the removed items. - - The removed items. - - - - Represents a collection of objects. - - The type of the elements. - - - - The parent . - - - - - The internal list. - - - - - Initializes a new instance of the class. - - The parent . - - - - Raised when the collection changes. - - - - - Gets the number of elements contained in the collection. - - The number of elements contained in the collection. - - - - Gets a value indicating whether the collection is read-only. - - true if the collection is read-only; otherwise, false. - - - - Gets or sets the element at the specified index. - - The index. - The element. - - - - Returns an enumerator that iterates through the collection. - - A that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Adds an item to the collection. - - The object to add to the collection. - The element cannot be added, it already belongs to a PlotModel. - - - - Removes all items from the collection. - - - - - Determines whether the contains a specific value. - - The object to locate in the . - true if is found in the ; otherwise, false. - - - - Copies to. - - The array. - Index of the array. - - - - Removes the first occurrence of a specific object from the . - - The object to remove from the . - true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . - - - - Determines the index of a specific item in the collection. - - The object to locate in the collection. - The index of if found in the list; otherwise, -1. - - - - Inserts an item to the collection at the specified index. - - The zero-based index at which should be inserted. - The object to insert into the collection. - The element cannot be inserted, it already belongs to a PlotModel. - - - - Removes the collection item at the specified index. - - The zero-based index of the item to remove. - - - - Raises the collection changed event. - - The added items. - The removed items. - - - - Represents arguments for the hit test. - - - - - Initializes a new instance of the class. - - The point. - The tolerance. - - - - Gets the point to hit test. - - - - - Gets the hit test tolerance. - - - - - Represents a hit test result. - - - - - Initializes a new instance of the class. - - The element that was hit. - The nearest hit point. - The item. - The index. - - - - Gets the index of the hit (if available). - - The index. - If the hit was in the middle between point 1 and 2, index = 1.5. - - - - Gets the item of the hit (if available). - - The item. - - - - Gets the element that was hit. - - - The element. - - - - - Gets the position of the nearest hit point. - - The nearest hit point. - - - - Specifies functionality to interact with a graphics view. - - - - - Handles mouse down events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse move events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse up events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse enter events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse leave events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles mouse wheel events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles touch started events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles touch delta events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles touch completed events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles key down events. - - The plot view. - The instance containing the event data. - true if the event was handled. - - - - Handles the specified gesture. - - The plot view. - The gesture. - The instance containing the event data. - true if the event was handled. - - - - Adds the specified mouse manipulator and invokes the method with the specified mouse event arguments. - - The plot view. - The manipulator to add. - The instance containing the event data. - - - - Adds the specified mouse hover manipulator and invokes the method with the specified mouse event arguments. - - The view. - The manipulator. - The instance containing the event data. - - - - Adds the specified touch manipulator and invokes the method with the specified mouse event arguments. - - The view. - The manipulator. - The instance containing the event data. - - - - Binds the specified command to the specified mouse down gesture. Removes old bindings to the gesture. - - The mouse down gesture. - The command. If null, the binding will be removed. - - - - Binds the specified command to the specified mouse enter gesture. Removes old bindings to the gesture. - - The mouse enter gesture. - The command. If null, the binding will be removed. - - - - Binds the specified command to the specified mouse wheel gesture. Removes old bindings to the gesture. - - The mouse wheel gesture. - The command. If null, the binding will be removed. - - - - Binds the specified command to the specified touch gesture. Removes old bindings to the gesture. - - The touch gesture. - The command. If null, the binding will be removed. - - - - Binds the specified command to the specified key gesture. Removes old bindings to the gesture. - - The key gesture. - The command. If null, the binding will be removed. - - - - Unbinds the specified gesture. - - The gesture to unbind. - - - - Unbinds the specified command from all gestures. - - The command to unbind. - - - - Unbinds all commands. - - - - - Represents an binding by an input gesture and a command binding. - - - - - Initializes a new instance of the class by a gesture. - - The gesture. - The command. - - - - Initializes a new instance of the class by a key gesture. - - The key. - The modifiers. - The command. - - - - Initializes a new instance of the class by a mouse gesture. - - The mouse button. - The modifiers. - The command. - - - - Gets the gesture. - - - - - Gets the command. - - - - - Specifies common functionality for the views. - - - - - Gets the actual model in the view. - - - The actual . - - - - - Gets the actual controller. - - - The actual . - - - - - Gets the coordinates of the client area of the view. - - - The client area rectangle. - - - - - Sets the cursor type. - - The cursor type. - - - - Hides the zoom rectangle. - - - - - Shows the zoom rectangle. - - The rectangle. - - - - Specifies functionality to execute a command on a view. - - - - - Executes the command on the specified plot. - - The view. - The controller. - The instance containing the event data. - - - - Specifies functionality to execute a command on a view. - - The type of the event arguments. - - - - Executes the command on the specified plot. - - The view. - The controller. - The instance containing the event data. - - - - Provides an abstract base class for controller manipulators. - - The type of the event arguments. - - - - Initializes a new instance of the class. - - The view. - - - - Gets the plot view where the event was raised. - - The plot view. - - - - Occurs when a manipulation is complete. - - The instance containing the event data. - - - - Occurs when the input device changes position during a manipulation. - - The instance containing the event data. - - - - Occurs when an input device begins a manipulation on the plot. - - The instance containing the event data. - - - - Provides an abstract base class for graphics models. - - - Provides an abstract base class for graphics models. - - - - - The default selection color. - - - - - The synchronization root object. - - - - - Initializes a new instance of the class. - - - - - Gets an object that can be used to synchronize access to the . - - A synchronization object. - This property can be used when modifying the on a separate thread (not the thread updating or rendering the model). - - - - Gets or sets the color of the selection. - - The color of the selection. - - - - Returns the elements that are hit at the specified position. - - The hit test arguments. - - A sequence of hit results. - - - - - Gets all elements of the model, top-level elements first. - - An enumerator of the elements. - - - - The mouse hit tolerance. - - - - - The element that receives mouse move events. - - - - - The element that receives touch delta events. - - - - - Occurs when a key is pressed down when the plot view is focused. - - - - - Occurs when a mouse button is pressed down on the model. - - - - - Occurs when the mouse is moved on the plot element (only occurs after MouseDown). - - - - - Occurs when the mouse button is released on the plot element. - - - - - Occurs when the mouse cursor enters the plot area. - - - - - Occurs when the mouse cursor leaves the plot area. - - - - - Occurs when a touch gesture is started. - - - - - Occurs when a touch gesture is changed. - - - - - Occurs when a touch gesture is completed. - - - - - Handles the mouse down event. - - The sender. - The instance containing the event data. - - - - Handles the mouse move event. - - The sender. - The instance containing the event data. - - - - Handles the mouse up event. - - The sender. - The instance containing the event data. - - - - Handles the mouse enter event. - - The sender. - The instance containing the event data. - - - - Handles the mouse leave event. - - The sender. - The instance containing the event data. - - - - Handles the touch started event. - - The sender. - A instance containing the event data. - - - - Handles the touch delta event. - - The sender. - A instance containing the event data. - - - - Handles the touch completed event. - - The sender. - A instance containing the event data. - - - - Handles key down events. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Raises the event. - - The sender. - The instance containing the event data. - - - - Represents a selection of items (by index) and features (by enumeration type). - - - - - Static instance representing everything (all items and all features) selected. - - - - - The selection (cannot use HashSet{T} in PCL) - - - - - Gets the everything selected. - - The everything. - - - - Determines whether everything is selected. - - true if everything is selected; otherwise, false. - - - - Gets the indices of the selected items in this selection. - - Enumerator of indices. - - - - Gets the selected items by the specified feature. - - The feature. - Enumerator of indices. - - - - Clears the selected items. - - - - - Determines whether the specified item and feature is selected. - - The index of the item. - The feature. - true if the item is selected; otherwise, false. - - - - Selects the specified item/feature. - - The index. - The feature. - - - - Unselects the specified item. - - The index of the item. - The feature. - - - - Represents an item in a . - - - - - The index - - - - - The feature - - - - - Initializes a new instance of the struct. - - The index. - The feature. - - - - Gets the index. - - The index. - - - - Gets the feature. - - The feature. - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Returns a hash code for this instance. - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Defines the mode of selection used by . - - - - - All the elements will be selected - - - - - A single element will be selected - - - - - Multiple elements can be selected - - - - - Implements support for decoding bmp images. - - - - - Gets information about the image in the specified byte array. - - The image data. - - An structure. - - - - - Decodes an image from the specified byte array. - - The image data. - - The 32-bit pixel data. - - - - - Implements support for encoding bmp images. - - - - - The options - - - - - Initializes a new instance of the class. - - The options. - - - - Encodes the specified image data to png. - - The pixel data (bottom line first). - The png image data. - - - - Encodes the specified 8-bit indexed pixels. - - The pixels. - The palette. - The image data. - - - - Writes the bitmap info header. - - The writer. - The width. - The height. - The number of bits per pixel. - The length of the pixel data. - The horizontal resolution (dpi). - The vertical resolution (dpi). - The number of colors. - - - - Writes the bitmap V4 header. - - The writer. - The width. - The height. - The number of bits per pixel. - The length. - The resolution. - The number of colors. - - - - Represents options for the . - - - - - Provides utilities for s. - - - - - Copies a range of the specified . - - The type of the array items. - The source array. - The start index. - The end index. - An containing the items from index to index . - - - - Copies the first items of the specified . - - The type of the array items. - The source array. - The number of items to copy. - An containing the items from index 0 to index . - - - - Fills the specified array with values in the specified range. - - The type of the array items. - The source array. - The start index. - The end index. - The value to fill. - - - - Implements a binary reader that can read bits. - - - - - Reads a byte from the stream. - - The byte. - - - - Reads a bit from the stream. - - Returns 0 or 1 if a bit is available, or throws an EOFException if the end of stream is reached. - - - - Closes this stream and the underlying InputStream. - - - - - Returns the current bit position, which is between 0 and 7 inclusive. The number of bits remaining in the current byte is 8 minus this number. - - The bit position. - - - - Discards the remainder of the current byte and reads the next byte from the stream. - - The byte. - - - - Reads the specified number of bits. - - The number of bits. - The bits. - Reading past EOF. - - - - The byte bit reader. - - - - - The input. - - - - - The bit position. - - Either in the range 0x00 to 0xFF, or -1 if the end of stream is reached - - - - The disposed flag. - - - - - The is end of stream. - - Always between 1 and 8, inclusive - - - - The next bits. - - Underlying byte stream to read from - - - - Initializes a new instance of the class. - - The arguments. - Argument is null - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Reads a bit from the stream. Returns 0 or 1 if a bit is available, or -1 if the end of stream is reached. The end of stream always occurs on a byte boundary. - - The . - - - - Reads a bit from the stream. Returns 0 or 1 if a bit is available, or throws an EOFException if the end of stream is reached. - - The . - - - - Gets the bit position. - - The . - - - - Discards the remainder of the current byte and reads the next byte from the stream. - - The . - - - - Closes this stream and the underlying InputStream. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - A canonical Huffman code. Immutable. Code length 0 means no code. - -

    - The code is a c# port of the DEFLATE project by Nayuki Minase at github. - Original source code: CircularDictionary.java. -

    -

    - A canonical Huffman code only describes the code length of each symbol. The codes can be reconstructed from this information. In this implementation, symbols with lower code lengths, breaking ties by lower symbols, are assigned lexicographically lower codes. - Example: - Code lengths (canonical code): - Symbol A: 1 - Symbol B: 3 - Symbol C: 0 (no code) - Symbol D: 2 - Symbol E: 3 - Huffman codes (generated from canonical code): - Symbol A: 0 - Symbol B: 110 - Symbol C: None - Symbol D: 10 - Symbol E: 111 -

    -
    - - - The code lengths - - - - - Initializes a new instance of the class. - - The code lengths. - The constructor does not check that the array of code lengths results in a complete Huffman tree, being neither underfilled nor overfilled. - - - - Initializes a new instance of the class based on the given code tree. - - The tree. - The symbol limit. - - - - Gets the symbol limit. - - The limit. - - - - Gets the length of the code. - - The symbol. - The length. - Symbol out of range - - - - Converts the canonical code to a code tree. - - The code tree. - This canonical code does not represent a Huffman code tree - or - This canonical code does not represent a Huffman code tree - - - - Builds the code lengths. - - The node. - The depth. - Symbol has more than one code - or - Symbol exceeds symbol limit - or - Illegal node type - - - - Provides a circular dictionary. - - The code is a c# port of the DEFLATE project by Nayuki Minase at github. - Original source code: CircularDictionary.java. - - - - The data - - - - - The mask - - - - - The index - - - - - Initializes a new instance of the class. - - The size of the dictionary. - - - - Appends the specified byte. - - The byte. - - - - Copies the specified bytes to the output writer. - - The distance? - The length. - The writer. - - - - The code tree. - - The code is a c# port of Nayuki Minase's DEFLATE project at GitHub. - Original source code: CodeTree.java. - - - - Stores the code for each symbol, or null if the symbol has no code. - For example, if symbol 5 has code 10011, then codes.get(5) is the list [1, 0, 0, 1, 1]. - - - - - Initializes a new instance of the class. Every symbol in the tree 'root' must be strictly less than 'symbolLimit'. - - The root. - The symbol limit. - - - - Gets the root. - - - - - Gets the code for the specified symbol. - - The symbol. - A of codes. - - - - Returns a string showing all the codes in this tree. The format is subject to change. Useful for debugging. - - The . - - - - Appends the code of the specified node to the specified . - - The prefix. - The node. - The string builder. - Illegal node type - - - - Builds the code list. - - The node. - The prefix. - - - - Implements DEFLATE decompression. - - The code is a c# port of the DEFLATE project by Nayuki Minase at github. - Original source code: Decompressor.java. - - - - The fixed literal length code. - - - - - The fixed distance code. - - - - - The dictionary. - - - - - The input. - - - - - The output. - - - - - The output stream. - - - - - The disposed flag. - - - - - Initializes static members of the class. - - - - - Initializes a new instance of the class. - - The reader. - - - - Decompresses the data from the specified . - - The input. - An array of . - - - - Decompresses the data from the specified . - - The input. - An array of . - - - - Decompresses the specified data. - - The input. - An array of . - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - For handling dynamic Huffman codes. - - A sequence of items. - - - - Decompress an uncompressed block. - - - - - Decompresses a Huffman block. - - The litLen code. - The distance code. - - - - Decodes the specified symbol. - - The code. - The . - - - - Decodes the run length. - - The symbol. - The . - - - - Decodes distance. - - The symbol. - The . - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Reads the specified number of bits. - - The number of bits to read. - The . - - - - Represents an internal node. - - - - - Initializes a new instance of the class. - - The left child. - The right child. - - - - Gets the left child. - - - - - Gets the right child. - - - - - Represents a leaf. - - - - - Initializes a new instance of the class. - - The symbol. - Illegal symbol value;symbol - - - - Gets the symbol. - - The symbol. - - - - Defines the node abstract class. - - Package-private (internal) to prevent accidental sub-classing outside of this package - - - - Specifies functionality to decode an image. - - - - - Gets information about the image in the specified byte array. - - The image data. - An structure. - - - - Decodes an image from the specified byte array. - - The image data. - The 32-bit pixel data. The indexing is [x,y] where [0,0] is top-left. - - - - Specifies functionality to encode an image. - - - - - Encodes the specified pixels. - - The pixel data. The indexing is [x,y] where [0,0] is top-left. - The image data. - - - - Encodes the specified 8-bit indexed pixels. - - The indexed pixel data. The indexing is [x,y] where [0,0] is top-left. - The palette. - The image data. - - - - Provides an abstract base class for image encoder options. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the horizontal resolution (in dots per inch). - - The resolution. The default value is 96 dpi. - - - - Gets or sets the vertical resolution (in dots per inch). - - The resolution. The default value is 96 dpi. - - - - Defines the image format. - - - - - The image is a PNG image. - - - - - The image is a bitmap image. - - - - - The image is a JPEG image. - - - - - The image format is unknown. - - - - - Implements support for decoding jpeg images. - - - - - Defines the EXIF tags. - - - - - Gets information about the image in the specified byte array. - - The image data. - An structure. - Invalid SOI - or - Invalid APP0 marker - or - Invalid marker - or - Invalid Exif identifier - or - Invalid TIFF identifier - - - - Decodes an image from the specified stream. - - The data to decode. - The 32-bit pixel data. - - - - Represents an image. - - - - - The image data. - - - - - The pixels - - - - - Initializes a new instance of the class from the specified stream. - - A stream that provides the image data. - - - - Initializes a new instance of the class from a byte array. - - The image bytes. - - - - Gets the image format. - - The format. - - - - Gets the width of the image. - - The width. - - - - Gets the height of the image. - - The height. - - - - Gets the number of bits per pixel. - - The bits per pixel. - - - - Gets the horizontal resolution of the image. - - The resolution in dots per inch (dpi). - - - - Gets the vertical resolution of the image. - - The resolution in dots per inch (dpi). - - - - Creates an image from 8-bit indexed pixels. - - The pixels indexed as [x,y]. [0,0] is top-left. - The palette. - The image format. - The encoder options. - An - - - - Creates an image from 32-bit true-color pixels. - - The pixels indexed as [x,y]. [0,0] is top-left. - The image format. - The encoder options. - An - - - - Gets the image data. - - The image data as a byte array. - - - - Gets the pixels of the image. - - The pixels in an array [width,height]. [0,0] is top-left. - - - - Gets the for the specified format. - - The image format. - The . - - - - Gets the for the specified format. - - The image format. - The image encoder options. - The . - - - - Gets the image format. - - The image bytes. - The - - - - Gets the byte array from the specified stream. - - The stream. - A byte array. - - - - Updates the image information. - - - - - Provides information about an . - - - - - Gets or sets the width in pixels. - - The width. - - - - Gets or sets the height in pixels. - - The height. - - - - Gets or sets the bits per pixel. - - The bits per pixel. - - - - Gets or sets the horizontal resolution of the image. - - The resolution in dots per inch (dpi). - - - - Gets or sets the vertical resolution of the image. - - The resolution in dots per inch (dpi). - - - - Implements support for decoding png images. - - - - - Gets information about the image in the specified byte array. - - The image data. - An structure. - Wrong length of pHYs chunk. - - - - Decodes an image from the specified byte array. - - The image data. - The 32-bit pixel data, indexed as [x,y]. - - - - Deflates the specified bytes. - - The bytes. - The deflated bytes. - - - - Defines the color type - - - - - Gray scale - - - - - True color - - - - - Indexed color - - - - - Gray scale with alpha - - - - - True color with alpha - - - - - Defines the compression method. - - - - - DEFLATE compression - - - - - Defines the filter method. - - - - - No filter. - - - - - Sub filter - - - - - Up filter - - - - - Average filter - - - - - Paeth filter - - - - - Defines interlace methods (chapter 8.2) - - - - - The null method, pixels are extracted sequentially from left to right, and scan lines sequentially from top to bottom. - - - - - Adam7, defines seven distinct passes over the image. Each pass transmits a subset of the pixels in the reference image. - The pass in which each pixel is transmitted (numbered from 1 to 7) is defined by replicating a 8-by-8 pattern over the - entire image, starting at the upper left corner. - - - - - Implements support for encoding png images. - - - - - The CRC table - - - - - The options - - - - - Initializes static members of the class. - - - - - Initializes a new instance of the class. - - The options. - - - - Encodes the specified image data to png. - - The pixel data indexed as [x,y] (bottom line first). - The png image data. - - - - Encodes the specified 8-bit indexed pixels. - - The pixels. - The palette. - The image data. - - - - Calculates the Adler-32 check sum. - - The data. - The check sum. - - - - Creates the header data. - - The width. - The height. - The header. - - - - Creates the physical dimensions data. - - The horizontal resolution. - The vertical resolution. - The data. - - - - Creates the uncompressed blocks. - - The data. - The output data. - - - - Updates the CRC check sum. - - The input CRC. - The data. - The updated CRC. - - - - Writes the integer value with big endian byte order. - - The writer. - The value. - - - - Writes the unsigned integer value with big endian byte order. - - The writer. - The value. - - - - Writes a png chunk. - - The writer. - The chunk type. - The chunk data. - - - - Provides a binary writer that writes to memory. - - - - - Initializes a new instance of the class. - - - - - Gets the content as a byte array. - - The byte array. - - - - Represents options for the . - - - - - Provides an abstract base class for input device gestures. - - The input gesture can be bound to a command in a . - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Represents a keyboard input gesture. - - The input gesture can be bound to a command in a . - - - - Initializes a new instance of the class. - - The key. - The modifier keys. - - - - Gets or sets the modifier keys. - - - - - Gets or sets the key. - - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Represents a mouse down input gesture. - - The input gesture can be bound to a command in a . - - - - Initializes a new instance of the class. - - The mouse button. - The modifiers. - The click count. - - - - Gets the modifier keys. - - - - - Gets the mouse button. - - - - - Gets the click count. - - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Represents a mouse enter gesture. - - The input gesture can be bound to a command in a . - - - - Initializes a new instance of the class. - - The modifiers. - - - - Gets the modifier keys. - - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Represents a mouse wheel gesture. - - The input gesture can be bound to a command in a . - - - - Initializes a new instance of the class. - - The modifiers. - - - - Gets the modifier keys. - - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Represents a shake input gesture. - - The input gesture can be bound to a command in a . The shake gesture applies primarily to mobile devices. - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Represents a touch input gesture. - - The input gesture can be bound to a command in a . - - - - Indicates whether the current object is equal to another object of the same type. - - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Defines the possible key values on a keyboard. - - - - - The Space key. - - - - - The Enter key. - - - - - The Esc key. - - - - - The Tab key. - - - - - The Backspace key. - - - - - The Insert key. - - - - - The Delete key. - - - - - The Home key. - - - - - The End key. - - - - - The Up arrow key. - - - - - The Down arrow key. - - - - - The Left arrow key. - - - - - The Right arrow key. - - - - - The Page up key. - - - - - The Page down key. - - - - - The A key. - - - - - The B key. - - - - - The C key. - - - - - The D key. - - - - - The E key. - - - - - The F key. - - - - - The G key. - - - - - The H key. - - - - - The I key. - - - - - The J key. - - - - - The K key. - - - - - The L key. - - - - - The M key. - - - - - The N key. - - - - - The O key. - - - - - The P key. - - - - - The Q key. - - - - - The R key. - - - - - The S key. - - - - - The T key. - - - - - The U key. - - - - - The V key. - - - - - The W key. - - - - - The X key. - - - - - The Y key. - - - - - The Z key. - - - - - The 0 key. - - - - - The 1 key. - - - - - The 2 key. - - - - - The 3 key. - - - - - The 4 key. - - - - - The 5 key. - - - - - The 6 key. - - - - - The 7 key. - - - - - The 8 key. - - - - - The 9 key. - - - - - The 0 key on the numeric keypad. - - - - - The 1 key on the numeric keypad. - - - - - The 2 key on the numeric keypad. - - - - - The 3 key on the numeric keypad. - - - - - The 4 key on the numeric keypad. - - - - - The 5 key on the numeric keypad. - - - - - The 6 key on the numeric keypad. - - - - - The 7 key on the numeric keypad. - - - - - The 8 key on the numeric keypad. - - - - - The 9 key on the numeric keypad. - - - - - The add key. - - - - - The subtract key. - - - - - The multiply key. - - - - - The divide key. - - - - - The decimal key. - - - - - The F1 key. - - - - - The F2 key. - - - - - The F3 key. - - - - - The F4 key. - - - - - The F5 key. - - - - - The F6 key. - - - - - The F7 key. - - - - - The F8 key. - - - - - The F9 key. - - - - - The F10 key. - - - - - The F11 key. - - - - - The F12 key. - - - - - Unknown/not supported key. - - - - - Defines the set of modifier keys. - - - - - No modifiers are pressed. - - - - - The Control key. - - - - - The Alt/Menu key. - - - - - The Shift key. - - - - - The Windows key. - - - - - Defines values that specify the buttons on a mouse device. - - - - - No mouse button. - - - - - The left mouse button. - - - - - The middle mouse button. - - - - - The right mouse button. - - - - - The first extended mouse button. - - - - - The second extended mouse button. - - - - - Represents a Legend. - - - - - Initializes a new insance of the Legend class. - - - - - Override for legend hit test. - - Arguments passe to the hit test - The hit test results. - - - - Gets or sets the group name font. - - - - - Gets or sets the group name font size. - - - - - Gets or sets the group name font weight. - - - - - Gets or sets the textcolor of invisible series. - - - - - Checks if a screen point is within the legend boundaries. - - A screen point. - A value indicating whether the point is inside legend boundaries or not. - - - - Makes the LegendOrientation property safe. - - If Legend is positioned left or right, force it to vertical orientation - - - - Renders or measures the legends. - - The render context. - - - - Measures the legend area and gets the legend size. - - The rendering context. - The area available to legend. - - - - Gets the rectangle of the legend box. - - Size of the legend box. - A rectangle. - - - - Renders the legend for the specified series. - - The render context. - The series. - The position and size of the legend. - - - - Measures the legends. - - The render context. - The available size for the legend box. - The size of the legend box. - - - - Renders or measures the legends. - - The render context. - Provides the available size if measuring, otherwise it provides the position and size of the legend. - Specify if the size of the legend box should be measured only (not rendered). - The size of the legend box. - - - - Specifies the placement of the legend box. - - - - - Place the legends inside the plot area. - - - - - Place the legends outside the plot area. - - - - - Specifies the position of the legend box. - - - - - Place the legend box in the top-left corner. - - - - - Place the legend box centered at the top. - - - - - Place the legend box in the top-right corner. - - - - - Place the legend box in the bottom-left corner. - - - - - Place the legend box centered at the bottom. - - - - - Place the legend box in the bottom-right corner. - - - - - Place the legend box in the left-top corner. - - - - - Place the legend box centered at the left. - - - - - Place the legend box in the left-bottom corner. - - - - - Place the legend box in the right-top corner. - - - - - Place the legend box centered at the right. - - - - - Place the legend box in the right-bottom corner. - - - - - Specifies the orientation of the items in the legend box. - - - - - Orient the items horizontally. - - - - - Orient the items vertically. - - - - - Specifies the item order of the legends. - - - - - Render the items in the normal order. - - - - - Render the items in the reverse order. - - - - - Specifies the placement of the legend symbols. - - - - - Render symbols to the left of the labels. - - - - - Render symbols to the right of the labels. - - - - - The abstract Legend class. - - - - - Override for legend hit test. - - Arguments passe to the hit test - The hit test results. - - - - Defines the legend hit test behaviour. - - The hit test arguments. - The hit test result. - - - - Gets or sets a key to identify this legend. The default is null. - - The key is used to identify which series to show in the legends by comparing with the Series.LegendKey property. - - - - Gets or sets a value indicating whether the legend is visible. The titles of the series must be set to use the legend. - - - - - Gets or sets the legend orientation. - - The legend orientation. - Horizontal orientation is reverted to Vertical if Legend is positioned Left or Right of the plot. - - - - Gets or sets the legend padding. - - The legend padding. - - - - Gets or sets the length of the legend symbols (the default value is 16). - - - - - Gets or sets the legend symbol margins (distance between the symbol and the text). - - The legend symbol margin. - - - - Gets or sets the legend symbol placement. - - The legend symbol placement. - - - - Gets or sets the legend title. - - The legend title. - - - - Gets or sets the color of the legend title. - - The color of the legend title. - If this value is null, the TextColor will be used. - - - - Gets or sets the legend title font. - - The legend title font. - - - - Gets or sets the size of the legend title font. - - The size of the legend title font. - - - - Gets or sets the legend title font weight. - - The legend title font weight. - - - - Gets the legend area. - - The legend area. - - - - Gets or sets the size of the legend. - - - - - Gets or sets the background color of the legend. Use null for no background. - - The legend background. - - - - Gets or sets the border color of the legend. - - The legend border. - - - - Gets or sets the thickness of the legend border. Use 0 for no border. - - The legend border thickness. - - - - Gets or sets the spacing between columns of legend items (only for vertical orientation). - - The spacing in device independent units. - - - - Gets or sets the legend font. - - The legend font. - - - - Gets or sets the size of the legend font. - - The size of the legend font. - - - - Gets or sets the color of the legend text. - - The color of the legend text. - If this value is null, the TextColor will be used. - - - - Gets or sets the legend font weight. - - The legend font weight. - - - - Gets or sets the legend item alignment. - - The legend item alignment. - - - - Gets or sets the legend item order. - - The legend item order. - - - - Gets or sets the horizontal spacing between legend items when the orientation is horizontal. - - The horizontal distance between items in device independent units. - - - - Gets or sets the vertical spacing between legend items. - - The spacing in device independent units. - - - - Gets or sets the legend margin. - - The legend margin. - - - - Gets or sets the max width of the legend. - - The max width of the legend. - - - - Gets or sets the max height of the legend. - - The max height of the legend. - - - - Gets or sets the legend placement. - - The legend placement. - - - - Gets or sets the legend position. - - The legend position. - - - - Gets or sets a value indicating whether the legend should use the full extend of the plot when equals LegendPlacement.Outside. - - Whether the legends is allowed to use the full extent of the plot. - - - - Gets or sets a value indicating whether the legend should show invisible series. The default is true. - - Whether the legends should show invisible series. - Invisible series will appear in the listening, but will be grayed out. - - - - Makes the LegendOrientation property safe. - - If Legend is positioned left or right, force it to vertical orientation - - - - Measures the legend area and gets the legend size. - - The rendering context. - The area available to legend. - - - - Gets the rectangle of the legend box. - - Size of the legend box. - The legend area rectangle. - - - - Renders or measures the legends. - - The render context. - - - - Provides extension methods facilitating compatibility with .NET 4.0. - - - - - Returns a corresponding to the specified . - - The type of the list. - The list. - - On .NET4.0, this returns a wrapper around the which implements and . - On .NET4.5 and later, this directly returns the . - - - - - Returns a corresponding to the specified array. - - The type of the array. - The array. - - On .NET4.0, this returns a wrapper around the which implements and . - On .NET4.5 and later, this directly returns the . - - - - - Defines the page size. - - - - - ISO A4 size (595pt x 842pt). - - - - - ISO A3 size (842pt x 1190pt). - - - - - American letter size (612pt x 792pt). - - - - - Defines the page orientation. - - - - - Portrait orientation (where the height is greater than the width). - - - - - Landscape orientation (where the width is greater than the height). - - - - - Defines the line cap type. - - - - - Butt cap. The stroke is squared off at the endpoint of the path. There is no projection beyond the end of the path. - - - - - Round cap. A semicircular arc with a diameter equal to the line width is drawn around the endpoint and filled in. - - - - - Projecting square cap. The stroke continues beyond the endpoint of the path for a distance equal to half the line width and is squared off. - - - - - Defines the color space. - - - - - The colors are defined by intensities of red, green and blue light, the three additive primary colors used in displays. - - - - - Defines the font encoding. - - - - - Windows Code Page 1252, often called the “Windows ANSI” encoding. This is the standard Windows encoding for Latin text in - Western writing systems. PDF has a predefined encoding named WinAnsiEncoding that can be used with both Type 1 and TrueType fonts. - - - - - Defines the font subtype - - - - - Adobe type 1 font. - - - - - TrueType font. - - - - - Provides functionality to export plots to pdf. - - - - - Gets or sets the width (in points, 1/72 inch) of the output document. - - - - - Gets or sets the height (in points, 1/72 inch) of the output document. - - - - - Exports the specified model to a stream. - - The model. - The output stream. - The width (points). - The height (points). - - - - Exports the specified to the specified . - - The model. - The stream. - - - - Implements an producing PDF documents by . - - - - - The current document. - - - - - The image cache. - - - - - Initializes a new instance of the class. - - The width. - The height. - The background. - - - - Saves the output to the specified stream. - - The stream. - - - - Draws an ellipse. - - The rectangle. - The fill color. - The stroke color. - The thickness. - The edge rendering mode. This is not supported and will be ignored. - - - - Draws a polyline. - - The points. - The stroke color. - The stroke thickness. - The edge rendering mode. This is not supported and will be ignored. - The dash array. - The line join type. - - - - Draws a polygon. The polygon can have stroke and/or fill. - - The points. - The fill color. - The stroke color. - The stroke thickness. - The edge rendering mode. This is not supported and will be ignored. - The dash array. - The line join type. - - - - Draws a rectangle. - - The rectangle. - The fill color. - The stroke color. - The stroke thickness. - The edge rendering mode. This is not supported and will be ignored. - - - - Draws the text. - - The position of the text. - The text. - The fill color. - The font family. - Size of the font. - The font weight. - The rotation angle. - The horizontal alignment. - The vertical alignment. - The maximum size of the text. - - - - Measures the text. - - The text. - The font family. - Size of the font. - The font weight. - The text size. - - - - Draws the specified portion of the specified at the specified location and with the specified size. - - The source. - The x-coordinate of the upper-left corner of the portion of the source image to draw. - The y-coordinate of the upper-left corner of the portion of the source image to draw. - Width of the portion of the source image to draw. - Height of the portion of the source image to draw. - The x-coordinate of the upper-left corner of drawn image. - The y-coordinate of the upper-left corner of drawn image. - The width of the drawn image. - The height of the drawn image. - The opacity. - Interpolate if set to true. - - - - - - - - - - Converts the specified to a . - - The value to convert. - The converted value. - - - - Sets the width of the line. - - The thickness (in 1/96 inch units). - - - - Sets the line dash pattern. - - The dash array (in 1/96 inch units). - The dash phase (in 1/96 inch units). - - - - Provides a low-level PDF writer. - - - - - The output writer. - - - - - Initializes a new instance of the class. - - The s. - - - - Specifies the object type. - - - - - The Catalog type. - - - - - The Pages type. - - - - - The Page type. - - - - - The Font type. - - - - - The XObject type. - - - - - The ExtGState type. - - - - - The FontDescriptor type. - - - - - Specifies a document object. - - - - - Gets the object number. - - - - - Gets the position in the stream. - - - - - Writes a formatted string. - - The format string. - The arguments. - - - - Writes a formatted line. - - The format string. - The arguments. - - - - Writes a dictionary. - - The dictionary. - - - - Writes a byte array. - - The byte array. - - - - Writes an empty line. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Writes an object. - - The object to write. - - - - Writes a list. - - The list. - - - - Represents a document that can be output to PDF. - - - - - The objects. - - - - - The stroke alpha cache. - - - - - The fill alpha cache. - - - - - The font cache. - - - - - The image cache. - - - - - The catalog object. - - - - - The pages object. - - - - - The metadata object. - - - - - The resources object. - - - - - The fonts dictionary. - - - - - The x objects dictionary. - - - - - The ext g state dictionary. - - - - - The page reference objects. - - - - - The current page contents - - - - - The current font - - - - - The current font size - - - - - Initializes a new instance of the class. - - - - - Gets the width of the current page. - - The width measured in points (1/72 inch). - - - - Gets the height of the current page. - - The height measured in points (1/72 inch). - - - - Sets the title property. - - - - - Sets the author property. - - - - - Sets the subject property. - - - - - Sets the keywords property. - - - - - Sets the creator property. - - - - - Sets the producer property. - - - - - Sets the current line width. - - The line width in points. - - - - Sets the line cap type. - - The cap type. - - - - Sets the line join type. - - The line join. - - - - Sets the miter limit. - - The limit. - - - - Sets the line dash pattern. - - The dash array specifies the lengths of alternating dashes and gaps; the numbers must be nonnegative and not all zero. - The dash phase specifies the distance into dash pattern at which to start the dash. - Before beginning to stroke a path, the dash array is cycled through, adding up the lengths of - dashes and gaps. When the accumulated length equals the value specified by the dash phase, stroking - of the path begins, and the dash array is used cyclically from that point onward. - Table 4.6 shows examples of line dash patterns. As can be seen from the table, an empty dash array - and zero phase can be used to restore the dash pattern to a solid line. - - - - Resets the line dash pattern. - - - - - Moves to the specified coordinate. - - The x1. - The y1. - Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment. - If the previous path construction operator in the current path was also m, the new m overrides it; - no vestige of the previous m operation remains in the path. - - - - Appends a straight line segment to the current path. - - The x1. - The y1. - Append a straight line segment from the current point to the point (x, y). The new current point is (x, y). - - - - Appends a cubic Bézier curve to the current path. - - The x1. - The y1. - The x2. - The y2. - The x3. - The y3. - The curve extends from the current point to the point (x3 , y3 ), using (x1 , y1 ) and (x2 , y2 ) - as the Bézier control points (see “Cubic Bézier Curves,” below). The new current point is (x3 , y3 ). - - - - Saves the current graphics state. - - - - - Restores the graphics state. - - - - - Translates the current transformation matrix. - - The x-translation. - The y-translation. - - - - Scales the current transformation matrix. - - The x-scale. - The y-scale. - - - - Modifies the current transformation matrix (CTM). - - The a. - The b. - The c. - The d. - The e. - The f. - Modify the current transformation matrix (CTM) by concatenating the specified matrix - (see Section 4.2.1, “Coordinate Spaces”). Although the operands specify a matrix, they - are written as six separate numbers, not as an array. - - - - Sets the vertical text scaling. - - A number specifying the percentage of the normal height. - - - - Rotates by the specified angle around the specified point. - - The x-coordinate of the rotation centre. - The y-coordinate of the rotation centre. - The rotation angle in degrees. - - - - Rotates by the specified angle. - - The rotation angle in degrees. - - - - Sets the stroke alpha. - - The alpha value [0,1]. - - - - Sets the fill alpha. - - The alpha value [0,1]. - - - - Strokes the path. - - Closes the path if set to true. - - - - Fills the path. - - Use the even-odd fill rule if set to true. Use the nonzero winding number rule if set to false. - - - - Fills and strokes the path. - - Closes the path if set to true. - Use the even-odd fill rule if set to true. Use the nonzero winding number rule if set to false. - - - - Sets the clipping path. - - Use the even-odd fill rule if set to true. Use the nonzero winding number rule if set to false. - - - - Ends the path. - - End the path object without filling or stroking it. This operator is a path-painting no-op, - used primarily for the side effect of changing the current clipping path (see Section 4.4.3, “Clipping Path Operators”). - - - - Closes the subpath. - - Close the current subpath by appending a straight line segment from the current point - to the starting point of the subpath. If the current subpath is already closed, h does nothing. - This operator terminates the current subpath. Appending another segment to the current - path begins a new subpath, even if the new segment begins at the endpoint reached by the h operation. - - - - Appends a rectangle to the current path. - - The x-coordinate of the lower-left corner. - The y-coordinate of the lower-left corner. - The width. - The height. - Append a rectangle to the current path as a complete subpath, - with lower-left corner (x, y) and dimensions width and height in user space. - - - - Draws a line connecting the two points specified by the coordinate pairs. - - The x-coordinate of the first point. - The y-coordinate of the first point. - The x-coordinate of the second point. - The y-coordinate of the second point. - - - - Draws a rectangle. - - The x-coordinate of the lower-left corner. - The y-coordinate of the lower-left corner. - The width. - The height. - Fill the rectangle if set to true. - - - - Sets the clipping rectangle. - - The x-coordinate of the lower-left corner. - The y-coordinate of the lower-left corner. - The width. - The height. - Use the even-odd region rule if set to true. - - - - Fills a rectangle. - - The x-coordinate of the lower-left corner. - The y-coordinate of the lower-left corner. - The width. - The height. - - - - Draws a circle. - - The x-coordinate of the center. - The y-coordinate of the center. - The radius. - Fill the circle if set to true. - - - - Fills a circle. - - The x-coordinate of the center. - The y-coordinate of the center. - The radius. - - - - Draws an ellipse. - - The x-coordinate of the lower-left corner. - The y-coordinate of the lower-left corner. - The width. - The height. - Fill the ellipse if set to true. - - - - Fills an ellipse. - - The x-coordinate of the lower-left corner. - The y-coordinate of the lower-left corner. - The width. - The height. - - - - Appends an ellipse to the current path. - - The x-coordinate of the lower-left corner. - The y-coordinate of the lower-left corner. - The width. - The height. - - - - Sets the current font. - - The font name. - The font size in points. - Use bold font weight if set to true. - Use italic style if set to true. - - - - Draws the text at the specified coordinate. - - The left x-coordinate. - The bottom (!) y-coordinate. - The text. - - - - Measures the size of the specified text. - - The text. - The width. - The height. - - - - Draws an image. - - The image to draw. - - - - Sets the color in Device RGB color space. - - The red value. - The green value. - The blue value. - - - - Sets the color in CMYK color space. - - The cyan value. - The magenta value. - The yellow value. - The black value. - - - - Sets the fill color in Device RGB color space. - - The red value. - The green value. - The blue value. - - - - Adds a page. - - The page size. - The page orientation. - - - - Adds a page specified by width and height. - - The page width in points. - The page height in points. - - - - Saves the document to the specified stream. - - The output stream. - - - - Encodes the specified string. - - The text to encode. - The target encoding. - The encoded text - - - - Escapes the specified string. - - The text. - The encoded string. - - - - Encodes binary bits into a plaintext ASCII85 format string - - binary bits to encode - ASCII85 encoded string - - - - Gets the font. - - Name of the font. - Use bold if set to true. - Use italic if set to true. - The font. - - - - Gets a cached value. - - The type of the key. - The type of the value. - The key. - The cache dictionary. - The create value function. - The cached or created value. - - - - Adds an object to the document. - - The added object. - - - - Adds an object of the specified type. - - The object type. - The added object. - - - - Adds an ExtGState object. - - The key. - The value. - The added object. - - - - Adds an image. - - The image. - The added object. - - - - Adds a font. - - The font. - The added object. - - - - Appends a line to the current page contents. - - The format string. - The arguments. - Cannot add content before a page has been added. - - - - Appends text to the current page contents. - - The format string. - The arguments. - Cannot add content before a page has been added. - - - - Represents an object in the . - - The object contains a dictionary and text content. - - - - The dictionary - - - - - The object number - - - - - The contents - - - - - Initializes a new instance of the class. - - The object number. - - - - Gets the object number. - - The object number. - - - - Sets the dictionary value for the specified key. - - The . - The key. - The object. - - - - Appends text to the content of the object. - - The format string. - The arguments. - - - - Appends a line to the content of the object. - - The format string. - The arguments. - - - - Writes the object to the specified . - - The writer. - - - - Provides OxyPlot extension methods for . - - - - - Sets the stroke color. - - The document. - The color. - - - - Sets the fill color. - - The document. - The color. - - - - Represents a font that can be used in a . - - - - - Initializes a new instance of the class. - - - - - Gets or sets the font subtype. - - - - - Gets or sets the base font. - - - - - Gets or sets the encoding. - - - - - Gets or sets the first character in the Widths array. - - - - - Gets or sets the character Widths array. - - - - - Gets or sets the font ascent. - - - - - Gets or sets the font cap height. - - - - - Gets or sets the font descent. - - - - - Gets or sets the font flags. - - - - - Gets or sets the font bounding box. - - - - - Gets or sets the italic angle. - - - - - Gets or sets the stem v. - - - - - Gets or sets the x height. - - - - - Gets or sets the font name. - - - - - Measures the specified text. - - The text. - The font size - The width of the text. - The height of the text. - - - - Represents a font family that can be used in a . - - - - - Gets or sets the regular font. - - - - - Gets or sets the bold font. - - - - - Gets or sets the italic font. - - - - - Gets or sets the bold and italic font. - - - - - Gets the font with the specified weight and style. - - bold font weight. - italic/oblique font style. - The font. - - - - Represents an image that can be included in a . - - - - - Initializes a new instance of the class. - - The width. - The height. - The number of bits per component. - The bits. - The bits of the mask. - Interpolate if set to true. - The color space. - - - - Gets the width. - - The width. - - - - Gets the height. - - The height. - - - - Gets the bits per component. - - The bits per component. - - - - Gets the color space. - - The color space. - - - - Gets the bits. - - The bits. - - - - Gets the mask bits. - - The mask bits. - - - - Gets a value indicating whether the image is interpolated. - - true if interpolated; otherwise, false. - - - - Provides utility methods related to . - - - - - Converts the specified to a . - - The source image. - interpolate if set to true. - The converted image. - - - - Defines the standard fonts that can be used in a . - - - - - Initializes static members of the class. - - - - - Gets the Arial font family. - - - - - Gets the Times font family. - - - - - Gets the Courier font family. - - - - - Provides a controller command for the implemented by a delegate. - - The type of the event arguments. - - - - Initializes a new instance of the class. - - The handler. - - - - Provides an abstract base class for classes that contain event data for input events. - - - - - Gets or sets a value indicating whether the event was handled. - - - - - Gets or sets the modifier keys. - - - - - Gets a value indicating whether the alt key was pressed when the event was raised. - - - - - Gets a value indicating whether the control key was pressed when the event was raised. - - - - - Gets a value indicating whether the shift key was pressed when the event was raised. - - - - - Provides data for key events. - - - - - Gets or sets the key. - - - - - Provides data for the mouse down events. - - - - - Gets or sets the mouse button that has changed. - - - - - Gets or sets the number of times the button was clicked. - - The number of times the mouse button was clicked. - - - - Gets or sets the hit test result. - - - - - Provides data for the mouse events. - - - - - Gets or sets the position of the mouse cursor. - - - - - Provides data for mouse wheel events. - - - - - Gets or sets the change. - - - - - Provides data for touch events. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The current touches. - The previous touches. - - - - Gets or sets the position of the touch. - - The position. - - - - Gets or sets the relative change in scale. - - The scale change. - - - - Gets or sets the change in x and y direction. - - The translation. - - - - Specifies functionality to interact with a plot view. - - - - - Provides an abstract base class for manipulators that handles mouse events. - - - - - Initializes a new instance of the class. - - The plot view. - - - - Gets or sets the first position of the manipulation. - - - - - Occurs when an input device begins a manipulation on the plot. - - The instance containing the event data. - - - - Provides a manipulator for panning functionality. - - - - - Initializes a new instance of the class. - - The plot view. - - - - Gets or sets the previous position. - - - - - Gets or sets a value indicating whether panning is enabled. - - - - - Occurs when a manipulation is complete. - - The instance containing the event data. - - - - Occurs when the input device changes position during a manipulation. - - The instance containing the event data. - - - - Occurs when an input device begins a manipulation on the plot. - - The instance containing the event data. - - - - Provides an abstract base class for plot manipulators. - - The type of the event arguments. - - - - Initializes a new instance of the class. - - The plot view. - - - - Gets the plot view where the event was raised. - - The plot view. - - - - Gets or sets the X axis. - - The X axis. - - - - Gets or sets the Y axis. - - The Y axis. - - - - Transforms a point from screen coordinates to data coordinates. - - The x coordinate. - The y coordinate. - A data point. - - - - Assigns the axes to this manipulator by the specified position. - - The position. - - - - Provides a manipulator for panning and scaling by touch events. - - - - - Initializes a new instance of the class. - - The plot view. - - - - Gets or sets a value indicating whether e.Handled should be set to true - in case pan or zoom is enabled. - - - - - Gets or sets a value indicating whether panning is enabled. - - - - - Gets or sets a value indicating whether zooming is enabled. - - - - - Occurs when a manipulation is complete. - - The instance containing the event data. - - - - Occurs when a touch delta event is handled. - - The instance containing the event data. - - - - Occurs when an input device begins a manipulation on the plot. - - The instance containing the event data. - - - - Provides a plot manipulator for tracker functionality. - - - - - The current series. - - - - - Initializes a new instance of the class. - - The plot view. - - - - Gets or sets a value indicating whether to show tracker on points only (not interpolating). - - - - - Gets or sets a value indicating whether to snap to the nearest point. - - - - - Gets or sets a value indicating whether to lock the tracker to the initial series. - - true if the tracker should be locked; otherwise, false. - - - - Gets or sets the distance from the series at which the tracker fires. - - - - - Gets or sets a value indicating whether to check distance when showing tracker between data points. - - This parameter is ignored if is equal to False. - - - - Occurs when a manipulation is complete. - - The instance containing the event data. - - - - Occurs when a touch delta event is handled. - - The instance containing the event data. - - - - Occurs when an input device begins a manipulation on the plot. - - The instance containing the event data. - - - - Updates the tracker to the specified position. - - The position. - - - - Provides data for a tracker hit result. - - This is used as DataContext for the TrackerControl. - The TrackerControl is visible when the user use the left mouse button to "track" points on the series. - - - - Gets or sets the nearest or interpolated data point. - - - - - Gets or sets the source item of the point. - If the current point is from an ItemsSource and is not interpolated, this property will contain the item. - - - - - Gets or sets the index for the Item. - - - - - Gets or sets the horizontal/vertical line extents. - - - - - Gets or sets the plot model. - - - - - Gets or sets the position in screen coordinates. - - - - - Gets or sets the series that is being tracked. - - - - - Gets or sets the text shown in the tracker. - - - - - Gets the X axis. - - - - - Gets the Y axis. - - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Provides a plot manipulator for tracker functionality. - - - - - The current series. - - - - - Initializes a new instance of the class. - - The plot view. - - - - Gets or sets a value indicating whether to show tracker on points only (not interpolating). - - - - - Gets or sets a value indicating whether to snap to the nearest point. - - - - - Gets or sets a value indicating whether to lock the tracker to the initial series. - - true if the tracker should be locked; otherwise, false. - - - - Gets or sets the distance from the series at which the tracker fires. - - - - - Gets or sets a value indicating whether to check distance when showing tracker between data points. - - This parameter is ignored if is equal to False. - - - - Occurs when a manipulation is complete. - - The instance containing the event data. - - - - Occurs when the input device changes position during a manipulation. - - The instance containing the event data. - - - - Occurs when an input device begins a manipulation on the plot. - - The instance containing the event data. - - - - Provides a manipulator for rectangle zooming functionality. - - - - - The zoom rectangle. - - - - - Initializes a new instance of the class. - - The plot view. - - - - Gets or sets a value indicating whether zooming is enabled. - - - - - Occurs when a manipulation is complete. - - The instance containing the event data. - - - - Occurs when the input device changes position during a manipulation. - - The instance containing the event data. - - - - Occurs when an input device begins a manipulation on the plot. - - The instance containing the event data. - - - - Gets the cursor for the manipulation. - - The cursor. - - - - Provides a plot view manipulator for stepwise zoom functionality. - - - - - Initializes a new instance of the class. - - The plot view. - - - - Gets or sets a value indicating whether FineControl. - - - - - Gets or sets Step. - - - - - Occurs when an input device begins a manipulation on the plot. - - The instance containing the event data. - - - - Defines common commands for the plots. - - - - - Initializes static members of the class. - - - - - Gets the reset axes command. - - - - - Gets the reset axes command (for mouse events). - - - - - Gets the copy code command. - - - - - Gets the pan/zoom touch command. - - - - - Gets the pan command. - - - - - Gets the zoom rectangle command. - - - - - Gets the zoom by mouse wheel command. - - - - - Gets the fine-control zoom by mouse wheel command. - - - - - Gets the tracker command. - - - - - Gets the snap tracker command. - - - - - Gets the snap tracker command. - - - - - Gets the points only tracker command. - - - - - Gets the points only tracker command. - - - - - Gets the mouse hover tracker. - - - - - Gets the mouse hover snap tracker. - - - - - Gets the mouse hover points only tracker. - - - - - Gets the pan left command. - - - - - Gets the pan right command. - - - - - Gets the pan up command. - - - - - Gets the pan down command. - - - - - Gets the fine control pan left command. - - - - - Gets the fine control pan right command. - - - - - Gets the fine control pan up command. - - - - - Gets the fine control pan down command. - - - - - Gets the zoom in command. - - - - - Gets the zoom out command. - - - - - Gets the zoom in command. - - - - - Gets the zoom out command. - - - - - Gets the fine control zoom in command. - - - - - Gets the fine control zoom out command. - - - - - Handles the reset event. - - The view to reset. - The instance containing the event data. - - - - Handles the copy code event. - - The view. - The instance containing the event data. - - - - Zooms the view by the specified factor at the position specified in the . - - The view. - The instance containing the event data. - The zoom factor. - - - - Zooms the view by the mouse wheel delta in the specified . - - The view. - The instance containing the event data. - The zoom speed factor. Default value is 1. - - - - Zooms the view by the key in the specified factor. - - The view. - The instance containing the event data. - The zoom factor (positive zoom in, negative zoom out). - - - - Pans the view by the key in the specified vector. - - The view. - The instance containing the event data. - The horizontal delta (percentage of plot area width). - The vertical delta (percentage of plot area height). - - - - Provides an with a default set of plot bindings. - - - - - Initializes a new instance of the class. - - - - - Specifies functionality for an element of a plot. - - - - - Returns a hash code for this element. - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - This method creates the hash code by reflecting the value of all public properties. - - - - Gets the clipping rectangle. - - The clipping rectangle. - - - - Specifies functionality for the plot model. - - - - - Gets the color of the background of the plot. - - The color. - If the background color is set to or is otherwise invisible then the background will be determined by the plot view or exporter. - - - - Updates the model. - - if set to true , all data collections will be updated. - - - - Renders the plot with the specified rendering context within the given rectangle. - - The rendering context. - The plot bounds. - - - - Attaches this model to the specified plot view. - - The plot view. - Only one plot view can be attached to the plot model. - The plot model contains data (e.g. axis scaling) that is only relevant to the current plot view. - - - - The TransposablePlotElement interface. - - - - - Defines a plot element that uses an X and a Y axis. - - - - - Gets the X axis. - - - - - Gets the Y axis. - - - - - Transforms the specified data point to a screen point by the axes of the plot element. - - The data point. - A screen point. - - - - Transforms from a screen point to a data point by the axes of this series. - - The screen point. - A data point. - - - - Provides an abstract base class for elements of a . - - - - - Initializes a new instance of the class. - - - - - Gets or sets the font. The default is null (use . - - The font. - If the value is null, the DefaultFont of the parent PlotModel will be used. - - - - Gets or sets the size of the font. The default is double.NaN (use ). - - The size of the font. - If the value is NaN, the DefaultFontSize of the parent PlotModel will be used. - - - - Gets or sets the font weight. The default is FontWeights.Normal. - - The font weight. - - - - Gets the parent . - - - - - Gets or sets an arbitrary object value that can be used to store custom information about this plot element. The default is null. - - The intended value. - This property is analogous to Tag properties in other Microsoft programming models. Tag is intended to provide a pre-existing property location where you can store some basic custom information about any PlotElement without requiring you to subclass an element. - - - - Gets or sets the color of the text. The default is OxyColors.Automatic (use ). - - The color of the text. - If the value is OxyColors.Automatic, the TextColor of the parent PlotModel will be used. - - - - Gets or sets the edge rendering mode that is used for rendering the plot element. - - The edge rendering mode. The default is . - - - - Gets or sets the tool tip. The default is null. - - - The tool tip string. - - - - - Gets the actual font. - - - - - Gets the actual size of the font. - - The actual size of the font. - - - - Gets the actual font weight. - - - - - Gets the actual color of the text. - - The actual color of the text. - - - - Gets the actual culture. - - The culture is defined in the parent PlotModel. - - - - - - - Returns a hash code for this element. - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - This method creates the hash code by reflecting the value of all public properties. - - - - The transposable plot element extensions. - - - - - Transforms from a screen point to a data point by the axes of this series. - - The . - The x coordinate of the screen point. - The y coordinate of the screen point. - A data point. - - - - Checks if the series is transposed. - - True if the series is transposed, False otherwise. - The . - - - - Transposes the ScreenPoint if the series is transposed. - - The . - The to orientate. - The oriented point. - - - - Transposes the ScreenVector if the series is transposed. Reverses the respective direction if X or Y axis are reversed. - - The . - The to orientate. - The oriented vector. - - - - Orientates a HorizontalAlignment and a VerticalAlignment according to whether the Series is transposed or the Axes are reversed. - - The . - The to orientate. - The to orientate. - - - - Transforms the specified data point to a screen point by the axes of this series. - - The . - The x coordinate of the data point. - The y coordinate of the data point. - A screen point. - - - - Provides utility functions for plot elements. - - - - - Gets the clipping rectangle defined by the Axis the uses. - - The . - The clipping rectangle. - - - - Transforms from a screen point to a data point by the axes of this series. - - The . - The screen point. - A data point. - - - - Transforms from a screen point to a data point by the axes of this series while being aware of the orientation. - - The . - The screen point. - A data point. - - - - Transforms the specified coordinates to a screen point by the axes of the plot element. - - The plot element. - The data point. - A screen point. - - - - Transforms the specified coordinates to a screen point by the axes of the plot element while being aware of the orientation. - - The plot element. - The data point. - A screen point. - - - - Specifies the coordinate system type. - - - - - XY coordinate system - two perpendicular axes - - - - - Cartesian coordinate system - perpendicular axes with the same scaling. - - See http://en.wikipedia.org/wiki/Cartesian_coordinate_system - - - - Polar coordinate system - with radial and angular axes - - See http://en.wikipedia.org/wiki/Polar_coordinate_system - - - - Specifies the horizontal alignment of the titles. - - - - - Centered within the plot area. - - - - - Centered within the client view (excluding padding defined in ). - - - - - Represents a plot. - - - Represents a plot. - - - - - The bar series managers. - - - - - The plot view that renders this plot. - - - - - The current color index. - - - - - Flags if the data has been updated. - - - - - The last update exception. - - The exception or null if there was no exceptions during the last update. - - - - Initializes a new instance of the class. - - - - - Occurs when the tracker has been changed. - - - - - Occurs when the plot has been updated. - - - - - Occurs when the plot is about to be updated. - - - - - Gets or sets the default font. - - The default font. - This font is used for text on axes, series, legends and plot titles unless other fonts are specified. - - - - Gets or sets the default size of the fonts. - - The default size of the font. - - - - Gets the actual culture. - - - - - Gets the actual plot margins. - - The actual plot margins. - - - - Gets the plot view that renders this plot. - - The plot view. - Only one view can render the plot at the same time. - - - - Gets the annotations. - - The annotations. - - - - Gets the axes. - - The axes. - - - - Gets or sets the legends. - - The legends. - - - - Gets or sets the color of the background of the plot. - - The color. The default is . - If the background color is set to or is otherwise invisible then the background will be determined by the plot view or exporter. - - - - Gets or sets the culture. - - The culture. - - - - Gets or sets the default colors. - - The default colors. - - - - Gets or sets the edge rendering mode that is used for rendering the plot bounds and backgrounds. - - The edge rendering mode. The default is . - - - - Gets or sets a value indicating whether invisible series should be assigned automatic colors. - - - - - Gets or sets a value indicating whether the legend is visible. The titles of the series must be set to use the legend. - - - - - Gets or sets the padding around the plot. - - The padding. - - - - Gets the PlotBounds of the plot (in device units). - - - - - Gets the total width of the plot (in device units). - - - - - Gets the total height of the plot (in device units). - - - - - Gets the area including both the plot and the axes. Outside legends are rendered outside this rectangle. - - The plot and axis area. - - - - Gets the plot area. This area is used to draw the series (not including axes or legends). - - The plot area. - - - - Gets or sets the distance between two neighborhood tiers of the same AxisPosition. - - - - - Gets or sets the color of the background of the plot area. - - - - - Gets or sets the color of the border around the plot area. - - The color of the box. - - - - Gets or sets the thickness of the border around the plot area. - - The box thickness. - - - - Gets or sets the margins around the plot (this should be large enough to fit the axes). - If any of the values is set to double.NaN, the margin is adjusted to the value required by the axes. - - - - - Gets or sets the type of the coordinate system. - - The type of the plot. - - - - Gets the series. - - The series. - - - - Gets or sets the rendering decorator. - - - The rendering decorator. - - - - - Gets or sets the subtitle. - - The subtitle. - - - - Gets or sets the subtitle font. If this property is null, the Title font will be used. - - The subtitle font. - - - - Gets or sets the size of the subtitle font. - - The size of the subtitle font. - - - - Gets or sets the subtitle font weight. - - The subtitle font weight. - - - - Gets or sets the default color of the text in the plot (titles, legends, annotations, axes). - - The color of the text. - - - - Gets or sets the title. - - The title. - - - - Gets or sets the title tool tip. - - The title tool tip. - - - - Gets or sets the color of the title. - - The color of the title. - If the value is null, the TextColor will be used. - - - - Gets or sets a value indicating whether to clip the title. The default value is true. - - - - - Gets or sets the length of the title clipping rectangle (fraction of the available length of the title area). The default value is 0.9. - - - - - Gets or sets the color of the subtitle. - - The color of the subtitle. - - - - Gets or sets the horizontal alignment of the title and subtitle. - - - The alignment. - - - - - Gets the title area. - - The title area. - - - - Gets or sets the title font. - - The title font. - - - - Gets or sets the size of the title font. - - The size of the title font. - - - - Gets or sets the title font weight. - - The title font weight. - - - - Gets or sets the padding around the title. - - The title padding. - - - - Gets the default angle axis. - - The default angle axis. - - - - Gets the default magnitude axis. - - The default magnitude axis. - - - - Gets the default X axis. - - The default X axis. - - - - Gets the default Y axis. - - The default Y axis. - - - - Gets the default color axis. - - The default color axis. - - - - Gets the actual title font. - - - - - Gets the actual subtitle font. - - - - - Attaches this model to the specified plot view. - - The plot view. - Only one plot view can be attached to the plot model. - The plot model contains data (e.g. axis scaling) that is only relevant to the current plot view. - - - - Invalidates the plot. - - Updates all data sources if set to true. - - - - Gets the first axes that covers the area of the specified point. - - The point. - The x-axis. - The y-axis. - - - - Gets the default color from the DefaultColors palette. - - The next default color. - - - - Gets the default line style. - - The next default line style. - - - - Gets a series from the specified point. - - The point. - The limit. - The nearest series. - - - - Generates C# code of the model. - - C# code. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Gets the legend for the specified key. - - The legend key. - The legend that corresponds with the key. - Cannot find legend with the specified key. - - - - Gets any exception thrown during the last call. - - The exception or null if there was no exception. - - - - Updates all axes and series. - 0. Updates the owner PlotModel of all plot items (axes, series and annotations) - 1. Updates the data of each Series (only if updateData==true). - 2. Ensure that all series have axes assigned. - 3. Updates the max and min of the axes. - - if set to true , all data collections will be updated. - - - - Gets the axis for the specified key. - - The axis key. - The axis that corresponds with the key. - Cannot find axis with the specified key. - - - - Gets the axis for the specified key, or returns a default value. - - The axis key. - The default axis. - defaultAxis if key is empty or does not exist; otherwise, the axis that corresponds with the key. - - - - Resets all axes in the model. - - - - - Pans all axes. - - The horizontal distance to pan (screen coordinates). - The vertical distance to pan (screen coordinates). - - - - Zooms all axes. - - The zoom factor. - - - - Raises the TrackerChanged event. - - The result. - - This method is public so custom implementations of tracker manipulators can invoke this method. - - - - - Raises the TrackerChanged event. - - The result. - - - - Gets all elements of the model, top-level elements first. - - - An enumerator of the elements. - - - - - Raises the Updated event. - - - - - Raises the Updating event. - - - - - Updates the axis transforms. - - - - - Enforces the same scale on all axes. - - - - - Updates the intervals (major and minor step values). - - - - - Finds and sets the default horizontal and vertical axes (the first horizontal/vertical axes in the Axes collection). - - - - - Resets the default color index. - - - - - Updates maximum and minimum values of the axes from values of all data series. - - if set to true , the data has been updated. - - - - Updates the bar series managers. - - - - - Renders the plot with the specified rendering context within the given rectangle. - - The rendering context. - The plot bounds. - - - - Renders the plot with the specified rendering context. - - The rendering context. - The plot bounds. - - - - Renders the specified error message. - - The rendering context. - The title. - The error message. - The font size. The default value is 12. - - - - Adjusts the plot margins. - - The render context. - true if the margins were adjusted. - - - - Adjust the positions of parallel axes, returns total size - - The parallel axes. - The maximum value of the position tier?? - - - - Measures the size of the title and subtitle. - - The rendering context. - Size of the titles. - - - - Renders the annotations. - - The render context. - The layer. - - - - Renders the axes. - - The render context. - The layer. - - - - Renders the series backgrounds. - - The render context. - - - - Renders the border around the plot area. - - The render context. - The border will only by rendered if there are axes in the plot. - - - - Renders the series. - - The render context. - - - - Renders the title and subtitle. - - The render context. - - - - Calculates the plot area (subtract padding, title size and outside legends) - - The rendering context. - - - - Provides data for the tracker event. - - - - - Gets or sets the hit result. - - The hit result. - - - - Specifies functionality for the plot views. - - - - - Gets the actual of the control. - - - - - Hides the tracker. - - - - - Invalidates the plot (not blocking the UI thread) - - if set to true, all data bindings will be updated. - - - - Shows the tracker. - - The tracker data. - - - - Stores text on the clipboard. - - The text. - - - - Defines standard font weight values. - - - - - Specifies a bold font weight. - - - - - Specifies a normal font weight. - - - - - Defines horizontal alignment. - - - - - Aligned to the left. - - - - - Aligned in the center. - - - - - Aligned to the right. - - - - - Defines an interpolation algorithm. - - - - - Creates a spline from data points. - - Data points. - True if the spline is closed. - The tolerance. - Spline. - - - - Creates a spline from points in screen space. - - Resampled points. - True if the spline is closed. - The tolerance. - Spline. - - - - Implements a set of predefined interpolation algorithms. - - - - - Canonical spline, also known as Cardinal spline. - - - - - Centripetal Catmull–Rom spline. - - - - - Uniform Catmull–Rom spline. - - - - - Chordal Catmull–Rom spline. - - - - - Defines how to join line segments. - - - - - Line joins use regular angular vertices. - - - - - Line joins use rounded vertices. - - - - - Line joins use beveled vertices. - - - - - Defines the style of a line. - - - - - The solid line style. - - - - - The dash line style. - - - - - The dot line style. - - - - - The dash dot line style. - - - - - The dash dash dot line style. - - - - - The dash dot dot line style. - - - - - The dash dash dot dot line style. - - - - - The long dash line style. - - - - - The long dash dot line style. - - - - - The long dash dot dot line style. - - - - - The hidden line style. - - - - - The automatic line style. - - - - - Provides functionality to convert from to a stroke dash array. - - - - - Gets the stroke dash array for a given . - - The line style. - A dash array. - - - - Describes a color in terms of alpha, red, green, and blue channels. - - - - - The red component. - - - - - The green component. - - - - - The blue component. - - - - - The alpha component. - - - - - Initializes a new instance of the struct. - - The alpha value. - The red value. - The green value. - The blue value. - - - - Gets the alpha value. - - The alpha value. - - - - Gets the blue value. - - The blue value. - - - - Gets the green value. - - The green value. - - - - Gets the red value. - - The red value. - - - - Parse a string. - - The string in the format "#FFFFFF00" or "255,200,180,50". - The parsed color. - Invalid format. - - - - Calculates the difference between two s - - The first color. - The second color. - L2-norm in ARGB space - - - - Convert an to a . - - The unsigned integer color value. - The . - - - - Creates a OxyColor from the specified HSV array. - - The HSV value array. - A OxyColor. - - - - Converts from HSV to - - The hue value [0,1] - The saturation value [0,1] - The intensity value [0,1] - The . - See Wikipedia. - - - - Calculate the difference in hue between two s. - - The first color. - The second color. - The hue difference. - - - - Creates a color defined by an alpha value and another color. - - Alpha value. - The original color. - A color. - - - - Creates a color from the specified ARGB values. - - The alpha value. - The red value. - The green value. - The blue value. - A color. - - - - Creates a new structure from the specified RGB values. - - The red value. - The green value. - The blue value. - A structure with the specified values and an alpha channel value of 1. - - - - Interpolates the specified colors. - - The color1. - The color2. - The t. - The interpolated color - - - - Determines whether the specified colors are equal to each other. - - The first color. - The second color. - true if the two colors are equal; otherwise, false . - - - - Determines whether the specified colors are not equal to each other. - - The first color. - The second color. - true if the two colors are not equal; otherwise, false . - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false . - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false . - - - - Returns a hash code for this instance. - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Determines whether this color is invisible. - - True if the alpha value is 0. - - - - Determines whether this color is visible. - - True if the alpha value is greater than 0. - - - - Determines whether this color is undefined. - - True if the color equals . - - - - Determines whether this color is automatic. - - True if the color equals . - - - - Gets the actual color. - - The default color. - The default color if the current color equals OxyColors.Automatic, otherwise the color itself. - - - - Returns C# code that generates this instance. - - The C# code. - - - - Provides extension methods for . - - These are pure methods. They could also be placed in the type with a PureAttribute. - - - - Changes the intensity. - - The color. - The factor. - A color with the new intensity. - - - - Changes the intensity. - - The color. - The factor. - A color with the new intensity. - - - - Calculates the complementary color. - - The color to convert. - The complementary color. - - - - Converts from a to HSV values (double) - - The color. - Array of [Hue,Saturation,Value] in the range [0,1] - - - - Converts to an unsigned integer. - - The color. - The color as an unsigned integer. - - - - Converts an to a string containing the ARGB byte values. - - The color. - A string that contains byte values of the alpha, red, green and blue components separated by comma. - - - - Returns C# code that generates this instance. - - The color. - The code. - - - - Gets the name of the color if it is defined in the class. - - The color. - The color name or null if the color is not found. - - - - Implements a set of predefined colors. - - - - - The undefined color. - - - - - The automatic color. - - - - - The alice blue. - - - - - The antique white. - - - - - The aqua. - - - - - The aquamarine. - - - - - The azure. - - - - - The beige. - - - - - The bisque. - - - - - The black. - - - - - The blanched almond. - - - - - The blue. - - - - - The blue violet. - - - - - The brown. - - - - - The burly wood. - - - - - The cadet blue. - - - - - The chartreuse. - - - - - The chocolate. - - - - - The coral. - - - - - The cornflower blue. - - - - - The cornsilk. - - - - - The crimson. - - - - - The cyan. - - - - - The dark blue. - - - - - The dark cyan. - - - - - The dark goldenrod. - - - - - The dark gray. - - - - - The dark green. - - - - - The dark khaki. - - - - - The dark magenta. - - - - - The dark olive green. - - - - - The dark orange. - - - - - The dark orchid. - - - - - The dark red. - - - - - The dark salmon. - - - - - The dark sea green. - - - - - The dark slate blue. - - - - - The dark slate gray. - - - - - The dark turquoise. - - - - - The dark violet. - - - - - The deep pink. - - - - - The deep sky blue. - - - - - The dim gray. - - - - - The dodger blue. - - - - - The firebrick. - - - - - The floral white. - - - - - The forest green. - - - - - The fuchsia. - - - - - The gainsboro. - - - - - The ghost white. - - - - - The gold. - - - - - The goldenrod. - - - - - The gray. - - - - - The green. - - - - - The green yellow. - - - - - The honeydew. - - - - - The hot pink. - - - - - The indian red. - - - - - The indigo. - - - - - The ivory. - - - - - The khaki. - - - - - The lavender. - - - - - The lavender blush. - - - - - The lawn green. - - - - - The lemon chiffon. - - - - - The light blue. - - - - - The light coral. - - - - - The light cyan. - - - - - The light goldenrod yellow. - - - - - The light gray. - - - - - The light green. - - - - - The light pink. - - - - - The light salmon. - - - - - The light sea green. - - - - - The light sky blue. - - - - - The light slate gray. - - - - - The light steel blue. - - - - - The light yellow. - - - - - The lime. - - - - - The lime green. - - - - - The linen. - - - - - The magenta. - - - - - The maroon. - - - - - The medium aquamarine. - - - - - The medium blue. - - - - - The medium orchid. - - - - - The medium purple. - - - - - The medium sea green. - - - - - The medium slate blue. - - - - - The medium spring green. - - - - - The medium turquoise. - - - - - The medium violet red. - - - - - The midnight blue. - - - - - The mint cream. - - - - - The misty rose. - - - - - The moccasin. - - - - - The navajo white. - - - - - The navy. - - - - - The old lace. - - - - - The olive. - - - - - The olive drab. - - - - - The orange. - - - - - The orange red. - - - - - The orchid. - - - - - The pale goldenrod. - - - - - The pale green. - - - - - The pale turquoise. - - - - - The pale violet red. - - - - - The papaya whip. - - - - - The peach puff. - - - - - The peru. - - - - - The pink. - - - - - The plum. - - - - - The powder blue. - - - - - The purple. - - - - - The red. - - - - - The rosy brown. - - - - - The royal blue. - - - - - The saddle brown. - - - - - The salmon. - - - - - The sandy brown. - - - - - The sea green. - - - - - The sea shell. - - - - - The sienna. - - - - - The silver. - - - - - The sky blue. - - - - - The slate blue. - - - - - The slate gray. - - - - - The snow. - - - - - The spring green. - - - - - The steel blue. - - - - - The tan. - - - - - The teal. - - - - - The thistle. - - - - - The tomato. - - - - - The transparent. - - - - - The turquoise. - - - - - The violet. - - - - - The wheat. - - - - - The white. - - - - - The white smoke. - - - - - The yellow. - - - - - The yellow green. - - - - - Represents a palette of colors. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The colors. - - - - Initializes a new instance of the class. - - The colors. - - - - Gets or sets the colors. - - The colors. - - - - Interpolates the specified colors to a palette of the specified size. - - The size of the palette. - The colors. - A palette. - - - - Creates a palette with reversed color order. - - The reversed . - - - - Provides predefined palettes. - - - Provides predefined palettes. - - - - - Initializes static members of the class. - - - - - Gets the blue-white-red palette with 31 colors. - - - - - Gets the hot palette with 64 colors. - - - - - Gets the hue palette with 64 colors. - - - - - Creates a black/white/red palette with the specified number of colors. - - The number of colors to create for the palette. - A palette. - - - - Creates a blue/white/red palette with the specified number of colors. - - The number of colors to create for the palette. - A palette. - - - - Creates a 'cool' palette with the specified number of colors. - - The number of colors to create for the palette. - A palette. - - - - Creates a gray-scale palette with the specified number of colors. - - The number of colors to create for the palette. - A palette. - - - - Creates a 'hot' palette with the specified number of colors. - - The number of colors to create for the palette. - A palette. - - - - Creates a palette from the hue component of the HSV color model. - - The number of colors. - The palette. - This palette is particularly appropriate for displaying periodic functions. - - - - Creates a hue-based palette from magenta to red. - - The number of colors. - The palette. - This palette contains only distinct colors and with the cool colors (blues) first. - - - - Creates a 'jet' palette with the specified number of colors. - - The number of colors to create for the palette. - A palette. - - - - Creates a rainbow palette with the specified number of colors. - - The number of colors to create for the palette. - A palette. - - - - The color sequence of the cividis palette. - - - - - The color sequence of the inferno palette. - - - - - The color sequence of the magma palette. - - - - - The color sequence of the plasma palette. - - - - - The color sequence of the viridis palette. - - - - - Gets the cividis palette. - - - - - Gets the inferno palette. - - - - - Gets the magma palette. - - - - - Gets the plasma palette. - - - - - Gets the viridis palette. - - - - - Describes a pen in terms of color, thickness, line style and line join type. - - - - - Initializes a new instance of the class. - - The color. - The thickness. - The line style. - The line join. - - - - Gets or sets the color of the pen. - - The color. - - - - Gets or sets the dash array (overrides ). - - The dash array. - - - - Gets or sets the line join type. - - The line join type. - - - - Gets or sets the line style (overridden by ). - - The line style. - - - - Gets or sets the line thickness. - - The line thickness. - - - - Gets the actual dash array. - - The actual dash array. - - - - Creates the specified pen. - - The color. - The thickness. - The line style. - The line join. - A pen. - - - - Returns a hash code for this instance. - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Describes the width, height, and point origin of a rectangle. - - - - - Gets an infinitely large starting at (0,0). - - - - - The height of the rectangle. - - - - - The x-coordinate location of the left side of the rectangle. - - - - - The y-coordinate location of the top side of the rectangle. - - - - - The width of the rectangle. - - - - - Initializes a new instance of the structure that has the specified x-coordinate, y-coordinate, width, and height. - - The x-coordinate location of the left side of the rectangle. - The y-coordinate location of the top side of the rectangle. - The width of the rectangle. - The height of the rectangle. - width;The width should not be negative. - or - height;The height should not be negative. - - - - Initializes a new instance of the struct that is exactly large enough to contain the two specified points. - - The first point that the new rectangle must contain. - The second point that the new rectangle must contain. - - - - Initializes a new instance of the struct by location and size. - - The location. - The size. - - - - Gets the y-axis value of the bottom of the rectangle. - - The bottom. - - - - Gets the height of the rectangle. - - The height. - - - - Gets the x-axis value of the left side of the rectangle. - - The left. - - - - Gets the x-axis value of the right side of the rectangle. - - The right. - - - - Gets the y-axis position of the top of the rectangle. - - The top. - - - - Gets the width of the rectangle. - - The width. - - - - Gets the center point of the rectangle. - - The center. - - - - Gets the top left corner of the rectangle. - - The top left corner. - - - - Gets the top right corner of the rectangle. - - The top right corner. - - - - Gets the bottom left corner of the rectangle. - - The bottom left corner. - - - - Gets the bottom right corner of the rectangle. - - The bottom right corner. - - - - Creates a rectangle from the specified corner coordinates. - - The x0. - The y0. - The x1. - The y1. - A rectangle. - - - - Determines whether the specified point is inside the rectangle. - - The x coordinate. - The y coordinate. - true if the rectangle contains the specified point; otherwise, false. - - - - Determines whether the specified point is inside the rectangle. - - The point. - true if the rectangle contains the specified point; otherwise, false. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Returns a that represents this instance. - - The format. - The format provider. - - A that represents this instance. - - - - - Determines whether this instance and another specified object have the same value. - - The rectangle to compare to this instance. - true if the value of the parameter is the same as the value of this instance; otherwise, false. - - - - Returns a rectangle that is expanded or shrunk by the specified width and height amounts, in all directions. - - The amount by which to expand or shrink the left and right sides of the rectangle. - The amount by which to expand or shrink the top and bottom sides of the rectangle. - The expanded/shrunk . - - - - Returns a rectangle that is expanded by the specified thickness, in all directions. - - The thickness to apply to the rectangle. - The inflated . - - - - Intersects this with another . - - The other . - The intersection between this and the other . - If the two rectangles don't intersect, this returns an empty . - - - - Returns a rectangle that is shrunk by the specified thickness, in all directions. - - The thickness to apply to the rectangle. - The deflated . - - - - Returns a rectangle that is moved by the specified horizontal and vertical amounts. - - The amount to move the rectangle horizontally. - The amount to move the rectangle vertically. - The moved . - - - - Returns a rectangle that is clipped to the outer bounds of the specified rectangle. - - The rectangle that defines the outermost allowed coordinates for the clipped rectangle. - The clipped rectangle. - - - - Describes the size of an object. - - - - - Empty Size. - - - - - The height - - - - - The width - - - - - Initializes a new instance of the struct. - - The width. - The height. - - - - Gets the height. - - The height. - - - - Gets the width. - - The width. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Returns a that represents this instance. - - The format. - The format provider. - - A that represents this instance. - - - - - Determines whether this instance and another specified object have the same value. - - The size to compare to this instance. - true if the value of the parameter is the same as the value of this instance; otherwise, false. - - - - Creates a new with the maximum dimensions of this instance and the specified other instance. - - The other instance. - A new . - - - - Provides extension methods for - - These are pure methods. They could also be placed in the type with a PureAttribute. - - - - Calculates the bounds with respect to rotation angle and horizontal/vertical alignment. - - The size of the object to calculate bounds for. - The rotation angle (degrees). - The horizontal alignment. - The vertical alignment. - A minimum bounding rectangle. - - - - Gets the polygon outline of the specified rotated and aligned box. - - The size of the box. - The origin of the box. - The rotation angle of the box. - The horizontal alignment of the box. - The vertical alignment of the box. - A sequence of points defining the polygon outline of the box. - - - - Describes the thickness of a frame around a rectangle. Four values describe the left, top, right, and bottom sides of the rectangle, respectively. - - - - - The bottom. - - - - - The left. - - - - - The right. - - - - - The top. - - - - - Initializes a new instance of the struct. - - The thickness. - - - - Initializes a new instance of the struct. - - The left. - The top. - The right. - The bottom. - - - - Gets the bottom thickness. - - The bottom thickness. - - - - Gets the left thickness. - - The left thickness. - - - - Gets the right thickness. - - The right thickness. - - - - Gets the top thickness. - - The top thickness. - - - - Returns C# code that generates this instance. - - The to code. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Determines whether this instance and another specified object have the same value. - - The thickness to compare to this instance. - true if the value of the parameter is the same as the value of this instance; otherwise, false. - - - - Creates a new with the maximum dimensions of this instance and the specified other instance. - - The other instance. - A new . - - - - Provides an abstract base class for rendering contexts that implements a clipping stack. - - - - - - - - - - - - - - Resets the clipping area. - - - - - Sets the clipping area to the specified rectangle. - - The rectangle. - - Calls to this method must always be balanced by a call to before calling again. - - - - - Enumerates the available edge rendering modes. This gives an indication to the renderer which tradoffs to make between sharpness, speed and geomitric accuracy - when rendering shapes like lines, polygons, ellipses etc. - - - - - Indicates that a rendering mode should be chosen automatically by the . The renderer will treat this equivalently to . - - - - - The renderer will try to find the best rendering mode depending on the rendered shape. - - - - - The renderer will try to maximise the sharpness of edges. To that end, it may disable Anti-Aliasing for some lines or snap the position and stroke thickness - of rendered elements to device pixels. - - - - - The renderer will try to maximise the rendering speed. To that end, it may disable Anti-Aliasing. - - - - - The renderer will try to maximise geometric accuracy. To that end, it may enable Anti-Aliasing even for straight lines. - - - - - Specifies functionality to render 2D graphics. - - - - - Gets a value indicating whether the context renders to screen. - - true if the context renders to screen; otherwise, false. - - - - Draws an ellipse. - - The rectangle defining the extents of the ellipse. - The fill color. If set to OxyColors.Undefined, the extents will not be filled. - The stroke color. If set to OxyColors.Undefined, the extents will not be stroked. - The thickness (in device independent units, 1/96 inch). - The edge rendering mode. - - - - Draws a collection of ellipses, where all have the same stroke and fill. - - The rectangles defining the extents of the ellipses. - The fill color. If set to OxyColors.Undefined, the ellipses will not be filled. - The stroke color. If set to OxyColors.Undefined, the ellipses will not be stroked. - The stroke thickness (in device independent units, 1/96 inch). - The edge rendering mode. - - This should have better performance than calling multiple times. - - - - - Draws a polyline. - - The points defining the polyline. The polyline is drawn from point 0, to point 1, to point 2 and so on. - The stroke color. - The stroke thickness (in device independent units, 1/96 inch). - The edge rendering mode. - The dash array (in device independent units, 1/96 inch). Use null to get a solid line. - The line join type. - - - - Draws line segments. - - The points defining the line segments. Lines are drawn from point 0 to 1, point 2 to 3 and so on. - The stroke color. - The stroke thickness (in device independent units, 1/96 inch). - The edge rendering mode. - The dash array (in device independent units, 1/96 inch). - The line join type. - - This should have better performance than calling for each segment. - - - - - Draws a polygon. - - The points defining the polygon. - The fill color. If set to OxyColors.Undefined, the polygon will not be filled. - The stroke color. If set to OxyColors.Undefined, the polygon will not be stroked. - The stroke thickness (in device independent units, 1/96 inch). - The edge rendering mode. - The dash array (in device independent units, 1/96 inch). - The line join type. - - - - Draws a collection of polygons, where all polygons have the same stroke and fill. - - The polygons to draw. - The fill color. If set to OxyColors.Undefined, the polygons will not be filled. - The stroke color. If set to OxyColors.Undefined, the polygons will not be stroked. - The stroke thickness (in device independent units, 1/96 inch). - The edge rendering mode. - The dash array (in device independent units, 1/96 inch). - The line join type. - - This performs better than calling multiple times. - - - - - Draws a rectangle. - - The rectangle to draw. - The fill color. If set to OxyColors.Undefined, the rectangle will not be filled. - The stroke color. If set to OxyColors.Undefined, the rectangle will not be stroked. - The stroke thickness (in device independent units, 1/96 inch). - The edge rendering mode. - - - - Draws a collection of extents, where all have the same stroke and fill. - - The extents to draw. - The fill color. If set to OxyColors.Undefined, the extents will not be filled. - The stroke color. If set to OxyColors.Undefined, the extents will not be stroked. - The stroke thickness (in device independent units, 1/96 inch). - The edge rendering mode. - - This should have better performance than calling multiple times. - - - - - Draws text. - - The position. - The text. - The text color. - The font family. - Size of the font (in device independent units, 1/96 inch). - The font weight. - The rotation angle. - The horizontal alignment. - The vertical alignment. - The maximum size of the text (in device independent units, 1/96 inch). If set to null, the text will not be clipped. - - Multi-line text is not supported. - - - - - Measures the size of the specified text. - - The text to measure. - The font family. - Size of the font (in device independent units, 1/96 inch). - The font weight. - The size of the text (in device independent units, 1/96 inch). - - - - Sets the tool tip for the following items. - - The text in the tool tip, or null if no tool tip should be shown. - - - - Cleans up resources not in use. - - This method is called at the end of each rendering. - - - - Draws a portion of the specified . - - The source. - The x-coordinate of the upper-left corner of the portion of the source image to draw. - The y-coordinate of the upper-left corner of the portion of the source image to draw. - Width of the portion of the source image to draw. - Height of the portion of the source image to draw. - The x-coordinate of the upper-left corner of drawn image. - The y-coordinate of the upper-left corner of drawn image. - The width of the drawn image. - The height of the drawn image. - The opacity. - interpolate if set to true. - - - - Pushes the clipping rectangle onto the clipping stack. - - The clipping rectangle. - - If there is already a clipping rectangle on the clipping stack, the new clipping rectangle will be intersected with the existing clipping rectangle. - Calls to this method must be balanced by a call to . - It is recommended to use in combination with a using statement instead of and if possible. - However if and are used directly, it is recommended to wrap them in a try...finally block. - - - - - Pops the most recently pushed clipping rectangle from the clipping stack. - - - - - Gets the number of clipping rectangles on the clipping stack. - - - - - Provides functionality to render mathematical expressions. - - - - - Initializes static members of the class. - - - - - Gets or sets the subscript alignment. - - - - - Gets or sets the subscript size. - - - - - Gets or sets the superscript alignment. - - - - - Gets or sets the superscript size. - - - - - Draws or measures text containing sub- and superscript. - - The render context. - The point. - The text. - Color of the text. - The font family. - The font size. - The font weight. - The angle. - The horizontal alignment. - The vertical alignment. - The maximum size of the text. - Measure the size of the text if set to true. - The size of the text. - Subscript: H_{2}O - Superscript: E=mc^{2} - Both: A^{2}_{i,j} - - - - Draws text containing sub- and superscript. - - The render context. - The point. - The text. - Color of the text. - The font family. - The font size. - The font weight. - The angle. - The horizontal alignment. - The vertical alignment. - The maximum size of the text. - Subscript: H_{2}O - Superscript: E=mc^{2} - Both: A^{2}_{i,j} - - - - The measure math text. - - The render context. - The text. - The font family. - The font size. - The font weight. - The size of the text. - - - - Draws text with sub- and superscript items. - - The render context. - The x. - The y. - The x offset (in rotated coordinates). - The y offset (in rotated coordinates). - The s. - The text color. - The font family. - The font size. - The font weight. - Only measure if set to true. - The angle of the text (degrees). - The size of the text. - - - - Provides an abstract base class for rendering contexts. - - - - - Initializes a new instance of the class. - - - - - Gets a value indicating whether the specified points form a straight line (i.e. parallel to the pixel raster). - - - To determine whether a line is straight, the coordinates of and are compared. If either the X or the Y - coordinates (or both) of both points are very close together, the line is considered straight. The threshold of what is considered 'very close' - is fixed at 1e-5. - - The first point. - The second point. - true if the points form a straight line; false otherwise. - - - - Gets a value indicating whether the specified points form a straight line (i.e. parallel to the pixel raster). - - The points. - true if the points form a straight line; false otherwise. - - - - Gets or sets a value indicating whether the context renders to screen. - - true if the context renders to screen; otherwise, false. - - - - - - - - - - - - - - - - - - - - - - - - - - - - Draws the text. - - The position of the text. - The text. - The fill color. - The font family. - Size of the font. - The font weight. - The rotation angle. - The horizontal alignment. - The vertical alignment. - The maximum size of the text. - - - - Measures the text. - - The text. - The font family. - Size of the font. - The font weight. - The text size. - - - - Sets the tool tip for the following items. - - The text in the tooltip. - - - - Cleans up resources not in use. - - This method is called at the end of each rendering. - - - - Draws the specified portion of the specified at the specified location and with the specified size. - - The source. - The x-coordinate of the upper-left corner of the portion of the source image to draw. - The y-coordinate of the upper-left corner of the portion of the source image to draw. - Width of the portion of the source image to draw. - Height of the portion of the source image to draw. - The x-coordinate of the upper-left corner of drawn image. - The y-coordinate of the upper-left corner of drawn image. - The width of the drawn image. - The height of the drawn image. - The opacity. - Interpolate if set to true. - - - - - - - - - - - - - Creates an ellipse polygon. - - The bounding rectangle. - The number of points. - The points defining the ellipse. - Note that this is very slow, not optimized in any way. - - - - Creates a rectangle polygon. - - The rectangle. - The points defining the rectangle. - - - - Returns a value indicating whether anti-aliasing should be used for the given edge rendering mode. - - The edge rendering mode. - true if anti-aliasing should be used; false otherwise. - - - - Returns a value indicating whether anti-aliasing should be used for the given edge rendering mode. - - The edge rendering mode. - true if anti-aliasing should be used; false otherwise. - - - - Returns a value indicating whether anti-aliasing should be used for the given edge rendering mode. - - The edge rendering mode. - The points. - true if anti-aliasing should be used; false otherwise. - - - - Provides extension methods for . - - - - - The vertical distance to the bottom points of the triangles. - - - - - The vertical distance to the top points of the triangles . - - - - - The horizontal/vertical distance to the end points of the stars. - - - - - Gets the actual edge rendering mode. - - The edge rendering mode. - The default value that is used if edgeRenderingMode is . - The value of edgeRenderingMode if it is not ; the otherwise. - - - - Draws a clipped polyline through the specified points. - - The render context. - The points. - The minimum line segment length (squared). - The stroke color. - The stroke thickness. - The edge rendering mode. - The dash array (in device independent units, 1/96 inch). - The line join. - The output buffer. - The points rendered callback. - - - - Draws the polygon within the specified clipping rectangle. - - The render context. - The points. - The squared minimum distance between points. - The fill color. - The stroke color. - The stroke thickness. - The edge rendering mode. - The line style. - The line join. - - - - Draws the specified image. - - The render context. - The image. - The destination X position. - The destination Y position. - The width. - The height. - The opacity. - Interpolate the image if set to true. - - - - Draws multi-line text at the specified point. - - The render context. - The point. - The text. - The text color. - The font family. - The font size. - The font weight. - The line spacing. - - - - Draws a line specified by coordinates. - - The render context. - The x0. - The y0. - The x1. - The y1. - The pen. - The edge rendering mode. - - - - Draws the line segments. - - The render context. - The points. - The pen. - The edge rendering mode. - - - - Renders the marker. - - The render context. - The center point of the marker. - The marker type. - The outline. - The size of the marker. - The fill color. - The stroke color. - The stroke thickness. - The edge rendering mode. - - - - Draws a list of markers. - - The render context. - The marker points. - Type of the marker. - The marker outline. - Size of the marker. - The marker fill. - The marker stroke. - The marker stroke thickness. - The edge rendering mode. - The resolution. - The bin Offset. - - - - Draws a list of markers. - - The render context. - The marker points. - Type of the marker. - The marker outline. - Size of the markers. - The marker fill. - The marker stroke. - The marker stroke thickness. - The edge rendering mode. - The resolution. - The bin Offset. - - - - Draws a circle at the specified position. - - The render context. - The center x-coordinate. - The center y-coordinate. - The radius. - The fill color. - The stroke color. - The thickness. - The edge rendering mode. - - - - Draws a circle at the specified position. - - The render context. - The center. - The radius. - The fill color. - The stroke color. - The thickness. - The edge rendering mode. - - - - Fills a circle at the specified position. - - The render context. - The center. - The radius. - The fill color. - The edge rendering mode. - - - - Fills a rectangle at the specified position. - - The render context. - The rectangle. - The fill color. - The edge rendering mode. - - - - Draws the outline of a rectangle with individual stroke thickness for each side. - - The render context. - The rectangle. - The stroke color. - The thickness. - The edge rendering mode. - - - - Measures the size of the specified text. - - The render context. - The text. - The font family. - Size of the font (in device independent units, 1/96 inch). - The font weight. - The angle of measured text (degrees). - The size of the text (in device independent units, 1/96 inch). - - - - Applies the specified clipping rectangle the the render context and returns a reset token. The clipping is reset once this token is disposed. - - The render context. - The clipping rectangle. - The reset token. Clipping is reset once this is disposed. - - - - Adds a marker geometry to the specified collections. - - The position of the marker. - The marker type. - The custom outline, if is . - The size of the marker. - The output ellipse collection. - The output rectangle collection. - The output polygon collection. - The output line collection. - - - - Calculates the bounds with respect to rotation angle and horizontal/vertical alignment. - - The size of the object to calculate bounds for. - The rotation angle (degrees). - A minimum bounding rectangle. - - - - Reduces the specified list of points by the specified minimum squared distance. - - The points that should be evaluated. - The minimum line segment length (squared). - The output buffer. Cannot be null. - Points that are closer than the specified distance will not be included in the output buffer. - - - - Represents the token that is used to automatically reset the clipping in the method. - - - - - Provides a decorator that distorts the rendered output. - - - - - The decorated . This is the one that does the actual rendering. - - - - - The random number generator. - - - - - Initializes a new instance of the class. - - The decorated render context. - - - - Gets or sets the distortion factor. - - - - - Gets or sets the interpolation distance. - - - - - Gets or sets the font family. - - - The font family. - - - - - Gets or sets the thickness scale. - - - The thickness scale. - - - - - - - - - - - - - - Draws the text. - - The position of the text. - The text. - The fill color. - The font family. - Size of the font. - The font weight. - The rotation angle. - The horizontal alignment. - The vertical alignment. - The maximum size of the text. - - - - Measures the text. - - The text. - The font family. - Size of the font. - The font weight. - - The text size. - - - - - Sets the tool tip for the following items. - - The text in the tool tip. - - - - Cleans up resources not in use. - - - This method is called at the end of each rendering. - - - - - Draws the specified portion of the specified at the specified location and with the specified size. - - The source. - The x-coordinate of the upper-left corner of the portion of the source image to draw. - The y-coordinate of the upper-left corner of the portion of the source image to draw. - Width of the portion of the source image to draw. - Height of the portion of the source image to draw. - The x-coordinate of the upper-left corner of drawn image. - The y-coordinate of the upper-left corner of drawn image. - The width of the drawn image. - The height of the drawn image. - The opacity. - Interpolate if set to true. - - - - - - - - - - Gets the transformed font family name. - - The original font family. - The actual font family. - - - - Distorts the specified points. - - The input points. - - The distorted points. - - - - - Generates an array of random numbers. - - The number of numbers to generate. - The random numbers. - - - - Applies a moving average filter to the input values. - - The input values. - The number of values to average. - The filtered values. - - - - Interpolates the input points. - - The input points. - The interpolation distance. - The interpolated points. - - - - Represents a point defined in screen space. - - The rendering methods transforms s to s. - - - - The undefined point. - - - - - The x-coordinate. - - - - - The y-coordinate. - - - - - Initializes a new instance of the struct. - - The x-coordinate. - The y-coordinate. - - - - Gets the x-coordinate. - - The x-coordinate. - - - - Gets the y-coordinate. - - The y-coordinate. - - - - Determines whether the specified point is undefined. - - The point. - true if the specified point is undefined; otherwise, false . - - - - Translates a by a . - - The point. - The vector. - The translated point. - - - - Subtracts a from a - and returns the result as a . - - The point on which to perform the subtraction. - The point to subtract from p1. - A structure that represents the difference between p1 and p2. - - - - Subtracts a from a - and returns the result as a . - - The point on which to perform the subtraction. - The vector to subtract from p1. - A that represents point translated by the negative vector. - - - - Gets the distance to the specified point. - - The point. - The distance. - - - - Gets the squared distance to the specified point. - - The point. - The squared distance. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Determines whether this instance and another specified object have the same value. - - The point to compare to this instance. - true if the value of the parameter is the same as the value of this instance; otherwise, false. - - - - Provides algorithms for polygons and lines of . - - - - - Finds the nearest point on the specified polyline. - - The point. - The points. - The nearest point. - The is null. - - - - Finds the point on line. - - The point. - The first point on the line. - The second point on the line. - The nearest point on the line. - See Bourke. - - - - Finds the nearest point on line. - - The point. - The start point on the line. - The end point on the line. - The relative position of the nearest point. - See Bourke. - - - - Determines whether the specified point is in the specified polygon. - - The point. - The polygon points. - true if the point is in the polygon; otherwise, false. - - - - Resamples the points with the specified point distance limit. - - All points. - The minimum squared distance. - List of resampled points. - - - - Gets the centroid of the specified polygon. - - The points. - The centroid. - - - - Represents a vector defined in screen space. - - - - - The x-coordinate. - - - - - The y-coordinate. - - - - - Initializes a new instance of the structure. - - The x-coordinate. - The y-coordinate. - - - - Gets the length. - - - - - Gets the length squared. - - - - - Gets the x-coordinate. - - The x-coordinate. - - - - Gets the y-coordinate. - - The y-coordinate. - - - - Implements the operator *. - - The vector. - The multiplication factor. - The result of the operator. - - - - Adds a vector to another vector. - - The vector to add to. - The vector to be added. - The result of the operation. - - - - Subtracts one specified vector from another. - - The vector to subtract from. - The vector to be subtracted. - The result of operation. - - - - Negates the specified vector. - - The vector to negate. - The result of operation. - - - - Normalizes this vector. - - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Determines whether this instance and another specified object have the same value. - - The point to compare to this instance. - true if the value of the parameter is the same as the value of this instance; otherwise, false. - - - - Provides functionality to interpolate a list of points by a canonical spline. - - CanonicalSplineHelper.cs (c) 2009 by Charles Petzold (WPF and Silverlight) - See also blog post. - - - - The tension. - - - - - Initializes a new instance of the class. - - The tension. - - - - Creates a spline of data points. - - The points. - True if the spline is closed. - The tolerance. - A list of data points. - - - - Creates a spline of screen points. - - The points. - True if the spline is closed. - The tolerance. - A list of screen points. - - - - Creates a spline of data points. - - The points. - The tension. - The tensions. - True if the spline is closed. - The tolerance. - A list of data points. - - - - Creates a spline of screen points. - - The points. - The tension. - The tensions. - True if the spline is closed. - The tolerance. - A list of screen points. - - - - The segment. - - The points. - The pt 0. - The pt 1. - The pt 2. - The pt 3. - The t 1. - The t 2. - The tolerance. - The maximum number of segments. Default is 1000. - - - - Provides functionality to interpolate a list of points by a Centripetal Catmull–Rom spline. - - Based on CanonicalSplineHelper.cs (c) 2009 by Charles Petzold (WPF and Silverlight) - See also blog post. - - - - Gets the alpha value. - - - - - Gets or sets the maximum number of segments. - - - - - Initializes a new instance of the class. - - The alpha. - - - - Creates a spline of data points. - - The points. - True if the spline is closed. - The tolerance. - A list of data points. - - - - Creates a spline of screen points. - - The points. - True if the spline is closed. - The tolerance. - A list of screen points. - - - - Creates a spline of data points. - - The points. - The alpha. - True if the spline is closed. - The tolerance. - The maximum number of segments. - A list of data points. - - - - Creates a spline of screen points. - - The points. - The alpha. - True if the spline is closed. - The tolerance. - The maximum number of segments. - A list of screen points. - - - - The segment. - - The points. - The pt 0. - The pt 1. - The pt 2. - The pt 3. - The alpha. - The tolerance. - The maximum number of segments. - - - - Provides functionality to decimate lines. - - - - - Decimates lines by reducing all points that have the same integer x value to a maximum of 4 points (first, min, max, last). - - The input points. - The decimated points. - - - - Adds vertical points to the list. - - The result. - The x coordinate. - The first y. - The last y. - The minimum y. - The maximum y. - - - - Specifies vertical alignment. - - - - - Aligned at the top. - - - - - Aligned in the middle. - - - - - Aligned at the bottom. - - - - - Represents an area series that fills the polygon defined by two sets of points or one set of points and a constant. - - - - - The second list of points. - - - - - The secondary data points from the collection. - - - - - The secondary data points from the list. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a constant value for the area definition. - This is used if DataFieldBase and BaselineValues are null. - - The baseline. - is used if is set - and or are null, - or if is null and is empty. - - - - Gets or sets the data field to use for the X-coordinates of the second data set. - - This property is used if is set. - - - - Gets or sets the data field to use for the Y-coordinates of the second data set. - - This property is used if is set. - - - - Gets or sets the color of the line for the second data set. - - The color. - - - - Gets the actual color of the line for the second data set. - - The actual color. - - - - Gets or sets the fill color of the area. - - The fill color. - - - - Gets the actual fill color of the area. - - The actual fill color. - - - - Gets the second list of points. - - The second list of points. - This property is not used if is set. - - - - Gets or sets a value indicating whether the second data collection should be reversed. - - true if the second data set should be reversed; otherwise, false. - The first dataset is not reversed, and normally - the second dataset should be reversed to get a - closed polygon. - - - - Gets the actual points of the second data set. - - A list of data points. - - - - Gets or sets the last visible window start position in second data points collection. - - - - - Gets a value indicating whether Points2 collection was defined by user. - - - - - Gets the nearest point. - - The point. - interpolate if set to true . - A TrackerHitResult for the current hit. - - - - Renders the series on the specified rendering context. - - The rendering context. - - - - Renders the legend symbol for the line series on the - specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - The update data. - - - - - Updates the maximum and minimum values of the series. - - - - - Renders data points skipping NaN values. - - Area rendering context. - The list of chunks. - - - - Renders a chunk of points on the screen. - - Render context. - Screen points. - The list of resampled points. - - - - Gets the x coordinate of a DataPoint. - - Data point. - X coordinate. - - - - Gets the points when is used. - - A sequence of . - - - - Holds parameters for point rendering. - - - - - Gets or sets source data points. - - - - - Gets or sets start index of a visible window. - - - - - Gets or sets maximum visible X coordinate. - - - - - Gets or sets render context. - - - - - Gets or sets minimum squared distance between points. - - - - - Gets or sets a value indicating whether to reverse the points. - - - - - Gets or sets line color. - - - - - Gets or sets line dash array. - - - - - Represents an item used in the BarSeries. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The value. - Index of the category. - - - - Gets or sets the color of the item. - - If the color is not specified (default), the color of the series will be used. - - - - Gets or sets the value of the item. - - - - - Returns c# code that generates this instance. - - C# code. - - - - Represents an item in a bar series. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the index of the category. - - The index of the category. - - - - Gets the index of the category. - - The default index. - The index. - - - - Represents a series for clustered or stacked bar charts. - - - - - The default tracker format string - - - - - The default fill color. - - - - - Initializes a new instance of the class. - - - - - Gets the actual fill color. - - The actual color. - - - - Gets or sets the base value. - - The base value. - - - - Gets or sets the color field. - - - - - Gets or sets the color of the interior of the bars. - - The color. - - - - - - - - - - Gets or sets the label format string. - - The label format string. - - - - Gets or sets the label margins. - - - - - Gets or sets label placements. - - - - - Gets or sets the color of the interior of the bars when the value is negative. - - The color. - - - - - - - Gets or sets the value field. - - - - - Gets or sets the actual rectangles for the bars. - - - - - - - - - - - - - - - - - - - - - - - Renders the bar/column item. - - The render context. - The end value of the bar. - The category value. - The actual width of the bar. - The item. - The rectangle of the bar. - - - - Renders the item label. - - The render context - The item. - The bar item base value. - The bar item top value. - The bar item category value. - The bar item category end value. - - - - - - - - - - Base class for bar series. - - - - - The default category axis title - - - - - The default value axis title - - - - - Specifies if the ItemsSourceItems list can be modified. - - - - - Initializes a new instance of the class. - - - - - Gets the list of items that should be rendered. - - - - - - - - Gets or sets the width of the bars. The default value is 1. - - - - - - - - Gets the items list. - - A list of . - - - - - - - Gets or sets the items from the items source. - - - - - - - - Gets or sets the color of the border around the bars. - - The color of the stroke. - - - - Gets or sets the thickness of the bar border strokes. - - The stroke thickness. - - - - Gets or sets the manager of this . - - - - - Gets the valid items. - - - - - Gets or sets the dictionary which stores the index-inversion for the valid items - - - - - Gets the actual width of the items of this series. - - The width. - The actual width is also influenced by the GapWidth of the CategoryAxis used by this series. - - - - Gets the category axis. - - The category axis. - - - - - - - Gets a value indicating whether the specified item is valid. - - The items. - true if the item is valid; false otherwise. - - - - Updates the from the and data fields. - - - - - Clears or creates the list. - - - - - - - - - - - - - - - - - Updates the list with the valid items. - - - - - Represents a manager for bar series. - - - This handles all operations that need information about all bar series in the plot that share the same axes. This includes: - - determine and keep track of bar width and offset - - determine and keep track of stacked bar offsets - - - - - The current offset of the bars (not used for stacked bar series). - - These offsets are modified during rendering. - - - - The current max value per StackIndex and Label. - - These values are modified during rendering. - - - - The current min value per StackIndex and Label. - - These values are modified during rendering. - - - - The base value per StackIndex and Label for negative values of stacked bar series. - - These values are modified during rendering. - - - - The base value per StackIndex and Label for positive values of stacked bar series. - - These values are modified during rendering. - - - - The maximal width of all labels. - - - - - Initializes a new instance of the class. - - The category axis the belong to. - The value axis the belong to. - The bar series this instance should manage. - - - - Gets the whose bar series this instance manages. - - - - - Gets all bar series that are managed by this instance. - - - - - Gets the whose bar series this instance manages. - - - - - Gets the value whose bar series this instance manages. - - - - - Gets the string representation of the categories. - - - - - Gets or set the offset of the bars. - - - - - Gets or sets the offset of the bars per StackIndex and Label (only used for stacked bar series). - - - - - Gets or sets the stack index mapping. The mapping indicates to which rank a specific stack index belongs. - - - - - Gets the category value. - - Index of the category. - Index of the stack. - Actual width of the bar. - The get category value. - - - - Gets the current bar offset for the specified category index. - - The category index. - The offset. - - - - Gets the current base value for the specified stack and category index. - - The stack index. - The category index. - if set to true get the base value for negative values. - The current base value. - - - - Gets the current maximum value for the specified stack and category index. - - The stack index. - The category index. - The current value. - - - - Gets the current minimum value for the specified stack and category index. - - The stack index. - The category index. - The current value. - - - - Gets the maximum width of all category labels. - - The maximum width. - - - - Gets the stack index for the specified stack group. - - The stack group. - The stack index. - - - - Increases the current bar offset for the specified category index. - - The category index. - The offset increase. - - - - Initializes the manager for rendering. This should be called before any of the managed series are rendered. - - - - - Sets the current base value for the specified stack and category index. - - Index of the stack. - Index of the category. - if set to true set the base value for negative values. - The new value. - - - - Sets the current maximum value for the specified stack and category index. - - The stack index. - The category index. - The new value. - - - - Sets the current minimum value for the specified stack and category index. - - The stack index. - The category index. - The new value. - - - - Bar series should call this after they updated their data. - - - - - Gets a value indicating whether the bar series has an item at the specified category index. - - The bar series. - The category index. - true of the bar series has an item at the specified category index; false otherwise. - - - - Resets the current values. - - The current values may be modified during update of max/min and rendering. - - - - Updates the bar offsets. - - - - - Updates the valid data of all managed series. - - - - - Represents an item used in the ErrorColumnSeries. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The value. - The error. - Index of the category. - - - - Gets or sets the error of the item. - - - - - Returns c# code that generates this instance. - - C# code. - - - - Represents a series for clustered or stacked column charts with an error value. - - - - - The default tracker format string - - - - - Initializes a new instance of the class. - - - - - Gets or sets the stroke thickness of the error line. - - The stroke thickness of the error line. - - - - Gets or sets the width of the error end lines. - - The width of the error end lines. - - - - Updates the maximum and minimum values of the series. - - - - - - - - Defines the functionality of a bar series. - - - - - Gets the bar width. - - - - - Gets the the bar series uses. - - - - - Gets a value indicating whether the bar series is visible. - - - - - Gets or sets the manager of the bar series. - - - - - Gets the the bar series belongs to. - - - - - Gets the the bar series uses. - - - - - Updates the valid data. - - - - - Gets the actual bar items. - - - - - Represents an item in an IntervalBarSeries. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The start. - The end. - The title. - - - - Gets or sets the color. - - - - - Gets or sets the end value. - - - - - Gets or sets the start value. - - - - - Gets or sets the title. - - - - - Returns c# code that generates this instance. - - C# code. - - - - Represents a series for bar charts defined by to/from values. - - - - - The default tracker format string - - - - - The default fill color. - - - - - Initializes a new instance of the class. - - - - - Gets the actual fill color. - - The actual color. - - - - Gets or sets the color field. - - - - - Gets or sets the color field. - - - - - Gets or sets the default color of the interior of the Maximum bars. - - The color. - - - - - - - - - - Gets or sets the label color. - - - - - Gets or sets the format string for the maximum labels. - - - - - Gets or sets the label margins. - - - - - - - - Gets or sets the color field. - - - - - Gets or sets the actual rectangles for the maximum bars. - - - - - - - - - - - - - - - - - - - - - - - - - - Defines properties for stacked series. - - - - - Gets a value indicating whether this series is stacked. - - - - - Gets a value indicating whether this series should overlap its stack when is true. - - - - - Gets the stack group. - - The stack group. - - - - Placement of the labels. - - - - - Placed outside the bar. - - - - - Placed inside the bar. - - - - - Placed inside in the middle/center of the bar. - - - - - Placed inside at the base of the bar. - - - - - Represents a series to display bars in a linear axis - - - - - The rendered rectangles. - - - - - The indexes matching rendered rectangles. - - - - - The default color. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color of the interior of the bars. - - The color. - - - - Gets or sets the width of the bars. - - The width of the bars. - - - - Gets or sets the thickness of the curve. - - The stroke thickness. - - - - Gets or sets the color of the border around the bars. - - The color of the stroke. - - - - Gets or sets the color of the interior of the bars when the value is negative. - - The color. - - - - Gets or sets the color of the border around the bars when the value is negative. - - The color of the stroke. - - - - Gets the actual color. - - The actual color. - - - - Gets the nearest point. - - The point. - interpolate if set to true . - A TrackerHitResult for the current hit. - - - - - - - Renders the legend symbol for the line series on the - specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - Sets default values from the plot model. - - - - - Updates the axes to include the max and min of this series. - - - - - Find the index of a rectangle that contains the specified point. - - the target point - the rectangle index - - - - Renders the series bars. - - The rendering context. - The list of points that should be rendered. - - - - Computes the bars width. - - The list of points. - The bars width. - - - - Gets the colors used to draw a bar. - - The point y value - The bar colors - - - - Stores the colors used to draw a bar. - - - - - Initializes a new instance of the struct. - - The fill color - The stroke color - - - - Gets the fill color. - - - - - Gets the stroke color. - - - - - Represents a rectangle item in a RectangleBarSeries. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The x0. - The y0. - The x1. - The y1. - - - - Gets or sets the color. - - If set to Automatic, the FillColor of the RectangleBarSeries will be used. - - - - Gets or sets the title. - - - - - Gets or sets the x0 coordinate. - - - - - Gets or sets the x1 coordinate. - - - - - Gets or sets the y0 coordinate. - - - - - Gets or sets the y1 coordinate. - - - - - Returns c# code that generates this instance. - - C# code. - - - - Represents a series for bar charts where the bars are defined by rectangles. - - - - - The default tracker format string - - - - - The default fill color. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the default color of the interior of the rectangles. - - The color. - - - - Gets the actual fill color. - - The actual color. - - - - Gets the rectangle bar items. - - - - - Gets or sets the label color. - - - - - Gets or sets the format string for the labels. - - - - - Gets or sets the color of the border around the rectangles. - - The color of the stroke. - - - - Gets or sets the thickness of the border around the rectangles. - - The stroke thickness. - - - - Gets or sets the actual rectangles for the rectangles. - - - - - Gets or sets the actual rectangle bar items. - - - - - Gets the point in the dataset that is nearest the specified point. - - The point. - Specifies whether to interpolate or not. - A for the current hit. - - - - - - - Renders the legend symbol on the specified rendering context. - - The rendering context. - The legend rectangle. - - - - Sets the default values. - - - - - Updates the data. - - - - - Updates the maximum and minimum values of the series. - - - - - Checks if the specified value is valid. - - The value. - True if the value is valid. - - - - Represents an item for the TornadoBarSeries. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the base value. - - - - - Gets or sets the maximum value. - - - - - Gets or sets the color for the maximum bar. - - - - - Gets or sets the minimum value. - - - - - Gets or sets the color for the minimum bar. - - - - - Returns c# code that generates this instance. - - C# code. - - - - Represents a series that can be used to create tornado plots. - - See http://en.wikipedia.org/wiki/Tornado_diagram. - - - - The default tracker format string - - - - - The default fill color. - - - - - The default minimum fill color. - - - - - Initializes a new instance of the class. - - - - - Gets the actual fill color. - - The actual color. - - - - Gets the actual minimum fill color. - - The actual color. - - - - Gets or sets the color field. - - - - - Gets or sets the base value. - - The base value. - - - - Gets or sets the label color. - - - - - Gets or sets the label margins. - - - - - Gets or sets the color field. - - - - - Gets or sets the color field. - - - - - Gets or sets the color of the interior of the Maximum bars. - - The color. - - - - Gets or sets the format string for the maximum labels. - - - - - Gets or sets the color field. - - - - - Gets or sets the color field. - - - - - Gets or sets the default color of the interior of the Minimum bars. - - The color. - - - - Gets or sets the format string for the minimum labels. - - - - - Gets or sets the actual rectangles for the maximum bars. - - - - - Gets or sets the actual rectangles for the minimum bars. - - - - - - - - - - - - - - - - - - - - - - - - - - Represents an item in a . - - - - - Initializes a new instance of the class. - - The x. - The lower whisker. - The box bottom. - The median. - The box top. - The upper whisker. - - - - Gets or sets the box bottom value (usually the 25th percentile, Q1). - - The lower quartile value. - - - - Gets or sets the box top value (usually the 75th percentile, Q3)). - - The box top value. - - - - Gets or sets the lower whisker value. - - The lower whisker value. - - - - Gets or sets the median. - - The median. - - - - Gets or sets the mean. - - The mean. - - - - Gets or sets the outliers. - - The outliers. - - - - Gets or sets the tag. - - The tag. - - - - Gets or sets the upper whisker value. - - The upper whisker value. - - - - Gets a list of all the values in the item. - - - - - Gets or sets the X value. - - The X value. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Represents a series for box plots. - - - - - The default tracker format string - - - - - The items from the items source. - - - - - Specifies if the ownsItemsSourceItems list can be modified. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the width of the boxes (specified in x-axis units). - - The width of the boxes. - - - - Gets or sets the fill color. If null, this color will be automatically set. - - The fill color. - - - - Gets or sets the box plot items. - - The items. - - - - Gets or sets the line style. - - The line style. - - - - Gets or sets the size of the median point. - - This property is only used when ShowMedianAsDot = true. - - - - Gets or sets the median thickness, relative to the StrokeThickness. - - The median thickness. - - - - Gets or sets the size of the mean point. - - This property is only used when ShowMeanAsDot = true. - - - - Gets or sets the mean thickness, relative to the StrokeThickness. - - The mean thickness. - - - - Gets or sets the diameter of the outlier circles (specified in points). - - The size of the outlier. - - - - Gets or sets the tracker format string for the outliers. - - The tracker format string for the outliers. - Use {0} for series title, {1} for x- and {2} for y-value. - - - - Gets or sets the type of the outliers. - - The type of the outliers. - MarkerType.Custom is currently not supported. - - - - Gets or sets the a custom polygon outline for the outlier markers. Set to to use this property. - - A polyline. The default is null. - - - - Gets or sets a value indicating whether to show the boxes. - - - - - Gets or sets a value indicating whether to show the median as a dot. - - - - - Gets or sets a value indicating whether to show the mean as a dot. - - - - - Gets or sets the stroke color. - - The stroke color. - - - - Gets or sets the stroke thickness. - - The stroke thickness. - - - - Gets or sets the width of the whiskers (relative to the BoxWidth). - - The width of the whiskers. - - - - Gets the list of items that should be rendered. - - - - - Gets the nearest point. - - The point. - interpolate if set to true . - A TrackerHitResult for the current hit. - - - - Determines whether the specified item contains a valid point. - - The item. - The x axis. - The y axis. - true if the point is valid; otherwise, false . - - - - Renders the series on the specified render context. - - The rendering context. - - - - Renders the legend symbol on the specified rendering context. - - The rendering context. - The legend rectangle. - - - - Updates the data. - - - - - Updates the maximum and minimum values of the series. - - - - - Updates the max and min of the series. - - The items. - - - - Gets the item at the specified index. - - The index of the item. - The item of the index. - - - - Gets the screen rectangle for the box. - - The box item. - A rectangle. - - - - Clears or creates the list. - - - - - Represents a series that renders contours. - - See wikipedia and link. - - - - The default tracker format string - - - - - The contour collection. - - - - - The temporary segment collection. - - - - - The default color. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color. - - The color. - - - - Gets the actual color. - - The actual color. - - - - Gets or sets the column coordinates. - - The column coordinates. - - - - Gets or sets the contour level step size. - This property is not used if the vector is set. - - The contour level step size. - - - - Gets or sets the contour levels. - - The contour levels. - - - - Gets or sets the contour colors. - - The contour colors. - These colors will override the Color of the series. - If there are less colors than the number of contour levels, the colors will cycle. - - - - Gets or sets the data. - - The data. - - - - Gets or sets the text background color. - - The text background color. - - - - Gets or sets the format string for contour values. - - The format string. - - - - Gets or sets the label spacing, which is the space between labels on the same contour. Not used if == - - The label spacing. - - - - Gets or sets a value indicating whether multiple labels should be displayed per Contour. The default value is false - - - - - Gets or sets the interval between labeled contours. LabelStep = 1 is default and it means that all contours have a label - - The label step. - - - - Gets or sets the line style. - - The line style. - - - - Gets or sets the row coordinates. - - The row coordinates. - - - - Gets or sets the stroke thickness. - - The stroke thickness. - - - - Calculates the contours. - - - - - Gets the point in the dataset that is nearest the specified point. - - The point. - The interpolate. - A hit result object. - - - - Renders the series on the specified rendering context. - - The rendering context. - - - - Sets default values from the plot model. - - - - - Updates the maximum and minimum values of the series. - - - - - Gets the index of item that is closest to the specified value. - - A list of values. - A value. - An index. - - - - The add contour labels. - - The contour. - The points of the contour. - The contour labels. - The index of the point in the list of points, where the label should get added. - - - - Joins the contour segments. - - The tolerance for segment ends to connect (maximum allowed [length of distance vector] / [length of position vector]). - - - - Renders the contour label. - - The render context. - The contour label. - - - - Renders the contour label background. - - The render context. - The contour label. - - - - Represents one of the two points of a segment. - - - - - Initializes a new instance of the class. - - The segment point. - - - - Gets or sets a value indicating whether this already was added to a . - - - - - Gets or sets the partner point. This point and its partner together define a segment. - - - - - Gets or sets the join point. This is a point from another segment with the same coordinates as this point (within eps). - - - - - Gets the data point. - - - - - Represents a contour. - - - - - Gets or sets the contour level. - - The contour level. - - - - Gets or sets the points. - - The points. - - - - Initializes a new instance of the class. - - The points. - The contour level. - - - - Gets or sets the color of the contour. - - - - - Represents a contour label. - - - - - Gets or sets the angle. - - The angle. - - - - Gets or sets the position. - - The position. - - - - Gets or sets the text. - - The text. - - - - Represents a contour segment. - - - - - The contour level. - - - - - The end point. - - - - - The start point. - - - - - Initializes a new instance of the class. - - The start point. - The end point. - The contour level. - - - - Provides an abstract base class for series that contain a collection of s. - - - - - The list of data points. - - - - - The data points from the items source. - - - - - Specifies if the itemsSourcePoints list can be modified. - - - - - Gets or sets a value indicating whether the tracker can interpolate points. - - - - - Gets or sets the data field X. The default is null. - - The data field X. - - - - Gets or sets the data field Y. The default is null. - - The data field Y. - - - - Gets or sets the delegate used to map from to the . The default is null. - - The mapping. - Example: series1.Mapping = item => new DataPoint(((MyType)item).Time,((MyType)item).Value); - - - - Gets the list of points. - - A list of . - - - - Gets the list of points that should be rendered. - - A list of . - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Updates the data. - - - - - Updates the maximum and minimum values of the series. - - - - - Gets the item at the specified index. - - The index of the item. - The item of the index. - - - - Clears or creates the list. - - - - - Updates the points from the . - - - - - Represents an interval defined by two doubles. - - - - - The undefined data range. - - - - - Initializes a new instance of the struct. - - The inclusive lower bound. - The inclusive upper bound. - - - - Gets the lower bound of the data range. - - - - - Gets the upper bound of the data range. - - - - - Gets the difference between maximum and minimum. - - - - - Determines whether this data range is defined. - - true if this instance is defined, otherwise false. - - - - Determines whether the specified value lies - within the closed interval of the data range. - - The value to be checked. - true if value in range, otherwise false. - - - - Determines whether the specified data range - intersects with this instance. - - the other interval to be checked. - true if intersects, otherwise false. - - - - Returns C# code that generates this instance. - - The to code. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Represents a series where the line can be rendered using a different style - or color in defined intervals of X. The style specified in the LineStyle - property determines how the line is rendered in these intervals. Outside - the intervals the style is always solid. - - - - - Default color for the extrapolated parts of the curve. Currently hard-coded. - - - - - Default line style for the extrapolated parts of the curve. Currently hard-coded. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color for the part of the line that is inside an interval. - - - - - Gets the actual extrapolation color. - - The actual color. - - - - Gets or sets the dash array for the extrapolated intervals of the rendered line - (overrides ). The default is null. - - The dash array for extrapolated intervals. - If this is not null it overrides the property. - - - - Gets or sets the style for the extrapolated parts of the line. - - - - - Gets the actual extrapolation line style. - - - - - Gets or sets a value indicating whether the extrapolated regions of the series will - be taken into account when calculating the minima and maxima of the dataset. - These regions will hence also be ignored when auto-scaling the axes. - - - - - Gets the list of X intervals within which the line is rendered using the second color and style. - - - - - Gets the actual dash array for the extrapolated parts of the line. - - - - - Renders the legend symbol for the extrapolation line series on the - specified rendering context. Both lines (normal and extrapolated) - are displayed. - - The rendering context. - The bounding rectangle of the legend box. - - - - Updates the data and sorts the intervals. - - - - - Updates the maximum and minimum values of the series. - - - - - Renders a continuous line. - - The render context. - The points to render. - - - - Creates clipping rectangles for the parts of the line which are either - rendered in normal style or in extrapolation style. - - - - - Returns a flat sequence of doubles containing alternating minima - and maxima of the original data range intervals. - - - - - Renders the part of the line which is given by the provided list of screen points. - - - - - Sorts the intervals by their minimum and merges those intervals which overlap, i.e. - replaces them by their union. - - - - - Checks whether the given x-value is within any of the - ordered intervals using binary search. - - The value to be checked for. - true if x is inside any interval. - - - - Checks whether the given x-value is within the provided interval. - - The interval to check against. - The value to be checked. - 0 if x is within inclusive interval, -1 if x smaller interval's min, 1 if x larger interval's max. - - - - Represents a dual view (candlestick + volume) series for OHLCV bars - - Note that to use this series, one *must* define two y-axes, one named "Bars" and the other named - "Volume". Typically would set up the volume on StartPosition =0, EndPosition = fraction and for - the bar axis StartPosition = fraction + delta, EndPosition = 1.0. - - See link - - - - The default tracker format string - - - - - The data series - - - - - The minimum X gap between successive data items - - - - - The index of the data item at the start of visible window - - - - - Initializes a new instance of the class. - - - - - Gets or sets the items of the series. - - The items. - - - - Gets the portion of the Y axis associated with bars - - - - - Gets the portion of the Y axis associated with volume - - - - - Gets or sets the volume axis key (defaults to "Volume") - - - - - Gets or sets the bar axis key (defaults to null, as is the primary axis). - - - - - Gets or sets the style of volume rendering (defaults to Combined) - - - - - Gets or sets the thickness of the bar lines - - The stroke thickness. - - - - Gets or sets the stroke intensity scale (used to generate stroke color from positive or negative color). - For example, 1.0 = same color and 0.5 is 1/2 of the intensity of the source fill color. - - - - - Gets or sets the thickness of the volume / bar separator - - The stroke thickness. - - - - Gets or sets the line style for the volume / bar separator - - - - - Gets or sets the color used when the closing value is greater than opening value or - for buying volume. - - - - - Gets or sets the fill color used when the closing value is less than opening value or - for selling volume - - - - - Gets or sets the color of the separator line - - - - - Gets or sets a value indicating whether positive bars are shown as filled (false) or hollow (true) candlesticks - - - - - Gets or sets a value indicating whether negative bars are shown as filled (false) or hollow (true) candlesticks - - - - - Gets or sets the bar width in data units (for example if the X axis is date-time based, then should - use the difference of DateTimeAxis.ToDouble(date) to indicate the width). By default candlestick - series will use 0.80 x the minimum difference in data points. - - - - - Gets or sets the minimum volume seen in the data series. - - - - - Gets or sets the maximum volume seen in the data series. - - - - - Gets or sets the average volume seen in the data series. - - - - - Append a bar to the series (must be in X order) - - Bar object. - - - - Fast index of bar where max(bar[i].X) <= x - - The index of the bar closest to X, where max(bar[i].X) <= x. - The x coordinate. - starting index - - - - - - - Renders the legend symbol for the series on the specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Updates the data. - - - - - Ensures that the axes of the series is defined. - - - - - Updates the axes to include the max and min of this series. - - - - - Updates the maximum and minimum values of the series. - - - - - Gets the clipping rectangle for the given combination of existing X-Axis and specific Y-Axis - - The clipping rectangle. - Y axis. - - - - Gets the clipping rectangle between plots - - The clipping rectangle. - - - - Represents a "higher performance" ordered OHLC series for candlestick charts - - Does the following: - - automatically calculates the appropriate bar width based on available screen + # of bars - - can render and pan within millions of bars, using a fast approach to indexing in series - - convenience methods - - This implementation is associated with issue 369. - - See also Wikipedia and - Matlab documentation. - - - - The minimum X gap between successive data items - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color used when the closing value is greater than opening value. - - - - - Gets or sets the fill color used when the closing value is less than opening value. - - - - - Gets or sets the bar width in data units (for example if the X axis is date/time based, then should - use the difference of DateTimeAxis.ToDouble(date) to indicate the width). By default candlestick - series will use 0.80 x the minimum difference in data points. - - - - - Fast index of bar where max(bar[i].X) <= x - - The index of the bar closest to X, where max(bar[i].X) <= x. - The x coordinate. - starting index - - - - - - - Renders the legend symbol for the series on the specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Updates the data. - - - - - Represents an item in a . - - - - - The undefined. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - The x value. - - - The high value. - - - The low value. - - - The open value. - - - The close value. - - - - - Gets or sets the close value. - - The close value. - - - - Gets or sets the high value. - - The high value. - - - - Gets or sets the low value. - - The low value. - - - - Gets or sets the open value. - - The open value. - - - - Gets or sets the X value (time). - - The X value. - - - - Returns C# code that generates this instance. - - The C# code. - - - - Represents a series for high-low plots. - - See link - - - - The default tracker format string - - - - - High/low items - - - - - The default color. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color of the item. - - The color. - - - - Gets the actual color of the item. - - The actual color. - - - - Gets or sets the dashes array. - If this is not null it overrides the LineStyle property. - - The dashes. - - - - Gets or sets the data field for the Close value. - - - - - Gets or sets the data field for the High value. - - - - - Gets or sets the data field for the Low value. - - - - - Gets or sets the data field for the Open value. - - - - - Gets or sets the x data field (time). - - - - - Gets the items of the series. - - The items. - - - - Gets or sets the line join. - - The line join. - - - - Gets or sets the line style. - - The line style. - - - - Gets or sets the mapping delegate. - - The mapping. - Example: series1.Mapping = item => new HighLowItem(((MyType)item).Time,((MyType)item).Value); - - - - Gets or sets the thickness of the curve. - - The stroke thickness. - - - - Gets or sets the length of the open/close ticks (screen coordinates). - - The length of the open/close ticks. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Determines whether the point is valid. - - The point. - The x axis. - The y axis. - true if the specified point is valid; otherwise, false. - - - - - - - Renders the legend symbol for the series on the specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - Sets the default values. - - - - - Updates the data. - - - - - Updates the maximum and minimum values of the series. - - - - - Represents an item in a . - - - - - The undefined. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The x coordinate / time. - Open value. - High value. - Low value. - Close value. - Buy volume. - Sell volume. - - - - Gets or sets the X value (time). - - The X value. - - - - Gets or sets the open value. - - The open value. - - - - Gets or sets the high value. - - The high value. - - - - Gets or sets the low value. - - The low value. - - - - Gets or sets the close value. - - The close value. - - - - Gets or sets the buy volume. - - - - - Gets or sets the sell volume. - - - - - Find index of max(x) <= target x in a list of OHLCV items - - - vector of bars - - - target x. - - - initial guess. - - - index of x with max(x) <= target x or -1 if cannot find - - - - - Indicate whether is valid for rendering or not - - true if this instance is valid; otherwise, false. - - - - Represents a series for candlestick charts. - - See also Wikipedia and - Matlab documentation. - - - - Initializes a new instance of the class. - - - - - Gets or sets the width of the candle (in screen space units). - - - - - Gets or sets the color used when the closing value is greater than opening value. - - - - - Gets or sets the fill color used when the closing value is less than opening value. - - - - - Gets or sets the end color of the shadow. - - The end color of the shadow. - - - - Gets or sets the lengths of the shadow ends. - - The length relative to the width of the candle. - - - - Gets the actual increasing fill color. - - - - - - - - Renders the legend symbol for the series on the specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - Represents a dual view (candlestick + volume) series for OHLCV bars - - See link - - - - The default tracker format string - - - - - The data series - - - - - The minimum X gap between successive data items - - - - - The index of the data item at the start of visible window - - - - - Initializes a new instance of the class. - - - - - Gets or sets the items of the series. - - The items. - - - - Gets or sets the style of volume rendering (defaults to Combined) - - - - - Gets or sets the thickness of the bar lines - - The stroke thickness. - - - - Gets or sets the stroke intensity scale (used to generate stroke color from positive or negative color). - For example, 1.0 = same color and 0.5 is 1/2 of the intensity of the source fill color. - - - - - Gets or sets the color used when the closing value is greater than opening value or - for buying volume. - - - - - Gets or sets the fill color used when the closing value is less than opening value or - for selling volume - - - - - Gets or sets the stroke color of the Y=0 intercept - - - - - Gets or sets the thickness of the Y=0 intercept - - - - - Gets or sets the line style of the Y=0 intercept - - - - - Gets or sets a value indicating whether positive bars are shown as filled (false) or hollow (true) candlesticks - - - - - Gets or sets a value indicating whether negative bars are shown as filled (false) or hollow (true) candlesticks - - - - - Gets or sets the bar width in data units (for example if the X axis is date/time based, then should - use the difference of DateTimeAxis.ToDouble(date) to indicate the width). By default candlestick - series will use 0.80 x the minimum difference in data points. - - - - - Gets or sets the minimum volume seen in the data series. - - - - - Gets or sets the maximum volume seen in the data series. - - - - - Gets or sets the average volume seen in the data series. - - - - - Append a bar to the series (must be in X order) - - The Bar. - - - - Fast index of bar where max(bar[i].X) <= x - - The index of the bar closest to X, where max(bar[i].X) <= x. - The x coordinate. - starting index - - - - - - - Renders the legend symbol for the series on the specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Updates the data. - - - - - Updates the axes to include the max and min of this series. - - - - - Updates the maximum and minimum values of the series. - - - - - Represents rendering style for volume in either or . - - - - - Volume is not displayed - - - - - Buy + Sell volume summed to produce net positive or negative volume - - - - - Buy and Sell volume is stacked, one on top of the other, with the dominant on top - - - - - Buy volume above y=0 axis and Sell volume below y=0 axis - - - - - Represents a line series that generates its dataset from a function. - - Define f(x) and make a plot on the range [x0,x1] or define x(t) and y(t) and make a plot on the range [t0,t1]. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class using a function f(x). - - The function f(x). - The start x value. - The end x value. - The increment in x. - The title (optional). - - - - Initializes a new instance of the class using a function f(x). - - The function f(x). - The start x value. - The end x value. - The number of points. - The title (optional). - - - - Initializes a new instance of the class using functions x(t) and y(t). - - The function x(t). - The function y(t). - The start t parameter. - The end t parameter. - The increment in t. - The title. - - - - Initializes a new instance of the class using functions x(t) and y(t). - - The function x(t). - The function y(t). - The start t parameter. - The end t parameter. - The number of points. - The title. - - - - Specifies how the heat map coordinates are defined. - - - - - The coordinates defines the center of the cells - - - - - The coordinates defines the edge of the cells - - - - - Specifies how the heat map coordinates are defined. - - - - - The heat map is rendered as a bitmap - - - - - The heat map is rendered as a collection of discrete rectangles - - - - - Represents a heat map. - - - - - The default tracker format string - - - - - The default color-axis title - - - - - The hash code of the data when the image was updated. - - - - - The hash code of the color axis when the image was updated. - - - - - The image - - - - - Initializes a new instance of the class. - - - - - Gets or sets the x-coordinate of the elements at index [0,*] in the data set. - - - If equals , the value defines the mid point of the element at index [0,*] in the data set. - If equals , the value defines the coordinate of the left edge of the element at index [0,*] in the data set. - - - - - Gets or sets the x-coordinate of the mid point for the elements at index [m-1,*] in the data set. - - - If equals , the value defines the mid point of the element at index [m-1,*] in the data set. - If equals , the value defines the coordinate of the right edge of the element at index [m-1,*] in the data set. - - - - - Gets or sets the y-coordinate of the mid point for the elements at index [*,0] in the data set. - - - If equals , the value defines the mid point of the element at index [*,0] in the data set. - If equals , the value defines the coordinate of the bottom edge of the element at index [*,0] in the data set. - - - - - Gets or sets the y-coordinate of the mid point for the elements at index [*,n-1] in the data set. - - - If equals , the value defines the mid point of the element at index [*,n-1] in the data set. - If equals , the value defines the coordinate of the top edge of the element at index [*,n-1] in the data set. - - - - - Gets or sets the data array. - - Note that the indices of the data array refer to [x,y]. - The first dimension is along the x-axis. - The second dimension is along the y-axis. - Remember to call the method if the contents of the array is changed. - - - - Gets or sets a value indicating whether to interpolate when rendering. The default value is true. - - This property is not supported on all platforms. Ignored (off) if is . - - - - Gets the minimum value of the dataset. - - - - - Gets the maximum value of the dataset. - - - - - Gets or sets the color axis. - - The color axis. - - - - Gets or sets the color axis key. - - The color axis key. - - - - Gets or sets the coordinate definition. The default value is . - - The coordinate definition. - - - - Gets or sets the render method. The default value is . - - The render method. - - - - Gets or sets the format string for the cell labels. The default value is 0.00. - - The format string. - The label format string is only used when is greater than 0. - - - - Gets or sets the font size of the labels. The default value is 0 (labels not visible). - - The font size relative to the cell height. - - - - Invalidates the image that renders the heat map. The image will be regenerated the next time the is rendered. - - Call to refresh the view. - - - - Renders the series on the specified render context. - - The rendering context. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Ensures that the axes of the series is defined. - - - - - Updates the maximum and minimum values of the series for the x and y dimensions only. - - - - - Updates the maximum and minimum values of the series. - - - - - Updates the axes to include the max and min of this series. - - - - - Renders the labels. - - The - The bounding rectangle for the data. - - - - Gets the label for the specified cell. - - The value of the cell. - The first index. - The second index. - The label string. - - - - Gets the interpolated value at the specified position in the data array (by bilinear interpolation). - Where interpolation is impossible, return NaN, rather than a calculated nonsense value. - - The data. - The first index. - The second index. - The interpolated value. - - - - Tests if a is inside the heat map - - The to test. - True if the point is inside the heat map. - - - - Updates the image. - - - - - Represents an item in a , a bin (range) and its area. - - - - - Initializes a new instance of the class. - - The range start. - The range end. - The area. - The count. - - - - Initializes a new instance of the class. - - The range start. - The range end. - The area. - The count. - The color. - - - - Gets or sets the range start. - - The range start. - - - - Gets or sets the range end. - - The range end. - - - - Gets or sets the area. - - The area. - - - - Gets the center of the item. - - - - - Gets or sets the count. - - The count. - - - - Gets or sets the color. - - The color. - If set to Automatic, the FillColor of the RectangleBarSeries will be used. - - - - Gets the computed width of the item. - - - - - Gets the computed height of the item. - - The computed height of the item. - - - - Gets the value of the item. Equivalent to the Height. - - The value of the item. - - - - Determines whether the specified point lies within the boundary of the . - - The DataPoint to determine whether or not lies within the boundary of the . - true if the value of the p parameter is inside the bounds of this instance. - - - - Returns C# code that generates this instance. - - The to code. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Represents a series that can be bound to a collection of . - - - - - The default tracker format string. - - - - - The default fill color. - - - - - The items originating from the items source. - - - - - Specifies if the list can be modified. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color of the interior of the bars. - - The color. - - - - Gets the actual fill color. - - The actual color. - - - - Gets or sets the color of the border around the bars. - - The color of the stroke. - - - - Gets or sets the thickness of the bar border strokes. - - The stroke thickness. - - - - Gets the minimum value of the dataset. - - - - - Gets the maximum value of the dataset. - - - - - Gets or sets the format string for the cell labels. The default value is 0.00. - - The format string. - - - - Gets or sets the label margins. - - - - - Gets or sets label placements. - - - - - Gets or sets the delegate used to map from histogram item to color. - - - - - Gets or sets the delegate used to map from to . The default is null. - - The mapping. - Example: series1.Mapping = item => new HistogramItem((double)item.BinStart, (double)item.BinStart + item.BinWidth, (double)item.Count / totalCount, item.Count). - - - - Gets the list of . - - A list of . This list is used if is not set. - - - - Gets the list of that should be rendered. - - A list of . - - - - Renders the series on the specified rendering context. - - The rendering context. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Renders the legend symbol on the specified rendering context. - - The rendering context. - The legend rectangle. - - - - Updates the data. - - - - - Sets the default values. - - - - - Updates the maximum and minimum values of the series for the x and y dimensions only. - - - - - Updates the maximum and minimum values of the series. - - - - - Gets the item at the specified index. - - The index of the item. - The item of the index. - - - - Renders the points as line, broken line and markers. - - The rendering context. - The Items to render. - - - - Gets the fill color of the given . - - The item. - The fill color of the item. - - - - Draws the label. - - The render context. - The column rectangle. - The item. - - - - Tests if a is inside the histogram. - - The to test. - True if the point is inside the heat map. - - - - Clears or creates the list. - - - - - Gets the default color for a HistogramItem. - - The default color. - - - - Updates the points from the . - - - - - Defines functionality to provide a . - - - - - Gets the that represents the element. - - A . - - - - Abstract base class for series that can contain items. - - - - - Gets or sets the items source. The default is null. - - The items source. - - - - Gets the item for the specified index. - - The items source. - The index. - The get item. - Returns null if ItemsSource is not set, or the index is outside the boundaries. - - - - Gets the item at the specified index. - - The index of the item. - The item of the index. - - - - Specifies the position of legends rendered on a . - - - - - Do not render legend on the line. - - - - - Render legend at the start of the line. - - - - - Render legend at the end of the line. - - - - - Represents a line series. - - - - - The divisor value used to calculate tolerance for line smoothing. - - - - - The output buffer. - - - - - The buffer for contiguous screen points. - - - - - The buffer for decimated points. - - - - - The default color. - - - - - The default marker fill color. - - - - - The default line style. - - - - - The smoothed points. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color of the curve. - - The color. - - - - Gets or sets the color of the broken line segments. The default is . Set it to if it should follow the . - - Add DataPoint.Undefined in the Points collection to create breaks in the line. - - - - Gets or sets the broken line style. The default is . - - - - - Gets or sets the broken line thickness. The default is 0 (no line). - - - - - Gets or sets the dash array for the rendered line (overrides ). The default is null. - - The dash array. - If this is not null it overrides the property. - - - - Gets or sets the decimator. - - - The decimator action. - - The decimator can be used to improve the performance of the rendering. See the example. - - - - Gets or sets the label format string. The default is null (no labels). - - The label format string. - - - - Gets or sets the label margins. The default is 6. - - - - - Gets or sets the line join. The default is . - - The line join. - - - - Gets or sets the line style. The default is . - - The line style. - - - - Gets or sets a value specifying the position of a legend rendered on the line. The default is LineLegendPosition.None. - - A value specifying the position of the legend. - - - - Gets or sets the marker fill color. The default is . - - The marker fill. - - - - Gets or sets the a custom polygon outline for the markers. Set to to use this property. The default is null. - - A polyline. - - - - Gets or sets the marker resolution. The default is 0. - - The marker resolution. - - - - Gets or sets the size of the marker. The default is 3. - - The size of the marker. - - - - Gets or sets the marker stroke. The default is OxyColors.Automatic. - - The marker stroke. - - - - Gets or sets the marker stroke thickness. The default is 2. - - The marker stroke thickness. - - - - Gets or sets the type of the marker. The default is MarkerType.None. - - The type of the marker. - If MarkerType.Custom is used, the MarkerOutline property must be specified. - - - - Gets or sets the minimum length of the segment. - Increasing this number will increase performance, - but make the curve less accurate. The default is 2. - - The minimum length of the segment. - - - - Gets or sets a type of interpolation algorithm used for smoothing this . - - Type of interpolation algorithm. - - - - Gets or sets the thickness of the curve. - - The stroke thickness. - - - - Gets the actual color. - - The actual color. - - - - Gets the actual marker fill color. - - The actual color. - - - - Gets the actual line style. - - The actual line style. - - - - Gets the actual dash array for the line. - - - - - Gets the smoothed points. - - The smoothed points. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Renders the series on the specified rendering context. - - The rendering context. - - - - Renders the legend symbol for the line series on the - specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - Sets default values from the plot model. - - - - - Updates the maximum and minimum values of the series. - - - - - Renders the points as line, broken line and markers. - - The rendering context. - The points to render. - - - - Extracts a single contiguous line segment beginning with the element at the position of the enumerator when the method - is called. Initial invalid data points are ignored. - - Current point index - Initially set to null, but I will update I won't give a broken line if this is null - Maximum visible X value - place to put broken segment - place to put contiguous segment - Points collection - - true if line segments are extracted, false if reached end. - - - - - Renders the point labels. - - The render context. - - - - Renders a legend on the line. - - The render context. - - - - Renders the transformed points as a line (smoothed if isn’t null) and markers (if is not None). - - The render context. - The points to render. - - - - Renders a continuous line. - - The render context. - The points to render. - - - - Force the smoothed points to be re-evaluated. - - - - - Represents a line segment. - - - - - Initializes a new instance of the class. - - The first point of the segment. - The second point of the segment. - - - - Gets the first point1 of the segment. - - - - - Gets the second point of the segment. - - - - - Represents a series for pie/circle/doughnut charts. - - The arc length/central angle/area of each slice is proportional to the quantity it represents. - See Pie charts. - - - - The default tracker format string - - - - - The slices. - - - - - The actual points of the slices. - - - - - The total value of all the pie slices. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the angle increment. - - - - - Gets or sets the angle span. - - - - - Gets or sets a value indicating whether inside labels are angled. - - - - - Gets or sets the name of the property containing the color. - - The color field. - - - - Gets or sets the diameter. - - The diameter. - - - - Gets or sets the exploded distance. - - The exploded distance. - - - - Gets or sets the inner diameter. - - The inner diameter. - - - - Gets or sets the color of the inside labels. - - If the value is OxyColors.Automatic, the will be used. - - - - Gets or sets the inside label format. - - The inside label format. - The formatting arguments are: value {0}, label {1} and percentage {2}. - - - - Gets or sets the inside label position. - - The inside label position. - - - - Gets or sets the is exploded field. - - The is exploded field. - - - - Gets or sets the label field. - - The label field. - - - - Gets or sets the legend format. - - The legend format. - - - - Gets or sets the outside label format. - - The outside label format. - - - - Gets or sets the slices. - - The slices. - - - - Gets or sets the start angle. - - The start angle. - - - - Gets or sets the stroke color. - - The stroke color. - - - - Gets or sets the stroke thickness. - - The stroke thickness. - - - - Gets or sets the distance from the edge of the pie slice to the tick line. - - The distance. - - - - Gets or sets the length of the horizontal part of the tick. - - The length. - - - - Gets or sets the distance from the tick line to the outside label. - - The distance. - - - - Gets or sets the length of the radial part of the tick line. - - The length. - - - - Gets or sets the name of the property containing the value. - - The value field. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true . - A TrackerHitResult for the current hit. - - - - Renders the series on the specified render context. - - The rendering context. - - - - Renders the legend symbol on the specified render context. - - The rendering context. - The legend rectangle. - - - - Checks if this data series requires X/Y axes. (e.g. PieSeries does not require axes) - - True if no axes are required. - - - - Ensures that the axes of the series is defined. - - - - - Check if the data series is using the specified axis. - - An axis. - True if the axis is in use. - - - - Sets the default values. - - - - - Updates the maximum and minimum values of the axes used by this series. - - - - - Updates the data. - - - - - Updates the maximum and minimum values of the series. - - - - - Represent a slice of a . - - - - - Initializes a new instance of the class. - - The label. - The value. - - - - Gets or sets the fill color. - - - - - Gets the actual fill color. - - The actual color. - - - - Gets or sets a value indicating whether the slice is exploded. - - - - - Gets the label. - - - - - Gets the value. - - - - - Gets or sets the default fill color. - - The default fill color. - - - - Returns C# code that generates this instance. - - C# code. - - - - Represents an item in a . - - s are transformed to s. - - - - The undefined rectangle item. - - - - - Initializes a new instance of the class. - - The x coordinate of the first corner. - The x coordinate of the diagonally-opposite corner. - The y coordinate of the first corner. - The y coordinate of the diagonally-opposite corner. - The value of the data rect. - - - - Initializes a new instance of the class. - - The first corner. - The diagonally-opposite corner. - The value of the data rect. - - - - Gets the first data point. - - The first data point. - - - - Gets the diagonally-opposite data point. - - The diagonally-opposite data point. - - - - Gets the value of the item. - - The value can be used to color-code the rectangle. - - - - Determines whether the specified point lies within the boundary of the rectangle. - - true if the value of the parameter is inside the bounds of this instance. - - - - Returns C# code that generates this instance. - - The to code. - - - - Determines whether this instance and another specified object have the same value. - - The point to compare to this instance. - true if the value of the parameter is the same as the value of this instance; otherwise, false. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Determines whether this rectangle item is defined. - - true if this point is defined; otherwise, false. - - - - Represents a series that can be bound to a collection of . - - - - - The items originating from the items source. - - - - - Specifies if the list can be modified. - - - - - The default tracker format string - - - - - The default color-axis title - - - - - Initializes a new instance of the class. - - - - - Gets the minimum value of the dataset. - - - - - Gets the maximum value of the dataset. - - - - - Gets or sets the color axis. - - The color axis. - - - - Gets or sets the color axis key. - - The color axis key. - - - - Gets or sets the format string for the cell labels. The default value is 0.00. - - The format string. - The label format string is only used when is greater than 0. - - - - Gets or sets the font size of the labels. The default value is 0 (labels not visible). - - The font size relative to the cell height. - - - - Gets or sets a value indicating whether the tracker can interpolate points. - - - - - Gets or sets the delegate used to map from to . The default is null. - - The mapping. - Example: series1.Mapping = item => new RectangleItem(new DataPoint((MyType)item).Time1, ((MyType)item).Value1), new DataPoint((MyType)item).Time2, ((MyType)item).Value2)); - - - - Gets the list of rectangles. - - A list of . This list is used if is not set. - - - - Gets the list of rectangles that should be rendered. - - A list of . - - - - Renders the series on the specified rendering context. - - The rendering context. - - - - Updates the data. - - - - - Gets the item at the specified index. - - The index of the item. - The item of the index. - - - - Clears or creates the list. - - - - - Updates the points from the . - - - - - Renders the points as line, broken line and markers. - - The rendering context. - The Items to render. - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Ensures that the axes of the series is defined. - - - - - Updates the maximum and minimum values of the series for the x and y dimensions only. - - - - - Updates the maximum and minimum values of the series. - - - - - Updates the axes to include the max and min of this series. - - - - - Tests if a is inside the heat map - - The to test. - True if the point is inside the heat map. - - - - Represents a point in a . - - - - - Initializes a new instance of the class. - - The x. - The y. - The X error. - The Y error. - The size. - The value. - The tag. - - - - Gets the error in X. - - - The error. - - - - - Gets the error in Y. - - - The error. - - - - - Returns C# code that generates this instance. - - C# code. - - - - Represents a series for scatter plots with the possibility to display error bars. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the data field for the X error property. - - - The data field. - - - - - Gets or sets the data field for the Y error property. - - - The data field. - - - - - Gets or sets the color of the error bar. - - - The color of the error bar. - - - - - Gets or sets the width of the error bar stop. - - - The width of the error bar stop. - - - - - Gets or sets the error bar stroke thickness. - - - The error bar stroke thickness. - - - - - Gets or sets the minimum size (relative to ) of the error bars to be shown. - - - The minimum size of the error. - - - - - Renders the series on the specified rendering context. - - - The rendering context. - - - - - Selects all points for which the passed function returns true. - - - The function. - - - - - Updates from data fields. - - - - - Represents a point in a . - - - - - Initializes a new instance of the class. - - The x. - The y. - The size. - The value. - The tag. - - - - Gets the X. - - The X. - - - - Gets the Y. - - The Y. - - - - Gets or sets the size. - - The size. - - - - Gets or sets the value. - - The value. - - - - Gets or sets the tag. - - The tag. - - - - Returns C# code that generates this instance. - - C# code. - - - - Returns a that represents this instance. - - A that represents this instance. - - - - Represents a series for scatter plots. - - See http://en.wikipedia.org/wiki/Scatter_plot - - - - Updates the from the and data fields. - - - - - Provides a base class for scatter series. - - The type of the data points. - - - - The default color-axis title - - - - - The list of data points. - - - - - The default fill color. - - - - - Initializes a new instance of the class. - - - - - Gets the list of points. - - A list of . - If the is specified, this list will not be used. - - - - Gets or sets the label format string. The default is null (no labels). - - The label format string. - - - - Gets or sets the label margins. The default is 6. - - - - - Gets or sets a function that maps from elements in the to points to be rendered. - - The mapping function. The default is null. - Example: series1.Mapping = item => new DataPoint(((MyType)item).Time,((MyType)item).Value); - - - - - Gets or sets the size of the 'binning' feature. - If this number is greater than 1, bins of the specified is created for both x and y directions. Only one point will be drawn in each bin. - - - The size of the bins. The default is 0 - no binning. - - - - - Gets the actual color axis. - - A . - This is used to map scatter point values to colors. Use the to specify a color axis. - If the is not specified, the first of the will be used. - - - - Gets or sets the color axis key. - - The color axis key. The default is null. - If set to null, the first of the will be used. - Make sure that the points contains values. - If your contains a , but you don't want to use a color axis, set the value to string.Empty or some other key that is not in use. - - - - Gets or sets the name of the property that specifies X coordinates in the elements. - - The name of the property. The default is null. - - - - Gets or sets the name of the property that specifies Y coordinates in the elements. - - The name of the property. The default is null. - - - - Gets or sets the name of the property that specifies the size in the elements. - - The name of the property. The default is null. - - - - Gets or sets the name of the property that specifies the tag in the elements. - - The name of the property. The default is null. - - - - Gets or sets the name of the property that specifies the color value in the elements. - - The name of the property. The default is null. - - - - Gets or sets the marker fill color. If null, this color will be automatically set. - - The fill color of the markers. The default is . - - - - Gets the actual fill color. - - The actual color. - - - - Gets or sets the custom marker outline polygon. Set to to use this. - - A polyline. The default is null. - - - - Gets or sets the size of the marker (same size for all items). - - The size of the markers. The default is 5. - - - - Gets or sets the marker stroke. - - The marker stroke. The default is . - - - - Gets or sets thickness of the the marker strokes. - - The thickness. The default is 1. - - - - Gets or sets the type of the marker. - - The type of the marker. The default is . - If is used, the property must be specified. - - - - Gets the maximum value of the points. - - - - - Gets the minimum value of the points. - - - - - Gets the actual points. - - - A read-only list of points. - - - - - Gets the list of points that should be rendered. - - A list of . - - - - Gets or sets the data points from the items source. - - - - - Gets or sets a value indicating whether the list can be modified. - - - - - Gets the nearest point. - - The point. - interpolate if set to true . - A TrackerHitResult for the current hit. - - - - - - - Renders the legend symbol for the line series on the specified rendering context. - - The rendering context. - The bounding rectangle of the legend box. - - - - Ensures that the axes of the series is defined. - - - - - Sets the default values. - - - - - Updates the data. - - - - - Updates the maximum and minimum values of the series. - - - - - Renders the point labels. - - The render context. - The clipping rectangle. - - - - Updates the Max/Min limits from the values in the specified point list. - - The points. - - - - Updates the Max/Min limits from the values in the specified point list. - - The points. - - - - Clears or creates the list. - - - - - Updates the from the and data fields. - - - - - Updates the points from the . - - - - - Provides an abstract base class for plot series. - - This class contains internal methods that should be called only from the PlotModel. - - - - Initializes a new instance of the class. - - - - - Gets or sets the background color of the series. The default is OxyColors.Undefined. - - This property defines the background color in the area defined by the x and y axes used by this series. - - - - Gets or sets a value indicating whether this series is visible. The default is true. - - - - - Gets or sets the title of the series. The default is null. - - The title that is shown in the legend of the plot. The default value is null. - - - - Gets or sets the key for the Legend to use on this series. The default is null. - - - This key may be used by the plot model to show a custom Legend for the series. - - - - - Gets or sets the groupname for the Series. The default is null. - - - This groupname may for e.g. be used by the Legend class to group series into separated blocks. - - - - - Gets or sets a value indicating whether the series should be rendered in the legend. The default is true. - - - - - Gets or sets a format string used for the tracker. The default depends on the series. - - - The arguments for the format string may be different for each type of series. See the documentation. - - - - - Gets or sets the key for the tracker to use on this series. The default is null. - - - This key may be used by the plot view to show a custom tracker for the series. - - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Renders the series on the specified render context. - - The rendering context. - - - - Renders the legend symbol on the specified render context. - - The rendering context. - The legend rectangle. - - - - Checks if this data series requires X/Y axes. (e.g. Pie series do not require axes) - - true if axes are required. - - - - Ensures that the axes of the series are defined. - - - - - Checks if the data series is using the specified axis. - - The axis that should be checked. - true if the axis is in use. - - - - Sets the default values (colors, line style etc.) from the plot model. - - - - - Updates the maximum and minimum values of the axes used by this series. - - - - - Updates the data of the series. - - - - - Updates the maximum and minimum values of the series. - - This method is called when the is updated with the updateData parameter set to true. - - - - When overridden in a derived class, tests if the plot element is hit by the specified point. - - The hit test arguments. - - The result of the hit test. - - - - - Represents a series for stair step graphs. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the stroke thickness of the vertical line segments. - - The vertical stroke thickness. - Set the value to NaN to use the StrokeThickness property for both horizontal and vertical segments. - Using the VerticalStrokeThickness property will have a small performance hit. - - - - Gets or sets the line style of the vertical line segments. - - The vertical line style. - - - - Gets the nearest point. - - The point. - interpolate if set to true . - A TrackerHitResult for the current hit. - - - - Renders the LineSeries on the specified rendering context. - - The rendering context. - - - - Represents a series that plots discrete data in a stem plot. - - See Stem plot and - stem. - - - - Initializes a new instance of the class. - - - - - Gets or sets Base. - - - - - Gets the point on the series that is nearest the specified point. - - The point. - Interpolate the series if this flag is set to true. - A TrackerHitResult for the current hit. - - - - Renders the LineSeries on the specified rendering context. - - The rendering context. - - - - Represents a two-color line series. - - - - - The default low color. - - - - - The default hi color. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color for the part of the line that is below the limit. - - - - - Gets or sets the color for the part of the line that is above the limit. - - - - - Gets the actual hi color. - - The actual color. - - - - Gets the actual low color. - - The actual color. - - - - Gets or sets the high limit. - - The parts of the line that is below this limit will be rendered with ColorHi. - The parts of the line that is above the limit will be rendered with Color. - - - - Gets or sets the low limit. - - The parts of the line that is below this limit will be rendered with ColorLo. - The parts of the line that is above the limit will be rendered with Color. - - - - Gets or sets the dash array for the rendered line that is above the limit (overrides ). - - The dash array. - If this is not null it overrides the property. - - - - Gets or sets the dash array for the rendered line that is below the limit (overrides ). - - The dash array. - If this is not null it overrides the property. - - - - Gets or sets the line style for the part of the line that is above the limit. - - The line style. - - - - Gets or sets the line style for the part of the line that is below the limit. - - The line style. - - - - Gets the actual line style for the part of the line that is above the limit. - - The line style. - - - - Gets the actual line style for the part of the line that is below the limit. - - The line style. - - - - Gets the actual dash array for the line that is above the limit. - - - - - Gets the actual dash array for the line that is below the limit. - - - - - Sets the default values. - - - - - - - - Represents a two-color area series. - - - - - The default second color. - - - - - The collection of points above the limit. - - - - - The collection of points below the limit. - - - - - Start index of a visible rendering window for markers. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the area fill color below the limit line. - - The fill below the limit line. - - - - Gets the actual fill color below the limit line. - - The actual fill below the limit line. - - - - Gets the actual second color. - - The actual color. - - - - Gets or sets the dash array for the rendered line that is below the limit (overrides ). - - The dash array. - If this is not null it overrides the property. - - - - Gets or sets the line style for the part of the line that is below the limit. - - The line style. - - - - Gets the actual line style for the part of the line that is below the limit. - - The line style. - - - - Gets the actual dash array for the line that is below the limit. - - - - - Gets or sets the marker fill color which is below the limit line. The default is . - - The marker fill. - - - - Gets or sets the marker stroke which is below the limit line. The default is OxyColors.Automatic. - - The marker stroke. - - - - Gets or sets a baseline for the series. - - - - - Gets the nearest point. - - The point. - Interpolate if set to true . - A TrackerHitResult for the current hit. - - - - - - - Sets the default values. - - - - - The update data. - - - - - Renders a chunk of points on the screen. - - Render context. - Screen points. - The list of resampled points. - - - - Splits a collection of points into two collections based on their Y value. - - A collection of points to split. - - - - Gets the screen points when baseline is used. - - The list of polygon screen points. - Baseline Y value for the polygon. - A sequence of . - - - - Gets interpolated X coordinate for given Y on a straight line - between two points. - - First point. - Second point. - Y coordinate. - Corresponding X coordinate. - - - - Render context for two color area plot. - - - - - Gets or sets area baseline value. - - - - - Gets or sets polygon fill color. - - - - - Gets or sets marker fill color. - - - - - Gets or sets marker stroke color. - - - - - Represents a two-color line series. - - - - - The default second color. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the color for the part of the line that is below the limit. - - - - - Gets the actual second color. - - The actual color. - - - - Gets or sets the limit. - - The parts of the line that is below this limit will be rendered with Color2. - The parts of the line that is above the limit will be rendered with Color. - - - - Gets or sets the dash array for the rendered line that is below the limit (overrides ). - - The dash array. - If this is not null it overrides the property. - - - - Gets or sets the line style for the part of the line that is below the limit. - - The line style. - - - - Gets the actual line style for the part of the line that is below the limit. - - The line style. - - - - Gets the actual dash array for the line that is below the limit. - - - - - Sets the default values. - - - - - - - - Provides an abstract base class for series that are related to an X-axis and a Y-axis. - - - - - The default tracker format string - - - - - The default x-axis title - - - - - The default y-axis title - - - - - Initializes a new instance of the class. - - - - - Gets or sets the maximum x-coordinate of the dataset. - - The maximum x-coordinate. - - - - Gets or sets the maximum y-coordinate of the dataset. - - The maximum y-coordinate. - - - - Gets or sets the minimum x-coordinate of the dataset. - - The minimum x-coordinate. - - - - Gets or sets the minimum y-coordinate of the dataset. - - The minimum y-coordinate. - - - - Gets the x-axis. - - The x-axis. - - - - Gets or sets the x-axis key. The default is null. - - The x-axis key. - - - - Gets the y-axis. - - The y-axis. - - - - Gets or sets the y-axis key. The default is null. - - The y-axis key. - - - - Gets or sets a value indicating whether the X coordinate of all data point increases monotonically. - - - - - Gets or sets the last visible window start position in the data points collection. - - - - - - - - Gets the rectangle the series uses on the screen (screen coordinates). - - The rectangle. - - - - - - - Renders the legend symbol on the specified rendering context. - - The rendering context. - The legend rectangle. - - - - - - - Check if this data series requires X/Y axes. (e.g. Pie series do not require axes) - - The are axes required. - - - - Ensures that the axes of the series is defined. - - - - - Check if the data series is using the specified axis. - - An axis. - True if the axis is in use. - - - - Sets default values from the plot model. - - - - - Updates the axes to include the max and min of this series. - - - - - Updates the data. - - - - - Updates the maximum and minimum values of the series. - - - - - Gets the point on the curve that is nearest the specified point. - - The point list. - The point. - A tracker hit result if a point was found. - The Text property of the result will not be set, since the formatting depends on the various series. - - - - Gets the point on the curve that is nearest the specified point. - - The point list. - The index to start from. - The point. - A tracker hit result if a point was found. - The Text property of the result will not be set, since the formatting depends on the various series. - - - - Gets the nearest point. - - The points (data coordinates). - The point (screen coordinates). - A if a point was found, null otherwise. - The Text property of the result will not be set, since the formatting depends on the various series. - - - - Gets the nearest point. - - The points (data coordinates). - The index to start from. - The point (screen coordinates). - A if a point was found, null otherwise. - The Text property of the result will not be set, since the formatting depends on the various series. - - - - Determines whether the specified point is valid. - - The point. - true if the point is valid; otherwise, false . - - - - Determines whether the specified point is valid. - - The x coordinate. - The y coordinate. - true if the point is valid; otherwise, false . - - - - Updates the Max/Min limits from the specified list. - - The list of points. - - - - Updates the Max/Min limits from the specified list. - - The type of the elements in the list. - The items. - A function that provides the x value for each item. - A function that provides the y value for each item. - The items argument cannot be null. - - - - Updates the Max/Min limits from the specified collection. - - The type of the items in the collection. - The items. - A function that provides the x minimum for each item. - A function that provides the x maximum for each item. - A function that provides the y minimum for each item. - A function that provides the y maximum for each item. - The items argument cannot be null. - - - - Verifies that both axes are defined. - - - - - Updates visible window start index. - - The type of the list items. - Data points. - Function that gets data point X coordinate. - X coordinate of visible window start. - Last window index. - The new window start index. - - - - Finds the index of max(x) <= target x in a list of data points - - The type of the list items. - vector of data points - Function that gets data point X coordinate. - target x. - initial guess index. - - index of x with max(x) <= target x or 0 if cannot find - - - - - Provides functionality to export plots to scalable vector graphics. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the width (in user units) of the output area. - - - - - Gets or sets the height (in user units) of the output area. - - - - - Gets or sets a value indicating whether the xml headers should be included. - - - - - Gets or sets a value indicating whether to use a workaround for vertical text alignment to support renderers with limited support for the dominate-baseline attribute. - - - - - Gets or sets the text measurer. - - - - - Exports the specified model to a stream. - - The model. - The output stream. - The width (points). - The height (points). - if set to true, the xml headers will be included (?xml and !DOCTYPE). - The text measurer. - Whether to use the workaround for vertical text alignment - - - - Exports to string. - - The model. - The width (points). - The height (points). - if set to true, the xml headers will be included (?xml and !DOCTYPE). - The text measurer. - The plot as an SVG string. - Whether to use the workaround for vertical text alignment - - - - Exports the specified to a . - - The model to export. - The target stream. - - - - Exports the specified to a string. - - The model. - the SVG content as a string. - - - - Provides a render context for scalable vector graphics output. - - - - - The writer. - - - - - The disposed flag. - - - - - Initializes a new instance of the class. - - The stream. - The width. - The height. - Create an SVG document if set to true. - The text measurer. - The background. - Whether to use the workaround for vertical text alignment. - - - - Gets or sets the text measurer. - - The text measurer. - - - - Gets or sets a value indicating whether to use a workaround for vertical text alignment to support renderers with limited support for the dominate-baseline attribute. - - - - - Closes the svg writer. - - - - - Completes the svg element. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - - - - - - - - - - - - - Draws the text. - - The p. - The text. - The c. - The font family. - Size of the font. - The font weight. - The rotate. - The horizontal alignment. - The vertical alignment. - Size of the max. - - - - Flushes this instance. - - - - - Measures the text. - - The text. - The font family. - Size of the font. - The font weight. - The text size. - - - - Draws the specified portion of the specified at the specified location and with the specified size. - - The source. - The x-coordinate of the upper-left corner of the portion of the source image to draw. - The y-coordinate of the upper-left corner of the portion of the source image to draw. - Width of the portion of the source image to draw. - Height of the portion of the source image to draw. - The x-coordinate of the upper-left corner of drawn image. - The y-coordinate of the upper-left corner of drawn image. - The width of the drawn image. - The height of the drawn image. - The opacity. - Interpolate if set to true. - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - - - - - - - Represents a writer that provides easy generation of Scalable Vector Graphics files. - - - - - The end is written. - - - - - The clip path number - - - - - Initializes a new instance of the class. - - The stream. - The width (in user units). - The height (in user units). - if set to true, the writer will write the xml headers (?xml and !DOCTYPE). - - - - Gets or sets a value indicating whether this writer should produce a stand-alone document. - - - - - Gets or sets the number format. - - The number format. - - - - Closes the svg document. - - - - - Writes the end of the document. - - - - - Creates a style. - - The fill color. - The stroke color. - The stroke thickness (in user units). - The line dash array. - The line join type. - A style string. - - - - Writes an ellipse. - - The x-coordinate of the center. - The y-coordinate of the center. - The width. - The height. - The style. - The edge rendering mode. - - - - Sets a clipping rectangle. - - The x coordinate of the clipping rectangle. - The y coordinate of the clipping rectangle. - The width of the clipping rectangle. - The height of the clipping rectangle. - - - - Resets the clipping rectangle. - - - - - Writes a portion of the specified image. - - The x-coordinate of the upper-left corner of the portion of the source image to draw. - The y-coordinate of the upper-left corner of the portion of the source image to draw. - Width of the portion of the source image to draw. - Height of the portion of the source image to draw. - The destination x-coordinate. - The destination y-coordinate. - Width of the destination rectangle. - Height of the destination rectangle. - The image. - - - - Writes the specified image. - - The x-coordinate. - The y-coordinate. - The width of the image. - The height of the image. - The image. - - - - Writes a line. - - The first point. - The second point. - The style. - The edge rendering mode. - - - - Writes a polygon. - - The points. - The style. - The edge rendering mode. - - - - Writes a polyline. - - The points. - The style. - The edge rendering mode. - - - - Writes a rectangle. - - The x coordinate. - The y coordinate. - The width. - The height. - The style. - The edge rendering mode. - - - - Writes text. - - The position. - The text. - The text color. - The font family. - The font size (in user units). - The font weight. - The rotation angle. - The horizontal alignment. - The vertical alignment. - - - - Converts a color to a svg color string. - - The color. - The color string. - - - - Writes an double attribute. - - The name. - The value. - - - - Writes the edge rendering mode attribute if necessary. - - The edge rendering mode. - - - - Converts a value to a string or to the specified "auto" string if the value is NaN. - - The value. - The string to return if value is NaN. - A string. - - - - Converts a list of points to a string. - - The points. - A string. - - - - Writes the header. - - The width. - The height. - - - - Provides functionality to build arrays. - - - - - Creates a vector. - - The first value. - The last value. - The number of steps. - A vector. - - - - Creates a vector. - - The first value. - The last value. - The step size. - A vector. - - - - Evaluates the specified function. - - The function. - The x values. - The y values. - Array of evaluations. The value of f(x_i,y_j) will be placed at index [i, j]. - - - - Fills the array with the specified value. - - The array to fill. - The value. - - - - Fills the two-dimensional array with the specified value. - - The two-dimensional array. - The value. - - - - Provides useful extension methods for arrays. - - - - - Finds the maximum value in the sequence, or returns a default value if the sequence is empty. - - The sequence. - The default value. - The maximum value of the sequence, or the default value if the sequency is empty. - - - - Finds the minimum value in the sequence, or returns a default value if the sequence is empty. - - The sequence. - The default value. - The minimum value of the sequence, or the default value if the sequency is empty. - - - - Finds the maximum value in the specified 2D array (NaN values not included). - - The array. - The maximum value. - - - - Finds the minimum value in the specified 2D array. - - The array. - Exclude NaN values if set to true. - The minimum value. - - - - Provides extension methods to the . - - - - - Reads a string of the specified length (in bytes). - - The reader. - The length. - The encoding. - The string. - - - - Reads an unsigned 32-bit integer. - - The reader. - Read as little endian (Intel convention) if set to true. - The unsigned integer. - - - - Reads a signed 32-bit integer. - - The reader. - Read as little endian (Intel convention) if set to true. - The signed integer. - - - - Reads an unsigned 16-bit integer. - - The reader. - Read as little endian (Intel convention) if set to true. - The unsigned integer. - - - - Reads an 64-bit floating point value. - - The reader. - Read as little endian (Intel convention) if set to true. - The floating point number. - - - - Reads an array of unsigned 32-bit integers. - - The reader. - The number of values to read. - Read as little endian (Intel convention) if set to true. - The unsigned integer array. - - - - Reads an array of unsigned 16-bit integers. - - The reader. - The number of values to read. - Read as little endian (Intel convention) if set to true. - The unsigned integer array. - - - - Reads a big endian (Motorola convention) unsigned 32-bit integer. - - The reader. - The unsigned integer. - - - - Reads a big endian (Motorola convention) signed 32-bit integer. - - The reader. - The signed integer. - - - - Reads a big endian (Motorola convention) unsigned 16-bit integer. - - The reader. - The unsigned integer. - - - - Reads a big endian (Motorola convention) 64-bit floating point number. - - The reader. - A . - - - - Specifies the behaviour for handling elements which cannot be assigned to any bin. - - - - - Throws an if any element cannot be assigned to any bin. - - - - - Counts outliers when computing statistics. - - - - - Ignores outliers when computing statistics. - - - - - Specifies the type of bounds used for binning. - - - - - Bins have an incusive lower bound. - - - - - Bins have an incusive upper bound. - - - - - Specifies the behaviour for handing extreme values which would be excluded by an exclusive bound. - - - - - Extreme values should be excluded if they do not fall on an inclusive bound. - - - - - Extreme values should always be included. - - - - - Represents options for methods that perform binning. - - - - - Initializes a new instance of the class. - - Specifies the behaviour for handling elements which cannot be assigned to any bin. - The type of interval that each bin represents. - Specifies whether extreme values should be assigned to the corresponding extreme bin. - - - - Gets a value specififying the behaviour for handling elements which cannot be assigned to any bin. - - - - - Gets a value specififying the type of interval that each bin represents. - - - - - Gets a value specififying the behaviour for handing extreme values which would be excluded by an exclusive bound. - - - - - Provides functionality to create custom comparers. - - - - - Creates a based on the specified comparison. - - The type of the elements to compare. - The delegate used to compare elements. - The created comparer. - - - - A comparer that uses a delegate to compare elements. - - The type of the elements to compare. - - - - The delegate used to compare elements. - - - - - Initializes a new instance of the class. - - The delegate used to compare elements. - - - - Compares two elements. - - The first element to compare. - The second element to compare. - A value indicating whether is less than, equal to, or greater than . - - - - Provides functionality to create contours from a triangular mesh. - - - Ported from C / Fortran code by Paul Bourke. - See Conrec for - full description of code and the original source. - - - Contouring aids in visualizing three dimensional surfaces on a two dimensional - medium (on paper or in this case a computer graphics screen). Two most common - applications are displaying topological features of an area on a map or the air - pressure on a weather map. In all cases some parameter is plotted as a function - of two variables, the longitude and latitude or x and y axis. One problem with - computer contouring is the process is usually CPU intensive and the algorithms - often use advanced mathematical techniques making them susceptible to error. - - - - - Renderer delegate - - Start point x-coordinate - Start point y-coordinate - End point x-coordinate - End point y-coordinate - Contour level - - - - Contour is a contouring subroutine for rectangularily spaced data - It emits calls to a line drawing subroutine supplied by the user - which draws a contour map corresponding to data on a randomly - spaced rectangular grid. The coordinates emitted are in the same - units given in the x() and y() arrays. - Any number of contour levels may be specified but they must be - in order of increasing value. - - Matrix of data to contour. - Data matrix column coordinates. - Data matrix row coordinates. - Contour levels in increasing order. - The renderer. - - - - Provides functionality to generate fraction strings from double values. - - Examples: "3/4", "PI/2" - - - - Converts a double to a fraction string. - - The value. - The unit. - The unit symbol. - The tolerance. - The format Provider. - The format string. - The convert to fraction string. - - - - Provides functionality to calculate hash codes. - - - - - Calculates a hash code for the specified sequence of items. - - A sequence of items. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Provides general helper functions. - - - - - Switches the values of two specified variables. - - The type of the variables. - The first value. - The second value. - - - - Gets the nearest tracker hit. - - The series. - The point. - Snap to points. - Check points only (no interpolation). - The distance from the series at which the tracker fires - The value indicating whether to check distance - when showing tracker between data points. - - is ignored if is equal to False. - - A tracker hit result. - - - - Provides methods to collect data samples into bins for use with a . - - - - - Generates a list of bin breaks, uniformly distributed between and . - - The inclusive lower-bound of the first bin. - The exclusive upper-bound of the last bin, which must be strictly greater than . - The number of bins to create. - An containing the breaks between bins of uniform size. - - - - Collects samples into tightly packed bins () defined by . - - The samples to collect into bins. - The start and end values for the bins. - The binning options to use. - A list of corresponding to the generated bins with areas computed from the proportion of samples placed within. - - - - Provides functionality to build a list by reflecting specified properties on a sequence. - - The target list item type. - This class uses reflection. - - - - The properties. - - - - - The default values - - - - - Initializes a new instance of the class. - - - - - Adds a property. - - The type of the property. - Name of the property. - The default value. - - - - Fills the specified target list. - - The target. - The source. - The instance creator. - - - - Fills the specified target list. - - The target. - The source list. - The instance creator. - - - - Provides functionality to reflect a path of properties. - - - - - The path items. - - - - - The property metadata. - - - - - The reflected types. - - - - - Initializes a new instance of the class. - - The reflection path. - - - - Gets the value for the specified instance. - - The instance. - - The value. - - Could not find property. - - - - Tries to get the value for the specified instance. - - The instance. - The result. - - true if the value was found. - - - - - Provides useful extension methods for streams. - - - - - Copies to the specified stream. - - The input stream. - The output stream. - - - - Provides extended string formatting functionality. - - - - - The formatting expression. - - - - - Replaces the format items in the specified string. - - The culture specific format provider. - The format string. - The item. - The values. - The formatted string. - The format string and values works as in String.Format. - In addition, you can format properties of the item object by using the syntax - {PropertyName:Formatstring}. - E.g. if you have a "Value" property in your item's class, use "{Value:0.00}" to output the value with two digits. - Note that this formatting is using reflection and does not have the same performance as string.Format. - - - - Creates a valid format string on the form "{0:###}". - - The input format string. - The corrected format string. - - - - Formats each item in a sequence by the specified format string and property. - - The source target. - The property name. - The format string. The format argument {0} can be used for the value of the property in each element of the sequence. - The format provider. - Could not find property. - - - - Splits the given text into separate lines. - - The text to split. - An array of the individual lines. - - - - Provides extension methods for types. - - - - - Retrieves an object that represents a specified property. - - The type that contains the property. - The name of the property. - An object that represents the specified property, or null if the property is not found. - - - - Provides an abstract base class for exporters that write xml. - - - - - The xml writer. - - - - - The disposed flag. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The stream. - - - - Closes this instance. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Flushes this instance. - - - - - Writes an attribute string. - - The name. - The value. - - - - Writes an attribute string with a prefix. - - The prefix. - The name. - The constant. - The value. - - - - Writes the doc type. - - The name of the DOCTYPE. This must be non-empty. - If non-null it also writes PUBLIC "pubid" "sysid" where pubid and sysid are replaced with the value of the given arguments. - If pubid is null and sysid is non-null it writes SYSTEM "sysid" where sysid is replaced with the value of this argument. - If non-null it writes [subset] where subset is replaced with the value of this argument. - - - - Writes an element string. - - The name. - The text. - - - - Writes the end document. - - - - - Writes an element end tag. - - - - - Writes raw text. - - The text. - - - - Writes the start document. - - The standalone. - - - - Writes an element start tag. - - The name. - - - - Writes an element tag with the specified name and namespace. - - The name. - The ns. - - - - Writes a string. - - The text. - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - -
    -
    diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC5DLL.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC5DLL.dll deleted file mode 100644 index a0797db..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC5DLL.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC5DLLx64.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC5DLLx64.dll deleted file mode 100644 index e6c13bf..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC5DLLx64.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC5_2024_09_27/RTC5DLL.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC5_2024_09_27/RTC5DLL.dll deleted file mode 100644 index 697dca4..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC5_2024_09_27/RTC5DLL.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC5_2024_09_27/RTC5DLLx64.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC5_2024_09_27/RTC5DLLx64.dll deleted file mode 100644 index 781bf85..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC5_2024_09_27/RTC5DLLx64.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC6DLL.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC6DLL.dll deleted file mode 100644 index d234f7f..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC6DLL.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC6DLLx64.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC6DLLx64.dll deleted file mode 100644 index 4c0f3be..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/RTC6DLLx64.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/SeqAutoRunPTOP.gv b/Machines/_out_prismatic_rd_ptop/x64-Debug/SeqAutoRunPTOP.gv deleted file mode 100644 index 7033781..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/SeqAutoRunPTOP.gv +++ /dev/null @@ -1,42 +0,0 @@ -digraph G { - graph [fontname="Malgun Gothic"] - node [fontname="Malgun Gothic"] - edge [fontname="Malgun Gothic"] - { - "#INIT#" [label="" shape=circle style=filled color=black] - "#FINAL#" [label="" shape=doublecircle] - "#FORCE_ERROR#" [shape=oval] - "[SeqAutoRunPTOP] SEQ_ENTER" [shape=oval] - "[SeqAutoRunPTOP] Check Init Condition" [shape=diamond] - "[SeqAutoRunPTOP] CHECK PageNo" [shape=oval] - "[SeqAutoRunPTOP] CHECK PageNo Complete" [shape=oval] - "[SeqAutoRunPTOP] Set Sequence Param (UploadWeldingList Seq)" [shape=oval] - "[SeqAutoRunPTOP] Process (UploadWeldingList Seq)" [shape=rpromoter] - "[SeqAutoRunPTOP] Get Sequence Result (UploadWeldingList Seq)" [shape=oval] - "[SeqAutoRunPTOP] Check Welding Start ReadBit" [shape=oval] - "[SeqAutoRunPTOP] Wait Welding Start" [shape=oval] - "[SeqAutoRunPTOP] Execute Welding" [shape=oval] - "[SeqAutoRunPTOP] Check Cycle Stop" [shape=diamond] - "[SeqAutoRunPTOP] Save Result Data" [shape=oval] - "[SeqAutoRunPTOP] Write Completion PLC Bit" [shape=oval] - "[SeqAutoRunPTOP] SEQ_COMPLETE" [shape=oval] - } - "#FORCE_ERROR#" -> "#FINAL#"; - "#INIT#" -> "[SeqAutoRunPTOP] SEQ_ENTER"; - "[SeqAutoRunPTOP] Check Cycle Stop" -> "[SeqAutoRunPTOP] CHECK PageNo"; - "[SeqAutoRunPTOP] Check Cycle Stop" -> "[SeqAutoRunPTOP] Save Result Data"; - "[SeqAutoRunPTOP] Check Init Condition" -> "[SeqAutoRunPTOP] CHECK PageNo"; - "[SeqAutoRunPTOP] Check Init Condition" -> "[SeqAutoRunPTOP] SEQ_COMPLETE"; - "[SeqAutoRunPTOP] CHECK PageNo" -> "[SeqAutoRunPTOP] CHECK PageNo Complete"; - "[SeqAutoRunPTOP] CHECK PageNo Complete" -> "[SeqAutoRunPTOP] Set Sequence Param (UploadWeldingList Seq)"; - "[SeqAutoRunPTOP] Check Welding Start ReadBit" -> "[SeqAutoRunPTOP] Wait Welding Start"; - "[SeqAutoRunPTOP] Execute Welding" -> "[SeqAutoRunPTOP] Check Cycle Stop"; - "[SeqAutoRunPTOP] Get Sequence Result (UploadWeldingList Seq)" -> "[SeqAutoRunPTOP] Check Welding Start ReadBit"; - "[SeqAutoRunPTOP] Process (UploadWeldingList Seq)" -> "[SeqAutoRunPTOP] Get Sequence Result (UploadWeldingList Seq)"; - "[SeqAutoRunPTOP] Save Result Data" -> "[SeqAutoRunPTOP] Write Completion PLC Bit"; - "[SeqAutoRunPTOP] SEQ_COMPLETE" -> "#FINAL#"; - "[SeqAutoRunPTOP] SEQ_ENTER" -> "[SeqAutoRunPTOP] Check Init Condition"; - "[SeqAutoRunPTOP] Set Sequence Param (UploadWeldingList Seq)" -> "[SeqAutoRunPTOP] Process (UploadWeldingList Seq)"; - "[SeqAutoRunPTOP] Wait Welding Start" -> "[SeqAutoRunPTOP] Execute Welding"; - "[SeqAutoRunPTOP] Write Completion PLC Bit" -> "[SeqAutoRunPTOP] SEQ_COMPLETE"; -} diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/SeqAutoRunPTOP.pdf b/Machines/_out_prismatic_rd_ptop/x64-Debug/SeqAutoRunPTOP.pdf deleted file mode 100644 index dfddd77..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/SeqAutoRunPTOP.pdf and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/SeqAutoRunTDC.gv b/Machines/_out_prismatic_rd_ptop/x64-Debug/SeqAutoRunTDC.gv deleted file mode 100644 index 4ff9701..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/SeqAutoRunTDC.gv +++ /dev/null @@ -1,42 +0,0 @@ -digraph G { - graph [fontname="Malgun Gothic"] - node [fontname="Malgun Gothic"] - edge [fontname="Malgun Gothic"] - { - "#INIT#" [label="" shape=circle style=filled color=black] - "#FINAL#" [label="" shape=doublecircle] - "#FORCE_ERROR#" [shape=oval] - "[SeqAutoRunTDC] SEQ_ENTER" [shape=oval] - "[SeqAutoRunTDC] Check Init Condition" [shape=diamond] - "[SeqAutoRunTDC] CHECK PageNo" [shape=oval] - "[SeqAutoRunTDC] CHECK PageNo Complete" [shape=oval] - "[SeqAutoRunTDC] Set Sequence Param (UploadWeldingList Seq)" [shape=oval] - "[SeqAutoRunTDC] Process (UploadWeldingList Seq)" [shape=rpromoter] - "[SeqAutoRunTDC] Get Sequence Result (UploadWeldingList Seq)" [shape=oval] - "[SeqAutoRunTDC] Check Welding Start ReadBit" [shape=oval] - "[SeqAutoRunTDC] Wait Welding Start" [shape=oval] - "[SeqAutoRunTDC] Execute Welding" [shape=oval] - "[SeqAutoRunTDC] Check Cycle Stop" [shape=diamond] - "[SeqAutoRunTDC] Save Result Data" [shape=oval] - "[SeqAutoRunTDC] Write Completion PLC Bit" [shape=oval] - "[SeqAutoRunTDC] SEQ_COMPLETE" [shape=oval] - } - "#FORCE_ERROR#" -> "#FINAL#"; - "#INIT#" -> "[SeqAutoRunTDC] SEQ_ENTER"; - "[SeqAutoRunTDC] Check Cycle Stop" -> "[SeqAutoRunTDC] CHECK PageNo"; - "[SeqAutoRunTDC] Check Cycle Stop" -> "[SeqAutoRunTDC] Save Result Data"; - "[SeqAutoRunTDC] Check Init Condition" -> "[SeqAutoRunTDC] CHECK PageNo"; - "[SeqAutoRunTDC] Check Init Condition" -> "[SeqAutoRunTDC] SEQ_COMPLETE"; - "[SeqAutoRunTDC] CHECK PageNo" -> "[SeqAutoRunTDC] CHECK PageNo Complete"; - "[SeqAutoRunTDC] CHECK PageNo Complete" -> "[SeqAutoRunTDC] Set Sequence Param (UploadWeldingList Seq)"; - "[SeqAutoRunTDC] Check Welding Start ReadBit" -> "[SeqAutoRunTDC] Wait Welding Start"; - "[SeqAutoRunTDC] Execute Welding" -> "[SeqAutoRunTDC] Check Cycle Stop"; - "[SeqAutoRunTDC] Get Sequence Result (UploadWeldingList Seq)" -> "[SeqAutoRunTDC] Check Welding Start ReadBit"; - "[SeqAutoRunTDC] Process (UploadWeldingList Seq)" -> "[SeqAutoRunTDC] Get Sequence Result (UploadWeldingList Seq)"; - "[SeqAutoRunTDC] Save Result Data" -> "[SeqAutoRunTDC] Write Completion PLC Bit"; - "[SeqAutoRunTDC] SEQ_COMPLETE" -> "#FINAL#"; - "[SeqAutoRunTDC] SEQ_ENTER" -> "[SeqAutoRunTDC] Check Init Condition"; - "[SeqAutoRunTDC] Set Sequence Param (UploadWeldingList Seq)" -> "[SeqAutoRunTDC] Process (UploadWeldingList Seq)"; - "[SeqAutoRunTDC] Wait Welding Start" -> "[SeqAutoRunTDC] Execute Welding"; - "[SeqAutoRunTDC] Write Completion PLC Bit" -> "[SeqAutoRunTDC] SEQ_COMPLETE"; -} diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/SeqAutoRunTDC.pdf b/Machines/_out_prismatic_rd_ptop/x64-Debug/SeqAutoRunTDC.pdf deleted file mode 100644 index 71c3cdb..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/SeqAutoRunTDC.pdf and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/SkiaSharp.HarfBuzz.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/SkiaSharp.HarfBuzz.dll deleted file mode 100644 index a7a00fb..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/SkiaSharp.HarfBuzz.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/SkiaSharp.HarfBuzz.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/SkiaSharp.HarfBuzz.xml deleted file mode 100644 index 09590d9..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/SkiaSharp.HarfBuzz.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - SkiaSharp.HarfBuzz - - - - Various extension methods to integrate SkiaSharp and a HarfBuzz . - - - - The stream to convert into a . - Converts a seekable stream into a . - Returns the new instance. - - - - Various extension methods to integrate a SkiaSharp and HarfBuzz. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The canvas to draw on. - The text shaper to use when shaping the text. - The text to draw. - The x-coordinate of the origin of the text being drawn. - The y-coordinate of the origin of the text being drawn. - The paint to use when drawing the text. - Draws shaped text on the canvas at the specified coordinates. - - - - Various extension methods to integrate SkiaSharp and a HarfBuzz . - - - - The font to retrieve the scale. - Retrieves the font scale. - Returns the font scale. - - - - The font to set the scale. - The scale to set. - Sets the font scale. - - - - Encapsulates basic text shaping. - - - - The typeface to use for the text shaping. - Creates a new instance using the specified typeface. - - - - Releases all resources used by this . - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The text to shape. - The paint to use. - Shapes the specified text using the properties from the paint. - Returns the results of the shaping operation. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The text to shape. - The x-offset to use when creating the shaping result. - The y-offset to use when creating the shaping result. - The paint to use. - Shapes the specified text using the properties from the paint. - Returns the results of the shaping operation. - - - - Gets the typeface used when creating the shaper. - - - - - Represents the result of a shaping operation. - - - - Creates a new instance using empty values. - - - - The glyph Unicode code points. - The glyph clusters. - The glyph positions. - Creates a new instance using the specified values. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets the glyph clusters. - - - - - Gets the glyph Unicode code points. - - - - - Gets the glyph positions. - - - - - To be added. - To be added. - To be added. - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/SkiaSharp.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/SkiaSharp.dll deleted file mode 100644 index 8040a46..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/SkiaSharp.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/SkiaSharp.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/SkiaSharp.xml deleted file mode 100644 index e9f0192..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/SkiaSharp.xml +++ /dev/null @@ -1,21959 +0,0 @@ - - - SkiaSharp - - - - Possible 3D APIs that may be used by Ganesh. - - - - To be added. - - - To be added. - - - Use the Metal 3D backend. (not yet supported) - - - Use the OpenGL 3D backend. - - - Use the Vulkan 3D backend. (not yet supported) - - - Wrap an existing render target created by the client in the 3D API. - - object wrapping -it. - -We require the client to explicitly provide information about the target, such -as width, height, and pixel configuration, rather than querying the 3D API for -these values. We expect these properties to be immutable even if the 3D API -doesn't require this (eg: OpenGL). -]]> - - - - The backend to use. - The description of the backend render target. - Creates a new with the properties from the specified description. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The width of the render target. - The height of the render target. - The number of samples per pixel. - The number of bits of stencil per pixel. - The OpenGL framebuffer information. - Creates a new OpenGL with the specified properties and framebuffer. - - - - Gets the backend for this render target. - - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - Returns the framebuffer info that this object wraps. - Returns the framebuffer info, if this object wraps an OpenGL framebuffer, otherwise an empty info instance. - - - - The framebuffer info, if this object wraps an OpenGL framebuffer. - Returns the framebuffer info that this object wraps. - Returns true if this object wraps an OpenGL framebuffer, otherwise false. - - - - Gets the height in pixels. - - - - - Gets a value indicating whether or not the was initialized. - - - - - Gets a rectangle with the current width and height. - - - - - Gets the number of samples per pixel. - - This is used to influence decisions about applying other forms of anti-aliasing. - - - Gets the current size of the 3D API object. - - - - - Gets the number of bits of stencil per-pixel. - - - - - Gets the width in pixels. - - - - - Wrap an existing render target created by the client in the 3D API with an underlying GRRenderTarget object. - - - - - - Gets or sets the color format. - - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Gets or sets the height in pixels. - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the pixel origin. - - - - - Gets a rectangle with the current width and height. - - - - - Gets or sets the handle to the 3D API object. - - When using OpenGL, it is the FBO ID. - - - Gets or sets the number of samples per pixel. - - This is used to influence decisions about applying other forms of anti-aliasing. - - - Gets the current size of the 3D API object. - - - - - Gets or sets the number of bits of stencil per pixel. - - - - - Gets or sets the width in pixels. - - - - - Various flags for the method. - - - - Reset all the context state for any backend. - - - Reset nothing. - - - Wrap an existing texture created by the client in the 3D API. - - object wrapping -it. - -We require the client to explicitly provide information about the target, such -as width, height, and pixel configuration, rather than querying the 3D API for -these values. We expect these properties to be immutable even if the 3D API -doesn't require this (eg: OpenGL). -]]> - - - - The description of the backend texture. - Creates a new with the properties from the specified description. - - - - The description of the backend texture. - Creates a new with the properties from the specified description. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The width of the render target. - The height of the render target. - Whether or not the texture is mipmapped. - The OpenGL texture information. - Creates a new OpenGL with the specified properties and texture. - - - - Gets the backend for this texture. - - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - Returns the texture info that this object wraps. - Returns the texture info, if this object wraps an OpenGL texture, otherwise an empty info instance. - - - - The texture info, if this object wraps an OpenGL texture. - Returns the texture info that this object wraps. - Returns true if this object wraps an OpenGL texture, otherwise false. - - - - Gets a value indicating whether this texture is mipmapped. - - - - - Gets the height in pixels. - - - - - Gets a value indicating whether or not the was initialized. - - - - - Gets a rectangle with the current width and height. - - - - - Gets the current size of the 3D API object. - - - - - Gets the width in pixels. - - - - - Wrap an existing texture created by the client in the 3D API with an underlying GRTexture object. - - - - - - Gets or sets the color format. - - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Gets or sets additional options about the texture. - - - - - To be added. - To be added. - To be added. - - - Gets or sets the height in pixels. - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the pixel origin. - - - - - To be added. - To be added. - To be added. - - - Gets or sets the number of samples per pixel. - - If the render target flag is set and sample count is greater than 0, then an MSAA buffer that resolves to the texture will be created. - - - To be added. - To be added. - To be added. - - - Gets or sets the handle to the 3D API object. - - When using OpenGL, it is the Texture ID. - - - Gets or sets the width in pixels. - - - - - Additional options for a backend texture. - - - - No flags enabled. - - - Indicates that the texture is also a render target. - - - Represents an underlying backend 3D API context. - - - - Use true to indicate that the underlying 3D context is not yet lost and the will cleanup all allocated resources before returning. Using false will ensure that the destructors of the and any of its created resource objects will not make backend 3D API calls. - Abandons all GPU resources and assumes the underlying backend 3D API context is not longer usable. After returning it will assume that the underlying context may no longer be valid. - - - - Gets the backend that this context is wrapping. - - - - - The backend to use. - Creates a for a backend context using the default interface for the specified backend. - Returns the new if one was created, otherwise . - - - - The backend to use. - The backend interface to use. - Creates a for a backend context. - Returns the new if one was created, otherwise . - - - - The backend to use. - The backend interface to use. - Creates a for a backend context. - Returns the new if one was created, otherwise . - - - - The backend to use. - The backend interface to use. - The context-creation options. - Creates a for a backend context. - Returns the new if one was created, otherwise . - - - - The backend to use. - The backend interface to use. - The context-creation options. - Creates a for a backend context. - Returns the new if one was created, otherwise . - - - - Creates a for an OpenGL context. - Returns the new if one was created, otherwise . - - - - To be added. - To be added. - To be added. - To be added. - - - The OpenGL interface to use. - Creates a for an OpenGL context. - Returns the new if one was created, otherwise . - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Call to ensure all drawing to the context has been issued to the underlying 3D API. - - - - To be added. - To be added. - To be added. - To be added. - - - The color type. - Get the maximum supported sample count for the specified color type. - Returns the maximum supported sample count. - 1 is returned if only non-MSAA rendering is supported for the color type. 0 is returned if rendering to this color type is not supported at all. - - - The configuration of the render target. - The display density in dots per inch. - Returns the recommended sample count for a render target when using this context. - Returns the recommended sample count. - May return 0 if MSAA is not supported or recommended to be used by default. - - - To be added. - To be added. - To be added. - - - The maximum number of resources that can be held in the cache. - The maximum number of bytes of video memory that can be held in the cache. - Returns the current GPU resource cache limits. - - - - The number of resources that are held in the cache. - The total number of bytes of video memory held in the cache. - Returns the current GPU resource cache usage. - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Flags to control what is reset. - Informs the context that the state was modified and should resend. - The context normally assumes that no outsider is setting state within the underlying 3D API's context/device/whatever. This method shouldn't be called frequently for good performance. - - - Flags to control what is reset. - Informs the context that the state was modified and should resend. - The context normally assumes that no outsider is setting state within the underlying 3D API's context/device/whatever. This method shouldn't be called frequently for good performance. - - - Flags to control what is reset. - Informs the context that the state was modified and should resend. - The context normally assumes that no outsider is setting state within the underlying 3D API's context/device/whatever. This method shouldn't be called frequently for good performance. - - - To be added. - To be added. - To be added. - - - The maximum number of resources that can be held in the cache. - The maximum number of bytes of video memory that can be held in the cache. - Specify the GPU resource cache limits. - If the current cache exceeds either of these, it will be purged (LRU) to keep the cache within these limits. - - - To be added. - To be added. - To be added. - - - Represents the collection of options for the construction of a context. - - - - To be added. - To be added. - - - Gets or sets a value indicating whether to allow path mask textures to be cached. - - This is only really useful if paths are commonly rendered at the same scale and fractional translation. Default is false. - - - Gets or sets a value indicating whether to avoid allocating stencil buffers. - - Bugs on certain drivers cause stencil buffers to leak. This flag causes Skia to avoid allocating stencil buffers and use alternate rasterization paths, avoiding the leak. - - - Gets or sets the threshold, in bytes, above which a buffer mapping API will be used to map vertex and index buffers to CPU memory in order to update them. - - A value of -1 means the context should deduce the optimal value for this platform. Default is -1. - - - Gets a new instance with the values set to the defaults. - - - - - Gets or sets a value indicating whether the GPU will be used to perform YUV -> RGB conversion when generating textures from codec-backed images. - - Default is false. - - - Gets or sets a value indicating whether to construct mipmaps manually, via repeated downsampling draw-calls. - - This is used when the driver's implementation (glGenerateMipmap) contains bugs. This requires mipmap level and LOD control (for example, desktop or ES3). Default is false. - - - Gets or sets a value indicating whether to enable instanced rendering as long as all required functionality is supported by the hardware. - - Instanced rendering is still experimental at this point and disabled by default. Default is false. - - - Gets or sets the maximum size of cache textures used for the SkiaSharp Glyph cache. - - Default is 2048 * 1024 * 4. - - - Gets or sets the GPU path renderers. - - Default is . - - - Gets or sets a value indicating whether the context operates in immediate mode. - - The context will issue all draws to the backend API immediately. Intended to ease debugging. Default is false. - - - Gets or sets the maximum size of a texture. - - An option to override feature detection using backend API queries. The override can only reduce the feature set or limits, never increase them beyond the detected values. Default is 0x7FFFFFFF. - - - Gets or sets the maximum size (if non-zero) of a tile for software-backed images and bitmaps rendered by the device. - - An option to override feature detection using backend API queries. The override can only reduce the feature set or limits, never increase them beyond the detected values. Default is 0. - - - Gets or sets a value indicating whether sRGB support will be disabled if sRGB decoding cannot be enabled. - - Default is true. - - - To be added. - To be added. - To be added. - - - Gets or sets a value indicating whether to suppress dual source blending. - - Default is false. - - - Gets or sets a value indicating whether the caps will never report driver support for path rendering. - - Default is false. - - - Gets or sets a value indicating whether to suppress prints for the . - - Default is false. - - - Gets or sets a value indicating whether to avoid partial writes. - - Some GPUs have problems with partial writes of the render target. Default is false. - - - Gets or sets a value indicating whether to do all swizzling manually in the shader and don't rely on extensions to do swizzling. - - Default is false. - - - Gets or sets a value indicating whether to render everything in wireframe. - - Default is false. - - - Various GPU path renderers for use with . - - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - Always use software masks. - - - To be added. - - - To be added. - - - To be added. - - - Various flags for the method when using a backend. - - - - Reset all the context state. - - - Reset the blend state. - - - Reset the fixed function state. - - - Reset miscellaneous state. - - - Reset the MSAA state - - - Reset nothing. - - - Reset the path rendering state. - - - Reset the pixel store state. - - - Reset the program state. - - - Reset the render target. - - - Reset the stencil state. - - - Reset the texture binding state. - - - Reset the vertex buffer state. - - - Reset the scissor and viewport state. - - - Wrap an existing OpenGL texture created by the client in the 3D API with an underlying GRTexture object. - - The client is responsible for ensuring that the texture lives at least as long as the GRTexture object wrapping it. - We require the client to explicitly provide information about the texture, such as width, height, and pixel configuration, rather than querying the 3D API for these values. We expect these to be immutable even if the 3D API doesn't require this (OpenGL). - Textures that are also render targets are supported as well. Any ancillary 3D API (stencil buffer, FBO id, etc) objects necessary will be managed. - - - - Gets or sets the color format. - - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Gets or sets additional options about the texture. - - - - - To be added. - To be added. - To be added. - - - Gets or sets the height in pixels. - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the pixel origin. - - - - - To be added. - To be added. - To be added. - - - Gets or sets the number of samples per pixel. - - - - - To be added. - To be added. - To be added. - - - Gets or sets the handle to the OpenGL texture. - - - - - Gets or sets the width in pixels. - - - - - Represents a handle to an existing OpenGL framebuffer. - - - - The OpenGL framebuffer ID. - Creates a new with the specified parameters. - - - - The OpenGL framebuffer ID. - The sized, internal format of the OpenGL framebuffer. - Creates a new with the specified parameters. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the sized, internal format of the OpenGL framebuffer. - - - - - Gets or sets the OpenGL framebuffer ID. - - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The user data passed to the assembling methods of . - The name of the endpoint to locate. - The delegate that is used when locating the various endpoints of an OpenGL implementation. - - - - - To be added. - To be added. - To be added. - To be added. - - - The is used to interface with OpenGL. - A does not interact directly with the underlying backend, instead it uses an OpenGL interface. - - - The delegate used to locate entry points. - Assemble an ANGLE using the specified delegate. - Returns the new , or if one could not be created. - - - - The user data to use in the delegate. - The delegate used to locate entry points. - Assemble an ANGLE using the specified context and delegate. - Returns the new , or if one could not be created. - - - - The delegate used to locate entry points. - Assemble an OpenGL ES using the specified delegate. - Returns the new , or if one could not be created. - - - - The user data to use in the delegate. - The delegate used to locate entry points. - Assemble an OpenGL ES using the specified context and delegate. - Returns the new , or if one could not be created. - - - - The delegate used to locate entry points. - Assemble an OpenGL using the specified delegate. - Returns the new , or if one could not be created. - - - - The user data to use in the delegate. - The delegate used to locate entry points. - Assemble an OpenGL using the specified context and delegate. - Returns the new , or if one could not be created. - - - - The delegate used to locate entry points. - Assemble an platform-specific using the specified delegate. - Returns the new , or if one could not be created. - - - - The user data to use in the delegate. - The delegate used to locate entry points. - Assemble an platform-specific using the specified context and delegate. - Returns the new , or if one could not be created. - - - - Returns a copy of the current interface. - Returns a copy. - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Create a using the platform-default OpenGL implementation. - Returns the new , or if one could not be created. - On Windows, this is typically ANGLE, on mobile it is typically OpenGL ES and on desktop it is typically OpenGL. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Create a using the ANGLE OpenGL implementation. - Returns the new , or if one could not be created. - - - - The pointer to the Evas_GL object to use. - Create a using the Evas OpenGL implementation. - Returns the new , or if one could not be created. - - - - Create a using the platform OpenGL implementation. - Returns the new , or if one could not be created. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - The extension to check for. - Checks to see if the underlying OpenGL backend has the specified extension. - Returns true if the backend has the extension, otherwise false. - - - - Validates that the supports its advertised standard. - Returns true if all the entry points are specified, and any required extensions exist. - - - - Represents a handle to an existing OpenGL texture. - - - - To be added. - To be added. - To be added. - To be added. - - - The OpenGL texture target. - The OpenGL texture ID. - The sized, internal format of the OpenGL texture. - Creates a new with the specified parameters. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the sized, internal format of the OpenGL texture. - - - - - To be added. - To be added. - To be added. - - - Gets or sets the OpenGL texture ID. - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the OpenGL texture target. - - - - - Various pixel configurations supported. - - - - To be added. - - - 8-bit Alpha. - - - To be added. - - - To be added. - - - Single 16-bit float channel. - - - To be added. - - - To be added. - - - Premultiplied 32-bit channel. Byte order is BGRA. - - - 8-bit grayscale color channel. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - 16-bit channel. Byte order is RGB. - - - Premultiplied, opaque 32-bit color with the format RGB, with 8 bits per color component. - - - To be added. - - - Premultiplied 32-bit color with the format RGBA, with 10 bits per color component and 2 bits for the alpha component. - - - To be added. - - - Premultiplied 16-bit channel. Byte order is RGBA. - - - Premultiplied 32-bit channel. Byte order is RGBA. - - - Premultiplied 32-bit (signed) channel. Byte order is BGRA. - - - 32-bit channel. Byte order is RGBA. - - - 16-bit channel. Byte order is RGBA. - - - To be added. - - - To be added. - - - 32-bit channel. Byte order is RG. - - - To be added. - - - Premultiplied and sRGB. Byte order is BGRA. - - - Premultiplied and sRGB. Byte order is RGBA. - - - The pixel configuration is not known or not set. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - The origin of a texture. - - - - Origin is at the bottom-left. - - - Origin is at the top-left. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - A utility class that can be used to create 3D transformations. - - - - - - Creates a new instance of . - - - - The canvas to apply the transformation to. - Applies the current transformation to the specified canvas. - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - The x-axis of the normal. - The y-axis of the normal. - The z-axis of the normal. - Returns the dot product of the current transformation and the specified normal. - Returns the dot product. - - - - The matrix to store the transformation. - Stores the current transformation in the specified matrix. - - - - Gets the current transformation as a matrix. - - - - - Restores the transformation to the last saved with . - - - - The degrees to rotate by. - Rotates the transformation along the x-axis by the specified degrees. - - - - The radians to rotate by. - Rotates the transformation along the x-axis by the specified radians. - - - - The degrees to rotate by. - Rotates the transformation along the y-axis by the specified degrees. - - - - The radians to rotate by. - Rotates the transformation along the y-axis by the specified radians. - - - - The degrees to rotate by. - Rotates the transformation along the z-axis by the specified degrees. - - - - The radians to rotate by. - Rotates the transformation along the z-axis by the specified radians. - - - - Saves the current transformation so that it can be restored later using . - - - - The amount to translate by along the x-axis. - The amount to translate by along the y-axis. - The amount to translate by along the z-axis. - Translates the transformation. - - - - The amount to translate by. - Translates the transformation along the x-axis. - - - - The amount to translate by. - Translates the transformation along the y-axis. - - - - The amount to translate by. - Translates the transformation along the z-axis. - - - - Represents a (a seekable, rewindable Skia stream). - - - - Creates a new instance of . - - - - The value indicating whether this object should destroy the underlying native object. - Creates a new instance of . - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - Implemented by derived types to copy the current stream. - Returns a pointer to the new instance. - - - - Implemented by derived types to duplicate the current stream. - Returns a pointer to the new instance. - After the stream has been duplicated, the new stream must set it's position to the start. - - - Implemented by derived types to fork the current stream. - Returns a pointer to the new instance. - After the stream has been duplicated, the new stream must set it's position to the same as this stream. - - - Implemented by derived types to return the total length of the stream. - Returns the total length of the stream. - - - - Implemented by derived types to get the current position in the stream - Returns the current position in the stream. - - - - Implemented by derived types to indicate whether this stream can report it's total length. - Returns a value indicating whether this stream can report it's total length. - - - - Implemented by derived types to indicate whether this stream can report it's current position. - Returns a value indicating whether this stream can report it's current position. - - - - Implemented by derived types to indicate whether all the bytes in the stream have been read. - Returns a value indicating whether all the bytes in the stream have been read. - - - - The relative offset. - Implemented by derived types to seek to a relative offset. - Returns true if seeking is supported and the seek was successful, otherwise false. - If an attempt is made to move to a position outside the stream, the position must be set to the closest point within the stream (beginning or end). - - - The buffer to read into. - The number of bytes to read. - Implemented by derived types to copy the specified number of bytes into the specified buffer. - Returns the number of bytes actually peeked/copied. - The stream's cursor must be returned to the position before this method was called. - - - The buffer to read into. - The number of bytes to read. - Implemented by derived types to copy the specified number of bytes into the specified buffer. - Returns the number of bytes actually read. - - - - Implemented by derived types to rewind the current stream. - Returns true if the stream is known to be at the beginning after this call returns. - - - - The absolute position. - Implemented by derived types to seek to an absolute position. - Returns true if seeking is supported and the seek was successful, otherwise false. - If an attempt is made to move to a position outside the stream, the position must be set to the closest point within the stream (beginning or end). - - - Represents a (a writeable Skia stream). - - - - Creates a new instance of . - - - - The value indicating whether this object should destroy the underlying native object. - Creates a new instance of . - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - Implemented by derived types to specify the number of bytes currently written to the stream. - Returns the number of bytes currently written to the stream. - - - - Implemented by derived types to flush the bytes to the underlying stream. - - - - The buffer to copy into the underlying stream. - The number of bytes to copy from the buffer. - Implemented by derived types to copy the specified number of bytes from the specified buffer into the underlying stream. - Returns on success, otherwise . - - - - Describes how to interpret the alpha component of a pixel. - - - - All pixels are stored as opaque. - - - - All pixels have their alpha premultiplied in their color components. - This is the natural format for the rendering target pixels. - - - - - - - - All pixels have their color components stored without any regard to the alpha. e.g. this is the default configuration for PNG images. - This alpha-type is ONLY supported for input images. Rendering cannot generate this on output. - - - - Convenience class used to restore the canvas state in a using statement. - - method restore the canvas state to -the state it was when this instance was created. - -## Examples - -```csharp -SKCanvas canvas = ...; - -using (new SKAutoCanvasRestore(canvas)) { - // perform some transform - canvas.RotateDegrees(45); - - // draw as usual - var paint = new SKPaint (); - canavs.DrawRect (10, 10, 100, 100, paint); - - // automatically restore to original transform -} -``` -]]> - - - - The canvas whose state will be preserved. - Creates a canvas restore point, invoking the method. - - - - The canvas whose state will be preserved. - Whether or not to invoke method at this point. - Creates a canvas restore point. - - - - - Disposes the canvas restore point, restoring the state of the canvas (matrix, clip and draw filter) to the state it was when the object was created. - This operation will not do anything if you had previously manually called the method. - - - - - Restores the canvas restore point, restoring the state of the canvas (matrix, clip and draw filter) to the state it was when the object was creatd. - - - - Convenience class used to automatically initialize and uninitialize COM on supported platforms. - - This is only supported on Windows, and is usually not needed. However, when creating a .NET Core app, COM may not be initialized. - Currently, only and more specifically, XPS documents require COM. - - - - Initializes COM. - - - - Uninitializes COM. - - - - Gets a value indicating whether COM is initialized or not. - - - - - Uninitializes COM. - - - - Convenience class used to automatically free the image data for a mask in a using statement. - - method. - -## Examples - -```csharp -// some buffer -byte[] buffer = ...; - -// create the mask, allocating the image -var mask = SKMask.Create(buffer, bounds, rowBytes, format); -using (new SKAutoMaskFreeImage(mask.Image)) { - // use the mask - - // automatically release the image data -} -``` -]]> - - - - The image to free. - Create a new instance of with the specified image to free. - - - - Disposes the object, releasing the image data. - - - - The specifies a raster bitmap. - - A bitmap has an integer width and height, and a format (color type), and a pointer to the actual pixels. Bitmaps can be drawn into a , but they are also used to specify the target of a ' drawing operations. - A exposes , which lets a caller write its pixels. To retrieve a pointer to the raw image data of the bitmap, call the method, and then call the method to get a pointer to the image data. Once you no longer need to use the raw data pointer, call the method. The raw data is laid out in the format configured at the time that the bitmap was created. - (Note: As of SkiaSharp 1.60.0, calls to and are no longer required, and they no longer exist as part of the API.) - - - - Default constructor that creates a bitmap with zero width and height, and no pixels. Its color type is set to . - This constructor does not allocate a backing store for the bitmap. - - - The description of the desired image format. - Constructor that configures the bitmap based on an specification. - This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table). - - - The description of the desired image format. - The additional flags. - Constructor that configures the bitmap based on an specification. - This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table). - - - The description of the desired image format. - The color lookup table. - Constructor that configures the bitmap based on an specification and a color table. - Use this method to create a bitmap that will use a color lookup table. The bitmap will be an 8-bit indexed bitmap, where each value represents an index into the color table, and the color is determined by the value in the specific location in the color table array. - - - The description of the desired image format. - The number of bytes per row. - Constructor that configures the bitmap based on an specification, and the specified number of bytes per row (the stride size) - This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table). - - - The description of the desired image format. - The color lookup table. - The additional flags. - Constructor that configures the bitmap based on an specification and a color table. - Use this method to create a bitmap that will use a color lookup table. The bitmap will be an 8-bit indexed bitmap, where each value represents an index into the color table, and the color is determined by the value in the specific location in the color table array. - - - The desired width in pixels. - The desired height in pixels. - If true, sets the to , otherwise it sets it to . - Creates a bitmap with the given width, height and opacity with color type set to - This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table). - - - The desired width in pixels. - The desired height in pixels. - The desired . - The desired . - Creates a bitmap with the given width, height, color type and alpha type. - This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table). - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets the configured for the bitmap. - The configured . - This determines the kind of encoding used for the alpha channel, opaque, premultiplied or unpremultiplied. - - - Returns the byte size of the pixels, based on the and . - The byte size of the pixels. - Note: this truncates the result to 32-bits. - - - Gets a copy of all the pixel data as a byte array. - The pixel data. - - - - Gets the number of bytes used per pixel. - - This is calculated from the . If the color type is , then the value will be 0. - - - The color type to check with. - Returns true if this bitmap's pixels can be converted into the requested color type, such that or could succeed. - Returns true if this bitmap's pixels can be converted into the requested color type. - - - - Gets the color space of the bitmap. - - - - - Gets the color table of the bitmap. - - - - - Gets the color type of the bitmap. - - - - - Copies the contents of the bitmap and returns the copy. - The copy of the bitmap, or on error. - - - - The color type to use for the copy of the bitmap. - Copies the contents of the bitmap with the specified color type and returns the copy. - The copy of the bitmap, or on error. - - - - The bitmap to received the copied contents. - Copies the contents of the bitmap into the specified bitmap. - Returns true if the copy was made. - - - - The bitmap to received the copied contents. - The color type to use for the copy of the bitmap. - Copies the contents of the bitmap into the specified bitmap. - Returns true if the copy was made. - - - - The codec to decode. - Decode a bitmap using the specified codec. - The decoded bitmap, or on error. - - - - The data to decode. - Decode a bitmap using the specified data. - The decoded bitmap, or on error. - - - - The stream to decode. - Decode a bitmap using the specified stream. - The decoded bitmap, or on error. - - - - The byte buffer to decode. - Decode a bitmap using the specified byte buffer. - The decoded bitmap, or on error. - - - - The stream to decode. - Decode a bitmap using the specified stream and destination image information. - The decoded bitmap, or on error. - - - - To be added. - To be added. - To be added. - To be added. - - - The filename of the bitmap to decode. - Decode a bitmap for the specified filename. - The decoded bitmap, or on error. - - - - The codec to decode. - The destination image information. - Decode a bitmap using the specified codec and destination image information. - The decoded bitmap, or on error. - - - - The data to decode. - The destination image information. - Decode a bitmap using the specified data and destination image information. - The decoded bitmap, or on error. - - - - The stream to decode. - The destination image information. - Decode a bitmap using the specified stream and destination image information. - The decoded bitmap, or on error. - - - - The byte buffer to decode. - The destination image information. - Decode a bitmap using the specified byte buffer and destination image information. - The decoded bitmap, or on error. - - - - The stream to decode. - The destination image information. - Decode a bitmap using the specified stream and destination image information. - The decoded bitmap, or on error. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The filename of the bitmap to decode. - The destination image information. - Decode a bitmap for the specified filename and destination image information. - The decoded bitmap, or on error. - - - - The data to decode. - Decode the bitmap information using the specified data. - The decoded bitmap information, or if there was an error. - - - - The stream to decode. - Decode the bitmap information using the specified stream. - The decoded bitmap information, or if there was an error. - - - - The byte buffer to decode. - Decode the bitmap information using the specified byte buffer. - The decoded bitmap information, or if there was an error. - - - - The stream to decode. - Decode the bitmap information using the specified stream. - The decoded bitmap information, or if there was an error. - - - - To be added. - To be added. - To be added. - To be added. - - - The filename of the bitmap to decode. - Decode the bitmap information for the specified filename. - The decoded bitmap information, or if there was an error. - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - Gets a value indicating whether drawing this bitmap has any effect. - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The stream to write the encoded image to. - The file format used to encode the image. - The quality level to use for the image. - Encodes the image using the specified format. - Returns on success, or if there was an error. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The color to fill. - Fill the entire bitmap with the specified color. - If the bitmap's color type does not support alpha (e.g. 565) then the alpha of the color is ignored (treated as opaque). If the color type only supports alpha (e.g. A1 or A8) then the color's R, G, B components are ignored. - - - The color to fill. - The area to fill. - Fill the specified area of this bitmap with the specified color. - If the bitmap's color type does not support alpha (e.g. 565) then the alpha of the color is ignored (treated as opaque). If the color type only supports alpha (e.g. A1 or A8) then the color's R, G, B components are ignored. - - - The bitmap to be filled with alpha layer. - Retrieve the alpha layer of this bitmap. - Returns true if the alpha layer was retrieved, false otherwise. - - - - The bitmap to be filled with alpha layer. - The paint to draw with. - Retrieve the alpha layer of this bitmap after applying the specified paint. - Returns true if the alpha layer was retrieved, false otherwise. - - - - The bitmap to be filled with alpha layer. - The top-left coordinate to position the retrieved bitmap so that it visually lines up with the original. - Retrieve the alpha layer of this bitmap. - Returns true if the alpha layer was retrieved, false otherwise. - - - - The bitmap to be filled with alpha layer. - The paint to draw with. - The top-left coordinate to position the retrieved bitmap so that it visually lines up with the original. - Retrieve the alpha layer of this bitmap after applying the specified paint. - Returns true if the alpha layer was retrieved, false otherwise. - - - - The bitmap that will be set to a subset of this bitmap. - The rectangle of pixels in this bitmap that the destination will reference. - Retrieve a subset of this bitmap. - Returns true if the subset was retrieved, false otherwise. - If possible, the retrieved bitmap will share the pixel memory, and just point into a subset of it. However, if the color type does not support this, a local copy will be made and associated with the destination bitmap. - - - The image to use to create a bitmap. - Creates a new bitmap from a copy of the pixel data in the specified image. - Returns a new instance of , or null if the bitmap could not be created. - - - - The x-coordinate of the pixel. - The y-coordinate of the pixel. - Returns the address of the specified pixel. - Returns the address of the specified pixel. - - - - The x-coordinate of the pixel. - The y-coordinate of the pixel. - Returns the 16-bit value of the specified pixel. - Returns the 16-bit value of the specified pixel. - - - - The x-coordinate of the pixel. - The y-coordinate of the pixel. - Returns the 32-bit value of the specified pixel. - Returns the 32-bit value of the specified pixel. - - - - The x-coordinate of the pixel. - The y-coordinate of the pixel. - Returns the 8-bit value of the specified pixel. - Returns the 8-bit value of the specified pixel. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The x-cordinate. - The y-cordinate. - Returns the color corresponding to the pixel specified by the coordinates for palette-based (color table) bitmaps. - Returns the color corresponding to the pixel specified by the coordinates. - - - - The x-cordinate. - The y-cordinate. - Returns the color for the pixel at the specified location. - Alpha only color types return black with the appropriate alpha set. The value is undefined for , if the coordinates are out of bounds, if the bitmap does not have any pixels, or has not be locked with . - In most cases this will require unpremultiplying the color. - - - Returns the address of the pixels for this bitmap. - Returns a pointer to the region that contains the pixel data for this bitmap. This might return if there is no pixel buffer associated with this bitmap. - - - - The length of the pixel buffer of the bitmap. - Returns the address of the pixels for this bitmap. - Returns a pointer to the region that contains the pixel data for this bitmap. This might return if there is no pixel buffer associated with this bitmap. - - - - Returns a span that wraps the pixel data. - Returns the span. - This span is only valid as long as the bitmap is valid - - - Gets the height of the bitmap. - - - - - Gets an instance of with all the properties of the bitmap. - - - - - The mask to install. - Installs the specified mask's pixels into the bitmap. - Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty. - The caller must ensure that the specified mask pixels are valid for the lifetime of the created bitmap. - - - The pixels to install. - Installs the specified pixels into the bitmap. - Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty. - - - - The image information describing the pixels. - The pixels to install. - Installs the specified pixels into the bitmap. - Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty. - - - - The image information describing the pixels. - The pixels to install. - The stride of the pixels being installed. - Installs the specified pixels into the bitmap. - Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty. - - - - The image information describing the pixels. - The pixels to install. - The stride of the pixels being installed. - The delegate to invoke when the pixels are no longer referenced. - Installs the specified pixels into the bitmap. - Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty. - - - - The image information describing the pixels. - The pixels to install. - The stride of the pixels being installed. - The color table to use, if installing Index8 pixels. - Installs the specified pixels into the bitmap. - Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty. - - - - The image information describing the pixels. - The pixels to install. - The stride of the pixels being installed. - The delegate to invoke when the pixels are no longer referenced. - The user data to use when invoking the delegate. - Installs the specified pixels into the bitmap. - Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty. - - - - The image information describing the pixels. - The pixels to install. - The stride of the pixels being installed. - Pixel8 is no longer supported. - The delegate to invoke when the pixels are no longer referenced. - The user data to use when invoking the delegate. - Developers should not use this obsolete method. - Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty. - - - - Gets a value indicating whether the bitmap has empty dimensions. - - In most cases, will return the desired result as it checks as well. - - - Indicates if the bitmap contents are immutable. - Returns if it is immutable, otherwise. - Immutability means that the contents of its pixels will not change for the lifetime of the bitmap. - - - Gets a value indicating whether the bitmap has any pixelref. - - This can return true even if the dimensions of the bitmap are not empty. In most cases, will return the desired result as it checks as well. - - - Gets a value indicating whether the bitmap should not be cached by devices. - - - - - Indicates to consumers of the bitmap that the pixel data has changed. - - - - Returns the pixels if they are available without having to lock the bitmap. - Returns the pixels if they are available, otherwise . - If the pixels are available without locking, then the pixmap is only valid until the bitmap changes in any way, in which case the pixmap becomes invalid. - - - The pixmap to receive the pixel information. - Returns the pixmap of the bitmap. - Returns on success, or if the bitmap does not have access to pixel data. - - - - Gets all the pixels as an array of colors. - - - - - Gets a value indicating whether or not the bitmap is valid enough to be drawn. - - - - - Reset the bitmap to its initial state. - The result is a bitmap with zero width and height, and no pixels. Its color type is set to . If we are a (shared) owner of the pixels, that ownership is decremented. - - - The bitmap to store the resized pixels. - The resize method. - Resizes the current bitmap using the specified resize method. - Returns if the resize operation can be performed, otherwise . - - - - The image information of the desired bitmap. - The resize method. - Resizes the current bitmap using the specified resize method. - Returns the resized bitmap if the resize operation could be performed, otherwise . - - - - The image information of the desired bitmap. - The level of quality to use when scaling the pixels. - Resizes the current bitmap using the specified quality filter. - Returns the resized bitmap if the resize operation could be performed, otherwise . - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The bitmap to store the resized pixels. - The bitmap to resize. - The resize method. - Resizes the provided bitmap using the specified resize method. - Returns if the resize operation can be performed, otherwise . - - - - The number of bytes per row. - - The same as . - - - The bitmap to recieve the scaled and converted pixels. - The level of quality to use when scaling the pixels. - Copies this pixmap to the destination, scaling the pixels to fit the destination size and converting the pixels to match the color type and alpha type. - Returns on success, or if there was an error. - - , or -, the destination color type must match. -If the color type is , destination -colorspace must also match. - -If the alpha type is , the destination -alpha type must match. - -If the colorspace is `null`, the destination colorspace must also be `null`. - -Filter Quality: - - - is fastest, typically implemented - with nearest neighbor filter. - - is typically implemented with bilerp - filter. - - is typically implemented with - bilerp filter, and mipmap when size is reduced. - - is slowest, typically implemented - with the bicubic filter.]]> - - - - The pixmap to recieve the scaled and converted pixels. - The level of quality to use when scaling the pixels. - Copies this pixmap to the destination, scaling the pixels to fit the destination size and converting the pixels to match the color type and alpha type. - Returns on success, or if there was an error. - - , or -, the destination color type must match. -If the color type is , destination -colorspace must also match. - -If the alpha type is , the destination -alpha type must match. - -If the colorspace is `null`, the destination colorspace must also be `null`. - -Filter Quality: - - - is fastest, typically implemented - with nearest neighbor filter. - - is typically implemented with bilerp - filter. - - is typically implemented with - bilerp filter, and mipmap when size is reduced. - - is slowest, typically implemented - with the bicubic filter.]]> - - - - The new color table. - Replaces the current color table of the bitmap. - - - - Marks the bitmap as immutable. - Marks this bitmap as immutable, meaning that the contents of its pixels will not change for the lifetime of the bitmap and of the underlying pixelref. This state can be set, but it cannot be cleared once it is set. This state propagates to all other bitmaps that share the same pixelref. - - - The x-coordinate. - The y-coordinate. - The color to set. - Sets the color of the pixel at a specified location. - This method will set the color of the pixel on the bitmap to the specified performing any necessary color conversions to the format of the bitmap. - - - The new pixel address. - Replaces the current pixel address for the bitmap. - - - - The new pixel address. - Index8 is no longer supported. - Developers should not use this obsolete method. - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The image information describing the pixels. - Allocates the memory for the bitmap using the specified image information. - Returns true if the allocation was successful, otherwise false. - - - - The image information describing the pixels. - The additional flags. - Allocates the memory for the bitmap using the specified image information. - Returns true if the allocation was successful, otherwise false. - - - - The image information describing the pixels. - The stride of the pixels being allocated. - Allocates the memory for the bitmap using the specified image information. - Returns true if the allocation was successful, otherwise false. - - - - Gets the width of the bitmap. - - - - - Flags to use with . - - - - Default bitmap allocation flag. - - - Initialize the bitmap with zeroed data. - - - The memory address of the pixels being released. - The user data that was provided when installing the pixels. - The delegate that is used when releasing the memory for a bitmap. - - - - Channel selector type for the method or the method. - - - - Use the box interpolated filter (Shrink: average color; Grow: pixel replication). - - - Use the Hamming windowed Sinc filter (cosine bell variant). - - - Use the Lanczos windowed Sinc filter. - - - Use the Mitchell cubic filter. - - - Use the box triangle or bilinear filter. - - - Predefined blend modes. - - - - - - No regions are enabled. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_clr.svg) - - - Creates a color with the hue and saturation of the source color and the luminosity of the backdrop color. [Non-Separable Blend Modes] - - - Darkens the backdrop color to reflect the source color. [Separable Blend Modes] - - - Brightens the backdrop color to reflect the source color. [Separable Blend Modes] - - - Selects the darker of the backdrop and source colors. [Separable Blend Modes] - - - Subtracts the darker of the two constituent colors from the lighter color. [Separable Blend Modes] - - - Only the destination will be present. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_dst.svg) - - - Destination which overlaps the source replaces the source. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_dst-atop.svg) - - - Destination which overlaps the source, replaces the source. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_dst-in.svg) - - - Destination is placed, where it falls outside of the source. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_dst-out.svg) - - - Destination is placed over the source. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_dst-over.svg) - - - Produces an effect similar to that of the Difference mode but lower in contrast. [Separable Blend Modes] - - - Multiplies or screens the colors, depending on the source color value. [Separable Blend Modes] - - - Creates a color with the hue of the source color and the saturation and luminosity of the backdrop color. [Non-Separable Blend Modes] - - - Selects the lighter of the backdrop and source colors. [Separable Blend Modes] - - - Creates a color with the luminosity of the source color and the hue and saturation of the backdrop color. [Non-Separable Blend Modes] - - - Multiplies all components (= alpha and color). [Separable Blend Modes] - - - The source color is multiplied by the destination color and replaces the destination [Separable Blend Modes] - - - Multiplies or screens the colors, depending on the backdrop color value. [Separable Blend Modes] - - - Display the sum of the source image and destination image. [Porter Duff Compositing Operators] - - - Creates a color with the saturation of the source color and the hue and luminosity of the backdrop color. [Non-Separable Blend Modes] - - - Multiplies the complements of the backdrop and source color values, then complements the result. [Separable Blend Modes] - - - Darkens or lightens the colors, depending on the source color value. [Separable Blend Modes] - - - Only the source will be present. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_src.svg) - - - Source which overlaps the destination, replaces the destination. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_src-atop.svg) - - - The source that overlaps the destination, replaces the destination. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_src-in.svg) - - - Source is placed, where it falls outside of the destination. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_src-out.svg) - - - Source is placed over the destination. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_src-over.svg) - - - The non-overlapping regions of source and destination are combined. [Porter Duff Compositing Operators] (https://drafts.fxtf.org/compositing-1/examples/PD_xor.svg) - - - Flags to use with . - - - - Apply all the flags. - - - Use a smother, higher quality blur algorithm. - - - The blur layer's radius is not affected by transforms. - - - Do not apply any of the flags. - - - Blur types for the method and its overloads. - - - - Fuzzy inside, nothing outside - - - Fuzzy inside and outside - - - Nothing inside, fuzzy outside - - - Solid inside, fuzzy outside - - - Encapsulates all of the state about drawing into a device (bitmap or surface). - - property of a -surface. - -### Construction - -SkiaSharp has multiple backends which receive -drawing commands, including: - - * Raster Surface - * GPU Surface - * PDF Document - * XPS Document _(experimental)_ - * SVG Canvas _(experimental)_ - * Picture - * Null Canvas _(for testing)_ - -#### Constructing a Raster Surface - -The raster backend draws to a block of memory. This memory can be managed by -SkiaSharp or by the client. - -The recommended way of creating a canvas for the Raster and Ganesh backends is -to use a , which is an object that manages the -memory into which the canvas commands are drawn. - -```csharp -// define the surface properties -var info = new SKImageInfo(256, 256); - -// construct a new surface -var surface = SKSurface.Create(info); - -// get the canvas from the surface -var canvas = surface.Canvas; - -// draw on the canvas ... -``` - -Alternatively, we could have specified the memory for the surface explicitly, -instead of asking SkiaSharp to manage it. - -```csharp -// define the surface properties -var info = new SKImageInfo(256, 256); - -// allocate memory -var memory = Marshal.AllocCoTaskMem(info.BytesSize); - -// construct a surface around the existing memory -var surface = SKSurface.Create(info, memory, info.RowBytes); - -// get the canvas from the surface -var canvas = surface.Canvas; - -// draw on the canvas ... -``` - -#### Constructing a GPU Surface - -GPU surfaces must have a object which manages the -GPU context, and related caches for textures and fonts. - - objects are matched one to one with OpenGL contexts -or Vulkan devices. That is, all instances that will -be rendered to using the same OpenGL context or Vulkan device should share a -. - -SkiaSharp does not create an OpenGL context or a Vulkan device for you. In -OpenGL mode it also assumes that the correct OpenGL context has been made -current to the current thread when SkiaSharp calls are made. - -```csharp -// an OpenGL context must be created and set as current - -// define the surface properties -var info = new SKImageInfo(256, 256); - -// create the surface -var context = GRContext.Create(GRBackend.OpenGL); -var surface = SKSurface.Create(context, false, info); - -// get the canvas from the surface -var canvas = surface.Canvas; - -// draw on the canvas ... -``` - -#### Constructing a PDF Document - -The PDF backend uses instead of -, since a document must include multiple pages. - -```csharp -// create the document -var stream = SKFileWStream.OpenStream("document.pdf"); -var document = SKDocument.CreatePdf(stream); - -// get the canvas from the page -var canvas = document.BeginPage(256, 256); - -// draw on the canvas ... - -// end the page and document -document.EndPage(); -document.Close(); -``` - -#### Constructing a XPS Document _(experimental)_ - -The XPS backend uses instead of -, since a document must include multiple pages. - -```csharp -// create the document -var stream = SKFileWStream.OpenStream("document.xps"); -var document = SKDocument.CreateXps(stream); - -// get the canvas from the page -var canvas = document.BeginPage(256, 256); - -// draw on the canvas ... - -// end the page and document -document.EndPage(); -document.Close(); -``` - -#### Constructing a SVG Canvas _(experimental)_ - -The SVG backend uses . - -```csharp -// create the canvas -var stream = SKFileWStream.OpenStream("image.svg"); -var writer = new SKXmlStreamWriter(stream); -var canvas = SKSvgCanvas.Create(SKRect.Create(256, 256), writer); - -// draw on the canvas ... -``` - -#### Constructing a Picture - -The XPS backend uses instead of -. - -```csharp -// create the picture recorder -var recorder = new SKPictureRecorder(); - -// get the canvas from the page -var canvas = recorder.BeginRecording(SKRect.Create(256, 256)); - -// draw on the canvas ... - -// finish recording -var picture = recorder.EndRecording(); -``` - -#### Constructing a Null Canvas _(for testing)_ - -The null canvas is a canvas that ignores all drawing commands and does -nothing. - -```csharp -// create the dummy canvas -var canvas = new SKNoDrawCanvas(256, 256); - -// draw on the canvas ... -``` - -### Transformations - -The canvas supports a number of 2D transformations. Unlike other 2D graphic -systems like CoreGraphics or Cairo, SKCanvas extends the transformations to -include perspectives. - -You can use the , -, , -, - to perform some of the most common -2D transformations. - -For more control you can use the to set -an arbitrary transformation using the and the - to concatenate an -transformation to the current matrix in use. - -The can be used to reset the state of -the matrix. - -### Drawing - -The drawing operations can take a parameter to affect -their drawing. You use objects to cache the style and -color information to draw geometries, texts and bitmaps. - -### Clipping and State - -It is possible to save the current transformations by calling the - method which preserves the current -transformation matrix, you can then alter the matrix and restore the previous -state by using the or - methods. - -Additionally, it is possible to push a new state with - which will make an offscreen copy of a -region, and once the drawing is completed, calling the - method which copies the offscreen bitmap -into this canvas. - -## Examples - -```csharp -var info = new SKImageInfo(640, 480); -using (var surface = SKSurface.Create(info)) { - SKCanvas canvas = surface.Canvas; - - canvas.Clear(SKColors.White); - - // set up drawing tools - var paint = new SKPaint { - IsAntialias = true, - Color = new SKColor(0x2c, 0x3e, 0x50), - StrokeCap = SKStrokeCap.Round - }; - - // create the Xamagon path - var path = new SKPath(); - path.MoveTo(71.4311121f, 56f); - path.CubicTo(68.6763107f, 56.0058575f, 65.9796704f, 57.5737917f, 64.5928855f, 59.965729f); - path.LineTo(43.0238921f, 97.5342563f); - path.CubicTo(41.6587026f, 99.9325978f, 41.6587026f, 103.067402f, 43.0238921f, 105.465744f); - path.LineTo(64.5928855f, 143.034271f); - path.CubicTo(65.9798162f, 145.426228f, 68.6763107f, 146.994582f, 71.4311121f, 147f); - path.LineTo(114.568946f, 147f); - path.CubicTo(117.323748f, 146.994143f, 120.020241f, 145.426228f, 121.407172f, 143.034271f); - path.LineTo(142.976161f, 105.465744f); - path.CubicTo(144.34135f, 103.067402f, 144.341209f, 99.9325978f, 142.976161f, 97.5342563f); - path.LineTo(121.407172f, 59.965729f); - path.CubicTo(120.020241f, 57.5737917f, 117.323748f, 56.0054182f, 114.568946f, 56f); - path.LineTo(71.4311121f, 56f); - path.Close(); - - // draw the Xamagon path - canvas.DrawPath(path, paint); -} -``` -]]> - - - - The bitmap for the canvas to draw into. - Creates a canvas with the specified bitmap to draw into. - The structure of the bitmap is copied into the canvas. - - - Replaces all the pixels in the canvas' current clip with the color. - - - - The color to use to replace the pixels in the current clipping region. - Replaces all the pixels in the canvas' current clip with the specified color. - - - - To be added. - To be added. - To be added. - - - The path to combine with the current clip. - The clip operator to apply to the current clip - Whether or not the clip should be antialiased. - Modify the current clip with the specified path. - - - - The rectangle to combine with the current clip. - The clip operator to apply to the current clip. - Whether or not the clip should be antialiased. - Modify the current clip with the specified rectangle. - - - - The region to combine with the current clip. - The region operator to apply to the current clip. - Modify the current clip with the specified region. - - - - The rounded rectangle to combine with the current clip. - The clip operator to apply to the current clip - Whether or not the clip should be antialiased. - Modify the current clip with the specified rounded rectangle. - - - - Transformation matrix to pre-concatenate. - Pre-concatenates the provided transformation matrix with the current transformation matrix. - - - - Gets the bounds of the current clip (in device coordinates). - - - - - Makes the canvas contents undefined. - - , return undefined -results. Calling this method does not change clip or matrix and may do nothing, depending on the implementation -of the underlying . - - allows optimized performance on subsequent draws by removing cached data associated -with the underlying . It is not necessary to call once -done with ; any cached data is deleted when the owning is deleted. -]]> - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - The bounds of the annotation. - The name of the annotation. - The blob of data to attach to the annotation. - Send an key/value pair "annotation" to the canvas. - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The bitmap to draw. - The destination coordinates for the bitmap. - The paint to use when drawing the bitmap. - Draws a bitmap on the canvas. - - - - The bitmap to draw. - The region to draw the bitmap into. - The paint to use when drawing the bitmap. - Draws a bitmap on the canvas. - - - - The bitmap to draw. - The source region to copy. - The region to draw the bitmap into. - The paint to use when drawing the bitmap. - Draws a bitmap on the canvas. - - - - The bitmap to draw. - The destination x-coordinate for the bitmap. - The destination y-coordinate for the bitmap. - The paint to use when drawing the bitmap. - Draws a bitmap on the canvas. - - - - The bitmap to draw. - The lattice that describes the areas of the bitmap to stretch or shrink. - The region to draw the bitmap into. - The paint to use when drawing the bitmap. - Draws the bitmap, stretched or shrunk differentially to fit into the destination rectangle. - - - - The bitmap to draw. - The x-coordinates that divide the bitmap vertically, describing the areas to stretch or shrink. - The y-coordinates that divide the bitmap horizontally, describing the areas to stretch or shrink. - The region to draw the bitmap into. - The paint to use when drawing the bitmap. - Draws the bitmap, stretched or shrunk differentially to fit into the destination rectangle. - - - - The bitmap to draw. - The center region within the bitmap to logically divide the bitmap into 9 sections (3x3). - The region to draw the bitmap into. - The paint to use when drawing the bitmap. - Draws the bitmap, stretched or shrunk differentially to fit into the destination rectangle. - - - - The center coordinates. - The radius for the circle. - The paint to use when drawing the circle. - Draws a circle on the canvas. - - - - The center x-coordinate. - The center y-coordinate. - The radius for the circle. - The paint to use when drawing the circle. - Draws a circle on the canvas. - - - - The color to use to paint the clipping region. - The blend mode for the color. - Fills the current clipping area with the specified color using the specified color and blend mode. - - - - To be added. - To be added. - To be added. - To be added. - - - The drawable to draw. - The matrix to apply while painting. - Draws a drawable on the canvas. - - - - The drawable to draw. - The destination coordinates for the drawable. - Draws a drawable on the canvas. - - - - The drawable to draw. - The destination x-coordinate for the drawable. - The destination y-coordinate for the drawable. - Draws a drawable on the canvas. - - - - The image to draw. - The destination coordinates for the image. - The paint to use when drawing the image, or . - Draws an image on the canvas. - - - - The image to draw. - The region to draw the image into. - The paint to use when drawing the image, or . - Draws an image on the canvas. - - - - The image to draw. - The source region to copy. - The region to draw the image into. - The paint to use when drawing the image, or . - Draws an image on the canvas. - - - - The image to draw. - The destination x-coordinate for the image. - The destination y-coordinate for the image. - The paint to use when drawing the image, or . - Draws an image on the canvas. - - - - The image to draw. - The lattice that describes the areas of the image to stretch or shrink. - The region to draw the image into. - The paint to use when drawing the image, or . - Draws the image, stretched or shrunk differentially to fit into the destination rectangle. - - - - The image to draw. - The x-coordinates that divide the image vertically, describing the areas to stretch or shrink. - The Y-coordinates that divide the image horizontally, describing the areas to stretch or shrink. - The region to draw the image into. - The paint to use when drawing the image, or . - Draws the image, stretched or shrunk differentially to fit into the destination rectangle. - - - - The image to draw. - The center region within the image to logically divide the image into 9 sections (3x3). - The region to draw the image into. - The paint to use when drawing the image, or . - Draws the image, stretched or shrunk differentially to fit into the destination rectangle. - - - - The first point coordinates. - The second point coordinates. - The paint to use when drawing the line. - Draws a line on the canvas. - - - - The first point x-coordinate. - The first point y-coordinate. - The second point x-coordinate. - The second point y-coordinate. - The paint to use when drawing the line. - Draws a line on the canvas. - - - - The bounds of the annotation. - The data that specifies the name of the link's destination. - Annotates the canvas by making the specified rectangle link to a named destination (see ). - - - - - - The bounds of the annotation. - The name of the link's destination. - Annotates the canvas by making the specified rectangle link to a named destination (see ). - Returns the actual data object that was attached to the canvas. - If the backend of this canvas does not support annotations, this call is safely ignored. - - - The location of the destination. - The data that specifies the name of the destination. - Annotates the canvas by associating a name with the specified point (see ). - - - - - - The location of the destination. - The name of the destination. - Annotates the canvas by associating a name with the specified point (see ). - Returns the actual data object that was attached to the canvas. - If the backend of this canvas does not support annotations, this call is safely ignored. - - - The bounding box for the oval. - The paint to use when drawing the oval. - Draws an oval on the canvas. - - - - The center coordinates. - The radius for the oval. - The paint to use when drawing the oval. - Draws an oval on the canvas. - - - - The center x-coordinate. - The center y-coordinate. - The vertical radius for the oval. - The horizontal radius for the oval. - The paint to use when drawing the oval. - Draws an oval on the canvas. - - - - The paint used to fill the current clipping path. - Fills the current clipping path with the specified paint. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The path to draw. - The paint to use when drawing the path. - Draws a path in the canvas. - - - - The picture to draw. - The paint to use when drawing the picture, or . - Draws a picture on the canvas. - - - - The picture to draw. - The matrix to apply while painting. - The paint to use when drawing the picture, or . - Draws a picture on the canvas. - - , followed by - with the specified `matrix`, - -and then . - -If paint is non-null, the picture is drawn into a temporary buffer, and then -the paint's alpha, color filter, image filter, blend mode are applied to that -buffer as it is drawn to the canvas. -]]> - - - - The picture to draw. - The destination coordinates for the picture. - The paint to use when drawing the picture, or . - Draws a picture on the canvas. - - - - The picture to draw. - The destination x-coordinate for the picture. - The destination y-coordinate for the picture. - The paint to use when drawing the picture, or . - Draws a picture on the canvas. - - - - The coordinates for the point to draw. - The color to use. - Draws a point in the canvas with the specified color. - - - - The coordinates for the point to draw. - The paint to use when drawing the point. - Draws a point in the canvas with the specified color. - - - - The x-coordinate for the point to draw. - The y-coordinate for the point to draw. - The color to use. - Draws a point in the canvas with the specified color. - - - - The x-coordinate for the point to draw. - The y-coordinate for the point to draw. - The paint to use when drawing the point. - Draws a point in the canvas with the specified color. - - - - Determines how the points array will be interpreted: as points, as coordinates to draw lines, or as coordinates of a polygon. - The array of points to draw. - The paint to use when drawing the points. - Draws an array of points, lines or a polygon in the canvas, one at a time. - - , each point is drawn centered at its -coordinate, and its size is specified by the paint's stroke-width. It draws as -a square, unless the paint's is -, in which the points are drawn as circles. - -For , each pair of points is drawn as a line -segment, respecting the paint's settings for cap, join and width. - -For , the entire array is drawn as a -series of connected line segments. - -Note that, while similar, the line and polygon modes draw slightly differently -than the equivalent path built with a series of move to, line to calls, in -that the path will draw all of its contours at once, with no interactions if -contours intersect each other (think ). -]]> - - - - The text to draw. - The positions for each glyph in the string. - The paint to use when drawing the text. - Draws glyphs of the text at specified locations on the canvas. - - - - The text to draw. - The positions for each glyph in the string. - The paint to use when drawing the text. - Draws glyphs of the text at specified locations on the canvas. - - - - The pointer to a region holding UTF-8 encoded text to draw. - The number of bytes to read from the - The positions for each glyph in the - The paint to use when drawing the text. - Draws text from a UTF-8 buffer at specified locations on the canvas. - - - - The rectangle to draw. - The paint to use when drawing the rectangle. - Draws a rectangle in the canvas. - - - - The x-coordinate. - The y-coordinate. - The rectangle width. - The rectangle height. - The paint to use when drawing the rectangle. - Draws a rectangle in the canvas. - - - - The region to be drawn. - The paint to use when drawing the region. - Draws the outline of the specified region using the specified paint. - - - - The rounded rectangle to draw. - The paint to use when drawing the rectangle. - Draws a rounded rectangle in the canvas. - The paint to use when drawing the rounded rectangle. - - - The rectangle to draw. - The radius of the oval used to round the corners. - The paint to use when drawing the rectangle. - Draws a rounded rectangle in the canvas. - The paint to use when drawing the rectangle. - - - The rectangle to draw. - The x-radius of the oval used to round the corners. - The y-radius of the oval used to round the corners. - The paint to use when drawing the rectangle. - Draws a rounded rectangle in the canvas. - - - - The x-coordinate of the rectangle. - The y-coordinate of the rectangle. - The rectangle width. - The rectangle height. - The x-radius of the oval used to round the corners. - The y-radius of the oval used to round the corners. - The paint to use when drawing the rectangle. - Draws a rounded rectangle in the canvas. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The surface to draw. - The destination coordinates for the surface. - The paint to use when drawing the surface, or . - Draws a surface on the canvas. - - - - The surface to draw. - The destination x-coordinate for the surface. - The destination y-coordinate for the surface. - The paint to use when drawing the surface, or . - Draws a surface on the canvas. - - - - The text to draw. - The coordinates of the origin of the text being drawn. - The paint to use when drawing the text. - Draws text on the canvas at the specified coordinates. - - - - The text to draw. - The coordinates of the origin of the text being drawn. - The paint to use when drawing the text. - Draws text on the canvas at the specified coordinates. - - - - The text blob to draw. - The x-coordinate of the origin of the text being drawn. - The y-coordinate of the origin of the text being drawn. - The paint to use when drawing the text. - Draws a text blob on the canvas at the specified coordinates. - - - - The text to draw. - The x-coordinate of the origin of the text being drawn. - The y-coordinate of the origin of the text being drawn. - The paint to use when drawing the text. - Draws text on the canvas at the specified coordinates. - - - - The pointer to a region holding UTF-8 encoded text to draw. - The number of bytes to read from the - The coordinates of the origin of the text being drawn. - The paint to use when drawing the text. - Draws text encoded in a UTF-8 buffer on the canvas at the specified coordinates. - - - - The text to draw. - The x-coordinate of the origin of the text being drawn. - The y-coordinate of the origin of the text being drawn. - The paint to use when drawing the text. - Draws text on the canvas at the specified coordinates. - - - - The pointer to a region holding UTF-8 encoded text to draw. - The number of bytes to read from the - The x-coordinate of the origin of the text being drawn. - The y-coordinate of the origin of the text being drawn. - The paint to use when drawing the text. - Draws text encoded in a UTF-8 buffer on the canvas at the specified coordinates. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The text to draw. - The path the text should follow for its baseline. - The offset to the path to add to the text's starting position. - The paint to use when drawing the text. - Draws text on the canvas following a path. - - - - The text to draw. - The path the text should follow for its baseline. - The offset to the path to add to the text's starting position. - The paint to use when drawing the text. - Draws text on the canvas following a path. - - - - The text to draw. - The path the text should follow for its baseline. - The distance along the path to add to the text's starting position. - The distance above (-) or below (+) the path to position the text. - The paint to use when drawing the text. - Draws text on the canvas following a path. - - - - The pointer to a region holding UTF-8 encoded text to draw. - The number of bytes to read from the - The path the text should follow for its baseline. - The offset to the path to add to the text's starting position. - The paint to use when drawing the text. - Draws text on the canvas following a path. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The text to draw. - The path the text should follow for its baseline. - The distance along the path to add to the text's starting position. - The distance above (-) or below (+) the path to position the text. - The paint to use when drawing the text. - Draws text on the canvas following a path. - - - - The pointer to a region holding UTF-8 encoded text to draw. - The number of bytes to read from the - The path the text should follow for its baseline. - The distance along the path to add to the text's starting position. - The distance above (-) or below (+) the path to position the text. - The paint to use when drawing the text. - Draws text encoded in a UTF-8 buffer on the canvas following a path. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The bounds of the annotation. - The data that specifies the URL. - Annotates the canvas by associating the specified URL with the specified rectangle (in local coordinates). - - - - - - The bounds of the annotation. - The URL. - Annotates the canvas by associating the specified URL with the specified rectangle (in local coordinates). - Returns the actual data object that was attached to the canvas. - If the backend of this canvas does not support annotations, this call is safely ignored. - - - The mesh to draw. - The blend mode to use to combine the colors with the texture, before being drawn using the paint. Used if both texture coordinates and colors are present. - The shader/texture. - Draws a set of vertices. - If both textures and vertex-colors are , it strokes hairlines with the paint's color. This behavior is a useful debugging mode to visualize the mesh. - - - How to interpret the array of vertices. - The array of vertices for the mesh. - The color for each vertex, to be interpolated across the triangle. May be . - The shader/texture. - Draws an array of vertices, interpreted as triangles (based on mode). - - - - How to interpret the array of vertices. - The array of vertices for the mesh. - The coordinates in texture space (not UV space) for each vertex. May be . - The color for each vertex, to be interpolated across the triangle. May be . - The shader/texture. - Draws an array of vertices, interpreted as triangles (based on mode). - If both textures and vertex-colors are , it strokes hairlines with the paint's color. This behavior is a useful debugging mode to visualize the mesh. - - - How to interpret the array of vertices. - The array of vertices for the mesh. - The coordinates in texture space (not UV space) for each vertex. May be . - The color for each vertex, to be interpolated across the triangle. May be . - The array of indices to reference into the vertex (texture coordinates, colors) array. - The shader/texture. - Draws an array of vertices, interpreted as triangles (based on mode). - If both textures and vertex-colors are , it strokes hairlines with the paint's color. This behavior is a useful debugging mode to visualize the mesh. - - - How to interpret the array of vertices. - The array of vertices for the mesh. - The coordinates in texture space (not UV space) for each vertex. May be . - The color for each vertex, to be interpolated across the triangle. May be . - The blend mode to use to combine the colors with the texture, before being drawn using the paint. Used if both texture coordinates and colors are present. - The array of indices to reference into the vertex (texture coordinates, colors) array. - The shader/texture. - Draws an array of vertices, interpreted as triangles (based on mode). - If both textures and vertex-colors are , it strokes hairlines with the paint's color. This behavior is a useful debugging mode to visualize the mesh. - - - Triggers the immediate execution of all pending draw operations. - For the GPU backend this will resolve all rendering to the GPU surface backing the surface that owns this canvas. - - - The resulting clip bounds. - Returns the bounds of the current clip (in device coordinates). - Returns true if the clip bounds are non-empty, otherwise false. - - - - The resulting clip bounds. - Returns the bounds of the current clip (in local coordinates). - Returns true if the clip bounds are non-empty, otherwise false. - This can be useful in that it tells you that drawing outside of these bounds will be clipped out. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Gets the bounds of the current clip (in local coordinates). - - - - - The path to compare with the current clip. - Checks to see if the specified path, after being transformed by the current matrix, would lie completely outside of the current clip. - Returns true if the path (transformed by the canvas' matrix) does not intersect with the canvas' clip. - Call this to check if an area you intend to draw into is clipped out (and therefore you can skip making the draw calls). - - - The rectangle to compare with the current clip. - Checks to see if the specified rectangle, after being transformed by the current matrix, would lie completely outside of the current clip. - Returns true if the rectangle (transformed by the canvas' matrix) does not intersect with the canvas' clip. - Call this to check if an area you intend to draw into is clipped out (and therefore you can skip making the draw calls). - - - Sets the current matrix to identity. - - - - Restore the canvas state. - This call balances a previous call to , and is used to remove all modifications to the matrix, clip and draw filter state since the last save call. It is an error to restore more times than was previously saved. - - - The number of levels to restore from, or -1 to restore all the way back to the initial value. - Efficiently restores the state to a specific level. - Efficient way to pop any calls to that happened after the save count reached . It is an error for to be greater than . To pop all the way back to the initial matrix/clip context set count to -1. - - - The number of degrees to rotate. - Pre-concatenates the current matrix with the specified rotation. - - - - The number of degrees to rotate. - The x-coordinate of the point to rotate about. - The y-coordinate of the point to rotate about. - Pre-concatenates the current matrix with the specified rotation, around the specified point. - - - - The number of radians to rotate. - Pre-concatenates the current matrix with the specified rotation. - - - - The number of radians to rotate. - The x-coordinate of the point to rotate about. - The y-coordinate of the point to rotate about. - Pre-concatenates the current matrix with the specified rotation, around the specified point. - - - - Saves the canvas state. - The value to pass to to balance this save. - This call saves the current matrix, clip, and draw filter, and pushes a copy onto a private stack. Subsequent calls to translate, scale, rotate, skew, concatenate or clipping path or drawing filter all operate on this copy. When the balancing call to is made, the previous matrix, clipping, and drawing filters are restored. - - - Gets the number of matrix/clip states on the canvas' private stack. - - This will equal the number of calls minus calls + 1. The save count on a new canvas is 1. - - - To be added. - To be added. - To be added. - - - This is copied, and is applied to the offscreen when is called. - Saves the canvas state and allocates an offscreen bitmap. - The value to pass to to balance this save. - This behaves the same as but in addition it allocates an offscreen bitmap. All drawing calls are directed there, and only when the balancing call to is made is that offscreen transfered to the canvas (or the previous layer). - - - This clipping rectangle hint to limit the size of the offscreen bitmap. - This is copied, and is applied to the offscreen when is called. - Saves the canvas state and allocates an offscreen bitmap. - The value to pass to to balance this save. - - but in addition it -allocates an offscreen bitmap. All drawing calls are directed there, and only -when the balancing call to is made is that -offscreen transfered to the canvas (or the previous layer). - -The limit rectangle, is used as a hint to limit the size of the offscreen -bitmap, and thus drawing may be clipped to it, though that clipping is not -guaranteed to happen. If exact clipping is desired, use -. -]]> - - - - The amount to scale. - Pre-concatenates the current matrix with the specified scale. - - - - The amount to scale. - Pre-concatenates the current matrix with the specified scale. - - - - The amount to scale in the x-direction. - The amount to scale in the y-direction. - Pre-concatenates the current matrix with the specified scale. - - - - The amount to scale in the x-direction. - The amount to scale in the y-direction. - The x-coordinate for the scaling center. - The y-coordinate for the scaling center. - Pre-concatenates the current matrix with the specified scale, at the specific offset. - - - - The matrix that will be copied into the current matrix. - Replaces the current matrix with a copy of the specified matrix. - - - - The amount to skew. - Pre-concatenates the current matrix with the specified skew. - - - - The amount to skew in the x-direction. - The amount to skew in the y-direction. - Pre-concatenates the current matrix with the specified skew. - - - - Gets the current matrix on the canvas. - - This does not account for the translate in any of the devices. - - - The distance to translate. - Pre-concatenates the current matrix with the specified translation. - - - - The distance to translate in the x-direction - The distance to translate in the y-direction. - Pre-concatenates the current matrix with the specified translation. - - - - The logical operations that can be performed when combining two regions. - - - - Subtract the op region from the first region. - - - Intersect the two regions. - - - An abstraction layer directly on top of an image codec. - - - - The data to use when creating the codec. - Creates a codec from the specified data. - Returns the new instance of the codec, or if there was an error. - - - - The stream to use when creating the codec. - Creates a codec from the specified stream. - Returns the new instance of the codec, or if there was an error. - If is returned, the stream is deleted immediately. Otherwise, the codec takes ownership of it, and will delete it when done with it. - - - The stream to use when creating the codec. - Creates a codec from the specified stream. - Returns the new instance of the codec, or if there was an error. - If is returned, the stream is deleted immediately. Otherwise, the codec takes ownership of it, and will delete it when done with it. - - - The path to an encoded image on the file system. - Creates a codec from the specified file. - Returns the new instance of the codec, or if there was an error. - - - - The stream to use when creating the codec. - The result of the creation operation. - Creates a codec from the specified stream. - Returns the new instance of the codec, or if there was an error. - If is returned, the stream is deleted immediately. Otherwise, the codec takes ownership of it, and will delete it when done with it. - - - The stream to use when creating the codec. - The result of the creation operation. - Creates a codec from the specified stream. - Returns the new instance of the codec, or if there was an error. - If is returned, the stream is deleted immediately. Otherwise, the codec takes ownership of it, and will delete it when done with it. - - - The path to an encoded image on the file system. - The result of the creation operation. - Creates a codec from the specified file. - Returns the new instance of the codec, or if there was an error. - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - Gets the image encoding from the codec. - - - - - Gets the encoded image information from the codec. - - - - - Gets the image origin from the codec. - - - - - Gets the number of frames in the encoded image. - - May require reading through the stream to determine info about the frames. As such, future decoding calls may require a rewind. For single-frame images, this will be zero. - - - Gets information about the frames in the encoded image. - - May require reading through the stream to determine info about the frames. As such, future decoding calls may require a rewind. For single-frame images, this will be an empty array. - - - The index of the frame to retrieve. - The information about the frame. - Gets information about a specific frame in the encoded image. - Returns true if the frame was successfully read, otherwise false. - May require reading through the stream to determine info about the frames. As such, future decoding calls may require a rewind. - - - The scanline that is located in the encoded data. - Returns the output y-coordinate of the row that corresponds to an input y-coordinate. - Returns the output y-coordinate of the row. - This will equal , except in the case of strangely encoded image types (bottom-up BMPs, interlaced GIFs). - - - The memory block with the decoded bitmap. - Decode the bitmap into the specified memory block. - Returns on success, or another value explaining the type of failure. - - - - The description of the desired output format expected by the caller. - The memory block to hold the decoded bitmap, with a length of at least . - Decode the bitmap into the specified memory block. - Returns on success, or another value explaining the type of failure. - - , can either be -, or a new instance with a different -configuration - which the codec may choose to ignore. - -If the specified size is different from the size from -, then the codec will attempt to scale the -resulting bitmap. If the codec cannot perform this scale, this method will -return . -]]> - - - - The description of the desired output format expected by the caller. - The memory block with the decoded bitmap. - Decode the bitmap into the specified memory block. - Returns on success, or another value explaining the type of failure. - - , can either be -, or a new instance with a different -configuration - which the codec may choose to ignore. - -If the specified size is different from the size from -, then the codec will attempt to scale the -resulting bitmap. If the codec cannot perform this scale, this method will -return . -]]> - - - - The description of the desired output format expected by the caller. - The memory block to hold the decoded bitmap, with a total size of at least . - Decode the bitmap into the specified memory block. - Returns on success, or another value explaining the type of failure. - - , can either be -, or a new instance with a different -configuration - which the codec may choose to ignore. - -If the specified size is different from the size from -, then the codec will attempt to scale the -resulting bitmap. If the codec cannot perform this scale, this method will -return . -]]> - - - - The description of the desired output format expected by the caller. - The memory block to hold the decoded bitmap, with a total size of at least . - The bitmap decoding options. - Decode the bitmap into the specified memory block. - Returns on success, or another value explaining the type of failure. - - , can either be -, or a new instance with a different -configuration - which the codec may choose to ignore. - -If the specified size is different from the size from -, then the codec will attempt to scale the -resulting bitmap. If the codec cannot perform this scale, this method will -return . -]]> - - - - The description of the desired output format expected by the caller. - The memory block to hold the decoded bitmap, with a total size of at least . - The color table to hold the color entries. - The logical number of color table entries. - Developers should not use this obsolete method. - Returns on success, or another value explaining the type of failure. - - , can either be -, or a new instance with a different -configuration - which the codec may choose to ignore. - -If the specified size is different from the size from -, then the codec will attempt to scale the -resulting bitmap. If the codec cannot perform this scale, this method will -return . - -]]> - - - - The description of the desired output format expected by the caller. - The memory block to hold the decoded bitmap, with a total size of at least . - The number of bytes in a row, typically . - The bitmap decoding options. - Decode the bitmap into the specified memory block. - Returns on success, or another value explaining the type of failure. - - , can either be -, or a new instance with a different -configuration - which the codec may choose to ignore. - -If the specified size is different from the size from -, then the codec will attempt to scale the -resulting bitmap. If the codec cannot perform this scale, this method will -return . -]]> - - - - The description of the desired output format expected by the caller. - The memory block to hold the decoded bitmap, with a total size of at least . - The pointer to the color table to hold the color entries, with a length of at least (256). - The logical number of color table entries. - Decode the bitmap into the specified memory block. - Returns on success, or another value explaining the type of failure. - - , can either be -, or a new instance with a different -configuration - which the codec may choose to ignore. - -If the specified size is different from the size from -, then the codec will attempt to scale the -resulting bitmap. If the codec cannot perform this scale, this method will -return . - -]]> - - - - The description of the desired output format expected by the caller. - The memory block to hold the decoded bitmap, with a total size of at least . - The bitmap decoding options. - The color table to hold the color entries. - The logical number of color table entries. - Decode the bitmap into the specified memory block. - Returns on success, or another value explaining the type of failure. - - , can either be -, or a new instance with a different -configuration - which the codec may choose to ignore. - -If the specified size is different from the size from -, then the codec will attempt to scale the -resulting bitmap. If the codec cannot perform this scale, this method will -return . - -]]> - - - - The description of the desired output format expected by the caller. - The memory block to hold the decoded bitmap, with a total size of at least . - The bitmap decoding options. - The pointer to the color table to hold the color entries, with a length of at least (256). - The logical number of color table entries. - Decode the bitmap into the specified memory block. - Returns on success, or another value explaining the type of failure. - - , can either be -, or a new instance with a different -configuration - which the codec may choose to ignore. - -If the specified size is different from the size from -, then the codec will attempt to scale the -resulting bitmap. If the codec cannot perform this scale, this method will -return . - - -]]> - - - - The description of the desired output format expected by the caller. - The memory block to hold the decoded bitmap, with a total size of at least . - The number of bytes in a row, typically . - The bitmap decoding options. - The color table to hold the color entries. - The logical number of color table entries. - Decode the bitmap into the specified memory block. - Returns on success, or another value explaining the type of failure. - - , can either be -, or a new instance with a different -configuration - which the codec may choose to ignore. - -If the specified size is different from the size from -, then the codec will attempt to scale the -resulting bitmap. If the codec cannot perform this scale, this method will -return . - -]]> - - - - The description of the desired output format expected by the caller. - The memory block to hold the decoded bitmap, with a total size of at least . - The number of bytes in a row, typically . - The bitmap decoding options. - The pointer to the color table to hold the color entries, with a length of at least (256). - The logical number of color table entries. - Decode the bitmap into the specified memory block. - Returns on success, or another value explaining the type of failure. - - , can either be -, or a new instance with a different -configuration - which the codec may choose to ignore. - -If the specified size is different from the size from -, then the codec will attempt to scale the -resulting bitmap. If the codec cannot perform this scale, this method will -return . - -]]> - - - - The desired scale factor. - Returns a size that approximately supports the desired scale factor. - Returns a supported size. - The codec may not be able to scale efficiently to the exact scale factor requested, so return a size that approximates that scale. Upscaling is not supported, so the original size will be returned. - - - The memory location to store the scanlines. - The number of lines to write. - The number of bytes per row. - Writes the next set of scanlines into the destination. - Returns the number of lines successfully decoded. - If number of lines successfully decoded is less than , this will fill the remaining lines with a default value. - - - The desired subset of the original bounds, which may be modified to a subset which is supported. - Modifies the specified subset to one that can decoded from this codec. - Returns true if this codec supports decoding the desired subset, otherwise false. The final subset can be used with . - - - - Start or continue the incremental decode. - Returns if all lines requested in have been completely decoded. otherwise. - Unlike , this does not do any filling. This is left up to the caller, since they may be skipping lines or continuing the decode later. - - - The total number of lines initialized. Only meaningful if this method returns . - Start or continue the incremental decode. - Returns if all lines requested in have been completely decoded. otherwise. - Unlike , this does not do any filling. This is left up to the caller, since they may be skipping lines or continuing the decode later. - - - Gets the image information from the codec. - - - - - Gets the minimum number of bytes that must be buffered in stream input. - - - - - Gets the y-coordinate of the next row to be returned by the scanline decoder. - - - - - Gets the image origin from the codec. - - - - - Gets the image data from the codec using the current . - - - - - Gets the number of times to repeat, if this image is animated. - - - For infinite repetition of frames, this will be -1. - May require reading the stream to find the repetition count. As such, future decoding calls may require a rewind. For single-frame images, this will be 0. - - - - Gets the order in which scanlines will be returned by the scanline decoder. - - - - - The number of scanlines to skip. - Skip the specified number of scanlines. - Returns if the scanlines were successfully skipped, otherwise on failure (incomplete input, the number of lines is less than zero, read all the lines). - - - - The image information of the destination. If the dimensions do not match those of , this implies a scale. - The memory to write to. Needs to be large enough to hold the subset, if present, or the full image. - The stride of the memory to write to. - Prepare for an incremental decode with the specified options. - Returns on success, or another value explaining the type of failure. - - - - The image information of the destination. If the dimensions do not match those of , this implies a scale. - The memory to write to. Needs to be large enough to hold the subset, if present, or the full image. - The stride of the memory to write to. - The decoding options, including if memory is zero initialized and whether to decode a subset. - Prepare for an incremental decode with the specified options. - Returns on success, or another value explaining the type of failure. - - - - The image information of the destination. If the dimensions do not match those of , this implies a scale. - The memory to write to. Needs to be large enough to hold the subset, if present, or the full image. - The stride of the memory to write to. - The decoding options, including if memory is zero initialized and whether to decode a subset. - The color table to use. - The size of the color table. - Prepare for an incremental decode with the specified options. - Returns on success, or another value explaining the type of failure. - - - - The image information of the destination. If the dimensions do not match those of , this implies a scale. - The memory to write to. Needs to be large enough to hold the subset, if present, or the full image. - The stride of the memory to write to. - The decoding options, including if memory is zero initialized and whether to decode a subset. - The pointer to the color table to use. - The size of the color table. - Prepare for an incremental decode with the specified options. - Returns on success, or another value explaining the type of failure. - - - - The image information of the destination. If the dimensions do not match those of , this implies a scale. - Prepare for a scanline decode. - Returns on success, or another value explaining the type of failure. - Not all codecs support this. - - - The image information of the destination. If the dimensions do not match those of , this implies a scale. - The decoding options, including if memory is zero initialized and whether to decode a subset. - Prepare for a scanline decode with the specified options. - Returns on success, or another value explaining the type of failure. - Not all codecs support this. - - - The image information of the destination. If the dimensions do not match those of , this implies a scale. - The decoding options, including if memory is zero initialized and whether to decode a subset. - The color table to use. - The size of the color table. - Prepare for a scanline decode with the specified options. - Returns on success, or another value explaining the type of failure. - Not all codecs support this. - - - The image information of the destination. If the dimensions do not match those of , this implies a scale. - The decoding options, including if memory is zero initialized and whether to decode a subset. - The pointer to the color table to use. - The size of the color table. - Prepare for a scanline decode with the specified options. - Returns on success, or another value explaining the type of failure. - Not all codecs support this. - - - Represents how the next frame in the image is based on the current frame. - - - - The next frame should be drawn on top of this one. - - - The area inside this frame's rectangle should be cleared to the background color before drawing the next frame. - - - The next frame should be drawn on top of the previous frame - i.e. disregarding this one. - - - Information about individual frames in a multi-framed image. - - - - Gets or sets a value indicating the frame's alpha value. - - - - - Gets or sets the method indicating how the current frame should be modified before decoding the next one. - - - - - Gets or sets the number of milliseconds to show this frame. - - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Gets or sets a value indicating whether the end marker for this frame is contained in the stream. - - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the frame that this frame needs to be blended with, or -1. - - - - - Additional options to pass to or one of the overloads that accepts a . - - - - The subset rectangle. - Create a new instance of with the specified subset rectangle. - - - - The zero-initialization. - Create a new instance of with the specified zero-initialization. - - - - The frame to decode. - Create a new instance of with the specified frame index. - Only meaningful for multi-frame images. - - - The zero-initialization. - The subset rectangle. - Create a new instance of with the specified subset rectangle and zero-initialization. - - - - The frame to decode. - Whether the decode destination already contains the prior frame. - Create a new instance of . - Only meaningful for multi-frame images. - - - The frame to decode. - The previous frame to decode. - Create a new instance of . - Only meaningful for multi-frame images. - - - Gets the default options. - The default value is not zero-initialized and without a subset rectangle. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the frame to decode. - - Only meaningful for multi-frame images. - - - To be added. - To be added. - To be added. - - - Gets or sets a value indicating whether the decode destination already contains the prior frame. - - Only meaningful for multi-frame images. - - - Gets a value indicating whether the options has a subset rectangle. - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets or sets a value indicating whether the decode should do a linear premultiply or a legacy premultiply. - - - - - Gets or sets a value indicating which frame, if any, the destination bitmap already contains. - - - needs to be blended with a prior -frame (as reported by `SKCodec.FrameInfo[FrameIndex].RequiredFrame`), the -client can set this to any non- -frame in the range [RequiredFrame, FrameIndex) to indicate that that frame is -already in the destination. is -ignored in this case. - -If set to -1, the codec will decode any necessary required frame(s) first. -]]> - - - - Gets or sets the subset rectangle. - - - - - Gets or sets the zero-initialization. - - - - - The various origins of a bitmap. - - - - Reflected across x-axis. - - - Rotated 180°. - - - Rotated 90° counter-clockwise. - - - Reflected across x-axis, Rotated 90° counter-clockwise. - - - Reflected across x-axis, Rotated 90° clockwise. - - - Rotated 90° clockwise. - - - Default. - - - Reflected across y-axis. - - - Used to describe the result of a call to or one of the overloads that accepts a . - Result is the union of possible results from subclasses. - - - Fulfilling this request requires rewinding the input, which is not supported for this input. - - - There was an error in the imput data. If returned from an incremental decode, decoding cannot continue, even with more data. - - - The input is incomplete. A partial image was generated. - - - An internal memory occurred, such as an out-of-memory error. - - - The codec cannot convert to match the request, ignoring dimensions. - - - The input did not contain a valid image. - - - The parameters (besides info) are invalid. e.g. null pixels, row bytes too small, etc. - - - The generator cannot scale to requested size. - - - The general return value for success. - - - This method is not supported by this codec. - - - The orders in which scanlines can be returned. - These values are obtained through the property. - - - Indicates that the scanline decoder reliably outputs rows, but they will be returned in reverse order. The property can be used to determine the actual y-coordinate of the next output row. - - - Indicates that the image can be decoded reliably using the scanline decoder, and that rows will be output in the logical order. - - - 32-bit ARGB unpremultiplied color value. - The color components are always in a known order. - - - The integer value of the unpremultiplied color. - Creates a color from the specified integer. - - - - The red component. - The green component. - The blue component. - Creates a color from the specified red, green and blue components. - - - - The red component. - The green component. - The blue component. - The alpha component. - Creates a color from the specified red, green, blue and alpha components. - - - - Gets the alpha component of the color. - - - - - Gets the blue component of the color. - - - - - Gets an "empty" color, with zero for all the components. - - - - The color to compare with the current color. - Determines whether the specified object is equal to the current object. - Returns if the specified object is equal to the current object; otherwise, . - - - - The object to compare with the current object. - Determines whether the specified object is equal to the current object. - Returns if the specified object is equal to the current object; otherwise, . - - - - The hue value. - The saturation value. - The lightness/luminosity value. - The alpha value. - Creates a color from the specified hue, saturation, lightness/luminosity and alpha values. - The new instance. - - - - The hue value. - The saturation value. - The value/brightness value. - The alpha value. - Creates a color from the specified hue, saturation, value/brightness and alpha values. - The new instance. - - - - Serves as the default hash function. - Returns a hash code for the current object. - - - - Gets the green component of the color. - - - - - Gets the hue value. - - - - - The first color to compare. - The second color to compare. - Indicates whether two objects are equal. - Returns if is equal to , otherwise . - - - - The color to convert. - Converts a to a UInt32. - The UInt32 value for the color. - - - - The UInt32 representation of a color. - Converts a UInt32 to a . - The new instance. - - - - The first color to compare. - The second color to compare. - Indicates whether two objects are different. - Returns if is not equal to , otherwise . - - - - The hexadecimal string representation of a color. - Converts the hexadecimal string representation of a color to its equivalent. - The new instance. - This method can parse a string in the forms with or without a preceding '#' character: AARRGGB, RRGGBB, ARGB, RGB. - - - Gets the red component of the color. - - - - - The hue value. - The saturation value. - The lightness/luminosity value. - Converts the current color into it's hue, saturation and lightness/luminosity values. - The alpha value is separate from the HSL calculation and will always be the same as . - - - The hue value. - The saturation value. - The value/brightness value. - Converts the current color into it's hue, saturation and value/brightness values. - The alpha value is separate from the HSV/HSB calculation and will always be the same as . - - - Returns the color as a string in the format: #AARRGGBB. - - - - - The hexadecimal string representation of a color. - The new instance. - Converts the hexadecimal string representation of a color to its equivalent. - Returns true if the conversion was successful, otherwise false. - This method can parse a string in the forms with or without a preceding '#' character: AARRGGB, RRGGBB, ARGB, RGB. - - - The new alpha component. - Returns a new color based on this current instance, but with the new alpha channel value. - - - - - The new blue component. - Returns a new color based on this current instance, but with the new blue channel value. - - - - - The new green component. - Returns a new color based on this current instance, but with the new green channel value. - - - - - The new red component. - Returns a new color based on this current instance, but with the new red channel value. - - - - - To be added. - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - 16-bit, floating-point, ARGB unpremultiplied color value. - The color components are always in a known order. - - - The red component. - The green component. - The blue component. - Creates a color from the specified red, green and blue components. - - - - The red component. - The green component. - The blue component. - The alpha component. - Creates a color from the specified red, green, blue and alpha components. - - - - Gets the alpha component of the color. - - - - - Gets the blue component of the color. - - - - - Clamp the color components in the range [0..1]. - Returns the clamped color. - - - - Gets an "empty" color, with zero for all the components. - - - - The color to compare with the current color. - Determines whether the specified object is equal to the current object. - Returns if the specified object is equal to the current object; otherwise, . - - - - The object to compare with the current object. - Determines whether the specified object is equal to the current object. - Returns if the specified object is equal to the current object; otherwise, . - - - - The hue value. - The saturation value. - The lightness/luminosity value. - The alpha value. - Creates a color from the specified hue, saturation, lightness/luminosity and alpha values. - The new instance. - - - - The hue value. - The saturation value. - The value/brightness value. - The alpha value. - Creates a color from the specified hue, saturation, value/brightness and alpha values. - The new instance. - - - - Serves as the default hash function. - Returns a hash code for the current object. - - - - Gets the green component of the color. - - - - - Gets the hue value. - - - - - The first color to compare. - The second color to compare. - Indicates whether two objects are equal. - Returns if is equal to , otherwise . - - - - The color to convert. - Converts a to a . - The . - As a result of converting a floating-point color to an integer color, some data loss will occur. - - - The . - Converts a to a . - The new instance. - - - - The first color to compare. - The second color to compare. - Indicates whether two objects are different. - Returns if is not equal to , otherwise . - - - - Gets the red component of the color. - - - - - The hue value. - The saturation value. - The lightness/luminosity value. - Converts the current color into it's hue, saturation and lightness/luminosity values. - The alpha value is separate from the HSL calculation and will always be the same as . - - - The hue value. - The saturation value. - The value/brightness value. - Converts the current color into it's hue, saturation and value/brightness values. - The alpha value is separate from the HSV/HSB calculation and will always be the same as . - - - Returns the color as a string in the format: #AARRGGBB. - - As a result of converting a floating-point color to an integer color, some data loss will occur. - - - The new alpha component. - Returns a new color based on this current instance, but with the new alpha channel value. - - - - - The new blue component. - Returns a new color based on this current instance, but with the new blue channel value. - - - - - The new green component. - Returns a new color based on this current instance, but with the new green channel value. - - - - - The new red component. - Returns a new color based on this current instance, but with the new red channel value. - - - - - Color filters for use with the property of a . - - - - The size of the color matrix. - - - - The source color used with the specified mode. - The blend mode mode that is applied to each color. - Creates a new color filter that uses the specified color and mode. - Returns the new , or if the mode will have no effect. - If the is , this function will return (since that mode will have no effect on the result). - - - An array of elements. - Creates a new color filter that transforms a color by a 4x5 (row-major) matrix. - Returns the new . - The matrix is in row-major order and the translation column is specified in unnormalized, 0...255, space. - - - The outer (second) filter to apply. - The inner (first) filter to apply. - Creates a new composition color filter, whose effect is to first apply the inner filter and then apply the outer filter to the result of the inner. - Returns the new . - - - - The high contrast configuration settings. - Creates a new high contrast color filter which provides transformations to improve contrast for users with low vision. - Returns the new . - Applies the following transformations in this order: conversion to grayscale, color inversion, increasing the resulting contrast. - - - Whether or not the color will be converted to grayscale. - Whether or not to invert brightness, lightness, or neither. - The amount to adjust the contrast by, in the range -1.0 through 1.0. - Creates a new high contrast color filter which provides transformations to improve contrast for users with low vision. - Returns the new . - Applies the following transformations in this order: conversion to grayscale, color inversion, increasing the resulting contrast. - - - The color to multiply the source color by. The alpha component is ignored. - The color to add to the source color. The alpha component is ignored. - Creates a new lighting color filter that multiplies the RGB channels by one color, and then adds a second color, pinning the result for each component to [0..255]. - Returns the new . - - - - Creates a new luminance-to-alpha color filter. - Returns the new . - - - - The table of values for each color component, with a length of . - Creates a new table color filter. - Returns the new . - - - - The table of values for the alpha component, with a length of . - The table of values for the red component, with a length of . - The table of values for the green component, with a length of . - The table of values for the blue component, with a length of . - Creates a new table color filter. - Returns the new . - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - The size of a color table for a color component. - - - - Definitions for some common color names. - - - - Gets the predefined color of alice blue, or #FFF0F8FF. - - - - Gets the predefined color of antique white, or #FFFAEBD7. - - - - Gets the predefined color of aqua, or #FF00FFFF. - - - - Gets the predefined color of aquamarine, or #FF7FFFD4. - - - - Gets the predefined color of azure, or #FFF0FFFF. - - - - Gets the predefined color of beige, or #FFF5F5DC. - - - - Gets the predefined color of bisque, or #FFFFE4C4. - - - - Gets the predefined color of black, or #FF000000. - - - - Gets the predefined color of blanched almond, or #FFFFEBCD. - - - - Gets the predefined color of blue, or #FF0000FF. - - - - Gets the predefined color of blue violet, or #FF8A2BE2. - - - - Gets the predefined color of brown, or #FFA52A2A. - - - - Gets the predefined color of burly wood, or #FFDEB887. - - - - Gets the predefined color of cadet blue, or #FF5F9EA0. - - - - Gets the predefined color of chartreuse, or #FF7FFF00. - - - - Gets the predefined color of chocolate, or #FFD2691E. - - - - Gets the predefined color of coral, or #FFFF7F50. - - - - Gets the predefined color of cornflower blue, or #FF6495ED. - - - - Gets the predefined color of cornsilk, or #FFFFF8DC. - - - - Gets the predefined color of crimson, or #FFDC143C. - - - - Gets the predefined color of cyan, or #FF00FFFF. - - - - Gets the predefined color of dark blue, or #FF00008B. - - - - Gets the predefined color of dark cyan, or #FF008B8B. - - - - Gets the predefined color of dark goldenrod, or #FFB8860B. - - - - Gets the predefined color of dark gray, or #FFA9A9A9. - - - - Gets the predefined color of dark green, or #FF006400. - - - - Gets the predefined color of dark khaki, or #FFBDB76B. - - - - Gets the predefined color of dark magenta, or #FF8B008B. - - - - Gets the predefined color of dark olive green, or #FF556B2F. - - - - Gets the predefined color of dark orange, or #FFFF8C00. - - - - Gets the predefined color of dark orchid, or #FF9932CC. - - - - Gets the predefined color of dark red, or #FF8B0000. - - - - Gets the predefined color of dark salmon, or #FFE9967A. - - - - Gets the predefined color of dark sea green, or #FF8FBC8B. - - - - Gets the predefined color of dark slate blue, or #FF483D8B. - - - - Gets the predefined color of dark slate gray, or #FF2F4F4F. - - - - Gets the predefined color of dark turquoise, or #FF00CED1. - - - - Gets the predefined color of dark violet, or #FF9400D3. - - - - Gets the predefined color of deep pink, or #FFFF1493. - - - - Gets the predefined color of deep sky blue, or #FF00BFFF. - - - - Gets the predefined color of dim gray, or #FF696969. - - - - Gets the predefined color of dodger blue, or #FF1E90FF. - - - - Gets the predefined empty color (black transparent), or #00000000. - - - - - Gets the predefined color of firebrick, or #FFB22222. - - - - Gets the predefined color of floral white, or #FFFFFAF0. - - - - Gets the predefined color of forest green, or #FF228B22. - - - - Gets the predefined color of fuchsia, or #FFFF00FF. - - - - Gets the predefined color of gainsboro, or #FFDCDCDC. - - - - Gets the predefined color of ghost white, or #FFF8F8FF. - - - - Gets the predefined color of gold, or #FFFFD700. - - - - Gets the predefined color of goldenrod, or #FFDAA520. - - - - Gets the predefined color of gray, or #FF808080. - - - - Gets the predefined color of green, or #FF008000. - - - - Gets the predefined color of green yellow, or #FFADFF2F. - - - - Gets the predefined color of honeydew, or #FFF0FFF0. - - - - Gets the predefined color of hot pink, or #FFFF69B4. - - - - Gets the predefined color of indian red, or #FFCD5C5C. - - - - Gets the predefined color of indigo, or #FF4B0082. - - - - Gets the predefined color of ivory, or #FFFFFFF0. - - - - Gets the predefined color of khaki, or #FFF0E68C. - - - - Gets the predefined color of lavender, or #FFE6E6FA. - - - - Gets the predefined color of lavender blush, or #FFFFF0F5. - - - - Gets the predefined color of lawn green, or #FF7CFC00. - - - - Gets the predefined color of lemon chiffon, or #FFFFFACD. - - - - Gets the predefined color of light blue, or #FFADD8E6. - - - - Gets the predefined color of light coral, or #FFF08080. - - - - Gets the predefined color of light cyan, or #FFE0FFFF. - - - - Gets the predefined color of light goldenrod yellow, or #FFFAFAD2. - - - - Gets the predefined color of light gray, or #FFD3D3D3. - - - - Gets the predefined color of light green, or #FF90EE90. - - - - Gets the predefined color of light pink, or #FFFFB6C1. - - - - Gets the predefined color of light salmon, or #FFFFA07A. - - - - Gets the predefined color of light sea green, or #FF20B2AA. - - - - Gets the predefined color of light sky blue, or #FF87CEFA. - - - - Gets the predefined color of light slate gray, or #FF778899. - - - - Gets the predefined color of light steel blue, or #FFB0C4DE. - - - - Gets the predefined color of light yellow, or #FFFFFFE0. - - - - Gets the predefined color of lime, or #FF00FF00. - - - - Gets the predefined color of lime green, or #FF32CD32. - - - - Gets the predefined color of linen, or #FFFAF0E6. - - - - Gets the predefined color of magenta, or #FFFF00FF. - - - - Gets the predefined color of maroon, or #FF800000. - - - - Gets the predefined color of medium aquamarine, or #FF66CDAA. - - - - Gets the predefined color of medium blue, or #FF0000CD. - - - - Gets the predefined color of medium orchid, or #FFBA55D3. - - - - Gets the predefined color of medium purple, or #FF9370DB. - - - - Gets the predefined color of medium sea green, or #FF3CB371. - - - - Gets the predefined color of medium slate blue, or #FF7B68EE. - - - - Gets the predefined color of medium spring green, or #FF00FA9A. - - - - Gets the predefined color of medium turquoise, or #FF48D1CC. - - - - Gets the predefined color of medium violet red, or #FFC71585. - - - - Gets the predefined color of midnight blue, or #FF191970. - - - - Gets the predefined color of mint cream, or #FFF5FFFA. - - - - Gets the predefined color of misty rose, or #FFFFE4E1. - - - - Gets the predefined color of moccasin, or #FFFFE4B5. - - - - Gets the predefined color of navajo white, or #FFFFDEAD. - - - - Gets the predefined color of navy, or #FF000080. - - - - Gets the predefined color of old lace, or #FFFDF5E6. - - - - Gets the predefined color of olive, or #FF808000. - - - - Gets the predefined color of olive drab, or #FF6B8E23. - - - - Gets the predefined color of orange, or #FFFFA500. - - - - Gets the predefined color of orange red, or #FFFF4500. - - - - Gets the predefined color of orchid, or #FFDA70D6. - - - - Gets the predefined color of pale goldenrod, or #FFEEE8AA. - - - - Gets the predefined color of pale green, or #FF98FB98. - - - - Gets the predefined color of pale turquoise, or #FFAFEEEE. - - - - Gets the predefined color of pale violet red, or #FFDB7093. - - - - Gets the predefined color of papaya whip, or #FFFFEFD5. - - - - Gets the predefined color of peach puff, or #FFFFDAB9. - - - - Gets the predefined color of peru, or #FFCD853F. - - - - Gets the predefined color of pink, or #FFFFC0CB. - - - - Gets the predefined color of plum, or #FFDDA0DD. - - - - Gets the predefined color of powder blue, or #FFB0E0E6. - - - - Gets the predefined color of purple, or #FF800080. - - - - Gets the predefined color of red, or #FFFF0000. - - - - Gets the predefined color of rosy brown, or #FFBC8F8F. - - - - Gets the predefined color of royal blue, or #FF4169E1. - - - - Gets the predefined color of saddle brown, or #FF8B4513. - - - - Gets the predefined color of salmon, or #FFFA8072. - - - - Gets the predefined color of sandy brown, or #FFF4A460. - - - - Gets the predefined color of sea green, or #FF2E8B57. - - - - Gets the predefined color of sea shell, or #FFFFF5EE. - - - - Gets the predefined color of sienna, or #FFA0522D. - - - - Gets the predefined color of silver, or #FFC0C0C0. - - - - Gets the predefined color of sky blue, or #FF87CEEB. - - - - Gets the predefined color of slate blue, or #FF6A5ACD. - - - - Gets the predefined color of slate gray, or #FF708090. - - - - Gets the predefined color of snow, or #FFFFFAFA. - - - - Gets the predefined color of spring green, or #FF00FF7F. - - - - Gets the predefined color of steel blue, or #FF4682B4. - - - - Gets the predefined color of tan, or #FFD2B48C. - - - - Gets the predefined color of teal, or #FF008080. - - - - Gets the predefined color of thistle, or #FFD8BFD8. - - - - Gets the predefined color of tomato, or #FFFF6347. - - - - Gets the predefined color of white transparent, or #00FFFFFF. - - - - Gets the predefined color of turquoise, or #FF40E0D0. - - - - Gets the predefined color of violet, or #FFEE82EE. - - - - Gets the predefined color of wheat, or #FFF5DEB3. - - - - Gets the predefined color of white, or #FFFFFFFF. - - - - Gets the predefined color of white smoke, or #FFF5F5F5. - - - - Gets the predefined color of yellow, or #FFFFFF00. - - - - Gets the predefined color of yellow green, or #FF9ACD32. - - - - Represents a color space. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - The ICC profile data. - Creates a new instance of from an ICC profile. - Returns the new instance of . - - - - To be added. - To be added. - To be added. - To be added. - - - The ICC profile data. - The size of the data. - Creates a new instance of from an ICC profile. - Returns the new instance of . - - - - The ICC profile data. - The size of the data. - Creates a new instance of from an ICC profile. - Returns the new instance of . - - - - The gamma transfer function. - The color gamut. - Creates a new instance of from a transfer function and a color gamut. - Returns the new instance of . - - - - The gamma transfer function. - The matrix transformation to XYZ D50. - Creates a new instance of from a transfer function and a color gamut. - Returns the new instance of . - - - - The coefficients for a common transfer function equation. - The color gamut. - Creates a new instance of from a transfer function and a color gamut. - Returns the new instance of . - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The coefficients for a common transfer function equation. - The matrix transformation to XYZ D50. - Creates a new instance of from a transfer function and a color gamut. - Returns the new instance of . - - - - The gamma. - The color gamut. - Creates a new instance of from a named gamma and a color gamut. - Returns the new instance of . - - - - The gamma. - The matrix transformation to XYZ D50. - Creates a new instance of from a named gamma and a color gamut. - Returns the new instance of . - - - - The gamma transfer function. - The color gamut. - The optional flags. - Creates a new instance of from a transfer function and a color gamut. - Returns the new instance of . - - - - The gamma transfer function. - The matrix transformation to XYZ D50. - The optional flags. - Creates a new instance of from a transfer function and a color gamut. - Returns the new instance of . - - - - The coefficients for a common transfer function equation. - The color gamut. - The optional flags. - Creates a new instance of from a transfer function and a color gamut. - Returns the new instance of . - - - - The coefficients for a common transfer function equation. - The matrix transformation to XYZ D50. - The optional flags. - Creates a new instance of from a transfer function and a color gamut. - Returns the new instance of . - - - - Creates a new instance of that represents the sRGB color space. - Returns the new instance of . - - - - Creates a new instance of with the sRGB primaries, but a linear (1.0) gamma - Returns the new instance of . - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - The first color space. - The second color space. - Compare two color spaces to determine if they are equivalent. - Returns if both color spaces are equivalent, otherwise . - - - - Describes color space gamut as a transformation from XYZ D50. - Returns the matrix if the color gamut can be described as a matrix, otherwise . - - - - Gets a value indicating whether or not the color space gamma is near enough to be approximated as sRGB. - - - - - Gets a value indicating whether or not the color space gamma is linear. - - - - - To be added. - To be added. - To be added. - - - The values of the coefficients to the standard equation. - Returns the values of the coefficients to the standard equation. - Returns if transfer function can be represented as coefficients to the standard equation, otherwise . - - - - Gets a value indicating whether the transfer function can be represented as coefficients to the standard equation. - - - - - Gets a value indicating whether or not the color space is sRGB. - - - - - Gets the gamma of the color space. - - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Describes color space gamut as a transformation to XYZ D50. - Returns the matrix if the color gamut can be described as a matrix, otherwise . - - - - The matrix that describes the color space. - Converts the color space to a XYZ D50 matrix that describes the color space. - Returns if the color gamut can be described as a matrix, otherwise . - - - - Gets the color space type. - - - - - Various flags that are used when creating a . - - - - Default construction. - - - Blending is non-linear. - - - Various gamut values for use with a . - - - - Adobe RGB. - - - DCI-P3 D65. - - - Rec. 2020 (ITU-R Recommendation BT.2020). - - - sRGB. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Describes a color gamut with primaries and a white point. - - - - The values of the primaries and white point. - Creates a new instance. - There must be exactly 8 values in the array with the form [RX, RY, GX, GY, BX, BY, WX, WY]. - - - The red X-coordinate. - The red Y-coordinate. - The green X-coordinate. - The green Y-coordinate. - The blue X-coordinate. - The blue Y-coordinate. - The white X-coordinate. - The white Y-coordinate. - Creates a new instance. - - - - Gets or sets the blue X-coordinate. - - - - - Gets or sets the blue Y-coordinate. - - - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Gets or sets the green X-coordinate. - - - - - Gets or sets the green Y-coordinate. - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the red X-coordinate. - - - - - Gets or sets the red Y-coordinate. - - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Converts primaries and a white point to a XYZ D50 matrix, the preferred color gamut representation of . - Returns the XYZ D50 matrix, or if the conversion is not possible. - - - - The XYZ D50 matrix. - Converts primaries and a white point to a XYZ D50 matrix, the preferred color gamut representation of . - Returns if the conversion succeeded, otherwise if the conversion is not possible. - - - - Gets the values of the primaries and white as an array with the form [RX, RY, GX, GY, BX, BY, WX, WY]. - - ] - - - Gets or sets the white X-coordinate. - - - - - Gets or sets the white Y-coordinate. - - - - - Represents gamma transfer functions. - - - - The transfer function is linear. - - - The transfer function is the canonical sRGB curve, which has a short linear segment followed by a 2.4f exponential. - - - Represents the coefficients for a common transfer function equation. - - The coefficients are specified as a transformation from a curved space to linear. - - LinearVal = C*InputVal + F; (for 0.0f <= InputVal < D) - LinearVal = (A*InputVal + B)^G + E; (for D <= InputVal <= 1.0f) - - Function is undefined if InputVal is not in [ 0.0f, 1.0f ]. - Resulting LinearVals must be in [ 0.0f, 1.0f ]. - Function must be positive and increasing. - - - - The values of the coefficients. - Creates a new instance of . - There must be exactly 7 values in the array with the form [G, A, B, C, D, E, F]. - - - The G coefficient. - The A coefficient. - The B coefficient. - The C coefficient. - The D coefficient. - The E coefficient. - The F coefficient. - Creates a new instance of . - - - - Gets or sets the A coefficient. - - - - - Gets or sets the B coefficient. - - - - - Gets or sets the C coefficient. - - - - - Gets or sets the D coefficient. - - - - - Gets or sets the E coefficient. - - - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the F coefficient. - - - - - Gets or sets the G coefficient. - - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Inverts coefficients for a common transfer function equation. - Returns the mathematically inverted parametric transfer function equation. - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - The input to transform. - Transform a single input by this transfer function. - Returns the transformed input. - For negative inputs, returns `-Transform(Math.Abs(x))`. - - - To be added. - To be added. - To be added. - - - Gets the coefficients as an array with the form [G, A, B, C, D, E, F]. - - - - - The various types of color sapces. - - - - The CMYK color space. - - - The gray color space. - - - The RGB color space. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Holds a premultiplied color table for indexed 8-bit bitmaps. - This class is used to represent a color lookup table for indexed bitmap images. The table can contain up to (256) colors (8 bits). The colors are stored are premultiplied 32-bit colors. - - - Creates a new, empty color table with 256 empty elements. - - - - The unpremultiplied colors to initialize with. - Creates a color table with the provided unpremultiplied colors, up to (256) colors can be provided. - The colors will be automatically premultiplied. - - - The premultiplied colors to initialize with. - Creates a color table with the provided premultiplied colors, up to (256) colors can be provided. - - - - The number of empty colors to initialize with. - Creates a color table with the specified number of elements, with empty colors. - - - - The unpremultiplied colors to initialize with. - The number of colors to initialize with. - Creates a color table with the provided unpremultiplied colors, but only consumes the first count elements from the colors array. - - - - The premultiplied colors to initialize with. - The number of colors to initialize with. - Creates a color table with the provided premultiplied colors, but only consumes the first count elements from the colors array. - - - - Gets a copy of the premultiplied colors in the color table. - - - - - Gets the number of colors in the lookup table. - - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - The index of the color to get. - Returns the unpremultiplied color at the specified index. - Returns the unpremultiplied color. - This is equivalent to premultiplying the value from . - - - - Gets the premultiplied color at the specified index. - - - - - Gets the maximum number of colors in the color lookup table. - - - - Returns an unmanaged pointer to the color lookup table. - - - - - Gets a copy of the unpremultiplied colors in the color table. - - The is equivalent to premultiplying the value of . - - - Describes how to interpret the components of a pixel. - - - - To be added. - - - Represents a 8-bit alpha-only color. - - - To be added. - - - Represents a 16-bit color with the format ARGB. - - - To be added. - - - To be added. - - - Represents a 32-bit color with the format BGRA. - - - Represents an opaque 8-bit grayscale color. - - - Represents a 8-bit indexed color. - - - To be added. - - - To be added. - - - Represents an opaque 32-bit color with the format RGB, with 10 bits per color component. - - - Represents an opaque 16-bit color with the format RGB, with the red and blue components being 5 bits and the green component being 6 bits. - - - Represents an opaque 32-bit color with the format RGB, with 8 bits per color component. - - - Represents a 32-bit color with the format RGBA, with 10 bits per color component and 2 bits for the alpha component. - - - To be added. - - - Represents a 32-bit color with the format RGBA. - - - Represents a floating-point based color with the format RGBA. - - - To be added. - - - To be added. - - - To be added. - - - Unknown encoding. - - - Flags used by the method. - - - - Consume all edges of the rectangle. - - - Only use the height component of the rectangle. - - - Only use the left component of the rectangle. - - - None of the edges have been specified. - - - Only use the top component of the rectangle. - - - Only use the width component of the rectangle. - - - The holds an immutable data buffer. - - Not only is the data immutable, but the actual pointer that is returned by the property is guaranteed to always be the same for the life of this instance. - The method can be used to return a that wraps this and allows for .NET APIs to scan the contents of the as a stream. - - - - Returns a span that wraps the underlying data. - Returns the data as a span. - This span is only valid as long as the data is valid. - - - Wraps the as a . - Returns the new . - - - - Whether or not to dispose the data object when the stream is disposed. - Wraps the as a . - Returns the new . - - - - The stream to read. - Returns a new instance with a copy of the data from the stream. - Returns the new instance. - - - - The size of the data buffer to create. - Returns a new instance with uninitialized data. - Returns the new instance. - - - - To be added. - To be added. - To be added. - To be added. - - - The stream to read. - Returns a new instance with a copy of the data from the stream. - Returns the new instance. - - - - The file to open. - Returns a new instance with the data from the file. - Returns the new instance. - - - - The size of the data buffer to create. - Returns a new instance with uninitialized data. - Returns the new instance. - - - - The stream to read. - The amount of data to read. - Returns a new instance with a copy of the data from the stream. - Returns the new instance. - - - - The stream to read. - The amount of data to read. - Returns a new instance with a copy of the data from the stream. - Returns the new instance. - - - - The stream to read. - The amount of data to read. - Returns a new instance with a copy of the data from the stream. - Returns the new instance. - - - - The pointer to a buffer. - The length of the buffer. - Returns a new instance with reference to the specified data. - Returns the new instance with reference to the specified data. - The caller is responsible for ensuring the data buffer lives as long as the instance. - - - The stream to read. - The amount of data to read. - Returns a new instance with a copy of the data from the stream. - Returns the new instance. - - - - The stream to read. - The amount of data to read. - Returns a new instance with a copy of the data from the stream. - Returns the new instance. - - - - The stream to read. - The amount of data to read. - Returns a new instance with a copy of the data from the stream. - Returns the new instance. - - - - The pointer to a buffer. - The length of the buffer. - The delegate to invoke when the instance is ready to be discarded. - Returns a new instance with reference to the specified data. - Returns the new instance with reference to the specified data. - The caller is responsible for ensuring the data buffer lives as long as the instance. - - - The pointer to a buffer. - The length of the buffer. - The delegate to invoke when the instance is ready to be discarded. - The user state to pass to the delegate when it is invoked. - Returns a new instance with reference to the specified data. - Returns the new instance with reference to the specified data. - The caller is responsible for ensuring the data buffer lives as long as the instance. - - - The array of bytes that will be copied. - Returns a new instance with a copy of the provided byte array. - Returns the new instance with a copy of the data. - - - - The span of bytes that will be copied. - Returns a new instance with a copy of the provided byte span. - Returns the new instance with a copy of the data. - - - - The array of bytes that will be copied. - The size of the buffer to create. - Returns a new instance with a copy of the provided byte array. - Returns the new instance with a copy of the data. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The pointer to a buffer. - The length of the buffer. - Returns a new instance with a copy of the provided byte buffer. - Returns the new instance with a copy of the data. - - - - Gets a pointer to the data wrapped by this . - - - - - Specify true to release both managed and unmanaged resources, false to release only unmanaged resources. - Releases the resources associated with the data. If this was created with one of the methods, then the operating system's "free" method will be called on the data. - - - - Gets a reference to the empty data instance. - - - - - Gets a value indicating whether or not the data is empty. - - - - - The stream to save the data into. - Saves the buffer into the provided stream. - - - - Gets the size of this data object in bytes. - - - - - To be added. - To be added. - To be added. - - - The offset of the data. - The length for the new . - Creates a new that points to a slice in this . - - - - - Copies the data object into a byte array. - Returns the byte array of the data. - - - - The pointer to the byte buffer. - The user state passed to . - The delegate that is used when a instance is about to be released. - - - - Channel selector type for the method. - - - - The alpha channel. - - - The blue channel. - - - The green channel. - - - The red channel. - - - The channel is not known. - - - A high-level API for creating a document-based canvas. - - to get the -canvas, and then complete the page with a call to -. Finally, call - to complete the document. -]]> - - - - Stops producing the document immediately. - - - - The width of the page. - The height of the page. - Begins a new page for the document, returning the canvas that will draw into the page. - Returns a canvas for the new page. - The document owns this canvas, and it will go out of scope when or is called, or the document is deleted. - - - The width of the page. - The height of the page. - The area for the page contents. - Begins a new page for the document, returning the canvas that will draw into the page. - Returns a canvas for the new page. - The document owns this canvas, and it will go out of scope when or is called, or the document is deleted. - - - Closes the current file or stream holding the document's contents. - - - - The stream to write to. - Create a PDF-backed document, writing the results into a stream. - Returns the new PDF-backed document. - - - - The stream to write to. - Create a PDF-backed document, writing the results into a stream. - Returns the new PDF-backed document. - - - - The path of the file to write to. - Create a PDF-backed document, writing the results into a file. - Returns the new PDF-backed document. - - - - The stream to write to. - The document metadata to include. - Create a PDF-backed document, writing the results into a stream. - Returns the new PDF-backed document. - - - - The stream to write to. - The DPI (pixels-per-inch) at which features without native PDF support will be rasterized. - Create a PDF-backed document, writing the results into a stream. - Returns the new PDF-backed document. - PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. - - - The stream to write to. - The document metadata to include. - Create a PDF-backed document with the specified metadata, writing the results into a stream. - Returns the new PDF-backed document. - - - - The stream to write to. - The DPI (pixels-per-inch) at which features without native PDF support will be rasterized. - Create a PDF-backed document, writing the results into a stream. - Returns the new PDF-backed document. - PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. - - - The path of the file to write to. - The document metadata to include. - Create a PDF-backed document with the specified metadata, writing the results into a file. - Returns the new PDF-backed document. - - - - The path of the file to write to. - The DPI (pixels-per-inch) at which features without native PDF support will be rasterized. - Create a PDF-backed document, writing the results into a file. - Returns the new PDF-backed document. - PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. - - - The stream to write to. - The document metadata to include. - The DPI (pixels-per-inch) at which features without native PDF support will be rasterized. - Create a PDF-backed document with the specified metadata, writing the results into a stream. - Returns the new PDF-backed document. - PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. - - - The stream to write to. - Create a XPS-backed document, writing the results into a stream. - Returns the new XPS-backed document. - - - - The stream to write to. - Create a XPS-backed document, writing the results into a stream. - Returns the new XPS-backed document. - - - - The path of the file to write to. - Create a XPS-backed document, writing the results into a file. - Returns the new XPS-backed document. - - - - The stream to write to. - The DPI (pixels-per-inch) at which features without native XPS support will be rasterized. - Create a XPS-backed document, writing the results into a stream. - Returns the new XPS-backed document. - XPS pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. - - - The stream to write to. - The DPI (pixels-per-inch) at which features without native XPS support will be rasterized. - Create a XPS-backed document, writing the results into a stream. - Returns the new XPS-backed document. - XPS pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. - - - The path of the file to write to. - The DPI (pixels-per-inch) at which features without native XPS support will be rasterized. - Create a XPS-backed document, writing the results into a file. - Returns the new XPS-backed document. - XPS pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. - - - Gets the default DPI for raster graphics. - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Completes the drawing for the current page created by . - - - - Optional metadata to be passed into the PDF factory function. - - - - The encoding quality. - Creates a new instance of with the specified encoding quality. - The encoding quality is between 0 and 100. A quality of 101 indicates lossless encoding. - - - The DPI (pixels-per-inch) at which features without native PDF support will be rasterized. - Creates a new instance of with the specified raster DPI. - PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. - - - The DPI (pixels-per-inch) at which features without native PDF support will be rasterized. - The encoding quality. - Creates a new instance of with the specified raster DPI and encoding quality. - PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. The encoding quality is between 0 and 100. A quality of 101 indicates lossless encoding. - - - The name of the person who created the document. - - - - - The date and time the document was created. - - - - - The name of the product that created the original document, if the document was converted to PDF from another format. - - - - - Gets a new instance of with the values set to the defaults. - - - - Gets the default encoding quality (101% or lossless). - - - - Gets the default DPI (72.0 DPI). - - - - Gets or sets the encoding quality. - - - - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Comma-separated keywords associated with the document. - - - - - The date and time the document was most recently modified. - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets or sets a value indicating whether or not make the document PDF/A-2b conformant. - - - - - - - The product that is converting this document to PDF. - - Leave empty to get the default, correct value. - - - Gets or sets the DPI (pixels-per-inch) at which features without native PDF support will be rasterized. - - - - - - - The subject of the document. - - - - - The document's title. - - - - - Represents the base class for objects that draw into . - - - - - - Creates a new instance of . - - - - The value indicating whether this object should destroy the underlying native object. - Creates a new instance of . - - - - Gets the conservative bounds of what the drawable will draw. - - - - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - The canvas to draw on. - The matrix to use when drawing. - Draw the current drawable onto the specified canvas. - - - - The canvas to draw on. - The amount to translate along the x-coordinate. - The amount to translate along the y-coordinate. - Draw the current drawable onto the specified canvas. - - - - Gets the unique value for this instance. - - It is presumed that if two calls return the same value, then drawing this will result in the same image as well. - - - Invalidate the drawing generation ID, indicating that the drawing has changed. - This is typically used by the object itself in response to its internal state changing. - - - The canvas to draw on. - Implemented by derived types to draw the drawable to the canvas. - If the generation ID is the same, then the resulting image must be the same. - - - Implemented by derived types to return the conservative bounds of what the drawable will draw. - Returns the bounds. - - - - Implemented by derived types to create an immutable snapshot of the drawing. - Returns the new snapshot. - - - - Create an immutable snapshot of the drawing. - Returns the snapshot. - - - - The various types of shadow modes for use with the method. - - - - Draw both the shadow and the foreground. - - - Draw the shadow only. - - - A writeable, dynamically-sized, memory-based stream. - - - - Create a new instance of with an empty buffer. - - - - The stream to copy the data to. - Copies the data from the current stream to the specified stream. - - - - - The memory location to copy the data to. - Copies the data from the current stream to a memory location. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Returns a copy of the data written so far. - A copy of the data. - The caller is responsible for releasing the memory. - - - Returns a instance of the data in the current stream, and then resets the current stream. - Returns the instance. - After calling this method, this stream is reset to it's empty state. - - - Returns a read-only stream with the current data, and then resets the current stream. - The stream with the data. - After calling this method, this stream is reset to it's empty state. - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - The various formats used by a . - - - - The ASTC image format. - - - To be added. - - - The BMP image format. - - - The Adobe DNG image format. - - - The GIF image format. - - - The HEIF or High Efficiency Image File format. - - - The ICO image format. - - - The JPEG image format. - - - The KTX image format. - - - The PKM image format. - - - The PNG image format. - - - The WBMP image format. - - - The WEBP image format. - - - Describes the encoded image information. - - - - The color format. - Creates a new with the specified color format. - - - - The color format. - The alpha format. - The number of bits per color component. - Creates a new . - - - - Gets the encoded alpha format. - - - - - Gets the number of bits per color component. - - - - - Gets the number of bits per pixel. - - - - - Gets the encoded color format. - - - - - The various alpha formats used by a . - - - - Each pixel is either fully opaque or fully transparent. - - - Each pixel is opaque. - - - Each pixel has an unpremultiplied alpha. - - - The various color formats used by a . - - - - The color format is BGR, without transparency. Typically found in BMP. - - - The color format is BGRA, with transparency. Typically found in BMP. - - - The color format is BGR, without transparency. Typically found in BMP. - - - The color format is grayscale, without transparency. Typically found in PNG and WBMP. - - - The color format is grayscale, with transparency. Typically found in PNG. - - - The color format is CMYK, without transparency. Typically found in JPEG. - - - The color format is palette based. Typically found in PNG, GIF and BMP. - - - The color format is RGB, without transparency. Typically found in PNG and RAW. - - - The color format is RGBA, with transparency. Typically found in PNG and RAW. - - - The color format is YCCK, without transparency. Typically found in JPEG. - - - The color format is YUV, without transparency. Typically found in JPEG and WEBP. - - - The color format is YUVA, without transparency. Typically found in PNG and RAW. - - - Represents various origin values returned by . - - - - Reflected across x-axis. - - - Rotated 180°. - - - This is equivalent to . - - - Rotated 90° counter-clockwise. - - - Reflected across x-axis. Rotated 90° counter-clockwise. - - - Reflected across x-axis. Rotated 90° clockwise. - - - Rotated 90° clockwise. - - - Default. - - - Reflected across y-axis. - - - Text encoding definition. - - - - UTF-16 encoding. - - - UTF-32 encoding. - - - UTF-8 encoding. - - - A seekable stream backed by a file on the file system. - - - - The existing file to open for reading. - Creates a new that wraps the file with the specified path. - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - The path to check. - Determines whether the specified path is supported by a . - Returns if the path is supported, otherwise . - - - - Gets a value indicating whether the file could be opened. - - - - - The path to the file to open. - Opens a read-only stream to the specified file. - Returns a stream that contains the file contents. - - - - A writeable stream backed by a file on the file system. - - - - The new or existing file to open for writing. - Creates a new that wraps the file with the specified path. - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - The path to check. - Determines whether the specified path is supported by a . - Returns if the path is supported, otherwise . - - - - Gets a value indicating whether the file could be opened. - - - - - The path to the file to open. - Opens a write-only stream to the specified file. - Returns a stream that contains the file contents. - - - - Filter quality settings. - - - - High quality. - - - Low quality. - - - Medium quality. - - - Unspecified. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - To be added. - - - To be added. - - - To be added. - - - To be added. - - - To be added. - - - Manages a collection of fonts. - - - - Creates a new, default font manager. - Returns the new font manager. - - - - The data to read the typeface from. - The TTC index. - Creates a new from the specified . - Returns the new , or if the data is not recognized. - - - - The stream to read the typeface from. - The TTC index. - Creates a new from the specified stream. - Returns the new , or if the stream is not recognized. - - - - The stream to read the typeface from. - The TTC index. - Creates a new from the specified stream. - Returns the new , or if the stream is not recognized. - - - - The path to the typeface. - The TTC index. - Creates a new from the specified file path. - Returns the new , or if the file does not exist or the contents are not recognized. - - - - Gets the default font manager. - - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Gets all the font family names loaded by this font manager. - - - - - Gets the number of font families available. - - - - - The index of the font family name to retrieve. - Returns the font family name for the specified index. - Returns the font family name. - - - - Returns all the font family names loaded by this font manager. - Returns an array of all the font family names loaded by this font manager. - - - - The index of the font style set to retrieve. - Returns the font style set for the specified index. - Returns the font style set. - The index must be in the range of [0, ). - - - The family name to use when searching. - Use the system fallback to find the typeface styles for the given family. - Returns a with all the font styles supported by the specified family. - Never returns and will return an empty set if the family is not found. - - - The character to find a typeface for. - Use the system fallback to find a typeface for the given character. - Returns the that contains the given character, or if none was found. - - - - The character to find a typeface for. - Use the system fallback to find a typeface for the given character. - Returns the that contains the given character, or if none was found. - - - - The family name to use when searching. - The character to find a typeface for. - Use the system fallback to find a typeface for the given character. - Returns the that contains the given character, or if none was found. - - - - The family name to use when searching. - The character to find a typeface for. - Use the system fallback to find a typeface for the given character. - Returns the that contains the given character, or if none was found. - - - - The family name to use when searching. - The ISO 639, 15924, and 3166-1 code to use when searching, such as "ja" and "zh". - The character to find a typeface for. - Use the system fallback to find a typeface for the given character. - Returns the that contains the given character, or if none was found. - - - - - - The family name to try and use. - The ISO 639, 15924, and 3166-1 code to use when searching, such as "ja" and "zh". - The character to find a typeface for. - Use the system fallback to find a typeface for the given character. - Returns the that contains the given character, or if none was found. - - - - - - The family name to use when searching. - The font style to use when searching. - The ISO 639, 15924, and 3166-1 code to use when searching, such as "ja" and "zh". - The character to find a typeface for. - Use the system fallback to find a typeface for the given character. - Returns the that contains the given character, or if none was found. - - - - - - The family name to use when searching. - The font weight to use when searching. - The font width to use when searching. - The font slant to use when searching. - The ISO 639, 15924, and 3166-1 code to use when searching, such as "ja" and "zh". - The character to find a typeface for. - Use the system fallback to find a typeface for the given character. - Returns the that contains the given character, or if none was found. - - - - - - The family name to use when searching. - The font weight to use when searching. - The font width to use when searching. - The font slant to use when searching. - The ISO 639, 15924, and 3166-1 code to use when searching, such as "ja" and "zh". - The character to find a typeface for. - Use the system fallback to find a typeface for the given character. - Returns the that contains the given character, or if none was found. - - - - - - The family name to use when searching. - The font weight to use when searching. - The font width to use when searching. - The font slant to use when searching. - The ISO 639, 15924, and 3166-1 code to use when searching, such as "ja" and "zh". - The character to find a typeface for. - Use the system fallback to find a typeface for the given character. - Returns the that contains the given character, or if none was found. - - - - - - To be added. - To be added. - To be added. - To be added. - - - The family name to use when searching. - The font style to use when searching. - Find the closest matching typeface to the specified family name and style. - Returns the that contains the given family name and style, or the default font if no matching font was found. - Will never return , as it will return the default font if no matching font is found. - - - The typeface to use when searching. - The font style to use when searching. - Find the closest matching typeface to the specified typeface and style. - Returns the that contains the given typeface and style, or the default font if no matching font was found. - Will never return , as it will return the default font if no matching font is found. - - - Structure to represent measurements for a font. - - - - Gets the recommended distance above the baseline. - - Will be <= 0. - - - Gets the average character width. - - Will be >= 0. - - - Gets the greatest distance below the baseline for any glyph. - - Will be >= 0. - - - Gets the cap height. - - Will be > 0, or 0 if cannot be determined. - - - Gets the recommended distance below the baseline. - - Will be >= 0. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Gets the recommended distance to add between lines of text. - - Will be >= 0. - - - Gets the max character width. - - Will be >= 0. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets the position of the bottom of the strikeout stroke relative to the baseline. - - This value is typically negative when valid. - - - Gets the thickness of the strikeout. - - - - - Gets the greatest distance above the baseline for any glyph. - - Will be <= 0. - - - Gets the position of the top of the underline stroke relative to the baseline. - - - Negative - underline should be drawn above baseline. - Positive - underline should be drawn below baseline. - Zero - underline should be drawn on baseline.underline position, or 0 if cannot be determined. - null - does not have an UnderlinePosition. - - - - Gets the thickness of the underline. - - - 0 - if the thickness can not be determined - null - if the thickness is not set. - - - - Gets the height of an 'x' in px. - - 0 if no 'x' in face. - - - Gets the maximum bounding box x value for all glyphs. - - - - - Gets the minimum bounding box x value for all glyphs. - - - - - Represents a particular style (bold, italic, condensed) of a typeface. - - - - Creates a new with a normal weight, a normal width and upright. - - - - The weight (light or bold). - The width (condensed or expanded). - The slant (italic). - Creates a new with the specified weight, width and slant. - - - - The weight (light or bold). - The width (condensed or expanded). - The slant (italic). - Creates a new with the specified weight, width and slant. - - - - Gets a new upright font style that is bold. - - - - - Gets a new italic font style that is bold. - - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - Gets a new italic font style. - - - - - Gets a new normal (upright and not bold) font style. - - - - - Gets the slant of this style. - - - - - Gets the weight of this style. - - The weight could potentially be one of the values of . - - - Gets the width of this style. - - The weight could potentially be one of the values of . - - - Represets the set of styles for a particular font family. - - - - Creates a new, empty . - - - - Gets the number of font styles in the set. - - - - - The font style to match. - Creates a new with a style that is the closest match to the specified font style. - Returns the new . - - - - The index of the font style to match. - Creates a new with the style that is the closest match to the style at the specified index. - Returns the new . - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Returns an enumerator that iterates through the font styles. - Returns an enumerator. - - - - The index of the font style. - Returns the name of the font style. - Returns the name of the font style. - - - - The index of the font style. - Gets the font style at the specified index. - - - - - Returns an enumerator that iterates through the font styles. - Returns an enumerator. - - - - Various font slants for use with . - - - - The italic font slant, in which the slanted characters appear as they were designed. - - - The oblique font slant, in which the characters are artificially slanted. - - - The upright/normal font slant. - - - Various predefined font weights for use with . - Font weights can range from anywhere between 100 to 1000 (inclusive). - - - A thick font weight of 900. - - - A thick font weight of 700. This is the default for a bold font. - - - A thick font weight of 1000. - - - A thick font weight of 800. - - - A thin font weight of 200. - - - The font has no thickness at all. - - - A thin font weight of 300. - - - A thicker font weight of 500. - - - A typical font weight of 400. This is the default font weight. - - - A thick font weight of 600. - - - A thin font weight of 100. - - - Various predefined font widths for use with . - - - - A condensed font width of 3. - - - An expanded font width of 7. - - - A condensed font width of 2. - - - An expanded font width of 8. - - - A normal font width of 5. This is the default font width. - - - A condensed font width of 4. - - - An expanded font width of 6. - - - A condensed font width of 1. - - - An expanded font width of 9. - - - A read-only stream that buffers the specified first chunk of bytes. - This is useful for decoding images using streams that are not seekable, since needs to read the first few bytes to determine the codec to use. - - - The stream to buffer. - The number of bytes to buffer. - Creates a new instance of that wraps the specified stream. - - - - The stream to buffer. - The number of bytes to buffer. - Creates a new instance of that wraps the specified stream. - - - - The stream to buffer. - The number of bytes to buffer. - Whether or not to dispose the underlying stream when this stream is disposed. - Creates a new instance of that wraps the specified stream. - - - - The stream to buffer. - The number of bytes to buffer. - Whether or not to dispose the underlying stream when this stream is disposed. - Creates a new instance of that wraps the specified stream. - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any managed objects. - - - - Implemented by derived types to copy the current stream. - Returns a pointer to the new instance. - - - - Implemented by derived types to return the total length of the stream. - Returns the total length of the stream. - - - - Implemented by derived types to get the current position in the stream - Returns the current position in the stream. - - - - Implemented by derived types to indicate whether this stream can report it's total length. - Returns a value indicating whether this stream can report it's total length. - - - - Implemented by derived types to indicate whether this stream can report it's current position. - Returns a value indicating whether this stream can report it's current position. - - - - Implemented by derived types to indicate whether all the bytes in the stream have been read. - Returns a value indicating whether all the bytes in the stream have been read. - - - - The relative offset. - Implemented by derived types to seek to a relative offset. - Returns if seeking is supported and the seek was successful, otherwise . - If an attempt is made to move to a position outside the stream, the position must be set to the closest point within the stream (beginning or end). - - - The buffer to read into. - The number of bytes to read. - Implemented by derived types to copy the specified number of bytes into the specified buffer. - Returns the number of bytes actually peeked/copied. - The stream's cursor must be returned to the position before this method was called. - - - The buffer to read into. - The number of bytes to read. - Implemented by derived types to copy the specified number of bytes into the specified buffer. - Returns the number of bytes actually read. - - - - Implemented by derived types to rewind the current stream. - Returns if the stream is known to be at the beginning after this call returns. - - - - The absolute position. - Implemented by derived types to seek to an absolute position. - Returns if seeking is supported and the seek was successful, otherwise . - If an attempt is made to move to a position outside the stream, the position must be set to the closest point within the stream (beginning or end). - - - A read-only stream that buffers the specified first chunk of bytes. - This is useful for decoding images using streams that are not seekable, since needs to read the first few bytes to determine the codec to use. - - - The stream to buffer. - Creates a new instance of that wraps the specified stream. - - - - The stream to buffer. - Whether or not to dispose the underlying stream when this stream is disposed. - Creates a new instance of that wraps the specified stream. - - - - The stream to buffer. - The number of bytes to buffer. - Creates a new instance of that wraps the specified stream. - - - - The stream to buffer. - The number of bytes to buffer. - Whether or not to dispose the underlying stream when this stream is disposed. - Creates a new instance of that wraps the specified stream. - - - - Gets a value indicating whether the current stream supports reading. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Gets a value indicating whether the current stream supports writing. - - - - - The default number of bytes to buffer (4096 bytes). - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Clears all buffers for this stream and causes any buffered data to be written to the underlying device. - - - - Gets the stream length in bytes. - - - - - Gets the position within the current stream. - - - - - The buffer to which bytes are to be copied. - The byte offset in the buffer at which to begin reading bytes. - The number of bytes to be read. - Copies bytes from the current buffered stream to an array. - Returns the total number of bytes read into the buffer array. - - - - The byte offset relative to the specified origin. - The reference point from which to obtain the new position. - Sets the position within the current buffered stream. - Returns the new position within the current buffered stream. - - - - An integer indicating the desired length of the current buffered stream in bytes. - Sets the length of the buffered stream. - - - - The byte array from which to copy count bytes to the current buffered stream. - The offset in the buffer at which to begin copying bytes to the current buffered stream. - The number of bytes to be written to the current buffered stream. - Copies bytes to the buffered stream and advances the current position within the buffered stream by the number of bytes written. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - High contrast configuration settings for use with . - - - - Whether or not the color will be converted to grayscale. - Whether or not to invert brightness, lightness, or neither. - The amount to adjust the contrast by, in the range -1.0 through 1.0. - Creates a new instance of . - - - - Gets or sets the amount to adjust the contrast by, in the range -1.0 through 1.0.. - - - - - Gets a new instance with the values set to the defaults. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Gets or sets a value indicating whether the color will be converted to grayscale. - - - - - Gets or sets a value indicating whether to invert brightness, lightness, or neither. - - - - - Gets a value indicating if the configuration is valid. - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Various invert styles for high contrast calculations. - - - - Invert the brightness. - - - Invert the lightness. - - - Do not invert. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Convenience methods for . - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - The pixel geometry to test. - Returns true if the pixel geometry is BGR. - - - - - The pixel geometry to test. - Returns true if the pixel geometry is horizontal. - - - - - The pixel geometry to test. - Returns true if the pixel geometry is RGB. - - - - - The pixel geometry to test. - Returns true if the pixel geometry is vertical. - - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - The to convert. - Converts a to an equivalent , if possible. - Returns the equivalent , or if there is none. - - - - The to convert. - Converts a to an equivalent . - Returns the equivalent . - - - - The to convert. - Converts a to the equivalent OpenGL sized format, if possible. - Returns the equivalent OpenGL sized format, or 0 if there is none. - - - - The to convert. - Converts a to the equivalent OpenGL sized format, if possible. - Returns the equivalent OpenGL sized format, or 0 if there is none. - - - - The to convert. - Converts a to an equivalent , if possible. - Returns the equivalent , or if there is none. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - An abstraction for drawing a rectangle of pixels. - - An image is an abstraction of pixels, though the particular type of image could be actually storing its data on the GPU, or as drawing commands (picture or PDF or otherwise), ready to be played back into another canvas. - - The content of an image is always immutable, though the actual storage may change, if for example that image can be recreated via encoded data or other means. - - An image always has a non-zero dimensions. If there is a request to create a new image, either directly or via a surface, and either of the requested dimensions are zero, then will be returned. - - - - Gets the configured for the bitmap. - - - - - The filter to apply to the current image. - The active portion of this image. - Constrains the device-space extent of the image to the given rectangle. - The active portion of the resulting image - The amount to translate the resulting image relative to the source when it is drawn. - Applies a given image filter to this image, and return the filtered result. - Returns the resulting image after the filter is applied, or if the image could not be created or would be transparent black (#00000000). - - - - The filter to apply to the current image. - The active portion of this image. - Constrains the device-space extent of the image to the given rectangle. - The active portion of the resulting image - The amount to translate the resulting image relative to the source when it is drawn. - Applies a given image filter to this image, and return the filtered result. - Returns the resulting image after the filter is applied, or if the image could not be created or would be transparent black (#00000000). - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets the image color space. - - - - - Gets the image color type. - - - - - The image information to use. - Creates a new raster-based using the specified information. - Returns the new instance. - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Encodes the image using the format. - Returns the wrapping the encoded image. - Use the overload that takes a if you want to encode in a different format. - - - The serializer to use to encode the image. - Encodes the image using the specified serializer. - Returns the wrapping the encoded image. - - - - The file format used to encode the image. - The quality level to use for the image. This is in the range from 0-100. - Encodes the image using the specified format. - Returns the wrapping the encoded image. - The quality is a suggestion, and not all formats (for example, PNG) respect or support it. - - - Gets the encoded image pixels as a , if the image was created from supported encoded stream format. - - Returns if the image mage contents are not encoded. - - - The graphics context. - The description of the existing texture. - Creates a new image from the specified texture descriptor. - Returns the new image, or if the specified descriptor is unsupported. - SkiaSharp will delete or recycle the texture when the image is released. - - - The graphics context. - The description of the existing OpenGL texture. - Creates a new image from the specified OpenGL texture descriptor. - Returns the new image, or if the specified descriptor is unsupported. - SkiaSharp will delete or recycle the OpenGL texture when the image is released. - - - The graphics context. - The description of the existing backend texture. - The color type to use for the image. - Creates a new image from the specified texture. - Returns the new image, or if the specified texture is unsupported. - SkiaSharp will delete or recycle the texture when the image is released. - - - The graphics context. - The description of the existing texture. - The alpha type of the texture. - Creates a new image from the specified texture descriptor. - Returns the new image, or if the specified descriptor is unsupported. - SkiaSharp will delete or recycle the texture when the image is released. - - - The graphics context. - The description of the existing OpenGL texture. - The alpha type of the texture. - Creates a new image from the specified OpenGL texture descriptor. - Returns the new image, or if the specified descriptor is unsupported. - SkiaSharp will delete or recycle the texture when the image is released. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The graphics context. - The description of the existing backend texture. - The origin of the texture. - The color type to use for the image. - Creates a new image from the specified texture. - Returns the new image, or if the specified texture is unsupported. - SkiaSharp will delete or recycle the texture when the image is released. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The graphics context. - The description of the existing backend texture. - The origin of the texture. - The color type to use for the image. - The transparency mode to use for the image. - Creates a new image from the specified texture. - Returns the new image, or if the specified texture is unsupported. - SkiaSharp will delete or recycle the texture when the image is released. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The graphics context. - The description of the existing backend texture. - The origin of the texture. - The color type to use for the image. - The transparency mode to use for the image. - The colorspace to use for the image. - Creates a new image from the specified texture. - Returns the new image, or if the specified texture is unsupported. - SkiaSharp will delete or recycle the texture when the image is released. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The bitmap that will be used as the source for the image. - Creates a new image from the provided . - An image whose contents are the contents of the specified bitmap. - If the bitmap is marked immutable, and its pixel memory is shareable, it may be shared instead of copied. - - - The data holding the encoded image. - Creates a new image from an encoded image wrapped by the data. - The decoded image, or on error. - - - - The stream holding the encoded image. - Creates a new image from an encoded image stream. - The decoded image, or on error. - - - - The buffer holding the encoded image. - Creates a new image from an encoded image buffer. - The decoded image, or on error. - - - - The stream holding the encoded image. - Creates a new image from an encoded image stream. - The decoded image, or on error. - - - - The buffer holding the encoded image. - Creates a new image from an encoded image buffer. - The decoded image, or on error. - - - - The path to an encoded image on the file system. - Creates a new image from an encoded image file. - The decoded image, or on error. - - - - The data holding the encoded image. - The bounds for a subset of the image. - Creates a new image from an encoded image wrapped by the data. - The decoded image, or on error. - - - - The picture. - The size of the raster image. - Creates a new image from the provided . - An image whose contents is the picture. - - - - The picture. - The size of the raster image. - The matrix to use when reading the image. - Creates a new image from the provided . - An image whose contents is the picture. - - - - The picture. - The size of the raster image. - The paint to use when reading the image. - Creates a new image from the provided . - An image whose contents is the picture. - - - - The picture. - The size of the raster image. - The matrix to use when reading the image. - The paint to use when reading the image. - Creates a new image from the provided . - An image whose contents is the picture. - - - - The pixmap that contains the image information and buffer location. - Creates a new image from a copy of an in-memory buffer. - A new image with a copy of the contents of the specified buffer, or on error. - - - - The image information describing the encoding of the image in the stream. - The stream of image data. - Creates a new image from a copy of the stream data. - A new image with a copy of the contents of the specified buffer, or on error. - - - - The image information describing the encoding of the image in memory. - The buffer of image data. - Creates a new image from a copy of an in-memory buffer. - A new image with a copy of the contents of the specified buffer, or on error. - - - - The image information describing the encoding of the image in memory. - The pointer to the image in memory. - Creates a new image from a copy of an in-memory buffer. - A new image with a copy of the contents of the specified buffer, or on error. - - - - The image information describing the encoding of the image in the stream. - The stream of image data. - Creates a new image from a copy of the stream data. - A new image with a copy of the contents of the specified buffer, or on error. - - - - The image information describing the encoding of the image in memory. - The buffer of image data. - Creates a new image from a copy of an in-memory buffer. - A new image with a copy of the contents of the specified buffer, or on error. - - - - The image information describing the encoding of the image in the stream. - The stream of image data. - The specified the number of bytes used per row in the image. - Creates a new image from a copy of the stream data. - A new image with a copy of the contents of the specified buffer, or on error. - - - - The image information describing the encoding of the image in memory. - The buffer of image data. - The specified the number of bytes used per row in the image. - Creates a new image from a copy of an in-memory buffer. - A new image with a copy of the contents of the specified buffer, or on error. - - - - The image information describing the encoding of the image in memory. - The pointer to the image in memory. - The specified the number of bytes used per row in the image. - Creates a new image from a copy of an in-memory buffer. - A new image with a copy of the contents of the specified buffer, or on error. - - - - The image information describing the encoding of the image in the stream. - The stream of image data. - The specified the number of bytes used per row in the image. - Creates a new image from a copy of the stream data. - A new image with a copy of the contents of the specified buffer, or on error. - - - - The image information describing the encoding of the image in memory. - The buffer of image data. - The specified the number of bytes used per row in the image. - Creates a new image from a copy of an in-memory buffer. - A new image with a copy of the contents of the specified buffer, or on error. - - - - The image information describing the encoding of the image in memory. - The pointer to the image in memory. - The specified the number of bytes used per row in the image. - The color table to use with the image data. - Creates a new image from a copy of an in-memory buffer. - A new image with a copy of the contents of the specified buffer, or on error. - - - - The image information describing the encoding of the image in memory. - The data object that contains the pixel data. - The specified the number of bytes used per row in the image. - Creates a new image from an in-memory buffer. - A new image wrapping the specified buffer, or on error. - - - - The pixmap that contains the image information and buffer location. - Creates a new image from an in-memory buffer. - A new image wrapping the specified buffer, or on error. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The image information describing the encoding of the image in memory. - The pointer to the image in memory. - Creates a new image from an in-memory buffer. - A new image wrapping the specified buffer, or on error. - - - - The pixmap that contains the image information and buffer location. - The delegate to invoke when the image is about to be destroyed. - Creates a new image from an in-memory buffer. - A new image wrapping the specified buffer, or on error. - - - - The image information describing the encoding of the image in memory. - The data object that contains the pixel data. - The specified the number of bytes used per row in the image. - Creates a new image from an in-memory buffer. - A new image wrapping the specified buffer, or on error. - - - - The image information describing the encoding of the image in memory. - The pointer to the image in memory. - The specified the number of bytes used per row in the image. - Creates a new image from an in-memory buffer. - A new image wrapping the specified buffer, or on error. - - - - The pixmap that contains the image information and buffer location. - The delegate to invoke when the image is about to be destroyed. - The user data to use when invoking the delegate. - Creates a new image from an in-memory buffer. - A new image wrapping the specified buffer, or on error. - - - - The graphics context. - The description of the existing texture. - Creates a new image from the specified texture descriptor. - Returns the new image, or if the specified descriptor is unsupported. - - - - The graphics context. - The description of the existing texture. - Creates a new image from the specified OpenGL texture descriptor. - Returns the new image, or if the specified descriptor is unsupported. - - - - The graphics context. - The description of the existing backend texture. - The color type to use for the image. - Creates a new image from the specified texture. - Returns the new image, or if the specified texture is unsupported - - - - The graphics context. - The description of the existing texture. - The alpha type of the texture. - Creates a new image from the specified texture descriptor. - Returns the new image, or if the specified descriptor is unsupported. - - - - The graphics context. - The description of the existing OpenGL texture. - The alpha type of the texture. - Creates a new image from the specified OpenGL texture descriptor. - Returns the new image, or if the specified descriptor is unsupported. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The graphics context. - The description of the existing backend texture. - The origin of the texture. - The color type to use for the image. - Creates a new image from the specified texture. - Returns the new image, or if the specified texture is unsupported - - - - The graphics context. - The description of the existing texture. - The alpha type of the texture. - The delegate to invoke when the image is about to be destroyed. - Creates a new image from the specified texture descriptor. - Returns the new image, or if the specified descriptor is unsupported. - - - - The graphics context. - The description of the existing OpenGL texture. - The alpha type of the texture. - The delegate to invoke when the image is about to be destroyed. - Creates a new image from the specified OpenGL texture descriptor. - Returns the new image, or if the specified descriptor is unsupported. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The graphics context. - The description of the existing backend texture. - The origin of the texture. - The color type to use for the image. - The transparency mode to use for the image. - Creates a new image from the specified texture. - Returns the new image, or if the specified texture is unsupported - - - - The graphics context. - The description of the existing texture. - The alpha type of the texture. - The delegate to invoke when the image is about to be destroyed. - The user data to use when invoking the delegate. - Creates a new image from the specified texture descriptor. - Returns the new image, or if the specified descriptor is unsupported - - - - The graphics context. - The description of the existing OpenGL texture. - The alpha type of the texture. - The delegate to invoke when the image is about to be destroyed. - The user data to use when invoking the delegate. - Creates a new image from the specified OpenGL texture descriptor. - Returns the new image, or if the specified descriptor is unsupported - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The graphics context. - The description of the existing backend texture. - The origin of the texture. - The color type to use for the image. - The transparency mode to use for the image. - The colorspace to use for the image. - Creates a new image from the specified texture. - Returns the new image, or if the specified texture is unsupported - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The graphics context. - The description of the existing backend texture. - The origin of the texture. - The color type to use for the image. - The transparency mode to use for the image. - The colorspace to use for the image. - The delegate to invoke when the image is about to be destroyed. - Creates a new image from the specified texture. - Returns the new image, or if the specified texture is unsupported - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The graphics context. - The description of the existing backend texture. - The origin of the texture. - The color type to use for the image. - The transparency mode to use for the image. - The colorspace to use for the image. - The delegate to invoke when the image is about to be destroyed. - The user data to use when invoking the delegate. - Creates a new image from the specified texture. - Returns the new image, or if the specified texture is unsupported - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets the image height. - - - - - To be added. - To be added. - To be added. - - - Gets a value indicating whether the image will be drawn as a mask, with no intrinsic color of its own - - - - - Gets a value indicating whether the image is backed by an image-generator or other source that creates (and caches) its pixels / texture on-demand. - - If this method returns , then will return . - - - Gets a value indicating whether the image is texture backed. - - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Returns the pixmap if the image is raster-based. - Returns the pixmap, or if the image does not have access to pixel data. - - - - The pixmap to receive the pixel information. - Returns the pixmap if the image is raster-based. - Returns on success, or if the image does not have access to pixel data. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The pixmap to read the pixel data into. - The source x-coordinate to start reading from. - The source y-coordinate to start reading from. - Copies the pixels from the image into the specified buffer. - Returns if the pixels were read, or if there was an error. - This method may return if the source rectangle [, , dst.Info.Width, dst.Info.Height] does not intersect the image, or if the color type/alpha type could not be converted to the destination types. - - - The pixmap to read the pixel data into. - The source x-coordinate to start reading from. - The source y-coordinate to start reading from. - Whether or not to cache intermediate results. - Copies the pixels from the image into the specified buffer. - Returns if the pixels were read, or if there was an error. - This method may return if the source rectangle [, , dst.Info.Width, dst.Info.Height] does not intersect the image, or if the color type/alpha type could not be converted to the destination types. - - - The image information describing the destination pixel buffer. - The pixel buffer to read the pixel data into. - The number of bytes in each row of in the destination buffer. - The source x-coordinate to start reading from. - The source y-coordinate to start reading from. - Copies the pixels from the image into the specified buffer. - Returns if the pixels were read, or if there was an error. - This method may return if the source rectangle [, , dstInfo.Width, dstInfo.Height] does not intersect the image, or if the color type/alpha type could not be converted to the destination types. - - - The image information describing the destination pixel buffer. - The pixel buffer to read the pixel data into. - The number of bytes in each row of in the destination buffer. - The source x-coordinate to start reading from. - The source y-coordinate to start reading from. - Whether or not to cache intermediate results. - Copies the pixels from the image into the specified buffer. - Returns if the pixels were read, or if there was an error. - This method may return if the source rectangle [, , dstInfo.Width, dstInfo.Height] does not intersect the image, or if the color type/alpha type could not be converted to the destination types. - - - The pixmap describing the destination pixel buffer. - The quality of scaling to use. - Copies the pixels from this image into the destination pixmap, scaling the image if the dimensions differ. - Returns on success, or if the color type/alpha type could not be converted to the destination types. - - - - The pixmap describing the destination pixel buffer. - The quality of scaling to use. - Whether or not to cache intermediate results. - Copies the pixels from this image into the destination pixmap, scaling the image if the dimensions differ. - Returns on success, or if the color type/alpha type could not be converted to the destination types. - - - - The rectangle indicating the subset to obtain. - Returns a new image that is a subset of this image. - Returns the new image, or if there was an error or the rectangle does not intersect the image. - The underlying implementation may share the pixels, or it may make a copy. - - - Returns a raster-based image of the current image. - Returns a raster-based copy of a texture image, or the same image if it already raster-based. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - The method in which to tile along the x-axis. - The method in which to tile along the y-axis. - Creates a new bitmap shader from the current image. - Returns a new bitmap shader that will draw the current image. - - - - The method in which to tile along the x-axis. - The method in which to tile along the y-axis. - The local matrix to use with the shader. - Creates a new bitmap shader from the current image. - Returns a new bitmap shader that will draw the current image. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets the unique ID associated with the image. - - - - - Gets the image width. - - - - - Hints to image calls where the system might cache computed intermediates. - - - - Use the system's default behaviour. - - - Caching should be avoided - - - Image filters for use with the property of a . - - - - The region to sample. - The minimum alpha for pixels within the region. - The maximum alpha for pixels outside the region. - The input filter to use. - Creates an image filter that samples a region. - Returns the new , or null on error. - If the sample is inside the region the alpha of the image is boosted up to a threshold value. If it is outside the region then the alpha is decreased to the threshold value. The (0, 0) point of the region corresponds to the upper left corner of the source image. - - - The region to sample. - The minimum alpha for pixels within the region. - The maximum alpha for pixels outside the region. - The input filter to use. - Creates an image filter that samples a region. - Returns the new , or null on error. - If the sample is inside the region the alpha of the image is boosted up to a threshold value. If it is outside the region then the alpha is decreased to the threshold value. The (0, 0) point of the region corresponds to the upper left corner of the source image. - - - The k1 constant value. - The k2 constant value. - The k3 constant value. - The k4 constant value. - Whether or not premultiplied colors are enforced. - The background image filter to use. If this is null, then the source bitmap is used. - The foreground image filter to use. If this is null, then the source bitmap is used. - The rectangle to which the output processing will be limited. - Creates an image filter that applies the specified arithmetic blend. - Returns the new , or null on error. - - - - The blend mode. - The background filter. - The foreground filter. - The rectangle to which the output processing will be limited. - Creates an image filter that applies a blend mode. - Returns the new , or null on error. - - - - The standard deviation of the Gaussian blur to apply (greater than 0) in the horizontal direction. - The standard deviation of the Gaussian blur to apply (greater than 0) in the vertical direction. - The input filter to use. - The rectangle to which the output processing will be limited. - Creates an image filter that applies a blur. - Returns the new , or null on error. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The color filter to use. - The input filter to use. - The rectangle to which the output processing will be limited. - Creates an image filter that applies a color filter. - Returns the new , or null on error. - - - - The outer (second) filter to apply. - The inner (first) filter to apply. - Creates an image filter, whose effect is to first apply the inner filter and then apply the outer filter to the result of the inner. - Returns the new , or null on error. - - - - The amount of dilation in the x-direction. - The amount of dilation in the y-direction. - The input filter to use. - The rectangle to which the output processing will be limited. - Creates an image filter that applies a dilation to pixels of a bitmap. - Returns the new , or null on error. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The channel in the x-direction to select for displacement. - The channel in the y-direction to select for displacement. - The amount to displace by. - The image filter to apply the displacement to. - The input filter to use. - The rectangle to which the output processing will be limited. - Creates an image filter that applies a displacement map. - Returns the new , or null on error. - - - - The direction of the light. - The color of the light. - The surface height to use. - The diffuse lighting constant. - The input filter to use. - The rectangle to which the output processing will be limited. - Creates an image filter that applies a distant diffuse lighting. - Returns the new , or null on error. - - - - The direction of the light. - The color of the light. - The surface height to use. - The specular lighting constant. - The shininess or specular exponent. - The input filter to use. - The rectangle to which the output processing will be limited. - Creates an image filter that applies a distant specular lighting. - Returns the new , or null on error. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The shadow offset in the x-direction. - The shadow offset in the y-direction. - The amount to blur in the x-direction. - The amount to blur in the y-direction. - The shadow color. - The shadow mode. - The input filter to use. - The rectangle to which the output processing will be limited. - Creates an image filter that applies a drop shadow. - Returns the new , or null on error. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The amount to erode in the x-direction. - The amount to erode in the y-direction. - The input filter to use. - The rectangle to which the output processing will be limited. - Creates an image filter that erodes the pixels of a bitmap. - Returns the new , or null on error. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The image to draw. - Creates an image filter that draws an image. - Returns the new , or null on error. - - - - The image to draw. - The rectangle of the source image to draw. - The rectangle of the destination area. - The filter quality. - Creates an image filter that draws an image. - Returns the new , or null on error. - - - - The rectangle area to magnify. - The amount of magnification to apply. - The input filter to use. - The rectangle to which the output processing will be limited. - Creates an image filter that magnifies an area of a bitmap. - Returns the new , or null on error. - - - - The transformation matrix. - The quality. - The input filter to use. - Creates an image filter that applies a transformation matrix. - Returns the new , or null on error. - - - - The kernel size in pixels, in each dimension (N by M). - The image processing kernel, with N * M elements in row order. - A scale factor applied to each pixel after convolution. - A bias factor added to each pixel after convolution. - An offset applied to each pixel coordinate before convolution. - How accesses outside the image are treated. - Whether or not all channels are convolved, or just the RGB channels. - The input filter to use. - The rectangle to which the output processing will be limited. - Creates an image that filter applies an NxM image processing kernel. - Returns the new , or null on error. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The image filters to merge. - The rectangle to which the output processing will be limited. - Creates an image filter that merges a set of image filters. - Returns the new , or null on error. - - - - The first image filter to merge. - The second image filter to merge. - The rectangle to which the output processing will be limited. - Creates an image filter that merges two image filters. - Returns the new , or null on error. - - - - The image filters to merge. - The blend modes to merge the filters with. - The rectangle to which the output processing will be limited. - Creates an image filter that merges a set of image filters using blend modes. - Returns the new , or null on error. - - - - The first image filter to merge. - The second image filter to merge. - The blend mode to merge the filters with. - The rectangle to which the output processing will be limited. - Creates an image filter that merges two image filters using a blend mode. - Returns the new , or null on error. - - - - The amount to offset in the x-direction. - The amount to offset in the y-direction. - The input filter to use. - The rectangle to which the output processing will be limited. - Creates an image filter that translates the bitmap that is drawn. - Returns the new , or null on error. - - - - The paint to draw. - The rectangle to which the output processing will be limited. - Creates an image filter that draws a paint. - Returns the new , or null on error. - - - - The picture to draw. - Creates an image filter that draws a picture. - Returns the new , or null on error. - - - - The picture to draw. - The rectangle to which the output processing will be limited. - Creates an image filter that draws a picture. - Returns the new , or null on error. - - - - The picture to draw. - The rectangle to which the output processing will be limited. - The quality. - Creates an image filter that draws a picture at a resolution that matches the local coordinate space. - Returns the new , or null on error. - - - - The location of the light. - The color of the light. - The surface height to use. - The diffuse lighting constant. - The input filter to use. - The rectangle to which the output processing will be limited. - Creates an image filter that applies a point diffuse lighting. - Returns the new , or null on error. - - - - The location of the light. - The color of the light. - The surface height to use. - The specular lighting constant. - The shininess or specular exponent. - The input filter to use. - The rectangle to which the output processing will be limited. - Creates an image filter that applies a point specular lighting. - Returns the new , or null on error. - - - - The location of the light. - The target location of the light. - The specular exponent. - The cutoff angle of the spotlight. - The color of the light. - The surface height to use. - The diffuse lighting constant. - The input filter to use. - The rectangle to which the output processing will be limited. - Creates an image filter that applies a spot diffuse lighting. - Returns the new , or null on error. - - - - The location of the light. - The target location of the light. - The specular exponent. - The cutoff angle of the spotlight. - The color of the light. - The surface height to use. - The specular lighting constant. - The shininess or specular exponent. - The input filter to use. - The rectangle to which the output processing will be limited. - Creates an image filter that applies a spot specular lighting. - Returns the new , or null on error. - - - - The pixels to tile. - The pixels where the tiles are drawn - The input filter to use. - Creates an image filter that tiles the image being drawn. - Returns the new , or null on error. - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - The rectangle to which the output processing of an will be limited. - - - - Creates an empty crop rectangle. - - - - The rectangle to crop to. - The edges that are specified by the rectangle. - Creates a crop rectangle with the specified edges. - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - Gets the edges that are specified by the rectangle. - - - - - Gets rectangle to crop to. - - - - - Describe an image's dimensions and pixel type. - - - - The width. - The height. - Creates a new with the specified width and height. - - - - The width. - The height. - The color type. - Creates a new with the specified width, height and color type. - - - - The width. - The height. - The color type. - The alpha/transparency type. - Creates a new with the specified width, height, color type and transparency type. - - - - The width. - The height. - The color type. - The alpha/transparency type. - The color space. - Creates a new with the specified width, height, color type, transparency type and color space. - - - - Gets the transparency type for the image info. - - - - - Gets the number of bits used per pixel. - - This is equivalent to multiplying the by 8 (the number of bits in a byte). - - - Gets the number of bytes used per pixel. - - This is calculated from the . If the color type is , then the value will be 0. - - - Gets the total number of bytes needed to store the bitmap data. - - This is calculated as: * * . - - - Gets the total number of bytes needed to store the bitmap data as a 64-bit integer. - - This is calculated as: * * . - - - Gets or sets the color space. - - - - - Gets or sets the color type. - - - - - An empty . - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Gets or sets the height. - - - - - Gets a value indicating whether the width or height are less or equal than zero. - - - - - Gets a value indicating whether the configured alpha type is opaque. - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The number of bits to shift left for the alpha color component. - - - - The number of bits to shift left for the blue color component. - - - - The number of bits to shift left for the green color component. - - - - The number of bits to shift left for the red color component. - - - - The current 32-bit color for the current platform. - On Windows, it is typically , and on Unix-based systems (macOS, Linux) it is typically . - - - Gets a rectangle with the current width and height. - - - - - Gets the number of bytes per row. - - This is calculated as: * . - - - Gets the number of bytes per row as a 64-bit integer. - - This is calculated as: * . - - - Gets the current size of the image. - - - - - Gets or sets the width. - - - - - The alpha/transparency type. - Creates a new with the same properties as this , but with the specified transparency type. - Returns the new . - - - - The color space. - Creates a new with the same properties as this , but with the specified color space. - Returns the new . - - - - The color type. - Creates a new with the same properties as this , but with the specified color type. - Returns the new . - - - - To be added. - To be added. - To be added. - To be added. - - - The width. - The height. - Creates a new with the same properties as this , but with the specified dimensions. - Returns the new . - - - - The memory address of the pixels being released. - The user data that was provided when creating the image. - The delegate that is used when releasing the memory for a raster-based image. - - - - The context of the image. - The delegate that is used when releasing the memory for a texture-based image. - - - - Various options to control how alpha should be handled. - - - - Blend the pixels onto a black background before encoding. - - - Ignore the alpha channel and treat the image as opaque. - - - Various options for the downsampling factor of the U and V components. - - - - Reduction by a factor of two in both the horizontal and vertical directions. - - - Reduction by a factor of two in the horizontal direction. - - - No downsampling. - - - Options to control the JPEG encoding. - - - - The quality of the encoding in the range 0 to 100. - The downsampling factor for the U and V components. - The value to control how alpha is handled. - Creates a new instance of . - - - - The quality of the encoding in the range 0 to 100. - The downsampling factor for the U and V components. - The value to control how alpha is handled. - The behavior when blending alpha. - Creates a new instance of . - - - - Gets or sets the value to control how alpha is handled. - - JPEGs must be opaque, so this instructs the encoder on how to handle input images with alpha. - - - Gets or sets the behavior when blending alpha. - - - - - Gets a new instance of with the values set to the defaults. - - - - Gets or sets the downsampling factor for the U and V components. - - This is only meaningful if the image is not gray, since gray will not be encoded as YUV. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the quality of the encoding in the range 0 to 100. - - - - - Specifies coordinates to divide a bitmap into ( * ) rectangles. - If the lattice divs or bounds are invalid, the entire lattice structure will be ignored on the draw call. - - - Gets or sets the optional source image bounds. - - - - - Gets or sets the array of fill types, one per rectangular grid entry. - - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the drawing options for each of the lattice rectangles. - - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the color for each of the lattice rectangles. - - - - - Gets or sets the x-coordinates for the lattice. - - - - - Gets or sets the y-coordinates for the lattice. - - - - - Flags to control how the bitmap lattice is drawn. - - - - Draw the bitmap for the rectangle. - - - Skip the drawing for the rectangle. - - - Optional setting per rectangular grid entry to make it transparent, or to fill the grid entry with a color. - - - - Draw the bitmap into the lattice rectangle. - - - Draw the associated entry into the lattice rectangle. - - - Skip the lattice rectangle (make it transparent). - - - Represents a mechanism for serializing pixels. - - - - Creates a new instance of with an empty buffer. - - - - The pixel data to encode. - Implemented by derived types to encode the specified pixel data. - Returns the encoded pixel data, or if the raw pixels should be used. - - - - The encoded data buffer. - The length of the encoded data buffer. - Implemented by derived types to determine whether the caller should use the specified encoded data instead of encoding a new version. - Returns if the specified encoded data should be used, otherwise to serialize another version. - - should not be called to encode -the source data. -]]> - - - - Wraps a into a (a seekable, rewindable Skia stream) - - that -represents a stream into an embedded resource in an assembly and use it with -SkiaSharp APIs that use resources: - -## Examples - -```csharp -public static void BitmapShader (SKCanvas canvas, int width, int height) -{ - var assembly = typeof(Demos).GetTypeInfo ().Assembly; - - // load the image from the embedded resource stream - using (var resource = assembly.GetManifestResourceStream ("embedded.png")) - using (var stream = new SKManagedStream(resource)) - using (var source = SKBitmap.Decode (stream)) { - var matrix = SKMatrix.MakeRotation (30.0f); - using (var shader = SKShader.CreateBitmap (source, SKShaderTileMode.Repeat, SKShaderTileMode.Repeat, matrix)) - using (var paint = new SKPaint ()) { - paint.IsAntialias = true; - paint.Shader = shader; - - // tile the bitmap - canvas.Clear (SKColors.White); - canvas.DrawPaint (paint); - } - } -} -``` -]]> - - - - The managed stream. - Creates a new read-only stream from a . - The underlying stream is not disposed when this object is disposed. - - - The managed stream. - If this is set to , the provided will be disposed when this instance is disposed. - Creates a new read-only stream from a , can optionally dispose the provided stream when this stream is disposed. - - - - The destination stream. - Copy the contents of this stream into the destination stream. - Returns the number of bytes that were copied. - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any managed objects. - - - - Implemented by derived types to copy the current stream. - Returns a pointer to the new instance. - - - - Implemented by derived types to duplicate the current stream. - Returns a pointer to the new instance. - After the stream has been duplicated, the new stream must set it's position to the start. - - - Implemented by derived types to fork the current stream. - Returns a pointer to the new instance. - After the stream has been duplicated, the new stream must set it's position to the same as this stream. - - - Implemented by derived types to return the total length of the stream. - Returns the total length of the stream. - - - - Implemented by derived types to get the current position in the stream - Returns the current position in the stream. - - - - Implemented by derived types to indicate whether this stream can report it's total length. - Returns a value indicating whether this stream can report it's total length. - - - - Implemented by derived types to indicate whether this stream can report it's current position. - Returns a value indicating whether this stream can report it's current position. - - - - Implemented by derived types to indicate whether all the bytes in the stream have been read. - Returns a value indicating whether all the bytes in the stream have been read. - - - - The relative offset. - Implemented by derived types to seek to a relative offset. - Returns if seeking is supported and the seek was successful, otherwise . - If an attempt is made to move to a position outside the stream, the position must be set to the closest point within the stream (beginning or end). - - - The buffer to read into. - The number of bytes to read. - Implemented by derived types to copy the specified number of bytes into the specified buffer. - Returns the number of bytes actually peeked/copied. - The stream's cursor must be returned to the position before this method was called. - - - The buffer to read into. - The number of bytes to read. - Implemented by derived types to copy the specified number of bytes into the specified buffer. - Returns the number of bytes actually read. - - - - Implemented by derived types to rewind the current stream. - Returns if the stream is known to be at the beginning after this call returns. - - - - The absolute position. - Implemented by derived types to seek to an absolute position. - Returns if seeking is supported and the seek was successful, otherwise . - If an attempt is made to move to a position outside the stream, the position must be set to the closest point within the stream (beginning or end). - - - Copies the contents of this stream into a new memory stream. - Returns the new memory stream. - - - - Wraps a into a (a writeable Skia stream) - - - - The managed stream. - Creates a new writeable stream from a . - The underlying stream is not disposed when this object is disposed. - - - The managed stream. - If this is set to , the provided will be disposed when this instance is disposed. - Creates a new writeable stream from a . - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any managed objects. - - - - Implemented by derived types to specify the number of bytes currently written to the stream. - Returns the number of bytes currently written to the stream. - - - - Implemented by derived types to flush the bytes to the underlying stream. - - - - The buffer to copy into the underlying stream. - The number of bytes to copy from the buffer. - Implemented by derived types to copy the specified number of bytes from the specified buffer into the underlying stream. - Returns on success, otherwise . - - - - A mask is used to describe alpha bitmaps, either 1-bit, 8-bit, or the 3-channel 3D format. - - - - The bounds of the mask in the image. - The number of bytes per row. - The format of the mask image. - Creates an instance of with the specified configuration, but a null . - - - - The pointer to the image data to use as the mask. - The bounds of the mask in the image. - The number of bytes per row. - The format of the mask image. - Creates an instance of with the specified configuration. - - - - Allocates a memory block for the mask's image. - Returns the total size of the allocated memory. - - - - The amount of memory to allocate. - Allocates a memory block for a mask's image. - Returns a pointer to the allocated memory. - - - - Gets the bounds of the mask in the image. - - - - - Calculates the byte size of the mask, assuming only 1 plane. - Returns the byte size of the mask. - - . For that, -use . - -If there is an overflow of 32bits, then returns 0. -]]> - - - - Calculates the byte size of the mask, taking into account any extra planes (e.g. ). - Returns the byte size of the mask. - If there is an overflow of 32bits, then returns 0. - - - The image data to copy into the mask. - The bounds of the mask in the image. - The number of bytes per row. - The format of the mask image. - Creates an instance of with the specified configuration, and copies the image data. - Returns the instance of the mask. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Gets the format of the mask image. - - - - - De-allocate the mask's image data. - - - - The pointer to a mask's image data. - De-allocate the specified mask image data. - - - - The x-coordinate, which must be contained by the mask's bounds. - The y-coordinate, which must be contained by the mask's bounds. - Returns the address of the specified pixel, computing the pixel-size at runtime based on the mask format. - Returns the address of the specified pixel. - - or -). - -This should not be called with , as it will -give unspecified results. -]]> - - - - The x-coordinate, which must be contained by the mask's bounds. - The y-coordinate, which must be contained by the mask's bounds. - Returns the bit value of the specified specified pixel. - Returns the bit value of the specified specified pixel. - - - - The x-coordinate, which must be contained by the mask's bounds. - The y-coordinate, which must be contained by the mask's bounds. - Returns the 16-bit value of the specified specified pixel. - Returns the 16-bit value of the specified specified pixel. - - - - The x-coordinate, which must be contained by the mask's bounds. - The y-coordinate, which must be contained by the mask's bounds. - Returns the 32-bit value of the specified specified pixel. - Returns the 32-bit value of the specified specified pixel. - - - - The x-coordinate, which must be contained by the mask's bounds. - The y-coordinate, which must be contained by the mask's bounds. - Returns the 8-bit value of the specified specified pixel. - Returns the 8-bit value of the specified specified pixel. - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Get the pointer to the mask's image data location. - - - - - Gets a value indicating whether the mask's bounds are empty. - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets the number of bytes per row. - - - - - Mask filters perform transformations on an alpha-channel mask before drawing. A mask filter is set using the property on type. - - - - The radius. - Converts from the (legacy) idea of specifying the blur "radius" to the standard notion of specifying its sigma. - The sigma. - - - - The sigma. - Converts from the standard notion of specifying the blur sigma to the (legacy) idea of specifying its "radius". - The radius. - - - - The style of blurring. - The standard deviation (greater than 0) of the Gaussian blur to apply. - Creates a mask filter that applies a blur. - Returns the new , or on error. - - - - The style of blurring. - The standard deviation (greater than 0) of the Gaussian blur to apply. - The flags to apply when blurring. - Creates a mask filter that applies a blur. - Returns the new , or on error. - - - - The style of blurring. - The standard deviation (greater than 0) of the Gaussian blur to apply. - The rectangle for which no pixels need be drawn (because it will be overdrawn with some opaque object). - Creates a mask filter that applies a blur. - Returns the new , or on error. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The style of blurring. - The standard deviation (greater than 0) of the Gaussian blur to apply. - The rectangle for which no pixels need be drawn (because it will be overdrawn with some opaque object). - The flags to apply when blurring. - Creates a mask filter that applies a blur. - Returns the new , or on error. - - - - The style of blurring. - The standard deviation (greater than 0) of the Gaussian blur to apply. - The rectangle for which no pixels need be drawn (because it will be overdrawn with some opaque object). - Whether or not the blur's sigma is modified by the CTM. - Creates a mask filter that applies a blur. - Returns the new , or on error. - - - - The minimum alpha value. - The maximum alpha value. - Creates a mask filter that clips the alpha channel to the specified minimum and maximum alpha values. - Returns the new , or on error. - - - - The gamma. - Creates a mask filter that applies gamma. - Returns the new , or on error. - - - - The lookup table with exactly 256 elements. - Creates a mask filter that applies a table lookup on each of the alpha values in the mask. - Returns the new , or on error. - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Gets the maximum number of colors in the color lookup table. - - - - Formats that indicate the memory format of the underlying image data of a . - - - - 8-bits per pixel mask (e.g. anti-aliasing). - - - Premultiplied color. - - - 1-bit per pixel mask (e.g. monochrome). - - - 565 alpha for RGB. - - - To be added. - - - 3 8-bit per pixel planes: alpha, mul, add. - - - A 3x3 transformation matrix with perspective. - It extends the traditional 2D affine transformation matrix with three perspective components that allow simple 3D effects to be created with it. Those components must be manually set by using the , , fields of the matrix. - - - To be added. - To be added. - To be added. - - - The scaling in the x-direction. - The skew in the x-direction. - The translation in the x-direction. - The skew in the y-direction. - The scaling in the y-direction. - The translation in the y-direction. - The x-perspective. - The y-perspective. - The z-perspective. - Creates a new instance of using the specified values. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The result matrix value. - The first matrix to concatenate. - The second matrix to concatenate. - Concatenates the specified matrices into the resulting target matrix. - Either source matrices can also be the target matrix. - - - The result matrix value. - The first matrix to concatenate. - The second matrix to concatenate. - Concatenates the specified matrices into the resulting target matrix. - Either source matrices can also be the target matrix. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - The array to populate. - Populates the specified array with the matrix values. - The result will be the same as . - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Creates an identity matrix. - Returns the new matrix. - - - - The angle for the rotation, in radians. - Creates a matrix that represents a specific rotation in radians. - Returns the new matrix. - - - - The angle for the rotation, in radians. - The x-coordinate for the rotation pivot. - The y-coordinate for the rotation pivot. - Creates a matrix that represents a specific rotation in radians, around a pivot point. - Returns the new matrix. - - - - The angle for the rotation, in degrees. - Creates a matrix that represents a specific rotation in degrees. - Returns the new matrix. - - - - The angle for the rotation, in degrees. - The x-coordinate for the rotation pivot. - The y-coordinate for the rotation pivot. - Creates a matrix that represents a specific rotation in degrees, around a pivot point. - Returns the new matrix. - - - - The scaling in the x-direction. - The scaling in the y-direction. - Creates a scaling matrix. - Returns the new matrix. - - - - The scaling in the x-direction. - The scaling in the y-direction. - The x-coordinate for the scaling pivot. - The y-coordinate for the scaling pivot. - Creates a scaling matrix, around a pivot point. - Returns the new matrix. - - - - The skew in the x-direction. - The skew in the y-direction. - Creates a skewing matrix. - Returns the new matrix. - - - - The translation/offset in the x-direction. - The translation/offset in the y-direction. - Creates a translation matrix. - Returns the new matrix. - - - - The point to map. - Applies the matrix to a point. - Returns the mapped point. - Mapping points uses all components of the matrix. Use to ignore the translation. - - - The x-coordinate. - The y-coordinate. - Applies the matrix to a point. - Returns the mapped point. - Mapping points uses all components of the matrix. Use to ignore the translation. - - - The array of points to be mapped. - Applies the matrix to an array of points. - Returns the new array allocated with the mapped results. - Mapping points uses all components of the matrix. Use to ignore the translation. - - - The array where the mapped results will be stored (needs to have the same number of elements of the array). - The array of points to be mapped. - Applies the matrix to an array of points. - Mapping points uses all components of the matrix. Use to ignore the translation. - - - The radius to map. - Calculates the mean radius of a circle after it has been mapped by this matrix. - Returns the mean radius. - - - - The source rectangle to map. - Applies the matrix to a rectangle. - Returns the mapped rectangle. - - - - The transformation matrix. - The mapped rectangle. - The source rectangle to map. - Applies the matrix to a rectangle. - - - - To be added. - To be added. - To be added. - To be added. - - - The x-component of the vector. - The y-component of the vector. - Applies the matrix to a vector, ignoring translation. - Returns the mapped point. - Mapping vectors ignores the translation component in the matrix. Use to take the translation into consideration. - - - The array of vectors to map. - Applies the matrix to the array of vectors, ignoring translation, and returns the mapped results. - Returns the new array allocated with the mapped results. - Mapping vectors ignores the translation component in the matrix. Use to take the translation into consideration. - - - The array where the mapped results will be stored (needs to have the same number of elements of the array). - The array of vectors to map. - Apply the to the array of vectors and return the mapped results.. - Mapping vectors ignores the translation component in the matrix. Use to take the translation into consideration. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the x-perspective. - - - - - Gets or sets the y-perspective. - - - - - Gets or sets the z-perspective. - - - - - To be added. - To be added. - To be added. - To be added. - - - The target matrix. - The matrix to be post-concatenated. - Post-concatenates the matrix to the target matrix. - This represents: result = matrix * target - - - The target matrix. - The matrix to be post-concatenated. - Post-concatenates the matrix to the target matrix. - This represents: result = matrix * target - - - To be added. - To be added. - To be added. - To be added. - - - The target matrix. - The matrix to be post-concatenated. - Pre-concatenates the matrix to the target matrix. - This represents: result = target * matrix - - - The target matrix. - The matrix to be post-concatenated. - Pre-concatenates the matrix to the target matrix. - This represents: result = target * matrix - - - The target matrix. - The angle for the rotation, in radians. - Rotates the specified matrix by the specified radians. - - - - The target matrix. - The angle for the rotation, in radians. - The x-coordinate for the rotation pivot. - The y-coordinate for the rotation pivot. - Rotates the specified matrix by the specified radians. - - - - The target matrix. - The angle for the rotation, in degrees. - Rotates the specified matrix by the specified degrees. - - - - The target matrix. - The angle for the rotation, in degrees. - The x-coordinate for the rotation pivot. - The y-coordinate for the rotation pivot. - Rotates the specified matrix by the specified degrees. - - - - Gets or sets the scaling in the x-direction. - - - - - Gets or sets the scaling in the y-direction. - - - - - The scaling in the x-direction. - The scaling in the y-direction. - The translation in the x-direction. - The translation in the y-direction. - Initializes the matrix to be scale + post-translate. - - - - Gets or sets the skew in the x-direction. - - - - - Gets or sets the skew in the y-direction. - - - - - Get or sets the translation in the x-direction. - - - - - Get or sets the translation in the y-direction. - - - - - The destination value to store the inverted matrix if the matrix can be inverted. - Attempts to invert the matrix, if possible the inverse matrix contains the result. - True if the matrix can be inverted, and the inverse parameter is initialized with the inverted matrix, false otherwise. - - - - Gets or sets the matrix as a flat array: [ScaleX, SkewX, TransX, SkewY, ScaleY, TransY, Persp0, Persp1, Persp2]. - - - - - A 3D, 4x4 matrix. - - - - Creates a new, uninitialized instance of . - - - - The instance. - Creates a new instance of using the values from a instance. - When converting from to , the third row and column remain as identity. - - - The matrix to copy. - Creates a new instance of using the values from another instance. - - - - The first matrix. - The second matrix. - Creates a new instance of using the concatenated values from two other instances. - This is equivalent to creating an uninitialized matrix, and then passing the two matrices to . - - - Creates a new identity matrix. - Returns the new identity matrix. - This is equivalent to creating an uninitialized matrix, and invoking . - - - The x-axis to rotate around. - The y-axis to rotate around. - The z-axis to rotate around. - The amount, in radians, to rotate by. - Creates a new rotation matrix. - Returns the new rotation matrix. - This is equivalent to creating an uninitialized matrix and passing the values to . - - - The x-axis to rotate around. - The y-axis to rotate around. - The z-axis to rotate around. - The amount, in degrees, to rotate by. - Creates a new rotation matrix. - Returns the new rotation matrix. - This is equivalent to creating an uninitialized matrix and passing the values to . - - - The amount, along the x-axis, to scale. - The amount, along the y-axis, to scale. - The amount, along the z-axis, to scale. - Creates a new scale matrix. - Returns the new scale matrix. - This is equivalent to creating an uninitialized matrix and passing the values to . - - - The amount, along the x-axis, to translate. - The amount, along the y-axis, to translate. - The amount, along the z-axis, to translate. - Creates a new translation matrix. - Returns the new translation matrix. - This is equivalent to creating an uninitialized matrix and passing the values to . - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - Calculates the determinant of the matrix. - Returns the determinant. - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - The first matrix. - The second matrix. - Determines if the two matrices are equal. - Returns if the two matrices are equal, otherwise . - - - - The column-major array containing the values. - Creates a new matrix using the values from the column-major array. - Returns the new matrix. - The number of items in the source array should be exactly 16 items. - - - The row-major array containing the values. - Creates a new matrix using the values from the row-major array. - Returns the new matrix. - The number of items in the source array should be exactly 16 items. - - - Creates an inverted matrix from the current matrix. - Returns the inverted matrix if it is invertible, otherwise . - - - - The matrix to receive the inverted matrix. - Inverts the current matrix and stores the result in the provided matrix. - Returns if the matrix is invertible, otherwise . - - - - To be added. - To be added. - To be added. - - - The row to retrieve the value from. - The column to retrieve the value from. - Gets or sets a value in the matrix. - Returns the value found at the specified coordinates. - - - - The point to map. - Applies the matrix to a point. - Returns a new point with the matrix applied. - - - - The points to map. - Applies the matrix to an array of points. - Returns a new array of points with the matrix applied. - - - - The vector to map. The vector must have exactly 4 items. - Applies the matrix to a vector. - Returns a new vector with the matrix applied. - - - - The vector to map. The vector must have exactly 4 items. - The vector that will receive the mapped vector. - Applies the matrix to a vector. - - - - The x-value of the vector. - The y-value of the vector. - The z-value of the vector. - The w-value of the vector. - Applies the matrix to a vector. - Returns a new vector with the matrix applied. - - - - The array of [x, y] pairs. The array must have an entry count of a multiple of 2. - Applies the matrix to a series of [x, y] pairs, returning the [x', y', z', w'] result. - Returns the resulting [x', y', z', w'] sets. - - The source array must have an entry count of a multiple of 2 (2, 4, 6, 8, ...). The resulting array will have an entry count of a multiple of 4 (4, 8, 12, 16, ...). - The source array has an implied z-value of 0 and a w-value of 1, equivalent to [x, y, 0, 1]. - - - - The array of [x, y] pairs. The array must have an entry count of a multiple of 2. - Returns the resulting [x', y', z', w'] sets. The array must have an entry count of a multiple of 4, and the same number of vectors as the source has pairs. - Applies the matrix to a series of [x, y] pairs, returning the [x', y', z', w'] result. - The source array has an implied z-value of 0 and a w-value of 1, equivalent to [x, y, 0, 1]. - - - Gets the equivalent of the current matrix. - - When converting from to , the third row and column is dropped. - - - To be added. - To be added. - To be added. - To be added. - - - The matrix to concatenate. - Post-concatenates the current matrix with the specified matrix. - - - - The amount, along the x-axis, to scale. - The amount, along the y-axis, to scale. - The amount, along the z-axis, to scale. - Post-scales the current matrix with the specified scale. - - - - The amount, along the x-axis, to translate. - The amount, along the y-axis, to translate. - The amount, along the z-axis, to translate. - Post-translates the current matrix with the specified stranslationale. - - - - The matrix to concatenate. - Pre-concatenates the matrix with the specified matrix. - - - - The amount, along the x-axis, to scale. - The amount, along the y-axis, to scale. - The amount, along the z-axis, to scale. - Pre-scales the current matrix with the specified scale. - - - - The amount of error to allow for when determining axis-alignment. - Determines if transforming an axis-aligned square in 2D by this matrix will produce another 2D, axis-aligned square. - Returns if the matrix preserves 2D axis alignment, otherwise . - If the result is , it typically means the matrix is a scale with perhaps a 90-degree rotation. A 3D rotation through 90 degrees into a perpendicular plane collapses a square to a line, but is still considered to be axis-aligned. - - - The amount, along the x-axis, to translate. - The amount, along the y-axis, to translate. - The amount, along the z-axis, to translate. - Pre-translates the current matrix with the specified translation. - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - The array containing the new, column-major values. - Resets the current matrix with the specified column-major values. - - - - The first matrix. - The second matrix. - Reset the current matrix with the values from the concatenation of the specified matrices. - - - - Resets the current matrix to identity. - - - - The x-axis to rotate around. - The y-axis to rotate around. - The z-axis to rotate around. - The amount, in radians, to rotate by. - Resets the current matrix to a rotation matrix. - If the specified vector is not unit-length, it will be automatically resized. - - - The x-axis to rotate around. - The y-axis to rotate around. - The z-axis to rotate around. - The amount, in degrees, to rotate by. - Resets the current matrix to a rotation matrix. - If the specified vector is not unit-length, it will be automatically resized. - - - The x-axis to rotate around. - The y-axis to rotate around. - The z-axis to rotate around. - The amount, in radians, to rotate by. - Resets the current matrix to a rotation matrix, without checking to see if the specified vector is unit-length. - This method assumes the specified vector is unit-length. - - - The array containing the new, row-major values. - Resets the current matrix with the specified row-major values. - - - - The amount, along the x-axis, to scale. - The amount, along the y-axis, to scale. - The amount, along the z-axis, to scale. - Resets the current matrix to a scale matrix. - - - - The amount, along the x-axis, to translate. - The amount, along the y-axis, to translate. - The amount, along the y-axis, to translate. - Resets the current matrix to a translation matrix. - - - - Converts the current matrix to a column-major array. - Returns the new column-major array. - - - - The array to receive the matrix values. The array must have an item count of exactly 16 items. - Converts the current matrix to a column-major array. - - - - Converts the current matrix to a row-major array. - Returns the new row-major array. - - - - The array to receive the matrix values. The array must have an item count of exactly 16 items. - Converts the current matrix to a row-major array. - - - - Transposes the current matrix. - - - - Gets a bit field describing the transformations the matrix may perform. - - - - - Various flags describing the transformations of a . - - - - The matrix skews or rotates. - - - The matrix is an identity matrix. - - - The matrix is in perspective. - - - The matrix has any scale other than 1. - - - The matrix has translation. - - - Matrix convolution tile modes for use with . - - - - Clamp to the image's edge pixels. - - - Fill with transparent black. - - - Wrap around to the image's opposite edge. - - - A memory-based stream. - - - - Creates a new instance of with an empty buffer. - - - - The data to initialize the stream with. - Creates a new instance of with the buffer being the provided data. - - - - The data to initialize the stream with. - Creates a new instance of with a copy of the provided data. - - - - The size of the stream buffer. - Creates a new instance of with a buffer size of the specified size. - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - The data to reset the stream to. - Resets the stream with a copy of the provided data. - - - - Various standard gamma corrections. - - - - Standard linear gamma. - - - Any non-standard gamma. - - - Standard sRGB gamma. - - - Standard 2.2 gamma curve. - - - Represents a native object. - This object just wraps a native handle with the managed dispose pattern. For a tracked object, use . - - - Releases all resources used by this . - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Triggers a dispose, ignoring the value of . - - - - Implemented by derived types to destroy any managed objects. - - - - Implemented by derived types to destroy any native objects. - - - - To be added. - To be added. - - - Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. - - - - Gets or sets the handle to the underlying native object. - - - - - Gets or sets a value indicating whether the call the public should be no-op. - - This only affects the public disposal. Objects that own this one can still forcefull trigger a dispose using . - - - Gets or sets a value indicating whether the object has already been disposed. - - - - - Gets or sets a value indicating whether this object owns it's handle and should destroy the native object when is is disposed. - - - - - A type of that provides a base type for canvases that do not need to rasterize. - These canvases are not backed by any device/pixels and they use conservative clipping (clipping calls only use rectangles). - - - The width of the canvas. - The height of the canvas. - Creates a new with the specified dimensions. - - - - A type of that draws to multiple canvases at the same time. - - - - The width of the canvas. - The height of the canvas. - Creates a new with the specified dimensions. - - - - The canvas to add. - - - - - Remove all canvases. - - - - The canvas to remove. - - - - - Represents a tracked native object. - This object wraps a native handle and keeps track of it's lifetime for the garbage collector. For a simple object, use . - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any managed objects. - - - - Implemented by derived types to destroy any native objects. - - - - To be added. - To be added. - - - Gets or sets the handle to the underlying native object. - - Setting this value will register this object with the lifetime tracker. - - - Gets a value indicating whether this object should destroy the underlying native object. - - - - - A canvas that captures all drawing commands, and rather than draw the actual content, it increments the alpha channel of each pixel every time it would have been touched by a draw call. - This is useful for detecting overdraw. - - - The canvas to draw on. - Creates a new that wraps the specified . - - - - Holds the style and color information about how to draw geometries, text and bitmaps. - - , an paint object does not maintain an -internal stack of state. That is, there is no save/restore on a paint. -However, paint objects are relatively light-weight, so the client may create -and maintain any number of paint objects, each set up for a particular use. - -Factoring all of these color and stylistic attributes out of the canvas state, -and into (multiple) paint objects, allows the save and restore operations on -the to be that much more efficient, as all they have -to do is maintain the stack of matrix and clip settings. - -### Effects - -Beyond simple attributes such as color, strokes, and text values, paints -support effects. These are subclasses of different aspects of the drawing -pipeline, that when referenced by a paint, are called to override some part -of the drawing pipeline. - -There are five types of effects that can be assigned to an paint object: - -| Effect | Details | -|---------------|------------------------------------------------------------------------------------------------| -| Blend Mode | Blend modes and Duff-Porter transfer modes. | -| Color Filter | Modification of the source colors before applying the blend mode. | -| Mask Filter | Modification of the alpha mask before it is colorized and drawn (for example, blur). | -| Path Effect | Modification of the geometry (path) before the alpha mask is generated (for example, dashing). | -| Shader | Gradients and bitmap patterns. | - -## Examples - -### Simple Example - -The following example shows three different paints, each set up to draw in a -different style. The caller can intermix these paints freely, either using -them as is, or modifying them as the drawing proceeds. - -```csharp -var info = new SKImageInfo(256, 256); -using (var surface = SKSurface.Create(info)) { - SKCanvas canvas = surface.Canvas; - - canvas.Clear(SKColors.White); - - var paint1 = new SKPaint { - TextSize = 64.0f, - IsAntialias = true, - Color = new SKColor(255, 0, 0), - Style = SKPaintStyle.Fill - }; - - var paint2 = new SKPaint { - TextSize = 64.0f, - IsAntialias = true, - Color = new SKColor(0, 136, 0), - Style = SKPaintStyle.Stroke, - StrokeWidth = 3 - }; - - var paint3 = new SKPaint { - TextSize = 64.0f, - IsAntialias = true, - Color = new SKColor(136, 136, 136), - TextScaleX = 1.5f - }; - - var text = "Skia!"; - canvas.DrawText(text, 20.0f, 64.0f, paint1); - canvas.DrawText(text, 20.0f, 144.0f, paint2); - canvas.DrawText(text, 20.0f, 224.0f, paint3); -} -``` - -The example above produces the following: - -![SKPaint and Text](~/images/SKPaintText.png "SKPaint and Text") - -### Effects Example - -The following example draws using a gradient instead of a single color. To do, -this a `SKShader` is assigned to the paint. Anything drawn with that paint -will be drawn with the gradient specified in the call to -`SKShader.CreateLinearGradient`. - -```csharp -var info = new SKImageInfo(256, 256); -using (var surface = SKSurface.Create(info)) { - SKCanvas canvas = surface.Canvas; - - canvas.Clear(SKColors.White); - - // create a gradient - var colors = new[] { - SKColors.Blue, - SKColors.Yellow - }; - var shader = SKShader.CreateLinearGradient( - new SKPoint(0.0f, 0.0f), - new SKPoint(256.0f, 256.0f), - colors, - null, - SKShaderTileMode.Clamp); - - // assign the gradient to the paint - var paint = new SKPaint { - Shader = shader - }; - - canvas.DrawPaint(paint); -} -``` - -The example above produces the following: - -![SKPaint and SKShader](~/images/gradient.png "SKPaint and SKShader") -]]> - - - - Creates a new paint with the default settings. - - - - To be added. - To be added. - To be added. - - - Gets or sets the blend mode. - - - - - The text to be measured. - The maximum width. Only the subset of text whose accumulated widths are <= maxWidth are measured. - Measure the text, stopping early if the measured width exceeds . - Returns the number of bytes of text that were measured. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The text to be measured. - The maximum width. Only the subset of text whose accumulated widths are <= maxWidth are measured. - Measure the text, stopping early if the measured width exceeds . - Returns the number of characters of text that were measured. - - - - The text to be measured. - The maximum width. Only the subset of text whose accumulated widths are <= are measured. - The actual width of the measured text. - Measure the text, stopping early if the measured width exceeds . - Returns the number of bytes of text that were measured. - - - - The pointer to a region holding text encoded using the encoding specified in format. - The number of bytes to read from the - The maximum width. Only the subset of text whose accumulated widths are <= are measured. - Measure the text buffer, stopping early if the measured width exceeds . - Returns the number of bytes of text that were measured. - The parameter is a pointer to a region in memory that contains text encoded in the format. This only consumes up to bytes from the buffer. - - - The pointer to a region holding text encoded using the encoding specified in format. - The number of bytes to read from the - The maximum width. Only the subset of text whose accumulated widths are <= are measured. - Measure the text buffer, stopping early if the measured width exceeds . - Returns the number of bytes of text that were measured. - The parameter is a pointer to a region in memory that contains text encoded in the format. This only consumes up to bytes from the buffer. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The text to be measured. - The maximum width. Only the subset of text whose accumulated widths are <= are measured. - The actual width of the measured text. - Measure the text, stopping early if the measured width exceeds . - Returns the number of characters of text that were measured. - - - - The pointer to a region holding text encoded using the encoding specified in format. - The number of bytes to read from the - The maximum width. Only the subset of text whose accumulated widths are <= are measured. - The actual width of the measured text. - Measure the text buffer, stopping early if the measured width exceeds . - Returns the number of bytes of text that were measured. - The parameter is a pointer to a region in memory that contains text encoded in the format. This only consumes up to bytes from the buffer. - - - The pointer to a region holding text encoded using the encoding specified in format. - The number of bytes to read from the - The maximum width. Only the subset of text whose accumulated widths are <= are measured. - The actual width of the measured text. - Measure the text buffer, stopping early if the measured width exceeds . - Returns the number of bytes of text that were measured. - The parameter is a pointer to a region in memory that contains text encoded in the format. This only consumes up to bytes from the buffer. - - - The text to be measured. - The maximum width. Only the subset of text whose accumulated widths are <= are measured. - The actual width of the measured text. - The text that was measured. - Measure the text, stopping early if the measured width exceeds . - Returns the number of characters of text that were measured. - - - - Creates a copy of the current paint. - Returns the copy. - The copy is a shallow copy, all references will still point to the same objects. - - - Gets or sets the paint's foreground color. - - The color is a 32-bit value containing ARGB. This 32-bit value is not premultiplied, meaning that its alpha can be any value, regardless of the values of R, G and B. - - - To be added. - To be added. - To be added. - - - Gets or sets the paint's color filter. - - - - - The text encoded using the encoding specified in format. - Returns a value indicating whether or not all the characters corresponds to a non-zero glyph index. - Returns true if all the characters corresponds to a non-zero glyph index, otherwise false if any characters in text are not supported in the typeface. - This method does not check to see if the text contains invalid glyph indices. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - The text. - Returns a value indicating whether or not all the characters corresponds to a non-zero glyph index. - Returns true if all the characters corresponds to a non-zero glyph index, otherwise false if any characters in text are not supported in the typeface. - This method does not check to see if the text contains invalid glyph indices. - - - The text buffer encoded using the encoding specified in format. - The length of the text buffer. - Returns a value indicating whether or not all the characters corresponds to a non-zero glyph index. - Returns true if all the characters corresponds to a non-zero glyph index, otherwise false if any characters in text are not supported in the typeface. - This method does not check to see if the text contains invalid glyph indices. - - - The text buffer encoded using the encoding specified in format. - The length of the text buffer. - Returns a value indicating whether or not all the characters corresponds to a non-zero glyph index. - Returns true if all the characters corresponds to a non-zero glyph index, otherwise false if any characters in text are not supported in the typeface. - This method does not check to see if the text contains invalid glyph indices. - - - The text encoded using the encoding specified in format. - Returns the number of glyphs in text. - Returns the number of glyphs in text. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - The text. - Returns the number of glyphs in text. - Returns the number of glyphs in text. - - - - The text buffer encoded using the encoding specified in format. - The length of the text buffer. - Returns the number of glyphs in text. - Returns the number of glyphs in text. - - - - The text buffer encoded using the encoding specified in format. - The length of the text buffer. - Returns the number of glyphs in text. - Returns the number of glyphs in text. - - - - Gets or sets a value indicating whether device kerning is enabled. - - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - Gets or sets a value indicating whether fake bold text is enabled. - - - - - Gets or sets the filter quality of the current paint. - - This affects the quality (and performance) of drawing scaled images. - - - Gets the font metrics for the current typeface. - - - - - Gets the recommend line spacing. - - - - - The source path. - Creates a new path from the result of applying any and all effects to a source path. - Returns the resulting fill path, or null if the source path should be drawn with a hairline. - - - - The input path. - The output path. - Applies any and all effects to a source path, returning the result in the destination. - Returns true if the path should be filled, or false if it should be drawn with a hairline. - - - - The source path. - The limit to be passed to the path effect. - Creates a new path from the result of applying any and all effects to a source path. - Returns the resulting fill path, or null if the source path should be drawn with a hairline. - - - - The source path. - If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size. - Creates a new path from the result of applying any and all effects to a source path. - Returns the resulting fill path, or null if the source path should be drawn with a hairline. - - - - The source path. - The output path. - The limit to be passed to the path effect. - Applies any and all effects to a source path, returning the result in the destination. - Returns true if the path should be filled, or false if it should be drawn with a hairline. - - - - The input path. - The output path. - If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size. - Applies any and all effects to a source path, returning the result in the destination. - Returns true if the path should be filled, or false if it should be drawn with a hairline. - - - - The source path. - The limit to be passed to the path effect. - If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size. - Creates a new path from the result of applying any and all effects to a source path. - Returns the resulting fill path, or null if the source path should be drawn with a hairline. - - - - The input path. - The output path. - The destination path may be culled to this rectangle. - If > 1, increase precision, else if (0 < res < 1) reduce precision in favor of speed/size. - Applies any and all effects to a source path, returning the result in the destination. - Returns true if the path should be filled, or false if it should be drawn with a hairline. - - - - To be added. - To be added. - To be added. - To be added. - - - The font metrics for the current typeface. - If not 0, return width as if the canvas were scaled by this value. - Returns the font metrics and line spacing for the current typeface. - Returns the recommended spacing between lines. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The text encoded using the encoding specified in format. - Converts text into glyph indices. - Returns the glyph indices. - This method does not check the text for valid character codes or valid glyph indices. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - The text. - Converts text into glyph indices. - Returns the glyph indices. - This method does not check the text for valid character codes or valid glyph indices. - - - The text buffer encoded using the encoding specified in format. - The length of the text buffer. - Converts text into glyph indices. - Returns the glyph indices. - This method does not check the text for valid character codes or valid glyph indices. - - - The text buffer encoded using the encoding specified in format. - The length of the text buffer. - Converts text into glyph indices. - Returns the glyph indices. - This method does not check the text for valid character codes or valid glyph indices. - - - The text encoded using the encoding specified in format. - Retrieves the advance for each glyph in the text. - Returns the text advances for each glyph. - - is false, this method returns the -horizontal advance. If is true, this -method returns the vertical advance. - -Uses to decode text, - to get the font metrics, and - to scale the widths. -]]> - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - The text. - Retrieves the advance for each glyph in the text. - Returns the text advances for each glyph. - - is false, this method returns the -horizontal advance. If is true, this -method returns the vertical advance. - -Uses to decode text, - to get the font metrics, and - to scale the widths. -]]> - - - - The text encoded using the encoding specified in format. - The bounds for each glyph relative to (0, 0). - Retrieves the advance and bounds for each glyph in the text. - Returns the text advances for each glyph. - - is false, this method returns the -horizontal advance. If is true, this -method returns the vertical advance. - -Uses to decode text, - to get the font metrics, and - to scale the widths and bounds. -]]> - - - - The text buffer encoded using the encoding specified in format. - The length of the text buffer. - Retrieves the advance for each glyph in the text. - Returns the text advances for each glyph. - - is false, this method returns the -horizontal advance. If is true, this -method returns the vertical advance. - -Uses to decode text, - to get the font metrics, and - to scale the widths. -]]> - - - - The text buffer encoded using the encoding specified in format. - The length of the text buffer. - Retrieves the advance for each glyph in the text. - Returns the text advances for each glyph. - - is false, this method returns the -horizontal advance. If is true, this -method returns the vertical advance. - -Uses to decode text, - to get the font metrics, and - to scale the widths. -]]> - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The text. - The bounds for each glyph relative to (0, 0). - Retrieves the advance and bounds for each glyph in the text. - Returns the text advances for each glyph. - - is false, this method returns the -horizontal advance. If is true, this -method returns the vertical advance. - -Uses to decode text, - to get the font metrics, and - to scale the widths and bounds. -]]> - - - - The text buffer encoded using the encoding specified in format. - The length of the text buffer. - The bounds for each glyph relative to (0, 0). - Retrieves the advance and bounds for each glyph in the text. - Returns the text advances for each glyph. - - is false, this method returns the -horizontal advance. If is true, this -method returns the vertical advance. - -Uses to decode text, - to get the font metrics, and - to scale the widths and bounds. -]]> - - - - The text buffer encoded using the encoding specified in format. - The length of the text buffer. - The bounds for each glyph relative to (0, 0). - Retrieves the advance and bounds for each glyph in the text. - Returns the text advances for each glyph. - - is false, this method returns the -horizontal advance. If is true, this -method returns the vertical advance. - -Uses to decode text, - to get the font metrics, and - to scale the widths and bounds. -]]> - - - - The text encoded using the encoding specified in format. - The positions of each glyph in the horizontal direction. - The positions of all the glyphs along the y-coordinate. - The upper line parallel to the advance. - The lower line parallel to the advance. - Calculate the intersections of two parallel lines and the glyphs. - Returns the intersections of two parallel lines and the glyphs. - - to decode text, - to get the font metrics, and -, -and to scale and modify the glyph paths. -]]> - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The text. - The positions of each glyph in the horizontal direction. - The positions of all the glyphs along the y-coordinate. - The upper line parallel to the advance. - The lower line parallel to the advance. - Calculate the intersections of two parallel lines and the glyphs. - Returns the intersections of two parallel lines and the glyphs. - - to decode text, - to get the font metrics, and -, -and to scale and modify the glyph paths. -]]> - - - - The text buffer encoded using the encoding specified in format. - The length of the text buffer. - The positions of each glyph in the horizontal direction. - The positions of all the glyphs along the y-coordinate. - The upper line parallel to the advance. - The lower line parallel to the advance. - Calculate the intersections of two parallel lines and the glyphs. - Returns the intersections of two parallel lines and the glyphs. - - to decode text, - to get the font metrics, and -, -and to scale and modify the glyph paths. -]]> - - - - The text buffer encoded using the encoding specified in format. - The length of the text buffer. - The positions of each glyph in the horizontal direction. - The positions of all the glyphs along the y-coordinate. - The upper line parallel to the advance. - The lower line parallel to the advance. - Calculate the intersections of two parallel lines and the glyphs. - Returns the intersections of two parallel lines and the glyphs. - - to decode text, - to get the font metrics, and -, -and to scale and modify the glyph paths. -]]> - - - - The text encoded using the encoding specified in format. - The positions of each glyph. - The upper line parallel to the advance. - The lower line parallel to the advance. - Calculate the intersections of two parallel lines and the glyphs. - Returns the intersections of two parallel lines and the glyphs. - - to decode text, - to get the font metrics, and -, -and to scale and modify the glyph paths. -]]> - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The text. - The positions of each glyph. - The upper line parallel to the advance. - The lower line parallel to the advance. - Calculate the intersections of two parallel lines and the glyphs. - Returns the intersections of two parallel lines and the glyphs. - - to decode text, - to get the font metrics, and -, -and to scale and modify the glyph paths. -]]> - - - - The text buffer encoded using the encoding specified in format. - The length of the text buffer. - The positions of each glyph. - The upper line parallel to the advance. - The lower line parallel to the advance. - Calculate the intersections of two parallel lines and the glyphs. - Returns the intersections of two parallel lines and the glyphs. - - to decode text, - to get the font metrics, and -, -and to scale and modify the glyph paths. -]]> - - - - The text buffer encoded using the encoding specified in format. - The length of the text buffer. - The positions of each glyph. - The upper line parallel to the advance. - The lower line parallel to the advance. - Calculate the intersections of two parallel lines and the glyphs. - Returns the intersections of two parallel lines and the glyphs. - - to decode text, - to get the font metrics, and -, -and to scale and modify the glyph paths. -]]> - - - - The text blob. - The upper line parallel to the advance. - The lower line parallel to the advance. - Calculate the intersections of two parallel lines and the glyphs. - Returns the intersections of two parallel lines and the glyphs. - - to decode text, - to get the font metrics, and -, -and to scale and modify the glyph paths. -]]> - - - - The text encoded using the encoding specified in format. - The x-coordinate of the origin to the text. - The y-coordinate of the origin to the text. - The upper line parallel to the advance. - The lower line parallel to the advance. - Calculate the intersections of two parallel lines and the glyphs. - Returns the intersections of two parallel lines and the glyphs. - - to decode text, - to get the font metrics, and -, -and to scale and modify the glyph paths. -]]> - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The text. - The x-coordinate of the origin to the text. - The y-coordinate of the origin to the text. - The upper line parallel to the advance. - The lower line parallel to the advance. - Calculate the intersections of two parallel lines and the glyphs. - Returns the intersections of two parallel lines and the glyphs. - - to decode text, - to get the font metrics, and -, -and to scale and modify the glyph paths. -]]> - - - - The text buffer encoded using the encoding specified in format. - The length of the text buffer. - The x-coordinate of the origin to the text. - The y-coordinate of the origin to the text. - The upper line parallel to the advance. - The lower line parallel to the advance. - Calculate the intersections of two parallel lines and the glyphs. - Returns the intersections of two parallel lines and the glyphs. - - to decode text, - to get the font metrics, and -, -and to scale and modify the glyph paths. -]]> - - - - The text buffer encoded using the encoding specified in format. - The length of the text buffer. - The x-coordinate of the origin to the text. - The y-coordinate of the origin to the text. - The upper line parallel to the advance. - The lower line parallel to the advance. - Calculate the intersections of two parallel lines and the glyphs. - Returns the intersections of two parallel lines and the glyphs. - - to decode text, - to get the font metrics, and -, -and to scale and modify the glyph paths. -]]> - - - - The text encoded using the encoding specified in format. - The position to use for each glyph in the text. - Returns the path (outline) for the specified text. - Returns the containing the outline of the text. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The text to generate an outline for. - The position to use for each glyph in the text. - Returns the path (outline) for the specified text. - Returns the containing the outline of the text. - - - - The text encoded using the encoding specified in format. - The x-coordinate of the first glyph in the text. - The y-coordinate of the first glyph in the text. - Returns the path (outline) for the specified text. - Returns the containing the outline of the text. - - - - The pointer to a region holding text encoded using the encoding specified in format. - The number of bytes to read from the - The position to use for each glyph in the text. - Returns the path (outline) for the specified text. - Returns the containing the outline of the text. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The pointer to a region holding text encoded using the encoding specified in format. - The number of bytes to read from the - The position to use for each glyph in the text. - Returns the path (outline) for the specified text. - Returns the containing the outline of the text. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The text to generate an outline for. - The x-coordinate of the first glyph in the text. - The y-coordinate of the first glyph in the text. - Returns the path (outline) for the specified text. - Returns the containing the outline of the text. - - - - The pointer to a region holding text encoded using the encoding specified in format. - The number of bytes to read from the - The x-coordinate of the first glyph in the text. - The y-coordinate of the first glyph in the text. - Returns the path (outline) for the specified text. - Returns the containing the outline of the text. - - - - The pointer to a region holding text encoded using the encoding specified in format. - The number of bytes to read from the - The x-coordinate of the first glyph in the text. - The y-coordinate of the first glyph in the text. - Returns the path (outline) for the specified text. - Returns the containing the outline of the text. - - - - Gets or sets the level of hinting to be performed. - - - - - Gets or sets the image filter. - - - - - Gets or sets a value indicating whether anti-aliasing is enabled. - - - - - Gets or sets a value indicating whether auto-hinting is enabled. - - - - - Gets or sets a value indicating whether dithering is enabled. - - - - - Gets or sets a value indicating whether text is an embedded bitmap. - - - - - Gets or sets a value indicating whether text is linear. - - - - - Gets or sets a value indicating whether to paint a stroke or the fill. - - This is a shortcut way to set to either or . - - - Gets or sets a value indicating whether the text is vertical or horizontal is enabled. - - - will place -its glyphs vertically rather than horizontally. -]]> - - - - Gets or sets a value indicating whether LCD text rendering is enabled. - - - must also be enabled for LCD rendering to be enabled. - - - Gets or sets the mask filter to use when painting. - - Mask filters control the transformations on the alpha channel before primitives are drawn. Examples are blur or emboss. - - - The text to be measured. - Measures the specified text. - Returns the width of the text. - This will return the vertical measure if this is vertical text, in which case the returned value should be treated has a height instead of a width. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - The text to be measured. - Measures the specified text. - Returns the width of the text. - This will return the vertical measure if this is vertical text, in which case the returned value should be treated has a height instead of a width. - - - The text to be measured. - The bounds of the text relative to (0, 0) - Measures the specified text. - Returns the width of the text. - This will return the vertical measure if this is vertical text, in which case the returned value should be treated has a height instead of a width. - - - The pointer to a region holding text encoded using the encoding specified in format. - The number of bytes to read from the - Measures the specified UTF-8 encoded text. - Returns the width of the text. - The parameter is a pointer to a region in memory that contains text encoded in the format. This only consumes up to bytes from the buffer. - - - The pointer to a region holding text encoded using the encoding specified in format. - The number of bytes to read from the - Measures the specified UTF-8 encoded text. - Returns the width of the text. - The parameter is a pointer to a region in memory that contains text encoded in the format. This only consumes up to bytes from the buffer. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The text to be measured. - The bounds of the text relative to (0, 0) - Measures the specified text. - Returns the width of the text. - This will return the vertical measure if this is vertical text, in which case the returned value should be treated has a height instead of a width. - - - The pointer to a region holding text encoded using the encoding specified in format. - The number of bytes to read from the - The bounds of the text relative to (0, 0) - Measures the specified UTF-8 encoded text. - Returns the width of the text. - - format. This only -consumes up to `length` bytes from the buffer. -]]> - - - - The pointer to a region holding text encoded using the encoding specified in format. - The number of bytes to read from the - The bounds of the text relative to (0, 0) - Measures the specified UTF-8 encoded text. - Returns the width of the text. - - format. This only -consumes up to `length` bytes from the buffer. -]]> - - - - Gets or sets the path effect to use when painting. - - - - - Resets all the paint properties to their defaults. - - - - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the shader to use when painting. - - - - - Gets or sets a value indicating how the start and end of stroked lines and paths are treated. - - - - - Gets or sets the path's join type. - - - - - Gets or sets the paint's miter limit. - - This is used whenever the is or to control the behavior of miter joins when the joins' angle is sharp. - - - Gets or sets the paint's stroke width. - - This is used whenever the is or . The value of zero is the special hairline mode. Hairlines always draw with a width of 1 pixel, regardless of the transformation matrix. - - - Gets or sets the painting style. - - Can also be set using . - - - Gets or sets a value indicating whether to use subpixel text positioning. - - - - - Gets or sets the path's align value. - - - - - Gets or sets the encoding used when drawing or measuring text. - - This defaults to UTF-8 encoding. - - - Gets or sets paint's horizontal scale factor for text. - - - - - Gets or sets the text height in pixels. - - - - - Gets or sets paint's horizontal skew factor for text. - - - - - To be added. - To be added. - To be added. - - - Gets or sets the typeface used when painting text. May be . - - - - - Levels of hinting that can be performed. - - - - The same as , unless we are rendering subpixel glyphs. - - - Don't perform hinting. - - - Use the default hinting level. - - - Use a lighter hinting level. - - - Indications on how to draw geometry. - - , and lines are always drawn in -. - - implicitly draws the result with - so if the original path is even-odd, -the results may not appear the same as if it was drawn twice, filled and then -stroked. -]]> - - - - Fill the geometry. - - - Stroke the geometry. - - - Fill and stroke the geometry. - - - A compound geometric path. - A path encapsulates compound (multiple contour) geometric paths consisting of straight line segments, quadratic curves, and cubic curves. - - - Creates an empty path. - - - - The path to clone. - Creates a path by making a copy of an existing path. - This constructor can throw InvalidOperationException if there is a problem copying the source path. - - - The bounds of oval used to define the size of the arc. - Starting angle (in degrees) where the arc begins. - Sweep angle (in degrees) measured clockwise. - Adds the specified arc to the path as a new contour. - - - - The x-coordinate of the center of the circle. - The y-coordinate of the center of the circle. - The radius of the circle. - The direction to wind the circle's contour. - Adds a closed circle contour to the path. - - - - The bounding oval to add as a closed contour to the path. - The direction to wind the oval's contour. - Adds a closed oval contour to the path. - - - - The path containing the elements to be added to the current path. - Determines how the path contours are added to the path. On mode, contours are added as new contours. On mode, the last contour of the path is extended with the first contour of the path. - Extends the current path with the path elements from another path, using the specified extension mode. - - - - The path containing the elements to be added to the current path. - Transformation matrix applied to the path. - Determines how the path contours are added to the path. On mode, contours are added as new contours. On mode, the last contour of the path is extended with the first contour of the path. - Extends the current path with the path elements from another path, by applying the specified transformation matrix, using the specified extension mode. - - - - The path containing the elements to be added to the current path. - The amount to translate the path in X as it is added. - The amount to translate the path in Y as it is added. - Determines how the path contours are added to the path. On mode, contours are added as new contours. On mode, the last contour of the path is extended with the first contour of the path. - Extends the current path with the path elements from another path offset by (, ), using the specified extension mode. - - - - The path containing the elements to be added to the current path. - Extends the current path with the path elements from another path in reverse order. - - - - The points that make up the polygon. - Whether or not to close the path. - Adds a new contour made of just lines. - - - - The rectangle to add as a closed contour to the path - The direction to wind the rectangle's contour. - Adds a closed rectangle contour to the path. - - - - The rectangle to add as a closed contour to the path - The direction to wind the rectangle's contour. - Initial point of the contour (initial ), expressed as a corner index, starting in the upper-left position, clock-wise. Must be in the range of 0..3. - Adds a closed rectangle contour to the path. - Add a closed rectangle contour to the path with an initial point of the contour (startIndex) expressed as a corner index. - - - The bounds of a the rounded rectangle. - The x-radius of the rounded corners. - The y-radius of the rounded corners - The direction to wind the rectangle's contour. - Adds a closed rectangle with rounded corners to the current path. - - - - The rounded rectangle. - The direction to wind the rectangle's contour. - Adds a closed rectangle with rounded corners to the current path. - - - - The rounded rectangle. - The direction to wind the rectangle's contour. - Initial point of the contour (initial ), expressed as an index of the radii minor/major points, ordered clock-wise. Must be in the range of 0..7. - Adds a closed rectangle with rounded corners to the current path. - - - - The bounds of a the rounded rectangle. - The x-radius of the rounded corners. - The y-radius of the rounded corners - The direction to wind the rectangle's contour. - Adds a closed rectangle with rounded corners to the current path. - - - - The corner coordinates. - The destination coordinates. - The corner radius. - Appends a line and arc to the current path. - This is the same as the PostScript call "arct". - - - The bounding oval defining the shape and size of the arc. - The starting angle (in degrees) where the arc begins. - The sweep angle (in degrees) measured clockwise. - Whether to always begin a new contour with the arc. - Appends the specified arc to the path. - - is added to connect the current -contour to the start of the arc. However, if the path is empty, then we call - with the first point of the arc. -]]> - - - - The radius. - The angle in degrees relative to the x-axis. - Determines whether the smallest or largest arc possible is drawn. - Determines if the arc should be swept in an anti-clockwise or clockwise direction. - The destination coordinate. - Appends an elliptical arc from the current point in the format used by SVG. - - - - The corner x-coordinate. - The corner y-coordinate. - The destination x-coordinate. - The destination y-coordinate. - The corner radius. - Appends a line and arc to the current path. - This is the same as the PostScript call "arct". - - - The radius in the x-direction. - The radius in the y-direction. - The angle in degrees relative to the x-axis. - Determines whether the smallest or largest arc possible is drawn. - Determines if the arc should be swept in an anti-clockwise or clockwise direction. - The destination x-coordinate. - The destination y-coordinate. - Appends an elliptical arc from the current point in the format used by SVG. - - - - Gets the bounds of the path's points. If the path contains zero points/verbs, this will return the empty rectangle. - Gets the bounds of the path's points. - This bounds may be larger than the actual shape, since curves do not extend as far as their control points. Additionally this bound encompasses all points, even isolated MoveTo either preceding or following the last non-degenerate contour. - - - Closes the current contour. - If the current point is not equal to the first point of the contour, a line segment is automatically added. - - - Computes a bounds that is conservatively "snug" around the path. - Returns the bounds. - - This assumes that the path will be filled. - - It does not attempt to collapse away contours that are logically empty (e.g. MoveTo(x, y) + LineTo(x, y)) but will include them in the calculation. - - - - The coordinates of the control point of the conic curve. - The coordinates of the end point of the conic curve. - The weight of the conic curve. - Add a conic path from the last point. - - call has been made for this contour, -the first point is automatically set to (0, 0). -]]> - - - - The x-coordinate of the control point of the conic curve. - The y-coordinate of the control point of the conic curve. - The x-coordinate of the end point of the conic curve. - The y-coordinate of the end point of the conic curve. - The weight of the conic curve. - Add a conic path from the last point. - - call has been made for this contour, -the first point is automatically set to (0, 0). -]]> - - - - The x-coordinate to check. - The y-coordinate to check. - Returns true if the point (x, y) is contained by the path, taking into account the . - Returns true if the point (x, y) is contained by the path. - - - - The coordinates of the starting point of the conic curve. - The coordinates of the control point of the conic curve. - The coordinates of the end point of the conic curve. - The weight of the conic curve. - The tolerance to use (1 << pow2). - Chop a conic into a number of quads. - Returns the collection of points that make up the conic curve. - - - - The coordinates of the starting point of the conic curve. - The coordinates of the control point of the conic curve. - The coordinates of the end point of the conic curve. - The weight of the conic curve. - The collection to store the points. - The tolerance to use (1 << pow2). - Chop a conic into a number of quads. - Returns the number of quads. - The amount of storage needed for pts is: 1 + 2 * (1 << pow2) - - - The coordinates of the starting point of the conic curve. - The coordinates of the control point of the conic curve. - The coordinates of the end point of the conic curve. - The weight of the conic curve. - The collection of points. - The tolerance to use (1 << pow2). - Chop a conic into a number of quads. - Returns the number of quads. - - - - Gets or sets the path's convexity. - - If it is currently unknown, then this function will attempt to compute the convexity (and cache the result). - - - When this is true, each contour (as defined by a new starting move command) will be completed with a close verb regardless of the contour's contents. - Creates an iterator object to scan the all of the segments (lines, quadratics, cubics) of each contours in a path. - Returns an object that can be used to iterate over the various elements of the path. - - method instead. -]]> - - - - Creates a raw iterator object to scan the all of the segments (lines, quadratics, cubics) of each contours in a path. - Returns an object that can be used to iterate over the various elements of the path. - - method, this iterator -does not clean up or normalize the values in the path. It returns the raw -elements contained in the path. -]]> - - - - The coordinates of the 1st control point on a cubic curve. - The coordinates of the 2nd control point on a cubic curve. - The coordinates of the end point on a cubic curve. - Adds a cubic bezier from the last point. - - call has been made for this contour, -the first point is automatically set to (0, 0). -]]> - - - - The x-coordinate of the 1st control point on a cubic curve. - The y-coordinate of the 1st control point on a cubic curve. - The x-coordinate of the 2nd control point on a cubic curve. - The y-coordinate of the 2nd control point on a cubic curve. - The x-coordinate of the end point on a cubic curve. - The y-coordinate of the end point on a cubic curve. - Adds a cubic bezier from the last point. - - call has been made for this contour, -the first point is automatically set to (0, 0). -]]> - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - Gets or sets the path's fill type. - - This is used to define how "inside" is computed. The default value is . - - - The bounds, if the path contains any points. - Returns the bounds of the path's points. - Returns true if the path is not empty, otherwise false. - This bounds may be larger than the actual shape, since curves do not extend as far as their control points. Additionally this bound encompasses all points, even isolated MoveTo either preceding or following the last non-degenerate contour. - - - Returns the two points of the path. - Returns the two points of the path. - If the path is not a single, straight line, then is returned. See also . - - - Returns the oval bounds of the path. - Returns the oval bounds of the path. - If the path is not a single oval or circle, then an empty rectangle is returned. See also . - - - The index of the point to return. - Returns the point at the specified index. - The point at the specified index. - If the index is out of range (i.e. is not 0 <= index < ), then the returned coordinates will be (0, 0). - - - The maximum number of points to copy into points. - Returns a subset of points in the path. Up to max points are copied. - Returns the requested set of points. - - - - The array to hold the points. - The maximum number of points to copy into points. - Returns a subset of points in the path. Up to max points are copied. - Returns the actual number of points in the path - - - - Returns the rectangle of the path. - Returns the rectangle of the path. - If the path is not a single rectangle, then an empty rectangle is returned. See also . - - - Whether or not the rectangle is closed. - The direction of the rectangle. - Returns the rectangle of the path. - Returns the rectangle of the path. - If the path is not a single rectangle, then an empty rectangle is returned. See also . - - - Returns the round rectangle of the path. - Returns the round rectangle of the path. - If the path is not a single round rectangle, then is returned. See also . - - - The tight bounds of the path. - Gets the "tight" bounds of the path. Unlike , the control points of curves are excluded. - Returns true if the bounds could be computed, otherwise false. - - - - Gets a value indicating whether the path is concave. - - If it is currently unknown, then this function will attempt to compute the convexity (and cache the result). - - - Gets a value indicating whether the path is convex. - - If it is currently unknown, then this function will attempt to compute the convexity (and cache the result). - - - Gets a value indicating whether or not the path is empty (contains no lines or curves). - - - - - Gets a value indicating whether the path is a single, straight line. - - See also . - - - Gets a value indicating whether the path is a single oval or circle. - - See also . - - - Gets a value indicating whether the path is a single rectangle. - - See also and . - - - Gets a value indicating whether the path is a single, round rectangle. - - See also . - - - The index of the point to get. - Gets the point at the specified index. - The point at the specified index. - If the index is out of range (i.e. is not 0 <= index < ), then the returned coordinates will be (0, 0). - - - Return the last point on the path. If no points have been added, (0, 0) is returned. - - - - - The coordinates of the end of a line. - Add a line from the last point to the specified point (x, y). - - call has been made for this contour, -the first point is automatically set to (0, 0). -]]> - - - - The x-coordinate of the end of a line. - The y-coordinate of the end of a line. - Add a line from the last point to the specified point (x, y). - - call has been made for this contour, -the first point is automatically set to (0, 0). -]]> - - - - The coordinates of the start of a new contour. - Set the beginning of the next contour to the point. - - - - The x-coordinate of the start of a new contour. - The y-coordinate of the start of a new contour. - Set the beginning of the next contour to the point. - - - - The amount to offset the entire path. - Set the beginning of the next contour to the point. - - - - The amount in the x-direction to offset the entire path. - The amount in the y-direction to offset the entire path. - Offset the path by the specified distance. - - - - The second operand. - The logical operator. - Compute the result of a logical operation on two paths. - Returns the resulting path if the operation was successful, otherwise . - - - - The second operand. - The logical operator. - The path that will be used to set the result to. The current path will be . - Compute the result of a logical operation on two paths. - Returns true if the operation was successful, otherwise false. - - - - The SVG path data. - Creates a path based on the SVG path data string. - Returns the new path if successful, otherwise . - - - - Gets the number of points on the path. - - - - - Gets all the points in the path. - - - , To only -return a subset of the points in the path, use -. -]]> - - - - The coordinates of the control point on a quadratic curve. - The coordinates of the end point on a quadratic curve. - Add a quadratic bezier from the last point. - - call has been made for this contour, -the first point is automatically set to (0, 0). -]]> - - - - The x-coordinate of the control point on a quadratic curve. - The y-coordinate of the control point on a quadratic curve. - The x-coordinate of the end point on a quadratic curve. - The y-coordinate of the end point on a quadratic curve. - Add a quadratic bezier from the last point. - - call has been made for this contour, -the first point is automatically set to (0, 0). -]]> - - - - The radius. - The angle in degrees relative to the x-axis. - Determines whether the smallest or largest arc possible is drawn. - Determines if the arc should be swept in an anti-clockwise or clockwise direction. - The destination coordinates relative to the last point. - The same as , but the coordinates are considered relative to the last point on this contour. - - - - The radius in the x-direction. - The radius in the y-direction. - The angle in degrees relative to the x-axis. - Determines whether the smallest or largest arc possible is drawn. - Determines if the arc should be swept in an anti-clockwise or clockwise direction. - The destination x-coordinate relative to the last point. - The destination y-coordinate relative to the last point. - The same as , but the coordinates are considered relative to the last point on this contour. - - - - The amount to add to the coordinates of the last point on this contour, to specify the control point of the conic curve. - The amount to add to the coordinates of the last point on this contour, to specify the end point of the conic curve. - The weight of the conic curve. - Same as but the coordinates are considered relative to the last point on this contour. - - call has been made for this contour, -the first point is automatically set to (0, 0). -]]> - - - - The amount to add to the x-coordinate of the last point on this contour, to specify the control point of the conic curve. - The amount to add to the y-coordinate of the last point on this contour, to specify the control point of the conic curve. - The amount to add to the x-coordinate of the last point on this contour, to specify the end point of the conic curve. - The amount to add to the y-coordinate of the last point on this contour, to specify the end point of the conic curve. - The weight of the conic curve. - Same as but the coordinates are considered relative to the last point on this contour. - - call has been made for this contour, -the first point is automatically set to (0, 0). -]]> - - - - The amount to add to the coordinates of the last point on this contour, to specify the 1st control point on a cubic curve. - The amount to add to the coordinates of the last point on this contour, to specify the 2nd control point on a cubic curve. - The amount to add to the coordinates of the last point on this contour, to specify the end point on a cubic curve. - Same as but the coordinates are considered relative to the last point on this contour. - - call has been made for this contour, -the first point is automatically set to (0, 0). -]]> - - - - The amount to add to the x-coordinate of the last point on this contour, to specify the 1st control point on a cubic curve. - The amount to add to the y-coordinate of the last point on this contour, to specify the 1st control point on a cubic curve. - The amount to add to the x-coordinate of the last point on this contour, to specify the 2nd control point on a cubic curve. - The amount to add to the y-coordinate of the last point on this contour, to specify the 2nd control point on a cubic curve. - The amount to add to the x-coordinate of the last point on this contour, to specify the end point on a cubic curve. - The amount to add to the y-coordinate of the last point on this contour, to specify the end point on a cubic curve. - Same as but the coordinates are considered relative to the last point on this contour. - - call has been made for this contour, -the first point is automatically set to (0, 0). -]]> - - - - Clear any lines and curves from the path, making it empty. - This frees up internal storage associated with those segments. - - - Clear any lines and curves from the path, making it empty. - Any internal storage for those lines/curves is retained, making reuse of the path potentially faster. - - - The amount to add to the coordinates of the last point on this contour, to specify the end of a line. - Same as but the coordinates are considered relative to the last point on this contour. - - call has been made for this contour, -the first point is automatically set to (0, 0). -]]> - - - - The amount to add to the x-coordinate of the last point on this contour, to specify the end of a line. - The amount to add to the y-coordinate of the last point on this contour, to specify the end of a line. - Same as but the coordinates are considered relative to the last point on this contour. - - call has been made for this contour, -the first point is automatically set to (0, 0). -]]> - - - - The amount to add to the coordinates of the last point on this contour, to specify the start of a new contour. - Same as but the coordinates are considered relative to the last point on this contour. - - - - The amount to add to the x-coordinate of the last point on this contour, to specify the start of a new contour. - The amount to add to the x-coordinate of the last point on this contour, to specify the start of a new contour. - Same as but the coordinates are considered relative to the last point on this contour. - - - - The amount to add to the coordinates of the last point on this contour, to specify the control point on a quadratic curve. - The amount to add to the coordinates of the last point on this contour, to specify end point on a quadratic curve. - Same as but the coordinates are considered relative to the last point on this contour. - - call has been made for this contour, -the first point is automatically set to (0, 0). -]]> - - - - The amount to add to the x-coordinate of the last point on this contour, to specify the control point on a quadratic curve. - The amount to add to the y-coordinate of the last point on this contour, to specify the control point on a quadratic curve. - The amount to add to the x-coordinate of the last point on this contour, to specify end point on a quadratic curve. - The amount to add to the y-coordinate of the last point on this contour, to specify end point on a quadratic curve. - Same as but the coordinates are considered relative to the last point on this contour. - - call has been made for this contour, -the first point is automatically set to (0, 0). -]]> - - - - Gets a set of flags indicating if the path contains one or more segments of that type. - - - - - Return a simplified copy of the current path. - Returns the new path if simplification was successful, otherwise null. - The curve order is reduced where possible so that cubics may be turned into quadratics, and quadratics maybe turned into lines. - - - The path to store the simplified path data. If simplification failed, then this is unmodified. - Simplifies the current path. - Returns true if simplification was successful, otherwise false. - The curve order is reduced where possible so that cubics may be turned into quadratics, and quadratics maybe turned into lines. - - - Gets the "tight" bounds of the path. Unlike , the control points of curves are excluded. - The tight bounds of the path. - - - - Returns a SVG path data representation of the current path. - - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - The matrix to use for transformation. - Applies a transformation matrix to the all the elements in the path. - - - - The matrix to use for transformation. - The instance that should contain the final, transformed path. - Applies a transformation matrix to the all the elements in the path. - - - - Gets the number of verbs in the path. - - - - - Iterator object to scan the all of the segments (lines, quadratics, cubics) of each contours in a path. - - method. -]]> - - - - Return the weight for the current conic. - - - was . -]]> - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - Returns a value indicating whether the current contour is closed. - Returns true if the current contour is closed (has a ). - - - - Returns a value indicating whether the last call to returns a line which was the result of a command. - Returns true if the last call to returned a line which was the result of a command. - If the call to returned a different value than , the result is undefined. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - The storage for the points representing the current verb and/or segment. Should be an array of four points. - If , first scan for segments that are deemed degenerate (too short) and skip those. - If is and exact is true, skip only degenerate elements with lengths exactly equal to zero. If exact is , skip degenerate elements with lengths close to zero. If is , exact has no effect. - Returns the next verb in this iteration of the path. - The verb of the current segment. - When all segments have been visited, returns . - - - Perform a series of path operations, optimized for unioning many paths together. - - - - Creates an instance of . - - - - The second operand. - The operator to apply to the existing and supplied paths. - Add one or more paths and their operand. - The builder is empty before the first path is added, so the result of a single add is ("empty-path" OP "path"). - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - The product of the operands. - Computes the sum of all paths and operands, and resets the builder to its initial state. - Returns true if the operation succeeded, otherwise false. - - - - Iterator object to scan through the verbs in the path, providing the associated points. - - -method. -]]> - - - - Returns the weight for the current conic. - - Only valid if the current segment returned by was . - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - The storage for the points representing the current verb and/or segment. Should be an array of four points. - Returns the next verb in this iteration of the path. - The verb of the current segment. - - - - To be added. - To be added. - To be added. - To be added. - - - Returns what the next verb will be, but do not visit the next segment. - Returns the verb for the next segment. - - - - How to transform path at each point (based on the current position and tangent). - - - - Transform each point, and turn lines into curves. - - - Rotate the shape about its center. - - - Translate the shape to each position. - - - Controls how a path is added to another path. - - - - Source path contours are added as new contours. - - - The path is added by extending the last contour of the destination path with the first contour of the source path. If the last contour of the destination path is closed, then it will not be extended. Instead, the start of source path will be extended by a straight line to the end point of the destination path. - - - Indication for whether the smaller or larger of possible two arcs is drawn. - - - - The larger of the two possible arcs. - - - The smaller of the two possible arcs. - - - Convexity for paths. - - - - The path is concave. - - - The path is convex. - - - The path's convexity is unknown. - - - Direction for path contours. - - - - Clockwise direction for adding closed contours. - - - Counter-clockwise direction for adding closed contours. - - - The base class for objects in the that affect the geometry of a drawing primitive before it is transformed by the canvas' matrix and drawn. - - - - The path to replicate (dash). - The space between instances of path. - The distance (mod advance) along path for its initial position. - How to transform path at each point (based on the current position and tangent). - Creates a dash path effect by replicating the specified path. - Returns the new , or null on error. - - - - The width of the line. - The matrix. - Creates a dash path effect by replacing the path with a solid line. - Returns the new , or null on error. - - - - The matrix. - The path. - Stamp the specified path to fill the shape, using the matrix to define the latice. - Returns the new , or null on error. - - - - The arc radius. - Creates a path effect that can turn sharp corners into various arcs. - Returns the new , or null on error. - - - - The outer (second) path effect to apply. - The inner (first) path effect to apply. - Creates a compound path effect. - Returns the new , or null on error. - The effect is to apply first the inner path effect and the the outer path effect (e.g. outer(inner(path))). - - - The radius to use, must be > 0 to have an effect. - Creates a path effect that can turn sharp corners into various treatments (e.g. rounded corners). - Returns the new , or null on error. - - - - The definition of the dash pattern via an even number of entries. - The offset into the intervals array. (mod the sum of all of the intervals). - Creates a dash path effect by specifying the dash intervals. - Returns the new , or null on error. - - The dash pattern is defined via an array containing an even number of entries (>=2), with the even indices specifying the length of "on" intervals, and the odd indices specifying the length of "off" intervals. - For example: if the intervals = new [] { 10, 20 } and the phase = 25, then the dash pattern will be: 5 pixels off, 10 pixels on, 20 pixels off, 10 pixels on, 20 pixels off, etc. A phase of -5, 25, 55, 85, etc. would all result in the same path, because the sum of all the intervals is 30. - - - - The length of the segments to break the path into. - The maximum distance to move the point away from the original path. - The randomizer seed to use. - Creates a "jitter" path effect by chopping a path into discrete segments, and randomly displacing them. - Returns the new , or null on error. - - - - The first path effect to apply. - The second path effect to apply. - Creates a compound path effect. - Returns the new , or null on error. - The effect is to apply one path after the other. - - - The start path offset between [0, 1] - inclusive. - The stop path offset between [0, 1] - inclusive. - Creates a path effect that trims the path. - Returns the new , or null on error. - If either the start or stop values are outside the [0, 1] range (inclusive), they will be pinned to the nearest legal value. - - - The start path offset between [0, 1] - inclusive. - The stop path offset between [0, 1] - inclusive. - The trim mode to use. - Creates a path effect that trims the path. - Returns the new , or null on error. - If either the start or stop values are outside the [0, 1] range (inclusive), they will be pinned to the nearest legal value. - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Possible path fill type values. - - - - Specifies that "inside" is computed by an odd number of edge crossings. - - - Same as , but draws outside of the path, rather than inside. - - - Same as , but draws outside of the path, rather than inside. - - - Specifies that "inside" is computed by a non-zero sum of signed edge crossings. - - - Represents a type that can be used to calculate the length of, and segments of, a path. - - - - Create a new instance with a null path. - - - - The path to use, or null. - Controls whether or not the path is treated as closed. - Controls the precision of the measure. Values greater 1 increase the precision (and possibly slow down the computation). - Create a new instance with the specified path. - The path must remain valid for the lifetime of the measure object, or until is called with a different path (or null), since the measure object keeps a reference to the path object (does not copy its data). - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The distance to use. - The computed matrix. - Flags to indicate how to compute the matrix. - Computes a from the specified distance along the path. - Returns false if there is no path, or a zero-length path was specified, in which case matrix is unchanged. - Distance is pinned to 0 <= distance <= . - - - To be added. - To be added. - To be added. - To be added. - - - The distance to use. - The position of a point along the current contour. - Computes the corresponding position from the specified distance along the path. - Returns false if there is no path, or a zero-length path was specified, in which case position is unchanged. - Distance is pinned to 0 <= distance <= . - - - The distance to use. - The position of a point along the current contour. - The tangent along the current contour. - Computes the corresponding position and tangent from the specified distance along the path. - Returns false if there is no path, or a zero-length path was specified, in which case position and tangent are unchanged. - Distance is pinned to 0 <= distance <= . - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The starting offset of the segment. - The end offset of the segment. - The path to hold the new segment. - If true, begin the path segment with a . - Given a start and stop distance, update the destination path with the intervening segment(s). - Returns false if the segment is zero-length, otherwise returns true. - The start and stop parameters are pinned to 0... - - - To be added. - To be added. - To be added. - To be added. - - - The distance to use. - The tangent along the current contour. - Computes the corresponding tangent from the specified distance along the path. - Returns false if there is no path, or a zero-length path was specified, in which case position and tangent are unchanged. - Distance is pinned to 0 <= distance <= . - - - Gets a value indicating if the current contour is closed. - Returns true if the current contour is closed. - - - - Gets the total length of the current contour, or 0 if no path is associated. - The total length of the current contour. - - - - Move to the next contour in the path. - Returns true if another one exists, otherwise false. - - - - To be added. - To be added. - To be added. - - - The path to use, or null. - Controls whether or not the path is treated as closed. - Reset the path measure with the specified path. - The path must remain valid for the lifetime of the measure object, or until is called with a different path (or null), since the measure object keeps a reference to the path object (does not copy its data). - - - Flags to indicate how to compute a matrix from a position along a path. - This is used with . - - - Use the coordinates of the point along the path. - - - Use the coordinates of the point and the tangent along the path. - - - Use the coordinates of the tangent along the path. - - - The logical operations that can be performed when combining two paths using . - - - - Subtract the op path from the current path. - - - Intersect the two paths. - - - Subtract the current path from the op path. - - - Union (inclusive-or) the two paths. - - - Exclusive-or the two paths. - - - The flags used by . - - - - The path contains one or more conic segments. - - - The path contains one or more cubic segments. - - - The path contains one or more line segments. - - - The path contains one or more quad segments. - - - Verbs contained in an . - In the description below, the number of points returned represents the number of valid entries on the return array of points that is passed to or . - - - Close path, a call to or will return one point (contour's point). - - - Conic path, a call to or will return three points, plus the point. - - - Cubic path, a call to or will return four points. - - - The path is completed, points will not contain any data. - - - Line path, a call to or will return two points. - - - Move command, a call to or will return a single point. - - - Quad command, a call to or will return three points. - - - Recorded drawing operations made to a to be played back at a later time. - This base class handles serialization and a few other miscellany. - - - Gets the culling rectangle for this picture. - - Operations recorded into this picture that attempt to draw outside the culling rectangle might not be drawn. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets the non-zero value unique among all pictures. - - - - - The picture recorder is used to record drawing operations made to a and stored in a . - - - - Creates a new instance of the . - - - - The culling rectangle for the new picture. - Start the recording process and return the recording canvas. - Returns the current recording canvas. The same can be retrieved using . - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - Signal that the caller is done recording. - Returns the containing the recorded content. - - and -. -]]> - - - - Signal that the caller is done recording. - Returns the containing the recorded content. - - and -. - -Unlike , which returns an -immutable picture, the returned drawable may contain live references to other -drawables (if they were added to the recording canvas) and therefore this -drawable will reflect the current state of those nested drawables anytime it -is drawn or a new picture is snapped from it (by calling -). -]]> - - - - Gets the current recording canvas. - - - - - Describes how LCD strips are organized for each pixel. - Description of how the LCD strips are arranged for each pixel. If this is unknown, or the pixels are meant to be "portable" and/or transformed before showing (e.g. rotated, scaled) then use . - - - Pixels are made up horizontal blue, green and red lights. - - - Pixels are made up vertical blue, green and red lights. - - - Pixels are made up horizontal red, green and blue lights. - - - Pixels are made up vertical red, green and blue lights. - - - Use if the order is not known or the pixels are meant to be "portable" and/or transformed before showing (e.g. rotated, scaled). - - - Represents a mechanism for serializing pixels. - - - - Creates a new instance of with an empty buffer. - - - - The delegate to use to serialize the pixel data. - Create a new pixel serializer using the specified delegate to encode the pixel data. - Returns an instance of the . - - - - The delegate to use to determine whether to use the previous encoded data, or to encode another version. - The delegate to use to serialize the pixel data. - Create a new pixel serializer using the specified delegate to encode the pixel data. - Returns an instance of the . - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - The pixel data to encode. - Encode the specified pixel data. - Returns the encoded pixel data, or if the raw pixels should be used. - - - - The pixel data to encode. - Implemented by derived types to encode the specified pixel data. - Returns the encoded pixel data, or if the raw pixels should be used. - - - - The encoded data buffer. - The length of the encoded data buffer. - Implemented by derived types to determine whether the caller should use the specified encoded data instead of encoding a new version. - Returns if the specified encoded data should be used, otherwise to serialize another version. - - should not be called to encode -the source data. -]]> - - - - The encoded data buffer. - The length of the encoded data buffer. - Determines whether the serializer wants to use the specified encoded data instead of encoding a new version. - Returns if the specified encoded data should be used, otherwise to serialize another version. - - may not be called to encode the -source data. -]]> - - - - Pairs with actual pixels and rowbytes. - This class does not try to manage the lifetime of the pixel memory (nor the color table if provided). - - - Creates an empty instance of . - - - - The image information of the pixels. - The memory address of the pixels. - Creates an instance of . - - - - The image information of the pixels. - The memory address of the pixels. - The number of bytes per row. - Creates an instance of . - - - - The image information of the pixels. - The memory address of the pixels. - The number of bytes per row. - The color table. - Creates an instance of . - - - - Gets the alpha type. - - - - - Gets the number of bytes per pixel. - - - - - Gets the total number of bytes needed to store the pixel data. - - - - - Gets the color space. - - - - - Gets the color table. - - - - - Gets the color type. - - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - To be added. - To be added. - - - Implemented by derived types to destroy any native objects. - - - - The options to use when creating the encoder. - Encodes the pixmap as a JPEG. - Returns the wrapping the encoded pixmap. - - - - The options to use when creating the encoder. - Encodes the pixmap as a PNG. - Returns the wrapping the encoded pixmap. - - - - The options to use when creating the encoder. - Encodes the pixmap as a WEBP. - Returns the wrapping the encoded pixmap. - - - - The file format used to encode the pixmap. - The quality level to use for the pixmap. - Encodes the pixmap using the specified format. - Returns the wrapping the encoded pixmap. - - - - The stream to write the encoded pixmap to. - The options to use when creating the encoder. - Encodes the pixmap as a JPEG. - Returns on success, or if there was an error. - - - - The stream to write the encoded pixmap to. - The options to use when creating the encoder. - Encodes the pixmap as a PNG. - Returns on success, or if there was an error. - - - - The stream to write the encoded pixmap to. - The options to use when creating the encoder. - Encodes the pixmap as a WEBP. - Returns on success, or if there was an error. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The stream to write the encoded pixmap to. - The file format used to encode the pixmap. - The quality level to use for the pixmap. - Encodes the pixmap using the specified format. - Returns on success, or if there was an error. - - - - The stream to write the encoded pixmap to. - The pixmap to encode. - The options to use when creating the encoder. - Encodes the pixmap as a JPEG. - Returns on success, or if there was an error. - - - - The stream to write the encoded pixmap to. - The pixmap to encode. - The options to use when creating the encoder. - Encodes the pixmap as a PNG. - Returns on success, or if there was an error. - - - - The stream to write the encoded pixmap to. - The pixmap to encode. - The options to use when creating the encoder. - Encodes the pixmap as a WEBP. - Returns on success, or if there was an error. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The stream to write the encoded bitmap to. - The bitmap to encode. - The file format used to encode the bitmap. - The quality level to use for the bitmap. - Encodes the bitmap using the specified format. - Returns on success, or if there was an error. - - - - The stream to write the encoded pixmap to. - The pixmap to encode. - The file format used to encode the pixmap. - The quality level to use for the pixmap. - Encodes the pixmap using the specified format. - Returns on success, or if there was an error. - - - - The color to fill. - Fill the entire pixmap with the specified color. - Returns if the pixels were changed, otherwise . - If the pixmap's color type does not support alpha (e.g. 565) then the alpha of the color is ignored (treated as opaque). If the color type only supports alpha (e.g. A1 or A8) then the color's R, G, B components are ignored. - - - To be added. - To be added. - To be added. - To be added. - - - The color to fill. - The subset of the pixmap to fill. - Fill the entire pixmap with the specified color. - Returns if the pixels were changed, otherwise . - If the pixmap's color type does not support alpha (e.g. 565) then the alpha of the color is ignored (treated as opaque). If the color type only supports alpha (e.g. A1 or A8) then the color's R, G, B components are ignored. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The bounds of the pixmap subset to retrieve. - Creates a new which is a subset of this pixmap. - Returns a subset of the pixmap. - - - - The pixmap to store the subset pixels. - The bounds of the pixmap subset to retrieve. - Creates a new which is a subset of this pixmap. - Returns if the pixels were read, or if there was an error. - - - - The column index, zero or greater, and less than the pixmap width. - The row index, zero or greater, and less than the pixmap height. - Returns the color of the pixel at the specified coordinates. - Returns the color of the pixel. - - - - Returns the memory address of the pixels. - - - - - The column index, zero or greater, and less than the pixmap width. - The row index, zero or greater, and less than the pixmap height. - Returns the memory address of the pixels at (x, y). - - - - - Returns a span that wraps the pixel data. - Returns the span. - This span is only valid as long as the pixmap is valid - - - To be added. - To be added. - To be added. - To be added. - - - Gets the image height. - - - - - Gets the image info. - - - - - The pixmap to read the pixel data into. - Copies the pixels from the image into the specified pixmap. - Returns if the pixels were read, or if there was an error. - - - - The image information describing the destination pixel buffer. - The pixel buffer to read the pixel data into. - The number of bytes in each row of in the destination buffer. - Copies the pixels from the image into the specified buffer. - Returns if the pixels were read, or if there was an error. - - - - The pixmap to read the pixel data into. - The source x-coordinate to start reading from. - The source y-coordinate to start reading from. - Copies the pixels from the image into the specified pixmap. - Returns if the pixels were read, or if there was an error. - - - - The image information describing the destination pixel buffer. - The pixel buffer to read the pixel data into. - The number of bytes in each row of in the destination buffer. - The source x-coordinate to start reading from. - The source y-coordinate to start reading from. - Copies the pixels from the image into the specified buffer. - Returns if the pixels were read, or if there was an error. - - - - The image information describing the destination pixel buffer. - The pixel buffer to read the pixel data into. - The number of bytes in each row of in the destination buffer. - The source x-coordinate to start reading from. - The source y-coordinate to start reading from. - The behavior to control whether or not the source pixels are first converted to linear space. - Copies the pixels from the image into the specified buffer. - Returns if the pixels were read, or if there was an error. - - - - Gets a rectangle with the current width and height. - - - - - Reset the pixmap to an empty pixmap. - - - - The image information of the pixels. - The memory address of the pixels. - The number of bytes per row. - Resets the pixmap to the specified pixels. - - - - The image information of the pixels. - The memory address of the pixels. - The number of bytes per row. - The color table. - Resets the pixmap to the specified pixels. - - - - The pixmap to store the resized pixels. - The pixmap to resize. - The resize method. - Resize the specified pixmap using the specified method. - Returns if the resize operation can be performed, otherwise . - - - - Gets the number of bytes per row. - - - - - The pixmap to recieve the scaled and converted pixels. - The level of quality to use when scaling the pixels. - Copies this pixmap to the destination, scaling the pixels to fit the destination size and converting the pixels to match the color type and alpha type. - Returns on success, or if there was an error. - - , or -, the destination color type must match. -If the color type is , destination -colorspace must also match. - -If the alpha type is , the destination -alpha type must match. - -If the colorspace is `null`, the destination colorspace must also be `null`. - -Filter Quality: - - - is fastest, typically implemented - with nearest neighbor filter. - - is typically implemented with bilerp - filter. - - is typically implemented with - bilerp filter, and mipmap when size is reduced. - - is slowest, typically implemented - with the bicubic filter.]]> - - - - Gets the current size of the pixmap. - - - - - Gets the image width. - - - - - The alpha/transparency type. - Creates a new with the same properties as this , but with the specified transparency type. - Returns the new . - - - - The color space. - Creates a new with the same properties as this , but with the specified color space. - Returns the new . - - - - The color type. - Creates a new with the same properties as this , but with the specified color type. - Returns the new . - - - - 32-bit ARGB premultiplied color value. - The byte order for this value is configuration dependent. This is different from , which is unpremultiplied, and is always in the same byte order. - - - The integer value of the premultiplied color. - Creates a color from the specified integer. - - - - Gets the alpha component of the color. - - - - - Gets the blue component of the color. - - - - - To be added. - Determines whether the specified object is equal to the current object. - Returns if the specified object is equal to the current object; otherwise, . - - - - The object to compare with the current object. - Determines whether the specified object is equal to the current object. - Returns if the specified object is equal to the current object; otherwise, . - - - - Serves as the default hash function. - Returns a hash code for the current object. - - - - Gets the green component of the color. - - - - - The first color to compare. - The second color to compare. - Indicates whether two objects are equal. - Returns if is equal to , otherwise . - - - - The unpremultiplied color to convert. - Converts an unpremultiplied to the premultiplied . - Returns the new premultiplied . - - - - The premultiplied color to convert. - Converts a premultiplied to the unpremultiplied . - Returns the new unpremultiplied . - - - - The color to convert. - Converts a to a UInt32. - The UInt32 value for the color. - - - - The UInt32 representation of a color. - Converts a UInt32 to a . - The new instance. - - - - The first color to compare. - The second color to compare. - Indicates whether two objects are different. - Returns if is not equal to , otherwise . - - - - The unpremultiplied color to convert. - Converts an unpremultiplied to a premultiplied . - Returns the new premultiplied . - - - - The unpremultiplied colors to convert. - Converts an array of unpremultiplied s to an array of premultiplied s. - Returns the new array of premultiplied s. - - - - Gets the red component of the color. - - - - - Returns the color as a string in the format: #AARRGGBB. - - - - - The premultiplied color to convert. - Converts a premultiplied to the unpremultiplied . - Returns the new unpremultiplied . - - - - The premultiplied colors to convert. - Converts an array of premultiplied s to an array of unpremultiplied s. - Returns the new array of unpremultiplied s. - - - - Various row filters to use when encoding a PNG. - - - - Try all the filters. - - - Use the average of the two neighboring pixels (left and above) to predict the value of a pixel. [Average(x) = Raw(x) - floor((Raw(x-bpp)+Prior(x))/2)] - - - Do not use any filters. - - - Transmit unmodified. - - - Compute a simple linear function of the three neighboring pixels (left, above, upper left), then chooses as predictor the neighboring pixel closest to the computed value. [Paeth(x) = Raw(x) - PaethPredictor(Raw(x-bpp), Prior(x), Prior(x-bpp))] - - - Transmit the difference between each byte and the value of the corresponding byte of the prior pixel. [Sub(x) = Raw(x) - Raw(x-bpp)] - - - Transmit the difference between each byte and the value of the corresponding byte of the pixel above. [Up(x) = Raw(x) - Prior(x)] - - - Options to control the PNG encoding. - - - - The filtering flags. - The compression level in the range 0..9. - Creates a new instance of . - - - - The filtering flags. - The compression level in the range 0..9. - The unpremultiplication behavior. - Creates a new instance of . - - - - Gets a new instance of with the values set to the defaults. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the filtering flags. - - - If a single filter is chosen, then that filter will be used for every row. - If multiple filters are chosen, then a heuristic will be used to guess which filter will encode smallest, then apply that filter. This happens on a per row basis, different rows can use different filters. - Using a single filter (or less filters) is typically faster. Trying all of the filters may help minimize the output file size. - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the unpremultiplication behavior if the input is premultiplied. - - - - - Gets or sets the compression level in the range 0..9. - - A value of 0 is a special case to skip compression entirely, creating dramatically larger PNGs. - - - Represents an ordered pair of floating-point x- and y-coordinates that defines a point in a two-dimensional plane. - To convert a to a , use or . - - - The horizontal position of the point. - The vertical position of the point. - Creates a new instance of a point with the specified coordinates. - - - - The point to translate. - The offset value. - Translates a given point by a specified offset. - Returns the translated point. - - - - The point to translate. - The offset value. - Translates a given point by a specified offset. - Returns the translated point. - - - - The point to translate. - The offset size. - Translates a given point by a specified size. - Returns the translated point. - - - - The point to translate - The offset size. - Translates a given point by a specified size. - Returns the translated point. - - - - The first point. - The second point. - Calculate the Euclidean distance between two points. - Returns the Euclidean distance between two points. - - - - The first point. - The second point. - Calculate the Euclidean distance squared between two points. - Returns the Euclidean distance squared between two points. - - - - Represents a new instance of the class with member data left uninitialized. - - - - The to test. - Specifies whether this contains the same coordinates as the specified . - This method returns true if has the same coordinates as this . - - - - The to test. - Specifies whether this contains the same coordinates as the specified . - This method returns true if is a and has the same coordinates as this . - - - - Calculates the hashcode for this point. - Returns the hashcode for this point. - You should avoid depending on GetHashCode for unique values, as two objects with the same values for their X and Y properties may return the same hash code. This behavior could change in a future release. - - - Gets a value indicating whether this point is empty. - - - - - Gets the Euclidean distance from the origin (0, 0). - - - - - Gets the Euclidean distance squared from the origin (0, 0). - - - - - The point to normalize. - Returns a point with the same direction as the specified point, but with a length of one. - Returns a point with a length of one. - - - - The offset value. - Translates a given point by a specified offset. - - - - The offset in the x-direction. - The offset in the y-direction. - Translates a given point by a specified offset. - - - - The point to translate. - The offset value. - Translates a given point by a specified offset. - Returns the translated point. - - - - The point to translate. - The offset value. - Translates a given point by a specified offset. - Returns the translated point. - - - - The point to translate. - The offset size. - Translates a given point by a specified size. - Returns the translated point. - - - - The point to translate. - The offset size. - Translates a given point by a specified size. - Returns the translated point. - - - - A to compare. - A to compare. - Compares two structures. The result specifies whether the values of the and properties of the two structures are equal. - true if the and values of the left and right structures are equal; otherwise, false. - - - - A to compare. - A to compare. - Determines whether the coordinates of the specified points are not equal. - true if the and values of the left and right structures differ; otherwise, false. - - - - The to translate. - The point that specifies the numbers to subtract from the coordinates of . - Translates a given point by the negative of a specified offset. - The translated . - - - - The to translate. - The point that specifies the numbers to subtract from the coordinates of . - Translates a given point by the negative of a specified offset. - The translated . - - - - The to translate. - The that specifies the numbers to subtract from the coordinates of . - Translates a by the negative of a given . - The translated . - - - - The to translate. - The that specifies the numbers to subtract from the coordinates of . - Translates a by the negative of a given . - The translated . - - - - The point to reflect. - The normal. - Returns the reflection of a point off a surface that has the specified normal. - Returns the reflection of a point. - - - - The to translate. - The offset that specifies the numbers to subtract from the coordinates of . - Translates a given point by the negative of a specified offset. - The translated . - - - - The to translate. - The offset that specifies the numbers to subtract from the coordinates of . - Translates a given point by the negative of a specified offset. - The translated . - - - - The to translate. - The that specifies the numbers to subtract from the coordinates of . - Translates a by the negative of a specified size. - The translated . - - - - The to translate. - The that specifies the numbers to subtract from the coordinates of . - Translates a by the negative of a specified size. - The translated . - - - - Converts this to a human readable string. - A string that represents this . - - - - Gets or sets the x-coordinate of this . - - - - - Gets or sets the x-coordinate of this . - - - - - Represents an ordered pair of floating-point x-, y- and z-coordinates that defines a point in a three-dimensional plane. - - - - The x-coordinate of the point. - The y-coordinate of the point. - The z-coordinate of the point. - Creates a new instance of a 3D point with the specified coordinates. - - - - The point to translate. - The offset value. - Translates a given point by a specified offset. - Returns the translated point. - - - - Represents a new instance of the class with member data left uninitialized. - - - - The to test. - Specifies whether this contains the same coordinates as the specified . - This method returns true if has the same coordinates as this . - - - - The to test. - Specifies whether this contains the same coordinates as the specified . - This method returns true if is a and has the same coordinates as this . - - - - Calculates the hashcode for this point. - Returns the hashcode for this point. - You should avoid depending on GetHashCode for unique values, as two objects with the same values for their X, Y and Z properties may return the same hash code. This behavior could change in a future release. - - - Gets a value indicating whether this is empty. - - - - - The point to translate. - The offset value. - Translates a given point by a specified offset. - Returns the translated point. - - - - A to compare. - A to compare. - Compares two structures. The result specifies whether the values of the and properties of the two structures are equal. - true if the , and values of the left and right structures are equal; otherwise, false. - - - - A to compare. - A to compare. - Determines whether the coordinates of the specified points are not equal. - true if the , and values of the left and right structures differ; otherwise, false. - - - - The point to translate. - The offset value. - Translates a given point by the negative of a specified offset. - Returns the translated point. - - - - The point to translate. - The offset value. - Translates a given point by the negative of a specified offset. - Returns the translated point. - - - - Converts this to a human readable string. - A string that represents this . - - - - Gets or sets the x-coordinate of this . - - - - - Gets or sets the y-coordinate of this . - - - - - Gets or sets the z-coordinate of this . - - - - - Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane. - - - - A that specifies the coordinates for the new . - Initializes a new instance of the class from a . - - - - The horizontal position of the point. - The vertical position of the point. - Initializes a point from two floating point values. - - - - The point to translate. - The point that specifies the number to add to the coordinates of . - Translates a given by the specified point. - The translated point. - - - - The point to translate. - The size that specifies the number to add to the coordinates of . - Translates a given by the specified . - The translated point. - - - - The to convert. - Converts the specified to a by rounding the values of the to the next higher integer values. - The this method converts to. - - - - The first point. - The second point. - Calculate the Euclidean distance between two points. - Returns the Euclidean distance between two points. - - - - The first point. - The second point. - Calculate the Euclidean distance squared between two points. - Returns the Euclidean distance squared between two points. - - - - Represents a new instance of the class with member data left uninitialized. - - - - The to test. - Specifies whether this contains the same coordinates as the specified . - This method returns true if has the same coordinates as this . - - - - The to test. - Specifies whether this contains the same coordinates as the specified . - This method returns true if is a and has the same coordinates as this . - - - - Calculates the hashcode for this point. - Returns the hashcode for this point. - You should avoid depending on GetHashCode for unique values, as two point objects with the same values for their X and Y properties may return the same hash code. This behavior could change in a future release. - - - Gets a value indicating whether this is empty. - - - - - Gets the Euclidean distance from the origin (0, 0). - - - - - Gets the Euclidean distance squared from the origin (0, 0). - - - - - The point to normalize. - Returns a point with the same direction as the specified point, but with a length of one. - Returns a point with a length of one. - - - - The used to offset this . - Translates this by the specified . - This method adjusts the and values of this to the sum of the and values of this and . - - - The amount to offset the x-coordinate. - The amount to offset the y-coordinate. - Translates this by the specified amount. - - - - The to translate. - A point that specifies the pair of numbers to add to the coordinates of . - Translates a by a given offset. - Returns the translated . - - - - The to translate. - A that specifies the pair of numbers to add to the coordinates of . - Translates a by a given . - Returns the translated . - - - - A to compare. - A to compare. - Determines whether the coordinates of the specified points are equal. - true if the and values of the left and right structures are equal; otherwise, false. - - - - The to convert. - Converts an into an . - The new . - - - - The to convert. - Converts an into an . - The new . - - - - A to compare. - A to compare. - Determines whether the coordinates of the specified points are not equal. - true if the and values of the left and right structures differ; otherwise, false. - - - - The to translate. - The point that specifies the numbers to subtract from the coordinates of . - Translates a by the negative of a given point. - The translated . - - - - The to translate. - The that specifies the numbers to subtract from the coordinates of . - Translates a by the negative of a given . - The translated . - - - - The point to reflect. - The normal. - Returns the reflection of a point off a surface that has the specified normal. - Returns the reflection of a point. - - - - The to convert. - Converts the specified to a object by rounding the values to the nearest integer. - The this method converts to. - - - - The to be subtracted from. - The point to subtract from the . - Returns the result of subtracting specified point from the specified . - The that is the result of the subtraction operation. - - - - The to be subtracted from. - The to subtract from the . - Returns the result of subtracting specified from the specified . - The that is the result of the subtraction operation. - - - - Converts this to a human readable string. - A string that represents this . - - - - The to convert. - Converts the specified to a by truncating the values of the . - The this method converts to. - - - - Gets or sets the x-coordinate of this . - - - - - Gets or sets the y-coordinate of this - - - - - Possible values to interpret the incoming array of points for the method. - - - - Interpret the data as coordinates for lines. - - - Interpret the data as coordinates for points. - - - Interpret the data as coordinates for polygons. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Stores a set of four floating-point numbers that represent the upper-left corner and lower-right corner of a rectangle. - - - - The left coordinate. - The top coordinate. - The right coordinate. - The bottom coordinate. - Initializes a new instance of the class with the specified upper-left corner and lower-right corner. - - - - The size of the existing rectangle. - Calculates the smallest rectangle that will fill the current rectangle using the specified size. - Returns the smallest rectangle that will fill the current rectangle. - - - - The size of the existing rectangle. - Calculates the largest rectangle that will fit inside the current rectangle using the specified size. - Returns the largest rectangle that will fit inside the current rectangle. - - - - Gets or sets the y-coordinate of the bottom edge of this structure. - - - - - The point to test. - Determines whether the specified point is inside this rectangle. - Returns true if the point is inside this rectangle, otherwise false. - - - - The rectangle to test. - Determines whether the specified rectangle is inside this rectangle. - Returns true if the rectangle is inside this rectangle, otherwise false. - - - - The x-coordinate. - The y-coordinate. - Determines whether the specified coordinates are inside this rectangle. - Returns true if the coordinates are inside this rectangle, otherwise false. - - - - The rectangle size. - Creates a new rectangle with the specified size. - Returns the new rectangle. - - - - The rectangle location. - The rectangle size. - Creates a new rectangle with the specified location and size. - Returns the new rectangle. - - - - The rectangle width. - The rectangle height. - Creates a new rectangle with the specified size. - Returns the new rectangle. - - - - The x-coordinate. - The y-coordinate. - The rectangle width. - The rectangle height. - Creates a new rectangle with the specified location and size. - Returns the new rectangle. - - - - Represents a new instance of the class with member data left uninitialized. - - - - The to test. - Specifies whether this rectangle contains the same coordinates as the specified . - This method returns true if has the same coordinates as this . - - - - The to test. - Specifies whether this rectangle contains the same coordinates as the specified . - This method returns true if is a and has the same coordinates as this . - - - - Calculates the hashcode for this rectangle. - Returns the hashcode for this rectangle. - - - - Gets the height of the . - - - - - The amount to inflate this . - Enlarges this structure by the specified amount. - - - - The amount to inflate this structure horizontally. - The amount to inflate this structure vertically. - Enlarges this structure by the specified amount. - - - - The to be copied. This rectangle is not modified. - The amount to enlarge the copy of the rectangle horizontally. - The amount to enlarge the copy of the rectangle vertically. - Creates and returns an enlarged copy of the specified structure. The copy is enlarged by the specified amount and the original rectangle remains unmodified. - The enlarged . - - - - The rectangle to intersect. - Replaces this structure with the intersection of itself and the specified structure. - - - - A rectangle to intersect. - A rectangle to intersect. - Returns a structure that represents the intersection of two rectangles. If there is no intersection, and empty is returned. - A third structure the size of which represents the overlapped area of the two specified rectangles. - - - - The rectangle to test. - Determines if this rectangle intersects with another rectangle. - This method returns true if there is any intersection. - - - - The rectangle to test. - Determines if this rectangle intersects with another rectangle. - This method returns true if there is any intersection. - - - - Gets a value indicating whether this rectangle has a zero size and location. - - - - - Gets or sets the x-coordinate of the left edge of this structure. - - - - - Gets or sets the offset of the rectangle. - - - - - Gets the x-coordinate of the middle of this rectangle. - - - - - Gets the y-coordinate of the middle of this rectangle. - - - - - The amount to offset the rectangle. - Translates the this rectangle by the specified amount. - - - - The amount to offset the location horizontally. - The amount to offset the location vertically. - Translates the this rectangle by the specified amount. - - - - The structure that is to the left of the equality operator. - The structure that is to the right of the equality operator. - Tests whether two structures have equal coordinates. - This operator returns true if the two specified structures have equal , , , and properties. - - - - The structure to convert. - Converts the specified structure to a structure. - The structure that is converted from the specified structure. - - - - The structure that is to the left of the inequality operator. - The structure that is to the right of the inequality operator. - Tests whether two structures differ in coordinates. - This operator returns true if any of the , , , or properties of the two structures are unequal; otherwise false. - - - - Gets or sets the x-coordinate of the right edge of this structure. - - - - - Gets or sets the size of the rectangle. - - - - - Gets this rectangle and a new rectangle with a positive width and height. - - - - - Gets or sets the y-coordinate of the top edge of this structure. - - - - - Converts this to a human readable string. - A string that represents this . - - - - A rectangle to union. - Replaces this structure with the union of itself and the specified structure. - - - - A rectangle to union. - A rectangle to union. - Creates the smallest possible third rectangle that can contain both of two rectangles that form a union. - A third structure that contains both of the two rectangles that form the union. - - - - Gets the width of the rectangle. - - - - - Stores a set of four integers that represent the upper-left corner and lower-right corner of a rectangle. - - - - The left coordinate. - The top coordinate. - The right coordinate. - The bottom coordinate. - Initializes a new instance of the class with the specified upper-left corner and lower-right corner. - - - - The size of the existing rectangle. - Calculates the smallest rectangle that will fill the current rectangle using the specified size. - Returns the smallest rectangle that will fill the current rectangle. - - - - The size of the existing rectangle. - Calculates the largest rectangle that will fit inside the current rectangle using the specified size. - Returns the largest rectangle that will fit inside the current rectangle. - - - - Gets or sets the y-coordinate of the bottom edge of this structure. - - - - - The structure to be converted. - Converts the specified structure to a structure by rounding the values to the next higher integer values. - Returns a . - - - - The structure to be converted. - Whether or not to move in the direction of the side. - Converts the specified structure to a structure by rounding the values to the next higher integer values. - Returns a . - - - - The point to test. - Determines whether the specified point is inside this rectangle. - Returns true if the point is inside this rectangle, otherwise false. - - - - The rectangle to test. - Determines whether the specified rectangle is inside this rectangle. - Returns true if the rectangle is inside this rectangle, otherwise false. - - - - The x-coordinate. - The y-coordinate. - Determines whether the specified coordinates are inside this rectangle. - Returns true if the coordinates are inside this rectangle, otherwise false. - - - - The rectangle size. - Creates a new rectangle with the specified size. - Returns the new rectangle. - - - - The rectangle location. - The rectangle size. - Creates a new rectangle with the specified location and size. - Returns the new rectangle. - - - - The rectangle width. - The rectangle height. - Creates a new rectangle with the specified width and height. - Returns the new rectangle. - - - - The x-coordinate. - The y-coordinate. - The rectangle width. - The rectangle height. - Creates a new rectangle with the specified location and size. - Returns the new rectangle. - - - - Represents a new instance of the class with member data left uninitialized. - - - - The to test. - Specifies whether this rectangle contains the same coordinates as the specified . - This method returns true if has the same coordinates as this . - - - - The to test. - Specifies whether this rectangle contains the same coordinates as the specified . - This method returns true if is a and has the same coordinates as this . - - - - The structure to be converted. - Converts the specified structure to a structure by rounding the values to the closest lower integer values. - Returns a . - - - - The structure to be converted. - Whether or not to move in the direction of the side. - Converts the specified structure to a structure by rounding the values to the closest lower integer values. - Returns a . - - - - Calculates the hashcode for this rectangle. - Returns the hashcode for this rectangle. - - - - Gets the height of the . - - - - - The amount to inflate this . - Enlarges this structure by the specified amount. - - - - The amount to inflate this structure horizontally. - The amount to inflate this structure vertically. - Enlarges this structure by the specified amount. - - - - The to be copied. This rectangle is not modified. - The amount to enlarge the copy of the rectangle horizontally. - The amount to enlarge the copy of the rectangle vertically. - Creates and returns an enlarged copy of the specified structure. The copy is enlarged by the specified amount and the original rectangle remains unmodified. - The enlarged . - - - - The rectangle to intersect. - Replaces this structure with the intersection of itself and the specified structure. - - - - A rectangle to intersect. - A rectangle to intersect. - Returns a structure that represents the intersection of two rectangles. If there is no intersection, and empty is returned. - A third structure the size of which represents the overlapped area of the two specified rectangles. - - - - The rectangle to test. - Determines if this rectangle intersects with another rectangle. - This method returns true if there is any intersection. - - - - The rectangle to test. - Determines if this rectangle intersects with another rectangle. - This method returns true if there is any intersection. - - - - Gets a value indicating whether this rectangle has a zero size and location. - - - - - Gets or sets the x-coordinate of the left edge of this structure. - - - - - Gets or sets the offset of the rectangle. - - - - - Gets the x-coordinate of the middle of this rectangle. - - - - - Gets the y-coordinate of the middle of this rectangle. - - - - - The amount to offset the rectangle. - Translates the this rectangle by the specified amount. - - - - The amount to offset the location horizontally. - The amount to offset the location vertically. - Translates the this rectangle by the specified amount. - - - - The structure that is to the left of the equality operator. - The structure that is to the right of the equality operator. - Tests whether two structures have equal location and size. - This operator returns true if the two specified structures have equal , , , or properties. - - - - The structure that is to the left of the inequality operator. - The structure that is to the right of the inequality operator. - Tests whether two structures differ in location or size. - This operator returns true if any of the , , , or properties of the two structures are unequal; otherwise false. - - - - Gets or sets the x-coordinate of the right edge of this structure. - - - - - The structure to be converted. - Converts the specified structure to a structure by rounding the values to the nearest integer values. - Returns a . - - - - Gets or sets the size of the . - - - - - Gets this rectangle and a new rectangle with a positive width and height. - - - - - Gets or sets the y-coordinate of the top edge of this structure. - - - - - Converts this to a human readable string. - A string that represents this . - - - - The to be converted. - Converts the specified structure to a structure by truncating the values. - The truncated value of the . - - - - A rectangle to union. - Replaces this structure with the union of itself and the specified structure. - - - - A rectangle to union. - A rectangle to union. - Creates the smallest possible third rectangle that can contain both of two rectangles that form a union. - A third structure that contains both of the two rectangles that form the union. - - - - Gets the width of the . - - - - - Encapsulates the geometric region used to specify clipping areas for drawing. - - - - Creates an empty region. - - - - The path to use as the region. - Creates a new region using the area described by the path. - - - - The rectangle to use as the region. - Creates a new region using the area described by the rectangle. - - - - The region to copy. - Creates a new region by copying an existing region. - - - - Gets the bounds of this region. - - If the region is empty, returns an empty rectangle. - - - The path to check with. - Check to see if the specified path is completely inside the current region. - Returns true if the specified path is completely inside the current region, otherwise false. - This works for simple (rectangular) and complex path, and always returns the correct result. If either the path or the region is empty, this method returns false. - - - The coordinates to check with. - Check to see if the specified coordinates are completely inside the current region. - Returns true if the specified coordinates are completely inside the current region, otherwise false. - - - - The rect to check with. - Check to see if the specified rect is completely inside the current region. - Returns true if the specified rect is completely inside the current region, otherwise false. - If either the rect or the region is empty, this method returns false. - - - The region to check with. - Check to see if the specified region is completely inside the current region. - Returns true if the specified region is completely inside the current region, otherwise false. - This works for simple (rectangular) and complex regions, and always returns the correct result. If either region is empty, this method returns false. - - - The x-coordinate to check with. - The y-coordinate to check with. - Check to see if the specified coordinates are completely inside the current region. - Returns true if the specified coordinates are completely inside the current region, otherwise false. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - To be added. - To be added. - To be added. - - - The path to check with. - Check to see if the specified path intersects with the current region. - Returns true if the specified path has a non-empty intersection with the current region. - - - - The rectangle to check with. - Check to see if the specified rectangle intersects with the current region. - Returns true if the specified rectangle has a non-empty intersection with the current region. - - - - The region to check with. - Check to see if the specified region intersects with the current region. - Returns true if the specified region has a non-empty intersection with the current region. - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - The path to apply the operator on. - The operator to apply. - Set this region to the result of applying the operation to this region and the specified path. - Returns true if the resulting region is non-empty. - - - - The rectangle to apply the operator on. - The operator to apply. - Set this region to the result of applying the operation to this region and the specified rectangle. - Returns true if the resulting region is non-empty. - - - - The region to apply the operator on. - The operator to apply. - Set this region to the result of applying the operation to this region and the specified region. - Returns true if the resulting region is non-empty. - - - - The x-coordinate to apply the operator on. - The y-coordinate to apply the operator on. - The right-coordinate to apply the operator on. - The bottom-coordinate to apply the operator on. - The operator to apply. - Set this region to the result of applying the operation to this region and the specified rectangle. - Returns true if the resulting region is non-empty. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - The replacement path. - Set this region to the area described by the path, clipped to the current region. - Returns true if the resulting region is non-empty. - This produces a region that is identical to the pixels that would be drawn by the path (with no anti-aliasing) with the current region as the clip. - - - The replacement path. - The clipping region. - Set this region to the area described by the path, clipped. - Returns true if the resulting region is non-empty. - This produces a region that is identical to the pixels that would be drawn by the path (with no anti-aliasing) with the specified clip. - - - The replacement rectangle. - Set this region to the specified rectangle. - Returns true if the resulting region is non-empty. - - - - To be added. - To be added. - To be added. - To be added. - - - The replacement region. - Set this region to the specified region. - Return true if the resulting region is non-empty. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The logical operations that can be performed when combining two regions. - - - - Subtract the op region from the first region. - - - Intersect the two regions. - - - Replace the destination region with the op region. - - - Subtract the first region from the op region. - - - Union (inclusive-or) the two regions. - - - Exclusive-or the two regions. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Represents a rounded rectangle with a potentially different radii for each corner. - If either of a corner's radii are 0 the corner will be square and negative radii are not allowed (they are clamped to zero). - - - Creates a new instance of with all values initialized to 0. - - - - The bounds of the new rectangle. - Creates a new instance of with all radii set to 0. - - - - The rounded rectangle to copy. - Creates a copy of a . - - - - The bounds of the new rectangle. - The radii of the corners. - Creates a new instance of with the same radii for all four corners. - - - - The bounds of the new rectangle. - The radii of the corners along the x-axis. - The radii of the corners along the y-axis. - Creates a new instance of with the same radii for all four corners. - - - - Gets a value indicating whether all four corners are circular (with the x- and y-axis equal). - - - - - The difference in the axis allowed before the corners are no longer circular. - Check to see whether all four corners are circular (with the x- and y-axis equal). - - - - - The rectangle. - Determines whether the specified rectangle is wholly contained within the rounded rectangle. - Returns if the specified rectangle is inside the rounded rectangle, otherwise . - - - - The amount to deflate the rectangle by. - Deflate the rectangle by the specified amount. - The corner radii are adjusted by the amount of the deflation if they are round. - - - The amount to deflate the rectangle by along the x-axis. - The amount to deflate the rectangle by along the y-axis. - Deflate the rectangle by the specified amount. - The corner radii are adjusted by the amount of the deflation if they are round. - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - The corner to retrieve. - Retrieves the radii of the specified corner. - Returns the radii of the specified corner. - - - - Gets the height of the rectangle. - - - - - The amount to inflate the rectangle by. - Inflate the rectangle by the specified amount. - The corner radii are adjusted by the amount of the inflation if they are round. - - - The amount to inflate the rectangle by along the x-axis. - The amount to inflate the rectangle by along the y-axis. - Inflate the rectangle by the specified amount. - The corner radii are adjusted by the amount of the inflation if they are round. - - - Gets a value indicating whether the rectangle has a valid bounds, radii and type. - - - - - The amount to translate the rectangle by. - Translate the rectangle by the specified amount. - - - - The amount to translate the rectangle by along the x-axis. - The amount to translate the rectangle by along the y-axis. - Translate the rectangle by the specified amount. - - - - Gets the radii of the corners. - - The order of the corners are clockwise from the top left: Top Left, Top Right, Bottom Right, Bottom Left. - - - Gets the rectangle bounds of the rounded rectangle. - - - - - Set this rounded rectangle to an empty rectangle (with all values 0). - - - - The interior rectangle. - The radii along the x-axis on the left side of the rectangle. - The radii along the y-axis on the top of the rectangle. - The radii along the x-axis on the right side of the rectangle. - The radii along the y-axis on the bottom of the rectangle. - Set this rounded rectangle to a nine-patch rectangle. - - - - The outer bounds of the oval. - Set this rectangle to be an oval. - - - - The simple rectangle. - Set this rectangle to be a simple rectangle. - - - - The simple rectangle. - The radii of the corners along the x-axis. - The radii of the corners along the y-axis. - Set this rectangle to be a simple rounded rectangle. - - - - The rectangle. - The corner radii. - Set this rectangle to be a rounded rectangle. - - - - The transformation matrix. - Create a new rounded rectangle that is transformed by the specified matrix. - Returns a new, transformed rectangle if the matrix was valid, otherwise null. - The transformation matrix must be a scale and/or translation matrix. - - - The transformation matrix. - The transformed rounded rectangle. - Create a new rounded rectangle that is transformed by the specified matrix. - Returns a if the transformation was successful, otherwise . - The transformation matrix must be a scale and/or translation matrix. - - - Gets a value indicating what sub-type of rounded rectangle this instance is. - - - - - Gets the width of the rectangle. - - - - - Represents the corners of a rounded rectangle. - - - - The lower-left or bottom-left corner. - - - The lower-right or bottom-right corner. - - - The upper-left or top-left corner. - - - The upper-right or top-right corner. - - - Represents the various sub-types of rounded rectangles. - - - - A non-empty rounded rectangle with at least one corner non-zero. - - - An empty (all zero) rounded rectangle. - - - A non-empty rounded rectangle where the left x-radii are equal, the top y-radii are equal, the right x-radii are equal and the bottom y-radii are equal. - - - A non-empty rounded rectangle with the x-radii equal to half the width and the y-radii equal to half the height. - - - A non-empty rounded rectangle with zero radii at all corners. - - - A non-empty rounded rectangle with equal x-radii and equal y-radii. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - Shaders specify the source color(s) for what is being drawn in the . - - - - - - The bitmap to use inside the shader. - Creates a new shader that will draw with the specified bitmap. - Returns a new , or an empty shader on error. This function never returns null. - - then that mask will -be colorized using the color on the paint. -]]> - - - - The bitmap to use inside the shader. - The tiling mode to use when sampling the bitmap in the x-direction. - The tiling mode to use when sampling the bitmap in the y-direction. - Creates a new shader that will draw with the specified bitmap. - Returns a new , or an empty shader on error. This function never returns null. - - then that mask will -be colorized using the color on the paint. -]]> - - - - The bitmap to use inside the shader. - The tiling mode to use when sampling the bitmap in the x-direction. - The tiling mode to use when sampling the bitmap in the y-direction. - The matrix to apply before applying the shader. - Creates a new shader that will draw with the specified bitmap. - Returns a new , or an empty shader on error. This function never returns null. - - then that mask will -be colorized using the color on the paint. -]]> - - - - The color to paint. - Creates a new shader that just draws the specified color. - Returns a new , or an empty shader on error. This function never returns null. - - - - The color to paint. - The colorspace to use. - Creates a new shader that just draws the specified color. - Returns a new , or an empty shader on error. This function never returns null. - - - - The shader to apply. - The color filter to apply. - Creates a new shader that produces the same colors as invoking this shader and then applying the color filter. - Returns a new , or an empty shader on error. This function never returns null. - - - - The colors from this shader are seen as the destination by the blend mode. - The colors from this shader are seen as the source by the blend mode. - Create a new compose shader, which combines two shaders by the blend mode. - Returns a new , or an empty shader on error. This function never returns null. - - - - The colors from this shader are seen as the destination by the blend mode. - The colors from this shader are seen as the source by the blend mode. - The blend mode that combines the two shaders. - Create a new compose shader, which combines two shaders by a blend mode. - Returns a new , or an empty shader on error. This function never returns null. - - - - Creates a new "empty" shader that will not draw anything. - Returns a new , or an empty shader on error. This function never returns null. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The start point for the gradient. - The end point for the gradient. - The array colors to be distributed between the two points. - The tiling mode. - Creates a shader that generates a linear gradient between the two specified points. - Returns a new , or an empty shader on error. This function never returns null. - - - - The start point for the gradient. - The end point for the gradient. - The array colors to be distributed between the two points. - The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors. - The tiling mode. - Creates a shader that generates a linear gradient between the two specified points. - Returns a new , or an empty shader on error. This function never returns null. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The start point for the gradient. - The end point for the gradient. - The array colors to be distributed between the two points. - The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors. - The tiling mode. - The matrix to apply before applying the shader. - Creates a shader that generates a linear gradient between the two specified points. - Returns a new , or an empty shader on error. This function never returns null. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The shader to apply. - The matrix to apply before applying the shader. - Creates a shader that first applies the specified matrix and then applies the shader. - Returns a new , or null on error. - - - - The frequency in the x-direction in the range of 0..1. - The frequency in the y-direction in the range of 0..1. - The number of octaves, usually fairly small. - The randomization seed. - Creates a new shader that draws Perlin fractal noise. - Returns a new , or an empty shader on error. This function never returns null. - - - - The frequency in the x-direction in the range of 0..1. - The frequency in the y-direction in the range of 0..1. - The number of octaves, usually fairly small. - The randomization seed. - The tile size used to modify the frequencies so that the noise will be tileable for the given size. - Creates a new shader that draws Perlin fractal noise. - Returns a new , or an empty shader on error. This function never returns null. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The frequency in the x-direction in the range of 0..1. - The frequency in the y-direction in the range of 0..1. - The number of octaves, usually fairly small. - The randomization seed. - Creates a new shader that draws Perlin turbulence noise. - Returns a new , or an empty shader on error. This function never returns null. - - - - The frequency in the x-direction in the range of 0..1. - The frequency in the y-direction in the range of 0..1. - The number of octaves, usually fairly small. - The randomization seed. - The tile size used to modify the frequencies so that the noise will be tileable for the given size. - Creates a new shader that draws Perlin turbulence noise. - Returns a new , or an empty shader on error. This function never returns null. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - The picture to use inside the shader. - The tiling mode to use when sampling the picture in the x-direction. - The tiling mode to use when sampling the picture in the y-direction. - Creates a new shader that will draw with the specified picture. - Returns a new , or an empty shader on error. This function never returns null. - - - - The picture to use inside the shader. - The tiling mode to use when sampling the picture in the x-direction. - The tiling mode to use when sampling the picture in the y-direction. - The tile rectangle in picture coordinates. - Creates a new shader that will draw with the specified picture. - Returns a new , or an empty shader on error. This function never returns null. - - - - - - The picture to use inside the shader. - The tiling mode to use when sampling the picture in the x-direction. - The tiling mode to use when sampling the picture in the y-direction. - The matrix to apply before applying the shader. - The tile rectangle in picture coordinates. - Creates a new shader that will draw with the specified picture. - Returns a new , or an empty shader on error. This function never returns null. - - - - - - The center of the circle for this gradient. - The positive radius of the circle for this gradient. - The array colors to be distributed between the center and edge of the circle. - The tiling mode. - Creates a shader that generates a radial gradient given the center and radius. - Returns a new , or an empty shader on error. This function never returns null. - - - - The center of the circle for this gradient. - The positive radius of the circle for this gradient. - The array colors to be distributed between the center and edge of the circle. - The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors. - The tiling mode. - Creates a shader that generates a radial gradient given the center and radius. - Returns a new , or an empty shader on error. This function never returns null. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The center of the circle for this gradient. - The positive radius of the circle for this gradient. - The array colors to be distributed between the center and edge of the circle. - The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors. - The tiling mode. - The matrix to apply before applying the shader. - Creates a shader that generates a radial gradient given the center and radius. - Returns a new , or an empty shader on error. This function never returns null. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The coordinates of the center of the sweep. - The array colors to be distributed around the center. - Creates a shader that generates a sweep gradient given a center. - Returns a new , or an empty shader on error. This function never returns null. - - - - The coordinates of the center of the sweep. - The array colors to be distributed around the center. - The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors. - Creates a shader that generates a sweep gradient given a center. - Returns a new , or an empty shader on error. This function never returns null. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The coordinates of the center of the sweep. - The array colors to be distributed around the center. - The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors. - The matrix to apply before applying the shader. - Creates a shader that generates a sweep gradient given a center. - Returns a new , or an empty shader on error. This function never returns null. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The coordinates of the center of the sweep. - The array colors to be distributed around the center. - The tiling mode. - The start of the angular range. - The end of the angular range. - Creates a shader that generates a sweep gradient given a center. - Returns a new , or an empty shader on error. This function never returns null. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The coordinates of the center of the sweep. - The array colors to be distributed around the center. - The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors. - The tiling mode. - The start of the angular range. - The end of the angular range. - Creates a shader that generates a sweep gradient given a center. - Returns a new , or an empty shader on error. This function never returns null. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The coordinates of the center of the sweep. - The array colors to be distributed around the center. - The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors. - The tiling mode. - The start of the angular range. - The end of the angular range. - The matrix to apply before applying the shader. - Creates a shader that generates a sweep gradient given a center. - Returns a new , or an empty shader on error. This function never returns null. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The coordinates for the starting point. - The radius at the starting point. - The coordinates for the end point. - The radius at the end point. - The array colors to be distributed between the two points. - The tiling mode. - Creates a shader that generates a conical gradient given two circles. - Returns a new , or null on error. - - - - The coordinates for the starting point. - The radius at the starting point. - The coordinates for the end point. - The radius at the end point. - The array colors to be distributed between the two points. - The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors. - The tiling mode. - Creates a shader that generates a conical gradient given two circles. - Returns a new , or null on error. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The coordinates for the starting point. - The radius at the starting point. - The coordinates for the end point. - The radius at the end point. - The array colors to be distributed between the two points. - The positions (in the range of 0..1) of each corresponding color, or null to evenly distribute the colors. - The tiling mode. - The matrix to apply before applying the shader. - Creates a shader that generates a conical gradient given two circles. - Returns a new , or an empty shader on error. This function never returns null. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Indications on how the shader should handle drawing outside the original bounds. - - - - Replicate the edge color. - - - To be added. - - - Repeat the shader's image horizontally and vertically, alternating mirror images so that adjacent images always seam. - - - Repeat the shader's image horizontally and vertically. - - - Stores an ordered pair of floating-point numbers describing the width and height of a rectangle. - - - - The offset to use as the dimensions of the new point. - Creates a new size from the offset of a point. - - - - The width. - The height. - Creates a new size with a given width and height. - - - - The first structure to add. - The second structure to add. - Adds the width and height of one structure to the width and height of another structure. - A structure that is the result of the addition operation. - - - - Represents a new instance of the class with member data left uninitialized. - - - - The to test. - Tests to see whether the specified object is a structure with the same dimensions as this structure. - This method returns true if has the same coordinates as this . - - - - The to test. - Tests to see whether the specified object is a structure with the same dimensions as this structure. - This method returns true if is a and has the same coordinates as this . - - - - Returns a hash code for this structure. - An integer value that specifies a hash value for this structure. - - - - Gets or sets the vertical component of this structure. - - - - - Gets a value that indicates whether this structure has zero width and height. - - - - - The first structure to add. - The second structure to add. - Adds the width and height of one structure to the width and height of another structure. - A structure that is the result of the addition operation. - - - - The structure on the left side of the equality operator. - The structure on the left side of the equality operator. - The structure on the right of the equality operator. - The structure on the right of the equality operator. - Tests whether two structures are equal. - This operator returns true if both structures have equal and ; otherwise, false. - - - - The structure to be converted. - Converts the specified structure to a structure. - The structure structure to which this operator converts. - - - - The structure to be converted. - Converts the specified structure to a structure. - The structure structure to which this operator converts. - - - - The structure that is to the left of the inequality operator. - The structure that is to the left of the inequality operator. - The structure that is to the right of the inequality operator. - The structure that is to the right of the inequality operator. - Tests whether two structures are different. - This operator returns true if either of the and properties of the two structures are unequal; otherwise false. - - - - The structure on the left side of the subtraction operator. - The structure on the right side of the subtraction operator. - Subtracts the width and height of one structure from the width and height of another structure. - A that is the result of the subtraction operation. - - - - The structure on the left side of the subtraction operator. - The structure on the right side of the subtraction operator. - Subtracts the width and height of one structure from the width and height of another structure. - A that is the result of the subtraction operation. - - - - Converts a structure to a structure. - Returns a structure. - - - - Converts a structure to a structure. - Returns a structure. - - - - Converts this to a human readable string. - A string that represents this . - - - - Gets or sets the horizontal component of this structure. - - - - - Stores an ordered pair of integers describing the width and height of a rectangle. - - - - The offset to use as the dimensions of the new point. - Creates a new size from the offset of a point. - - - - The width. - The height. - Creates a new size with a given width and height. - - - - The first structure to add. - The second structure to add. - Adds the width and height of one structure to the width and height of another structure. - A structure that is the result of the addition operation. - - - - Represents a new instance of the class with member data left uninitialized. - - - - The to test. - Tests to see whether the specified object is a structure with the same dimensions as this structure. - This method returns true if has the same coordinates as this . - - - - The to test. - Tests to see whether the specified object is a structure with the same dimensions as this structure. - This method returns true if is a and has the same coordinates as this . - - - - Returns a hash code for this structure. - An integer value that specifies a hash value for this structure. - - - - Gets or sets the vertical component of this structure. - - - - - Gets a value that indicates whether this structure has zero width and height. - - - - - The first structure to add. - The second structure to add. - Adds the width and height of one structure to the width and height of another structure. - A structure that is the result of the addition operation. - - - - The structure on the left side of the equality operator. - The structure on the left side of the equality operator. - The structure on the right of the equality operator. - The structure on the right of the equality operator. - Tests whether two structures are equal. - This operator returns true if both structures have equal and ; otherwise, false. - - - - The structure to be converted. - Converts the specified structure to a structure. - The structure structure to which this operator converts. - - - - The structure that is to the left of the inequality operator. - The structure that is to the left of the inequality operator. - The structure that is to the right of the inequality operator. - The structure that is to the right of the inequality operator. - Tests whether two structures are different. - This operator returns true if either of the and properties of the two structures are unequal; otherwise false. - - - - The structure on the left side of the subtraction operator. - The structure on the right side of the subtraction operator. - Subtracts the width and height of one structure from the width and height of another structure. - A that is the result of the subtraction operation. - - - - The structure on the left side of the subtraction operator. - The structure on the right side of the subtraction operator. - Subtracts the width and height of one structure from the width and height of another structure. - A that is the result of the subtraction operation. - - - - Converts a structure to a structure. - Returns a structure. - - - - Converts this to a human readable string. - A string that represents this . - - - - Gets or sets the horizontal component of this structure. - - - - - An abstraction for a source of bytes, which can be backed by memory, or a file, or something else. - - - - Returns the memory address of the data if the stream is a memory stream. - Returns the memory address of the data, or IntPtr.Zero if the stream is not a memory stream. - - - - Gets a value indicating whether this stream can report it's total length. - - - - - Gets a value indicating whether this stream can report it's current position. - - - - - Gets a value indicating whether all the bytes in the stream have been read. - - This method may return true if there was an error, and the stream cannot be read anymore. - - - Gets the total length of the stream. If this is not supported, the length will be reported as 0. - - - - - The relative offset. - Seeks to an relative offset in the stream. - Returns true if seeking is supported and the seek was successful, otherwise false. - If an attempt is made to move to a position outside the stream, the position will be set to the closest point within the stream (beginning or end). - - - The relative offset. - Seeks to an relative offset in the stream. - Returns true if seeking is supported and the seek was successful, otherwise false. - If an attempt is made to move to a position outside the stream, the position will be set to the closest point within the stream (beginning or end). - - - The buffer to read into. - The number of bytes to read. - Attempt to peek at bytes. - Returns the number of bytes actually peeked/copied. - - - - Gets the current position in the stream. If this is not supported, the position will be reported as 0. - - - - - The buffer to read into. - The number of bytes to read. - Reads a copy of the specified number of bytes into the provided buffer. - Returns the number of bytes actually read. - - - - The buffer to read into. - The number of bytes to read. - Reads a copy of the specified number of bytes into the provided buffer. - Returns the number of bytes actually read. - - - - Read a single boolean. - Returns the boolean that was read. - - - - The boolean that was read. - Read a single boolean. - Returns true if the read was successful, otherwise false. - - - - Read a single byte. - Returns the byte that was read. - - - - The byte that was read. - Read a single byte. - Returns true if the read was successful, otherwise false. - - - - Read a single 16-bit integer. - Returns the 16-bit integer that was read. - - - - The 16-bit integer that was read. - Read a single 16-bit integer. - Returns true if the read was successful, otherwise false. - - - - Read a single 32-bit integer. - Returns the 32-bit integer that was read. - - - - The 32-bit integer that was read. - Read a single 32-bit integer. - Returns true if the read was successful, otherwise false. - - - - Read a single, signed byte. - Returns the signed byte that was read. - - - - The signed byte that was read. - Read a single, signed byte. - Returns true if the read was successful, otherwise false. - - - - Read a single, unsigned 16-bit integer. - Returns the unsigned 16-bit integer that was read. - - - - The unsigned 16-bit integer that was read. - Read a single, unsigned 16-bit integer. - Returns true if the read was successful, otherwise false. - - - - Read a single, unsigned 32-bit integer. - Returns the unsigned 32-bit integer that was read. - - - - The unsigned 32-bit integer that was read. - Read a single, unsigned 32-bit integer. - Returns true if the read was successful, otherwise false. - - - - Rewinds to the beginning of the stream. - Returns true if the stream is known to be at the beginning after this call returns. - - - - The absolute position. - Seeks to an absolute position in the stream. - Returns true if seeking is supported and the seek was successful, otherwise false. - If an attempt is made to move to a position outside the stream, the position will be set to the closest point within the stream (beginning or end). - - - The number of bytes to skip. - Moves the current position on by the specified number of bytes. - Returns the actual number bytes that could be skipped. - - - - An abstract, seekable stream with a known length. - - - - An abstract, memory-based stream. - - - - An abstract, rewindable stream. - - - - An abstract, rewindable stream that supports the seek operation. - - - - Various options for . - This is the treatment that is applied to the beginning and end of each non-closed contour (e.g. lines). - - - Begin/end contours with no extension. - - - Begin/end contours with a semi-circle extension. - - - Begin/end contours with a half square extension. - - - Join style for stroking operations. - This is the treatment that is applied to corners in paths and rectangles. - - - Connect path segments with a flat bevel join. - - - Connect path segments with a sharp join. - - - Connect path segments with a round join. - - - Represents the backend/results of drawing to a canvas. - - canvas, the surface stores the recorded -commands. - -The surface always has non-zero dimensions. If there is a request for a new -surface, and either of the requested dimensions are zero, then `null` will -be returned. - -Once you create a surface with one of its -methods, you can draw into the canvas returned by the - property. Once the drawing is complete, you -can retrieve an by calling the - method. - -## Examples - -```csharp -var info = new SKImageInfo(256, 256); -using (var surface = SKSurface.Create(info)) { - SKCanvas canvas = surface.Canvas; - - canvas.Clear(SKColors.White); - - // configure our brush - var redBrush = new SKPaint { - Color = new SKColor(0xff, 0, 0), - IsStroke = true - }; - var blueBrush = new SKPaint { - Color = new SKColor(0, 0, 0xff), - IsStroke = true - }; - - for (int i = 0; i < 64; i += 8) { - var rect = new SKRect(i, i, 256 - i - 1, 256 - i - 1); - canvas.DrawRect(rect, (i % 16 == 0) ? redBrush : blueBrush); - } -} -``` - -The example above produces the following: - -![SKSurface](~/images/surface-rects.png "SKSurface") -]]> - - - - Gets the canvas for this surface which can be used for drawing into it. - - - - - To be added. - To be added. - To be added. - - - Contains the image configuration parameters. - Creates a new surface with the specified image parameters. - Returns the new surface if it could be created and the configuration is supported, otherwise . - This will create a buffer with the parameters specified in . - - - The pixmap. - Creates a new surface with the specified pixmap. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing render target. - Wraps a pre-existing 3D API render target as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - Wraps a pre-existing 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing OpenGL texture. - Wraps a pre-existing OpenGL texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The image configuration parameters. - The surface property configuration. - Creates a new surface from the specified image parameters and surface properties. - Returns the new surface if it could be created and the configuration is supported, otherwise . - This will create a buffer with the parameters specified in and the properties specified in . - - - The image configuration parameters. - The surface property configuration. - Creates a new surface from the specified image parameters and surface properties. - Returns the new surface if it could be created and the configuration is supported, otherwise . - This will create a buffer with the parameters specified in and the properties specified in . - - - The image configuration parameters. - The number of bytes per row in the pixel buffer. - Creates a new surface from the specified image parameters. - Returns the new surface if it could be created and the configuration is supported, otherwise . - This will create a buffer with the parameters specified in . - - - The image configuration parameters. - The pointer to an in memory-buffer that can hold the image as specified. - Creates a new surface with the specified image parameters using a provided buffer. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The pixmap. - The surface property configuration. - Creates a new surface with the specified pixmap and surface properties. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The pixmap. - The surface property configuration. - Creates a new surface with the specified pixmap and surface properties. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing render target. - The color type to use for the surface. - Wraps a pre-existing 3D API render target as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing render target. - The surface property configuration. - Wraps a pre-existing 3D API render target as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - The color type to use for the surface. - Wraps a pre-existing 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - The surface property configuration. - Wraps a pre-existing 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing OpenGL texture. - The surface property configuration. - Wraps a pre-existing OpenGL texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - Whether an allocation should count against a cache budget. - The image configuration parameters. - Creates a new surface whose contents will be drawn to an offscreen render target, allocated by the surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The image configuration parameters. - The number of bytes per row in the pixel buffer. - The surface property configuration. - Creates a new surface from the specified image parameters and surface properties. - Returns the new surface if it could be created and the configuration is supported, otherwise . - This will create a buffer with the parameters specified in and the properties specified in . - - - The image configuration parameters. - The pointer to an in memory-buffer that can hold the image as specified. - The surface property configuration. - Creates a new surface from the specified image parameters and surface properties. - Returns the new surface if it could be created and the configuration is supported, otherwise . - This will create a buffer with the parameters specified in and the properties specified in . - - - The image configuration parameters. - The pointer to an in memory-buffer that can hold the image as specified. - The number of bytes per row in the pixel buffer. - Creates a new surface with the specified image parameters using a provided buffer. - Returns the new surface if it could be created and the configuration is supported, otherwise . - This will create a buffer that will be backend by the in-memory buffer provided in . - - - The graphics context. - The description of the existing render target. - The origin of the texture. - The color type to use for the surface. - Wraps a pre-existing backend 3D API render target as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing render target. - The color type to use for the surface. - The surface property configuration. - Wraps a pre-existing backend 3D API render target as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - The origin of the texture. - The color type to use for the surface. - Wraps a pre-existing backend 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - The color type to use for the surface. - The surface property configuration. - Wraps a pre-existing backend 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - Whether an allocation should count against a cache budget. - The image configuration parameters. - The surface property configuration. - Creates a new surface whose contents will be drawn to an offscreen render target, allocated by the surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - Whether an allocation should count against a cache budget. - The image configuration parameters. - The number of samples. - Creates a new surface whose contents will be drawn to an offscreen render target, allocated by the surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The image configuration parameters. - The pointer to an in memory-buffer that can hold the image as specified. - The number of bytes per row in the pixel buffer. - The surface property configuration. - Creates a new surface from the specified image parameters, the provided buffer and surface properties. - Returns the new surface if it could be created and the configuration is supported, otherwise . - This will create a buffer that will be backend by the in-memory buffer provided in . - - - The image configuration parameters. - The pointer to an in memory-buffer that can hold the image as specified. - The number of bytes per row in the pixel buffer. - The surface property configuration. - Creates a new surface from the specified image parameters, the provided buffer and surface properties. - Returns the new surface if it could be created and the configuration is supported, otherwise . - This will create a buffer that will be backend by the in-memory buffer provided in . - - - The desired width for the surface. - The desired height for the surface. - The color type to use for the surface. - The transparency mode to use for the surface. - Creates a new surface with the specified image parameters. - Returns the new surface if it could be created and the configuration is supported, otherwise . - This will create a buffer that will be backend by the in-memory buffer. - - - The graphics context. - The description of the existing render target. - The origin of the texture. - The color type to use for the surface. - The colorspace to use for the surface. - Wraps a pre-existing backend 3D API render target as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing render target. - The origin of the texture. - The color type to use for the surface. - The surface property configuration. - Wraps a pre-existing backend 3D API render target as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - The origin of the texture. - The color type to use for the surface. - The surface property configuration. - Wraps a pre-existing backend 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - The origin of the texture. - The number of samples per pixel. - The color type to use for the surface. - Wraps a pre-existing backend 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - Whether an allocation should count against a cache budget. - The image configuration parameters. - The number of samples per pixel. - The origin of the texture. - Creates a new surface whose contents will be drawn to an offscreen render target, allocated by the surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - Whether an allocation should count against a cache budget. - The image configuration parameters. - The number of samples. - The surface property configuration. - Creates a new surface whose contents will be drawn to an offscreen render target, allocated by the surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - Whether an allocation should count against a cache budget. - The image configuration parameters. - The number of samples. - The surface property configuration. - Creates a new surface whose contents will be drawn to an offscreen render target, allocated by the surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The image configuration parameters. - The pointer to an in memory-buffer that can hold the image as specified. - The number of bytes per row in the pixel buffer. - The delegate to invoke when the surface is about to be disposed. - The user data to use when invoking the delegate. - Creates a new surface with the specified image parameters using a provided buffer. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The desired width for the surface. - The desired height for the surface. - The color type to use for the surface. - The transparency mode to use for the surface. - The surface property configuration. - Creates a new surface with the specified image parameters and surface properties. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing render target. - The origin of the texture. - The color type to use for the surface. - The colorspace to use for the surface. - The surface property configuration. - Wraps a pre-existing backend 3D API render target as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - The origin of the texture. - The number of samples per pixel. - The color type to use for the surface. - The colorspace to use for the surface. - Wraps a pre-existing backend 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - The origin of the texture. - The number of samples per pixel. - The color type to use for the surface. - The surface property configuration. - Wraps a pre-existing backend 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The image configuration parameters. - The pointer to an in memory-buffer that can hold the image as specified. - The number of bytes per row in the pixel buffer. - The delegate to invoke when the surface is about to be disposed. - The user data to use when invoking the delegate. - The surface property configuration. - Creates a new surface with the specified image parameters using a provided buffer. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The desired width for the surface. - The desired height for the surface. - The color type to use for the surface. - The transparency mode to use for the surface. - The pointer to an in memory-buffer that can hold the image as specified. - The number of bytes per row in the pixel buffer. - Creates a new surface with the specified image parameters using a provided buffer. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - The origin of the texture. - The number of samples per pixel. - The color type to use for the surface. - The colorspace to use for the surface. - The surface property configuration. - Wraps a pre-existing backend 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - Whether an allocation should count against a cache budget. - The image configuration parameters. - The number of samples per pixel. - The origin of the texture. - The surface property configuration. - A hint that the surface will host mip map images. - Creates a new surface whose contents will be drawn to an offscreen render target, allocated by the surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The desired width for the surface. - The desired height for the surface. - The color type to use for the surface. - The transparency mode to use for the surface. - The pointer to an in memory-buffer that can hold the image as specified. - The number of bytes per row in the pixel buffer. - The surface property configuration. - Creates a new surface with the specified image parameters using a provided buffer and surface properties. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - Wraps a pre-existing backend 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - The flag must be set on for this to succeed. The texture must remain valid for the lifetime of the surface. - - - The graphics context. - The description of the existing OpenGL texture. - Wraps a pre-existing backend OpenGL texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - The flag must be set on for this to succeed. The texture must remain valid for the lifetime of the surface. - - - The graphics context. - The description of the existing texture. - The color type to use for the surface. - Wraps a pre-existing backend 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - The surface property configuration. - Wraps a pre-existing backend 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - The flag must be set on for this to succeed. The texture must remain valid for the lifetime of the surface. - - - The graphics context. - The description of the existing OpenGL texture. - The surface property configuration. - Wraps a pre-existing backend OpenGL texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - The flag must be set on for this to succeed. The texture must remain valid for the lifetime of the surface. - - - The graphics context. - The description of the existing texture. - The origin of the texture. - The color type to use for the surface. - Wraps a pre-existing backend 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - The color type to use for the surface. - The surface property configuration. - Wraps a pre-existing backend 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - The origin of the texture. - The color type to use for the surface. - The surface property configuration. - Wraps a pre-existing backend 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - The origin of the texture. - The number of samples per pixel. - The color type to use for the surface. - Wraps a pre-existing backend 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - The origin of the texture. - The number of samples per pixel. - The color type to use for the surface. - The colorspace to use for the surface. - Wraps a pre-existing backend 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - The origin of the texture. - The number of samples per pixel. - The color type to use for the surface. - The surface property configuration. - Wraps a pre-existing backend 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The graphics context. - The description of the existing texture. - The origin of the texture. - The number of samples per pixel. - The color type to use for the surface. - The colorspace to use for the surface. - The surface property configuration. - Wraps a pre-existing backend 3D API texture as a surface. - Returns the new surface if it could be created and the configuration is supported, otherwise . - - - - The desired width for the surface. - The desired height for the surface. - Creates a new surface without any backing pixels. - Returns the new surface if it could be created, otherwise . - Drawing to the returned from has no effect. Calling on the returned returns . - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - The canvas to draw on. - The destination x-coordinate for the surface. - The destination y-coordinate for the surface. - The paint to use when drawing the surface, or . - Draws the current surface on the specified canvas. - - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Returns the pixels, if they are available. - Returns the pixels, if they are available, otherwise . - If the pixels are available, then the surface is only valid until the surface changes in any way, in which case the pixmap becomes invalid. - - - The pixmap to receive the pixel information. - Returns the pixmap of the surface. - Returns on success, or if the surface does not have access to pixel data. - - - - The image information describing the destination pixel buffer. - The pixel buffer to read the pixel data into. - The number of bytes in each row of in the destination buffer. - The source x-coordinate to start reading from. - The source y-coordinate to start reading from. - Copies the pixels from the surface into the specified buffer. - Returns if the pixels were read, or if there was an error. - This method may return if the source rectangle [, , dstInfo.Width, dstInfo.Height] does not intersect the surface, or if the color type/alpha type could not be converted to the destination types. - - - Takes a snapshot of the surface and returns it as an image. - An that contains a snapshot of the current image. - You can use this method to take an snapshot of the current state of the surface. - - - To be added. - To be added. - To be added. - To be added. - - - Gets the surface property configuration. - - - - - Gets the surface property configuration. - - - - - Describes properties and constraints of a given . - The rendering engine can parse these during drawing, and can sometimes optimize its performance (e.g. disabling an expensive feature). - - - The description of how the LCD strips are arranged for each pixel. - Creates a new instance. - - - - The properties of the surface. - Creates a new instance. - - - - The flags to use when creating the surface. - The LCD geometry of each pixel on the surface. - Creates a new instance. - - - - The flags to use when creating the surface. - The LCD geometry of each pixel on the surface. - Creates a new instance. - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - Gets or sets the flags. - - - - - Gets a value indicating whether the surface should use device independent fonts. - - - - - Gets or sets the LCD geometry of each pixel on the surface. - - - - - Describes properties and constraints of a given . - The rendering engine can parse these during drawing, and can sometimes optimize its performance (e.g. disabling an expensive feature). - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the flags. - - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the LCD geometry of each pixel on the surface. - - - - - Flags for the . - - - - Use default properties. - - - Use device independent fonts. - - - The memory address of the pixels being released. - The user data that was provided when creating the surface. - The delegate that is used when releasing the memory for a surface. - - - - A specialized which generates SVG commands from its draw calls. - The canvas may buffer some drawing calls, so the output is not guaranteed to be valid or complete until the canvas instance is deleted. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The initial SVG viewport (viewBox attribute on the root SVG element). - The writer to receive the XML data. - Creates a new instance of which writes to the specified XML writer. - Returns the new canvas. - Ownership of the XML writer is not transfered to the canvas, but it must stay valid during the lifetime of the returned canvas. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Various utility methods for when swizzling pixels. - - - - The pixel buffer to swizzle. - Swizzles the byte order of 32-bit pixels, swapping R and B. (RGBA <-> BGRA) - - - - The pixel buffer to swizzle. - The size of the pixel buffers. - Swizzles the byte order of 32-bit pixels, swapping R and B. (RGBA <-> BGRA) - - - - The pixel buffer to swizzle. - The size of the pixel buffers. - Swizzles the byte order of 32-bit pixels, swapping R and B. (RGBA <-> BGRA) - - - - The destination pixel buffer. - The source pixel buffer. - The size of the pixel buffers. - Swizzles the byte order of 32-bit pixels, swapping R and B. (RGBA <-> BGRA) - - - - The destination pixel buffer. - The source pixel buffer. - The size of the pixel buffers. - Swizzles the byte order of 32-bit pixels, swapping R and B. (RGBA <-> BGRA) - - - - Possible text alignment values. - - - - Center the text. - - - Left align the text. - - - Right align the text. - - - Represents multiple text runs of glyphs and positions. - - - - Gets the conservative blob bounding box. - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets the unique, non-zero value representing the text blob. - - - - - A builder object that is used to create a . - - - - Creates a new instance of . - - - - The font to be used for this run. - The vertical offset within the blob. - The glyphs for this run. - The horizontal positions of each glyph. - Adds a new horizontally-positioned run to the builder. - The number of positions must be the same as the number of glyphs. - - - The font to be used for this run. - The vertical offset within the blob. - The glyphs for this run. - The horizontal positions of each glyph. - Adds a new horizontally-positioned run to the builder. - The number of positions must be the same as the number of glyphs. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The font to be used for this run. - The vertical offset within the blob. - The glyphs for this run. - The horizontal positions of each glyph. - The bounding box of the run, used when computing the blob bounds to avoid re-measuring. - Adds a new horizontally-positioned run to the builder. - The number of positions must be the same as the number of glyphs. - - - The font to be used for this run. - The vertical offset within the blob. - The glyphs for this run. - The horizontal positions of each glyph. - The bounding box of the run, used when computing the blob bounds to avoid re-measuring. - Adds a new horizontally-positioned run to the builder. - The number of positions must be the same as the number of glyphs. - - - The font to be used for this run. - The vertical offset within the blob. - The glyphs for this run. - The horizontal positions of each glyph. - The chacracter information for this run. - The glyph's cluster information. - Adds a new horizontally-positioned run to the builder. - The number of positions, characters and clusters must be the same as the number of glyphs. - - - The font to be used for this run. - The vertical offset within the blob. - The glyphs for this run. - The horizontal positions of each glyph. - The UTF-8 chacracter information for this run. - The glyph's cluster information. - Adds a new horizontally-positioned run to the builder. - The number of positions, characters and clusters must be the same as the number of glyphs. - - - The font to be used for this run. - The vertical offset within the blob. - The glyphs for this run. - The horizontal positions of each glyph. - The chacracter information for this run. - The glyph's cluster information. - Adds a new horizontally-positioned run to the builder. - The number of positions, characters and clusters must be the same as the number of glyphs. - - - The font to be used for this run. - The vertical offset within the blob. - The glyphs for this run. - The horizontal positions of each glyph. - The UTF-8 chacracter information for this run. - The glyph's cluster information. - The bounding box of the run, used when computing the blob bounds to avoid re-measuring. - Adds a new horizontally-positioned run to the builder. - The number of positions, characters and clusters must be the same as the number of glyphs. - - - The font to be used for this run. - The vertical offset within the blob. - The glyphs for this run. - The horizontal positions of each glyph. - The UTF-8 chacracter information for this run. - The glyph's cluster information. - The bounding box of the run, used when computing the blob bounds to avoid re-measuring. - Adds a new horizontally-positioned run to the builder. - The number of positions, characters and clusters must be the same as the number of glyphs. - - - The font to be used for this run. - The vertical offset within the blob. - The glyphs for this run. - The horizontal positions of each glyph. - The chacracter information for this run. - The glyph's cluster information. - The bounding box of the run, used when computing the blob bounds to avoid re-measuring. - Adds a new horizontally-positioned run to the builder. - The number of positions, characters and clusters must be the same as the number of glyphs. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The font to be used for this run. - The glyphs for this run. - The positions of each glyph. - Adds a new fully-positioned run to the builder. - The number of positions must be the same as the number of glyphs. - - - The font to be used for this run. - The glyphs for this run. - The positions of each glyph. - Adds a new fully-positioned run to the builder. - The number of positions must be the same as the number of glyphs. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The font to be used for this run. - The glyphs for this run. - The positions of each glyph. - The bounding box of the run, used when computing the blob bounds to avoid re-measuring. - Adds a new fully-positioned run to the builder. - The number of positions must be the same as the number of glyphs. - - - The font to be used for this run. - The glyphs for this run. - The positions of each glyph. - The bounding box of the run, used when computing the blob bounds to avoid re-measuring. - Adds a new fully-positioned run to the builder. - The number of positions must be the same as the number of glyphs. - - - The font to be used for this run. - The glyphs for this run. - The positions of each glyph. - The chacracter information for this run. - The glyph's cluster information. - Adds a new fully-positioned run to the builder. - The number of positions, characters and clusters must be the same as the number of glyphs. - - - The font to be used for this run. - The glyphs for this run. - The positions of each glyph. - The UTF-8 chacracter information for this run. - The glyph's cluster information. - Adds a new fully-positioned run to the builder. - The number of positions, characters and clusters must be the same as the number of glyphs. - - - The font to be used for this run. - The glyphs for this run. - The positions of each glyph. - The chacracter information for this run. - The glyph's cluster information. - Adds a new fully-positioned run to the builder. - The number of positions, characters and clusters must be the same as the number of glyphs. - - - The font to be used for this run. - The glyphs for this run. - The positions of each glyph. - The UTF-8 chacracter information for this run. - The glyph's cluster information. - The bounding box of the run, used when computing the blob bounds to avoid re-measuring. - Adds a new fully-positioned run to the builder. - The number of positions, characters and clusters must be the same as the number of glyphs. - - - The font to be used for this run. - The glyphs for this run. - The positions of each glyph. - The UTF-8 chacracter information for this run. - The glyph's cluster information. - The bounding box of the run, used when computing the blob bounds to avoid re-measuring. - Adds a new fully-positioned run to the builder. - The number of positions, characters and clusters must be the same as the number of glyphs. - - - The font to be used for this run. - The glyphs for this run. - The positions of each glyph. - The chacracter information for this run. - The glyph's cluster information. - The bounding box of the run, used when computing the blob bounds to avoid re-measuring. - Adds a new fully-positioned run to the builder. - The number of positions, characters and clusters must be the same as the number of glyphs. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The font to be used for this run. - The x-position of the origin of this run. - The y-position of the origin of this run. - The glyphs for this run. - Adds a new deafult-positioned run to the builder. - - - - The font to be used for this run. - The x-position of the origin of this run. - The y-position of the origin of this run. - The glyphs for this run. - Adds a new deafult-positioned run to the builder. - - - - The font to be used for this run. - The x-position of the origin of this run. - The y-position of the origin of this run. - The glyphs for this run. - The bounding box of the run, used when computing the blob bounds to avoid re-measuring. - Adds a new deafult-positioned run to the builder. - - - - The font to be used for this run. - The x-position of the origin of this run. - The y-position of the origin of this run. - The glyphs for this run. - The bounding box of the run, used when computing the blob bounds to avoid re-measuring. - Adds a new deafult-positioned run to the builder. - - - - The font to be used for this run. - The x-position of the origin of this run. - The y-position of the origin of this run. - The glyphs for this run. - The UTF-8 chacracter information for this run. - The glyph's cluster information. - Adds a new deafult-positioned run to the builder. - The number of characters and clusters must be the same as the number of glyphs. - - - The font to be used for this run. - The x-position of the origin of this run. - The y-position of the origin of this run. - The glyphs for this run. - The UTF-8 chacracter information for this run. - The glyph's cluster information. - Adds a new deafult-positioned run to the builder. - The number of characters and clusters must be the same as the number of glyphs. - - - The font to be used for this run. - The x-position of the origin of this run. - The y-position of the origin of this run. - The glyphs for this run. - The chacracter information for this run. - The glyph's cluster information. - Adds a new deafult-positioned run to the builder. - The number of characters and clusters must be the same as the number of glyphs. - - - The font to be used for this run. - The x-position of the origin of this run. - The y-position of the origin of this run. - The glyphs for this run. - The UTF-8 chacracter information for this run. - The glyph's cluster information. - The bounding box of the run, used when computing the blob bounds to avoid re-measuring. - Adds a new deafult-positioned run to the builder. - The number of characters and clusters must be the same as the number of glyphs. - - - The font to be used for this run. - The x-position of the origin of this run. - The y-position of the origin of this run. - The glyphs for this run. - The UTF-8 chacracter information for this run. - The glyph's cluster information. - The bounding box of the run, used when computing the blob bounds to avoid re-measuring. - Adds a new deafult-positioned run to the builder. - The number of characters and clusters must be the same as the number of glyphs. - - - The font to be used for this run. - The x-position of the origin of this run. - The y-position of the origin of this run. - The glyphs for this run. - The chacracter information for this run. - The glyph's cluster information. - The bounding box of the run, used when computing the blob bounds to avoid re-measuring. - Adds a new deafult-positioned run to the builder. - The number of characters and clusters must be the same as the number of glyphs. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - Create the from all the added runs. - Returns the new if there were runs, otherwise . - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - Possible text encodings. - - - - The buffer contains glyph ids. - - - The buffer contains UTF-16 encoded characters. - - - The buffer contains UTF-32 encoded characters. - - - The buffer contains UTF-8 encoded characters. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Various flags to be used with . - - - - Premultiplies, unpremultiplies, and blends ignoring the transfer function. Pixels are treated as if they are linear, regardless of their transfer function encoding. - - - Converts to a linear space before premultiplying, unpremultiplying, or blending. - - - Represents the type of trimming to perform. - - - - Remove the path between the start and stop, preserving [0, start] and [stop, 1] - - - Trim the path around the start and stop, preserving [start, stop] - - - Represents a specific typeface and intrinsic style of a font. - - , -, -, and - -to specify how text appears when drawn (and measured). - -Typeface objects are immutable, and so they can be shared between threads. -]]> - - - - The string containing characters. - Destination for the corresponding glyph IDs for each character. - Retrieve the corresponding glyph IDs of a string of characters. - The number of number of continuous non-zero glyph IDs computed from the beginning of the character codes. - - - - The buffer of character codes. - The length of the buffer. - How the character codes are encoded. - Destination for the corresponding glyph IDs for each character. - Retrieve the corresponding glyph IDs of a buffer containing character codes, of the specified encoding. - The number of number of continuous non-zero glyph IDs computed from the beginning of the character codes. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - The string containing characters. - Returns the number of glyphs in the string. - The number of number of continuous non-zero glyph IDs computed from the beginning of string. - - - - The buffer containing character codes. - How the character are encoded. - Returns the number of glyphs in the buffer. - The number of number of continuous non-zero glyph IDs computed from the beginning of the buffer. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The buffer containing character codes. - How the character are encoded. - Returns the number of glyphs in the buffer. - The number of number of continuous non-zero glyph IDs computed from the beginning of the buffer. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The text containing characters. - How the characters are to be encoded. - Returns the number of glyphs on the string. - The number of number of continuous non-zero glyph IDs computed from the beginning of chars. - - - - The buffer of character codes. - The length of the buffer. - How the characters are encoded. - Returns the number of glyphs on the specified buffer with the specified length and encoding. - The number of number of continuous non-zero glyph IDs computed from the beginning of chars. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - Creates a new which is the default, Normal typeface. - - This will never be null. - - - Gets the default, Normal typeface. - - This will never be . - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Gets the family name for the typeface. - - The family name will always be returned encoded as UTF8, but the language of the name is whatever the host platform chooses. - - - Gets the font slant for the typeface. - - This may be one of the values in . - - - Gets the font style for the typeface. - - - - - Gets the font weight for the typeface. - - This may be one of the values in . - - - Gets the font width for the typeface. - - This may be one of the values in . - - - The input data. - The font face index. - Returns a new typeface given data. - Returns a new typeface, or if the file does not exist, or is not a valid font file. - - - - The name of the font family. May be . - Returns a new instance to a typeface that most closely matches the requested family name and style. - Returns to the closest-matching typeface. - - - - The name of the font family. May be . - The style (normal, bold, italic) of the typeface. - Returns a new instance to a typeface that most closely matches the requested family name and style. - Returns to the closest-matching typeface. - - - - The name of the font family. May be . - The style (normal, bold, italic) of the typeface. - Returns a new instance to a typeface that most closely matches the requested family name and style. - Returns to the closest-matching typeface. - - - - The name of the font family. May be . - The weight of the typeface. - The width of the typeface. - The slant of the typeface. - Return a new instance to a typeface that most closely matches the requested family name and style. - Returns to the closest-matching typeface. - - - - The name of the font family. May be . - The weight of the typeface. - The width of the typeface. - The slant of the typeface. - Return a new instance to a typeface that most closely matches the requested family name and style. - Returns to the closest-matching typeface. - - - - The path of the file. - The font face index. - Returns a new typeface given a file. - Returns a new typeface, or if the file does not exist, or is not a valid font file. - - - - The input stream. - The font face index. - Returns a new typeface given a stream. Ownership of the stream is transferred, so the caller must not reference it again. - Returns a new typeface, or if the file does not exist, or is not a valid font file. - - - - The input stream. - The font face index. - Returns a new typeface given a stream. Ownership of the stream is transferred, so the caller must not reference it again. - Returns a new typeface, or if the file does not exist, or is not a valid font file. - - - - The typeface to use for the family name. - The style (normal, bold, italic) of the type face. - Return a new reference to the typeface that most closely matches the requested typeface and specified style - Returns to the closest-matching typeface. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - The string of characters. - Retrieve the corresponding glyph IDs of a string of characters. - Returns the corresponding glyph IDs for each character. - - - - The buffer of character codes. - How the character codes are encoded. - Retrieve the corresponding glyph IDs of a buffer containing character codes, of the specified encoding. - Returns the corresponding glyph IDs for each character. - - - - The buffer of character codes. - How the character codes are encoded. - Retrieve the corresponding glyph IDs of a buffer containing character codes, of the specified encoding. - Returns the corresponding glyph IDs for each character. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The string of characters. - How the characters are to be encoded. - Retrieve the corresponding glyph IDs of a string of characters, of the specified encoding. - Returns the corresponding glyph IDs for each character. - - - - The string of characters. - Destination for the corresponding glyph IDs for each character. - Retrieve the corresponding glyph IDs of a string of characters. - The number of number of continuous non-zero glyph IDs computed from the beginning of the character codes. - - - - The buffer of character codes. - How the character codes are encoded. - Destination for the corresponding glyph IDs for each character. - Retrieve the corresponding glyph IDs of a buffer containing character codes, of the specified encoding. - The number of number of continuous non-zero glyph IDs computed from the beginning of the character codes. - - - - The buffer of character codes. - The length of the buffer. - How the character codes are encoded. - Retrieve the corresponding glyph IDs of a buffer containing character codes, of the specified encoding. - Returns the corresponding glyph IDs for each character. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The buffer of character codes. - How the character codes are encoded. - Destination for the corresponding glyph IDs for each character. - Retrieve the corresponding glyph IDs of a buffer containing character codes, of the specified encoding. - The number of number of continuous non-zero glyph IDs computed from the beginning of the character codes. - - - - The string of characters. - How the characters are to be encoded. - Destination for the corresponding glyph IDs for each character. - Retrieve the corresponding glyph IDs of a string of characters. - The number of number of continuous non-zero glyph IDs computed from the beginning of the character codes. - - - - The buffer of character codes. - The length of the buffer. - How the character codes are encoded. - Destination for the corresponding glyph IDs for each character. - Retrieve the corresponding glyph IDs of a buffer containing character codes, of the specified encoding. - The number of number of continuous non-zero glyph IDs computed from the beginning of the character codes. - - - - To be added. - To be added. - To be added. - To be added. - - - The table tag to get the data for. - Returns the contents of the table data for the specified tag. - Returns the contents, if it exists, otherwise throws. - - - - The tag to retrieve. - Returns the size of the data for the specified tag. - Returns the size of the data. - - - - Returns the list of table tags in the font. - - - - - To be added. - To be added. - To be added. - - - Gets a value indicating whether the typeface claims to be a bold typeface. - - - . -]]> - - - - Gets a value indicating whether the typeface claims to be fixed-pitch. - - - - - - - Gets a value indicating whether the typeface claims to be slanted. - - - or -. -]]> - - - - Returns a stream for the contents of the font data. - Returns a stream for the contents of the font data, or on failure. - The caller is responsible for deleting the stream. - - - The TrueTypeCollection index of this typeface within the stream, or 0 if the stream is not a collection. - Returns a stream for the contents of the font data. - Returns a stream for the contents of the font data, or on failure. - The caller is responsible for deleting the stream. - - - Gets the the typeface's intrinsic style attributes. - - - - - Gets the number of data tables in the typeface. - - - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The table tag to get the data for. - The contents of the table data for the specified tag. - Returns the contents of the table data for the specified tag. - Returns true if the content exists, otherwise false. - - - - The table tag to get the data for. - The offset of the data to fetch. - The length of data to fetch. - The contents of the table data for the specified tag. - Returns the contents of the table data for the specified tag. - Returns true if the content exists, otherwise false. - - - - The table tags. - Returns the list of table tags in the font. - Returns true if the tags could be fetched, otherwise false. - - - - Gets the units-per-em value for this typeface, or zero if there is an error. - - - - - Specifies the intrinsic style attributes of a given typeface. - - - - Bold - - - Bold and Italic, convenience definition. - - - Italic - - - Normal - - - Various mode with which to interpret triangles when invoking . - - - - The vertices are a triangle fan. - - - The vertices are a triangle list. - - - The vertices are a triangle strip. - - - Represents an immutable set of vertex data that can be used with . - - - - How to interpret the array of vertices. - The array of vertices for the mesh. - The color for each vertex, to be interpolated across the triangle. May be . - Creates a new instance, making a copy of the vertices and related data. - Returns the new instance. - - - - How to interpret the array of vertices. - The array of vertices for the mesh. - The coordinates in texture space (not UV space) for each vertex. May be . - The color for each vertex, to be interpolated across the triangle. May be . - Creates a new instance, making a copy of the vertices and related data. - Returns the new instance. - - - - How to interpret the array of vertices. - The array of vertices for the mesh. - The coordinates in texture space (not UV space) for each vertex. May be . - The color for each vertex, to be interpolated across the triangle. May be . - The array of indices to reference into the vertex (texture coordinates, colors) array. - Creates a new instance, making a copy of the vertices and related data. - Returns the new instance. - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - The various types of compression for WEBP files. - - - - Compress the file without loosing data. - - - Compress the files by reducing image quality. - - - Options to control the WEBP encoding. - - - - The compression level. - The quality of the encoding in the range 0.0 to 100.0. - Creates a new instance of . - - - - The compression level. - The quality of the encoding in the range 0.0 to 100.0. - The unpremultiplication behavior. - Creates a new instance of . - - - - Gets or sets the compression level. - - - - - Gets a new instance of with the values set to the defaults. - - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - Gets or sets the quality of the encoding. - - - If the compression is lossy, then the quality corresponds to the visual quality. Lower values are smaller, but will have reduced quality. - If the compression is lossless, then the quality corresponds effort put into compressing the file. Lower values are faster, but higher values have smaller files. - - - - Gets or sets the unpremultiplication behavior if the input is premultiplied. - - - - - An abstraction for writing a stream of bytes, which can be backed by memory, or a file, or something else. - - - - Gets the number of bytes written so far. - - - - - Flush the buffer to the underlying destination. - - - - The value to store. - Returns the number of bytes in the stream required to store the specified value. - Returns the number of bytes required. - - - - Write a newline character to the stream, if one was not already written. - Returns true if the write succeeded, otherwise false. - If the last character was a newline character, this method does nothing. - - - The data buffer to write. - The number of bytes from the buffer to write. - Write the provided data to the stream. - Returns true if the write succeeded, otherwise false. - - - - The unsigned 16-bit integer to write. - Write a single, unsigned 16-bit integer to the stream. - Returns true if the write succeeded, otherwise false. - - - - The unsigned 32-bit integer to write. - Write a single, unsigned 32-bit integer to the stream. - Returns true if the write succeeded, otherwise false. - - - - The byte to write. - Write a single byte to the stream. - Returns true if the write succeeded, otherwise false. - - - - The 64-bit integer to write. - The number of digits (length) to use when writing. - Write a single 64-bit integer to the stream as a string. - Returns true if the write succeeded, otherwise false. - - - - The boolean to write. - Write a single boolean to the stream. - Returns true if the write succeeded, otherwise false. - - - - The 32-bit integer to write. - Write a 32-bit integer to the stream as a string. - Returns true if the write succeeded, otherwise false. - - - - The unsigned, 32-bit integer to write. - The number of digits (length) to use when writing. - Write an unsigned, 32-bit integer to the stream as a hexadecimal string. - Returns true if the write succeeded, otherwise false. - - - - The unsigned 32-bit integer to write. - Write a single, unsigned 32-bit integer to the stream in the smallest space possible. - Returns true if the write succeeded, otherwise false. - - - - The floating-point number to write. - Write a single, floating-point number to the stream. - Returns true if the write succeeded, otherwise false. - - - - The floating-point number to write. - Write a single, floating-point number to the stream as text. - Returns true if the write succeeded, otherwise false. - - - - The stream to write. - The number of bytes to write. - Write the contents of the specified stream to this stream. - Returns true if the write succeeded, otherwise false. - - - - The string to write. - Write a string to the stream as a string. - Returns true if the write succeeded, otherwise false. - - - - A stream-based XML writer. - - - - The stream to write the XML to. - Creates a new instance of which writes to the provided stream. - - - - - to release both managed and unmanaged resources; to release only unmanaged resources. - Releases the unmanaged resources used by the and optionally releases the managed resources. - Always dispose the object before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer. - - - Implemented by derived types to destroy any native objects. - - - - An abstract, XML writer. - - - - Whether or not the memory passed to (or one of the overloads that accepts a ) is zero initialized - - - - The memory passed has not been initialized to zero, so the codec must write all zeros to memory. - - - The memory passed is zero initialized, so the codec may take advantage of this by skipping writing zeroes. - - - Various utility methods for when working with strings and text. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The text to encode. - The encoding to use. - Encodes the specified string using the encoding as a byte array. - Returns the encoded text as a byte array. - - - - The text to encode. - The encoding to use. - Encodes the specified string using the encoding as a byte array. - Returns the encoded text as a byte array. - - - - The bytes representing text. - The encoding to use. - Decodes the specified bytes as a string. - Returns the decoded text. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - The pointer to the bytes representing text. - The number of bytes to decode. - The encoding to use. - Decodes the specified bytes as a string. - Returns the decoded text. - - - - The bytes representing text. - The index to start decoding. - The number of bytes to decode. - The encoding to use. - Encodes the specified string using the encoding as a byte array. - Returns the decoded text. - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - The character to get the Unicode character code. - The encoding of the string. - Returns the Unicode character code for the specified character. - Returns the Unicode character code. - - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - To be added. - To be added. - To be added. - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/SocketCommDll_4CSharp.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/SocketCommDll_4CSharp.dll deleted file mode 100644 index ef8af48..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/SocketCommDll_4CSharp.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Buffers.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Buffers.dll deleted file mode 100644 index f2d83c5..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Buffers.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Buffers.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Buffers.xml deleted file mode 100644 index e243dce..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Buffers.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - System.Buffers - - - - Provides a resource pool that enables reusing instances of type . - The type of the objects that are in the resource pool. - - - Initializes a new instance of the class. - - - Creates a new instance of the class. - A new instance of the class. - - - Creates a new instance of the class using the specifed configuration. - The maximum length of an array instance that may be stored in the pool. - The maximum number of array instances that may be stored in each bucket in the pool. The pool groups arrays of similar lengths into buckets for faster access. - A new instance of the class with the specified configuration. - - - Retrieves a buffer that is at least the requested length. - The minimum length of the array. - An array of type that is at least minimumLength in length. - - - Returns an array to the pool that was previously obtained using the method on the same instance. - A buffer to return to the pool that was previously obtained using the method. - Indicates whether the contents of the buffer should be cleared before reuse. If clearArray is set to true, and if the pool will store the buffer to enable subsequent reuse, the method will clear the array of its contents so that a subsequent caller using the method will not see the content of the previous caller. If clearArray is set to false or if the pool will release the buffer, the array&#39;s contents are left unchanged. - - - Gets a shared instance. - A shared instance. - - - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Collections.Immutable.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Collections.Immutable.dll deleted file mode 100644 index ad944df..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Collections.Immutable.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Diagnostics.DiagnosticSource.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Diagnostics.DiagnosticSource.dll deleted file mode 100644 index 1786b54..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Diagnostics.DiagnosticSource.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Formats.Asn1.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Formats.Asn1.dll deleted file mode 100644 index 2873fcd..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Formats.Asn1.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Formats.Asn1.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Formats.Asn1.xml deleted file mode 100644 index f849b3d..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Formats.Asn1.xml +++ /dev/null @@ -1,2128 +0,0 @@ - - - - System.Formats.Asn1 - - - - This type represents an ASN.1 tag, as described in ITU-T Recommendation X.680. - - - Represents the universal class tag for a Boolean value. - - - Represents the universal class tag for a Bit String value under a constructed encoding. - - - Represents the universal class tag for a Octet String value under a constructed encoding. - - - Represents the universal class tag for an Enumerated value. - - - Represents the universal class tag for a GeneralizedTime value. - - - Represents the universal class tag for an Integer value. - - - Represents the universal class tag for a value. - - - Represents the universal class tag for an Object Identifier value. - - - Represents the universal class tag for a Bit String value under a primitive encoding. - - - Represents the universal class tag for an Octet String value under a primitive encoding. - - - Represents the universal class tag for a Sequence value (always a constructed encoding). - - - Represents the universal class tag for a SetOf value (always a constructed encoding). - - - Represents the universal class tag for a UtcTime value. - - - Create an for a specified value within a specified tag class. - The tag class for this tag. - The numeric value for this tag. - - for a constructed tag, for a primitive tag. - - is not a known value. - -or- - is negative. - - - Create an for a tag from the UNIVERSAL class. - One of the enumeration values that specifies the semantic type for this tag. - - for a constructed tag, for a primitive tag. - - is not a known value. - - - Produces a tag with the same and values, but whose is . - A tag with the same and values, but whose is . - - - Produces a tag with the same and values, but whose is . - A tag with the same and values, but whose is . - - - Reports the number of bytes required for the BER-encoding of this tag. - The number of bytes required for the BER-encoding of this tag. - - - Reads a BER-encoded tag which starts at . - The read only byte sequence whose beginning is a BER-encoded tag. - When this method returns, contains the number of bytes that contributed to the encoded tag. This parameter is treated as uninitialized. - The provided data does not decode to a tag. - The decoded tag. - - - Writes the BER-encoded form of this tag to . - The start of where the encoded tag should be written. - - . < . - The number of bytes written to . - - - Tests if has the same encoding as this tag. - Tag to test for equality. - - if has the same values for , , and ; otherwise. - - - Tests if is an with the same encoding as this tag. - Object to test for value equality. - - if is not an , otherwise. - - - Returns the hash code for this instance. - A 32-bit signed integer hash code. - - - Tests if has the same and values as this tag, and does not compare . - Tag to test for concept equality. - - if has the same and as this tag, otherwise. - - - Tests if two values have the same BER encoding. - The first value to compare. - The second value to compare. - - if and have the same BER encoding, otherwise. - - - Tests if two values have a different BER encoding. - The first value to compare. - The second value to compare. - - if and have a different BER encoding, otherwise. - - - Provides a text representation of this tag suitable for debugging. - A text representation of this tag suitable for debugging. - - - Attempts to read a BER-encoded tag which starts at . - The read only byte sequence whose beginning is a BER-encoded tag. - The decoded tag. - When this method returns, contains the number of bytes that contributed to the encoded tag, 0 on failure. This parameter is treated as uninitialized. - - if a tag was correctly decoded; otherwise, . - - - Attempts to write the BER-encoded form of this tag to . - The start of where the encoded tag should be written. - Receives the value from on success, 0 on failure. - - if . < (), otherwise. - - - Indicates if the tag represents a constructed encoding (), or a primitive encoding (). - - - The tag class to which this tag belongs. - - - The numeric value for this tag. - - - The exception that is thrown when an encoded ASN.1 value cannot be successfully decoded. - - - Initializes a new instance of the class, using the default message. - - - Initializes a new instance of the class with serialized data. - The object that holds the serialized object data. - The contextual information about the source or destination. - - - Initializes a new instance of the class, using the provided message. - The error message that explains the reason for the exception. - - - Initializes a new instance of the class, using the provided message and exception that is the cause of this exception. - The error message that explains the reason for the exception. - The exception that is the cause of the current exception. - - - Provides stateless methods for decoding BER-encoded, CER-encoded, and DER-encoded ASN.1 data. - - - Reads a Bit String value from with a specified tag under the specified encoding rules, returning the contents in a new array. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - On success, receives the number of bits in the last byte which were reported as "unused" by the writer. - This parameter is treated as uninitialized. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 3). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - An array containing the contents of the Bit String value. - - - Reads a Boolean value from with a specified tag under the specified encoding rules. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 1). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - The decoded value. - - - Reads the next value as character string with the specified tag and encoding type, returning the decoded string. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - One of the enumeration values which represents the value type to process. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the universal tag that is appropriate to the requested encoding type. - - is not defined. - --or- - - is not a known character string type. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - --or- - -The string did not successfully decode. - - . is , but . is not the same as . - The decoded value. - - - Locates the contents range for the encoded value at the beginning of the buffer using the specified encoding rules. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - When this method returns, the offset of the content payload relative to the start of . - This parameter is treated as uninitialized. - When this method returns, the number of bytes in the content payload (which may be 0). - This parameter is treated as uninitialized. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - - is not defined. - - does not represent a value encoded under the specified encoding rules. - The tag identifying the content. - - - Reads an Enumerated value from with a specified tag under the specified encoding rules, returning the contents as a slice of the buffer. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 10). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - The slice of the buffer containing the bytes of the Enumerated value, in signed big-endian form. - - - Reads an Enumerated from with a specified tag under the specified encoding rules, converting it to the non-[] enum specified by . - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - Type object representing the destination type. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 10). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - --or- - -The encoded value is too big to fit in a value. - - is not an enum type. - --or- - - was declared with . - --or- - -. is , but . is not correct for the method. - - is . - The Enumerated value converted to a . - - - Reads an Enumerated from with a specified tag under the specified encoding rules, converting it to the non-[] enum specified by . - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 10). - Destination enum type. - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - --or- - -The encoded value is too big to fit in a value. - - is not an enum type. - --or- - - was declared with . - --or- - -. is , but . is not correct for the method. - The Enumerated value converted to a . - - - Reads a GeneralizedTime value from with a specified tag under the specified encoding rules. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 24). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - The decoded value. - - - Reads an Integer value from with a specified tag under the specified encoding rules. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 2). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - The decoded numeric value. - - - Reads an Integer value from with a specified tag under the specified encoding rules, returning the contents as a slice of the buffer. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 2). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - The slice of the buffer containing the bytes of the Integer value, in signed big-endian form. - - - Reads a NamedBitList from with a specified tag under the specified encoding rules. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 3). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - The bits from the encoded value. - - - Reads a NamedBitList from with a specified tag under the specified encoding rules, converting it to the [] enum specified by . - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - Type object representing the destination type. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 3). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - --or- - -The encoded value is too big to fit in a value. - - is not an enum type. - --or- - - was not declared with - --or- - -. is , but . is not correct for the method. - - is - The NamedBitList value converted to a . - - - Reads a NamedBitList from with a specified tag under the specified encoding rules, converting it to the [] enum specified by . - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 3). - Destination enum type. - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - --or- - -The encoded value is too big to fit in a value. - - is not an enum type. - --or- - - was not declared with - --or- - -. is , but . is not correct for the method. - The NamedBitList value converted to a . - - - Reads a value from with a specified tag under the specified encoding rules. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 5). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - - Reads an Object Identifier value from with a specified tag under the specified encoding rules. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 6). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - The decoded object identifier, in dotted-decimal notation. - - - Reads an Octet String value from with a specified tag under the specified encoding rules, returning the contents in a new array. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 4). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - An array containing the contents of the Octet String value. - - - Reads a Sequence or Sequence-Of value from with a specified tag under the specified encoding rules. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - When this method returns, the offset of the content payload relative to the start of . - This parameter is treated as uninitialized. - When this method returns, the number of bytes in the content payload (which may be 0). - This parameter is treated as uninitialized. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 16). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - - Reads a Set-Of value from with a specified tag under the specified encoding rules. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - When this method returns, the offset of the content payload relative to the start of . - This parameter is treated as uninitialized. - When this method returns, the number of bytes in the content payload (which may be 0). - This parameter is treated as uninitialized. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - - to always accept the data in the order it is presented, to verify that the data is sorted correctly when the encoding rules say sorting was required (CER and DER). - The tag to check for before reading, or for the default tag (Universal 17). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - - Reads a UtcTime value from with a specified tag under the specified encoding rules. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The largest year to represent with this value. - The default value, 2049, represents the 1950-2049 range for X.509 certificates. - The tag to check for before reading, or for the default tag (Universal 24). - - is not defined. - --or- - - is not in the range [99, 9999]. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - The decoded value. - - - Attempts to copy a Bit String value from with a specified tag under the specified encoding rules into . - The buffer containing encoded data. - The buffer in which to write. - The encoding constraints to use when interpreting the data. - On success, receives the number of bits in the last byte which were reported as "unused" by the writer. - This parameter is treated as uninitialized. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - When this method returns, the total number of bytes written to . - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 3). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - --or- - - overlaps . - - if is large enough to receive the value of the Bit String; otherwise, . - - - Reads a character string value from with a specified tag under the specified encoding rules, copying the decoded string into a a provided destination buffer. - The buffer containing encoded data. - The buffer in which to write. - The encoding constraints to use when interpreting the data. - One of the enumeration values which represents the value type to process. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - When this method returns, the number of chars written to . - This parameter is treated as uninitialized. - The tag to check for before reading, or for the universal tag that is appropriate to the requested encoding type. - - is not defined. - --or- - - is not a known character string type. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - --or- - -The string did not successfully decode. - - . is , but . is not the same as . - - and advances the reader if had sufficient length to receive the value, otherwise and the reader does not advance. - - - Attempts to read a character string value from with a specified tag under the specified encoding rules, copying the unprocessed bytes into the provided destination buffer. - The buffer containing encoded data. - The buffer in which to write. - The encoding constraints to use when interpreting the data. - The tag to check for before reading. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - On success, receives the number of bytes written to . - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not a character string tag type. - --or- - - overlaps . - - if is large enough to receive the value of the unprocessed character string; otherwise, . - - - Attempts locate the contents range for the encoded value at the beginning of the buffer using the specified encoding rules. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - When this method returns, the tag identifying the content. - This parameter is treated as uninitialized. - When this method returns, the offset of the content payload relative to the start of . - This parameter is treated as uninitialized. - When this method returns, the number of bytes in the content payload (which may be 0). - This parameter is treated as uninitialized. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - - is not defined. - - if represents a valid structural encoding for the specified encoding rules; otherwise, . - - - Attempts to read an Integer value from with a specified tag under the specified encoding rules as a signed 32-bit value. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - On success, receives the interpreted numeric value. - This parameter is treated as uninitialized. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 2). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - if the Integer represents value is between and , inclusive; otherwise, . - - - Attempts to read an Integer value from with a specified tag under the specified encoding rules as a signed 64-bit value. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - On success, receives the interpreted numeric value. - This parameter is treated as uninitialized. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 2). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - if the Integer represents value is between and , inclusive; otherwise, . - - - Attempts to get an Octet String value from with a specified tag under the specified encoding rules, copying the value into the provided destination buffer. - The buffer containing encoded data. - The buffer in which to write. - The encoding constraints to use when interpreting the data. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - When this method returns, the total number of bytes written to . - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 4). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - --or- - - overlaps . - - if is large enough to receive the value of the Octet String; otherwise, . - - - Attempts to get a Bit String value from with a specified tag under the specified encoding rules, if the value is contained in a single (primitive) encoding. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - On success, receives the number of bits in the last byte which were reported as "unused" by the writer. - This parameter is treated as uninitialized. - On success, receives a slice of the input buffer that corresponds to the value of the Bit String. - This parameter is treated as uninitialized. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 3). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - if the Bit String value has a primitive encoding and all of the bits reported as unused are set to 0; otherwise, . - - - Attempts to get an unprocessed character string value from with a specified tag under the specified encoding rules, if the value is contained in a single (primitive) encoding. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - The tag to check for before reading. - On success, receives a slice of the input buffer that corresponds to the value of the Bit String. - This parameter is treated as uninitialized. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not a character string tag type. - - if the character string value has a primitive encoding; otherwise, . - - - Attempts to get an Octet String value from with a specified tag under the specified encoding rules, if the value is contained in a single (primitive) encoding. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - On success, receives a slice of the input buffer that corresponds to the value of the Octet String. - This parameter is treated as uninitialized. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 4). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - if the Octet String value has a primitive encoding; otherwise, . - - - Attempts to read an Integer value from with a specified tag under the specified encoding rules as an unsigned 32-bit value. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - On success, receives the interpreted numeric value. - This parameter is treated as uninitialized. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 2). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - if the Integer represents value is between and , inclusive; otherwise, . - - - Attempts to read an Integer value from with a specified tag under the specified encoding rules as an unsigned 64-bit value. - The buffer containing encoded data. - The encoding constraints to use when interpreting the data. - On success, receives the interpreted numeric value. - This parameter is treated as uninitialized. - When this method returns, the total number of bytes for the encoded value. - This parameter is treated as uninitialized. - The tag to check for before reading, or for the default tag (Universal 2). - - is not defined. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - if the Integer represents value is between and , inclusive; otherwise, . - - - The encoding ruleset for an or . - - - ITU-T X.690 Basic Encoding Rules. - - - ITU-T X.690 Canonical Encoding Rules. - - - ITU-T X.690 Distinguished Encoding Rules. - - - A stateful, forward-only reader for BER-, CER-, or DER-encoded ASN.1 data. - - - Construct an over with a given ruleset. - The data to read. - The encoding constraints for the reader. - Additional options for the reader. - - is not defined. - - - Get a view of the content octets (bytes) of the next encoded value without advancing the reader. - The reader is positioned at a point where the tag or length is invalid under the current encoding rules. - The bytes of the contents octets of the next encoded value. - - - Get a view of the next encoded value without advancing the reader. For indefinite length encodings this includes the End of Contents marker. - The reader is positioned at a point where the tag or length is invalid under the current encoding rules. - The bytes of the next encoded value. - - - Read the encoded tag at the next data position, without advancing the reader. - A tag could not be decoded at the reader's current position. - The decoded tag value. - - - Reads the next value as a BIT STRING with a specified tag, returning the value in a byte array. - On success, receives the number of bits in the last byte which were reported as "unused" by the writer. - The tag to check for before reading, or for the default tag (Universal 1). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - A copy of the value in a newly allocated, precisely sized, array. - - - Reads the next value as a Boolean with a specified tag. - The tag to check for before reading, or for the default tag (Universal 1). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - The decoded value. - - - Reads the next value as character string with the specified tag and encoding type, returning the decoded value as a string. - One of the enumeration values representing the value type to process. - The tag to check for before reading, or for the universal tag that is appropriate to the requested encoding type. - - is not a known character string type. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - --or- - -The string did not successfully decode. - - . is , but . is not the same as . - The decoded value. - - - Get a view of the next encoded value, and advance the reader past it. For an indefinite length encoding this includes the End of Contents marker. - A view of the next encoded value. - - - Reads the next value as a Enumerated with a specified tag, returning the contents as a over the original data. - The tag to check for before reading, or for the default tag (Universal 10). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - The bytes of the Enumerated value, in signed big-endian form. - - - Reads the next value as an Enumerated with a specified tag, converting it to the non-[] enum specified by . - Type object representing the destination type. - The tag to check for before reading, or for the default tag (Universal 10). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - --or- - -The encoded value is too big to fit in a value. - - is not an enum type. - --or- - - was declared with . - --or- - -. is , but . is not correct for the method. - - is . - The Enumerated value converted to a . - - - Reads the next value as an Enumerated with a specified tag, converting it to the non-[] enum specified by . - The tag to check for before reading, or for the default tag (Universal 10). - Destination enum type. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - --or- - -The encoded value is too big to fit in a value. - - is not an enum type. - --or- - - was declared with . - --or- - -. is , but . is not correct for the method. - The Enumerated value converted to a . - - - Reads the next value as a GeneralizedTime with a specified tag. - The tag to check for before reading, or for the default tag (Universal 24). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - The decoded value. - - - Reads the next value as an Integer with a specified tag. - The tag to check for before reading, or for the default tag (Universal 2). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - The decoded value. - - - Reads the next value as a Integer with a specified tag, returning the contents as a over the original data. - The tag to check for before reading, or for the default tag (Universal 2). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - The bytes of the Integer value, in signed big-endian form. - - - Reads the next value as a NamedBitList with a specified tag. - The tag to check for before reading. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - The bits from the encoded value. - - - Reads the next value as a NamedBitList with a specified tag, converting it to the [] enum specified by . - Type object representing the destination type. - The tag to check for before reading. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - --or- - -The encoded value is too big to fit in a value. - - is not an enum type. - --or- - - was not declared with - --or- - -. is , but . is not correct for the method. - - is - The NamedBitList value converted to a . - - - Reads the next value as a NamedBitList with a specified tag, converting it to the [] enum specified by . - The tag to check for before reading. - Destination enum type. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - --or- - -The encoded value is too big to fit in a value. - - is not an enum type. - --or- - - was not declared with - --or- - -. is , but . is not correct for the method. - The NamedBitList value converted to a . - - - Reads the next value as a NULL with a specified tag. - The tag to check for before reading, or for the default tag (Universal 5). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - - Reads the next value as an OBJECT IDENTIFIER with a specified tag, returning the value in a dotted decimal format string. - The tag to check for before reading, or for the default tag (Universal 6). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - The object identifier value in a dotted decimal format string. - - - Reads the next value as an OCTET STRING with tag UNIVERSAL 4, returning the value in a byte array. - The tag to check for before reading, or for the default tag (Universal 4). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - A copy of the value in a newly allocated, precisely sized, array. - - - Reads the next value as a SEQUENCE or SEQUENCE-OF with the specified tag and returns the result as a new reader positioned at the first value in the sequence (or with == ). - The tag to check for before reading, or for the default tag (Universal 16). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - A new reader positioned at the first value in the sequence (or with == ). - - - Reads the next value as a SET-OF with the specified tag and returns the result as a new reader positioned at the first value in the set-of (or with == ). - - to always accept the data in the order it is presented, to verify that the data is sorted correctly when the encoding rules say sorting was required (CER and DER). - The tag to check for before reading, or for the default tag (Universal 17). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - A new reader positioned at the first value in the set-of (or with == ). - - - Reads the next value as a SET-OF with the specified tag and returns the result as a new reader positioned at the first value in the set-of (or with == ), using the value from the constructor (default ). - The tag to check for before reading, or for the default tag (Universal 17). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - A new reader positioned at the first value in the set-of (or with == ). - - - Reads the next value as a UTCTime with a specified tag. - The largest year to represent with this value. - The tag to check for before reading, or for the default tag (Universal 23). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - The decoded value. - - - Reads the next value as a UTCTime with a specified tag using the value from options passed to the constructor (with a default of 2049). - The tag to check for before reading, or for the default tag (Universal 23). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - The decoded value. - - - Throws a standardized if the reader has remaining data, performs no function if returns . - - - Reads the next value as a BIT STRING with a specified tag, copying the value into a provided destination buffer. - The buffer in which to write. - On success, receives the number of bits in the last byte which were reported as "unused" by the writer. - On success, receives the number of bytes written to . - The tag to check for before reading, or for the default tag (Universal 1). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - and advances the reader if had sufficient length to receive the value, otherwise and the reader does not advance. - - - Reads the next value as character string with the specified tag and encoding type, copying the decoded value into a provided destination buffer. - The buffer in which to write. - One of the enumeration values representing the value type to process. - On success, receives the number of chars written to . - The tag to check for before reading, or for the universal tag that is appropriate to the requested encoding type. - - is not a known character string type. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - --or- - -The string did not successfully decode. - - . is , but . is not the same as . - - and advances the reader if had sufficient length to receive the value, otherwise and the reader does not advance. - - - Reads the next value as character string with the specified tag, copying the unprocessed bytes into a provided destination buffer. - The buffer in which to write. - The tag to check for before reading. - On success, receives the number of bytes written to . - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not a character string tag type. - - and advances the reader if had sufficient length to receive the value, otherwise and the reader does not advance. - - - Attempts to read the next value as an Integer with a specified tag, as a signed 32-bit value. - On success, receives the decoded value. - The tag to check for before reading, or for the default tag (Universal 2). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - and does not advance the reader if the value is not between and , inclusive; otherwise is returned and the reader advances. - - - Attempts to read the next value as an Integer with a specified tag, as a signed 64-bit value. - On success, receives the decoded value. - The tag to check for before reading, or for the default tag (Universal 2). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - and does not advance the reader if the value is not between and , inclusive; otherwise is returned and the reader advances. - - - Reads the next value as an OCTET STRING with a specified tag, copying the value into a provided destination buffer. - The buffer in which to write. - On success, receives the number of bytes written to . - The tag to check for before reading, or for the default tag (Universal 4). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - and advances the reader if had sufficient length to receive the value, otherwise and the reader does not advance. - - - Reads the next value as a BIT STRING with a specified tag, returning the contents as a over the original data. - On success, receives the number of bits in the last byte which were reported as "unused" by the writer. - On success, receives a over the original data corresponding to the value of the BIT STRING. - The tag to check for before reading, or for the default tag (Universal 1). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - and advances the reader if the BIT STRING value had a primitive encoding, and does not advance the reader if it had a constructed encoding. - - - Reads the next value as a character with a specified tag, returning the contents as an unprocessed over the original data. - The tag to check for before reading. - On success, receives a over the original data corresponding to the value of the character string. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not a character string tag type. - - and advances the reader if the character string value had a primitive encoding, and does not advance the reader if it had a constructed encoding. - - - Attempts to read the next value as an OCTET STRING with a specified tag, returning the contents as a over the original data. - On success, receives a over the original data corresponding to the value of the OCTET STRING. - The tag to check for before reading. - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - and advances the reader if the OCTET STRING value had a primitive encoding, and does not advance the reader if it had a constructed encoding. - - - Attempts to read the next value as an Integer with a specified tag, as an unsigned 32-bit value. - On success, receives the decoded value. - The tag to check for before reading, or for the default tag (Universal 2). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - and does not advance the reader if the value is not between and , inclusive; otherwise is returned and the reader advances. - - - Attempts to read the next value as an Integer with a specified tag, as an unsigned 64-bit value. - On success, receives the decoded value. - The tag to check for before reading, or for the default tag (Universal 2). - The next value does not have the correct tag. - --or- - -The length encoding is not valid under the current encoding rules. - --or- - -The contents are not valid under the current encoding rules. - - . is , but . is not correct for the method. - - and does not advance the reader if the value is not between and , inclusive; otherwise is returned and the reader advances. - - - Gets an indication of whether the reader has remaining data available to process. - - if there is more data available for the reader to process; otherwise, . - - - Gets the encoding rules in use by this reader. - The encoding rules in use by this reader. - - - Specifies options that modify the behavior of an . - - - Gets or sets a value that indicates whether the reader should bypass sort ordering on a Set or Set-Of value. - - if the reader should not validate that a Set or Set-Of value is sorted correctly for the current encoding rules; otherwise . - The default is . - - - Gets or sets the largest year to represent with a UtcTime value. - The largest year to represent with a UtcTime value. The default is 2049. - - - A writer for BER-, CER-, and DER-encoded ASN.1 data. - - - Create a new with a given set of encoding rules. - The encoding constraints for the writer. - - is not defined. - - - Copy the value of this writer into another. - The writer to receive the value. - - is . - A or has not been closed via or . - -or- - This writer is empty. - -or- - This writer represents more than one top-level value. - -or- - This writer's value is encoded in a manner that is not compatible with the ruleset for the destination writer. - - - Return a new array containing the encoded value. - A or has not been closed via or . - A precisely-sized array containing the encoded value. - - - Writes the encoded representation of the data to . - The buffer in which to write. - A or has not been closed via or . - The number of bytes written to . - - - Determines if would produce an output identical to . - The instance to compare encoded values against. - - is . - A or has not been closed via or . - - if the pending encoded data is identical to , otherwise. - - - Determines if would produce an output identical to . - The encoded value to compare against. - A or has not been closed via or . - - if the pending encoded data is identical to , otherwise. - - - Gets the number of bytes that would be written by . - - , , or was called without the corresponding Pop method. - The number of bytes that would be written by . - - - Indicate that the open Octet String with the tag UNIVERSAL 4 is closed, returning the writer to the parent context. - The tag to write, or for the default tag (Universal 4). - - . is , but . is not correct for the method. - the writer is not currently positioned within an Octet String with the specified tag. - - - Indicate that the open Sequence with the specified tag is closed, returning the writer to the parent context. - The tag to write, or for the default tag (Universal 16). - - . is , but . is not correct for the method. - the writer is not currently positioned within a Sequence with the specified tag. - - - Indicate that the open Set-Of with the specified tag is closed, returning the writer to the parent context. - The tag to write, or for the default tag (Universal 17). - - . is , but . is not correct for the method. - the writer is not currently positioned within a Set-Of with the specified tag. - - - Begin writing an Octet String value with a specified tag. - The tag to write, or for the default tag (Universal 4). - A disposable value which will automatically call . - - - Begin writing a Sequence with a specified tag. - The tag to write, or for the default tag (Universal 16). - - . is , but . is not correct for the method. - A disposable value which will automatically call . - - - Begin writing a Set-Of with a specified tag. - The tag to write, or for the default tag (Universal 17). - - . is , but . is not correct for the method. - A disposable value which will automatically call . - - - Reset the writer to have no data, without releasing resources. - - - Attempts to write the encoded representation of the data to . - The buffer in which to write. - On success, receives the number of bytes written to . - A or has not been closed via or . - - if the encode succeeded, if is too small. - - - Write a Bit String value with a specified tag. - The value to write. - The number of trailing bits which are not semantic. - The tag to write, or for the default tag (Universal 3). - - . is , but . is not correct for the method. - -or- - has length 0 and is not 0 - -or- - is not empty and any of the bits identified by is set. - - is not in the range [0,7]. - - - Write a Boolean value with a specified tag. - The value to write. - The tag to write, or for the default tag (Universal 1). - - . is , but . is not correct for the method - - - Write the provided string using the specified encoding type using the specified tag corresponding to the encoding type. - One of the enumeration values representing the encoding to use. - The string to write. - The tag to write, or for the universal tag that is appropriate to the requested encoding type. - - is not a restricted character string encoding type. - -or- - is a restricted character string encoding type that is not currently supported by this method. - - . is , but . is not correct for the method. - - - Write the provided string using the specified encoding type using the specified tag corresponding to the encoding type. - One of the enumeration values representing the encoding to use. - The string to write. - The tag to write, or for the universal tag that is appropriate to the requested encoding type. - - is - - is not a restricted character string encoding type. - -or- - is a restricted character string encoding type that is not currently supported by this method. - - . is , but . is not correct for the method. - - - Write a single value which has already been encoded. - The value to write. - - could not be read under the current encoding rules. - -or- - has data beyond the end of the first value. - - - Write a non-[] enum value as an Enumerated with tag UNIVERSAL 10. - The boxed enumeration value to write. - The tag to write, or for the default tag (Universal 10). - - is . - - . is , but . is not correct for the method. - -or- - is not a boxed enum value. - -or- - the unboxed type of is declared []. - - - Write a non-[] enum value as an Enumerated with tag UNIVERSAL 10. - The boxed enumeration value to write. - The tag to write, or for the default tag (Universal 10). - The non-[] enumeration type to write. - - is . - - . is , but . is not correct for the method. - -or- - is not an enum. - -or- - is declared []. - - - Write the provided as a GeneralizedTime with a specified UNIVERSAL 24, optionally excluding the fractional seconds. - The value to write. - - to treat the fractional seconds in as 0 even if a non-zero value is present. - The tag to write, or for the default tag (Universal 24). - - . is , but . is not correct for the method. - - - Write an Integer value with a specified tag. - The value to write. - The tag to write, or for the default tag (Universal 2). - - . is , but . is not correct for the method. - - - Write an Integer value with a specified tag. - The value to write. - The tag to write, or for the default tag (Universal 2). - - . is , but . is not correct for the method. - - - Write an Integer value with a specified tag. - The integer value to write, in signed big-endian byte order. - The tag to write, or for the default tag (Universal 2). - - . is , but . is not correct for the method. - the 9 most significant bits are all set. - -or- - the 9 most significant bits are all unset. - - - Write an Integer value with a specified tag. - The value to write. - The tag to write, or for the default tag (Universal 2). - - . is , but . is not correct for the method. - - - Write an Integer value with a specified tag. - The integer value to write, in unsigned big-endian byte order. - The tag to write, or for the default tag (Universal 2). - - . is , but . is not correct for the method. - the 9 most significant bits are all unset. - - - Write a bit array value as a NamedBitList with a specified tag. - The bits to write. - The tag to write, or for the default tag (Universal 3). - - . is , but . is not correct for the method. - - is . - - - Write a [] enum value as a NamedBitList with a specified tag. - The boxed enumeration value to write. - The tag to write, or for the default tag (Universal 3). - - . is , but . is not correct for the method. - -or- - is not a boxed enum value. - -or- - the unboxed type of is not declared []. - - is . - - - Write a [] enum value as a NamedBitList with a specified tag. - The enumeration value to write. - The tag to write, or for the default tag (Universal 3). - The [] enumeration type to write. - - . is , but . is not correct for the method. - -or- - is not an enum value. - -or- - is not declared []. - - - Write NULL with a specified tag. - The tag to write, or for the default tag (Universal 5). - - . is , but . is not correct for the method. - - - Write an Object Identifier with a specified tag. - The object identifier to write. - The tag to write, or for the default tag (Universal 6). - - . is , but . is not correct for the method. - -or- - is not a valid dotted decimal object identifier. - - - Write an Object Identifier with a specified tag. - The object identifier to write. - The tag to write, or for the default tag (Universal 6). - - . is , but . is not correct for the method. - -or- - is not a valid dotted decimal object identifier. - - is . - - - Write an Octet String value with a specified tag. - The value to write. - The tag to write, or for the default tag (Universal 4). - - . is , but . is not correct for the method. - - - Write the provided value as a UTCTime with a specified tag, provided the year is in the allowed range. - The value to write. - The maximum valid year for , after conversion to UTC. - For the X.509 Time.utcTime range of 1950-2049, pass 2049. - The tag to write, or for the default tag (Universal 23). - - . is , but . is not correct for the method. - - . (after conversion to UTC) is not in the range ( - 100, ]. - - - Write the provided value as a UTCTime with a specified tag, accepting the two-digit year as valid in context. - The value to write. - The tag to write, or for the default tag (Universal 23). - - . is , but . is not correct for the method. - - - Gets the encoding rules in use by this writer. - The encoding rules in use by this writer. - - - Provides an target for safely closing an opened tag by using a lexical scope as a logical scope. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - The tag class for a particular ASN.1 tag. - - - The Application tag class. - - - The Context-Specific tag class. - - - The Private tag class. - - - The Universal tag class. - - - Tag assignments for the UNIVERSAL class in ITU-T X.680. - - - The universal class tag value for Bit String. - - - The universal class tag value for BMPString. - - - The universal class tag value for Boolean. - - - The universal class tag value for Date. - - - The universal class tag value for Date-Time. - - - The universal class tag value for Duration. - - - The universal class tag value for Embedded-PDV. - - - The reserved identifier for the End-of-Contents marker in an indefinite length encoding. - - - The universal class tag value for Enumerated. - - - The universal class tag value for External. - - - The universal class tag value for GeneralizedTime. - - - The universal class tag value for GeneralString. - - - The universal class tag value for GraphicString. - - - The universal class tag value for IA5String. - - - The universal class tag value for Instance-Of. - - - The universal class tag value for Integer. - - - The universal class tag value for ISO646String (VisibleString). - - - The universal class tag value for Null. - - - The universal class tag value for NumericString. - - - The universal class tag value for Object Descriptor. - - - The universal class tag value for Object Identifier. - - - The universal class tag value for Object Identifier Internationalized Resource Identifier (IRI). - - - The universal class tag value for Octet String. - - - The universal class tag value for PrintableString. - - - The universal class tag value for Real. - - - The universal class tag value for Relative Object Identifier. - - - The universal class tag value for Relative Object Identifier Internationalized Resource Identifier (IRI). - - - The universal class tag value for Sequence. - - - The universal class tag value for Sequence-Of. - - - The universal class tag value for Set. - - - The universal class tag value for Set-Of. - - - The universal class tag value for T61String (TeletexString). - - - The universal class tag value for TeletexString (T61String). - - - The universal class tag value for Time. - - - The universal class tag value for Time-Of-Day. - - - The universal class tag value for UniversalString. - - - The universal class tag value for an unrestricted character string. - - - The universal class tag value for UTCTime. - - - The universal class tag value for UTF8String. - - - The universal class tag value for VideotexString. - - - The universal class tag value for VisibleString (ISO646String). - - - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Memory.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Memory.dll deleted file mode 100644 index 4617199..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Memory.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Numerics.Vectors.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Numerics.Vectors.dll deleted file mode 100644 index 0865972..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Numerics.Vectors.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Numerics.Vectors.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Numerics.Vectors.xml deleted file mode 100644 index da34d39..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Numerics.Vectors.xml +++ /dev/null @@ -1,2621 +0,0 @@ - - - System.Numerics.Vectors - - - - Represents a 3x2 matrix. - - - Creates a 3x2 matrix from the specified components. - The value to assign to the first element in the first row. - The value to assign to the second element in the first row. - The value to assign to the first element in the second row. - The value to assign to the second element in the second row. - The value to assign to the first element in the third row. - The value to assign to the second element in the third row. - - - Adds each element in one matrix with its corresponding element in a second matrix. - The first matrix. - The second matrix. - The matrix that contains the summed values of value1 and value2. - - - Creates a rotation matrix using the given rotation in radians. - The amount of rotation, in radians. - The rotation matrix. - - - Creates a rotation matrix using the specified rotation in radians and a center point. - The amount of rotation, in radians. - The center point. - The rotation matrix. - - - Creates a scaling matrix from the specified X and Y components. - The value to scale by on the X axis. - The value to scale by on the Y axis. - The scaling matrix. - - - Creates a scaling matrix that scales uniformly with the specified scale with an offset from the specified center. - The uniform scale to use. - The center offset. - The scaling matrix. - - - Creates a scaling matrix that is offset by a given center point. - The value to scale by on the X axis. - The value to scale by on the Y axis. - The center point. - The scaling matrix. - - - Creates a scaling matrix that scales uniformly with the given scale. - The uniform scale to use. - The scaling matrix. - - - Creates a scaling matrix from the specified vector scale. - The scale to use. - The scaling matrix. - - - Creates a scaling matrix from the specified vector scale with an offset from the specified center point. - The scale to use. - The center offset. - The scaling matrix. - - - Creates a skew matrix from the specified angles in radians. - The X angle, in radians. - The Y angle, in radians. - The skew matrix. - - - Creates a skew matrix from the specified angles in radians and a center point. - The X angle, in radians. - The Y angle, in radians. - The center point. - The skew matrix. - - - Creates a translation matrix from the specified 2-dimensional vector. - The translation position. - The translation matrix. - - - Creates a translation matrix from the specified X and Y components. - The X position. - The Y position. - The translation matrix. - - - Returns a value that indicates whether this instance and another 3x2 matrix are equal. - The other matrix. - true if the two matrices are equal; otherwise, false. - - - Returns a value that indicates whether this instance and a specified object are equal. - The object to compare with the current instance. - true if the current instance and obj are equal; otherwise, false. If obj is null, the method returns false. - - - Calculates the determinant for this matrix. - The determinant. - - - Returns the hash code for this instance. - The hash code. - - - Gets the multiplicative identity matrix. - The multiplicative identify matrix. - - - Inverts the specified matrix. The return value indicates whether the operation succeeded. - The matrix to invert. - When this method returns, contains the inverted matrix if the operation succeeded. - true if matrix was converted successfully; otherwise, false. - - - Indicates whether the current matrix is the identity matrix. - true if the current matrix is the identity matrix; otherwise, false. - - - Performs a linear interpolation from one matrix to a second matrix based on a value that specifies the weighting of the second matrix. - The first matrix. - The second matrix. - The relative weighting of matrix2. - The interpolated matrix. - - - The first element of the first row. - - - - The second element of the first row. - - - - The first element of the second row. - - - - The second element of the second row. - - - - The first element of the third row. - - - - The second element of the third row. - - - - Returns the matrix that results from multiplying two matrices together. - The first matrix. - The second matrix. - The product matrix. - - - Returns the matrix that results from scaling all the elements of a specified matrix by a scalar factor. - The matrix to scale. - The scaling value to use. - The scaled matrix. - - - Negates the specified matrix by multiplying all its values by -1. - The matrix to negate. - The negated matrix. - - - Adds each element in one matrix with its corresponding element in a second matrix. - The first matrix. - The second matrix. - The matrix that contains the summed values. - - - Returns a value that indicates whether the specified matrices are equal. - The first matrix to compare. - The second matrix to compare. - true if value1 and value2 are equal; otherwise, false. - - - Returns a value that indicates whether the specified matrices are not equal. - The first matrix to compare. - The second matrix to compare. - true if value1 and value2 are not equal; otherwise, false. - - - Returns the matrix that results from multiplying two matrices together. - The first matrix. - The second matrix. - The product matrix. - - - Returns the matrix that results from scaling all the elements of a specified matrix by a scalar factor. - The matrix to scale. - The scaling value to use. - The scaled matrix. - - - Subtracts each element in a second matrix from its corresponding element in a first matrix. - The first matrix. - The second matrix. - The matrix containing the values that result from subtracting each element in value2 from its corresponding element in value1. - - - Negates the specified matrix by multiplying all its values by -1. - The matrix to negate. - The negated matrix. - - - Subtracts each element in a second matrix from its corresponding element in a first matrix. - The first matrix. - The second matrix. - The matrix containing the values that result from subtracting each element in value2 from its corresponding element in value1. - - - Returns a string that represents this matrix. - The string representation of this matrix. - - - Gets or sets the translation component of this matrix. - The translation component of the current instance. - - - Represents a 4x4 matrix. - - - Creates a object from a specified object. - A 3x2 matrix. - - - Creates a 4x4 matrix from the specified components. - The value to assign to the first element in the first row. - The value to assign to the second element in the first row. - The value to assign to the third element in the first row. - The value to assign to the fourth element in the first row. - The value to assign to the first element in the second row. - The value to assign to the second element in the second row. - The value to assign to the third element in the second row. - The value to assign to the third element in the second row. - The value to assign to the first element in the third row. - The value to assign to the second element in the third row. - The value to assign to the third element in the third row. - The value to assign to the fourth element in the third row. - The value to assign to the first element in the fourth row. - The value to assign to the second element in the fourth row. - The value to assign to the third element in the fourth row. - The value to assign to the fourth element in the fourth row. - - - Adds each element in one matrix with its corresponding element in a second matrix. - The first matrix. - The second matrix. - The matrix that contains the summed values of value1 and value2. - - - Creates a spherical billboard that rotates around a specified object position. - The position of the object that the billboard will rotate around. - The position of the camera. - The up vector of the camera. - The forward vector of the camera. - The created billboard. - - - Creates a cylindrical billboard that rotates around a specified axis. - The position of the object that the billboard will rotate around. - The position of the camera. - The axis to rotate the billboard around. - The forward vector of the camera. - The forward vector of the object. - The billboard matrix. - - - Creates a matrix that rotates around an arbitrary vector. - The axis to rotate around. - The angle to rotate around axis, in radians. - The rotation matrix. - - - Creates a rotation matrix from the specified Quaternion rotation value. - The source Quaternion. - The rotation matrix. - - - Creates a rotation matrix from the specified yaw, pitch, and roll. - The angle of rotation, in radians, around the Y axis. - The angle of rotation, in radians, around the X axis. - The angle of rotation, in radians, around the Z axis. - The rotation matrix. - - - Creates a view matrix. - The position of the camera. - The target towards which the camera is pointing. - The direction that is &quot;up&quot; from the camera&#39;s point of view. - The view matrix. - - - Creates an orthographic perspective matrix from the given view volume dimensions. - The width of the view volume. - The height of the view volume. - The minimum Z-value of the view volume. - The maximum Z-value of the view volume. - The orthographic projection matrix. - - - Creates a customized orthographic projection matrix. - The minimum X-value of the view volume. - The maximum X-value of the view volume. - The minimum Y-value of the view volume. - The maximum Y-value of the view volume. - The minimum Z-value of the view volume. - The maximum Z-value of the view volume. - The orthographic projection matrix. - - - Creates a perspective projection matrix from the given view volume dimensions. - The width of the view volume at the near view plane. - The height of the view volume at the near view plane. - The distance to the near view plane. - The distance to the far view plane. - The perspective projection matrix. - nearPlaneDistance is less than or equal to zero. - -or- - farPlaneDistance is less than or equal to zero. - -or- - nearPlaneDistance is greater than or equal to farPlaneDistance. - - - Creates a perspective projection matrix based on a field of view, aspect ratio, and near and far view plane distances. - The field of view in the y direction, in radians. - The aspect ratio, defined as view space width divided by height. - The distance to the near view plane. - The distance to the far view plane. - The perspective projection matrix. - fieldOfView is less than or equal to zero. - -or- - fieldOfView is greater than or equal to . - nearPlaneDistance is less than or equal to zero. - -or- - farPlaneDistance is less than or equal to zero. - -or- - nearPlaneDistance is greater than or equal to farPlaneDistance. - - - Creates a customized perspective projection matrix. - The minimum x-value of the view volume at the near view plane. - The maximum x-value of the view volume at the near view plane. - The minimum y-value of the view volume at the near view plane. - The maximum y-value of the view volume at the near view plane. - The distance to the near view plane. - The distance to the far view plane. - The perspective projection matrix. - nearPlaneDistance is less than or equal to zero. - -or- - farPlaneDistance is less than or equal to zero. - -or- - nearPlaneDistance is greater than or equal to farPlaneDistance. - - - Creates a matrix that reflects the coordinate system about a specified plane. - The plane about which to create a reflection. - A new matrix expressing the reflection. - - - Creates a matrix for rotating points around the X axis. - The amount, in radians, by which to rotate around the X axis. - The rotation matrix. - - - Creates a matrix for rotating points around the X axis from a center point. - The amount, in radians, by which to rotate around the X axis. - The center point. - The rotation matrix. - - - The amount, in radians, by which to rotate around the Y axis from a center point. - The amount, in radians, by which to rotate around the Y-axis. - The center point. - The rotation matrix. - - - Creates a matrix for rotating points around the Y axis. - The amount, in radians, by which to rotate around the Y-axis. - The rotation matrix. - - - Creates a matrix for rotating points around the Z axis. - The amount, in radians, by which to rotate around the Z-axis. - The rotation matrix. - - - Creates a matrix for rotating points around the Z axis from a center point. - The amount, in radians, by which to rotate around the Z-axis. - The center point. - The rotation matrix. - - - Creates a scaling matrix from the specified vector scale. - The scale to use. - The scaling matrix. - - - Creates a uniform scaling matrix that scale equally on each axis. - The uniform scaling factor. - The scaling matrix. - - - Creates a scaling matrix with a center point. - The vector that contains the amount to scale on each axis. - The center point. - The scaling matrix. - - - Creates a uniform scaling matrix that scales equally on each axis with a center point. - The uniform scaling factor. - The center point. - The scaling matrix. - - - Creates a scaling matrix from the specified X, Y, and Z components. - The value to scale by on the X axis. - The value to scale by on the Y axis. - The value to scale by on the Z axis. - The scaling matrix. - - - Creates a scaling matrix that is offset by a given center point. - The value to scale by on the X axis. - The value to scale by on the Y axis. - The value to scale by on the Z axis. - The center point. - The scaling matrix. - - - Creates a matrix that flattens geometry into a specified plane as if casting a shadow from a specified light source. - The direction from which the light that will cast the shadow is coming. - The plane onto which the new matrix should flatten geometry so as to cast a shadow. - A new matrix that can be used to flatten geometry onto the specified plane from the specified direction. - - - Creates a translation matrix from the specified 3-dimensional vector. - The amount to translate in each axis. - The translation matrix. - - - Creates a translation matrix from the specified X, Y, and Z components. - The amount to translate on the X axis. - The amount to translate on the Y axis. - The amount to translate on the Z axis. - The translation matrix. - - - Creates a world matrix with the specified parameters. - The position of the object. - The forward direction of the object. - The upward direction of the object. Its value is usually [0, 1, 0]. - The world matrix. - - - Attempts to extract the scale, translation, and rotation components from the given scale, rotation, or translation matrix. The return value indicates whether the operation succeeded. - The source matrix. - When this method returns, contains the scaling component of the transformation matrix if the operation succeeded. - When this method returns, contains the rotation component of the transformation matrix if the operation succeeded. - When the method returns, contains the translation component of the transformation matrix if the operation succeeded. - true if matrix was decomposed successfully; otherwise, false. - - - Returns a value that indicates whether this instance and another 4x4 matrix are equal. - The other matrix. - true if the two matrices are equal; otherwise, false. - - - Returns a value that indicates whether this instance and a specified object are equal. - The object to compare with the current instance. - true if the current instance and obj are equal; otherwise, false. If obj is null, the method returns false. - - - Calculates the determinant of the current 4x4 matrix. - The determinant. - - - Returns the hash code for this instance. - The hash code. - - - Gets the multiplicative identity matrix. - Gets the multiplicative identity matrix. - - - Inverts the specified matrix. The return value indicates whether the operation succeeded. - The matrix to invert. - When this method returns, contains the inverted matrix if the operation succeeded. - true if matrix was converted successfully; otherwise, false. - - - Indicates whether the current matrix is the identity matrix. - true if the current matrix is the identity matrix; otherwise, false. - - - Performs a linear interpolation from one matrix to a second matrix based on a value that specifies the weighting of the second matrix. - The first matrix. - The second matrix. - The relative weighting of matrix2. - The interpolated matrix. - - - The first element of the first row. - - - - The second element of the first row. - - - - The third element of the first row. - - - - The fourth element of the first row. - - - - The first element of the second row. - - - - The second element of the second row. - - - - The third element of the second row. - - - - The fourth element of the second row. - - - - The first element of the third row. - - - - The second element of the third row. - - - - The third element of the third row. - - - - The fourth element of the third row. - - - - The first element of the fourth row. - - - - The second element of the fourth row. - - - - The third element of the fourth row. - - - - The fourth element of the fourth row. - - - - Returns the matrix that results from multiplying two matrices together. - The first matrix. - The second matrix. - The product matrix. - - - Returns the matrix that results from scaling all the elements of a specified matrix by a scalar factor. - The matrix to scale. - The scaling value to use. - The scaled matrix. - - - Negates the specified matrix by multiplying all its values by -1. - The matrix to negate. - The negated matrix. - - - Adds each element in one matrix with its corresponding element in a second matrix. - The first matrix. - The second matrix. - The matrix that contains the summed values. - - - Returns a value that indicates whether the specified matrices are equal. - The first matrix to compare. - The second matrix to care - true if value1 and value2 are equal; otherwise, false. - - - Returns a value that indicates whether the specified matrices are not equal. - The first matrix to compare. - The second matrix to compare. - true if value1 and value2 are not equal; otherwise, false. - - - Returns the matrix that results from scaling all the elements of a specified matrix by a scalar factor. - The matrix to scale. - The scaling value to use. - The scaled matrix. - - - Returns the matrix that results from multiplying two matrices together. - The first matrix. - The second matrix. - The product matrix. - - - Subtracts each element in a second matrix from its corresponding element in a first matrix. - The first matrix. - The second matrix. - The matrix containing the values that result from subtracting each element in value2 from its corresponding element in value1. - - - Negates the specified matrix by multiplying all its values by -1. - The matrix to negate. - The negated matrix. - - - Subtracts each element in a second matrix from its corresponding element in a first matrix. - The first matrix. - The second matrix. - The matrix containing the values that result from subtracting each element in value2 from its corresponding element in value1. - - - Returns a string that represents this matrix. - The string representation of this matrix. - - - Transforms the specified matrix by applying the specified Quaternion rotation. - The matrix to transform. - The rotation t apply. - The transformed matrix. - - - Gets or sets the translation component of this matrix. - The translation component of the current instance. - - - Transposes the rows and columns of a matrix. - The matrix to transpose. - The transposed matrix. - - - Represents a three-dimensional plane. - - - Creates a object from a specified four-dimensional vector. - A vector whose first three elements describe the normal vector, and whose defines the distance along that normal from the origin. - - - Creates a object from a specified normal and the distance along the normal from the origin. - The plane&#39;s normal vector. - The plane&#39;s distance from the origin along its normal vector. - - - Creates a object from the X, Y, and Z components of its normal, and its distance from the origin on that normal. - The X component of the normal. - The Y component of the normal. - The Z component of the normal. - The distance of the plane along its normal from the origin. - - - Creates a object that contains three specified points. - The first point defining the plane. - The second point defining the plane. - The third point defining the plane. - The plane containing the three points. - - - The distance of the plane along its normal from the origin. - - - - Calculates the dot product of a plane and a 4-dimensional vector. - The plane. - The four-dimensional vector. - The dot product. - - - Returns the dot product of a specified three-dimensional vector and the normal vector of this plane plus the distance () value of the plane. - The plane. - The 3-dimensional vector. - The dot product. - - - Returns the dot product of a specified three-dimensional vector and the vector of this plane. - The plane. - The three-dimensional vector. - The dot product. - - - Returns a value that indicates whether this instance and a specified object are equal. - The object to compare with the current instance. - true if the current instance and obj are equal; otherwise, false. If obj is null, the method returns false. - - - Returns a value that indicates whether this instance and another plane object are equal. - The other plane. - true if the two planes are equal; otherwise, false. - - - Returns the hash code for this instance. - The hash code. - - - The normal vector of the plane. - - - - Creates a new object whose normal vector is the source plane&#39;s normal vector normalized. - The source plane. - The normalized plane. - - - Returns a value that indicates whether two planes are equal. - The first plane to compare. - The second plane to compare. - true if value1 and value2 are equal; otherwise, false. - - - Returns a value that indicates whether two planes are not equal. - The first plane to compare. - The second plane to compare. - true if value1 and value2 are not equal; otherwise, false. - - - Returns the string representation of this plane object. - A string that represents this object. - - - Transforms a normalized plane by a 4x4 matrix. - The normalized plane to transform. - The transformation matrix to apply to plane. - The transformed plane. - - - Transforms a normalized plane by a Quaternion rotation. - The normalized plane to transform. - The Quaternion rotation to apply to the plane. - A new plane that results from applying the Quaternion rotation. - - - Represents a vector that is used to encode three-dimensional physical rotations. - - - Creates a quaternion from the specified vector and rotation parts. - The vector part of the quaternion. - The rotation part of the quaternion. - - - Constructs a quaternion from the specified components. - The value to assign to the X component of the quaternion. - The value to assign to the Y component of the quaternion. - The value to assign to the Z component of the quaternion. - The value to assign to the W component of the quaternion. - - - Adds each element in one quaternion with its corresponding element in a second quaternion. - The first quaternion. - The second quaternion. - The quaternion that contains the summed values of value1 and value2. - - - Concatenates two quaternions. - The first quaternion rotation in the series. - The second quaternion rotation in the series. - A new quaternion representing the concatenation of the value1 rotation followed by the value2 rotation. - - - Returns the conjugate of a specified quaternion. - The quaternion. - A new quaternion that is the conjugate of value. - - - Creates a quaternion from a vector and an angle to rotate about the vector. - The vector to rotate around. - The angle, in radians, to rotate around the vector. - The newly created quaternion. - - - Creates a quaternion from the specified rotation matrix. - The rotation matrix. - The newly created quaternion. - - - Creates a new quaternion from the given yaw, pitch, and roll. - The yaw angle, in radians, around the Y axis. - The pitch angle, in radians, around the X axis. - The roll angle, in radians, around the Z axis. - The resulting quaternion. - - - Divides one quaternion by a second quaternion. - The dividend. - The divisor. - The quaternion that results from dividing value1 by value2. - - - Calculates the dot product of two quaternions. - The first quaternion. - The second quaternion. - The dot product. - - - Returns a value that indicates whether this instance and another quaternion are equal. - The other quaternion. - true if the two quaternions are equal; otherwise, false. - - - Returns a value that indicates whether this instance and a specified object are equal. - The object to compare with the current instance. - true if the current instance and obj are equal; otherwise, false. If obj is null, the method returns false. - - - Returns the hash code for this instance. - The hash code. - - - Gets a quaternion that represents no rotation. - A quaternion whose values are (0, 0, 0, 1). - - - Returns the inverse of a quaternion. - The quaternion. - The inverted quaternion. - - - Gets a value that indicates whether the current instance is the identity quaternion. - true if the current instance is the identity quaternion; otherwise, false. - - - Calculates the length of the quaternion. - The computed length of the quaternion. - - - Calculates the squared length of the quaternion. - The length squared of the quaternion. - - - Performs a linear interpolation between two quaternions based on a value that specifies the weighting of the second quaternion. - The first quaternion. - The second quaternion. - The relative weight of quaternion2 in the interpolation. - The interpolated quaternion. - - - Returns the quaternion that results from multiplying two quaternions together. - The first quaternion. - The second quaternion. - The product quaternion. - - - Returns the quaternion that results from scaling all the components of a specified quaternion by a scalar factor. - The source quaternion. - The scalar value. - The scaled quaternion. - - - Reverses the sign of each component of the quaternion. - The quaternion to negate. - The negated quaternion. - - - Divides each component of a specified by its length. - The quaternion to normalize. - The normalized quaternion. - - - Adds each element in one quaternion with its corresponding element in a second quaternion. - The first quaternion. - The second quaternion. - The quaternion that contains the summed values of value1 and value2. - - - Divides one quaternion by a second quaternion. - The dividend. - The divisor. - The quaternion that results from dividing value1 by value2. - - - Returns a value that indicates whether two quaternions are equal. - The first quaternion to compare. - The second quaternion to compare. - true if the two quaternions are equal; otherwise, false. - - - Returns a value that indicates whether two quaternions are not equal. - The first quaternion to compare. - The second quaternion to compare. - true if value1 and value2 are not equal; otherwise, false. - - - Returns the quaternion that results from scaling all the components of a specified quaternion by a scalar factor. - The source quaternion. - The scalar value. - The scaled quaternion. - - - Returns the quaternion that results from multiplying two quaternions together. - The first quaternion. - The second quaternion. - The product quaternion. - - - Subtracts each element in a second quaternion from its corresponding element in a first quaternion. - The first quaternion. - The second quaternion. - The quaternion containing the values that result from subtracting each element in value2 from its corresponding element in value1. - - - Reverses the sign of each component of the quaternion. - The quaternion to negate. - The negated quaternion. - - - Interpolates between two quaternions, using spherical linear interpolation. - The first quaternion. - The second quaternion. - The relative weight of the second quaternion in the interpolation. - The interpolated quaternion. - - - Subtracts each element in a second quaternion from its corresponding element in a first quaternion. - The first quaternion. - The second quaternion. - The quaternion containing the values that result from subtracting each element in value2 from its corresponding element in value1. - - - Returns a string that represents this quaternion. - The string representation of this quaternion. - - - The rotation component of the quaternion. - - - - The X value of the vector component of the quaternion. - - - - The Y value of the vector component of the quaternion. - - - - The Z value of the vector component of the quaternion. - - - - Represents a single vector of a specified numeric type that is suitable for low-level optimization of parallel algorithms. - The vector type. T can be any primitive numeric type. - - - Creates a vector whose components are of a specified type. - The numeric type that defines the type of the components in the vector. - - - Creates a vector from a specified array. - A numeric array. - values is null. - - - Creates a vector from a specified array starting at a specified index position. - A numeric array. - The starting index position from which to create the vector. - values is null. - index is less than zero. - -or- - The length of values minus index is less than . - - - Copies the vector instance to a specified destination array. - The array to receive a copy of the vector values. - destination is null. - The number of elements in the current vector is greater than the number of elements available in the destination array. - - - Copies the vector instance to a specified destination array starting at a specified index position. - The array to receive a copy of the vector values. - The starting index in destination at which to begin the copy operation. - destination is null. - The number of elements in the current instance is greater than the number of elements available from startIndex to the end of the destination array. - index is less than zero or greater than the last index in destination. - - - Returns the number of elements stored in the vector. - The number of elements stored in the vector. - Access to the property getter via reflection is not supported. - - - Returns a value that indicates whether this instance is equal to a specified vector. - The vector to compare with this instance. - true if the current instance and other are equal; otherwise, false. - - - Returns a value that indicates whether this instance is equal to a specified object. - The object to compare with this instance. - true if the current instance and obj are equal; otherwise, false. The method returns false if obj is null, or if obj is a vector of a different type than the current instance. - - - Returns the hash code for this instance. - The hash code. - - - Gets the element at a specified index. - The index of the element to return. - The element at index index. - index is less than zero. - -or- - index is greater than or equal to . - - - Returns a vector containing all ones. - A vector containing all ones. - - - Adds two vectors together. - The first vector to add. - The second vector to add. - The summed vector. - - - Returns a new vector by performing a bitwise And operation on each of the elements in two vectors. - The first vector. - The second vector. - The vector that results from the bitwise And of left and right. - - - Returns a new vector by performing a bitwise Or operation on each of the elements in two vectors. - The first vector. - The second vector. - The vector that results from the bitwise Or of the elements in left and right. - - - Divides the first vector by the second. - The first vector. - The second vector. - The vector that results from dividing left by right. - - - Returns a value that indicates whether each pair of elements in two specified vectors are equal. - The first vector to compare. - The second vector to compare. - true if left and right are equal; otherwise, false. - - - Returns a new vector by performing a bitwise XOr operation on each of the elements in two vectors. - The first vector. - The second vector. - The vector that results from the bitwise XOr of the elements in left and right. - - - Reinterprets the bits of the specified vector into a vector of type . - The vector to reinterpret. - The reinterpreted vector. - - - Reinterprets the bits of the specified vector into a vector of type . - The vector to reinterpret. - The reinterpreted vector. - - - Reinterprets the bits of the specified vector into a vector of type . - The vector to reinterpret. - The reinterpreted vector. - - - Reinterprets the bits of the specified vector into a vector of type . - The vector to reinterpret. - The reinterpreted vector. - - - Reinterprets the bits of the specified vector into a vector of type . - The vector to reinterpret. - The reinterpreted vector. - - - Reinterprets the bits of the specified vector into a vector of type . - The vector to reinterpret. - The reinterpreted vector. - - - Reinterprets the bits of the specified vector into a vector of type . - The vector to reinterpret. - The reinterpreted vector. - - - Reinterprets the bits of the specified vector into a vector of type . - The vector to reinterpret. - The reinterpreted vector. - - - Reinterprets the bits of the specified vector into a vector of type . - The vector to reinterpret. - The reinterpreted vector. - - - Reinterprets the bits of the specified vector into a vector of type . - The vector to reinterpret. - The reinterpreted vector. - - - Returns a value that indicates whether any single pair of elements in the specified vectors is equal. - The first vector to compare. - The second vector to compare. - true if any element pairs in left and right are equal. false if no element pairs are equal. - - - Multiplies two vectors together. - The first vector. - The second vector. - The product vector. - - - Multiplies a vector by a specified scalar value. - The source vector. - A scalar value. - The scaled vector. - - - Multiplies a vector by the given scalar. - The scalar value. - The source vector. - The scaled vector. - - - Returns a new vector whose elements are obtained by taking the one&#39;s complement of a specified vector&#39;s elements. - The source vector. - The one&#39;s complement vector. - - - Subtracts the second vector from the first. - The first vector. - The second vector. - The vector that results from subtracting right from left. - - - Negates a given vector. - The vector to negate. - The negated vector. - - - Returns the string representation of this vector using the specified format string to format individual elements and the specified format provider to define culture-specific formatting. - A or that defines the format of individual elements. - A format provider that supplies culture-specific formatting information. - The string representation of the current instance. - - - Returns the string representation of this vector using default formatting. - The string representation of this vector. - - - Returns the string representation of this vector using the specified format string to format individual elements. - A or that defines the format of individual elements. - The string representation of the current instance. - - - Returns a vector containing all zeroes. - A vector containing all zeroes. - - - Provides a collection of static convenience methods for creating, manipulating, combining, and converting generic vectors. - - - Returns a new vector whose elements are the absolute values of the given vector&#39;s elements. - The source vector. - The vector type. T can be any primitive numeric type. - The absolute value vector. - - - Returns a new vector whose values are the sum of each pair of elements from two given vectors. - The first vector. - The second vector. - The vector type. T can be any primitive numeric type. - The summed vector. - - - Returns a new vector by performing a bitwise And Not operation on each pair of corresponding elements in two vectors. - The first vector. - The second vector. - The vector type. T can be any primitive numeric type. - The resulting vector. - - - Reinterprets the bits of a specified vector into those of a vector of unsigned bytes. - The source vector. - The vector type. T can be any primitive numeric type. - The reinterpreted vector. - - - Reinterprets the bits of a specified vector into those of a double-precision floating-point vector. - The source vector. - The vector type. T can be any primitive numeric type. - The reinterpreted vector. - - - Reinterprets the bits of a specified vector into those of a vector of 16-bit integers. - The source vector. - The vector type. T can be any primitive numeric type. - The reinterpreted vector. - - - Reinterprets the bits of a specified vector into those of a vector of integers. - The source vector. - The vector type. T can be any primitive numeric type. - The reinterpreted vector. - - - Reinterprets the bits of a specified vector into those of a vector of long integers. - The source vector. - The vector type. T can be any primitive numeric type. - The reinterpreted vector. - - - Reinterprets the bits of a specified vector into those of a vector of signed bytes. - The source vector. - The vector type. T can be any primitive numeric type. - The reinterpreted vector. - - - Reinterprets the bits of a specified vector into those of a single-precision floating-point vector. - The source vector. - The vector type. T can be any primitive numeric type. - The reinterpreted vector. - - - Reinterprets the bits of a specified vector into those of a vector of unsigned 16-bit integers. - The source vector. - The vector type. T can be any primitive numeric type. - The reinterpreted vector. - - - Reinterprets the bits of a specified vector into those of a vector of unsigned integers. - The source vector. - The vector type. T can be any primitive numeric type. - The reinterpreted vector. - - - Reinterprets the bits of a specified vector into those of a vector of unsigned long integers. - The source vector. - The vector type. T can be any primitive numeric type. - The reinterpreted vector. - - - Returns a new vector by performing a bitwise And operation on each pair of elements in two vectors. - The first vector. - The second vector. - The vector type. T can be any primitive numeric type. - The resulting vector. - - - Returns a new vector by performing a bitwise Or operation on each pair of elements in two vectors. - The first vector. - The second vector. - The vector type. T can be any primitive numeric type. - The resulting vector. - - - Creates a new single-precision vector with elements selected between two specified single-precision source vectors based on an integral mask vector. - The integral mask vector used to drive selection. - The first source vector. - The second source vector. - The new vector with elements selected based on the mask. - - - Creates a new double-precision vector with elements selected between two specified double-precision source vectors based on an integral mask vector. - The integral mask vector used to drive selection. - The first source vector. - The second source vector. - The new vector with elements selected based on the mask. - - - Creates a new vector of a specified type with elements selected between two specified source vectors of the same type based on an integral mask vector. - The integral mask vector used to drive selection. - The first source vector. - The second source vector. - The vector type. T can be any primitive numeric type. - The new vector with elements selected based on the mask. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Returns a new vector whose values are the result of dividing the first vector&#39;s elements by the corresponding elements in the second vector. - The first vector. - The second vector. - The vector type. T can be any primitive numeric type. - The divided vector. - - - Returns the dot product of two vectors. - The first vector. - The second vector. - The vector type. T can be any primitive numeric type. - The dot product. - - - Returns a new integral vector whose elements signal whether the elements in two specified double-precision vectors are equal. - The first vector to compare. - The second vector to compare. - The resulting integral vector. - - - Returns a new integral vector whose elements signal whether the elements in two specified integral vectors are equal. - The first vector to compare. - The second vector to compare. - The resulting integral vector. - - - Returns a new vector whose elements signal whether the elements in two specified long integer vectors are equal. - The first vector to compare. - The second vector to compare. - The resulting long integer vector. - - - Returns a new integral vector whose elements signal whether the elements in two specified single-precision vectors are equal. - The first vector to compare. - The second vector to compare. - The resulting integral vector. - - - Returns a new vector of a specified type whose elements signal whether the elements in two specified vectors of the same type are equal. - The first vector to compare. - The second vector to compare. - The vector type. T can be any primitive numeric type. - The resulting vector. - - - Returns a value that indicates whether each pair of elements in the given vectors is equal. - The first vector to compare. - The second vector to compare. - The vector type. T can be any primitive numeric type. - true if all elements in left and right are equal; otherwise, false. - - - Returns a value that indicates whether any single pair of elements in the given vectors is equal. - The first vector to compare. - The second vector to compare. - The vector type. T can be any primitive numeric type. - true if any element pair in left and right is equal; otherwise, false. - - - Returns a new integral vector whose elements signal whether the elements in one double-precision floating-point vector are greater than their corresponding elements in a second double-precision floating-point vector. - The first vector to compare. - The second vector to compare. - The resulting integral vector. - - - Returns a new integral vector whose elements signal whether the elements in one integral vector are greater than their corresponding elements in a second integral vector. - The first vector to compare. - The second vector to compare. - The resulting integral vector. - - - Returns a new long integer vector whose elements signal whether the elements in one long integer vector are greater than their corresponding elements in a second long integer vector. - The first vector to compare. - The second vector to compare. - The resulting long integer vector. - - - Returns a new integral vector whose elements signal whether the elements in one single-precision floating-point vector are greater than their corresponding elements in a second single-precision floating-point vector. - The first vector to compare. - The second vector to compare. - The resulting integral vector. - - - Returns a new vector whose elements signal whether the elements in one vector of a specified type are greater than their corresponding elements in the second vector of the same time. - The first vector to compare. - The second vector to compare. - The vector type. T can be any primitive numeric type. - The resulting vector. - - - Returns a value that indicates whether all elements in the first vector are greater than the corresponding elements in the second vector. - The first vector to compare. - The second vector to compare. - The vector type. T can be any primitive numeric type. - true if all elements in left are greater than the corresponding elements in right; otherwise, false. - - - Returns a value that indicates whether any element in the first vector is greater than the corresponding element in the second vector. - The first vector to compare. - The second vector to compare. - The vector type. T can be any primitive numeric type. - true if any element in left is greater than the corresponding element in right; otherwise, false. - - - Returns a new integral vector whose elements signal whether the elements in one vector are greater than or equal to their corresponding elements in the single-precision floating-point second vector. - The first vector to compare. - The second vector to compare. - The resulting integral vector. - - - Returns a new long integer vector whose elements signal whether the elements in one long integer vector are greater than or equal to their corresponding elements in the second long integer vector. - The first vector to compare. - The second vector to compare. - The resulting long integer vector. - - - Returns a new integral vector whose elements signal whether the elements in one integral vector are greater than or equal to their corresponding elements in the second integral vector. - The first vector to compare. - The second vector to compare. - The resulting integral vector. - - - Returns a new integral vector whose elements signal whether the elements in one vector are greater than or equal to their corresponding elements in the second double-precision floating-point vector. - The first vector to compare. - The second vector to compare. - The resulting integral vector. - - - Returns a new vector whose elements signal whether the elements in one vector of a specified type are greater than or equal to their corresponding elements in the second vector of the same type. - The first vector to compare. - The second vector to compare. - The vector type. T can be any primitive numeric type. - The resulting vector. - - - Returns a value that indicates whether all elements in the first vector are greater than or equal to all the corresponding elements in the second vector. - The first vector to compare. - The second vector to compare. - The vector type. T can be any primitive numeric type. - true if all elements in left are greater than or equal to the corresponding elements in right; otherwise, false. - - - Returns a value that indicates whether any element in the first vector is greater than or equal to the corresponding element in the second vector. - The first vector to compare. - The second vector to compare. - The vector type. T can be any primitive numeric type. - true if any element in left is greater than or equal to the corresponding element in right; otherwise, false. - - - Gets a value that indicates whether vector operations are subject to hardware acceleration through JIT intrinsic support. - true if vector operations are subject to hardware acceleration; otherwise, false. - - - Returns a new integral vector whose elements signal whether the elements in one double-precision floating-point vector are less than their corresponding elements in a second double-precision floating-point vector. - The first vector to compare. - The second vector to compare. - The resulting integral vector. - - - Returns a new integral vector whose elements signal whether the elements in one integral vector are less than their corresponding elements in a second integral vector. - The first vector to compare. - The second vector to compare. - The resulting integral vector - - - Returns a new long integer vector whose elements signal whether the elements in one long integer vector are less than their corresponding elements in a second long integer vector. - The first vector to compare. - The second vector to compare. - The resulting long integer vector. - - - Returns a new integral vector whose elements signal whether the elements in one single-precision vector are less than their corresponding elements in a second single-precision vector. - The first vector to compare. - The second vector to compare. - The resulting integral vector. - - - Returns a new vector of a specified type whose elements signal whether the elements in one vector are less than their corresponding elements in the second vector. - The first vector to compare. - The second vector to compare. - The vector type. T can be any primitive numeric type. - The resulting vector. - - - Returns a value that indicates whether all of the elements in the first vector are less than their corresponding elements in the second vector. - The first vector to compare. - The second vector to compare. - The vector type. T can be any primitive numeric type. - true if all of the elements in left are less than the corresponding elements in right; otherwise, false. - - - Returns a value that indicates whether any element in the first vector is less than the corresponding element in the second vector. - The first vector to compare. - The second vector to compare. - The vector type. T can be any primitive numeric type. - true if any element in left is less than the corresponding element in right; otherwise, false. - - - Returns a new integral vector whose elements signal whether the elements in one double-precision floating-point vector are less than or equal to their corresponding elements in a second double-precision floating-point vector. - The first vector to compare. - The second vector to compare. - The resulting integral vector. - - - Returns a new integral vector whose elements signal whether the elements in one integral vector are less than or equal to their corresponding elements in a second integral vector. - The first vector to compare. - The second vector to compare. - The resulting integral vector. - - - Returns a new long integer vector whose elements signal whether the elements in one long integer vector are less or equal to their corresponding elements in a second long integer vector. - The first vector to compare. - The second vector to compare. - The resulting long integer vector. - - - Returns a new integral vector whose elements signal whether the elements in one single-precision floating-point vector are less than or equal to their corresponding elements in a second single-precision floating-point vector. - The first vector to compare. - The second vector to compare. - The resulting integral vector. - - - Returns a new vector whose elements signal whether the elements in one vector are less than or equal to their corresponding elements in the second vector. - The first vector to compare. - The second vector to compare. - The vector type. T can be any primitive numeric type. - The resulting vector. - - - Returns a value that indicates whether all elements in the first vector are less than or equal to their corresponding elements in the second vector. - The first vector to compare. - The second vector to compare. - The vector type. T can be any primitive numeric type. - true if all of the elements in left are less than or equal to the corresponding elements in right; otherwise, false. - - - Returns a value that indicates whether any element in the first vector is less than or equal to the corresponding element in the second vector. - The first vector to compare. - The second vector to compare. - The vector type. T can be any primitive numeric type. - true if any element in left is less than or equal to the corresponding element in right; otherwise, false. - - - Returns a new vector whose elements are the maximum of each pair of elements in the two given vectors. - The first vector to compare. - The second vector to compare. - The vector type. T can be any primitive numeric type. - The maximum vector. - - - Returns a new vector whose elements are the minimum of each pair of elements in the two given vectors. - The first vector to compare. - The second vector to compare. - The vector type. T can be any primitive numeric type. - The minimum vector. - - - Returns a new vector whose values are a scalar value multiplied by each of the values of a specified vector. - The scalar value. - The vector. - The vector type. T can be any primitive numeric type. - The scaled vector. - - - Returns a new vector whose values are the product of each pair of elements in two specified vectors. - The first vector. - The second vector. - The vector type. T can be any primitive numeric type. - The product vector. - - - Returns a new vector whose values are the values of a specified vector each multiplied by a scalar value. - The vector. - The scalar value. - The vector type. T can be any primitive numeric type. - The scaled vector. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Returns a new vector whose elements are the negation of the corresponding element in the specified vector. - The source vector. - The vector type. T can be any primitive numeric type. - The negated vector. - - - Returns a new vector whose elements are obtained by taking the one&#39;s complement of a specified vector&#39;s elements. - The source vector. - The vector type. T can be any primitive numeric type. - The resulting vector. - - - Returns a new vector whose elements are the square roots of a specified vector&#39;s elements. - The source vector. - The vector type. T can be any primitive numeric type. - The square root vector. - - - Returns a new vector whose values are the difference between the elements in the second vector and their corresponding elements in the first vector. - The first vector. - The second vector. - The vector type. T can be any primitive numeric type. - The difference vector. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Returns a new vector by performing a bitwise exclusive Or (XOr) operation on each pair of elements in two vectors. - The first vector. - The second vector. - The vector type. T can be any primitive numeric type. - The resulting vector. - - - Represents a vector with two single-precision floating-point values. - - - Creates a new object whose two elements have the same value. - The value to assign to both elements. - - - Creates a vector whose elements have the specified values. - The value to assign to the field. - The value to assign to the field. - - - Returns a vector whose elements are the absolute values of each of the specified vector&#39;s elements. - A vector. - The absolute value vector. - - - Adds two vectors together. - The first vector to add. - The second vector to add. - The summed vector. - - - Restricts a vector between a minimum and a maximum value. - The vector to restrict. - The minimum value. - The maximum value. - The restricted vector. - - - Copies the elements of the vector to a specified array. - The destination array. - array is null. - The number of elements in the current instance is greater than in the array. - array is multidimensional. - - - Copies the elements of the vector to a specified array starting at a specified index position. - The destination array. - The index at which to copy the first element of the vector. - array is null. - The number of elements in the current instance is greater than in the array. - index is less than zero. - -or- - index is greater than or equal to the array length. - array is multidimensional. - - - Computes the Euclidean distance between the two given points. - The first point. - The second point. - The distance. - - - Returns the Euclidean distance squared between two specified points. - The first point. - The second point. - The distance squared. - - - Divides the first vector by the second. - The first vector. - The second vector. - The vector resulting from the division. - - - Divides the specified vector by a specified scalar value. - The vector. - The scalar value. - The vector that results from the division. - - - Returns the dot product of two vectors. - The first vector. - The second vector. - The dot product. - - - Returns a value that indicates whether this instance and a specified object are equal. - The object to compare with the current instance. - true if the current instance and obj are equal; otherwise, false. If obj is null, the method returns false. - - - Returns a value that indicates whether this instance and another vector are equal. - The other vector. - true if the two vectors are equal; otherwise, false. - - - Returns the hash code for this instance. - The hash code. - - - Returns the length of the vector. - The vector&#39;s length. - - - Returns the length of the vector squared. - The vector&#39;s length squared. - - - Performs a linear interpolation between two vectors based on the given weighting. - The first vector. - The second vector. - A value between 0 and 1 that indicates the weight of value2. - The interpolated vector. - - - Returns a vector whose elements are the maximum of each of the pairs of elements in two specified vectors. - The first vector. - The second vector. - The maximized vector. - - - Returns a vector whose elements are the minimum of each of the pairs of elements in two specified vectors. - The first vector. - The second vector. - The minimized vector. - - - Multiplies two vectors together. - The first vector. - The second vector. - The product vector. - - - Multiplies a vector by a specified scalar. - The vector to multiply. - The scalar value. - The scaled vector. - - - Multiplies a scalar value by a specified vector. - The scaled value. - The vector. - The scaled vector. - - - Negates a specified vector. - The vector to negate. - The negated vector. - - - Returns a vector with the same direction as the specified vector, but with a length of one. - The vector to normalize. - The normalized vector. - - - Gets a vector whose 2 elements are equal to one. - A vector whose two elements are equal to one (that is, it returns the vector (1,1). - - - Adds two vectors together. - The first vector to add. - The second vector to add. - The summed vector. - - - Divides the first vector by the second. - The first vector. - The second vector. - The vector that results from dividing left by right. - - - Divides the specified vector by a specified scalar value. - The vector. - The scalar value. - The result of the division. - - - Returns a value that indicates whether each pair of elements in two specified vectors is equal. - The first vector to compare. - The second vector to compare. - true if left and right are equal; otherwise, false. - - - Returns a value that indicates whether two specified vectors are not equal. - The first vector to compare. - The second vector to compare. - true if left and right are not equal; otherwise, false. - - - Multiplies two vectors together. - The first vector. - The second vector. - The product vector. - - - Multiples the specified vector by the specified scalar value. - The vector. - The scalar value. - The scaled vector. - - - Multiples the scalar value by the specified vector. - The vector. - The scalar value. - The scaled vector. - - - Subtracts the second vector from the first. - The first vector. - The second vector. - The vector that results from subtracting right from left. - - - Negates the specified vector. - The vector to negate. - The negated vector. - - - Returns the reflection of a vector off a surface that has the specified normal. - The source vector. - The normal of the surface being reflected off. - The reflected vector. - - - Returns a vector whose elements are the square root of each of a specified vector&#39;s elements. - A vector. - The square root vector. - - - Subtracts the second vector from the first. - The first vector. - The second vector. - The difference vector. - - - Returns the string representation of the current instance using default formatting. - The string representation of the current instance. - - - Returns the string representation of the current instance using the specified format string to format individual elements. - A or that defines the format of individual elements. - The string representation of the current instance. - - - Returns the string representation of the current instance using the specified format string to format individual elements and the specified format provider to define culture-specific formatting. - A or that defines the format of individual elements. - A format provider that supplies culture-specific formatting information. - The string representation of the current instance. - - - Transforms a vector by a specified 3x2 matrix. - The vector to transform. - The transformation matrix. - The transformed vector. - - - Transforms a vector by a specified 4x4 matrix. - The vector to transform. - The transformation matrix. - The transformed vector. - - - Transforms a vector by the specified Quaternion rotation value. - The vector to rotate. - The rotation to apply. - The transformed vector. - - - Transforms a vector normal by the given 3x2 matrix. - The source vector. - The matrix. - The transformed vector. - - - Transforms a vector normal by the given 4x4 matrix. - The source vector. - The matrix. - The transformed vector. - - - Gets the vector (1,0). - The vector (1,0). - - - Gets the vector (0,1). - The vector (0,1). - - - The X component of the vector. - - - - The Y component of the vector. - - - - Returns a vector whose 2 elements are equal to zero. - A vector whose two elements are equal to zero (that is, it returns the vector (0,0). - - - Represents a vector with three single-precision floating-point values. - - - Creates a new object whose three elements have the same value. - The value to assign to all three elements. - - - Creates a new object from the specified object and the specified value. - The vector with two elements. - The additional value to assign to the field. - - - Creates a vector whose elements have the specified values. - The value to assign to the field. - The value to assign to the field. - The value to assign to the field. - - - Returns a vector whose elements are the absolute values of each of the specified vector&#39;s elements. - A vector. - The absolute value vector. - - - Adds two vectors together. - The first vector to add. - The second vector to add. - The summed vector. - - - Restricts a vector between a minimum and a maximum value. - The vector to restrict. - The minimum value. - The maximum value. - The restricted vector. - - - Copies the elements of the vector to a specified array. - The destination array. - array is null. - The number of elements in the current instance is greater than in the array. - array is multidimensional. - - - Copies the elements of the vector to a specified array starting at a specified index position. - The destination array. - The index at which to copy the first element of the vector. - array is null. - The number of elements in the current instance is greater than in the array. - index is less than zero. - -or- - index is greater than or equal to the array length. - array is multidimensional. - - - Computes the cross product of two vectors. - The first vector. - The second vector. - The cross product. - - - Computes the Euclidean distance between the two given points. - The first point. - The second point. - The distance. - - - Returns the Euclidean distance squared between two specified points. - The first point. - The second point. - The distance squared. - - - Divides the specified vector by a specified scalar value. - The vector. - The scalar value. - The vector that results from the division. - - - Divides the first vector by the second. - The first vector. - The second vector. - The vector resulting from the division. - - - Returns the dot product of two vectors. - The first vector. - The second vector. - The dot product. - - - Returns a value that indicates whether this instance and another vector are equal. - The other vector. - true if the two vectors are equal; otherwise, false. - - - Returns a value that indicates whether this instance and a specified object are equal. - The object to compare with the current instance. - true if the current instance and obj are equal; otherwise, false. If obj is null, the method returns false. - - - Returns the hash code for this instance. - The hash code. - - - Returns the length of this vector object. - The vector&#39;s length. - - - Returns the length of the vector squared. - The vector&#39;s length squared. - - - Performs a linear interpolation between two vectors based on the given weighting. - The first vector. - The second vector. - A value between 0 and 1 that indicates the weight of value2. - The interpolated vector. - - - Returns a vector whose elements are the maximum of each of the pairs of elements in two specified vectors. - The first vector. - The second vector. - The maximized vector. - - - Returns a vector whose elements are the minimum of each of the pairs of elements in two specified vectors. - The first vector. - The second vector. - The minimized vector. - - - Multiplies a scalar value by a specified vector. - The scaled value. - The vector. - The scaled vector. - - - Multiplies two vectors together. - The first vector. - The second vector. - The product vector. - - - Multiplies a vector by a specified scalar. - The vector to multiply. - The scalar value. - The scaled vector. - - - Negates a specified vector. - The vector to negate. - The negated vector. - - - Returns a vector with the same direction as the specified vector, but with a length of one. - The vector to normalize. - The normalized vector. - - - Gets a vector whose 3 elements are equal to one. - A vector whose three elements are equal to one (that is, it returns the vector (1,1,1). - - - Adds two vectors together. - The first vector to add. - The second vector to add. - The summed vector. - - - Divides the first vector by the second. - The first vector. - The second vector. - The vector that results from dividing left by right. - - - Divides the specified vector by a specified scalar value. - The vector. - The scalar value. - The result of the division. - - - Returns a value that indicates whether each pair of elements in two specified vectors is equal. - The first vector to compare. - The second vector to compare. - true if left and right are equal; otherwise, false. - - - Returns a value that indicates whether two specified vectors are not equal. - The first vector to compare. - The second vector to compare. - true if left and right are not equal; otherwise, false. - - - Multiplies two vectors together. - The first vector. - The second vector. - The product vector. - - - Multiples the specified vector by the specified scalar value. - The vector. - The scalar value. - The scaled vector. - - - Multiples the scalar value by the specified vector. - The vector. - The scalar value. - The scaled vector. - - - Subtracts the second vector from the first. - The first vector. - The second vector. - The vector that results from subtracting right from left. - - - Negates the specified vector. - The vector to negate. - The negated vector. - - - Returns the reflection of a vector off a surface that has the specified normal. - The source vector. - The normal of the surface being reflected off. - The reflected vector. - - - Returns a vector whose elements are the square root of each of a specified vector&#39;s elements. - A vector. - The square root vector. - - - Subtracts the second vector from the first. - The first vector. - The second vector. - The difference vector. - - - Returns the string representation of the current instance using default formatting. - The string representation of the current instance. - - - Returns the string representation of the current instance using the specified format string to format individual elements. - A or that defines the format of individual elements. - The string representation of the current instance. - - - Returns the string representation of the current instance using the specified format string to format individual elements and the specified format provider to define culture-specific formatting. - A or that defines the format of individual elements. - A format provider that supplies culture-specific formatting information. - The string representation of the current instance. - - - Transforms a vector by a specified 4x4 matrix. - The vector to transform. - The transformation matrix. - The transformed vector. - - - Transforms a vector by the specified Quaternion rotation value. - The vector to rotate. - The rotation to apply. - The transformed vector. - - - Transforms a vector normal by the given 4x4 matrix. - The source vector. - The matrix. - The transformed vector. - - - Gets the vector (1,0,0). - The vector (1,0,0). - - - Gets the vector (0,1,0). - The vector (0,1,0).. - - - Gets the vector (0,0,1). - The vector (0,0,1). - - - The X component of the vector. - - - - The Y component of the vector. - - - - The Z component of the vector. - - - - Gets a vector whose 3 elements are equal to zero. - A vector whose three elements are equal to zero (that is, it returns the vector (0,0,0). - - - Represents a vector with four single-precision floating-point values. - - - Creates a new object whose four elements have the same value. - The value to assign to all four elements. - - - Constructs a new object from the specified object and a W component. - The vector to use for the X, Y, and Z components. - The W component. - - - Creates a new object from the specified object and a Z and a W component. - The vector to use for the X and Y components. - The Z component. - The W component. - - - Creates a vector whose elements have the specified values. - The value to assign to the field. - The value to assign to the field. - The value to assign to the field. - The value to assign to the field. - - - Returns a vector whose elements are the absolute values of each of the specified vector&#39;s elements. - A vector. - The absolute value vector. - - - Adds two vectors together. - The first vector to add. - The second vector to add. - The summed vector. - - - Restricts a vector between a minimum and a maximum value. - The vector to restrict. - The minimum value. - The maximum value. - The restricted vector. - - - Copies the elements of the vector to a specified array. - The destination array. - array is null. - The number of elements in the current instance is greater than in the array. - array is multidimensional. - - - Copies the elements of the vector to a specified array starting at a specified index position. - The destination array. - The index at which to copy the first element of the vector. - array is null. - The number of elements in the current instance is greater than in the array. - index is less than zero. - -or- - index is greater than or equal to the array length. - array is multidimensional. - - - Computes the Euclidean distance between the two given points. - The first point. - The second point. - The distance. - - - Returns the Euclidean distance squared between two specified points. - The first point. - The second point. - The distance squared. - - - Divides the first vector by the second. - The first vector. - The second vector. - The vector resulting from the division. - - - Divides the specified vector by a specified scalar value. - The vector. - The scalar value. - The vector that results from the division. - - - Returns the dot product of two vectors. - The first vector. - The second vector. - The dot product. - - - Returns a value that indicates whether this instance and another vector are equal. - The other vector. - true if the two vectors are equal; otherwise, false. - - - Returns a value that indicates whether this instance and a specified object are equal. - The object to compare with the current instance. - true if the current instance and obj are equal; otherwise, false. If obj is null, the method returns false. - - - Returns the hash code for this instance. - The hash code. - - - Returns the length of this vector object. - The vector&#39;s length. - - - Returns the length of the vector squared. - The vector&#39;s length squared. - - - Performs a linear interpolation between two vectors based on the given weighting. - The first vector. - The second vector. - A value between 0 and 1 that indicates the weight of value2. - The interpolated vector. - - - Returns a vector whose elements are the maximum of each of the pairs of elements in two specified vectors. - The first vector. - The second vector. - The maximized vector. - - - Returns a vector whose elements are the minimum of each of the pairs of elements in two specified vectors. - The first vector. - The second vector. - The minimized vector. - - - Multiplies two vectors together. - The first vector. - The second vector. - The product vector. - - - Multiplies a vector by a specified scalar. - The vector to multiply. - The scalar value. - The scaled vector. - - - Multiplies a scalar value by a specified vector. - The scaled value. - The vector. - The scaled vector. - - - Negates a specified vector. - The vector to negate. - The negated vector. - - - Returns a vector with the same direction as the specified vector, but with a length of one. - The vector to normalize. - The normalized vector. - - - Gets a vector whose 4 elements are equal to one. - Returns . - - - Adds two vectors together. - The first vector to add. - The second vector to add. - The summed vector. - - - Divides the first vector by the second. - The first vector. - The second vector. - The vector that results from dividing left by right. - - - Divides the specified vector by a specified scalar value. - The vector. - The scalar value. - The result of the division. - - - Returns a value that indicates whether each pair of elements in two specified vectors is equal. - The first vector to compare. - The second vector to compare. - true if left and right are equal; otherwise, false. - - - Returns a value that indicates whether two specified vectors are not equal. - The first vector to compare. - The second vector to compare. - true if left and right are not equal; otherwise, false. - - - Multiplies two vectors together. - The first vector. - The second vector. - The product vector. - - - Multiples the specified vector by the specified scalar value. - The vector. - The scalar value. - The scaled vector. - - - Multiples the scalar value by the specified vector. - The vector. - The scalar value. - The scaled vector. - - - Subtracts the second vector from the first. - The first vector. - The second vector. - The vector that results from subtracting right from left. - - - Negates the specified vector. - The vector to negate. - The negated vector. - - - Returns a vector whose elements are the square root of each of a specified vector&#39;s elements. - A vector. - The square root vector. - - - Subtracts the second vector from the first. - The first vector. - The second vector. - The difference vector. - - - Returns the string representation of the current instance using default formatting. - The string representation of the current instance. - - - Returns the string representation of the current instance using the specified format string to format individual elements. - A or that defines the format of individual elements. - The string representation of the current instance. - - - Returns the string representation of the current instance using the specified format string to format individual elements and the specified format provider to define culture-specific formatting. - A or that defines the format of individual elements. - A format provider that supplies culture-specific formatting information. - The string representation of the current instance. - - - Transforms a four-dimensional vector by the specified Quaternion rotation value. - The vector to rotate. - The rotation to apply. - The transformed vector. - - - Transforms a four-dimensional vector by a specified 4x4 matrix. - The vector to transform. - The transformation matrix. - The transformed vector. - - - Transforms a three-dimensional vector by the specified Quaternion rotation value. - The vector to rotate. - The rotation to apply. - The transformed vector. - - - Transforms a two-dimensional vector by a specified 4x4 matrix. - The vector to transform. - The transformation matrix. - The transformed vector. - - - Transforms a two-dimensional vector by the specified Quaternion rotation value. - The vector to rotate. - The rotation to apply. - The transformed vector. - - - Transforms a three-dimensional vector by a specified 4x4 matrix. - The vector to transform. - The transformation matrix. - The transformed vector. - - - Gets the vector (0,0,0,1). - The vector (0,0,0,1). - - - Gets the vector (1,0,0,0). - The vector (1,0,0,0). - - - Gets the vector (0,1,0,0). - The vector (0,1,0,0).. - - - Gets a vector whose 4 elements are equal to zero. - The vector (0,0,1,0). - - - The W component of the vector. - - - - The X component of the vector. - - - - The Y component of the vector. - - - - The Z component of the vector. - - - - Gets a vector whose 4 elements are equal to zero. - A vector whose four elements are equal to zero (that is, it returns the vector (0,0,0,0). - - - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Reactive.Linq.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Reactive.Linq.dll deleted file mode 100644 index d2efb09..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Reactive.Linq.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Reactive.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Reactive.dll deleted file mode 100644 index 69d24a4..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Reactive.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Runtime.CompilerServices.Unsafe.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Runtime.CompilerServices.Unsafe.dll deleted file mode 100644 index c5ba4e4..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Runtime.CompilerServices.Unsafe.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Encoding.CodePages.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Encoding.CodePages.dll deleted file mode 100644 index 2f683a8..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Encoding.CodePages.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Encoding.CodePages.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Encoding.CodePages.xml deleted file mode 100644 index 2922228..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Encoding.CodePages.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - System.Text.Encoding.CodePages - - - - Provides access to an encoding provider for code pages that otherwise are available only in the desktop .NET Framework. - - - Returns the encoding associated with the specified code page identifier. - The code page identifier of the preferred encoding which the encoding provider may support. - The encoding associated with the specified code page identifier, or if the provider does not support the requested codepage encoding. - - - Returns the encoding associated with the specified code page name. - The code page name of the preferred encoding which the encoding provider may support. - The encoding associated with the specified code page, or if the provider does not support the requested encoding. - - - Returns an array that contains all the encodings that are supported by the . - An array that contains all the supported encodings. - - - Gets an encoding provider for code pages supported in the desktop .NET Framework but not in the current .NET Framework platform. - An encoding provider that allows access to encodings not supported on the current .NET Framework platform. - - - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Encodings.Web.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Encodings.Web.dll deleted file mode 100644 index 3d16c7e..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Encodings.Web.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Encodings.Web.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Encodings.Web.xml deleted file mode 100644 index ecf7979..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Encodings.Web.xml +++ /dev/null @@ -1,939 +0,0 @@ - - - - System.Text.Encodings.Web - - - - Represents an HTML character encoding. - - - Initializes a new instance of the class. - - - Creates a new instance of the HtmlEncoder class with the specified settings. - Settings that control how the instance encodes, primarily which characters to encode. - - is . - A new instance of the class. - - - Creates a new instance of the HtmlEncoder class that specifies characters the encoder is allowed to not encode. - The set of characters that the encoder is allowed to not encode. - - is . - A new instance of the class. - - - Gets a built-in instance of the class. - A built-in instance of the class. - - - Represents a JavaScript character encoding. - - - Initializes a new instance of the class. - - - Creates a new instance of JavaScriptEncoder class with the specified settings. - Settings that control how the instance encodes, primarily which characters to encode. - - is . - A new instance of the class. - - - Creates a new instance of the JavaScriptEncoder class that specifies characters the encoder is allowed to not encode. - The set of characters that the encoder is allowed to not encode. - - is . - A new instance of the class. - - - Gets a built-in instance of the class. - A built-in instance of the class. - - - Gets a built-in JavaScript encoder instance that is less strict about what is encoded. - A JavaScript encoder instance. - - - The base class of web encoders. - - - Initializes a new instance of the class. - - - Encodes characters from an array and writes them to a object. - The stream to which to write the encoded text. - The array of characters to encode. - The array index of the first character to encode. - The number of characters in the array to encode. - - is . - The method failed. The encoder does not implement correctly. - - is . - - is out of range. - - is out of range. - - - Encodes the specified string to a object. - The stream to which to write the encoded text. - The string to encode. - - - Encodes a substring and writes it to a object. - The stream to which to write the encoded text. - The string whose substring is to be encoded. - The index where the substring starts. - The number of characters in the substring. - - is . - The method failed. The encoder does not implement correctly. - - is . - - is out of range. - - is out of range. - - - Encodes the supplied characters. - A source buffer containing the characters to encode. - The destination buffer to which the encoded form of will be written. - The number of characters consumed from the buffer. - The number of characters written to the buffer. - - to indicate there is no further source data that needs to be encoded; otherwise, . - An enumeration value that describes the result of the encoding operation. - - - Encodes the supplied string and returns the encoded text as a new string. - The string to encode. - - is . - The method failed. The encoder does not implement correctly. - The encoded string. - - - Encodes the supplied UTF-8 text. - A source buffer containing the UTF-8 text to encode. - The destination buffer to which the encoded form of will be written. - The number of bytes consumed from the buffer. - The number of bytes written to the buffer. - - to indicate there is no further source data that needs to be encoded; otherwise, . - A status code that describes the result of the encoding operation. - - - Finds the index of the first character to encode. - The text buffer to search. - The number of characters in . - The index of the first character to encode. - - - Finds the first element in a UTF-8 text input buffer that would be escaped by the current encoder instance. - The UTF-8 text input buffer to search. - The index of the first element in that would be escaped by the current encoder instance, or -1 if no data in requires escaping. - - - Encodes a Unicode scalar value and writes it to a buffer. - A Unicode scalar value. - A pointer to the buffer to which to write the encoded text. - The length of the destination in characters. - When the method returns, indicates the number of characters written to the . - - if is too small to fit the encoded text; otherwise, returns . - - - Determines if a given Unicode scalar value will be encoded. - A Unicode scalar value. - - if the value will be encoded by this encoder; otherwise, returns . - - - Gets the maximum number of characters that this encoder can generate for each input code point. - The maximum number of characters. - - - Represents a filter that allows only certain Unicode code points. - - - Instantiates an empty filter (allows no code points through by default). - - - Instantiates a filter by cloning the allowed list of another object. - The other object to be cloned. - - - Instantiates a filter where only the character ranges specified by are allowed by the filter. - The allowed character ranges. - - is . - - - Allows the character specified by through the filter. - The allowed character. - - - Allows all characters specified by through the filter. - The allowed characters. - - is . - - - Allows all code points specified by . - The allowed code points. - - is . - - - Allows all characters specified by through the filter. - The range of characters to be allowed. - - is . - - - Allows all characters specified by through the filter. - The ranges of characters to be allowed. - - is . - - - Resets this object by disallowing all characters. - - - Disallows the character through the filter. - The disallowed character. - - - Disallows all characters specified by through the filter. - The disallowed characters. - - is . - - - Disallows all characters specified by through the filter. - The range of characters to be disallowed. - - is . - - - Disallows all characters specified by through the filter. - The ranges of characters to be disallowed. - - is . - - - Gets an enumerator of all allowed code points. - The enumerator of allowed code points. - - - Represents a URL character encoding. - - - Initializes a new instance of the class. - - - Creates a new instance of UrlEncoder class with the specified settings. - Settings that control how the instance encodes, primarily which characters to encode. - - is . - A new instance of the class. - - - Creates a new instance of the UrlEncoder class that specifies characters the encoder is allowed to not encode. - The set of characters that the encoder is allowed to not encode. - - is . - A new instance of the class. - - - Gets a built-in instance of the class. - A built-in instance of the class. - - - Represents a contiguous range of Unicode code points. - - - Creates a new that includes a specified number of characters starting at a specified Unicode code point. - The first code point in the range. - The number of code points in the range. - - is less than zero or greater than 0xFFFF. - --or- - - is less than zero. - --or- - - plus is greater than 0xFFFF. - - - Creates a new instance from a span of characters. - The first character in the range. - The last character in the range. - - precedes . - A range that includes all characters between and . - - - Gets the first code point in the range represented by this instance. - The first code point in the range. - - - Gets the number of code points in the range represented by this instance. - The number of code points in the range. - - - Provides static properties that return predefined instances that correspond to blocks from the Unicode specification. - - - Gets a range that consists of the entire Basic Multilingual Plane (BMP), from U+0000 to U+FFFF). - A range that consists of the entire BMP. - - - Gets the Alphabetic Presentation Forms Unicode block (U+FB00-U+FB4F). - The Alphabetic Presentation Forms Unicode block (U+FB00-U+FB4F). - - - Gets the Arabic Unicode block (U+0600-U+06FF). - The Arabic Unicode block (U+0600-U+06FF). - - - Gets the Arabic Extended-A Unicode block (U+08A0-U+08FF). - The Arabic Extended-A Unicode block (U+08A0-U+08FF). - - - A corresponding to the 'Arabic Extended-B' Unicode block (U+0870..U+089F). - - - Gets the Arabic Presentation Forms-A Unicode block (U+FB50-U+FDFF). - The Arabic Presentation Forms-A Unicode block (U+FB50-U+FDFF). - - - Gets the Arabic Presentation Forms-B Unicode block (U+FE70-U+FEFF). - The Arabic Presentation Forms-B Unicode block (U+FE70-U+FEFF). - - - Gets the Arabic Supplement Unicode block (U+0750-U+077F). - The Arabic Supplement Unicode block (U+0750-U+077F). - - - Gets the Armenian Unicode block (U+0530-U+058F). - The Armenian Unicode block (U+0530-U+058F). - - - Gets the Arrows Unicode block (U+2190-U+21FF). - The Arrows Unicode block (U+2190-U+21FF). - - - Gets the Balinese Unicode block (U+1B00-U+1B7F). - The Balinese Unicode block (U+1B00-U+1B7F). - - - Gets the Bamum Unicode block (U+A6A0-U+A6FF). - The Bamum Unicode block (U+A6A0-U+A6FF). - - - Gets the Basic Latin Unicode block (U+0021-U+007F). - The Basic Latin Unicode block (U+0021-U+007F). - - - Gets the Batak Unicode block (U+1BC0-U+1BFF). - The Batak Unicode block (U+1BC0-U+1BFF). - - - Gets the Bengali Unicode block (U+0980-U+09FF). - The Bengali Unicode block (U+0980-U+09FF). - - - Gets the Block Elements Unicode block (U+2580-U+259F). - The Block Elements Unicode block (U+2580-U+259F). - - - Gets the Bopomofo Unicode block (U+3100-U+312F). - The Bopomofo Unicode block (U+3105-U+312F). - - - Gets the Bopomofo Extended Unicode block (U+31A0-U+31BF). - The Bopomofo Extended Unicode block (U+31A0-U+31BF). - - - Gets the Box Drawing Unicode block (U+2500-U+257F). - The Box Drawing Unicode block (U+2500-U+257F). - - - Gets the Braille Patterns Unicode block (U+2800-U+28FF). - The Braille Patterns Unicode block (U+2800-U+28FF). - - - Gets the Buginese Unicode block (U+1A00-U+1A1F). - The Buginese Unicode block (U+1A00-U+1A1F). - - - Gets the Buhid Unicode block (U+1740-U+175F). - The Buhid Unicode block (U+1740-U+175F). - - - Gets the Cham Unicode block (U+AA00-U+AA5F). - The Cham Unicode block (U+AA00-U+AA5F). - - - Gets the Cherokee Unicode block (U+13A0-U+13FF). - The Cherokee Unicode block (U+13A0-U+13FF). - - - Gets the Cherokee Supplement Unicode block (U+AB70-U+ABBF). - The Cherokee Supplement Unicode block (U+AB70-U+ABBF). - - - Gets the CJK Compatibility Unicode block (U+3300-U+33FF). - The CJK Compatibility Unicode block (U+3300-U+33FF). - - - Gets the CJK Compatibility Forms Unicode block (U+FE30-U+FE4F). - The CJK Compatibility Forms Unicode block (U+FE30-U+FE4F). - - - Gets the CJK Compatibility Ideographs Unicode block (U+F900-U+FAD9). - The CJK Compatibility Ideographs Unicode block (U+F900-U+FAD9). - - - Gets the CJK Radicals Supplement Unicode block (U+2E80-U+2EFF). - The CJK Radicals Supplement Unicode block (U+2E80-U+2EFF). - - - Gets the CJK Strokes Unicode block (U+31C0-U+31EF). - The CJK Strokes Unicode block (U+31C0-U+31EF). - - - Gets the CJK Symbols and Punctuation Unicode block (U+3000-U+303F). - The CJK Symbols and Punctuation Unicode block (U+3000-U+303F). - - - Gets the CJK Unified Ideographs Unicode block (U+4E00-U+9FCC). - The CJK Unified Ideographs Unicode block (U+4E00-U+9FCC). - - - Gets the CJK Unitied Ideographs Extension A Unicode block (U+3400-U+4DB5). - The CJK Unitied Ideographs Extension A Unicode block (U+3400-U+4DB5). - - - Gets the Combining Diacritical Marks Unicode block (U+0300-U+036F). - The Combining Diacritical Marks Unicode block (U+0300-U+036F). - - - Gets the Combining Diacritical Marks Extended Unicode block (U+1AB0-U+1AFF). - The Combining Diacritical Marks Extended Unicode block (U+1AB0-U+1AFF). - - - Gets the Combining Diacritical Marks for Symbols Unicode block (U+20D0-U+20FF). - The Combining Diacritical Marks for Symbols Unicode block (U+20D0-U+20FF). - - - Gets the Combining Diacritical Marks Supplement Unicode block (U+1DC0-U+1DFF). - The Combining Diacritical Marks Supplement Unicode block (U+1DC0-U+1DFF). - - - Gets the Combining Half Marks Unicode block (U+FE20-U+FE2F). - The Combining Half Marks Unicode block (U+FE20-U+FE2F). - - - Gets the Common Indic Number Forms Unicode block (U+A830-U+A83F). - The Common Indic Number Forms Unicode block (U+A830-U+A83F). - - - Gets the Control Pictures Unicode block (U+2400-U+243F). - The Control Pictures Unicode block (U+2400-U+243F). - - - Gets the Coptic Unicode block (U+2C80-U+2CFF). - The Coptic Unicode block (U+2C80-U+2CFF). - - - Gets the Currency Symbols Unicode block (U+20A0-U+20CF). - The Currency Symbols Unicode block (U+20A0-U+20CF). - - - Gets the Cyrillic Unicode block (U+0400-U+04FF). - The Cyrillic Unicode block (U+0400-U+04FF). - - - Gets the Cyrillic Extended-A Unicode block (U+2DE0-U+2DFF). - The Cyrillic Extended-A Unicode block (U+2DE0-U+2DFF). - - - Gets the Cyrillic Extended-B Unicode block (U+A640-U+A69F). - The Cyrillic Extended-B Unicode block (U+A640-U+A69F). - - - A corresponding to the 'Cyrillic Extended-C' Unicode block (U+1C80..U+1C8F). - - - Gets the Cyrillic Supplement Unicode block (U+0500-U+052F). - The Cyrillic Supplement Unicode block (U+0500-U+052F). - - - Gets the Devangari Unicode block (U+0900-U+097F). - The Devangari Unicode block (U+0900-U+097F). - - - Gets the Devanagari Extended Unicode block (U+A8E0-U+A8FF). - The Devanagari Extended Unicode block (U+A8E0-U+A8FF). - - - Gets the Dingbats Unicode block (U+2700-U+27BF). - The Dingbats Unicode block (U+2700-U+27BF). - - - Gets the Enclosed Alphanumerics Unicode block (U+2460-U+24FF). - The Enclosed Alphanumerics Unicode block (U+2460-U+24FF). - - - Gets the Enclosed CJK Letters and Months Unicode block (U+3200-U+32FF). - The Enclosed CJK Letters and Months Unicode block (U+3200-U+32FF). - - - Gets the Ethiopic Unicode block (U+1200-U+137C). - The Ethiopic Unicode block (U+1200-U+137C). - - - Gets the Ethipic Extended Unicode block (U+2D80-U+2DDF). - The Ethipic Extended Unicode block (U+2D80-U+2DDF). - - - Gets the Ethiopic Extended-A Unicode block (U+AB00-U+AB2F). - The Ethiopic Extended-A Unicode block (U+AB00-U+AB2F). - - - Gets the Ethiopic Supplement Unicode block (U+1380-U+1399). - The Ethiopic Supplement Unicode block (U+1380-U+1399). - - - Gets the General Punctuation Unicode block (U+2000-U+206F). - The General Punctuation Unicode block (U+2000-U+206F). - - - Gets the Geometric Shapes Unicode block (U+25A0-U+25FF). - The Geometric Shapes Unicode block (U+25A0-U+25FF). - - - Gets the Georgian Unicode block (U+10A0-U+10FF). - The Georgian Unicode block (U+10A0-U+10FF). - - - A corresponding to the 'Georgian Extended' Unicode block (U+1C90..U+1CBF). - - - Gets the Georgian Supplement Unicode block (U+2D00-U+2D2F). - The Georgian Supplement Unicode block (U+2D00-U+2D2F). - - - Gets the Glagolitic Unicode block (U+2C00-U+2C5F). - The Glagolitic Unicode block (U+2C00-U+2C5F). - - - Gets the Greek and Coptic Unicode block (U+0370-U+03FF). - The Greek and Coptic Unicode block (U+0370-U+03FF). - - - Gets the Greek Extended Unicode block (U+1F00-U+1FFF). - The Greek Extended Unicode block (U+1F00-U+1FFF). - - - Gets the Gujarti Unicode block (U+0A81-U+0AFF). - The Gujarti Unicode block (U+0A81-U+0AFF). - - - Gets the Gurmukhi Unicode block (U+0A01-U+0A7F). - The Gurmukhi Unicode block (U+0A01-U+0A7F). - - - Gets the Halfwidth and Fullwidth Forms Unicode block (U+FF00-U+FFEE). - The Halfwidth and Fullwidth Forms Unicode block (U+FF00-U+FFEE). - - - Gets the Hangul Compatibility Jamo Unicode block (U+3131-U+318F). - The Hangul Compatibility Jamo Unicode block (U+3131-U+318F). - - - Gets the Hangul Jamo Unicode block (U+1100-U+11FF). - The Hangul Jamo Unicode block (U+1100-U+11FF). - - - Gets the Hangul Jamo Extended-A Unicode block (U+A960-U+A9F). - The Hangul Jamo Extended-A Unicode block (U+A960-U+A97F). - - - Gets the Hangul Jamo Extended-B Unicode block (U+D7B0-U+D7FF). - The Hangul Jamo Extended-B Unicode block (U+D7B0-U+D7FF). - - - Gets the Hangul Syllables Unicode block (U+AC00-U+D7AF). - The Hangul Syllables Unicode block (U+AC00-U+D7AF). - - - Gets the Hanunoo Unicode block (U+1720-U+173F). - The Hanunoo Unicode block (U+1720-U+173F). - - - Gets the Hebrew Unicode block (U+0590-U+05FF). - The Hebrew Unicode block (U+0590-U+05FF). - - - Gets the Hiragana Unicode block (U+3040-U+309F). - The Hiragana Unicode block (U+3040-U+309F). - - - Gets the Ideographic Description Characters Unicode block (U+2FF0-U+2FFF). - The Ideographic Description Characters Unicode block (U+2FF0-U+2FFF). - - - Gets the IPA Extensions Unicode block (U+0250-U+02AF). - The IPA Extensions Unicode block (U+0250-U+02AF). - - - Gets the Javanese Unicode block (U+A980-U+A9DF). - The Javanese Unicode block (U+A980-U+A9DF). - - - Gets the Kanbun Unicode block (U+3190-U+319F). - The Kanbun Unicode block (U+3190-U+319F). - - - Gets the Kangxi Radicals Supplement Unicode block (U+2F00-U+2FDF). - The Kangxi Radicals Supplement Unicode block (U+2F00-U+2FDF). - - - Gets the Kannada Unicode block (U+0C81-U+0CFF). - The Kannada Unicode block (U+0C81-U+0CFF). - - - Gets the Katakana Unicode block (U+30A0-U+30FF). - The Katakana Unicode block (U+30A0-U+30FF). - - - Gets the Katakana Phonetic Extensions Unicode block (U+31F0-U+31FF). - The Katakana Phonetic Extensions Unicode block (U+31F0-U+31FF). - - - Gets the Kayah Li Unicode block (U+A900-U+A92F). - The Kayah Li Unicode block (U+A900-U+A92F). - - - Gets the Khmer Unicode block (U+1780-U+17FF). - The Khmer Unicode block (U+1780-U+17FF). - - - Gets the Khmer Symbols Unicode block (U+19E0-U+19FF). - The Khmer Symbols Unicode block (U+19E0-U+19FF). - - - Gets the Lao Unicode block (U+0E80-U+0EDF). - The Lao Unicode block (U+0E80-U+0EDF). - - - Gets the Latin-1 Supplement Unicode block (U+00A1-U+00FF). - The Latin-1 Supplement Unicode block (U+00A1-U+00FF). - - - Gets the Latin Extended-A Unicode block (U+0100-U+017F). - The Latin Extended-A Unicode block (U+0100-U+017F). - - - Gets the Latin Extended Additional Unicode block (U+1E00-U+1EFF). - The Latin Extended Additional Unicode block (U+1E00-U+1EFF). - - - Gets the Latin Extended-B Unicode block (U+0180-U+024F). - The Latin Extended-B Unicode block (U+0180-U+024F). - - - Gets the Latin Extended-C Unicode block (U+2C60-U+2C7F). - The Latin Extended-C Unicode block (U+2C60-U+2C7F). - - - Gets the Latin Extended-D Unicode block (U+A720-U+A7FF). - The Latin Extended-D Unicode block (U+A720-U+A7FF). - - - Gets the Latin Extended-E Unicode block (U+AB30-U+AB6F). - The Latin Extended-E Unicode block (U+AB30-U+AB6F). - - - Gets the Lepcha Unicode block (U+1C00-U+1C4F). - The Lepcha Unicode block (U+1C00-U+1C4F). - - - Gets the Letterlike Symbols Unicode block (U+2100-U+214F). - The Letterlike Symbols Unicode block (U+2100-U+214F). - - - Gets the Limbu Unicode block (U+1900-U+194F). - The Limbu Unicode block (U+1900-U+194F). - - - Gets the Lisu Unicode block (U+A4D0-U+A4FF). - The Lisu Unicode block (U+A4D0-U+A4FF). - - - Gets the Malayalam Unicode block (U+0D00-U+0D7F). - The Malayalam Unicode block (U+0D00-U+0D7F). - - - Gets the Mandaic Unicode block (U+0840-U+085F). - The Mandaic Unicode block (U+0840-U+085F). - - - Gets the Mathematical Operators Unicode block (U+2200-U+22FF). - The Mathematical Operators Unicode block (U+2200-U+22FF). - - - Gets the Meetei Mayek Unicode block (U+ABC0-U+ABFF). - The Meetei Mayek Unicode block (U+ABC0-U+ABFF). - - - Gets the Meetei Mayek Extensions Unicode block (U+AAE0-U+AAFF). - The Meetei Mayek Extensions Unicode block (U+AAE0-U+AAFF). - - - Gets the Miscellaneous Mathematical Symbols-A Unicode block (U+27C0-U+27EF). - The Miscellaneous Mathematical Symbols-A Unicode block (U+27C0-U+27EF). - - - Gets the Miscellaneous Mathematical Symbols-B Unicode block (U+2980-U+29FF). - The Miscellaneous Mathematical Symbols-B Unicode block (U+2980-U+29FF). - - - Gets the Miscellaneous Symbols Unicode block (U+2600-U+26FF). - The Miscellaneous Symbols Unicode block (U+2600-U+26FF). - - - Gets the Miscellaneous Symbols and Arrows Unicode block (U+2B00-U+2BFF). - The Miscellaneous Symbols and Arrows Unicode block (U+2B00-U+2BFF). - - - Gets the Miscellaneous Technical Unicode block (U+2300-U+23FF). - The Miscellaneous Technical Unicode block (U+2300-U+23FF). - - - Gets the Modifier Tone Letters Unicode block (U+A700-U+A71F). - The Modifier Tone Letters Unicode block (U+A700-U+A71F). - - - Gets the Mongolian Unicode block (U+1800-U+18AF). - The Mongolian Unicode block (U+1800-U+18AF). - - - Gets the Myanmar Unicode block (U+1000-U+109F). - The Myanmar Unicode block (U+1000-U+109F). - - - Gets the Myanmar Extended-A Unicode block (U+AA60-U+AA7F). - The Myanmar Extended-A Unicode block (U+AA60-U+AA7F). - - - Gets the Myanmar Extended-B Unicode block (U+A9E0-U+A9FF). - The Myanmar Extended-B Unicode block (U+A9E0-U+A9FF). - - - Gets the New Tai Lue Unicode block (U+1980-U+19DF). - The New Tai Lue Unicode block (U+1980-U+19DF). - - - Gets the NKo Unicode block (U+07C0-U+07FF). - The NKo Unicode block (U+07C0-U+07FF). - - - Gets an empty Unicode range. - A Unicode range with no elements. - - - Gets the Number Forms Unicode block (U+2150-U+218F). - The Number Forms Unicode block (U+2150-U+218F). - - - Gets the Ogham Unicode block (U+1680-U+169F). - The Ogham Unicode block (U+1680-U+169F). - - - Gets the Ol Chiki Unicode block (U+1C50-U+1C7F). - The Ol Chiki Unicode block (U+1C50-U+1C7F). - - - Gets the Optical Character Recognition Unicode block (U+2440-U+245F). - The Optical Character Recognition Unicode block (U+2440-U+245F). - - - Gets the Oriya Unicode block (U+0B00-U+0B7F). - The Oriya Unicode block (U+0B00-U+0B7F). - - - Gets the Phags-pa Unicode block (U+A840-U+A87F). - The Phags-pa Unicode block (U+A840-U+A87F). - - - Gets the Phonetic Extensions Unicode block (U+1D00-U+1D7F). - The Phonetic Extensions Unicode block (U+1D00-U+1D7F). - - - Gets the Phonetic Extensions Supplement Unicode block (U+1D80-U+1DBF). - The Phonetic Extensions Supplement Unicode block (U+1D80-U+1DBF). - - - Gets the Rejang Unicode block (U+A930-U+A95F). - The Rejang Unicode block (U+A930-U+A95F). - - - Gets the Runic Unicode block (U+16A0-U+16FF). - The Runic Unicode block (U+16A0-U+16FF). - - - Gets the Samaritan Unicode block (U+0800-U+083F). - The Samaritan Unicode block (U+0800-U+083F). - - - Gets the Saurashtra Unicode block (U+A880-U+A8DF). - The Saurashtra Unicode block (U+A880-U+A8DF). - - - Gets the Sinhala Unicode block (U+0D80-U+0DFF). - The Sinhala Unicode block (U+0D80-U+0DFF). - - - Gets the Small Form Variants Unicode block (U+FE50-U+FE6F). - The Small Form Variants Unicode block (U+FE50-U+FE6F). - - - Gets the Spacing Modifier Letters Unicode block (U+02B0-U+02FF). - The Spacing Modifier Letters Unicode block (U+02B0-U+02FF). - - - Gets the Specials Unicode block (U+FFF0-U+FFFF). - The Specials Unicode block (U+FFF0-U+FFFF). - - - Gets the Sundanese Unicode block (U+1B80-U+1BBF). - The Sundanese Unicode block (U+1B80-U+1BBF). - - - Gets the Sundanese Supplement Unicode block (U+1CC0-U+1CCF). - The Sundanese Supplement Unicode block (U+1CC0-U+1CCF). - - - Gets the Superscripts and Subscripts Unicode block (U+2070-U+209F). - The Superscripts and Subscripts Unicode block (U+2070-U+209F). - - - Gets the Supplemental Arrows-A Unicode block (U+27F0-U+27FF). - The Supplemental Arrows-A Unicode block (U+27F0-U+27FF). - - - Gets the Supplemental Arrows-B Unicode block (U+2900-U+297F). - The Supplemental Arrows-B Unicode block (U+2900-U+297F). - - - Gets the Supplemental Mathematical Operators Unicode block (U+2A00-U+2AFF). - The Supplemental Mathematical Operators Unicode block (U+2A00-U+2AFF). - - - Gets the Supplemental Punctuation Unicode block (U+2E00-U+2E7F). - The Supplemental Punctuation Unicode block (U+2E00-U+2E7F). - - - Gets the Syloti Nagri Unicode block (U+A800-U+A82F). - The Syloti Nagri Unicode block (U+A800-U+A82F). - - - Gets the Syriac Unicode block (U+0700-U+074F). - The Syriac Unicode block (U+0700-U+074F). - - - A corresponding to the 'Syriac Supplement' Unicode block (U+0860..U+086F). - - - Gets the Tagalog Unicode block (U+1700-U+171F). - The Tagalog Unicode block (U+1700-U+171F). - - - Gets the Tagbanwa Unicode block (U+1760-U+177F). - The Tagbanwa Unicode block (U+1760-U+177F). - - - Gets the Tai Le Unicode block (U+1950-U+197F). - The Tai Le Unicode block (U+1950-U+197F). - - - Gets the Tai Tham Unicode block (U+1A20-U+1AAF). - The Tai Tham Unicode block (U+1A20-U+1AAF). - - - Gets the Tai Viet Unicode block (U+AA80-U+AADF). - The Tai Viet Unicode block (U+AA80-U+AADF). - - - Gets the Tamil Unicode block (U+0B80-U+0BFF). - The Tamil Unicode block (U+0B82-U+0BFA). - - - Gets the Telugu Unicode block (U+0C00-U+0C7F). - The Telugu Unicode block (U+0C00-U+0C7F). - - - Gets the Thaana Unicode block (U+0780-U+07BF). - The Thaana Unicode block (U+0780-U+07BF). - - - Gets the Thai Unicode block (U+0E00-U+0E7F). - The Thai Unicode block (U+0E00-U+0E7F). - - - Gets the Tibetan Unicode block (U+0F00-U+0FFF). - The Tibetan Unicode block (U+0F00-U+0FFF). - - - Gets the Tifinagh Unicode block (U+2D30-U+2D7F). - The Tifinagh Unicode block (U+2D30-U+2D7F). - - - Gets the Unified Canadian Aboriginal Syllabics Unicode block (U+1400-U+167F). - The Unified Canadian Aboriginal Syllabics Unicode block (U+1400-U+167F). - - - Gets the Unified Canadian Aboriginal Syllabics Extended Unicode block (U+18B0-U+18FF). - The Unified Canadian Aboriginal Syllabics Extended Unicode block (U+18B0-U+18FF). - - - Gets the Vai Unicode block (U+A500-U+A63F). - The Vai Unicode block (U+A500-U+A63F). - - - Gets the Variation Selectors Unicode block (U+FE00-U+FE0F). - The Variation Selectors Unicode block (U+FE00-U+FE0F). - - - Gets the Vedic Extensions Unicode block (U+1CD0-U+1CFF). - The Vedic Extensions Unicode block (U+1CD0-U+1CFF). - - - Gets the Vertical Forms Unicode block (U+FE10-U+FE1F). - The Vertical Forms Unicode block (U+FE10-U+FE1F). - - - Gets the Yijing Hexagram Symbols Unicode block (U+4DC0-U+4DFF). - The Yijing Hexagram Symbols Unicode block (U+4DC0-U+4DFF). - - - Gets the Yi Radicals Unicode block (U+A490-U+A4CF). - The Yi Radicals Unicode block (U+A490-U+A4CF). - - - Gets the Yi Syllables Unicode block (U+A000-U+A48F). - The Yi Syllables Unicode block (U+A000-U+A48F). - - - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Json.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Json.dll deleted file mode 100644 index 6ba99c1..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Json.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Json.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Json.xml deleted file mode 100644 index da1a571..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Text.Json.xml +++ /dev/null @@ -1,5785 +0,0 @@ - - - - System.Text.Json - - - - Defines how the struct handles comments. - - - Allows comments within the JSON input and treats them as valid tokens. While reading, the caller can access the comment values. - - - Doesn't allow comments within the JSON input. Comments are treated as invalid JSON if found, and a is thrown. This is the default value. - - - Allows comments within the JSON input and ignores them. The behaves as if no comments are present. - - - Provides a mechanism for examining the structural content of a JSON value without automatically instantiating data values. - - - Releases the resources used by this instance. - - - Parses a sequence as UTF-8-encoded text representing a single JSON value into a JsonDocument. - The JSON text to parse. - Options to control the reader behavior during parsing. - - does not represent a valid single JSON value. - - contains unsupported options. - A JsonDocument representation of the JSON value. - - - Parses a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The stream is read to completion. - The JSON data to parse. - Options to control the reader behavior during parsing. - - does not represent a valid single JSON value. - - contains unsupported options. - A JsonDocument representation of the JSON value. - - - Parses memory as UTF-8-encoded text representing a single JSON value into a JsonDocument. - The JSON text to parse. - Options to control the reader behavior during parsing. - - does not represent a valid single JSON value. - - contains unsupported options. - A JsonDocument representation of the JSON value. - - - Parses text representing a single JSON value into a JsonDocument. - The JSON text to parse. - Options to control the reader behavior during parsing. - - does not represent a valid single JSON value. - - contains unsupported options. - A JsonDocument representation of the JSON value. - - - Parses text representing a single JSON string value into a JsonDocument. - The JSON text to parse. - Options to control the reader behavior during parsing. - - does not represent a valid single JSON value. - - contains unsupported options. - A JsonDocument representation of the JSON value. - - - Parses a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The stream is read to completion. - The JSON data to parse. - Options to control the reader behavior during parsing. - The token to monitor for cancellation requests. - - does not represent a valid single JSON value. - - contains unsupported options. - A task to produce a JsonDocument representation of the JSON value. - - - Parses one JSON value (including objects or arrays) from the provided reader. - The reader to read. - - contains unsupported options. - --or- - -The current token does not start or represent a value. - A value could not be read from the reader. - A JsonDocument representing the value (and nested values) read from the reader. - - - Attempts to parse one JSON value (including objects or arrays) from the provided reader. - The reader to read. - When the method returns, contains the parsed document. - - contains unsupported options. - --or- - -The current token does not start or represent a value. - A value could not be read from the reader. - - if a value was read and parsed into a JsonDocument; if the reader ran out of data while parsing. All other situations result in an exception being thrown. - - - Writes the document to the provided writer as a JSON value. - The writer to which to write the document. - The parameter is . - The of this would result in invalid JSON. - The parent has been disposed. - - - Gets the root element of this JSON document. - A representing the value of the document. - - - Provides the ability for the user to define custom behavior when parsing JSON to create a . - - - Gets or sets a value that indicates whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being read. - - if an extra comma at the end of a list of JSON values in an object or array is allowed; otherwise, . Default is - - - Gets or sets a value that determines how the handles comments when reading through the JSON data. - The comment handling enum is set to a value that is not supported (or not within the enum range). - One of the enumeration values that indicates how comments are handled. - - - Gets or sets the maximum depth allowed when parsing JSON data, with the default (that is, 0) indicating a maximum depth of 64. - The max depth is set to a negative value. - The maximum depth allowed when parsing JSON data. - - - Represents a specific JSON value within a . - - - Gets a JsonElement that can be safely stored beyond the lifetime of the original . - A JsonElement that can be safely stored beyond the lifetime of the original . - - - Gets an enumerator to enumerate the values in the JSON array represented by this JsonElement. - This value's is not . - The parent has been disposed. - An enumerator to enumerate the values in the JSON array represented by this JsonElement. - - - Gets an enumerator to enumerate the properties in the JSON object represented by this JsonElement. - This value's is not . - The parent has been disposed. - An enumerator to enumerate the properties in the JSON object represented by this JsonElement. - - - Gets the number of values contained within the current array value. - This value's is not . - The parent has been disposed. - The number of values contained within the current array value. - - - Gets the value of the element as a . - This value's is neither nor . - The parent has been disposed. - The value of the element as a . - - - Gets the current JSON number as a . - This value's is not . - The value cannot be represented as a . - The parent has been disposed. - The current JSON number as a . - - - Gets the value of the element as a byte array. - This value's is not . - The value is not encoded as Base64 text and hence cannot be decoded to bytes. - The parent has been disposed. - The value decoded as a byte array. - - - Gets the value of the element as a . - This value's is not . - The value cannot be read as a . - The parent has been disposed. - The value of the element as a . - - - Gets the value of the element as a . - This value's is not . - The value cannot be read as a . - The parent has been disposed. - The value of the element as a . - - - Gets the current JSON number as a . - This value's is not . - The value cannot be represented as a . - The parent has been disposed. - The current JSON number as a . - - - Gets the current JSON number as a . - This value's is not . - The value cannot be represented as a . - The parent has been disposed. - The current JSON number as a . - - - Gets the value of the element as a . - This value's is not . - The value cannot be represented as a . - The parent has been disposed. - The value of the element as a . - - - Gets the current JSON number as an . - This value's is not . - The value cannot be represented as an . - The parent has been disposed. - The current JSON number as an . - - - Gets the current JSON number as an . - This value's is not . - The value cannot be represented as an . - The parent has been disposed. - The current JSON number as an . - - - Gets the current JSON number as an . - This value's is not . - The value cannot be represented as a . - The parent has been disposed. - The current JSON number as an . - - - Gets a representing the value of a required property identified by . - The UTF-8 representation (with no Byte-Order-Mark (BOM)) of the name of the property to return. - This value's is not . - No property was found with the requested name. - The parent has been disposed. - A representing the value of the requested property. - - - Gets a representing the value of a required property identified by . - The name of the property whose value is to be returned. - This value's is not . - No property was found with the requested name. - The parent has been disposed. - A representing the value of the requested property. - - - Gets a representing the value of a required property identified by . - The name of the property whose value is to be returned. - This value's is not . - No property was found with the requested name. - - is . - The parent has been disposed. - A representing the value of the requested property. - - - Gets a string that represents the original input data backing this value. - The parent has been disposed. - The original input data backing this value. - - - Gets the current JSON number as an . - This value's is not . - The value cannot be represented as an . - The parent has been disposed. - The current JSON number as an . - - - Gets the current JSON number as a . - This value's is not . - The value cannot be represented as a . - The parent has been disposed. - The current JSON number as a . - - - Gets the value of the element as a . - This value's is neither nor . - The parent has been disposed. - The value of the element as a . - - - Gets the current JSON number as a . - This value's is not . - The value cannot be represented as a . - The parent has been disposed. - The current JSON number as a . - - - Gets the current JSON number as a . - This value's is not . - The value cannot be represented as a . - The parent has been disposed. - The current JSON number as a . - - - Gets the current JSON number as a . - This value's is not . - The value cannot be represented as a . - The parent has been disposed. - The current JSON number as a . - - - Parses one JSON value (including objects or arrays) from the provided reader. - The reader to read. - - is using unsupported options. - The current token does not start or represent a value. - A value could not be read from the reader. - A JsonElement representing the value (and nested values) read from the reader. - - - Gets a string representation for the current value appropriate to the value type. - The parent has been disposed. - A string representation for the current value appropriate to the value type. - - - Attempts to represent the current JSON number as a . - When this method returns, contains the byte equivalent of the current JSON number if the conversion succeeded, or 0 if the conversion failed. - This value's is not . - The parent has been disposed. - - if the number can be represented as a ; otherwise, . - - - Attempts to represent the current JSON string as a byte array, assuming that it is Base64 encoded. - If the method succeeds, contains the decoded binary representation of the Base64 text. - This value's is not . - The parent has been disposed. - - if the entire token value is encoded as valid Base64 text and can be successfully decoded to bytes; otherwise, . - - - Attempts to represent the current JSON string as a . - When this method returns, contains the date and time value equivalent to the current JSON string if the conversion succeeded, or if the conversion failed. - This value's is not . - The parent has been disposed. - - if the string can be represented as a ; otherwise, . - - - Attempts to represent the current JSON string as a . - When this method returns, contains the date and time value equivalent to the current JSON string if the conversion succeeded, or if the conversion failed. - This value's is not . - The parent has been disposed. - - if the string can be represented as a ; otherwise, . - - - Attempts to represent the current JSON number as a . - When this method returns, contains the decimal equivalent of the current JSON number if the conversion succeeded, or 0 if the conversion failed. - This value's is not . - The parent has been disposed. - - if the number can be represented as a ; otherwise, . - - - Attempts to represent the current JSON number as a . - When this method returns, contains a double-precision floating point value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed. - This value's is not . - The parent has been disposed. - - if the number can be represented as a ; otherwise, . - - - Attempts to represent the current JSON string as a . - When this method returns, contains the GUID equivalent to the current JSON string if the conversion succeeded, or if the conversion failed. - This value's is not . - The parent has been disposed. - - if the string can be represented as a ; otherwise, . - - - Attempts to represent the current JSON number as an . - When this method returns, contains the 16-bit integer value equivalent of the current JSON number if the conversion succeeded, or 0 if the conversion failed. - This value's is not . - The parent has been disposed. - - if the number can be represented as an ; otherwise, . - - - Attempts to represent the current JSON number as an . - When this method returns, contains the 32-bit integer value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed. - This value's is not . - The parent has been disposed. - - if the number can be represented as an ; otherwise, . - - - Attempts to represent the current JSON number as a . - When this method returns, contains the 64-bit integer value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed. - This value's is not . - The parent has been disposed. - - if the number can be represented as a ; otherwise, . - - - Looks for a property named in the current object, returning a value that indicates whether or not such a property exists. When the property exists, the method assigns its value to the argument. - The UTF-8 (with no Byte-Order-Mark (BOM)) representation of the name of the property to return. - Receives the value of the located property. - This value's is not . - The parent has been disposed. - - if the property was found; otherwise, . - - - Looks for a property named in the current object, returning a value that indicates whether or not such a property exists. When the property exists, the method assigns its value to the argument. - The name of the property to find. - When this method returns, contains the value of the specified property. - This value's is not . - The parent has been disposed. - - if the property was found; otherwise, . - - - Looks for a property named in the current object, returning a value that indicates whether or not such a property exists. When the property exists, its value is assigned to the argument. - The name of the property to find. - When this method returns, contains the value of the specified property. - This value's is not . - - is . - The parent has been disposed. - - if the property was found; otherwise, . - - - Attempts to represent the current JSON number as an . - When this method returns, contains the signed byte equivalent of the current JSON number if the conversion succeeded, or 0 if the conversion failed. - This value's is not . - The parent has been disposed. - - if the number can be represented as an ; otherwise, . - - - Attempts to represent the current JSON number as a . - When this method returns, contains the single-precision floating point value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed. - This value's is not . - The parent has been disposed. - - if the number can be represented as a ; otherwise, . - - - Attempts to represent the current JSON number as a . - When this method returns, contains the unsigned 16-bit integer value equivalent of the current JSON number if the conversion succeeded, or 0 if the conversion failed. - This value's is not . - The parent has been disposed. - - if the number can be represented as a ; otherwise, . - - - Attempts to represent the current JSON number as a . - When this method returns, contains unsigned 32-bit integer value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed. - This value's is not . - The parent has been disposed. - - if the number can be represented as a ; otherwise, . - - - Attempts to represent the current JSON number as a . - When this method returns, contains unsigned 64-bit integer value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed. - This value's is not . - The parent has been disposed. - - if the number can be represented as a ; otherwise, . - - - Attempts to parse one JSON value (including objects or arrays) from the provided reader. - The reader to read. - Receives the parsed element. - - is using unsupported options. - The current token does not start or represent a value. - A value could not be read from the reader. - - if a value was read and parsed into a JsonElement; if the reader ran out of data while parsing. - All other situations result in an exception being thrown. - - - Compares the text represented by a UTF8-encoded byte span to the string value of this element. - The UTF-8 encoded text to compare against. - This value's is not . - - if the string value of this element has the same UTF-8 encoding as - ; otherwise, . - - - Compares a specified read-only character span to the string value of this element. - The text to compare against. - This value's is not . - - if the string value of this element matches ; otherwise, . - - - Compares a specified string to the string value of this element. - The text to compare against. - This value's is not . - - if the string value of this element matches ; otherwise, . - - - Writes the element to the specified writer as a JSON value. - The writer to which to write the element. - The parameter is . - The of this value is . - The parent has been disposed. - - - Gets the value at the specified index if the current value is an . - The item index. - This value's is not . - - is not in the range [0, ()). - The parent has been disposed. - The value at the specified index. - - - Gets the type of the current JSON value. - The parent has been disposed. - The type of the current JSON value. - - - Represents an enumerator for the contents of a JSON array. - - - Releases the resources used by this instance. - - - Returns an enumerator that iterates through a collection. - An enumerator that can be used to iterate through the array. - - - Advances the enumerator to the next element of the collection. - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - - Sets the enumerator to its initial position, which is before the first element in the collection. - - - Returns an enumerator that iterates through a collection. - An enumerator for an array of that can be used to iterate through the collection. - - - Returns an enumerator that iterates through a collection. - An enumerator that can be used to iterate through the collection. - - - Gets the element in the collection at the current position of the enumerator. - The element in the collection at the current position of the enumerator. - - - Gets the element in the collection at the current position of the enumerator. - The element in the collection at the current position of the enumerator. - - - Represents an enumerator for the properties of a JSON object. - - - Releases the resources used by this instance. - - - Returns an enumerator that iterates the properties of an object. - An enumerator that can be used to iterate through the object. - - - Advances the enumerator to the next element of the collection. - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - - Sets the enumerator to its initial position, which is before the first element in the collection. - - - Returns an enumerator that iterates through a collection. - An enumerator for objects that can be used to iterate through the collection. - - - Returns an enumerator that iterates through a collection. - An enumerator that can be used to iterate through the collection. - - - Gets the element in the collection at the current position of the enumerator. - The element in the collection at the current position of the enumerator. - - - Gets the element in the collection at the current position of the enumerator. - The element in the collection at the current position of the enumerator. - - - Provides methods to transform UTF-8 or UTF-16 encoded text into a form that is suitable for JSON. - - - Encodes a UTF-8 text value as a JSON string. - The UTF-8 encoded text to convert to JSON encoded text. - The encoder to use when escaping the string, or to use the default encoder. - - is too large. - --or- - - contains invalid UTF-8 bytes. - The encoded JSON text. - - - Encodes a specified text value as a JSON string. - The value to convert to JSON encoded text. - The encoder to use when escaping the string, or to use the default encoder. - - is too large. - --or- - - contains invalid UTF-16 characters. - The encoded JSON text. - - - Encodes the string text value as a JSON string. - The value to convert to JSON encoded text. - The encoder to use when escaping the string, or to use the default encoder. - - is . - - is too large. - --or- - - contains invalid UTF-16 characters. - The encoded JSON text. - - - Determines whether this instance and a specified object, which must also be a instance, have the same value. - The object to compare to this instance. - - if the current instance and are equal; otherwise, . - - - Determines whether this instance and another specified instance have the same value. - The object to compare to this instance. - - if this instance and have the same value; otherwise, . - - - Returns the hash code for this . - The hash code for this instance. - - - Converts the value of this instance to a . - The underlying UTF-16 encoded string. - - - Gets the UTF-8 encoded representation of the pre-encoded JSON text. - The UTF-8 encoded representation of the pre-encoded JSON text. - - - Gets the UTF-16 encoded representation of the pre-encoded JSON text as a . - - - Defines a custom exception object that is thrown when invalid JSON text is encountered, the defined maximum depth is passed, or the JSON text is not compatible with the type of a property on an object. - - - Initializes a new instance of the class. - - - Creates a new exception object with serialized data. - The serialized object data about the exception being thrown. - An object that contains contextual information about the source or destination. - - is . - - - Initializes a new instance of the class with a specified error message. - The context-specific error message. - - - Initializes a new instance of the class, with a specified error message and a reference to the inner exception that is the cause of this exception. - The context-specific error message. - The exception that caused the current exception. - - - Creates a new exception object to relay error information to the user. - The context-specific error message. - The path where the invalid JSON was encountered. - The line number (starting at 0) at which the invalid JSON was encountered when deserializing. - The byte count within the current line (starting at 0) where the invalid JSON was encountered. - - - Creates a new exception object to relay error information to the user that includes a specified inner exception. - The context-specific error message. - The path where the invalid JSON was encountered. - The line number (starting at 0) at which the invalid JSON was encountered when deserializing. - The byte count (starting at 0) within the current line where the invalid JSON was encountered. - The exception that caused the current exception. - - - Sets the with information about the exception. - The serialized object data about the exception being thrown. - An object that contains contextual information about the source or destination. - - - Gets the zero-based number of bytes read within the current line before the exception. - The zero-based number of bytes read within the current line before the exception. - - - Gets the zero-based number of lines read before the exception. - The zero-based number of lines read before the exception. - - - Gets a message that describes the current exception. - The error message that describes the current exception. - - - Gets The path within the JSON where the exception was encountered. - The path within the JSON where the exception was encountered. - - - Determines the naming policy used to convert a string-based name to another format, such as a camel-casing format. - - - Initializes a new instance of . - - - When overridden in a derived class, converts the specified name according to the policy. - The name to convert. - The converted name. - - - Gets the naming policy for camel-casing. - The naming policy for camel-casing. - - - Gets the naming policy for lowercase kebab-casing. - - - Gets the naming policy for uppercase kebab-casing. - - - Gets the naming policy for lowercase snake-casing. - - - Gets the naming policy for uppercase snake-casing. - - - Represents a single property for a JSON object. - - - Compares the specified UTF-8 encoded text to the name of this property. - The UTF-8 encoded text to compare against. - This value's is not . - - if the name of this property has the same UTF-8 encoding as ; otherwise, . - - - Compares the specified text as a character span to the name of this property. - The text to compare against. - This value's is not . - - if the name of this property matches ; otherwise, . - - - Compares the specified string to the name of this property. - The text to compare against. - This value's is not . - - if the name of this property matches ; otherwise . - - - Provides a string representation of the property for debugging purposes. - A string containing the uninterpreted value of the property, beginning at the declaring open-quote and ending at the last character that is part of the value. - - - Writes the property to the provided writer as a named JSON object property. - The writer to which to write the property. - - is . - - is too large to be a JSON object property. - The of this JSON property's would result in invalid JSON. - The parent has been disposed. - - - Gets the name of this property. - The name of this property. - - - Gets the value of this property. - The value of this property. - - - Provides the ability for the user to define custom behavior when reading JSON. - - - Gets or sets a value that defines whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being read. - - if an extra comma is allowed; otherwise, . - - - Gets or sets a value that determines how the handles comments when reading through the JSON data. - The property is being set to a value that is not a member of the enumeration. - One of the enumeration values that indicates how comments are handled. - - - Gets or sets the maximum depth allowed when reading JSON, with the default (that is, 0) indicating a maximum depth of 64. - The maximum depth is being set to a negative value. - The maximum depth allowed when reading JSON. - - - Defines an opaque type that holds and saves all the relevant state information, which must be provided to the to continue reading after processing incomplete data. - - - Constructs a new instance. - Defines the customized behavior of the that is different from the JSON RFC (for example how to handle comments, or the maximum depth allowed when reading). By default, the follows the JSON RFC strictly (comments within the JSON are invalid) and reads up to a maximum depth of 64. - The maximum depth is set to a non-positive value (< 0). - - - Gets the custom behavior to use when reading JSON data using the struct that may deviate from strict adherence to the JSON specification, which is the default behavior. - The custom behavior to use when reading JSON data. - - - Provides functionality to serialize objects or value types to JSON and to deserialize JSON into objects or value types. - - - Reads the UTF-8 encoded text representing a single JSON value into an instance specified by the . - The Stream will be read to completion. - JSON data to parse. - Metadata about the type to convert. - - or is . - The JSON is invalid, - or there is remaining data in the Stream. - A representation of the JSON value. - - - Reads the UTF-8 encoded text representing a single JSON value into a . - The Stream will be read to completion. - JSON data to parse. - The type of the object to convert to and return. - Options to control the behavior during reading. - - or is . - The JSON is invalid, the is not compatible with the JSON, or there is remaining data in the Stream. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Reads the UTF-8 encoded text representing a single JSON value into a . - The Stream will be read to completion. - JSON data to parse. - The type of the object to convert to and return. - A metadata provider for serializable types. - - , , or is . - The JSON is invalid, the is not compatible with the JSON, or there is remaining data in the Stream. - There is no compatible for or its serializable members. - The method on the provided did not return a compatible for . - A representation of the JSON value. - - - Parses the UTF-8 encoded text representing a single JSON value into an instance specified by the . - JSON text to parse. - Metadata about the type to convert. - The JSON is invalid, - or there is remaining data in the buffer. - A representation of the JSON value. - - - Parses the UTF-8 encoded text representing a single JSON value into an instance of a specified type. - The JSON text to parse. - The type of the object to convert to and return. - Options to control the behavior during parsing. - - is . - The JSON is invalid. - --or- - - is not compatible with the JSON. - --or- - -There is remaining data in the span beyond a single JSON value. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Parses the UTF-8 encoded text representing a single JSON value into a . - JSON text to parse. - The type of the object to convert to and return. - A metadata provider for serializable types. - - is . - The JSON is invalid, is not compatible with the JSON, or there is remaining data in the Stream. - There is no compatible for or its serializable members. - The method on the provided did not return a compatible for . - A representation of the JSON value. - - - Parses the text representing a single JSON value into an instance specified by the . - JSON text to parse. - Metadata about the type to convert. - - is . - The JSON is invalid. - --or- - -There is remaining data in the string beyond a single JSON value. - A representation of the JSON value. - - - Parses the text representing a single JSON value into an instance of a specified type. - The JSON text to parse. - The type of the object to convert to and return. - Options to control the behavior during parsing. - - is . - The JSON is invalid. - --or- - - is not compatible with the JSON. - --or- - -There is remaining data in the span beyond a single JSON value. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Parses the text representing a single JSON value into a . - JSON text to parse. - The type of the object to convert to and return. - A metadata provider for serializable types. - - or is . - --or- - - is . - The JSON is invalid. - --or- - - is not compatible with the JSON. - --or- - -There is remaining data in the string beyond a single JSON value. - There is no compatible for or its serializable members. - The method of the provided returns for the type to convert. - A representation of the JSON value. - - - Parses the text representing a single JSON value into an instance specified by the . - JSON text to parse. - Metadata about the type to convert. - - is . - --or- - - is . - The JSON is invalid. - --or- - -There is remaining data in the string beyond a single JSON value. - A representation of the JSON value. - - - Parses the text representing a single JSON value into an instance of a specified type. - The JSON text to parse. - The type of the object to convert to and return. - Options to control the behavior during parsing. - - or is . - The JSON is invalid. - --or- - - is not compatible with the JSON. - --or- - -There is remaining data in the string beyond a single JSON value. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Parses the text representing a single JSON value into a . - JSON text to parse. - The type of the object to convert to and return. - A metadata provider for serializable types. - - or is . - --or- - - is . - The JSON is invalid. - --or- - - is not compatible with the JSON. - --or- - -There is remaining data in the string beyond a single JSON value. - There is no compatible for or its serializable members. - The method of the provided returns for the type to convert. - A representation of the JSON value. - - - Converts the representing a single JSON value into an instance specified by the . - The to convert. - Metadata about the type to convert. - - is . - --or- - - is . - A representation of the JSON value. - - - Converts the representing a single JSON value into a . - The to convert. - The type of the object to convert to and return. - Options to control the behavior during parsing. - - or is . - - is not compatible with the JSON. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Converts the representing a single JSON value into a . - The to convert. - The type of the object to convert to and return. - A metadata provider for serializable types. - - is . - --or- - - is . - --or- - - is . - The JSON is invalid. - --or- - - is not compatible with the JSON. - --or- - -There is remaining data in the string beyond a single JSON value. - There is no compatible for or its serializable members. - The method of the provided returns for the type to convert. - A representation of the JSON value. - - - Converts the representing a single JSON value into an instance specified by the . - The to convert. - Metadata about the type to convert. - - is . - A representation of the JSON value. - - - Converts the representing a single JSON value into a . - The to convert. - The type of the object to convert to and return. - Options to control the behavior during parsing. - - is . - - is not compatible with the JSON. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Converts the representing a single JSON value into a . - The to convert. - The type of the object to convert to and return. - A metadata provider for serializable types. - - is . - --or- - - is . - The JSON is invalid. - --or- - - is not compatible with the JSON. - --or- - -There is remaining data in the string beyond a single JSON value. - There is no compatible for or its serializable members. - The method of the provided returns for the type to convert. - A representation of the JSON value. - - - Converts the representing a single JSON value into an instance specified by the . - The to convert. - Metadata about the type to convert. - - is . - A representation of the JSON value. - - - Converts the representing a single JSON value into a . - The to convert. - The type of the object to convert to and return. - Options to control the behavior during parsing. - - is not compatible with the JSON. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Converts the representing a single JSON value into a . - The to convert. - The type of the object to convert to and return. - A metadata provider for serializable types. - - is . - --or- - - is . - The JSON is invalid. - --or- - - is not compatible with the JSON. - --or- - -There is remaining data in the string beyond a single JSON value. - There is no compatible for or its serializable members. - The method of the provided returns for the type to convert. - A representation of the JSON value. - - - Reads one JSON value (including objects or arrays) from the provided reader into an instance specified by the . - The reader to read. - Metadata about the type to convert. - The JSON is invalid, - is not compatible with the JSON, - or a value could not be read from the reader. - - is using unsupported options. - A representation of the JSON value. - - - Reads one JSON value (including objects or arrays) from the provided reader and converts it into an instance of a specified type. - The reader to read the JSON from. - The type of the object to convert to and return. - Options to control the serializer behavior during reading. - - is . - The JSON is invalid. - --or- - - is not compatible with the JSON. - --or- - -A value could not be read from the reader. - - is using unsupported options. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Reads one JSON value (including objects or arrays) from the provided reader into a . - The reader to read. - The type of the object to convert to and return. - A metadata provider for serializable types. - - or is . - The JSON is invalid, is not compatible with the JSON, or a value could not be read from the reader. - - is using unsupported options. - There is no compatible for or its serializable members. - The method on the provided did not return a compatible for . - A representation of the JSON value. - - - Reads the UTF-8 encoded text representing a single JSON value into a . - The Stream will be read to completion. - JSON data to parse. - Options to control the behavior during reading. - The type to deserialize the JSON value into. - - is . - The JSON is invalid, is not compatible with the JSON, or there is remaining data in the Stream. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Reads the UTF-8 encoded text representing a single JSON value into a . - The Stream will be read to completion. - JSON data to parse. - Metadata about the type to convert. - The type to deserialize the JSON value into. - - or is . - The JSON is invalid, is not compatible with the JSON, or there is remaining data in the Stream. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Parses the UTF-8 encoded text representing a single JSON value into an instance of the type specified by a generic type parameter. - The JSON text to parse. - Options to control the behavior during parsing. - The target type of the UTF-8 encoded text. - The JSON is invalid. - --or- - - is not compatible with the JSON. - --or- - -There is remaining data in the span beyond a single JSON value. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Parses the UTF-8 encoded text representing a single JSON value into a . - JSON text to parse. - Metadata about the type to convert. - The type to deserialize the JSON value into. - The JSON is invalid, is not compatible with the JSON, or there is remaining data in the Stream. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Parses the text representing a single JSON value into an instance of the type specified by a generic type parameter. - The JSON text to parse. - Options to control the behavior during parsing. - The type to deserialize the JSON value into. - The JSON is invalid. - --or- - - is not compatible with the JSON. - --or- - -There is remaining data in the span beyond a single JSON value. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Parses the text representing a single JSON value into a . - JSON text to parse. - Metadata about the type to convert. - The type to deserialize the JSON value into. - - is . - --or- - - is . - The JSON is invalid. - --or- - - is not compatible with the JSON. - --or- - -There is remaining data in the string beyond a single JSON value. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Parses the text representing a single JSON value into an instance of the type specified by a generic type parameter. - The JSON text to parse. - Options to control the behavior during parsing. - The target type of the JSON value. - - is . - The JSON is invalid. - --or- - - is not compatible with the JSON. - --or- - -There is remaining data in the string beyond a single JSON value. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Parses the text representing a single JSON value into a . - JSON text to parse. - Metadata about the type to convert. - The type to deserialize the JSON value into. - - is . - --or- - - is . - The JSON is invalid. - --or- - - is not compatible with the JSON. - --or- - -There is remaining data in the string beyond a single JSON value. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Converts the representing a single JSON value into a . - The to convert. - Options to control the behavior during parsing. - The type to deserialize the JSON value into. - - is . - - is not compatible with the JSON. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Converts the representing a single JSON value into a . - The to convert. - Metadata about the type to convert. - The type to deserialize the JSON value into. - - is . - --or- - - is . - - is not compatible with the JSON. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Converts the representing a single JSON value into a . - The to convert. - Options to control the behavior during parsing. - The type to deserialize the JSON value into. - - is not compatible with the JSON. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Converts the representing a single JSON value into a . - The to convert. - Metadata about the type to convert. - The type to deserialize the JSON value into. - - is . - - is not compatible with the JSON. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Converts the representing a single JSON value into a . - The to convert. - Options to control the behavior during parsing. - The type to deserialize the JSON value into. - - is not compatible with the JSON. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Converts the representing a single JSON value into a . - The to convert. - Metadata about the type to convert. - The type to deserialize the JSON value into. - - is . - - is not compatible with the JSON. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Reads one JSON value (including objects or arrays) from the provided reader into an instance of the type specified by a generic type parameter. - The reader to read the JSON from. - Options to control serializer behavior during reading. - The target type of the JSON value. - The JSON is invalid. - --or- - - is not compatible with the JSON. - --or- - -A value could not be read from the reader. - - uses unsupported options. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Reads one JSON value (including objects or arrays) from the provided reader into a . - The reader to read. - Metadata about the type to convert. - The type to deserialize the JSON value into. - The JSON is invalid, is not compatible with the JSON, or a value could not be read from the reader. - - is using unsupported options. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Reads the UTF-8 encoded text representing a single JSON value into an instance specified by the . - The Stream will be read to completion. - JSON data to parse. - Metadata about the type to convert. - The that can be used to cancel the read operation. - - or is . - The JSON is invalid, - or when there is remaining data in the Stream. - A representation of the JSON value. - - - Asynchronously reads the UTF-8 encoded text representing a single JSON value into an instance of a specified type. The stream will be read to completion. - The JSON data to parse. - The type of the object to convert to and return. - Options to control the behavior during reading. - A cancellation token that may be used to cancel the read operation. - - or is . - The JSON is invalid. - --or- - - is not compatible with the JSON. - --or- - -There is remaining data in the stream. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Reads the UTF-8 encoded text representing a single JSON value into a . - The Stream will be read to completion. - JSON data to parse. - The type of the object to convert to and return. - A metadata provider for serializable types. - The that can be used to cancel the read operation. - - , , or is . - The JSON is invalid, the is not compatible with the JSON, or there is remaining data in the Stream. - There is no compatible for or its serializable members. - The method on the provided did not return a compatible for . - A representation of the JSON value. - - - Asynchronously reads the UTF-8 encoded text representing a single JSON value into an instance of a type specified by a generic type parameter. The stream will be read to completion. - The JSON data to parse. - Options to control the behavior during reading. - A token that may be used to cancel the read operation. - The target type of the JSON value. - The JSON is invalid. - --or- - - is not compatible with the JSON. - --or- - -There is remaining data in the stream. - There is no compatible for or its serializable members. - - is . - A representation of the JSON value. - - - Reads the UTF-8 encoded text representing a single JSON value into a . - The Stream will be read to completion. - JSON data to parse. - Metadata about the type to convert. - The which may be used to cancel the read operation. - The type to deserialize the JSON value into. - - or is . - The JSON is invalid, is not compatible with the JSON, or there is remaining data in the Stream. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Wraps the UTF-8 encoded text into an that can be used to deserialize root-level JSON arrays in a streaming manner. - JSON data to parse. - Options to control the behavior during reading. - The which may be used to cancel the read operation. - The element type to deserialize asynchronously. - - is . - An representation of the provided JSON array. - - - Wraps the UTF-8 encoded text into an that can be used to deserialize root-level JSON arrays in a streaming manner. - JSON data to parse. - Metadata about the element type to convert. - The that can be used to cancel the read operation. - The element type to deserialize asynchronously. - - or is . - An representation of the provided JSON array. - - - Converts the provided value to UTF-8 encoded JSON text and write it to the . - The UTF-8 to write to. - The value to convert. - Metadata about the type to convert. - - is . - - does not match the type of . - - - Converts the provided value to UTF-8 encoded JSON text and write it to the . - The UTF-8 to write to. - The value to convert. - The type of the to convert. - Options to control the conversion behavior. - - is not compatible with . - - or is . - There is no compatible for or its serializable members. - - - Converts the provided value to UTF-8 encoded JSON text and write it to the . - The UTF-8 to write to. - The value to convert. - The type of the to convert. - A metadata provider for serializable types. - - is not compatible with . - - , , or is . - There is no compatible for or its serializable members. - - - Converts the provided value into a . - The value to convert. - Metadata about the type to convert. - - is . - - does not match the type of . - A representation of the value. - - - Converts the value of a specified type into a JSON string. - The value to convert. - The type of the to convert. - Options to control the conversion behavior. - - is not compatible with . - - is . - There is no compatible for or its serializable members. - The JSON string representation of the value. - - - Converts the provided value into a . - The value to convert. - The type of the to convert. - A metadata provider for serializable types. - There is no compatible for or its serializable members. - The method of the provided returns for the type to convert. - - or is . - A representation of the value. - - - Writes one JSON value (including objects or arrays) to the provided writer. - The writer to write. - The value to convert and write. - Metadata about the type to convert. - - or is . - - does not match the type of . - - - Writes the JSON representation of the specified type to the provided writer. - The JSON writer to write to. - The value to convert and write. - The type of the to convert. - Options to control serialization behavior. - - is not compatible with - - or is . - There is no compatible for or its serializable members. - - - Writes one JSON value (including objects or arrays) to the provided writer. - A JSON writer to write to. - The value to convert and write. - The type of the to convert. - A metadata provider for serializable types. - - is not compatible with . - - or is . - There is no compatible for or its serializable members. - The method of the provided returns for the type to convert. - - - Converts the value of a type specified by a generic type parameter into a JSON string. - The value to convert. - Options to control serialization behavior. - The type of the value to serialize. - There is no compatible for or its serializable members. - A JSON string representation of the value. - - - Converts the provided value into a . - The value to convert. - Metadata about the type to convert. - The type of the value to serialize. - There is no compatible for or its serializable members. - - is . - A representation of the value. - - - Converts the provided value to UTF-8 encoded JSON text and write it to the . - The UTF-8 to write to. - The value to convert. - Options to control the conversion behavior. - The type of the value to serialize. - - is . - There is no compatible for or its serializable members. - - - Converts the provided value to UTF-8 encoded JSON text and write it to the . - The UTF-8 to write to. - The value to convert. - Metadata about the type to convert. - The type of the value to serialize. - - is . - There is no compatible for or its serializable members. - - - Writes the JSON representation of a type specified by a generic type parameter to the provided writer. - A JSON writer to write to. - The value to convert and write. - Options to control serialization behavior. - The type of the value to serialize. - - is . - There is no compatible for or its serializable members. - - - Writes one JSON value (including objects or arrays) to the provided writer. - The writer to write. - The value to convert and write. - Metadata about the type to convert. - The type of the value to serialize. - - or is . - There is no compatible for or its serializable members. - - - Converts the provided value to UTF-8 encoded JSON text and writes it to the . - The UTF-8 to write to. - The value to convert. - Metadata about the type to convert. - The that can be used to cancel the write operation. - - is . - - does not match the type of . - A task that represents the asynchronous write operation. - - - Asynchronously converts the value of a specified type to UTF-8 encoded JSON text and writes it to the specified stream. - The UTF-8 stream to write to. - The value to convert. - The type of the to convert. - Options to control serialization behavior. - A token that may be used to cancel the write operation. - - is not compatible with . - - or is . - There is no compatible for or its serializable members. - A task that represents the asynchronous write operation. - - - Converts the provided value to UTF-8 encoded JSON text and write it to the . - The UTF-8 to write to. - The value to convert. - The type of the to convert. - A metadata provider for serializable types. - The that can be used to cancel the write operation. - - is not compatible with . - - , , or is . - There is no compatible for or its serializable members. - A task that represents the asynchronous write operation. - - - Asynchronously converts a value of a type specified by a generic type parameter to UTF-8 encoded JSON text and writes it to a stream. - The UTF-8 stream to write to. - The value to convert. - Options to control serialization behavior. - A token that may be used to cancel the write operation. - The type of the value to serialize. - - is . - There is no compatible for or its serializable members. - A task that represents the asynchronous write operation. - - - Converts the provided value to UTF-8 encoded JSON text and write it to the . - The UTF-8 to write to. - The value to convert. - Metadata about the type to convert. - The that can be used to cancel the write operation. - The type of the value to serialize. - - is . - There is no compatible for or its serializable members. - A task that represents the asynchronous write operation. - - - Converts the provided value into a . - The value to convert. - Metadata about the type to convert. - - is . - - does not match the type of . - A representation of the value. - - - Converts the provided value into a . - The value to convert. - The type of the to convert. - Options to control the conversion behavior. - - is not compatible with . - - is . - There is no compatible for or its serializable members. - A representation of the value. - - - Converts the provided value into a . - The value to convert. - The type of the to convert. - A metadata provider for serializable types. - There is no compatible for or its serializable members. - The method of the provided returns for the type to convert. - - or is . - A representation of the value. - - - Converts the provided value into a . - The value to convert. - Options to control the conversion behavior. - The type of the value to serialize. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Converts the provided value into a . - The value to convert. - Metadata about the type to convert. - The type of the value to serialize. - There is no compatible for or its serializable members. - - is . - A representation of the value. - - - Converts the provided value into a . - The value to convert. - Metadata about the type to convert. - - is . - - does not match the type of . - A representation of the value. - - - Converts the provided value into a . - The value to convert. - The type of the to convert. - Options to control the conversion behavior. - - is not compatible with . - - is . - There is no compatible for or its serializable members. - A representation of the value. - - - Converts the provided value into a . - The value to convert. - The type of the to convert. - A metadata provider for serializable types. - There is no compatible for or its serializable members. - The method of the provided returns for the type to convert. - - or is . - A representation of the value. - - - Converts the provided value into a . - The value to convert. - Options to control the conversion behavior. - The type of the value to serialize. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Converts the provided value into a . - The value to convert. - Metadata about the type to convert. - The type of the value to serialize. - There is no compatible for or its serializable members. - - is . - A representation of the value. - - - Converts the provided value into a . - The value to convert. - Metadata about the type to convert. - - is . - - does not match the type of . - A representation of the value. - - - Converts the provided value into a . - The value to convert. - The type of the to convert. - Options to control the conversion behavior. - - is not compatible with . - - is . - There is no compatible for or its serializable members. - A representation of the value. - - - Converts the provided value into a . - The value to convert. - The type of the to convert. - A metadata provider for serializable types. - There is no compatible for or its serializable members. - The method of the provided returns for the type to convert. - - or is . - A representation of the value. - - - Converts the provided value into a . - The value to convert. - Options to control the conversion behavior. - The type of the value to serialize. - There is no compatible for or its serializable members. - A representation of the JSON value. - - - Converts the provided value into a . - The value to convert. - Metadata about the type to convert. - The type of the value to serialize. - There is no compatible for or its serializable members. - - is . - A representation of the value. - - - Converts the provided value into a array. - The value to convert. - Metadata about the type to convert. - - is . - - does not match the type of . - A UTF-8 representation of the value. - - - Converts a value of the specified type into a JSON string, encoded as UTF-8 bytes. - The value to convert. - The type of the to convert. - Options to control the conversion behavior. - - is not compatible with . - - is . - There is no compatible for or its serializable members. - A JSON string representation of the value, encoded as UTF-8 bytes. - - - Converts the provided value into a array. - The value to convert. - The type of the to convert. - A metadata provider for serializable types. - - is not compatible with . - - is . - There is no compatible for or its serializable members. - The method of the provided returns for the type to convert. - A UTF-8 representation of the value. - - - Converts the value of a type specified by a generic type parameter into a JSON string, encoded as UTF-8 bytes. - The value to convert. - Options to control the conversion behavior. - The type of the value. - There is no compatible for or its serializable members. - A JSON string representation of the value, encoded as UTF-8 bytes. - - - Converts the provided value into a array. - The value to convert. - Metadata about the type to convert. - The type of the value to serialize. - There is no compatible for or its serializable members. - - is . - A UTF-8 representation of the value. - - - Indicates whether unconfigured instances should be set to use the reflection-based . - - - Specifies scenario-based default serialization options that can be used to construct a instance. - - - - General-purpose option values. These are the same settings that are applied if a member isn't specified. - For information about the default property values that are applied, see JsonSerializerOptions properties. - - - - - Option values appropriate to Web-based scenarios. - This member implies that: - - Property names are treated as case-insensitive. - - "camelCase" name formatting should be employed. - - Quoted numbers (JSON strings for number properties) are allowed. - - - - Provides options to be used with . - - - Initializes a new instance of the class. - - - Constructs a new instance with a predefined set of options determined by the specified . - The to reason about. - - - Copies the options from a instance to a new instance. - The options instance to copy options from. - - is . - - - Appends a new to the metadata resolution of the current instance. - The generic definition of the specified context type. - - - Returns the converter for the specified type. - The type to return a converter for. - The configured for returned an invalid converter. - There is no compatible for or its serializable members. - The first converter that supports the given type. - - - Gets the contract metadata resolved by the current instance. - The type to resolve contract metadata for. - - is . - - is not valid for serialization. - The contract metadata resolved for . - - - Marks the current instance as read-only to prevent any further user modification. - The instance does not specify a setting. - - - Marks the current instance as read-only preventing any further user modification. - Populates unconfigured properties with the reflection-based default. - - The instance does not specify a setting. Thrown when is . - -or- - The feature switch has been turned off. - - - - Tries to get the contract metadata resolved by the current instance. - The type to resolve contract metadata for. - When this method returns, contains the resolved contract metadata, or if the contract could not be resolved. - - is . - - is not valid for serialization. - - if a contract for was found, or otherwise. - - - Get or sets a value that indicates whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being deserialized. - This property was set after serialization or deserialization has occurred. - - if an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored); otherwise. - - - Gets the list of user-defined converters that were registered. - The list of custom converters. - - - Gets a read-only, singleton instance of that uses the default configuration. - - - Gets or sets the default buffer size, in bytes, to use when creating temporary buffers. - The buffer size is less than 1. - This property was set after serialization or deserialization has occurred. - The default buffer size in bytes. - - - Gets or sets a value that determines when properties with default values are ignored during serialization or deserialization. - The default value is . - This property is set to . - This property is set after serialization or deserialization has occurred. - --or- - - has been set to . These properties cannot be used together. - - - Gets or sets the policy used to convert a key's name to another format, such as camel-casing. - The policy used to convert a key's name to another format. - - - Gets or sets the encoder to use when escaping strings, or to use the default encoder. - The JavaScript character encoding. - - - Gets or sets a value that indicates whether values are ignored during serialization and deserialization. The default value is . - This property was set after serialization or deserialization has occurred. - --or- - - has been set to a non-default value. These properties cannot be used together. - - if null values are ignored during serialization and deserialization; otherwise, . - - - Gets or sets a value that indicates whether read-only fields are ignored during serialization. A field is read-only if it is marked with the keyword. The default value is . - This property is set after serialization or deserialization has occurred. - - if read-only fields are ignored during serialization; otherwise. - - - Gets a value that indicates whether read-only properties are ignored during serialization. The default value is . - This property was set after serialization or deserialization has occurred. - - if read-only properties are ignored during serialization; otherwise, . - - - Gets or sets a value that indicates whether fields are handled during serialization and deserialization. - The default value is . - This property is set after serialization or deserialization has occurred. - - if fields are included during serialization; otherwise, . - - - Gets a value that indicates whether the current instance has been locked for user modification. - - - Gets or sets the maximum depth allowed when serializing or deserializing JSON, with the default value of 0 indicating a maximum depth of 64. - This property was set after serialization or deserialization has occurred. - The max depth is set to a negative value. - The maximum depth allowed when serializing or deserializing JSON. - - - Gets or sets an object that specifies how number types should be handled when serializing or deserializing. - This property is set after serialization or deserialization has occurred. - - - Gets or sets the preferred object creation handling for properties when deserializing JSON. - When set to , all properties that are capable of reusing the existing instance will be populated. - - - Gets or sets a value that indicates whether a property's name uses a case-insensitive comparison during deserialization. The default value is . - - if property names are compared case-insensitively; otherwise, . - - - Gets or sets a value that specifies the policy used to convert a property's name on an object to another format, such as camel-casing, or to leave property names unchanged. - A property naming policy, or to leave property names unchanged. - - - Gets or sets a value that defines how comments are handled during deserialization. - This property was set after serialization or deserialization has occurred. - The comment handling enum is set to a value that is not supported (or not within the enum range). - A value that indicates whether comments are allowed, disallowed, or skipped. - - - Gets or sets an object that specifies how object references are handled when reading and writing JSON. - - - Gets or sets the contract resolver used by this instance. - The property is set after serialization or deserialization has occurred. - - - Gets the list of chained contract resolvers used by this instance. - - - Gets or sets an object that specifies how deserializing a type declared as an is handled during deserialization. - - - Gets or sets an object that specifies how handles JSON properties that cannot be mapped to a specific .NET member when deserializing object types. - - - Gets or sets a value that indicates whether JSON should use pretty printing. By default, JSON is serialized without any extra white space. - This property was set after serialization or deserialization has occurred. - - if JSON is pretty printed on serialization; otherwise, . The default is . - - - Defines the various JSON tokens that make up a JSON text. - - - The token type is a comment string. - - - The token type is the end of a JSON array. - - - The token type is the end of a JSON object. - - - The token type is the JSON literal false. - - - There is no value (as distinct from ). This is the default token type if no data has been read by the . - - - The token type is the JSON literal null. - - - The token type is a JSON number. - - - The token type is a JSON property name. - - - The token type is the start of a JSON array. - - - The token type is the start of a JSON object. - - - The token type is a JSON string. - - - The token type is the JSON literal true. - - - Specifies the data type of a JSON value. - - - A JSON array. - - - The JSON value false. - - - The JSON value null. - - - A JSON number. - - - A JSON object. - - - A JSON string. - - - The JSON value true. - - - There is no value (as distinct from ). - - - Allows the user to define custom behavior when writing JSON using the . - - - Gets or sets the encoder to use when escaping strings, or to use the default encoder. - The JavaScript character encoder used to override the escaping behavior. - - - Gets or sets a value that indicates whether the should format the JSON output, which includes indenting nested JSON tokens, adding new lines, and adding white space between property names and values. - - if the JSON output is formatted; if the JSON is written without any extra white space. The default is . - - - Gets or sets the maximum depth allowed when writing JSON, with the default (that is, 0) indicating a max depth of 1000. - Thrown when the max depth is set to a negative value. - - - Gets or sets a value that indicates whether the should skip structural validation and allow the user to write invalid JSON. - - if structural validation is skipped and invalid JSON is allowed; if an is thrown on any attempt to write invalid JSON. - - - Represents a mutable JSON array. - - - Initializes a new instance of the class that is empty. - Options to control the behavior. - - - Initializes a new instance of the class that contains items from the specified array. - The items to add to the new . - - - Initializes a new instance of the class that contains items from the specified params array. - Options to control the behavior. - The items to add to the new . - - - Adds a to the end of the . - The to be added to the end of the . - - - Adds an object to the end of the . - The object to be added to the end of the . - The type of object to be added. - - - Removes all elements from the . - - - Determines whether an element is in the . - The object to locate in the . - - if is found in the ; otherwise, . - - - Initializes a new instance of the class that contains items from the specified . - The . - Options to control the behavior. - The is not a . - The new instance of the class that contains items from the specified . - - - Returns an enumerator that iterates through the . - An for the . - - - Returns an enumerable that wraps calls to . - The type of the value to obtain from the . - An enumerable iterating over values of the array. - - - The object to locate in the . - The to locate in the . - The index of item if found in the list; otherwise, -1. - - - Inserts an element into the at the specified index. - The zero-based index at which should be inserted. - The to insert. - - is less than 0 or is greater than . - - - Removes the first occurrence of a specific from the . - The to remove from the . - - if is successfully removed; otherwise, . - - - Removes the element at the specified index of the . - The zero-based index of the element to remove. - - is less than 0 or is greater than . - - - Copies the entire to a compatible one-dimensional array, starting at the specified index of the target array. - The one-dimensional that is the destination of the elements copied from . The Array must have zero-based indexing. - The zero-based index in at which copying begins. - - is . - - is less than 0. - The number of elements in the source ICollection is greater than the available space from to the end of the destination . - - - Returns an enumerator that iterates through the . - A for the . - - - Writes the into the provided as JSON. - The . - Options to control the serialization behavior. - - - Gets the number of elements contained in the . - The number of elements contained in the . - - - Returns . - - if the is read-only; otherwise, . - - - The base class that represents a single node within a mutable JSON document. - - - Casts to the derived type. - The node is not a . - A . - - - Casts to the derived type. - The node is not a . - A . - - - Casts to the derived type. - The node is not a . - A . - - - Creates a new instance of the class. All child nodes are recursively cloned. - A new cloned instance of the current node. - - - Compares the values of two nodes, including the values of all descendant nodes. - The to compare. - The to compare. - - if the tokens are equal; otherwise . - - - Returns the index of the current node from the parent . - The current parent is not a . - The index of the current node. - - - Gets the JSON path. - The JSON Path value. - - - Returns the property name of the current node from the parent object. - The current parent is not a . - The property name of the current node. - - - Gets the value for the current . - The type of the value to obtain from the . - The current cannot be represented as a {TValue}. - The current is not a or is not compatible with {TValue}. - A value converted from the instance. - - - Returns the of the current instance. - The json value kind of the current instance. - - - Defines an explicit conversion of a given to a . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a given to a . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a given to a . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a given to a . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a given to a . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a given to a . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a given to a . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a given to a . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a given to an . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a given to an . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a given to an . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a specified nullable to a nullable . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a specified nullable to a nullable . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a given to a . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a specified nullable to a nullable . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a specified nullable to a nullable . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a specified nullable to a nullable . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a specified nullable to a nullable . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a specified nullable to a nullable . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a specified nullable to a nullable . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a specified nullable to a nullable . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a specified nullable to a nullable . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a specified nullable to a nullable . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a specified nullable to a nullable . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a specified nullable to a nullable . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a specified nullable to a nullable . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a specified nullable to a nullable . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a given to an . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a given to a . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a specified nullable to a nullable . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a given to a . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a given to a . - A to explicitly convert. - A value converted from the instance. - - - Defines an explicit conversion of a given to a . - A to explicitly convert. - A value converted from the instance. - - - Defines an implicit conversion of a given to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a given to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a given to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a given to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a given to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a given to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a given to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a given to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a given to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a given to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a given to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a nullable . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Defines an implicit conversion of a specified nullable to a . - A to implicitly convert. - A instance converted from the parameter. - - - Parses a as UTF-8-encoded data representing a single JSON value into a . The Stream will be read to completion. - JSON text to parse. - Options to control the node behavior after parsing. - Options to control the document behavior during parsing. - - does not represent a valid single JSON value. - A representation of the JSON value. - - - Parses text representing a single JSON value. - JSON text to parse. - Options to control the node behavior after parsing. - Options to control the document behavior during parsing. - - does not represent a valid single JSON value. - A representation of the JSON value. - - - Parses text representing a single JSON value. - JSON text to parse. - Options to control the node behavior after parsing. - Options to control the document behavior during parsing. - - is . - - does not represent a valid single JSON value. - A representation of the JSON value. - - - Parses one JSON value (including objects or arrays) from the provided reader. - The reader to read. - Options to control the behavior. - - is using unsupported options. - The current token does not start or represent a value. - A value could not be read from the reader. - The from the reader. - - - Parses a as UTF-8 encoded data representing a single JSON value into a . The stream will be read to completion. - The JSON text to parse. - Options to control the node behavior after parsing. - Options to control the document behavior during parsing. - The token to monitor for cancellation requests. - - does not represent a valid single JSON value. - A to produce a representation of the JSON value. - - - Replaces this node with a new value. - The value that replaces this node. - The type of value to be replaced. - - - Converts the current instance to string in JSON format. - Options to control the serialization behavior. - JSON representation of current instance. - - - Gets a string representation for the current value appropriate to the node type. - A string representation for the current value appropriate to the node type. - - - Writes the into the provided as JSON. - The . - Options to control the serialization behavior. - The parameter is . - - - Gets or sets the element at the specified index. - The zero-based index of the element to get or set. - - is less than 0 or is greater than the number of properties. - The current is not a . - - - Gets or sets the element with the specified property name. - If the property is not found, is returned. - The name of the property to return. - - is . - The current is not a . - - - Gets the options to control the behavior. - - - Gets the parent . - If there is no parent, is returned. - A parent can either be a or a . - - - Gets the root . - - - Options to control behavior. - - - Gets or sets a value that indicates whether property names on are case insensitive. - - if property names are case insensitive; if property names are case sensitive. - - - Represents a mutable JSON object. - - - Initializes a new instance of the class that contains the specified . - The properties to be added. - Options to control the behavior. - - - Initializes a new instance of the class that is empty. - Options to control the behavior. - - - Adds the specified property to the . - The KeyValuePair structure representing the property name and value to add to the . - An element with the same property name already exists in the . - The property name of is . - - - Adds an element with the provided property name and value to the . - The property name of the element to add. - The value of the element to add. - - is . - An element with the same property name already exists in the . - - - Removes all elements from the . - - - Determines whether the contains an element with the specified property name. - The property name to locate in the . - - is . - - if the contains an element with the specified property name; otherwise, . - - - Initializes a new instance of the class that contains properties from the specified . - The . - Options to control the behavior. - The new instance of the class that contains properties from the specified . - - - Returns an enumerator that iterates through the . - An enumerator that iterates through the . - - - Removes the element with the specified property name from the . - The property name of the element to remove. - - is . - - if the element is successfully removed; otherwise, . - - - Determines whether the contains a specific property name and reference. - The element to locate in the . - - if the contains an element with the property name; otherwise, . - - - Copies the elements of the to an array of type KeyValuePair starting at the specified array index. - The one-dimensional Array that is the destination of the elements copied from . - The zero-based index in at which copying begins. - - is . - - is less than 0. - The number of elements in the source ICollection is greater than the available space from to the end of the destination . - - - Removes a key and value from the . - The KeyValuePair structure representing the property name and value to remove from the . - - if the element is successfully removed; otherwise, . - - - Gets the value associated with the specified property name. - The property name of the value to get. - When this method returns, contains the value associated with the specified property name, if the property name is found; otherwise, . - - is . - - if the contains an element with the specified property name; otherwise, . - - - Returns an enumerator that iterates through the . - An enumerator that iterates through the . - - - Returns the value of a property with the specified name. - The name of the property to return. - The JSON value of the property with the specified name. - - if a property with the specified name was found; otherwise, . - - - Writes the into the provided as JSON. - The . - Options to control the serialization behavior. - - - Gets the number of elements contained in . - The number of elements contained in the . - - - Returns . - - if the is read-only; otherwise, . - - - Gets a collection containing the property names in the . - An containing the keys of the object that implements . - - - Gets a collection containing the property values in the . - An containing the values in the object that implements . - - - Represents a mutable JSON value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The underlying value of the new instance. - Options to control the behavior. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The value to create. - Options to control the behavior. - The type of value to create. - The new instance of the class that contains the specified value. - - - Initializes a new instance of the class that contains the specified value. - The value to create. - The that will be used to serialize the value. - Options to control the behavior. - The type of value to create. - The new instance of the class that contains the specified value. - - - Tries to obtain the current JSON value and returns a value that indicates whether the operation succeeded. - When this method returns, contains the parsed value. - The type of value to obtain. - - if the value can be successfully obtained; otherwise, . - - - Specifies that the JSON type should have its method called after deserialization occurs. - - - The method that is called after deserialization. - - - Specifies that the type should have its method called before deserialization occurs. - - - The method that is called before deserialization. - - - Specifies that the type should have its method called after serialization occurs. - - - The method that is called after serialization. - - - Specifies that the type should have its method called before serialization occurs. - - - The method that is called before serialization. - - - Provides the base class for serialization attributes. - - - Creates a new instance of the . - - - When placed on a constructor, indicates that the constructor should be used to create instances of the type on deserialization. - - - Initializes a new instance of . - - - Converts an object or value to or from JSON. - - - When overridden in a derived class, determines whether the converter instance can convert the specified object type. - The type of the object to check whether it can be converted by this converter instance. - - if the instance can convert the specified object type; otherwise, . - - - Gets the type being converted by the current converter instance. - - - Converts an object or value to or from JSON. - The type of object or value handled by the converter. - - - Initializes a new instance. - - - Determines whether the specified type can be converted. - The type to compare against. - - if the type can be converted; otherwise, . - - - Reads and converts the JSON to type . - The reader. - The type to convert. - An object that specifies serialization options to use. - The converted value. - - - Reads a dictionary key from a JSON property name. - The to read from. - The type to convert. - The options to use when reading the value. - The value that was converted. - - - Writes a specified value as JSON. - The writer to write to. - The value to convert to JSON. - An object that specifies serialization options to use. - - - Writes a dictionary key as a JSON property name. - The to write to. - The value to convert. The value of determines if the converter handles values. - The options to use when writing the value. - - - Gets a value that indicates whether should be passed to the converter on serialization, and whether should be passed on deserialization. - - - Gets the type being converted by the current converter instance. - - - When placed on a property or type, specifies the converter type to use. - - - Initializes a new instance of . - - - Initializes a new instance of with the specified converter type. - The type of the converter. - - - When overridden in a derived class and is , allows the derived class to create a in order to pass additional state. - The type of the converter. - The custom converter. - - - Gets the type of the , or if it was created without a type. - The type of the , or if it was created without a type. - - - Supports converting several types by using a factory pattern. - - - When overridden in a derived class, initializes a new instance of the class. - - - Creates a converter for a specified type. - The type handled by the converter. - The serialization options to use. - A converter for which is compatible with . - - - Gets the type being converted by the current converter instance. - - - When placed on a type declaration, indicates that the specified subtype should be opted into polymorphic serialization. - - - Initializes a new attribute with specified parameters. - A derived type that should be supported in polymorphic serialization of the declared based type. - - - Initializes a new attribute with specified parameters. - A derived type that should be supported in polymorphic serialization of the declared base type. - The type discriminator identifier to be used for the serialization of the subtype. - - - Initializes a new attribute with specified parameters. - A derived type that should be supported in polymorphic serialization of the declared base type. - The type discriminator identifier to be used for the serialization of the subtype. - - - A derived type that should be supported in polymorphic serialization of the declared base type. - - - The type discriminator identifier to be used for the serialization of the subtype. - - - When placed on a property of type , any properties that do not have a matching member are added to that dictionary during deserialization and written during serialization. - - - Initializes a new instance of the class. - - - Prevents a property from being serialized or deserialized. - - - Initializes a new instance of . - - - Gets or sets the condition that must be met before a property will be ignored. - - - Controls how the ignores properties on serialization and deserialization. - - - Property is always ignored. - - - Property is always serialized and deserialized, regardless of configuration. - - - Property is ignored only if it equals the default value for its type. - - - Property is ignored if its value is . This is applied only to reference-type properties and fields. - - - Indicates that the member should be included for serialization and deserialization. - The attribute is applied to a non-public property. - - - Initializes a new instance of . - - - The to be used at run time. - - - Specifies that the built-in be used to convert JSON property names. - - - Specifies that the built-in be used to convert JSON property names. - - - Specifies that the built-in policy be used to convert JSON property names. - - - Specifies that the built-in policy be used to convert JSON property names. - - - Specifies that the built-in policy be used to convert JSON property names. - - - Specifies that JSON property names should not be converted. - - - Converter to convert enums to and from numeric values. - The enum type that this converter targets. - - - Initializes a new instance of . - - - When overridden in a derived class, determines whether the converter instance can convert the specified object type. - The type of the object to check whether it can be converted by this converter instance. - - true if the instance can convert the specified object type; otherwise, false. - - - Creates a converter for a specified type. - The type handled by the converter. - The serialization options to use. - A converter for which T is compatible with typeToConvert. - - - Determines how handles numbers when serializing and deserializing. - - - The "NaN", "Infinity", and "-Infinity" tokens can be read as floating-point constants, and the and values for these constants will be written as their corresponding JSON string representations. - - - Numbers can be read from tokens. Does not prevent numbers from being read from token. - - - Numbers will only be read from tokens and will only be written as JSON numbers (without quotes). - - - Numbers will be written as JSON strings (with quotes), not as JSON numbers. - - - When placed on a type, property, or field, indicates what settings should be used when serializing or deserializing numbers. - - - Initializes a new instance of . - A bitwise combination of the enumeration values that specify how number types should be handled when serializing or deserializing. - - - Indicates what settings should be used when serializing or deserializing numbers. - An object that determines the number serialization and deserialization settings. - - - Determines how deserialization will handle object creation for fields or properties. - - - Attempt to populate any instances already found on a deserialized field or property. - - - A new instance will always be created when deserializing a field or property. - - - Determines how deserialization handles object creation for fields or properties. - - - Initializes a new instance of . - The handling to apply to the current member. - - - Gets the configuration to use when deserializing members. - - - When placed on a type, indicates that the type should be serialized polymorphically. - - - Creates a new instance. - - - Gets or sets a value that indicates whether the deserializer should ignore any unrecognized type discriminator IDs and revert to the contract of the base type. - - to instruct the deserializer to ignore any unrecognized type discriminator IDs and revert to the contract of the base type; to fail the deserialization for unrecognized type discriminator IDs. - - - Gets or sets a custom type discriminator property name for the polymorhic type. - Uses the default '$type' property name if left unset. - - - Gets or sets the behavior when serializing an undeclared derived runtime type. - - - Specifies the property name that is present in the JSON when serializing and deserializing. This overrides any naming policy specified by . - - - Initializes a new instance of with the specified property name. - The name of the property. - - - Gets the name of the property. - The name of the property. - - - Specifies the property order that is present in the JSON when serializing. Lower values are serialized first. - If the attribute is not specified, the default value is 0. - - - Initializes a new instance of with the specified order. - The order of the property. - - - Gets the serialization order of the property. - The serialization order of the property. - - - Indicates that the annotated member must bind to a JSON property on deserialization. - - - Initializes a new instance of . - - - Instructs the System.Text.Json source generator to generate source code to help optimize performance when serializing and deserializing instances of the specified type and types in its object graph. - - - Initializes a new instance of with the specified type. - The type to generate source code for. - - - Gets or sets the mode that indicates what the source generator should generate for the type. If the value is , then the setting specified on will be used. - - - Gets or sets the name of the property for the generated for the type on the generated, derived type. - - - Provides metadata about a set of types that is relevant to JSON serialization. - - - Creates an instance of and binds it with the indicated . - The run time provided options for the context instance. - - - Gets metadata for the specified type. - The type to fetch metadata for. - The metadata for the specified type, or if the context has no metadata for the type. - - - Resolves a contract for the requested type and options. - The type to be resolved. - The configuration to use when resolving the metadata. - A instance matching the requested type, or if no contract could be resolved. - - - Gets the default run-time options for the context. - - - Gets the run-time specified options of the context. If no options were passed when instantiating the context, then a new instance is bound and returned. - - - The generation mode for the System.Text.Json source generator. - - - When specified on , indicates that both type-metadata initialization logic and optimized serialization logic should be generated for all types. When specified on , indicates that the setting on should be used. - - - Instructs the JSON source generator to generate type-metadata initialization logic. - - - Instructs the JSON source generator to generate optimized serialization logic. - - - Instructs the System.Text.Json source generator to assume the specified options will be used at run time via . - - - Initializes a new instance of . - - - Constructs a new instance with a predefined set of options determined by the specified . - The to reason about. - - is invalid. - - - Gets or sets the default value of . - - - Gets or sets the default value of . - - - Gets or sets the default value of . - - - Gets or sets the default ignore condition. - - - Gets or sets the default value of . - - - Gets or sets the source generation mode for types that don't explicitly set the mode with . - - - Gets or sets a value that indicates whether to ignore read-only fields. - - - Gets or sets a value that indicates whether to ignore read-only properties. - - - Gets or sets a value that indicates whether to include fields for serialization and deserialization. - - - Gets or sets the default value of . - - - Gets or sets the default value of . - - - Gets or sets the default value of . - - - Gets or sets the default value of . - - - Gets or sets a built-in naming policy to convert JSON property names with. - - - Gets or sets the default value of . - - - Gets or sets the default value of . - - - Gets or sets the default value of . - - - Gets or sets a value that indicates whether the source generator defaults to instead of numeric serialization for all enum types encountered in its type graph. - - - Gets or sets a value that indicates whether JSON output is pretty-printed. - - - Converts enumeration values to and from strings. - - - Initializes an instance of the class with the default naming policy that allows integer values. - - - Initializes an instance of the class with a specified naming policy and a value that indicates whether undefined enumeration values are allowed. - The optional naming policy for writing enum values. - - to allow undefined enum values; otherwise, . When , if an enum value isn't defined, it will output as a number rather than a string. - - - Determines whether the specified type can be converted to an enum. - The type to be checked. - - true if the type can be converted; otherwise, false. - - - Creates a converter for the specified type. - The type handled by the converter. - The serialization options to use. - A converter for which T is compatible with typeToConvert. - - - Converter to convert enums to and from strings. - The enum type that this converter targets. - - - Initializes a new instance of with the default naming policy and that allows integer values. - - - Initializes a new instance of . - Optional naming policy for writing enum values. - - to allow undefined enum values. When , if an enum value isn't defined, it outputs as a number rather than a string. - - - When overridden in a derived class, determines whether the converter instance can convert the specified object type. - The type of the object to check whether it can be converted by this converter instance. - - true if the instance can convert the specified object type; otherwise, false. - - - Creates a converter for a specified type. - The type handled by the converter. - The serialization options to use. - A converter for which T is compatible with typeToConvert. - - - Defines how objects of a derived runtime type that has not been explicitly declared for polymorphic serialization should be handled. - - - An object of undeclared runtime type will fail polymorphic serialization. - - - An object of undeclared runtime type will fall back to the serialization contract of the base type. - - - An object of undeclared runtime type will revert to the serialization contract of the nearest declared ancestor type. - Certain interface hierarchies are not supported due to diamond ambiguity constraints. - - - Defines how deserializing a type declared as an is handled during deserialization. - - - A type declared as is deserialized as a . - - - A type declared as is deserialized as a . - - - Determines how handles JSON properties that cannot be mapped to a specific .NET member when deserializing object types. - - - Throws an exception when an unmapped property is encountered. - - - Silently skips any unmapped properties. This is the default behavior. - - - When placed on a type, determines the configuration for the specific type, overriding the global setting. - - - Initializes a new instance of . - The handling to apply to the current member. - - - Gets the unmapped member handling setting for the attribute. - - - Defines the default, reflection-based JSON contract resolver used by System.Text.Json. - - - Creates a mutable instance. - - - Resolves a JSON contract for a given and configuration. - The type for which to resolve a JSON contract. - A instance used to determine contract configuration. - - or is . - A defining a reflection-derived JSON contract for . - - - Gets a list of user-defined callbacks that can be used to modify the initial contract. - - - Used to resolve the JSON serialization contract for requested types. - - - Resolves a contract for the requested type and options. - Type to be resolved. - Configuration used when resolving the metadata. - A instance matching the requested type, or if no contract could be resolved. - - - Provides serialization metadata about a collection type. - The collection type. - - - - A instance representing the element type. - - - If a dictionary type, the instance representing the key type. - - - The option to apply to number collection elements. - - - A to create an instance of the collection when deserializing. - - - An optimized serialization implementation assuming pre-determined defaults. - - - Represents a supported derived type defined in the metadata of a polymorphic type. - - - Initializes a new instance of the class that represents a supported derived type without a type discriminator. - The derived type to be supported by the polymorphic type metadata. - - - Initializes a new instance of the class that represents a supported derived type with an integer type discriminator. - The derived type to be supported by the polymorphic type metadata. - The type discriminator to be associated with the derived type. - - - Initializes a new instance of the class that represents a supported derived type with a string type discriminator. - The derived type to be supported by the polymorphic type metadata. - The type discriminator to be associated with the derived type. - - - Gets a derived type that should be supported in polymorphic serialization of the declared base type. - - - Gets the type discriminator identifier to be used for the serialization of the subtype. - - - Provides helpers to create and initialize metadata for JSON-serializable types. - - - Creates serialization metadata for an array. - The serialization and deserialization options to use. - Provides serialization metadata about the collection type. - The generic definition of the element type. - Serialization metadata for the given type. - - - Creates metadata for types assignable to . - The serialization and deserialization options to use. - Provides serialization metadata about the collection type. - The generic definition of the type. - The generic definition of the element type. - Serialization metadata for the given type. - - - Creates metadata for types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - The generic definition of the type. - The generic definition of the element type. - Serialization metadata for the given type. - - - Creates metadata for types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - The generic definition of the type. - The generic definition of the key type. - The generic definition of the value type. - Serialization metadata for the given type. - - - Creates serialization metadata for types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - The generic definition of the type. - The generic definition of the element type. - Serialization metadata for the given type. - - - Creates metadata for types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - The generic definition of the type. - The generic definition of the element type. - Serialization metadata for the given type. - - - Creates metadata for types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - The generic definition of the type. - Serialization metadata for the given type. - - - Creates metadata for types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - The generic definition of the type. - The generic definition of the key type. - The generic definition of the value type. - Serialization metadata for the given type. - - - Creates metadata for types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - The generic definition of the type. - Serialization metadata for the given type. - - - Creates metadata for types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - The generic definition of the type. - The generic definition of the element type. - Serialization metadata for the given type. - - - Creates metadata for types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - The generic definition of the type. - Serialization metadata for the given type. - - - Creates metadata for types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - The generic definition of the type. - The generic definition of the element type. - Serialization metadata for the given type. - - - Creates metadata for and types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - A method to create an immutable dictionary instance. - The generic definition of the type. - The generic definition of the key type. - The generic definition of the value type. - Serialization metadata for the given type. - - - Creates metadata for non-dictionary immutable collection types. - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - A method to create an immutable dictionary instance. - The generic definition of the type. - The generic definition of the element type. - Serialization metadata for the given type. - - - Creates metadata for types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - The generic definition of the type. - The generic definition of the key type. - The generic definition of the value type. - Serialization metadata for the given type. - - - Creates metadata for types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - The generic definition of the type. - The generic definition of the element type. - Serialization metadata for the given type. - - - Creates metadata for types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - The generic definition of the type. - The generic definition of the element type. - Serialization metadata for the given type. - - - Creates serialization metadata for . - The to use. - Provides serialization metadata about the collection type. - The generic definition of the element type. - Serialization metadata for the given type. - - - Creates metadata for a complex class or struct. - The to use for serialization and deserialization. - Provides serialization metadata about an object type with constructors, properties, and fields. - The type of the class or struct. - - or is . - A instance representing the class or struct. - - - Creates metadata for a property or field. - The to use for serialization and deserialization. - Provides serialization metadata about the property or field. - The type that the converter for the property returns or accepts when converting JSON data. - A instance initialized with the provided metadata. - - - Creates metadata for types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - A method for adding elements to the collection when using the serializer's code-paths. - The generic definition of the type. - Serialization metadata for the given type. - - - Creates metadata for types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - The generic definition of the type. - The generic definition of the element type. - Serialization metadata for the given type. - - - Creates serialization metadata for . - The to use. - Provides serialization metadata about the collection type. - The generic definition of the element type. - Serialization metadata for the given type. - - - Creates metadata for types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - A method for adding elements to the collection when using the serializer's code-paths. - The generic definition of the type. - Serialization metadata for the given type. - - - Creates metadata for types assignable to . - The to use for serialization and deserialization. - Provides serialization metadata about the collection type. - The generic definition of the type. - The generic definition of the element type. - Serialization metadata for the given type. - - - Creates metadata for a primitive or a type with a custom converter. - The to use for serialization and deserialization. - - The generic type definition. - A instance representing the type. - - - Creates a instance that converts values. - The to use for serialization and deserialization. - The generic definition for the enum type. - A instance that converts values. - - - Creates a instance that converts values. - The to use for serialization and deserialization. - The generic definition for the underlying nullable type. - A instance that converts values - - - Creates a instance that converts values. - Serialization metadata for the underlying nullable type. - The generic definition for the underlying nullable type. - A instance that converts values - - - Gets a type converter that throws a . - The generic definition for the type. - A instance that throws - - - Gets an object that converts values. - - - Gets an object that converts byte array values. - - - Gets an object that converts values. - - - Gets an object that converts values. - - - Returns a instance that converts values. - - - Gets an object that converts values. - An instance that converts values. - - - Gets an object that converts values. - - - Gets an object that converts values. - - - Gets an object that converts values. - - - Gets an object that converts values. - - - Returns a instance that converts values. - - - Returns a instance that converts values. - - - Gets an object that converts values. - - - Gets an object that converts values. - - - Gets an object that converts values. - - - Gets an object that converts values. - - - Returns a instance that converts values. - - - Gets a JSON converter that converts values. - - - Gets an object that converts values. - - - Gets an object that converts values. - - - Gets an object that converts values. - - - Returns a instance that converts values. - - - Gets an object that converts values. - - - Returns a instance that converts values. - - - Gets an object that converts values. - - - Gets an object that converts values. - - - Gets an object that converts values. - - - Returns a instance that converts values. - - - Gets a JSON converter that converts values. - - - Returns a instance that converts values. - - - Gets an object that converts values. - - - Gets an object that converts values. - - - Gets an object that converts values. - - - Gets an object that converts values. - - - Gets an object that converts values. - - - Provides serialization metadata about an object type with constructors, properties, and fields. - The object type to serialize or deserialize. - - - - Provides a mechanism to initialize metadata for a parameterized constructor of the class or struct to be used when deserializing. - - - Gets or sets an object that specifies how number properties and fields should be processed when serializing and deserializing. - - - Gets or sets a mechanism to create an instance of the class or struct using a parameterless constructor during deserialization. - - - Gets or sets a mechanism to create an instance of the class or struct using a parameterized constructor during deserialization. - - - Gets or sets a mechanism to initialize metadata for properties and fields of the class or struct. - - - Gets or sets a serialization implementation for instances of the class or struct that assumes options specified by . - - - Provides information about a constructor parameter required for JSON deserialization. - - - - Gets or sets the default value of the parameter. - - - Gets or sets a value that specifies whether a default value was specified for the parameter. - - - Gets or sets the name of the parameter. - - - Gets or sets the type of the parameter. - - - Gets or sets the zero-based position of the parameter in the formal parameter list. - - - Defines polymorphic configuration for a specified base type. - - - Creates an empty instance. - - - Gets the list of derived types supported in the current polymorphic type configuration. - - - Gets or sets a value that indicates whether the serializer should ignore any unrecognized type discriminator IDs and revert to the contract of the base type. - The parent instance has been locked for further modification. - - if the serializer should ignore any unrecognized type discriminator IDs and revert to the contract of the base type; if the deserialization should fail when an unrecognized type discriminator ID is encountered. - - - Gets or sets a custom type discriminator property name for the polymorhic type. - Uses the default '$type' property name if left unset. - The parent instance has been locked for further modification. - - - Gets or sets the behavior when serializing an undeclared derived runtime type. - The parent instance has been locked for further modification. - - - Provides JSON serialization-related metadata about a property or field. - - - Gets or sets the custom attribute provider for the current property. - The instance has been locked for further modification. - - - Gets or sets a custom converter override for the current property. - The instance has been locked for further modification. - - - Gets or sets a getter delegate for the property. - The instance has been locked for further modification. - - - Gets or sets a value that indicates whether the current property is a special extension data property. - The instance has been locked for further modification. - --or- - -The current is not valid for use with extension data. - - - Gets or sets a value that indicates whether the current property is required for deserialization to be successful. - The instance has been locked for further modification. - - - Gets or sets the JSON property name used when serializing the property. - - is . - The instance has been locked for further modification. - - - Gets or sets the applied to the current property. - The instance has been locked for further modification. - - - Gets or sets a value indicating if the property or field should be replaced or populated during deserialization. - - - Gets the value associated with the current contract instance. - - - Gets or sets the serialization order for the current property. - The instance has been locked for further modification. - - - Gets the type of the current property. - - - Gets or sets a setter delegate for the property. - The instance has been locked for further modification. - - - Gets or sets a predicate that determines whether the current property value should be serialized. - The instance has been locked for further modification. - - - Provides serialization metadata about a property or field. - The type to convert of the for the property. - - - - A for the property or field, specified by . - - - The declaring type of the property or field. - - - Provides a mechanism to get the property or field's value. - - - Whether the property was annotated with . - - - Specifies a condition for the member to be ignored. - - - Whether the property was annotated with . - - - If , indicates that the member is a property, otherwise indicates the member is a field. - - - Whether the property or field is public. - - - Whether the property or field is a virtual property. - - - The name to be used when processing the property or field, specified by . - - - If the property or field is a number, specifies how it should processed when serializing and deserializing. - - - The name of the property or field. - - - The info for the property or field's type. - - - Provides a mechanism to set the property or field's value. - - - Provides JSON serialization-related metadata about a type. - - - Creates a blank instance for the current . - The declared type for the property. - The property name used in JSON serialization and deserialization. - - or is . - - cannot be used for serialization. - The instance has been locked for further modification. - A blank instance. - - - Creates a blank instance. - The type for which contract metadata is specified. - The instance the metadata is associated with. - - or is . - - cannot be used for serialization. - A blank instance. - - - Creates a blank instance. - The instance the metadata is associated with. - The type for which contract metadata is specified. - - is . - A blank instance. - - - Locks the current instance for further modification. - - - Gets the associated with the current type. - - - Gets or sets a parameterless factory to be used on deserialization. - The instance has been locked for further modification. - --or- - -A parameterless factory is not supported for the current metadata . - - - Gets a value that indicates whether the current instance has been locked for modification. - - - Gets a value that describes the kind of contract metadata that the current instance specifies. - - - Gets or sets the type-level override. - The instance has been locked for further modification. - An invalid value was specified. - - - Gets or sets a callback to be invoked after deserialization occurs. - The instance has been locked for further modification. - --or- - -Serialization callbacks are only supported for metadata. - - - Gets or sets a callback to be invoked before deserialization occurs. - The instance has been locked for further modification. - --or- - -Serialization callbacks are only supported for metadata. - - - Gets or sets a callback to be invoked after serialization occurs. - The instance has been locked for further modification. - --or- - -Serialization callbacks are only supported for metadata. - - - Gets or sets a callback to be invoked before serialization occurs. - The instance has been locked for further modification. - --or- - -Serialization callbacks are only supported for metadata. - - - Gets the value associated with the current instance. - - - Gets or sets the from which this metadata instance originated. - The instance has been locked for further modification. - - - Gets or sets a configuration object specifying polymorphism metadata. - - has been associated with a different instance. - The instance has been locked for further modification. - --or- - -Polymorphic serialization is not supported for the current metadata . - - - Gets or sets the preferred value for properties contained in the type. - The instance has been locked for further modification. - --or- - -Unmapped member handling is only supported for JsonTypeInfoKind.Object. - Specified an invalid value. - - - Gets the list of metadata corresponding to the current type. - - - Gets the for which the JSON serialization contract is being defined. - - - Gets or sets the type-level override. - The instance has been locked for further modification. - --or- - -Unmapped member handling is only supported for . - An invalid value was specified. - - - Provides JSON serialization-related metadata about a type. - The generic definition of the type. - - - Gets or sets a parameterless factory to be used on deserialization. - The instance has been locked for further modification. - --or- - -A parameterless factory is not supported for the current metadata . - - - Serializes an instance of using values specified at design time. - - - Describes the kind of contract metadata a specifies. - - - Type is serialized as a dictionary with key/value pair entries. - - - Type is serialized as a collection with elements. - - - Type is either a simple value or uses a custom converter. - - - Type is serialized as an object with properties. - - - Contains utilities and combinators acting on . - - - Combines multiple sources into one. - Sequence of contract resolvers to be queried for metadata. - - is . - A combining results from . - - - Creates a resolver and applies modifications to the metadata generated by the source . - The source resolver generating metadata. - The delegate that modifies non- results. - A new instance with modifications applied. - - - Defines how the deals with references on serialization and deserialization. - - - Initializes a new instance of the class. - - - Returns the used for each serialization call. - The resolver to use for serialization and deserialization. - - - Gets an object that indicates whether an object is ignored when a reference cycle is detected during serialization. - - - Gets an object that indicates whether metadata properties are honored when JSON objects and arrays are deserialized into reference types, and written when reference types are serialized. This is necessary to create round-trippable JSON from objects that contain cycles or duplicate references. - - - Defines how the deals with references on serialization and deserialization. - The type of the to create on each serialization or deserialization call. - - - Initializes a new instance of the generic class that can create a instance of the specified type. - - - Creates a new of type used for each serialization call. - The new resolver to use for serialization and deserialization. - - - Defines how the deals with references on serialization and deserialization. - Defines the core behavior of preserving references on serialization and deserialization. - - - Initializes a new instance of the class. - - - Adds an entry to the bag of references using the specified id and value. - This method gets called when an $id metadata property from a JSON object is read. - The identifier of the JSON object or array. - The value of the CLR reference type object that results from parsing the JSON object. - - - Gets the reference identifier of the specified value if exists; otherwise a new id is assigned. - This method gets called before a CLR object is written so we can decide whether to write $id and enumerate the rest of its properties or $ref and step into the next object. - The value of the CLR reference type object to get an id for. - When this method returns, if a reference to value already exists; otherwise, . - The reference id for the specified object. - - - Returns the CLR reference type object related to the specified reference id. - This method gets called when $ref metadata property is read. - The reference id related to the returned object. - The reference type object related to the specified reference id. - - - Provides a high-performance API for forward-only, read-only access to UTF-8 encoded JSON text. - - - Initializes a new instance of the structure that processes a read-only sequence of UTF-8 encoded text and indicates whether the input contains all the text to process. - The UTF-8 encoded JSON text to process. - - to indicate that the input sequence contains the entire data to process; to indicate that the input span contains partial data with more data to follow. - The reader state. If this is the first call to the constructor, pass the default state; otherwise, pass the value of the property from the previous instance of the . - - - Initializes a new instance of the structure that processes a read-only sequence of UTF-8 encoded text using the specified options. - The UTF-8 encoded JSON text to process. - Options that define customized behavior of the that differs from the JSON RFC (for example, how to handle comments or maximum depth allowed when reading). By default, the follows the JSON RFC strictly; comments within the JSON are invalid, and the maximum depth is 64. - - - Initializes a new instance of the structure that processes a read-only span of UTF-8 encoded text and indicates whether the input contains all the text to process. - The UTF-8 encoded JSON text to process. - - to indicate that the input sequence contains the entire data to process; to indicate that the input span contains partial data with more data to follow. - The reader state. If this is the first call to the constructor, pass the default state; otherwise, pass the value of the property from the previous instance of the . - - - Initializes a new instance of the structure that processes a read-only span of UTF-8 encoded text using the specified options. - The UTF-8 encoded JSON text to process. - Options that define customized behavior of the that differs from the JSON RFC (for example, how to handle comments or maximum depth allowed when reading). By default, the follows the JSON RFC strictly; comments within the JSON are invalid, and the maximum depth is 64. - - - Copies the current JSON token value from the source, unescaped, as UTF-8 bytes to a buffer. - A buffer to write the unescaped UTF-8 bytes into. - The JSON token is not a string, that is, it's not or . - --or- - -The JSON string contains invalid UTF-8 bytes or invalid UTF-16 surrogates. - The destination buffer is too small to hold the unescaped value. - The number of bytes written to . - - - Copies the current JSON token value from the source, unescaped, as UTF-16 characters to a buffer. - A buffer to write the transcoded UTF-16 characters into. - The JSON token is not a string, that is, it's not or . - --or- - -The JSON string contains invalid UTF-8 bytes or invalid UTF-16 surrogates. - The destination buffer is too small to hold the unescaped value. - The number of characters written to . - - - Reads the next JSON token value from the source as a . - The value of the JSON token isn't a Boolean value (that is, or ). - - if the is ; if the is . - - - Parses the current JSON token value from the source as a . - The value of the JSON token is not a . - The numeric format of the JSON token value is incorrect (for example, it contains a fractional value or is written in scientific notation). - --or- - -The JSON token value represents a number less than Byte.MinValue or greater than Byte.MaxValue. - The value of the UTF-8 encoded token. - - - Parses the current JSON token value from the source and decodes the Base64 encoded JSON string as a byte array. - The type of the JSON token is not a . - The value is not encoded as Base64 text, so it can't be decoded to bytes. - --or- - -The value contains invalid or more than two padding characters. - --or- - -The value is incomplete. That is, the JSON string length is not a multiple of 4. - The byte array that represents the current JSON token value. - - - Parses the current JSON token value from the source as a comment and transcodes it as a . - The JSON token is not a comment. - The comment that represents the current JSON token value. - - - Reads the next JSON token value from the source and parses it to a . - The value of the JSON token isn't a . - The JSON token value cannot be read as a . - --or- - -The entire UTF-8 encoded token value cannot be parsed to a value. - --or- - -The JSON token value is of an unsupported format. - The date and time value, if the entire UTF-8 encoded token value can be successfully parsed. - - - Reads the next JSON token value from the source and parses it to a . - The value of the JSON token isn't a . - The JSON token value cannot be read as a . - --or- - -The entire UTF-8 encoded token value cannot be parsed to a value. - --or- - -The JSON token value is of an unsupported format. - The date and time offset, if the entire UTF-8 encoded token value can be successfully parsed. - - - Reads the next JSON token value from the source and parses it to a . - The JSON token value isn't a . - The JSON token value represents a number less than Decimal.MinValue or greater than Decimal.MaxValue. - The UTF-8 encoded token value parsed to a . - - - Reads the next JSON token value from the source and parses it to a . - The JSON token value isn't a . - The JSON token value represents a number less than Double.MinValue or greater than Double.MaxValue. - The UTF-8 encoded token value parsed to a . - - - Reads the next JSON token value from the source and parses it to a . - The value of the JSON token isn't a . - The JSON token value is in an unsupported format for a Guid. - --or- - -The entire UTF-8 encoded token value cannot be parsed to a value. - The GUID value, if the entire UTF-8 encoded token value can be successfully parsed. - - - Parses the current JSON token value from the source as a . - The value of the JSON token is not a . - The numeric format of the JSON token value is incorrect (for example, it contains a fractional value or is written in scientific notation). - --or- - -The JSON token value represents a number less than Int16.MinValue or greater than Int16.MaxValue. - The UTF-8 encoded token value parsed to an . - - - Reads the next JSON token value from the source and parses it to an . - The JSON token value isn't a . - The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation. - --or- - -The JSON token value represents a number less than Int32.MinValue or greater than Int32.MaxValue. - The UTF-8 encoded token value parsed to an . - - - Reads the next JSON token value from the source and parses it to an . - The JSON token value isn't a . - The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation. - --or- - -The JSON token value represents a number less than Int64.MinValue or greater than Int64.MaxValue. - The UTF-8 encoded token value parsed to an . - - - Parses the current JSON token value from the source as an . - The value of the JSON token is not a . - The numeric format of the JSON token value is incorrect (for example, it contains a fractional value or is written in scientific notation). - --or- - -The JSON token value represents a number less than SByte.MinValue or greater than SByte.MaxValue. - The UTF-8 encoded token value parsed to an . - - - Reads the next JSON token value from the source and parses it to a . - The JSON token value isn't a . - The JSON token value represents a number less than Single.MinValue or greater than Single.MaxValue. - The UTF-8 encoded token value parsed to a . - - - Reads the next JSON token value from the source unescaped and transcodes it as a string. - The JSON token value isn't a string (that is, not a , , or ). - --or- - -The JSON string contains invalid UTF-8 bytes or invalid UTF-16 surrogates. - The token value parsed to a string, or if is . - - - Parses the current JSON token value from the source as a . - The value of the JSON token is not a . - The numeric format of the JSON token value is incorrect (for example, it contains a fractional value or is written in scientific notation). - --or- - -The JSON token value represents a number less than UInt16.MinValue or greater than UInt16.MaxValue. - The UTF-8 encoded token value parsed to a . - - - Reads the next JSON token value from the source and parses it to a . - The JSON token value isn't a . - The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation. - --or- - -The JSON token value represents a number less than UInt32.MinValue or greater than UInt32.MaxValue. - The UTF-8 encoded token value parsed to a . - - - Reads the next JSON token value from the source and parses it to a . - The JSON token value isn't a . - The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation. - --or- - -The JSON token value represents a number less than UInt64.MinValue or greater than UInt64.MaxValue. - The UTF-8 encoded token value parsed to a . - - - Reads the next JSON token from the input source. - An invalid JSON token according to the JSON RFC is encountered. - --or- - -The current depth exceeds the recursive limit set by the maximum depth. - - if the token was read successfully; otherwise, . - - - Skips the children of the current JSON token. - The reader was given partial data with more data to follow (that is, is ). - An invalid JSON token was encountered while skipping, according to the JSON RFC. - --or- - -The current depth exceeds the recursive limit set by the maximum depth. - - - Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. - When this method returns, contains the byte equivalent of the current JSON number if the conversion succeeded, or 0 if the conversion failed. - The JSON token value isn't a . - - if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . - - - Tries to parse the current JSON token value from the source and decodes the Base64 encoded JSON string as a byte array and returns a value that indicates whether the operation succeeded. - When this method returns, contains the decoded binary representation of the Base64 text. - The JSON token is not a . - - if the entire token value is encoded as valid Base64 text and can be successfully decoded to bytes; otherwise, . - - - Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. - When this method returns, contains the date and time value equivalent to the current JSON string if the conversion succeeded, or if the conversion failed. - The value of the JSON token isn't a . - - if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . - - - Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. - When this method returns, contains the date and time value equivalent to the current JSON string if the conversion succeeded, or if the conversion failed. - The value of the JSON token isn't a . - - if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . - - - Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. - When this method returns, contains the decimal equivalent of the current JSON number if the conversion succeeded, or 0 if the conversion failed. - The JSON token value isn't a . - - if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . - - - Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. - When this method returns, contains a double-precision floating point value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed. - The JSON token value isn't a . - - if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . - - - Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. - When this method returns, contains the GUID equivalent to the current JSON string if the conversion succeeded, or if the conversion failed. - The value of the JSON token isn't a . - - if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . - - - Tries to parse the current JSON token value from the source as an and returns a value that indicates whether the operation succeeded. - When this method returns, contains the 16-bit integer value equivalent of the current JSON number if the conversion succeeded, or 0 if the conversion failed. - The JSON token value isn't a . - - if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . - - - Tries to parse the current JSON token value from the source as an and returns a value that indicates whether the operation succeeded. - When this method returns, contains the 32-bit integer value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed. - The JSON token value isn't a . - - if the entire UTF-8 encoded token value can be successfully parsed to an value; otherwise, . - - - Tries to parse the current JSON token value from the source as an and returns a value that indicates whether the operation succeeded. - When this method returns, contains the 64-bit integer value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed. - The JSON token value isn't a . - - if the entire UTF-8 encoded token value can be successfully parsed to an value; otherwise, . - - - Tries to parse the current JSON token value from the source as an and returns a value that indicates whether the operation succeeded. - When this method returns, contains the signed byte equivalent of the current JSON number if the conversion succeeded, or 0 if the conversion failed. - The JSON token value isn't a . - - if the entire UTF-8 encoded token value can be successfully parsed to an value; otherwise, . - - - Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. - When this method returns, contains the single-precision floating point value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed. - The JSON token value isn't a . - - if the entire UTF-8 encoded token value can be successfully parsed to an value; otherwise, . - - - Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. - When this method returns, contains the unsigned 16-bit integer value equivalent of the current JSON number if the conversion succeeded, or 0 if the conversion failed. - The JSON token value isn't a . - - if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . - - - Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. - When this method returns, contains unsigned 32-bit integer value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed. - The JSON token value isn't a . - - if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . - - - Tries to parse the current JSON token value from the source as a and returns a value that indicates whether the operation succeeded. - When this method returns, contains unsigned 64-bit integer value equivalent to the current JSON number if the conversion succeeded, or 0 if the conversion failed. - The JSON token value isn't a . - - if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . - - - Tries to skip the children of the current JSON token. - An invalid JSON token was encountered while skipping, according to the JSON RFC. - --or - - -The current depth exceeds the recursive limit set by the maximum depth. - - if there was enough data for the children to be skipped successfully; otherwise, . - - - Compares the UTF-8 encoded text in a read-only byte span to the unescaped JSON token value in the source and returns a value that indicates whether they match. - The UTF-8 encoded text to compare against. - The JSON token is not a JSON string (that is, it is not or ). - - if the JSON token value in the source matches the UTF-8 encoded lookup text; otherwise, . - - - Compares the text in a read-only character span to the unescaped JSON token value in the source and returns a value that indicates whether they match. - The text to compare against. - The JSON token is not a JSON string (that is, it is not or ). - - if the JSON token value in the source matches the lookup text; otherwise, . - - - Compares the string text to the unescaped JSON token value in the source and returns a value that indicates whether they match. - The text to compare against. - The JSON token is not a JSON string (that is, it is not or ). - - if the JSON token value in the source matches the lookup text; otherwise, . - - - Gets the total number of bytes consumed so far by this instance of the . - The total number of bytes consumed so far. - - - Gets the depth of the current token. - The depth of the current token. - - - Gets the current state to pass to a constructor with more data. - The current reader state. - - - Gets a value that indicates which Value property to use to get the token value. - - if should be used to get the token value; if should be used instead. - - - Gets a value that indicates whether all the JSON data was provided or there is more data to come. - - if the reader was constructed with the input span or sequence containing the entire JSON data to process; if the reader was constructed with an input span or sequence that may contain partial JSON data with more data to follow. - - - Gets the current within the provided UTF-8 encoded input ReadOnlySequence<byte> or a default if the struct was constructed with a ReadOnlySpan<byte>. - The current within the provided UTF-8 encoded input ReadOnlySequence<byte> or a default if the struct was constructed with a ReadOnlySpan<byte>. - - - Gets the index that the last processed JSON token starts at (within the given UTF-8 encoded input text), skipping any white space. - The starting index of the last processed JSON token within the given UTF-8 encoded input text. - - - Gets the type of the last processed JSON token in the UTF-8 encoded JSON text. - The type of the last processed JSON token. - - - Gets a value that indicates whether the current or properties contain escape sequences per RFC 8259 section 7, and therefore require unescaping before being consumed. - - - Gets the raw value of the last processed token as a ReadOnlySequence<byte> slice of the input payload, only if the token is contained within multiple segments. - A byte read-only sequence. - - - Gets the raw value of the last processed token as a ReadOnlySpan<byte> slice of the input payload, if the token fits in a single segment or if the reader was constructed with a JSON payload contained in a ReadOnlySpan<byte>. - A read-only span of bytes. - - - Provides a high-performance API for forward-only, non-cached writing of UTF-8 encoded JSON text. - - - Initializes a new instance of the class using the specified to write the output to and customization options. - The destination for writing JSON text. - Defines the customized behavior of the . By default, it writes minimized JSON (with no extra white space) and validates that the JSON being written is structurally valid according to the JSON RFC. - - is . - - - Initializes a new instance of the class using the specified stream to write the output to and customization options. - The destination for writing JSON text. - Defines the customized behavior of the . By default, it writes minimized JSON (with no extra white space) and validates that the JSON being written is structurally valid according to the JSON RFC. - - is . - - - Commits any leftover JSON text that has not yet been flushed and releases all resources used by the current instance. - - - Asynchronously commits any leftover JSON text that has not yet been flushed and releases all resources used by the current instance. - A task representing the asynchronous dispose operation. - - - Commits the JSON text written so far, which makes it visible to the output destination. - This instance has been disposed. - - - Asynchronously commits the JSON text written so far, which makes it visible to the output destination. - The token to monitor for cancellation requests. The default value is . - This instance has been disposed. - A task representing the asynchronous flush operation. - - - Resets the internal state of this instance so that it can be reused. - This instance has been disposed. - - - Resets the internal state of this instance so that it can be reused with a new instance of . - The destination for writing JSON text. - - is . - This instance has been disposed. - - - Resets the internal state of this instance so that it can be reused with a new instance of . - The destination for writing JSON text. - - is . - This instance has been disposed. - - - Writes the property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object. - The UTF-8 encoded name of the property to write. - The binary data to write as Base64 encoded text. - The specified property name or value is too large. - Validation is enabled, and this method would result in writing invalid JSON. - - - Writes the property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object. - The property name of the JSON object to be transcoded and written as UTF-8. - The binary data to write as Base64 encoded text. - The specified property name or value is too large. - Validation is enabled, and this method would result in writing invalid JSON. - - - Writes the property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object. - The property name of the JSON object to be transcoded and written as UTF-8. - The binary data to write as Base64 encoded text. - The specified property name or value is too large. - Validation is enabled, and this method would result in writing invalid JSON. - The parameter is . - - - Writes the pre-encoded property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object. - The JSON-encoded name of the property to write. - The binary data to write as Base64 encoded text. - The specified value is too large. - Validation is enabled, and this method would result in writing invalid JSON. - - - Writes the raw bytes value as a Base64 encoded JSON string as an element of a JSON array. - The binary data to be written as a Base64 encoded JSON string element of a JSON array. - The specified value is too large. - Validation is enabled, and this method would result in writing invalid JSON. - - - Writes a property name specified as a read-only span of bytes and a value (as a JSON literal true or false) as part of a name/value pair of a JSON object. - The UTF-8 encoded property name of the JSON object to be written. - The value to be written as a JSON literal true or false as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the operation would result in writing invalid JSON. - - - Writes a property name specified as a read-only character span and a value (as a JSON literal true or false) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON literal true or false as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the operation would result in writing invalid JSON. - - - Writes a property name specified as a string and a value (as a JSON literal true or false) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON literal true or false as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the operation would result in writing invalid JSON. - The parameter is . - - - Writes the pre-encoded property name and value (as a JSON literal true or false) as part of a name/value pair of a JSON object. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON literal true or false as part of the name/value pair. - Validation is enabled, and this method would result in writing invalid JSON. - - - Writes a value (as a JSON literal true or false) as an element of a JSON array. - The value to be written as a JSON literal true or false as an element of a JSON array. - Validation is enabled, and the operation would result in writing invalid JSON. - - - Writes a UTF-8 text value as a JSON comment. - The UTF-8 encoded value to be written as a JSON comment within /*..*/. - The specified value is too large. - --or- - - contains a comment delimiter (that is, */). - - - Writes a UTF-16 text value as a JSON comment. - The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within /*..*/. - The specified value is too large. - --or- - - contains a comment delimiter (that is, */). - - - Writes a string text value as a JSON comment. - The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within /*..*/. - The specified value is too large. - --or- - - contains a comment delimiter (that is, */). - The parameter is . - - - Writes the end of a JSON array. - Validation is enabled, and the operation would result in writing invalid JSON. - - - Writes the end of a JSON object. - Validation is enabled, and the operation would result in writing invalid JSON. - - - Writes a property name specified as a read-only span of bytes and the JSON literal null as part of a name/value pair of a JSON object. - The UTF-8 encoded property name of the JSON object to be written. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a read-only character span and the JSON literal null as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a string and the JSON literal null as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - The parameter is . - - - Writes the pre-encoded property name and the JSON literal null as part of a name/value pair of a JSON object. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - Validation is enabled, and this method would result in writing invalid JSON. - - - Writes the JSON literal null as an element of a JSON array. - Validation is enabled, and the operation would result in writing invalid JSON. - - - Writes a property name specified as a read-only span of bytes and a value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-8 encoded property name of the JSON object to be written. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a read-only span of bytes and a value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-8 encoded property name of the JSON object to be written. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a read-only span of bytes and an value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-8 encoded property name of the JSON object to be written. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a read-only span of bytes and an value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-8 encoded property name of the JSON object to be written. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a read-only span of bytes and a value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-8 encoded property name of the JSON object to be written. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a read-only span of bytes and a value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-8 encoded property name of the JSON object to be written. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a read-only span of bytes and a value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-8 encoded property name of the JSON object to be written. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a read-only character span and a value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a read-only character span and a value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a read-only character span and an value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a read-only character span and an value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a read-only character span and a value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a read-only character span and a value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a read-only character span and a value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a string and a value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - The parameter is . - - - Writes a property name specified as a string and a value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - The parameter is . - - - Writes a property name specified as a string and an value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - The parameter is . - - - Writes a property name specified as a string and an value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - The parameter is . - - - Writes a property name specified as a string and a value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - The parameter is . - - - Writes a property name specified as a string and a value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - The parameter is . - - - Writes a property name specified as a string and a value (as a JSON number) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - The parameter is . - - - Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - Validation is enabled, and this method would result in writing invalid JSON. - - - Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - Validation is enabled, and this method would result in writing invalid JSON. - - - Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - Validation is enabled, and this method would result in writing invalid JSON. - - - Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - Validation is enabled, and this method would result in writing invalid JSON. - - - Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - Validation is enabled, and this method would result in writing invalid JSON. - - - Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - Validation is enabled, and this method would result in writing invalid JSON. - - - Writes the pre-encoded property name and value (as a JSON number) as part of a name/value pair of a JSON object. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON number as part of the name/value pair. - Validation is enabled, and this method would result in writing invalid JSON. - - - Writes a value (as a JSON number) as an element of a JSON array. - The value to be written as a JSON number as an element of a JSON array. - Validation is enabled, and the operation would result in writing invalid JSON. - - - Writes a value (as a JSON number) as an element of a JSON array. - The value to be written as a JSON number as an element of a JSON array. - Validation is enabled, and the operation would result in writing invalid JSON. - - - Writes an value (as a JSON number) as an element of a JSON array. - The value to be written as a JSON number as an element of a JSON array. - Validation is enabled, and the operation would result in writing invalid JSON. - - - Writes an value (as a JSON number) as an element of a JSON array. - The value to be written as a JSON number as an element of a JSON array. - Validation is enabled, and the operation would result in writing invalid JSON. - - - Writes a value (as a JSON number) as an element of a JSON array. - The value to be written as a JSON number as an element of a JSON array. - Validation is enabled, and the operation would result in writing invalid JSON. - - - Writes a value (as a JSON number) as an element of a JSON array. - The value to be written as a JSON number as an element of a JSON array. - Validation is enabled, and the operation would result in writing invalid JSON. - - - Writes a value (as a JSON number) as an element of a JSON array. - The value to be written as a JSON number as an element of a JSON array. - Validation is enabled, and the operation would result in writing invalid JSON. - - - Writes the UTF-8 property name (as a JSON string) as the first part of a name/value pair of a JSON object. - The UTF-8 encoded property name of the JSON object to be written. - The specified property name is too large. - Validation is enabled, and this write operation would produce invalid JSON. - - - Writes the property name (as a JSON string) as the first part of a name/value pair of a JSON object. - The property name of the JSON object to be transcoded and written as UTF-8. - The specified property name is too large. - Validation is enabled, and this write operation would produce invalid JSON. - - - Writes the property name (as a JSON string) as the first part of a name/value pair of a JSON object. - The property name of the JSON object to be transcoded and written as UTF-8. - The specified property name is too large. - Validation is enabled, and this write operation would produce invalid JSON. - - is . - - - Writes the pre-encoded property name (as a JSON string) as the first part of a name/value pair of a JSON object. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - Validation is enabled, and this write operation would produce invalid JSON. - - - Writes the input as JSON content. It is expected that the input content is a single complete JSON value. - The raw JSON content to write. - - to validate if the input is an RFC 8259-compliant JSON payload; to skip validation. - The length of the input is zero or equal to Int32.MaxValue. - - is , and the input - is not a valid, complete, single JSON value according to the JSON RFC - or the input JSON exceeds a recursive depth of 64. - - - Writes the input as JSON content. It is expected that the input content is a single complete JSON value. - The raw JSON content to write. - - to validate if the input is an RFC 8259-compliant JSON payload; otherwise. - The length of the input is zero or equal to Int32.MaxValue. - - is , and the input is not a valid, complete, single JSON value according to the JSON RFC, or the input JSON exceeds a recursive depth of 64. - - - Writes the input as JSON content. It is expected that the input content is a single complete JSON value. - The raw JSON content to write. - - to validate if the input is an RFC 8259-compliant JSON payload; otherwise. - The length of the input is zero or greater than 715,827,882 (Int32.MaxValue / 3). - - is , and the input is not a valid, complete, single JSON value according to the JSON RFC, or the input JSON exceeds a recursive depth of 64. - - - Writes the input as JSON content. It is expected that the input content is a single complete JSON value. - The raw JSON content to write. - - to validate if the input is an RFC 8259-compliant JSON payload; otherwise. - - is . - The length of the input is zero or greater than 715,827,882 (Int32.MaxValue / 3). - - is , and the input is not a valid, complete, single JSON value according to the JSON RFC, or the input JSON exceeds a recursive depth of 64. - - - Writes the beginning of a JSON array. - The depth of the JSON exceeds the maximum depth of 1,000. - --or- - -Validation is enabled, and this write operation would produce invalid JSON. - - - Writes the beginning of a JSON array with a property name specified as a read-only span of bytes as the key. - The UTF-8 encoded property name of the JSON array to be written. - The specified property name is too large. - The depth of the JSON exceeds the maximum depth of 1,000. - --or- - -Validation is enabled, and this write operation would produce invalid JSON. - - - Writes the beginning of a JSON array with a property name specified as a read-only character span as the key. - The UTF-16 encoded property name of the JSON array to be transcoded and written as UTF-8. - The specified property name is too large. - The depth of the JSON exceeds the maximum depth of 1,000. - --or- - -Validation is enabled, and this write operation would produce invalid JSON. - - - Writes the beginning of a JSON array with a property name specified as a string as the key. - The UTF-16 encoded property name of the JSON array to be transcoded and written as UTF-8. - The specified property name is too large. - The depth of the JSON exceeds the maximum depth of 1,000. - --or- - -Validation is enabled, and this write operation would produce invalid JSON. - The parameter is . - - - Writes the beginning of a JSON array with a pre-encoded property name as the key. - The JSON encoded property name of the JSON array to be transcoded and written as UTF-8. - The depth of the JSON has exceeded the maximum depth of 1,000. - --or- - -Validation is enabled, and this method would result in writing invalid JSON. - - - Writes the beginning of a JSON object. - The depth of the JSON exceeds the maximum depth of 1,000. - --or- - -Validation is enabled, and the operation would result in writing invalid JSON. - - - Writes the beginning of a JSON object with a property name specified as a read-only span of bytes as the key. - The UTF-8 encoded property name of the JSON object to be written. - The specified property name is too large. - The depth of the JSON exceeds the maximum depth of 1,000. - --or- - -Validation is enabled, and this write operation would produce invalid JSON. - - - Writes the beginning of a JSON object with a property name specified as a read-only character span as the key. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The specified property name is too large. - The depth of the JSON exceeds the maximum depth of 1,000. - --or- - -Validation is enabled, and this write operation would produce invalid JSON. - - - Writes the beginning of a JSON object with a property name specified as a string as the key. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The specified property name is too large. - The depth of the JSON exceeds the maximum depth of 1,000. - --or- - -Validation is enabled, and this write operation would produce invalid JSON. - The parameter is . - - - Writes the beginning of a JSON object with a pre-encoded property name as the key. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - The depth of the JSON has exceeded the maximum depth of 1,000. - --or- - -Validation is enabled, and this method would result in writing invalid JSON. - - - Writes a UTF-8 property name and a value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-8 encoded property name of the JSON object to be written. - The value to be written as a JSON string as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a UTF-8 property name and a value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-8 encoded property name of the JSON object to be written. - The value to be written as a JSON string as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a UTF-8 property name and a value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-8 encoded property name of the JSON object to be written. - The value to be written as a JSON string as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a UTF-8 property name and UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-8 encoded property name of the JSON object to be written. - The UTF-8 encoded value to be written as a JSON string as part of the name/value pair. - The specified property name or value is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a UTF-8 property name and UTF-16 text value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-8 encoded property name of the JSON object to be written. - The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. - The specified property name or value is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a UTF-8 property name and string text value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-8 encoded property name of the JSON object to be written. - The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. - The specified property name or value is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes the UTF-8 property name and pre-encoded value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-8 encoded property name of the JSON object to be written. - The JSON encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and this method would result in writing invalid JSON. - - - Writes a property name specified as a read-only character span and a value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON string as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a read-only character span and a value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON string as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a read-only character span and a value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON string as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a UTF-16 property name and UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The UTF-8 encoded value to be written as a JSON string as part of the name/value pair. - The specified property name or value is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a UTF-16 property name and UTF-16 text value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. - The specified property name or value is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a UTF-16 property name and string text value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. - The specified property name or value is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes the property name and pre-encoded value (as a JSON string) as part of a name/value pair of a JSON object. - The property name of the JSON object to be transcoded and written as UTF-8. - The JSON encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a property name specified as a string and a value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON string as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - The parameter is . - - - Writes a property name specified as a string and a value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON string as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - The parameter is . - - - Writes a property name specified as a string and a value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON string as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - The parameter is . - - - Writes a property name specified as a string and a UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The UTF-8 encoded value to be written as a JSON string as part of the name/value pair. - The specified property name or value is too large. - Validation is enabled, and the write operation would produce invalid JSON. - The parameter is . - - - Writes a property name specified as a string and a UTF-16 text value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. - The specified property name or value is too large. - Validation is enabled, and the write operation would produce invalid JSON. - The parameter is . - - - Writes a property name specified as a string and a string text value (as a JSON string) as part of a name/value pair of a JSON object. - The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. - The specified property name or value is too large. - Validation is enabled, and the write operation would produce invalid JSON. - The parameter is . - - - Writes the property name and pre-encoded value (as a JSON string) as part of a name/value pair of a JSON object. - The property name of the JSON object to be transcoded and written as UTF-8. - The JSON encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. - The specified property name is too large. - Validation is enabled, and the write operation would produce invalid JSON. - The parameter is . - - - Writes the pre-encoded property name and value (as a JSON string) as part of a name/value pair of a JSON object. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON string as part of the name/value pair. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes the pre-encoded property name and value (as a JSON string) as part of a name/value pair of a JSON object. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON string as part of the name/value pair. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes the pre-encoded property name and value (as a JSON string) as part of a name/value pair of a JSON object. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a JSON string as part of the name/value pair. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes the pre-encoded property name and UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - The UTF-8 encoded value to be written as a JSON string as part of the name/value pair. - The specified value is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes the pre-encoded property name and text value (as a JSON string) as part of a name/value pair of a JSON object. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. - The specified value is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes the pre-encoded property name and string text value (as a JSON string) as part of a name/value pair of a JSON object. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - The value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. - The specified value is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes the pre-encoded property name and pre-encoded value (as a JSON string) as part of a name/value pair of a JSON object. - The JSON encoded property name of the JSON object to be transcoded and written as UTF-8. - The JSON encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a value (as a JSON string) as an element of a JSON array. - The value to be written as a JSON string as an element of a JSON array. - Validation is enabled, and the operation would result in writing invalid JSON. - - - Writes a value (as a JSON string) as an element of a JSON array. - The value to be written as a JSON string as an element of a JSON array. - Validation is enabled, and the operation would result in writing invalid JSON. - - - Writes a value (as a JSON string) as an element of a JSON array. - The value to be written as a JSON string as an element of a JSON array. - Validation is enabled, and the operation would result in writing invalid JSON. - - - Writes a UTF-8 text value (as a JSON string) as an element of a JSON array. - The UTF-8 encoded value to be written as a JSON string element of a JSON array. - The specified value is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a UTF-16 text value (as a JSON string) as an element of a JSON array. - The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array. - The specified value is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes a string text value (as a JSON string) as an element of a JSON array. - The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array. - The specified value is too large. - Validation is enabled, and the write operation would produce invalid JSON. - - - Writes the pre-encoded text value (as a JSON string) as an element of a JSON array. - The JSON encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array. - Validation is enabled, and the write operation would produce invalid JSON. - - - Gets the total number of bytes committed to the output by the current instance so far. - The total number of bytes committed to the output by the so far. - - - Gets the number of bytes written by the so far that have not yet been flushed to the output and committed. - The number of bytes written so far by the that have not yet been flushed to the output and committed. - - - Gets the depth of the current token. - The depth of the current token. - - - Gets the custom behavior when writing JSON using this instance, which indicates whether to format the output while writing, whether to skip structural JSON validation, and which characters to escape. - The custom behavior of this instance of the writer for formatting, validating, and escaping. - - - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Threading.Tasks.Extensions.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Threading.Tasks.Extensions.dll deleted file mode 100644 index eeec928..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.Threading.Tasks.Extensions.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.ValueTuple.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.ValueTuple.dll deleted file mode 100644 index 4ce28fd..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.ValueTuple.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.ValueTuple.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/System.ValueTuple.xml deleted file mode 100644 index 1151832..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/System.ValueTuple.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - System.ValueTuple - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ToastNotificationWPFShared.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/ToastNotificationWPFShared.dll deleted file mode 100644 index a8c32ef..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/ToastNotificationWPFShared.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ToastNotifications.Messages.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/ToastNotifications.Messages.dll deleted file mode 100644 index ee8996c..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/ToastNotifications.Messages.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ToastNotifications.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/ToastNotifications.dll deleted file mode 100644 index e7e9f68..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/ToastNotifications.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionAligner.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionAligner.dll deleted file mode 100644 index 764a30c..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionAligner.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionAligner.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionAligner.xml deleted file mode 100644 index 37427ea..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionAligner.xml +++ /dev/null @@ -1,677 +0,0 @@ - - - - VisionAligner - - - - - 얼라인 횟수 체크 - - - - - 생성자 - - 얼라인 레시피 - - - - 얼라인 횟수 초기화 - - - - - 현재 얼라인의 횟수를 Get한다 - - 얼라인 상태 - 현재 얼라인 횟수 - - - - 얼라인 결과들을 하나의 얼라인 보정량으로 계산한다. - - - - - 모터 이동이 가능/불가능한 얼라인 결과를 하나의 보정량으로 계산한다. - - 이동 불가능한 헤드 얼라인 이동량 - 이동 가능한 스테이지 얼라인 이동량 - 얼라인 보정량 - - - - 헤드 얼라인 - - - - - 생성자 - - 얼라인 정보 - - - - N-포인트 얼라인 보정량 T를 계산한다. - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 좌표계의 Y축 반전 여부 - 얼라인 보정량 - - - - ICP 알고리즘을 이용하여 N-포인트 얼라인 보정량 T를 계산한다. - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 좌표계의 Y축 반전 여부 - 얼라인 보정량 - - - - N-포인트 얼라인 보정량 XY를 계산한다. - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 좌표계의 Y축 반전 여부 - 회전 원점 - 얼라인 보정량 T - 얼라인 보정량 - - - - 1-포인트 얼라인 보정량 XYT를 계산한다. - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 좌표계의 Y축 반전 여부 - 회전 원점 - 얼라인 보정량 T - 얼라인 보정량 - - - - 얼라인 결과 항목 - - - - 걸린 시간 - - - 얼라인 이름 - - - 얼라인 알고리즘 - - - 얼라인 횟수 - - - 얼라인 보정량 X - - - 얼라인 보정량 Y - - - 얼라인 보정량 T - - - 얼라인 상태 - - - - Clone (Deep Copy) - - AlignResultItem - - - - 얼라인 결과 항목 매니저 - - - - - 얼라인 결과 항목을 Get한다 - - 서브 시스템 정보 - 얼라인 결과 - 얼라인 결과 항목 - - - - 얼라인 에이전트 생성 및 등록 - - - - - 얼라인 에이전트 생성 및 등록 - - - - - 얼라인 레시피 갱신 - - 서브시스템 정보 - - - - 얼라인 계산을 담당한다 - - - - - 얼라인 정보를 초기화한다 - - - - - N-포인트 얼라인을 진행한다 - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 좌표계의 Y축 반전 여부 - 얼라인 결과 - - - - 1-포인트 얼라인을 진행한다 - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 좌표계의 Y축 반전 여부 - 얼라인 결과 - - - - 외부에서 레시피가 새로 저장된 경우, 레시피를 갱신해준다. - - 얼라인 모드 - - - - 얼라인 상태가 NG인지 확인 - - 얼라인 상태 - 얼라인 상태가 NG인 여부 - - - - Source(이동)를 Target(고정)에 맞추는 얼라인 XYT - - Head 얼라인 : Source(RefPoint), Target(MeaPoint) - - - Stage 얼라인 : Source(MeaPoint), Target(RefPoint) - - - 이동 포인트 - 고정 포인트 - Y축 반전 - 보정량 XYT - - - - ICP 알고리즘을 이용하여 Source(이동)를 Target(고정)에 맞추는 얼라인 XYT - - Head 얼라인 : Source(RefPoint), Target(MeaPoint) - - - Stage 얼라인 : Source(MeaPoint), Target(RefPoint) - - - 이동 포인트 - 고정 포인트 - Y축 반전 - 보정량 XYT - - - - Source(이동)를 Target(고정)에 맞추는 얼라인 XY - - 이동 포인트 리스트 - 고정 포인트 리스트 - 보정량 XY - - - - Source(이동)를 Target(고정)에 맞추는 얼라인 XYT - - Head 얼라인 : Source(RefPoint), Target(MeaPoint) - - - Stage 얼라인 : Source(MeaPoint), Target(RefPoint) - - - 이동 포인트 - 고정 포인트 - 패턴 틀어진 각도 보정량 - 회전 원점 - Y축 반전 - 보정량 XYT - - - - Source(이동)를 Target(고정)에 맞추는 얼라인 XY - - 이동 포인트 - 고정 포인트 - 보정량 XY - - - - 얼라인 에이전트 - - - - - 생성자 - - 얼라인 정보 - 얼라인 모드 - - - - 외부에서 레시피가 새로 저장된 경우, 레시피를 갱신해준다. - - 얼라인 모드 - - - - 얼라인 모드를 모두 리셋한다. - - - - - N-포인트 얼라인 보정량 XYT를 계산한다. - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 좌표계의 Y축 반전 여부 - 얼라인 결과 - - - - 1-포인트 얼라인 보정량 XYT를 계산한다. - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 얼라인 보정량 T - 좌표계의 Y축 반전 여부 - 얼라인 결과 - - - - 얼라인 리밋 체크 - - - - - 생성자 - - 얼라인 레시피 - - - - 얼라인 리밋 활성 유무 - - 얼라인 리밋 활성 유무 - - - - 얼라인 상태를 Get한다 - - 얼라인 보정량 - 얼라인 상태 - - - - 얼라인 X값의 리밋 초과 유무 확인 - - 얼라인 보정량 - 얼라인 X값의 리밋 초과 유무 - - - - 얼라인 Y값의 리밋 초과 유무 확인 - - 얼라인 보정량 - 얼라인 Y값의 리밋 초과 유무 - - - - 얼라인 T값의 리밋 초과 유무 확인 - - 얼라인 T보정량 - 얼라인 T값의 리밋 초과 유무 - - - - 얼라인 모드(알고리즘) - - - - 로거 - - - 얼라인 보정량 제한 체커 - - - 얼라인 재시도 스펙 체커 - - - 얼라인 재시도 횟수 체커 - - - 얼라인 레시피 - - - 서브 시스템 정보 - - - - 생성자(UnitTest 전용) - - - - - 생성자 - - 얼라인 정보 - - - - N-포인트 얼라인 보정량 XYT를 계산한다. - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 좌표계의 Y축 반전 여부 - 얼라인 결과 - - - - N-포인트 얼라인 보정량 T를 계산한다. - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 좌표계의 Y축 반전 여부 - 얼라인 보정량 - - - - ICP 알고리즘을 이용하여 N-포인트 얼라인 보정량 T를 계산한다. - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 좌표계의 Y축 반전 여부 - 얼라인 보정량 - - - - N-포인트 얼라인 보정량 XY를 계산한다. - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 좌표계의 Y축 반전 여부 - 회전 원점 - 얼라인 보정량 T - 얼라인 보정량 - - - - 1-포인트 얼라인 보정량 XYT를 계산한다. - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 얼라인 보정량 T - 좌표계의 Y축 반전 여부 - 얼라인 결과 - - - - 1-포인트 얼라인 보정량 XYT를 계산한다. - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 좌표계의 Y축 반전 여부 - 회전 원점 - 얼라인 보정량 T - 얼라인 보정량 - - - - 얼라인 상태를 체크한다. - - 얼라인 보정량 - 얼라인 상태 코드 - - - - 얼라인 재시도 스펙 체커를 초기화 한다. - - - - - 얼라인 재시도 횟수를 초기화 한다. - - - - - 얼라인 재시도 스펙 체커와 재시도 횟수를 초기화 한다. - - - - - 회전 원점을 얻어온다. - - 회전 원점 좌표 - - - - 얼라인 보정량 T에 얼라인 타겟 회전량를 적용한다. - - 얼라인 보정량 T - 얼라인 사용 축 - 얼라인 타겟 회전량 - 최종 얼라인 보정량 T - - - - 얼라인 보정량 X에 얼라인 타겟 거리 X를 적용한다. - - 얼라인 보정량 X - 얼라인 사용 축 - 얼라인 타겟 거리 X - 최종 얼라인 보정량 X - - - - 얼라인 보정량 Y에 얼라인 타겟 거리 Y를 적용한다. - - 얼라인 보정량 Y - 얼라인 사용 축 - 얼라인 타겟 거리 Y - 최종 얼라인 보정량 Y - - - - 얼라인 T축 사용여부를 체크한다. - - 얼라인 축 정보 - 체크 결과 - - - - 얼라인 XY축 사용여부를 체크한다. - - 얼라인 축 정보 - 체크 결과 - - - - 얼라인 X축 사용여부를 체크한다. - - 얼라인 축 정보 - 체크 결과 - - - - 얼라인 Y축 사용여부를 체크한다. - - 얼라인 축 정보 - 체크 결과 - - - - 스테이지 얼라인 - - - - - 생성자 - - 얼라인 정보 - - - - N-포인트 얼라인 보정량 T를 계산한다. - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 좌표계의 Y축 반전 여부 - 얼라인 보정량 - - - - ICP 알고리즘을 이용하여 N-포인트 얼라인 보정량 T를 계산한다. - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 좌표계의 Y축 반전 여부 - 얼라인 보정량 - - - - N-포인트 얼라인 보정량 XY를 계산한다. - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 좌표계의 Y축 반전 여부 - 회전 원점 - 얼라인 보정량 T - 얼라인 보정량 - - - - 1-포인트 얼라인 보정량 XYT를 계산한다. - - 패턴 검출 위치 - 레퍼런스(기준) 위치 - 좌표계의 Y축 반전 여부 - 회전 원점 - 얼라인 보정량 T - 얼라인 보정량 - - - - 얼라인 재시도 체크 - - - - - 생성자 - - 얼라인 레시피 - - - - 얼라인 재시도 활성 유무 - - 얼라인 재시도 활성 유무 - - - - 얼라인 재시도 상태를 Get한다 - - 얼라인 보정값 - 얼라인 상태 - - - - 얼라인 재시도 횟수를 초기화한다 - - - - - 얼라인 에이전트 매니저 - - - - - 얼라인 에이전트를 Set한다 - - 얼라인 정보 - 얼라인 계산 - 성공 유무 - - - - 얼라인 에이전트를 Get한다 - - 얼라인 정보 - 얼라인 에이전트 - - - - 사용하지 않는 에이전트를 삭제한다 - - 최신 얼라인 정보들 - 성공 유무 - - - - 새로 추가된 얼라인 정보인지 확인한다 - - 최신 얼라인 정보들 - 추가된 얼라인 유무 - - - - 얼라인 에이전트를 초기화한다. - - - - - Source(이동)를 Target(고정)에 맞추는 얼라인 T - - 이동 포인트 리스트 - 고정 포인트 리스트 - 보정량 T - - - - ICP 알고리즘을 이용하여 Source(이동)를 Target(고정)에 맞추는 얼라인 T - - 이동 포인트 리스트 - 고정 포인트 리스트 - 보정량 T - - - - Source(이동)를 Target(고정)에 맞추는 얼라인 XY - - 이동 포인트 리스트 - 고정 포인트 리스트 - 보정량 XY - - - - Source(이동)를 Target(고정)에 맞추는 얼라인 XY - - 이동 포인트 - 고정 포인트 - 보정량 XY - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCalibrator.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCalibrator.dll deleted file mode 100644 index e522ed7..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCalibrator.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCalibrator.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCalibrator.xml deleted file mode 100644 index a81b9e6..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCalibrator.xml +++ /dev/null @@ -1,337 +0,0 @@ - - - - VisionCalibrator - - - - - MIL or Cognex 상호참조 해결을 위한 클래스 - - - - - 켈리브레이터를 Get한다. - - FovInfo - Calibrator - - - - 이미지 좌표를 자재 좌표계로 변환한다 - - FOV 정보 - 변환할 이미지 좌표 - 변환할 이미지의 크기 - 자재 좌표 - - - - 자재 좌표를 이미지 좌표계로 변환한다 - - FOV 정보 - 변환할 자재 좌표 - 변환할 이미지의 크기 - 이미지 좌표 - - - - 이미지 좌표와 자재 좌표간의 변환을 위한 클래스이다. - - - - - Calibrator 생성자 - - Fov 정보 - - - - 이미지 좌표를 자재 좌표계로 변환한다 - - 변환할 이미지 좌표 - 변환할 이미지의 크기 - 자재 좌표 - - - - 이미지 좌표를 자재 좌표계로 변환한다 - - 변환할 이미지 좌표 - 변환할 이미지의 크기 - 변환할 이미지의 회전 오차 - 카메라의 픽셀 크기 - 자재 좌표 - - - - X축 픽셀 사이즈만으로 이미지 좌표를 자재 좌표계로 변환한다 - - 변환할 이미지 좌표 - 변환할 이미지의 크기 - 변환할 이미지의 회전 오차 - 카메라의 X축 픽셀 크기 - 자재 좌표 - - - - Y축 픽셀 사이즈만으로 이미지 좌표를 자재 좌표계로 변환한다 - - 변환할 이미지 좌표 - 변환할 이미지의 크기 - 변환할 이미지의 회전 오차 - 카메라의 Y축 픽셀 크기 - 자재 좌표 - - - - 자재 좌표를 이미지 좌표계로 변환한다 - - 변환할 자재 좌표 - 변환할 이미지의 크기 - 이미지 좌표 - - - - 카메라의 픽셀 크기를 계산한다. - - 이미지 좌표 리스트 - 측정시 이동 거리 - 회전 오차 - 계산할 픽셀 크기의 축 - 픽셀 크기 - - - - 회전 오차를 계산한다. - - 자재 좌표 리스트 - 계산시 사용할 데이터의 축 - 회전 오차 - - - - 회전 원점을 계산한다. - - 자재 좌표 리스트 - 회전한 각도 - 회전 원점의 자재 좌표 - - - - Fov 레시피를 새로 가져온다. - - Fov 레시피 - - - - 좌표계에 Y축 반전을 적용 여부를 가져온다. - - Y축 반전 여부 - - - - 켈리브레이터를 관리하는 매니저 - - - - - 켈리브레이터를 Set한다. - - FovInfo - Calibrator - - - - 켈리브레이터를 Get한다. - - FovInfo - Calibrator - - - - 모든 켈리브레이터를 Get한다. - - 캘리브레이터 딕셔너리 - - - - 캘리브레이터 생성 및 등록 - - - - - 캘리브레이터 생성 및 등록 - - - - 한 점의 좌표 정보 - - - X 좌표 - - - Y 좌표 - - - 여러 점들의 좌표 정보 - - - 점들의 수 - - - 점들의 좌표 정보 - - - 회전을 위한 정보 - - - 회전 원점의 좌표 - - - 회전 각도 - - - 반지름 길이 - - - - 자재 좌표를 모션 좌표로 변환하기 위한 클래스이다. - - - - - CoordConverter 생성자 - - 서브 시스템 정보 - - - - 리스트로 전달된 자재 좌표를 모션 좌표로 변환한다. - - 자재 좌표 리스트 - 패턴 간의 수평 거리 - 패턴 간의 수직 거리 - 수평 Low, 수직 Low 모션 좌표 - 수평 High, 수직 Low 모션 좌표 - 수평 Low, 수직 High 모션 좌표 - 수평 High, 수직 High 모션 좌표 - 모션 좌표 리스트 - - - - 자재 좌표를 모션 좌표로 변환한다. - - 자재 좌표 - 패턴 간의 수평 거리 - 패턴 간의 수직 거리 - 수평 Low, 수직 Low 모션 좌표 - 수평 High, 수직 Low 모션 좌표 - 수평 Low, 수직 High 모션 좌표 - 수평 High, 수직 High 모션 좌표 - 모션 좌표 - - - - 자재 좌표를 모션 좌표로 변환한다. - - 자재 X좌표 - 자재 Y좌표 - 패턴 간의 수평 거리 - 패턴 간의 수직 거리 - 수평 Low, 수직 Low 모션 좌표 - 수평 High, 수직 Low 모션 좌표 - 수평 Low, 수직 High 모션 좌표 - 수평 High, 수직 High 모션 좌표 - 모션 좌표 - - - - - 자재 좌표에 얼라인 보정량을 적용한다. - - 자재 좌표 - 얼라인 X보정량 - 얼라인 Y보정량 - 얼라인 T보정량 - 얼라인 보정량이 적용된 자재 좌표 - - - - 리스트로 전달된 자재 좌표에 얼라인 보정량을 적용한다. - - 자재 좌표 리스트 - 얼라인 X보정량 - 얼라인 Y보정량 - 얼라인 T보정량 - 얼라인 보정량이 적용된 자재 좌표 리스트 - - - - 리스트로 전달된 자재 좌표에 얼라인 보정량을 적용하고 모션 좌표로 변환한다. - - 자재 좌표 리스트 - 얼라인 X보정량 - 얼라인 Y보정량 - 얼라인 T보정량 - 패턴 간의 수평 거리 - 패턴 간의 수직 거리 - 수평 Low, 수직 Low 모션 좌표 - 수평 High, 수직 Low 모션 좌표 - 수평 Low, 수직 High 모션 좌표 - 수평 High, 수직 High 모션 좌표 - 얼라인 보정량이 적용된 모션 좌표 리스트 - - - - 자재 좌표에 얼라인 보정량을 적용하고 모션 좌표로 변환한다. - - 자재 좌표 리스트 - 얼라인 X보정량 - 얼라인 Y보정량 - 얼라인 T보정량 - 패턴 간의 수평 거리 - 패턴 간의 수직 거리 - 수평 Low, 수직 Low 모션 좌표 - 수평 High, 수직 Low 모션 좌표 - 수평 Low, 수직 High 모션 좌표 - 수평 High, 수직 High 모션 좌표 - 얼라인 보정량이 적용된 모션 좌표 - - - - 쿠드컨버터 생성 및 등록 - - - - - 쿠드컨버터 생성 및 등록 - - - - - 쿠드컨버터를 관리하는 매니저 - - - - - 쿠드컨버터 에이전트를 Set한다. - - SubSysInfo - CoordConverter - - - - 쿠드컨버터 에이전트를 Get한다. - - SubSysInfo - CoordConverter - - - - 모든 쿠드컨버터 에이전트를 Get한다. - - 쿠드컨버터 딕셔너리 - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCommon.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCommon.dll deleted file mode 100644 index 866f32e..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCommon.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCommon.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCommon.xml deleted file mode 100644 index bd91bcc..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCommon.xml +++ /dev/null @@ -1,1957 +0,0 @@ - - - - VisionCommon - - - - - MIL or Cognex 라이브러리를 활용한 환경 구성 - - - - - 기본 비전 알람 매니저 - - - - - 비전 알람 코드 - - - - 조명 설정 에러 - - - 카메라 연결 에러 - - - 카메라 그랩 에러 - - - - 비전 알람 인터페이스 - - - - - 알람을 등록한다. - - 결과 상태 코드 - - - - 알람을 발생시킨다. - - 비전 알람 코드 - 결과 상태 코드 - - - - 알람을 발생시킨다. - - 비전 알람 코드 - 결과 상태 코드 - - - - 장비의 비전 셋업 인터페이스 - - - - - 오토 포커스의 결과로 나온 최적의 초점 위치 저장 - - 최적의 초점 위치 - - - - 기본 장비 패턴 매니저 - - - - - 장비 패턴 인터페이스 - - - - - 장비에서 구현한 패턴 타입 리스트를 얻어온다. - - 패턴 타입 리스트 - - - - 패턴을 얻어온다. - - 패턴 정보 - 패턴 - - - - 패턴 설정 윈도우를 얻어온다. - - 패턴 에이전트 - 패턴 정보 - 카메라 디스플레이 - FOV 키 정보 - 패턴 - - - - 장비에서 시퀀스 노드를 정의하고, - AuroraVision 시퀀스에서 사용하기 위한 클래스 - - - - - 생성자 - - 로그 태그명 - - - - Action 노드를 가져온다. - - 노드 이름 - Default Decision 노드 - Action 노드 - - - - Decision 노드를 가져온다. - - 노드 이름 - Default Decision 노드 - Decision 노드 - - - - Action 노드를 등록한다. - - 노드 이름 - Action 노드 - - - - Deicision 노드를 등록한다. - - 노드 이름 - Deicision 노드 - - - - Sequence adapter 사용 시 default node ( ActionNode ) 만들어주는 Method - - - - - 생성자 - - ActionNode 사용 시 Default로 제공하는 결과값 (default(non param) : SequenceAction.OK()) - - - - 생성자 : ActionNode 사용 시 Default로 제공하는 결과값 (default : SequenceAction.OK()) - - - - - Default Action Node - - Default Action Node return - - - - Sequence adapter 사용 시 default node (Decision Node ) 만들어주는 Method - - - - - 생성자 - - DecisionNode 사용 시 Default로 제공하는 결과값(default : "") - - - - Default Decision Node - - Default Decision Node return - - - - 기본 장비 시퀀스 매니저 - - - - - 생성자 - - - - - 장비에서 정의한 시퀀스 어댑터 매니저 - - - - 기본 생성자 - - - - 서브 시스템의 시퀀스 어댑터를 등록한다. - - 서브 시스템 정보 - 시퀀스 어댑터 - - - - 서브 시스템의 시퀀스 어댑터를 가져온다. - - 서브 시스템 정보 - 가져올 때 default Adapter를 어떤 것을 가져올지 설정하는 정보 - !주의! Node 형태로 사용할 때 : ( DefaultActionNode / DefaultDecisionNode 를 생성) - !주의! Method 형태로 사용할 때 : null을 사용한다면 ".GetAdapter(~)?.Invoke(~)" 형태로 사용 - 시퀀스 어댑터 - - - - 기본 장비의 운영 모드 어댑터 - - - - - 기본 장비의 카메라 트리거 어댑터 - - - - - 장비의 카메라 트리거 인터페이스 - - - - - SW or HW 트리거 모드 일괄 설정 - - 파라미터 - 성공 유무 - - - - SW 트리거 모드 설정 - - 파라미터 - 성공 유무 - - - - HW 트리거 모드 설정 - - 파라미터 - 성공 유무 - - - - 트리거 On - - 성공 유무 - - - - 트리거 Off - - 성공 유무 - - - - 트리거 신호 On - - 카메라 컨피그 - - - - 트리거 신호 Off - - 카메라 컨피그 - - - - 기본 모션 - - - - - 기본 서브 시스템 모션 매니저 - - - - - 생성자 - - - - - 기본 FOV 모션 매니저 - - - - - 생성자 - - - - - 모션 제어를 위한 매니저 - - 키 정보 - - - - 모션을 등록한다. - - 키 정보 - 모션 - - - - 모션을 얻어온다. - - 키 정보 - 모션 - - - - 특정 키에 해당하는 모션을 제거한다. - - 키 정보 - - - - 모든 모션을 제거한다. - - - - - 상대위치 이동 - - 키 정보 - 상대 위치 이동량 - 이동 결과 상태 코드 - - - - 절대위치 이동 - - 키 정보 - 이동할 절대 위치 - 이동 결과 상태 코드 - - - - 포지션 타입의 위치로 이동한다. - - 키 정보 - 포지션 타입 - 이동 결과 상태 코드 - - - - 현재의 위치 값을 얻어온다. - - 키 정보 - 현재 위치 값 - - - - EquipAdapter에서 사용하는 모션 제어 인터페이스 - - - - - 요청한 이동량(delta)만큼 상대위치 이동한다. - - 상대 위치 이동량 - 성공 : Hermes.E1.OK - - - - 요청한 위치로 이동한다. - - - 성공 : Hermes.E1.OK - - - - 요청한 포지션타입(ePositionType)에 맞는 위치로 절대위치 이동한다. - - 포지션타입 - 성공 : Hermes.E1.OK - - - - 현재 모터 위치를 리턴한다. - - 현재 모터 위치 - - - - 기본 포지션 매니저 - - - - - 기본 서브 시스템 포지션 매니저 - - - - - 생성자 - - - - - 기본 FOV 포지션 매니저 - - - - - 생성자 - - - - - 포지션 어댑터 인터페이스 - - - - - 포지션을 얻어온다. - - 포지션 타입 - 포지션 - - - - 모션의 포지션 매니저 - - - - - - 포지션 어댑터를 등록한다. - - 키 정보 - 포지션 어댑터 - - - - 포지션 어댑터를 얻어온다. - - 키 정보 - 포지션 어댑터 - - - - 포지션을 얻어온다. - - 키 정보 - 포지션 타입 - 포지션 - - - - 다른 디스플레이에서 동일 카메라 라이브 동작시, 버튼 UI Sync를 맞추기 위함. - - - - - 외부(버퍼) 트리거에 의한 그랩 완료 여부 (True : 그랩 완료 / False : 그랩 미완료) - - - - - EventCallBack에 의한 그랩 완료 여부 (True : 그랩 완료 / False : 그랩 미완료) - - - - - 카메라 화면 중심을 기준으로 Ratio X,Y를 적용한 자를 이미지 크기 - - 자를 이미지 크기 - - - - 외부(버퍼) 트리거에 의한 그랩 완료 여부 설정 - - 그랩 완료 여부 - - - - - EventCallBack에 의한 그랩 완료 여부 설정 - - 그랩 완료 여부 - - - - EventCallBack에 의한 그랩 완료 여부 체크 (True : 그랩 완료 / False : 그랩 미완료) - - 그랩 완료 여부 - - - - 라이브 켜져있는지 여부 - - 라이브 여부 - - - - 카메라 라이브 시키기 - - - - - 카메라 라이브 끄기 - - - - - 연결되어있는지 여부 - - 연결여부 - - - - 이미지 버퍼 복제 - - 복제한 이미지버퍼 - - - - 카메라 디스플레이 가져오기 - - 카메라 디스플레이 - - - - 디스플레이 설정하기 - - 카메라 디스플레이 - - - - 디스플레이로 부터 이미지 가져오기 - - 가져올 카메라 디스플레이 - 이미지 객체 - - - - 게인 값 가져오기 - - 성공유무 - - - - 게인 값 설정하기 - - 설정할 게인 값 - 성공유무 - - - - 노출도 값 가져오기 - - 노출 값 - - - - 노출도 최솟값 가져오기 - - 노출도 최솟값 - - - - 노출도 최댓값 가져오기 - - 노출도 최댓값 - - - - 노출 값 설정하기 - - 노출시간(ms)기준 - 성공유무 - - - - - 이미지 사이즈 가져오기 - - 이미지 사이즈 - - - - 버퍼로 부터 그랩한 이미지 가져오기 - - 카메라 디스플레이 - 가져올 이미지 (reference) - 성공유무 - - - - 카메라 그랩(동기) - - 카메라 디스플레이 - 가져올 이미지 (reference) - 성공 유무 - - - - 라이브 시작 - - 카메라 디스플레이 - - - - 라이브 정지 - - - - - Child 이미지들로 Parent(원장) 이미지가 정상적으로 만들어지는지 검증 - - 디스플레이 - 원장(부모) 이미지 - 성공 유무 - - - - 플라잉 시작 - - FOV 정보 - 추가 파라미터 - 성공 유무 - - - - 플라잉 종료 - - 추가 파라미터 - 성공 유무 - - - - 플라잉 상태 체크 - - 성공 유무 - - - - 현재 플라잉 인덱스 가져오기 - - 현재 플라잉 인덱스 - - - - 플라잉 이미지 가져오기 - - 플라잉 인덱스 - 플라잉 이미지 - - - - 플라잉 이미지 전체 가져오기 - - 플라잉 이미지 전체 - - - - 플라잉 합성(원장) 이미지 가져오기. *원장 : Child 이미지를 조합하여 한 장으로 만듬 - - 플라잉 합성(원장) 이미지 - - - - 데이터를 인덱스별로 관리하는 클래스 - - - - - 생성자 - - - - - 모든 데이터 리턴 - - 모든 데이터 - - - - 마지막 lastDataCnt개의 데이터 리턴 - - 마지막 데이터 개수 - 마지막 lastDataCnt개의 데이터 - - - - 데이터 삽입 - - 데이터 - - - - 원점, 각도, 길이로 구성되는 십자가 - - - - 원점 - - - 각도 - - - 수직/수평 길이 - - - 수직 라인 - - - 수평 라인 - - - - 생성자 - - 원점 - - - - 생성자 - - 원점 - 수직/수평 길이 - - - - 생성자 - - 원점 - 각도 - - - - 생성자 - - 원점 - 각도 - 수직/수평 길이 - - - - 객체 복제 (DeepCopy) - - - - - - 객체 복사 (DeepCopy) - - - - - - MIL, Cognex와 상관없이 범용적으로 사용하는 컬러 - - - - - Source -> Target 좌표계 변환을 위환 변환 값으로 작성한다. - - - - - 데이터 저장 타입 - - - - - CSV 로드 및 저장 - - - - - 생성자 - - - - - CSV파일 로드 - - 서브시스템 정보 - 시간 - 데이터 저장 타입 - 데이터 리스트 - - - - 자동 생성된 경로에 CSV파일 저장 (비동기식) - - 서브시스템 정보 - 데이터 리스트 - 데이터 저장 타입 - - - - 자동 생성된 경로에 CSV파일 저장 (비동기식) - - 서브시스템 정보 - 데이터 - 데이터 저장 타입 - - - - 자동 생성된 경로에 CSV파일 저장 (동기식) - - 서브시스템 정보 - 데이터 - 데이터 저장 타입 - - - - 이미지 로드 및 저장 - - - - - 생성자 - - - - - 이미지 로드 - - 파일 경로 - 이미지 - - - - 이미지 로드 - - 파일 경로 - 보드 타입 - 보드 슬롯 위치 - 이미지 - - - - 자동 생성된 경로에 이미지 저장 (비동기식) - - FOV 정보 - 이미지 - 공정 결과 상태 - 자재 정보 - - - - 공정중 Grab한 이미지를 저장 - - 서브 시스템 키 정보 - 데이터 저장 타입 - 이미지 - - - - 공정 중 Grab한 이미지를 저장 - - FOV 키 정보 - 데이터 저장 타입 - 이미지 - - - - 지정된 경로에 이미지 저장 (비동기식) - - 파일 경로 - 파일 이름 - 이미지 - - - - 오버레이 이미지 저장 - - 마지막 FOV 정보 - 공정 결과 상태 - 자재 정보 - 디스플레이 타입 - - - - 특정 서브시스템에 대한 동기화된 공정 결과 시간을 저장 - - 서브시스템 정보 - 공정 결과 - - - - - 특정 서브시스템에 대한 공정 결과 시간 초기화 - - 서브시스템 정보 - - - - 센터로부터 각 패턴의 정위치까지 떨어진 거리 파라미터 - - - - - 센터로부터 각 패턴의 정위치까지 떨어진 거리들 - - 이미지 좌표상으로 좌상단부터 우하단까지 0 ~ n-1 인덱스이며, RefOffsets가 null이면 센터를 기준으로 얼라인 - - - - - 찾은 패턴의 위치와 패턴의 정위치 간에 허용 거리. (Default : 3 mm) - - - - 생성자 - - 센터로부터 각 패턴의 정위치까지 떨어진 거리들 - 찾은 패턴의 위치와 패턴의 정위치 간에 허용 거리 - - - - 센터로부터 각 패턴의 정위치까지 떨어진 거리 - - - - 센터로부터 패턴 정위치까지 거리X - - - 센터로부터 패턴 정위치까지 거리Y - - - - 수평/수직 라인의 방향 타입 - - - - 수평 라인 - - - 수직 라인 - - - - 시작과 끝점을 가지는 직선 - - - - - 직선의 시작점 - - - 직선의 끝점 - - - 직선의 길이 - - - - 생성자 - - 시작점 - 끝점 - - - - 수평/수직 라인 방향을 결정 - - 각도 - 라인 방향 (수평 or 수직) - - - 비전 시퀀스를 호출하기 전, 상위에서 클래스를 생성한 후 시퀀스 context에 넣어주어야 함. - - - var materialInfo = new MaterialInfo() { - LotId = "L0032", - CarrierId = "C19KAM123", - MaterialId = "90KMAQMM1QAS12" - }; - context.PutValue(VisionContextKeys.CNTXT_KEY_MATERIAL_INFO, materialInfo); - - - - - - - 장비의 운영 모드 상태 체크를 위한 인터페이스 - - - - - 시뮬레이션 모드 상태인지 체크 - - 상태 플래그 - - - - 드라이런 또는 물류 모드 상태인지 체크 - - 상태 플래그 - - - - 드라이런과 물류 모드 상태가 아닌지 체크 - - 상태 플래그 - - - - 드라이런 모드 상태인지 체크 - - 상태 플래그 - - - - 물류 모드 상태인지 체크 - - 상태 플래그 - - - - 카메라 디바이스 모델 리스트 - - - - - 그래버 유형 - - - - - 그래버 슬롯 위치 (MIL에서 Auto 인덱싱 해줌에 주의) - - - - - 그래버 포트 위치 (MIL에서 Auto 인덱싱 해줌에 주의) - - - - - 카메라 트리거 유형 - - - - - 카메라 트리거 발생 주체 - - - - 트리거 발생 주체가 외부(버퍼) 프로그램인 경우 - - - 트리거 발생 주체가 Aurora인 경우 - - - - GenICam "TriggerSource" Features - - - - - MIL : *.dcf 파일로 카메라 연결. EX) "D:\\Aurora\\DcfFiles\\CAM1.dcf" - Euresys : *.cti 파일로 카메라 연결. EX) "C:\\Program Files\\Euresys\\eGrabber\\cti\\x86_64\\gigelink.cti" - - - - - 활성화된 모터 위치 인덱스 기준으로 오름차순 정렬된 Child 객체 리스트 가져오기 - - 활성화된 모터 위치 인덱스 기준으로 오름차순 정렬된 Child 객체 리스트 - - - - 이미지 취득을 위한 카메라 트리거 모드 관리 - - - - - 항상 SW트리거로만 동작하는지 체크 - - 항상 SW트리거로 동작하면 True - - - - 항상 HW트리거로만 동작하는지 체크 - - 항상 HW트리거로 동작하면 True - - - - 플라잉 시작 - - FOV 정보 - 추가 파라미터 - 성공 유무 - - - - 플라잉 종료 - - 추가 파라미터 - 성공 유무 - - - - 플라잉 상태 체크 - - 성공 유무 - - - - 현재 플라잉 인덱스 가져오기 - - 현재 플라잉 인덱스 - - - - 플라잉 이미지 가져오기 - - 플라잉 인덱스 - 플라잉 이미지 - - - - 플라잉 이미지 전체 가져오기 - - 플라잉 이미지 전체 - - - - 플라잉 합성(원장) 이미지 가져오기. *원장 : Child 이미지를 조합하여 한 장으로 만듬 - - 플아잉 합성(원장) 이미지 - - - - MIL or Cognex 라이브러리를 활용한 환경 구성 - - - - - 패턴 유틸 클래스 - - - - - UI 콤보 박스용 패턴 설명 생성 - - 패턴 정보 - 패턴 설명 - - - - 패턴 검출 결과의 레퍼런스 인덱스를 구한다. - - 포인트 타입, 예)ImagePoint, StaticPoint - 패턴 검출 결과 - 레퍼런스 - 허용 거리(Spec) - 패턴의 레퍼런스 인덱스 (성공 : 0 ~ , 실패 : -1) - - - - 직선의 방정식 : Ax + By + C = 0 - - - - - 직선의 방정식 파라미터 A - - - - - 직선의 방정식 파라미터 B - - - - - 직선의 방정식 파라미터 C - - - - - 직선의 파라미터로 방정식 생성 - - 직선의 방정식 파라미터 A - 직선의 방정식 파라미터 B - 직선의 방정식 파라미터 C - - - - 직선을 지나는 두 점으로 방정식 생성 - - 직선을 지나가는 좌표1 X - 직선을 지나가는 좌표1 Y - 직선을 지나가는 좌표2 X - 직선을 지나가는 좌표2 Y - - - - 파라미터 Y좌표에 대응하는 X좌표 - - 임의의 Y좌표 - - - - - 파라미터 X좌표에 대응하는 Y좌표 - - 임의의 X좌표 - - - - - 복제 (ICloneable) - - object(LineEquation) - - - - FOV 간에 상관관계를 이용하여 라인을 교정하기 위한 매니저 - - - - - 라인 중점 보관 (자재 좌표) - - FOV 정보 - 수평/수직 라인 타입 - 라인 중점 (자재 좌표) - - - - 라인 중점 가져오기 (자재 좌표) - - FOV 정보 - 수평/수직 라인 타입 - 라인 중점 (자재 좌표) - - - - 라인 중점 초기화 - - - - - 각 FOV에서 찾은 라인의 중점 기반으로 새로 그려진 라인의 교점으로 meaPoints를 새롭게 정의 - - 보상된 교점 위치 - - - - 라인 교점들로 라인 그리기 - - 라인 교점들 - - - - 패턴을 트래킹하기 위해 패턴 위치를 저장/관리하는 매니저 - - - - - 패턴 위치 추가 - - FOV 키 - 패턴 위치 - - - - 모든 패턴 위치 리턴 - - FOV 키 - 모든 패턴 위치 - - - - 마지막 lastDataCnt개의 패턴 위치 리턴 - - FOV 키 - 마지막 패턴 위치 개수 - 마지막 lastDataCnt개의 패턴 위치 - - - - 모든 패턴 위치 초기화 - - FOV 키 - - - - C2_F4 or C4_F4에서 라인 교점으로 얼라인 하는 경우, 각 FOV들 간에 상관관계를 이용하여 라인 교점 알고리즘을 보상해주기 위해 라인 중점 저장 - - 라인 결과 - 패턴 정보 - 카메라 디스플레이 - - - - FixtureResult를 기준으로 이동시킨 ROI를 리턴한다. - - 패턴 타입 - 원본 ROI - 기준 패턴 결과 - 각도 반전 플래그. MIL과 Cognex의 각도 방향은 반대. Default : "true" - 회전 및 이동이 반영된 ROI - - - - 레퍼런스 위치에 십자가 그리기 - - 십자가 길이 - 십자가 색상 - - - - Pattern 찾을 때 Parameter interface - - - - - 패턴 파인더 interface - - - - - 외부 패턴 파일 - - - - - 패턴 파일 경로 가져오기 - - 패턴 파일 경로 - - - - 패턴 불러오기 - - 성공 유무 - - - - 패턴 저장하기 - - 성공 유무 - - - - 패턴 생성하기 - - 성공 유무 - - - - 패턴 제거하기 - - 성공 유무 - - - - 찾기 영역(ROI) 가져오기 - - ROI - - - - 찾기 영역(ROI) 설정하기 - - 설정할 ROI - 성공 유무 - - - - 패턴 찾을 때 사용할 파라미터들을 가져오기 - - 패턴 찾을때 사용 할 파라미터 (RunParam) - - - - 패턴 찾을 때 사용할 파라미터들 설정하기 - - 패턴 찾을때 사용 할 파라미터 (RunParam) - 성공 유무 - - - - 패턴 찾기 - - 패턴 검출할 이미지 - 패턴 결과 - - - - 패턴 찾기 - - 패턴 검출할 이미지 - 검출할 영역 - 패턴 결과 - - - - 패턴을 찾지 못했을 때 패턴 결과 - - 패턴 결과 - - - - Tool 가져오기 - - 객체 - - - - 패턴 결과 표시하기 - - 패턴 결과 - 카메라 디스플레이 - Fixture Pattern인지 여부 - - - - 패턴 썸네일 가져오기 - - 썸네일 - - - - 윈도우 타이틀 - - - - - 타이틀 등록 함수 - - - - - 포지션 리셋 함수 - - - - - 라인1,2 간에 교점 계산 - - 라인1 - 라인2 - 라인1,2 간에 교점 - - - - 라인1을 지나는 점에서 수직인 라인과 라인2 간에 교점 계산 - - 라인1을 지나는 점 - 라인1 - 라인2 - 라인1을 지나는 점에서 수직인 라인과 라인2 간에 교점 - - - - 점과 라인 간에 거리 계산 - - 점 - 라인 - 점과 라인 간에 거리 - - - - 편집 중인 패턴 데이터가 존재하는지 체크. - 공정 중 편집 중이던 패턴 데이터 갱신을 위함. - - - - - 편집중인 패턴 데이터 존재하는지 여부 - - 편집 중인 패턴 데이터 존재 여부 - - - - 패턴 데이터 편집 중으로 설정 - - - - - 편집 중인 패턴 데이터 클리어 - - - - - 패턴 썸네일 유틸 틀래스 - - - - 썸네일 이미지 폭(가로) - - - 썸네일 이미지 높이(세로) - - - - 썸네일의 이미지 사이즈 정보를 얻어온다. - - 이미지 사이즈 정보 - - - - 기본 썸네일 이미지 - - 썸네일 비트맵 - - - - 메인화면 UI 설정을 위한 Recipe - - - - - 메인화면 FOV 행렬 위치 - - - - - 메인화면 타입 - - - - - Clone (Deep Copy) - - MainUiRecipe - - - - 얼라인 정위치(Reference Point) 설정을 위한 레시피 - - - - - FOV의 중심 위치로부터의 오프셋 [mm] - - - - - RefPointRecipe를 깊은 복사한다. - - - - - - 데이터를 target에 복사한다. - - 복사 대상 - - - - 자재 좌표계 구성을 위한 레시피 - - - - - 기준 좌표계 대비 자재 좌표계의 방향을 설정 - - - - - FOV 간의 X, Y축 방향으로의 거리 - - - - - 얼라인 보정량 계산과 보정량 적용을 위한 회전 중심 - - - - - 깊은 복사 - - - - - - 데이터 복사 (this -> target) - - - - - - 하드웨어 카메라마다 여러 개의 FovInfo를 가질 수 있다. - - - - - 서브시스템별 공정 설정 관리 - - - - - 부착검사 시퀀스 FOV 타입 - - - - FOV 순서별 부착검사 파라미터 - - - - - Light Retry 사용 여부 - - - - - - Light Retry Value ( 모드 적용 시 움직일 Step 값 ) - - - - - Light Retry Value ( 모드 적용 시 움직일 Step 값 ) - - - - - Light Retry Step으로 반복 할 횟수 - - - - - 얼라인 모드(알고리즘)를 정의 - - - - 스테이지 얼라인 (스테이지 또는 자재가 이동) - - - 헤드 얼라인 (카메라, 레이저 등이 이동) - - - 장비에서 직접 구현하기 위한 모드 - - - 장비에서 직접 구현하기 위한 모드 - - - - 얼라인 계산 축(DOF) - 활성화한 축의 보정량만 계산된다. - 비활성화된 축의 보정량은 0이다. - - - - - 카메라 설정을 위한 Recipe - - - - - 카메라(HW) ID - - - - - 카메라(Aurora Device)의 CamId를 반환한다. - - 카메라의 Aurora Device ID - CamId - - - - Clone (Deep Copy) - - CamRecipe - - - - 하드웨어 카메라마다 고유하게 지정 - - - - - 하드웨어 조명 컨트롤러마다 고유하게 지정 - - - - 얼라인 혹은 검사에 대한 string ID - - - - 하나의 FOV 내에서 동시에 찾을 패턴의 갯수 ID - EX) ProcPattern1 : 1개 / ProcPattern2 : 2개 / ... / ProcPattern10 : 10개 - - - - - SubSystem별 비전 셋업 기능을 위한 레시피 - - - - - 캘리브레이션 시퀀스 설정 - - - - - 센터튜닝 시퀀스 설정 (필요시 생성) - - - - - FOV별 비전 셋업 기능을 위한 레시피 - - - - - Auto Focus 시퀀스 설정 (필요시 생성) - - - - - 비전 반복도 시퀀스 설정 (필요시 생성) - - - - - 메인 카메라뷰 FOV UI Row/Column 위치 - (EX : RC_02 -> 0행 2열) - (EX : RC_10 -> 1행 0열) - - - - - 현재 실행 중인 SW의 Recipe 구성에 맞게 - 장비에 저장된 Recipe 파일을 업데이트 한다. - - - - - 레시피 업데이트를 실행한다. - - 레시피 또는 모델 - 실행 결과 - - - 현재 SW의 레시피 버전 - - - 레시피 최초 버전 - - - - Aurora Ingredient에서 관리되는 비전 레시피 - - - - - Aurora Model에서 관리되는 비전 레시피 - - - - - 서브 시퀀스 파라미터 베이스 클래스 - - - - 시퀀스 모드 - - - - 생성자 - - 시퀀스 모드 - - - - 서브 시퀀스 매니저 - - - - - 서브 시퀀스의 시퀀스빌더를 생성한다. - - 서브 시퀀스 객체 - 시퀀스 이름 - 시퀀스빌더 - - - - 서브 시퀀스 추상 베이스 클래스 - - - - - 서브 시퀀스의 시퀀스빌더 생성 - - 서브 시퀀스 이름 - 시퀀스빌더 - - - - 무브 후, 그랩 전 딜레이 적용 - - 서브 시스템 정보 - - - - 에러로그 출력 및 Toast 메시지 띄우기 - - 로거 - 에러 메시지 - - - - 에러로그 출력 및 Toast 메시지 띄우기 - - 로거 - 메시지 - - - - C2_F4 or C4_F4 라인 교점 얼라인시, 이웃한 FOV들 간에 상관관계를 이용하여 라인 교점을 보상할지 체크 - - - - - - 반드시 RegisterSetting이 끝난 이후에 수행되어야 함. - - - - - Aurora Recipe에서 관리되는 비전 레시피 - - - - - 자재 좌표계의 FOV 위치(오프셋 포함)를 반환한다. - - FovInfo - FOV 위치 - - - - 자재 좌표계의 FOV 위치(오프셋 포함)를 반환한다. - - SubSysInfo - eFovId - FOV 위치 - - - - 자재 좌표계의 FOV 위치(오프셋 포함)를 반환한다. - - eUnitId - eSubSysId - eFovId - FOV 위치 - - - - 얼라인 정위치(Reference Point) 레시피를 반환한다. - - FovInfo - RefPointRecipe - - - - 얼라인 정위치(Reference Point) 레시피를 반환한다. - - UnitId - SubSysId - FovId - RefPointRecipe - - - - 얼라인 정위치(Reference Point)를 반환한다. - - SubSysInfo - FovId - Reference Point - - - - 얼라인 정위치(Reference Point)를 반환한다. - - FovInfo - Reference Point - - - - 얼라인 정위치(Reference Point)를 반환한다. - - UnitId - SubSysId - FovId - Reference Point - - - 비전 레시피를 저장할 Aurora의 데이터 타입 - - - Aurora의 Recipe에 저장 - - - Aurora의 Model에 저장 - - - Aurora의 Ingredient에 저장 - - - 설정 - 비전 레시피를 저장할 Aurora의 데이터 타입 - - - - UI 바인딩 및 레시피 저장이 필요한 뷰에서 상속받아 구현한다. - - - - 비전 레시피를 최신으로 갱신한다. - - - _VsRps = VisionRecipeManager.GetVisionRecipes(_VsRps.SubSysInfo); // 레시피 갱신 - - - - - - 최신 레시피 복사본을 UI에 업데이트한다. - - - var vsRps = VisionRecipeManager.GetVisionRecipes(_VsRps.SubSysInfo); // 레시피 새로 읽기 - var alignRecipe = vsRps.AlignRecipes[_AlignIdx].Clone(); // 레시피 복사 - AlignRetry = alignRecipe.AlignRetry; // 레시피 업데이트(바인딩) - - - - - - 파일 저장 전, UI에서 읽어온 레시피를 메모리에 업데이트 한다. - - - var vsRps = VisionRecipeManager.GetVisionRecipes(_VsRps.SubSysInfo); // 레시피 새로 읽기 - var alignRecipe = vsRps.AlignRecipes[_AlignIdx]; - alignRecipe.AlignRetry = AlignRetry; // 레시피 메모리에 쓰기 - RecipeFileManager.SaveVisionRecipe(); // 레시피 파일 저장 (함수 외부에서 저장해도 됨) - - - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCommonUI.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCommonUI.dll deleted file mode 100644 index 6c95e11..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCommonUI.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCommonUI.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCommonUI.xml deleted file mode 100644 index afca758..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCommonUI.xml +++ /dev/null @@ -1,2104 +0,0 @@ - - - - VisionCommonUI - - - - - CamDeviceSettingView - - - - - InitializeComponent - - - - - ChildImageSettingView - - - - - InitializeComponent - - - - - VerifyParentImageWindow - - - - - InitializeComponent - - - - - ChildImageSettingWindow - - - - - InitializeComponent - - - - - CamDeviceSettingWindow - - - - - InitializeComponent - - - - - 레시피 항목이 누락되어 UI를 그리지 못할 경우 에러 메시지 출력 - - - UCRecipeErrorTextBlock - - - - - InitializeComponent - - - - - CameraLightSettingView - - - - - InitializeComponent - - - - - CameraLightSettingViewEachCh - - - - - InitializeComponent - - - - - CameraLightSettingWindow - - - - - InitializeComponent - - - - - 특정 서브시스템 / 모든 카메라 - 모든 조명 윈도우들 띄우기 - - - - - 특정 서브시스템 / 특정 카메라 - 특정 조명 윈도우 띄우기 - - - - - 특정 서브시스템 / 모든 카메라 - 모든 조명 윈도우들 리턴 - - - - - 특정 서브시스템 / 특정 카메라 - 특정 조명 윈도우 리턴 - - - - - 특정 서브시스템 / 모든 카메라 - 모든 조명 뷰들 리턴 - - - - - 특정 서브시스템 / 특정 카메라 - 조명 뷰 리턴 - - - - - PatternLightSettingView - - - - - InitializeComponent - - - - - PatternLightSettingViewEachCh - - - - - InitializeComponent - - - - - PatternLightSettingWindow - - - - - InitializeComponent - - - - - 특정 서브시스템 / 특정 카메라 - 특정 조명 윈도우 띄우기 - - - - - MessageBoxError - - - - - InitializeComponent - - - - - MessageBoxInfo - - - - - InitializeComponent - - - - - MessageBoxOk - - - - - InitializeComponent - - - - - MessageBoxPassword - - - - - InitializeComponent - - - - - MessageBoxQuestion - - - - - InitializeComponent - - - - - MessageBoxQuestionOption - - - - - InitializeComponent - - - - - MessageBoxQuestionOption_Modaless.xaml에 대한 상호 작용 논리 - - - MessageBoxQuestionOption_Modaless - - - - - InitializeComponent - - - - - MessageBoxSaveData - - - - - 데이터 저장시, 전후 값을 비교하기 위함. - - 비교할 데이터의 변경 전의 값들 - 비교할 데이터의 변경 후의 값들 - - - - InitializeComponent - - - - - MessageBoxWarning - - - - - InitializeComponent - - - - - Interaction logic for PatternBlockSettingView.xaml - - - PatternBlockSettingView - - - - - InitializeComponent - - - - - Interaction logic for PatternTrackingSettingView.xaml - - - PatternTrackingSettingView - - - - - InitializeComponent - - - - - Interaction logic for PatternTrackingSettingWindow.xaml - - - PatternTrackingSettingWindow - - - - - InitializeComponent - - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to Acceptance. - - - - - Looks up a localized string similar to Accuracy. - - - - - Looks up a localized string similar to Activated. - - - - - Looks up a localized string similar to Align. - - - - - Looks up a localized string similar to Align Id. - - - - - Looks up a localized string similar to Align mode. - - - - - Looks up a localized string similar to Align Motor Direction. - - - - - Looks up a localized string similar to Align Name. - - - - - Looks up a localized string similar to All. - - - - - Looks up a localized string similar to Angle. - - - - - Looks up a localized string similar to Any. - - - - - Looks up a localized string similar to Apply. - - - - - Looks up a localized string similar to Area. - - - - - Looks up a localized string similar to Attach. - - - - - Looks up a localized string similar to Attach Insp. - - - - - Looks up a localized string similar to Attach Insp Params. - - - - - Looks up a localized string similar to Auto. - - - - - Looks up a localized string similar to Auto Focus. - - - - - Looks up a localized string similar to Baud Rate. - - - - - Looks up a localized string similar to Binarization. - - - - - Looks up a localized string similar to Bit Depth. - - - - - Looks up a localized string similar to Black. - - - - - Looks up a localized string similar to Block. - - - - - Looks up a localized string similar to Blocks. - - - - - Looks up a localized string similar to Board Port Pos. - - - - - Looks up a localized string similar to Board Slot Pos. - - - - - Looks up a localized string similar to Board Type. - - - - - Looks up a localized string similar to Brightness. - - - - - Looks up a localized string similar to Buffer. - - - - - Looks up a localized string similar to Buffer. - - - - - Looks up a localized string similar to Cam. - - - - - Looks up a localized string similar to Cam Connection Config. - - - - - Looks up a localized string similar to Camera Direction. - - - - - Looks up a localized string similar to Cam Id. - - - - - Looks up a localized string similar to Cam Move. - - - - - Looks up a localized string similar to Cam Pattern. - - - - - Looks up a localized string similar to Cancel. - - - - - Looks up a localized string similar to Center. - - - - - Looks up a localized string similar to Center Tuning. - - - - - Looks up a localized string similar to Certainty. - - - - - Looks up a localized string similar to Channel. - - - - - Looks up a localized string similar to Channels. - - - - - Looks up a localized string similar to Ch Colors. - - - - - Looks up a localized string similar to Ch DevTypes. - - - - - Looks up a localized string similar to Clear. - - - - - Looks up a localized string similar to Close. - - - - - Looks up a localized string similar to Count. - - - - - Looks up a localized string similar to Code. - - - - - Looks up a localized string similar to Color. - - - - - Looks up a localized string similar to Common. - - - - - Looks up a localized string similar to Connection Config. - - - - - Looks up a localized string similar to Continuous. - - - - - Looks up a localized string similar to Contrast. - - - - - Looks up a localized string similar to Control. - - - - - Looks up a localized string similar to Coordinate. - - - - - Looks up a localized string similar to Copy. - - - - - Looks up a localized string similar to Dark. - - - - - Looks up a localized string similar to Data Bits. - - - - - Looks up a localized string similar to Dcf File Path. - - - - - Looks up a localized string similar to Delete. - - - - - Looks up a localized string similar to Description. - - - - - Looks up a localized string similar to Detail. - - - - - Looks up a localized string similar to Diagram. - - - - - Looks up a localized string similar to Dim Range. - - - - - Looks up a localized string similar to Direction T. - - - - - Looks up a localized string similar to Dist. - - - - - Looks up a localized string similar to Distance step. - - - - - Looks up a localized string similar to Distance unit. - - - - - Looks up a localized string similar to Distance X. - - - - - Looks up a localized string similar to Distance Y. - - - - - Looks up a localized string similar to Data Terminal Ready. - - - - - Looks up a localized string similar to Edge. - - - - - Looks up a localized string similar to Edit. - - - - - Looks up a localized string similar to Enabled. - - - - - Looks up a localized string similar to Enter. - - - - - Looks up a localized string similar to Eraser. - - - - - Looks up a localized string similar to Error. - - - - - Looks up a localized string similar to ErrorRotation. - - - - - Looks up a localized string similar to Err Rotation. - - - - - Looks up a localized string similar to Exposure Time. - - - - - Looks up a localized string similar to Filter. - - - - - Looks up a localized string similar to Filter Half Size In Pixels. - - - - - Looks up a localized string similar to Filtering. - - - - - Looks up a localized string similar to Filtering Type. - - - - - Looks up a localized string similar to Find. - - - - - Looks up a localized string similar to Fit. - - - - - Looks up a localized string similar to Fixture. - - - - - Looks up a localized string similar to Flip and Rotation. - - - - - Looks up a localized string similar to Flip Y. - - - - - Looks up a localized string similar to Flying. - - - - - Looks up a localized string similar to Flying Cnt. - - - - - Looks up a localized string similar to Flying Enabled. - - - - - Looks up a localized string similar to Force OK enabled. - - - - - Looks up a localized string similar to Foreground. - - - - - Looks up a localized string similar to Fov Id. - - - - - Looks up a localized string similar to Fov Layout. - - - - - Looks up a localized string similar to Fov Name. - - - - - Looks up a localized string similar to Grab. - - - - - Looks up a localized string similar to Grab Retry. - - - - - Looks up a localized string similar to Grab Timeout. - - - - - Looks up a localized string similar to Graph. - - - - - Looks up a localized string similar to Height. - - - - - Looks up a localized string similar to High. - - - - - Looks up a localized string similar to History. - - - - - Looks up a localized string similar to Horizontal. - - - - - Looks up a localized string similar to Hardware. - - - - - Looks up a localized string similar to Hw Trigger Config. - - - - - Looks up a localized string similar to ID. - - - - - Looks up a localized string similar to Ignore. - - - - - Looks up a localized string similar to Image. - - - - - Looks up a localized string similar to Image Flip. - - - - - Looks up a localized string similar to Image Format. - - - - - Looks up a localized string similar to Image Rotation. - - - - - Looks up a localized string similar to Image Size. - - - - - Looks up a localized string similar to In. - - - - - Looks up a localized string similar to Info. - - - - - Looks up a localized string similar to Information. - - - - - Looks up a localized string similar to Insp. - - - - - Looks up a localized string similar to Ip Address. - - - - - Looks up a localized string similar to Layout. - - - - - Looks up a localized string similar to Lens Type. - - - - - Looks up a localized string similar to Light. - - - - - Looks up a localized string similar to Light Delay. - - - - - Looks up a localized string similar to Light Model. - - - - - Looks up a localized string similar to Light Type. - - - - - Looks up a localized string similar to Limit. - - - - - Looks up a localized string similar to Limit T. - - - - - Looks up a localized string similar to Limit X. - - - - - Looks up a localized string similar to Limit Y. - - - - - Looks up a localized string similar to Line. - - - - - Looks up a localized string similar to List. - - - - - Looks up a localized string similar to Live Delay. - - - - - Looks up a localized string similar to Log. - - - - - Looks up a localized string similar to Low. - - - - - Looks up a localized string similar to Manual Find Enabled. - - - - - Looks up a localized string similar to Mask. - - - - - Looks up a localized string similar to Masking. - - - - - Looks up a localized string similar to Material. - - - - - Looks up a localized string similar to Material Direction. - - - - - Looks up a localized string similar to Max. - - - - - Looks up a localized string similar to MIL Error Print. - - - - - Looks up a localized string similar to Min. - - - - - Looks up a localized string similar to Mode. - - - - - Looks up a localized string similar to Model. - - - - - Looks up a localized string similar to Morphology. - - - - - Looks up a localized string similar to Motor Direction. - - - - - Looks up a localized string similar to Motor Direction. - - - - - Looks up a localized string similar to Motor Move Type X. - - - - - Looks up a localized string similar to Motor Move Type Y. - - - - - Looks up a localized string similar to Move axis. - - - - - Looks up a localized string similar to Move enabled. - - - - - Looks up a localized string similar to Move Step. - - - - - Looks up a localized string similar to AlignProcSeqParams is Null.. - - - - - Looks up a localized string similar to AlignResult is Null.. - - - - - Looks up a localized string similar to AutoFocusRecipe of {0} is Null.. - - - - - Looks up a localized string similar to Final BackStepValue ({0}mm) is over limit (4mm).. - - - - - Looks up a localized string similar to Calibration Calc stopped : Return param empty. - - - - - Looks up a localized string similar to Calibration Seq Stopped : Pattern Not Found. - - - - - Looks up a localized string similar to Description could Not be empty!. - - - - - Looks up a localized string similar to Digitizer Init Error.. - - - - - Looks up a localized string similar to FOV ID is duplicated.. - - - - - Looks up a localized string similar to Exposure Time Setting Error.. - - - - - Looks up a localized string similar to Fov Id is duplicated.. - - - - - Looks up a localized string similar to Image Not Allocated.. - - - - - Looks up a localized string similar to Image Not Ready.. - - - - - Looks up a localized string similar to Image Size Setting Error.. - - - - - Looks up a localized string similar to Train origin must be within Find ROI.. - - - - - Looks up a localized string similar to No Cognex License.. - - - - - Looks up a localized string similar to No MIL License.. - - - - - Looks up a localized string similar to No Sub Patterns.. - - - - - Looks up a localized string similar to Not Setted Fov Exist.. - - - - - Looks up a localized string similar to Enter valid input.\n[{1} < {0} <= {2}]. - - - - - Looks up a localized string similar to Param is Null.. - - - - - Looks up a localized string similar to For {0}, finding is NOT supported now.. - - - - - Looks up a localized string similar to Pattern Not Activated.. - - - - - Looks up a localized string similar to Pattern NOT found.. - - - - - Looks up a localized string similar to Pattern Not Trained.. - - - - - Looks up a localized string similar to For {0}, finding is NOT supported now.. - - - - - Looks up a localized string similar to PatternType could Not be None!. - - - - - Looks up a localized string similar to Register two LineFinder patterns first!. - - - - - Looks up a localized string similar to Select Block Id.. - - - - - Looks up a localized string similar to Please select different Block Id.. - - - - - Looks up a localized string similar to {0} Not Allocated.. - - - - - Looks up a localized string similar to Train Failed.. - - - - - Looks up a localized string similar to Train ROI is NOT set.. - - - - - Looks up a localized string similar to Trigger Setting Error.. - - - - - Looks up a localized string similar to Select a process id.. - - - - - Looks up a localized string similar to Select a process pattern id.. - - - - - Looks up a localized string similar to Copy Completed.. - - - - - Looks up a localized string similar to Register Completed.. - - - - - Looks up a localized string similar to Save Completed.. - - - - - Looks up a localized string similar to Train Completed.. - - - - - Looks up a localized string similar to Do you want to apply mask to sub patterns?. - - - - - Looks up a localized string similar to Do you want to apply Pattern {0} as a process pattern?. - - - - - Looks up a localized string similar to Do you want to clear the pattern tracking position?. - - - - - Looks up a localized string similar to Do you want to move by align delta? {0}. - - - - - Looks up a localized string similar to Do you want to run vision calibration?. - - - - - Looks up a localized string similar to Do you want to run Vision Repeat at this position?. - - - - - Looks up a localized string similar to Do you want to run Vision(Motion) Repeat?. - - - - - Looks up a localized string similar to Would you like to save your data?. - - - - - Looks up a localized string similar to Do you want to save the best position[{0}]?. - - - - - Looks up a localized string similar to You cannot save data during auto-operation.. - - - - - Looks up a localized string similar to Vision calibration is complete. Would you like to save your cal-data?. - - - - - Looks up a localized string similar to Masking image will be deleted. Do you want to continue to train pattern?. - - - - - Looks up a localized string similar to Do you want to copy Pattern 0?. - - - - - Looks up a localized string similar to Do you want to delete?. - - - - - Looks up a localized string similar to Pattern [{0}] of [{1} of {2}] already exists. Do you want to delete and copy the pattern?. - - - - - Looks up a localized string similar to Do you want to delete Pattern {0}?. - - - - - Looks up a localized string similar to Do you want to sync origin with Pattern {0}?. - - - - - Looks up a localized string similar to Do you want to save the Calibration data?. - - - - - Looks up a localized string similar to All sub patterns will be removed.. - - - - - Looks up a localized string similar to Current Cog Version is {0} and Bit Type is {1}.. - - - - - Looks up a localized string similar to Current MIL Version is {0} and Bit Type is {1}.. - - - - - Looks up a localized string similar to {0} must be less than {1}.. - - - - - Looks up a localized string similar to {0} must be more than {1}.. - - - - - Looks up a localized string similar to Pattern {0} NOT found.. - - - - - Looks up a localized string similar to Quick Find is fast in small angle and scale. - - - - - Looks up a localized string similar to Negative. - - - - - Looks up a localized string similar to New. - - - - - Looks up a localized string similar to No. - - - - - Looks up a localized string similar to Number. - - - - - Looks up a localized string similar to Object. - - - - - Looks up a localized string similar to Off. - - - - - Looks up a localized string similar to Off Delay. - - - - - Looks up a localized string similar to Offset. - - - - - Looks up a localized string similar to Offset T. - - - - - Looks up a localized string similar to Offset X. - - - - - Looks up a localized string similar to Offset Y. - - - - - Looks up a localized string similar to OK. - - - - - Looks up a localized string similar to Old. - - - - - Looks up a localized string similar to On. - - - - - Looks up a localized string similar to (Optional). - - - - - Looks up a localized string similar to Origin. - - - - - Looks up a localized string similar to Others. - - - - - Looks up a localized string similar to Out. - - - - - Looks up a localized string similar to Out Bit. - - - - - Looks up a localized string similar to Out Index. - - - - - Looks up a localized string similar to Out Port. - - - - - Looks up a localized string similar to Param. - - - - - Looks up a localized string similar to Parameter. - - - - - Looks up a localized string similar to Parameters. - - - - - Looks up a localized string similar to Params. - - - - - Looks up a localized string similar to Parity. - - - - - Looks up a localized string similar to Pattern. - - - - - Looks up a localized string similar to Patterns. - - - - - Looks up a localized string similar to Pixel. - - - - - Looks up a localized string similar to Point. - - - - - Looks up a localized string similar to Polarity. - - - - - Looks up a localized string similar to Port Number. - - - - - Looks up a localized string similar to Position. - - - - - Looks up a localized string similar to Positive. - - - - - Looks up a localized string similar to Pre. - - - - - Looks up a localized string similar to Proc. - - - - - Looks up a localized string similar to Proc Fov Type. - - - - - Looks up a localized string similar to Proc Test. - - - - - Looks up a localized string similar to No. - - - - - Looks up a localized string similar to Radius. - - - - - Looks up a localized string similar to Range T. - - - - - Looks up a localized string similar to Range X. - - - - - Looks up a localized string similar to Range Y. - - - - - Looks up a localized string similar to Read Retry Count. - - - - - Looks up a localized string similar to Read Timeout. - - - - - Looks up a localized string similar to [{0}] is not set up properly.. - - - - - Looks up a localized string similar to Recipe Model Type. - - - - - Looks up a localized string similar to Recipe Setting. - - - - - Looks up a localized string similar to Ref. - - - - - Looks up a localized string similar to Reference. - - - - - Looks up a localized string similar to Region. - - - - - Looks up a localized string similar to Register. - - - - - Looks up a localized string similar to Reload. - - - - - Looks up a localized string similar to Retry. - - - - - Looks up a localized string similar to Retry cnt. - - - - - Looks up a localized string similar to ROI. - - - - - Looks up a localized string similar to Root Dir Path. - - - - - Looks up a localized string similar to Rotation. - - - - - Looks up a localized string similar to Rotation step. - - - - - Looks up a localized string similar to Rotation unit. - - - - - Looks up a localized string similar to Rotation X. - - - - - Looks up a localized string similar to Request To Send. - - - - - Looks up a localized string similar to Save. - - - - - Looks up a localized string similar to Save OK Image. - - - - - Looks up a localized string similar to Save OK Overlay Image. - - - - - Looks up a localized string similar to SaveParams. - - - - - Looks up a localized string similar to Scale. - - - - - Looks up a localized string similar to Score. - - - - - Looks up a localized string similar to Setting. - - - - - Looks up a localized string similar to Setup Direction. - - - - - Looks up a localized string similar to Sharpness. - - - - - Looks up a localized string similar to Show. - - - - - Looks up a localized string similar to Show Diagram. - - - - - Looks up a localized string similar to Size. - - - - - Looks up a localized string similar to Smoothness. - - - - - Looks up a localized string similar to Speed. - - - - - Looks up a localized string similar to Start. - - - - - Looks up a localized string similar to Start Axis Repeat. - - - - - Looks up a localized string similar to Start Vision Repeat. - - - - - Looks up a localized string similar to Static Move. - - - - - Looks up a localized string similar to Stop. - - - - - Looks up a localized string similar to Stop Bits. - - - - - Looks up a localized string similar to Strobe. - - - - - Looks up a localized string similar to Sub. - - - - - Looks up a localized string similar to SubRegion. - - - - - Looks up a localized string similar to SubSystem. - - - - - Looks up a localized string similar to SubSystem Id. - - - - - Looks up a localized string similar to SubSystem Name. - - - - - Looks up a localized string similar to SubSystem Type. - - - - - Looks up a localized string similar to Software. - - - - - Looks up a localized string similar to Sync. - - - - - Looks up a localized string similar to Target. - - - - - Looks up a localized string similar to Test. - - - - - Looks up a localized string similar to Theta. - - - - - Looks up a localized string similar to Thickness. - - - - - Looks up a localized string similar to Threshold. - - - - - Looks up a localized string similar to Tolerance. - - - - - Looks up a localized string similar to Tool. - - - - - Looks up a localized string similar to Tracking. - - - - - Looks up a localized string similar to Train. - - - - - Looks up a localized string similar to Trig Buf Cnt. - - - - - Looks up a localized string similar to TrigSrc. - - - - - Looks up a localized string similar to Trig Type. - - - - - Looks up a localized string similar to Type. - - - - - Looks up a localized string similar to Unit Id. - - - - - Looks up a localized string similar to Unit Name. - - - - - Looks up a localized string similar to Attach Inspection. - - - - - Looks up a localized string similar to Auto Focus. - - - - - Looks up a localized string similar to Calibration. - - - - - Looks up a localized string similar to Camera Base View. - - - - - Looks up a localized string similar to Use Cam Pattern. - - - - - Looks up a localized string similar to Carrier ID. - - - - - Looks up a localized string similar to Center Tuning. - - - - - Looks up a localized string similar to Lot ID. - - - - - Looks up a localized string similar to Main Camera Window. - - - - - Looks up a localized string similar to Material ID. - - - - - Looks up a localized string similar to Use Proc Test. - - - - - Looks up a localized string similar to Use Quick Find. - - - - - Looks up a localized string similar to Vision Repeat. - - - - - Looks up a localized string similar to Using Align Motor. - - - - - Looks up a localized string similar to Value. - - - - - Looks up a localized string similar to Vertical. - - - - - Looks up a localized string similar to Vision Repeat. - - - - - Looks up a localized string similar to White. - - - - - Looks up a localized string similar to Width. - - - - - Looks up a localized string similar to Write Timeout. - - - - - Looks up a localized string similar to Yes. - - - - - Looks up a localized string similar to Zoom. - - - - - Interaction logic for UCContentComboBox.xaml - - - UCContentComboBox - - - - - InitializeComponent - - - - - Interaction logic for UCContentSlider.xaml - - - - - UCContentSlider - - - - - InitializeComponent - - - - - GeneratedInternalTypeHelper - - - - - CreateInstance - - - - - GetPropertyValue - - - - - SetPropertyValue - - - - - CreateDelegate - - - - - AddEventHandler - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCore.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCore.dll deleted file mode 100644 index 42eb3d7..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionCore.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionDirector.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionDirector.dll deleted file mode 100644 index 25c18c3..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionDirector.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionDirector.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionDirector.xml deleted file mode 100644 index aae1edb..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionDirector.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - VisionDirector - - - - - TeachingDirector를 관리하는 매니저 - - - - - TeachingDirectorManager의 싱글턴 인스턴스 - - - - - AlignDirector를 관리하는 매니저 - - - - - AlignDirectorManager의 싱글턴 인스턴스 - - - - - AlignMotor의 Director - - - - - 생성자 - - 서브시스템 정보 - - - - MotionDirector를 관리하는 매니저 - - - - - MotionDirector를 Set한다. - - SubSysInfo(KEY) - MotionDirector(VALUE) - - - - MotionDirector를 Get한다. - - SubSysInfo(KEY) - MotionDirector(VALUE) - - - - 모터의 좌표계를 관리한다. - - - - - 생성자 - - SubSysInfo - - - - 레시피 업데이트 - - - - - 자재 기준의 Position을 모터 기준 Position으로 변환 - - 자재 좌표계의 Position - 모터 좌표계의 Position - - - - 자재 기준의 DoublePoint를 모터 기준 DoublePoint로 변환 - - 자재 좌표계의 DoublePoint - 모터 좌표계의 DoublePoint - - - - 자재 기준의 T축 방향을 모터 기준 T축 방향으로 변환 - - 자재 좌표계의 T축 방향 - 모터 좌표계의 T축 방향 - - - - 자재 기준의 Z축 방향을 모터 기준 Z축 방향으로 변환 - - 자재 좌표계의 Z축 방향 - 모터 좌표계의 Z축 방향 - - - - 모션 디렉터 생성 및 등록 - - - - - 모션 디렉터 생성 및 등록 - - - - - TeachingMotor의 Director - - - - - 생성자 - - 서브시스템 정보 - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionInspector.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionInspector.dll deleted file mode 100644 index 9c30bbf..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionInspector.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionLight.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionLight.dll deleted file mode 100644 index 73821f3..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionLight.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionLight.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionLight.xml deleted file mode 100644 index 8984f11..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionLight.xml +++ /dev/null @@ -1,1336 +0,0 @@ - - - - VisionLight - - - - - LightBase (SerialModbus) - - - - 시리얼 통신 베이스 - - - - 생성자 - EquipmentInfo.SimulationMode로 시뮬레이션 상태를 설정한다. - - 디바이스 ID - - - - 생성자 - - 디바이스 ID - 시뮬레이션 상태 - - - - 디바이스 Activate - - 디바이스 컨피그 - - - - - 디바이스 Deactivate - - - - - - 조명 켜기 - - 채널 번호 - 조명 제어 결과 - - - - 조명 끄기 - - 채널 번호 - 조명 제어 결과 - - - - 조명 상태 가져오기 - - 채널 번호 - 조명 상태 (on : true, off : false) - - - - 조명 값 가져오기 - - 채널 번호 - 조명 값 - - - - 조명 값 제어 (개별) - - 레벨 - 채널 번호 - 조명 제어 결과 - - - - 연결되어있는지 확인 필요 - - - - - - Write double world - - 주소 - 값 - - - - - Write Real - - 주소 - 값 - - - - - Read Word - - 주소 - - - - - Read Double Word - - 주소 - - - - - Read Real - - 주소 - - - - - 소켓 조명 베이스 클래스 - - - - 소켓 통신 - - - - 생성자 - EquipmentInfo.SimulationMode로 시뮬레이션 상태를 설정한다. - - 디바이스 ID - - - - 생성자 - - 디바이스 ID - 시뮬레이션 상태 - - - - 디바이스 Activate - - 디바이스 컨피그 - - - - - 디바이스 Deactivate - - - - - - 조명 켜기 - - 채널 번호 - 조명 제어 결과 - - - - 조명 끄기 - - 채널 번호 - 조명 제어 결과 - - - - 조명 상태 가져오기 - - 채널 번호 - 조명 상태 (on : true, off : false) - - - - 조명 값 가져오기 - - 채널 번호 - 조명 값 - - - - 조명 값 제어 (개별) - - 레벨 - 채널 번호 - 조명 제어 결과 - - - - 시리얼 조명 베이스 클래스 - - - - 시리얼 통신 - - - - 생성자 - EquipmentInfo.SimulationMode로 시뮬레이션 상태를 설정한다. - - 디바이스 ID - - - - 생성자 - - 디바이스 ID - 시뮬레이션 상태 - - - - 디바이스 Activate - - 디바이스 컨피그 - - - - - 디바이스 Deactivate - - - - - - 조명 켜기 - - 채널 번호 - 조명 제어 결과 - - - - 조명 끄기 - - 채널 번호 - 조명 제어 결과 - - - - 조명 상태 가져오기 - - 채널 번호 - 조명 상태 (on : true, off : false) - - - - 조명 값 가져오기 - - 채널 번호 - 조명 값 - - - - 조명 값 제어 (개별) - - 레벨 - 채널 번호 - 조명 제어 결과 - - - - 조명 디바이스 모델 리스트 - 이름 형식 : 제조사_모델 - - - - - - TSM사 P12RV2 - - - - - TSM사 I16R - - - - - TSM사 STM16C - - - - - LVS사 PN - - - - - LVS사 PT0105 - - - - - LVS사 PT0205 - - - - - LVS사 PT0405 - - - - - LVS사 EN04 - - - - - LVS사 EN04_SOCKET - - - - - LVS사 ES08 - - - - - LVS사 ES08_SOCKET - - - - - LEESOS LPD - - - - - CCS - - - - - IPLUS MODBUS_SERIAL - - - - - ERI사 E_MINI - - - - - 장비 전용 조명 디바이스 A - - - - - 장비 전용 조명 디바이스 B - - - - - 장비 전용 조명 디바이스 C - , - - - - 조명 구동 방식 - - - - 상시 구동 - - - 점멸 구동 (짧은 시간 동안 강한 빛을 내는 섬광 방식) - - - - 조명 컬러 타입 - - - - - Red - - - - - Green - - - - - Blue - - - - - White - - - - - None - - - - - 조명 장치 타입 - - - - - Bar형 - - - - - Ring 형 - - - - - Half Ring 형 - - - - - Side - - - - - Spot - - - - - Coaxial - - - - - Half Coaxial - - - - - BackLight - - - - - ETC - - - - - 조명 연결 타입 - - - - - Serial - - - - - Socket - - - - - ModBus Serial - - - - - None - - - - - 조명 디바이스 컨피그 (베이스) - - - - - Light Model - - - - - Light Type - - - - 미사용 - - - 레벨 Min, Max - - - 총 채널 개수 - - - - Channel Config - - - - - 디폴트 조명 컨피그 가져오기 - - 조명 연결 타입 - 조명 디바이스 컨피그 - - - - 조명 디바이스 컨피그 (시리얼 통신용) - - - - - Serial Connection Config - - - - - 조명 디바이스 컨피그 (소켓 통신용) - - - - - Socket Connection 컨피그 - - - - - 조명 디바이스 컨피그 (모드버스 시리얼 통신용) - - - - - Light Config(Modbus Serial) - - - - - Modbus Serial Connection Config - - - - - Light Config Info - LighId | DimRange | ChConfig - - - - - Light Id - - - - - Dim Ranged (0, 255) - - - - - Channel Config - - - - - Clone - - - - - - Copy To Target - - 복사할 타겟 - - - - 채널 컨피그 - - - - - 채널 - - - - - On/Off - - - - - 레벨 - - - - - Light 디바이스 종류 - - - - - 컬러 타입 - - - - - 캠 ID - - - - - Clone - - - - - - Copy To Target - - 복사할 타겟 - - - - Light Hub - - - - - 싱글턴 객체 instance - - - - - Light 컨피그 정보 리스트 가져오기 - - 카메라 Id - Light Config info List - - - - Light 컨피그 정보 가져오기 - - Light ID - 채널 - - - - - Light Id 리스트 가져오기 - - Light 리스트 - - - - 조명 켜기 - - 조명 아이디 - 채널 번호 - 조명 제어 결과 - - - - 조명 끄기 - - 조명 아이디 - 채널 번호 - 조명 제어 결과 - - - - 조명 상태 가져오기 - - 조명 아이디 - 채널 번호 - 조명 상태 (on : true, off : false) - - - - 라이트 레벨 설정하기 (list) - - 라이트 파라미터들 - - - - - 라이트 레벨 설정하기 - - 라이트 Id - 채널 레벨 - 채널 숫자 - - - - - 라이트 파라미터 리스트 가져오기 - - 카메라 ID - - - - - 라이트 컨피그 정보 저장하기 - - 라이트 컨피그 정보들 - - - - 해제 - - - - - LightControlCCS_Library 사용 (Socket) - Inkjet Oledos 향 검증 완료 - - - - - Light CCS 생성자 - - Device Id - Simulation Mode - - - - Light CCS 생성자 - - 디바이스 Id - - - - Set Level Implement - - 레벨 - 채널 - - - - - Set Off Implement - - 채널 - Light 결과 값 - - - - Set On Implement - - 채널 - Light 결과 값 - - - - Device Activate - - Device Config - 결과 값 - - - - Device Deactiavate 될 때 호출 - - - - - - MagnetAttach strobe 조명으로 사용. - light 관련 time delay 필요했던 조명 - 조명 Mode를 변경할 경우 늦게 반영되는 경우가 많아, 자주 변경할 경우 GrabSeq와 별개로 별도로 호출해서도 사용 하였음 ( eLightMode ) - !주의! 다른 Light와는 상대적으로 Thread sleep이 자주 호출됨. ( 추후 재검증 시 확인 후 주석 처리 할 것 ) - - - - - Light Mode - - - - - Off - - - - - Continous - - - - - Strobe - - - - - Light IPlus Modbus Serial 생성자 - - 디바이스 Id - - - - Set Level Implement - - 레벨 - 채널 - - - - - Set Off Implement - - 채널 - Light 결과 값 - - - - Set On Implement - - 채널 - Light 결과값 - - - - 모드 변경 - - Light Mode - Light 결과 값 - - - - Duration Setting - - continous duriation setting - - - - - [상시 조명 컨트롤러 - 16CH / 시리얼 통신][Series] - Range : (0,255) - Baudrate : 9600 bps - DataBit : 8 bit - StopBit : 1 bit - ParityBit : None - - - - - [상시 조명 컨트롤러 - 4CH / 시리얼 통신] - Range : (0,255) - Baudrate : 38400 bps - DataBit : 8 bit - StopBit : 1 bit - ParityBit : None - - - - - !!! 반드시 UDP로 통신할 해야 함 !!! - [상시 조명 컨트롤러 - 4CH / 소켓 통신] - Range : (0,255) - SocketProtocol : TCP or UDP - IpAddress : XXX.XXX.XXX.XXX - PortNumber : XXX - - - - - [상시 조명 컨트롤러 - 4CH / 시리얼 통신] - Range : (0,255) - Baudrate : 19200 bps - DataBit : 8 bit - StopBit : 1 bit - ParityBit : None - - - - - [스트로브 조명 컨트롤러 - 8CH / 시리얼 통신][Series] - Range : (0,999) us - Baudrate : 19200 bps - DataBit : 8 bit - StopBit : 1 bit - ParityBit : None - - - - - LVS PT Series Base Code - PT0105 | PT0205 | PT0405 - - - - - Light_LVS_PT생성자 - - 디바이스 Id - - - - Set On Implement - - 채널 - Light 결과 - - - - Set Off Implement - - 채널 - Light 결과 - - - - Set level Implement - - 레벨 - 채널 - - - - - Set On 할 때 요청 Msg - - ChannelRange 안의 Channel - - - - - Set Off 할 때 요청 Msg - - ChannelRange 안의 Channel - - - - - Set Level 할 때의 요청 Msg - - DimRange 안의 Level - ChannelRange 안의 Channel - - - - - [상시 조명 컨트롤러 - 1CH / 시리얼 통신] - Range : (0,1023) - Baudrate : 19200 or 57600 bps - DataBit : 8 bit - StopBit : 1 bit - ParityBit : None - - - - - LVS_PT0105 생성자 - - Device Id - - - - [상시 조명 컨트롤러 - 2CH / 시리얼 통신] - Range : (0,1023) - Baudrate : 19200 or 57600 bps - DataBit : 8 bit - StopBit : 1 bit - ParityBit : None - - - - - LVS_PT0205 생성자 - - Device Id - - - - Channel 개별로 설정하는 protocol이 없어 temp 저장하는 Channel 통신여부를 확인할 수 있는 Param 제공 - 2CH에만 제공. ( 1CH/4CH 개별로 세팅하는 protocol 존재 ) - - - - - Device Deactiavate 될 때 호출 - - - - - - [상시 조명 컨트롤러 - 4CH / 시리얼 통신] - Range : (0,1023) - Baudrate : 19200 or 57600 bps - DataBit : 8 bit - StopBit : 1 bit - ParityBit : None - - - - - Light LVS PT0405 생성자 - - 디바이스 ID - - - - !!! 반드시 UDP로 통신할 해야 함 !!! - [스트로브 조명 컨트롤러 - 8CH / 소켓 통신] - Range : (0,1000) - SocketProtocol : TCP or UDP - IpAddress : 192.168.0.231 (예시) - PortNumber : 50000 (예시) - - - - - LVS ES08 Socket 생성자 - - 디바이스 ID - - - - Set On Implement - - 채널 - Light 결과 값 - - - - Set Off Implement - - 채널 - Light 결과 값 - - - - Set Level Implement - - 레벨 - 채널 - Light 결과 값 - - - - [상시 조명 컨트롤러 - 12CH / 시리얼 통신] - Range : (0,255) or (0,512) - Baudrate : 19200 bps - DataBit : 8 bit - StopBit : 1 bit - ParityBit : None - - - - - [스트로브 조명 컨트롤러 - 8CH / 시리얼 통신] - Range : (0,4999) us - Baudrate : 115200 bps - DataBit : 8 bit - StopBit : 1 bit - ParityBit : None - - - - - 조명 제어 결과 - - - - 성공 - - - 실패 - - - 이전 값과 동일할 경우 생략 - - - - 조명 베이스 클래스 - - - - lock 설정을 위한 객체 - - - 로그 - - - - 채널 별 마지막 조명 값 - 마지막 조명 값과 동일한 경우 Write하지 않기 위함. - - - - - 채널 별 마지막 On/Off 상태 값 - 마지막 조명 상태와 동일한 경우 Write하지 않기 위함. - - - - 디바이스 컨피그 - - - 연결 타입 (시리얼 or 소켓) - - - - 생성자 - EquipmentInfo.SimulationMode로 시뮬레이션 상태를 설정한다. - - 디바이스 ID - - - - 생성자 - - 디바이스 ID - 시뮬레이션 상태 - - - - 다비이스 컨피그 설정 - - - - - - 채널 별 마지막 조명 값, On/Off 상태 설정 - - - - - 채널 별 마지막 조명 값, On/Off 상태 초기화 - - - - - On 상태 여부 체크 - - 채널 번호 - true: On, false: Off - - - - 조명 켜기 수행 메소드 - - 채널 번호 - 실행 결과 - - - - 조명 끄기 수행 메소드 - - 채널 번호 - 실행 결과 - - - - 조명 값 제어 수행 메소드 - - 설정 값 - 채널 번호 - 실행 결과 - - - - 조명 켜기 - - 채널 번호 - Device Actaivated를 무시하고 조명킬지 확인 여부 - 조명 제어 결과 - - - - 모든 채널의 조명 켜기 - - - - - 모든 채널의 조명 켜기 - Device Activated 여부 무시하고 진행 ( 내부적으로만 사용 ) - - - - - 조명 끄기 - - 채널 번호 - 조명 제어 결과 - - - - 모든 채널의 조명 끄기 - - - - - 조명 상태 가져오기 - - 채널 번호 - 조명 상태 (on : true, off : false) - - - - 조명 값 가져오기 - - 채널 번호 - 조명 값 - - - - 조명 값 제어 (개별) - - 레벨 - 채널 번호 - 조명 제어 결과 - - - - Channel 접근이 정상적인지 확인하는 Method (셋팅값과 동일한지) - - 채널 - 채널 정상 여부 - - - - level 접근이 정상적인지 확인하는 Method (Dim Range 셋팅값과 동일한지) - - 조명 값 (Dim Range) - 레벨 정상 여부 - - - - [상시 조명 컨트롤러 - 4CH / 시리얼 통신][Series] - Range : (0,255) - Baudrate : 19200 or 9600 bps - DataBit : 8 bit - StopBit : 1 bit - ParityBit : None - - - - - [상시 조명 컨트롤러 - 16CH / 시리얼 통신] - Range : (0,255) - Baudrate : - DataBit : 8 bit - StopBit : 1 bit - ParityBit : None - - - - - 조명 생성 및 등록 - - - - - 조명 생성 및 등록 - - Aurora 레지스트리 - - - - 소켓 통신을 위한 클래스 - - - - - 생성자 - - 디바이스 ID - 시뮬레이션 유무 - 프로토콜 타입(TCP/UDP) - - - - 소켓 통신 연결 - - 소켓 연결 컨피그 - 성공 유무 - - - - 현재 연결 상태 가져오기 - - 연결 유무 - - - - 데이터 송수신 - - 보내는 데이터 - 받는 데이터 - 타임아웃(ms) - 성공 유무 - - - - 데이터 송수신 - - 보내는 데이터 - 받는 데이터 - 타임아웃(ms) - 성공 유무 - - - - 데이터 송신 - - 보내는 데이터 - 성공 유무 - - - - 데이터 송신 - - 보내는 데이터 - 성공 유무 - - - - 데이터 수신 - - 받는 데이터 - 타임 아웃(ms) - 성공 유무 - - - - 소켓 통신 연결 끊기 - - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionSequence.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionSequence.dll deleted file mode 100644 index 1a0f463..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionSequence.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionSequence.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionSequence.xml deleted file mode 100644 index a10049a..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionSequence.xml +++ /dev/null @@ -1,2009 +0,0 @@ - - - - VisionSequence - - - - - 얼라인 믹서 시퀀스 파라미터 - - - - Target 얼라인 키 정보 - - - Source 얼라인 키 정보 - - - Target 얼라인 결과 - - - FOV별로 이동시킬 절대위치 - - - 메인 화면 타입 - - - - 얼라인 재시도(Retry) 카운트 초기화 플래그 - 1) 비전에서 Move와 Retry를 처리할 경우 [True] - 2) 제어에서 Move와 Retry를 처리하면서, 얼라인 시퀀스를 신규 호출한 경우 [True] - 3) 제어에서 Move와 Retry를 처리하면서, Retry로 얼라인 시퀀스를 다시 호출한 경우 [False] - - - - - 얼라인 믹서 시퀀스 파라미터를 얻어온다. - - Target 얼라인 키 정보 - Source 얼라인 키 정보 - Target 얼라인 결과가 null이 아닐 경우, 이후 Target 얼라인 스킵 (선택사항) - FOV별로 이동시킬 절대위치. null일 경우, 자동으로 Adapter에 정의된 티칭위치로 이동 - 메인 화면 타입 - 얼라인 횟수 - 시퀀스 모드 - - - - Target(고정형)과 Source(이동형)의 얼라인 보정량을 조합하여, 최종적으로 Source를 Target에 맞추는 얼라인 시퀀스 - Target의 3축(X,Y,T)이 모두 움직일 수가 없기 때문에, Source의 모터를 대신 움직여 얼라인 한다. - - - - - 생성자 - - 시퀀스 이름 - Target 얼라인 키 정보 - Source 얼라인 키 정보 - - - - N개 패턴, N번 얼라인 시퀀스 파라미터 - - - - 얼라인 키 정보 - - - 얼라인 레퍼런스 정보 - - - 플라잉 위치 인덱스 (Optional) - - - 메인 화면 타입 - - - - N개 패턴, N번 얼라인 시퀀스 파라미터를 얻어온다. - - 얼라인 키 정보 - 센터로부터 각 패턴의 정위치까지 떨어진 거리 파라미터 - 그랩 이미지 (Optional) - 메인 화면 타입 - 시퀀스 모드 - - - - CAM 1대 / FOV 1개 / 패턴 N개 / 1 Point Align N개 / MeasurePattern to (Center + Ref Dist Offset) - - - - - 생성자 - - - - - C1_F1_SPN_AN 얼라인 시퀀스 파라미터 - - - - 얼라인 키 정보 - - - 얼라인 레퍼런스 위치 - - - 얼라인 레퍼런스 정보 - - - 그랩 이미지 (Optional) - - - 메인 화면 타입 - - - - C1_F1_SPN_AN 얼라인 시퀀스 파라미터를 얻어온다. - - 얼라인 키 정보 - 얼라인 레퍼런스 위치 - 그랩 이미지 (Optional) - 센터로부터 각 패턴의 정위치까지 떨어진 거리 파라미터 - 메인 화면 타입 - 시퀀스 모드 - - - - CAM 1대 / FOV 1개 / 패턴 1개 / 얼라인 N개 / 1 Point Align N개 / MeasurePattern to (Center + Target Offset) - - - - - 생성자 - - - - - C1_F1_AP2_A2 얼라인 시퀀스 파라미터 - - - - 얼라인 키 정보 - - - 얼라인 레퍼런스 위치 - - - 얼라인 레퍼런스 정보 - - - 플라잉 위치 인덱스 (Optional) - - - 메인 화면 타입 - - - - C1_F1_AP2_A2 얼라인 시퀀스 파라미터를 얻어온다. - - 얼라인 키 정보 - 얼라인 레퍼런스 위치 - 그랩 이미지 (Optional) - 센터로부터 각 패턴의 정위치까지 떨어진 거리 파라미터 - 메인 화면 타입 - 시퀀스 모드 - - - - CAM 1대 / FOV 1개 / 서로 다른(Another) 패턴 2개 / 얼라인 2개 / 1 Point Align 2개 / MeasurePattern to (Center + Target Offset) - - - - - 생성자 - - - - - C2_F2 얼라인 시퀀스 파라미터 - - - - 얼라인 키 정보 - - - FOV별로 이동시킬 절대위치 - - - 메인 화면 타입 - - - - C2_F2 얼라인 시퀀스 파라미터를 얻어온다. - - 얼라인 키 정보 - FOV별로 이동시킬 절대위치. null일 경우, 자동으로 Adapter에 정의된 티칭위치로 이동 - 메인 화면 타입 - 시퀀스 모드 - - - - CAM 2대 / FOV 2개 / 포지션 이동 (X) / 2 Point Align / 2 MeasurePatterns to 2 ReferencePatterns - - - - - 생성자 - - - - - 얼라인 서브시퀀스 파라미터 - - - - 얼라인 키 정보 - - - FOV별로 이동시킬 절대위치 - - - 메인 화면 타입 - - - - 얼라인 서브시퀀스 파라미터를 얻어온다. - - 메인 화면 타입 - 얼라인 키 정보 - FOV별로 이동시킬 절대위치. null일 경우, 자동으로 Adapter에 정의된 티칭위치로 이동 - - - - 얼라인 서브시퀀스 - - - - - 생성자 - - - - - 얼라인 공정 시퀀스 파라미터 - - - - 얼라인 키 정보 - - - FOV별로 이동시킬 절대위치 - - - 메인 화면 타입 - - - - 얼라인 재시도(Retry) 카운트 초기화 플래그 - 1) 비전에서 Move와 Retry를 처리할 경우 [True] - 2) 제어에서 Move와 Retry를 처리하면서, 얼라인 시퀀스를 신규 호출한 경우 [True] - 3) 제어에서 Move와 Retry를 처리하면서, Retry로 얼라인 시퀀스를 다시 호출한 경우 [False] - - - - - 얼라인 시퀀스 파라미터를 얻어온다. - - 얼라인 키 정보 - FOV별로 이동시킬 절대위치. null일 경우, 자동으로 Adapter에 정의된 티칭위치로 이동 - 메인 화면 타입 - 얼라인 횟수 - 시퀀스 모드 - - - - 얼라인 공정 시퀀스 - - - - - 생성자 - - 시퀀스 이름 - 시퀀스 키 정보 - - - - 모든 얼라인 시퀀스들을 사전에 등록하여 사용한다. - - - - - 얼라인 공정 시퀀스를 생성하고 등록한다. - - Aurora 환경 변수 - Aurora의 SequenceRegister - - - - 시퀀스빌더를 얻어온다. - - 얼라인 키 정보 - 시퀀스빌더 - - - - 얼라인 시퀀스를 얻어온다. - - 얼라인 키 정보 - 시퀀스 - - - - 얼라인 시퀀스 파라미터를 얻어온다. - - 얼라인 키 정보 - FOV별로 이동시킬 절대위치. null일 경우, 자동으로 Adapter에 정의된 티칭위치로 이동 - 얼라인 공정 시퀀스 파라미터 - - - - 시퀀스 이름을 얻어온다. - - 얼라인 키 정보 - 시퀀스 이름 - - - - C1_F1_M2C 얼라인 시퀀스 파라미터 - - - - 얼라인 키 정보 - - - 메인 화면 타입 - - - - C1_F1_M2C 얼라인 시퀀스 파라미터를 얻어온다. - - 얼라인 키 정보 - 메인 화면 타입 - 시퀀스 모드 - - - - CAM 1대 / FOV 1개 / 포지션 이동 (X) / 1 Point Align / MeasurePattern to Center - - - - - 생성자 - - - - - C1_F1_M2R 얼라인 시퀀스 파라미터 - - - - 얼라인 키 정보 - - - 메인 화면 타입 - - - - C1_F1_M2R 얼라인 시퀀스 파라미터를 얻어온다. - - 얼라인 키 정보 - 메인 화면 타입 - 시퀀스 모드 - - - - CAM 1대 / FOV 1개 / 포지션 이동 (X) / 1 Point Align / MeasurePattern to ReferencePattern - - - - - 생성자 - - - - - C4_F4 얼라인 시퀀스 파라미터 - - - - 얼라인 키 정보 - - - FOV별로 이동시킬 절대위치 - - - 메인 화면 타입 - - - - C4_F4 얼라인 시퀀스 파라미터를 얻어온다. - - 얼라인 키 정보 - FOV별로 이동시킬 절대위치. null일 경우, 자동으로 Adapter에 정의된 티칭위치로 이동 - 메인 화면 타입 - 시퀀스 모드 - - - - CAM 4대 / FOV 4개 / 포지션 이동 (X) / 4 Point Align / 4 MeasurePatterns to 4 ReferencePatterns - - - - - 생성자 - - - - - C2_F4_MV 얼라인 시퀀스 파라미터 - - - - 얼라인 키 정보 - - - FOV별로 이동시킬 절대위치 - - - 메인 화면 타입 - - - - C2_F4_MV 얼라인 시퀀스 파라미터를 얻어온다. - - 얼라인 키 정보 - FOV별로 이동시킬 절대위치. null일 경우, 자동으로 Adapter에 정의된 티칭위치로 이동 - 메인 화면 타입 - 시퀀스 모드 - - - - CAM 2대 / FOV 4개 / 포지션 이동 (O) / 4 Point Align / 4 MeasurePatterns to 4 ReferencePatterns - - - - - 생성자 - - - - - C1_FN_MV 얼라인 시퀀스 파라미터 - - - - 얼라인 키 정보 - - - FOV별로 이동시킬 절대위치 - - - 메인 화면 타입 - - - - C1_FN_MV 얼라인 시퀀스 파라미터를 얻어온다. - - 얼라인 키 정보 - FOV별로 이동시킬 절대위치. null일 경우, 자동으로 Adapter에 정의된 티칭위치로 이동 - 메인 화면 타입 - 시퀀스 모드 - - - - - 생성자 - - - - - 드라이런(Dry Run) 시퀀스 파라미터 - - - - 얼라인 키 정보 - - - FOV 키 정보 - - - 이동할 포지션 타입 - - - 메인 화면 타입 - - - FOV별로 이동시킬 절대위치 - - - - 드라이런(Dry Run) 시퀀스 파라미터를 얻어온다. - - 얼라인 키 정보 - FOV 키 정보 - 포지션 타입 - 메인 화면 타입 - FOV별로 이동시킬 절대위치. null일 경우, 자동으로 Adapter에 정의된 티칭위치로 이동 - - - - 드라이런(Dry Run)을 위한 시퀀스 : 티칭 위치 이동 후 그랩만 수행 - - - - - 생성자 - - - - - 각 그랩이 스레드로 병렬처리 되므로, 모든 그랩 완료 후 이동을 보장받기 위해 그랩이 모두 끝날 때까지 기다린다. - - 모든 그랩 결과 - - - - 패턴 검출 결과 아이템 - - - - 검출 시간 - - - FOV ID - - - 패턴 ID - - - 패턴 이름 - - - 패턴 타입 - - - 패턴 검출 이미지 좌표 X - - - 패턴 검출 이미지 좌표 Y - - - 패턴 검출 자재 좌표 X - - - 패턴 검출 자재 좌표 Y - - - 패턴 검출 각도 - - - 패턴 검출 점수 - - - 패턴 검출 수행 시간 - - - 패턴 검출 상태 - - - - 파라미터 복제(PatternResultItem) - - PatternResultItem - - - - 패턴 검출 결과 아이템 매니저 - - - - - 패턴 검출 결과를 패턴 검출 아이템으로 변환한다. - - 서브 시스템 키 정보 - 패턴 검출 결과 - 패턴 검출 아이템 - - - - 공정 전/후 이미지를 자동 저장하는 시퀀스를 사전에 등록한다. (리뷰 기능 사용시 등록) - - - - - 리뷰 공정 시퀀스를 생성하고 등록한다. - - Aurora 환경 변수 - Aurora의 SequenceRegister - - - - 얼라인 시퀀스를 얻어온다. - - 시퀀스 - - - - 시퀀스 이름을 얻어온다. - - 시퀀스 이름 - - - - 리뷰 타입 - - - - 공정 진행 전 수행 - - - 공정 진행 후 수행 - - - - C1_MV 리뷰 시퀀스 파라미터 - - - - 서브 시스템 키 정보 - - - 리뷰 타입 - - - 리뷰 포지션 (모터 절대 위치) - - - 자재 정보 - - - - C1_MV 얼라인 시퀀스 파라미터를 얻어온다. - - 서브 시스템 키 정보 - 리뷰 타입 - 리뷰 포지션 (모터 절대 위치) - 자재 정보 - - - - CAM 1대 / N개 포지션 이동 / 리뷰 시퀀스 - - - - - 생성자 - - - - - Align Sequence 유틸 클래스 ( 예시 Flying Vision 사용 시 ref distance 관련 ) - - - - - 패턴 포지션별 정위치(센터로부터 X,Y거리)가 센터로 보고 얼라인 - - - - - - 패턴 포지션별 정위치(센터로부터 X,Y거리) 정보를 RefDistParam으로 정의. 향후 얼라인 보정량 계산에 사용됨. - - 패턴 포지션별 정위치(센터로부터 X,Y거리) - 패턴 정위치와 실제 찾은 패턴의 위치 간에 허용 오차 거리 값 (mm). - - - - - 모든 FOV의 부착 검사 시퀀스 결과 - - - - 서브 시스템 키 정보 - - - FOV의 부착 검사 결과 - - - 부착 검사 결과 상태 - - - - 생성자 - - 서브 시스템 키 정보 - FOV의 부착 검사 결과 - 부착 검사 결과 상태 - - - - C2_F4_MV 부착 검사 시퀀스 파라미터 - - - - 서브시스템 정보 - - - FOV별로 이동시킬 절대위치 - - - 메인 화면 타입 - - - - C2_F4_MV 부착 검사 시퀀스 파라미터를 얻어온다. - - 서브시스템 정보 - FOV별로 이동시킬 절대위치. null일 경우, 자동으로 Adapter에 정의된 티칭위치로 이동 - 메인 화면 타입 - - - - CAM 2대 / FOV 4개 / 포지션 이동 (O) - - - - - 생성자 - - - - - 선폭 검사 시퀀스 파라미터 - - - - FOV 키 정보 - - - 메인 화면 타입 - - - - 생성자 - - FOV 키 정보 - 메인 화면 타입 - - - - 수평, 수직 각각에서 두 라인 간에 선폭 검사 (서브시퀀스로 호출해서 사용) - - - - - 생성자 - - - - - 바코드 검사 시퀀스 파라미터 - - - - FOV 키 정보 - - - Align 키 정보 - - - 메인 화면 타입 - - - - 생성자 - - FOV 키 정보 - 메인 화면 타입 - - - - 바코드 검사 (서브시퀀스로 호출해서 사용) - - - - - 생성자 - - - - - 패턴 간의 거리 검사 시퀀스 파라미터 - - - - 얼라인 키 정보 - - - 패턴 검출 결과 - - - - 생성자 - - 얼라인 키 정보 - 패턴 검출 결과 - - - - 서로 다른 FOV에서 찾은 두 패턴 간에 거리 검사 (서브시퀀스로 호출해서 사용) - - - - - 생성자 - - - - - 패턴 유무 검사 시퀀스 파라미터 - - - - FOV 키 정보 - - - Align 키 정보 - - - 메인 화면 타입 - - - - 생성자 - - FOV 키 정보 - 메인 화면 타입 - - - - 패턴 유무 검사 (서브시퀀스로 호출해서 사용) - - - - - 생성자 - - - - - 패턴 검출 시퀀스 파라미터 - - - - 패턴 검출을 위한 이미지 - - - - 생성자 - - 패턴 검출을 위한 이미지 - FOV 키 정보 - 패턴 정보 - 메인 화면 타입 - 매뉴얼 시퀀스 플래그 - - - - 패턴 검출 시퀀스 - - - - - 생성자 - - - - - 강제 OK 요청 파라미터 - - - - FOV 키 정보 - - - 패턴 인덱스 - - - 패턴 검출 이미지 - - - 패턴 검출 결과 - - - 강제 OK 완료 여부 플래그 - - - - 생성자 - - FOV 키 정보 - 패턴 인덱스 - 패턴 검출 이미지 - 패턴 검출 결과 - - - - 카메라 그랩, 패턴 검출 공정 시퀀스 파라미터 - - - - FOV 키 정보 - - - 패턴 정보 - - - 메인 화면 타입 - - - - 생성자 - - FOV 키 정보 - 패턴 정보 - 메인 화면 타입 - 시퀀스 모드 - - - - GrabFindWithFixtureSeqParams로 변환한다. - - GrabFindWithFixtureSeqParams - - - - GrabFindSeqParams로 변환한다. - - GrabFindSeqParams - - - - 카메라 그랩, 패턴 검출 공정 시퀀스 - - - - - 생성자 - - - - - 카메라 그랩, 패턴 검출 시퀀스 파라미터 - - - - - 생성자 - - FOV 키 정보 - 패턴 정보 - 메인 화면 타입 - 시퀀스 모드 - - - - 카메라 그랩, 패턴 검출 시퀀스 - - - - - 생성자 - - - - - 공정 중 취득한 이미지와 패턴 정보를 관리하기 위함. - - - - - 공정 조명 값이 동일할 때, 그랩을 스킵하고 재활용할 이미지 저장 - - - - - 공정 Fixture 패턴 저장 - - - - - 등록 패턴의 조명 값이 마지막 조명 값과 동일한지 체크 (그랩 생략을 위함) - - - - - 그랩 완료 여부를 체크한다. - - FOV 키 정보 - 조명 값 - 그랩 완료 여부 - - - - 그랩 완료된 공정 이미지를 등록한다. - - FOV 키 정보 - 조명 값 - 공정 그랩 이미지 - - - - 그랩 완료된 공정 이미지를 얻어온다. - - FOV 키 정보 - 조명 값 - 공정 이미지 - - - - 공정 이미지들을 정리한다. - - FOV 키 정보 - - - - Fixture 패턴의 검출 결과를 등록한다. - - FOV 키 정보 - 패턴 검출 결과 - - - - Fixture 패턴의 검출 결과를 얻어온다. - - FOV 키 정보 - Fixture 패턴의 검출 결과 - - - - Fixture 패턴의 검출 결과를 정리한다. - FOV 키 정보 - - - - - 곻정 이미지, 패턴 정보 초기화 - - 서브시스템 정보 - - - - 곻정 이미지, 패턴 정보 초기화 - - FOV 키 정보 - - - - 패턴 검출 결과의 이미지 좌표를 자재 좌표로 변환한다. - - 캘리브레이터 디바이스 - 이미지 사이즈 정보 - 패턴 검출 결과 - - - - 강제 OK 이벤트 발생시키고 강제 OK 결과를 가져온다. - - 강제 OK 요청 파라미터 - 강제 OK 패턴 검출 결과 - - - - 카메라 그랩, 픽스처와 메인 패턴 검출 시퀀스 파라미터 - - - - - 생성자 - - FOV 키 정보 - 패턴 정보 - 메인 화면 타입 - 시퀀스 모드 - - - - 카메라 그랩, 픽스처와 메인 패턴 검출 시퀀스 - - - - - 생성자 - - - - - FOV별 Grab, Find 메뉴얼 시퀀스들을 사전에 등록하여 사용한다. - - - - - FOV별 Grab, Find 메뉴얼 시퀀스들을 등록한다. - - Aurora 환경 변수 - Aurora의 SequenceRegister - - - - 얼라인 시퀀스를 얻어온다. - - FOV 키 정보 - 시퀀스 - - - - 시퀀스 이름을 얻어온다. - - FOV 키 정보 - 시퀀스 이름 - - - - 카메라 그랩 시퀀스 파라미터 - - - - - 그랩 시퀀스 파라미터 생성자 - - FOV 키 정보 - 패턴 정보 - 메인 화면 타입 - 매뉴얼 시퀀스 플래그 - - - - 카메라 그랩 시퀀스 - - - - - 생성자 - - - - - 같은 카메라에 대한 다른 메인 디스플레이 군에도 이미지를 Set해준다. - - - - - 이미지 버퍼 명시적 메모리 해제 - - - - - 공정에서 사용되는 이미지의 정보 - - - - 공정 이미지 - - - 점유(사용) 상태 플래그 - - - - 생성자 - - 공정 이미지 - 점유(사용) 상태 플래그 - - - - 명시적 해제 (이미지 메모리 해제, Occupied = false) - - - - - 공정 이미지 매니저로 그랩 횟수를 최소화하기 위해 사용한다. - 패턴에서 동일한 조명 값을 사용하는 경우 카메라 그랩을 1회만 수행한다. - - - - - 생성자 - - FOV 키 정보 - 카메라 에이전트 - - - - 공정 이미지 초기화 - - - - - 조명 값(LightInfo)의 공정 이미지 그랩 완료 여부 - - 조명 값 - 완료 여부 - - - - 조명 값(LightInfo)으로 그랩된 공정 이미지를 등록 - - 조명 값 - 공정 이미지 - - - - 공정이미지를 얻어 온다. - - 조명 값 - 공정 이미지 - - - - 명시적 해제 - - - - - 캘리브레이션 플랜 - - - - X, Y축 수평 이동 횟수 - - - T축 회전 이동 횟수 - - - 현재까지 이동 횟수 - - - X, Y축으로 1회 이동 거리 - - - T축으로 1회 회전 각도(Degree) - - - - 생성자 - - X, Y축 수평 이동 횟수 - X, Y축으로 1회 이동 거리 - T축 회전 이동 횟수 - T축으로 1회 회전 각도(Degree) - - - - 캘리브레이션 플랜을 생성한다. - - 픽셀 사이즈 측정 플래그 - X축 캘리브레이션 사용 플래그 - Y축 캘리브레이션 사용 플래그 - T축 캘리브레이션 사용 플래그 - - - - - 캘리브레이션 시퀀스 요청 파라미터 - - - - 서브 시스템 정보 - - - 메인 화면 타입 - - - 캘리브레이션 플랜아이템 리스트 - - - 캘리브레이션 셋업 레시피 - - - - 캘리브레이션 시퀀스 수행 결과 - - - - X축 캘리브레이션 패턴 검출 이미지 좌표 리스트 - - - Y축 캘리브레이션 패턴 검출 이미지 좌표 리스트 - - - 회전 원점 캘리브레이션 패턴 검출 이미지 좌표 리스트 - - - X축으로 1회 이동 거리 - - - Y축으로 1회 이동 거리 - - - T축으로 1회 회전 각도(Degree) - - - - 캘리브레이션 시퀀스 수행 결과 파라미터 - - - - 캘리브레이션 시퀀스 수행 결과 리스트 - - - - 캘리브레이션 계산 결과 - - - - 카메라 회전 오차 - - - 이미지 픽셀 크기 X - - - 이미지 픽셀 크기 Y - - - 모터 회전 중심 - - - - 캘리브레이션 계산 결과 파라미터 - - - - 캘리브레이션 계산 결과 리스트 - - - - 캘리브레이션 셋업 시퀀스 - - - - - 비전 시퀀스 상수 - - - - - 캘리브레이션 플랜의 아이템 - - - - 프로퍼티 변경 이벤트 핸들러 - - - FOV ID - - - 플랜아이템의 스텝 번호 - - - 플랜아이템의 캘리브레이션 목적 - - - 플랜아이템의 축과 방향 - - - 플랜아이템의 모터 이동 목적 - - - X축 상대위치 이동량 - - - Y축 상대위치 이동량 - - - T축 상대위치 회전량 - - - 캘리브레이션 패턴 검출 이미지 좌표X - - - 캘리브레이션 패턴 검출 이미지 좌표Y - - - 캘리브레이션 패턴 검출 자재 좌표X - - - 캘리브레이션 패턴 검출 자재 좌표Y - - - 캘리브레이션 패턴 검출 T - - - - 생성자 - - 플랜아이템의 스텝 번호 - 플랜아이템의 캘리브레이션 목적 - 플랜아이템의 축과 방향 - 플랜아이템의 모터 이동 목적 - X축 상대위치 이동량 - Y축 상대위치 이동량 - T축 상대위치 회전량 - - - - 생성자 - - - - - 복제(Deep Copy) - - 플랜 아이템 - - - - 캘리브레이션 결과의 아이템 - - - - 공정 수행 시간 - - - FOV ID - - - 플랜아이템의 스텝 번호 - - - 플랜아이템의 캘리브레이션 목적 - - - 플랜아이템의 축과 방향 - - - 플랜아이템의 모터 이동 목적 - - - X축 상대위치 이동량 - - - Y축 상대위치 이동량 - - - T축 상대위치 회전량 - - - 캘리브레이션 패턴 검출 이미지 좌표X - - - 캘리브레이션 패턴 검출 이미지 좌표Y - - - 캘리브레이션 패턴 검출 자재 좌표X - - - 캘리브레이션 패턴 검출 자재 좌표Y - - - 캘리브레이션 패턴 검출 T - - - - Clone (Deep Copy) - - CalResultItem - - - - Calibration 아이템 항목 매니저 - - - - - Calibration 아이템 항목을 Get한다 - - 서브 시스템 정보 - 플랜 아이템 - Calibration 아이템 항목 - - - - 캘리브레이션 서브 시퀀스 요청 파라미터 - - - - FOV 키 정보 리스트 - - - 메인 화면 타입 - - - 캘리브레이션 플랜아이템 리스트 - - - 카메라 대수 - - - - 캘리브레이션 서브 시퀀스 결과 파라미터 - - - - X축 캘리브레이션 패턴 검출 이미지 좌표 리스트 - - - Y축 캘리브레이션 패턴 검출 이미지 좌표 리스트 - - - 회전 원점 캘리브레이션 패턴 검출 이미지 좌표 리스트 - - - X축으로 1회 이동 거리 - - - Y축으로 1회 이동 거리 - - - T축으로 1회 회전 각도(Degree) - - - 패턴 검출 NG 발생 플래그 - - - - 픽셀 사이즈 및 회전 원점 계산 - - - - - 생성자 - - - - - 자동 초점(축) 모드 - - - - 대략적으로 - - - 섬세하게 - - - 종료 - - - - 자동 초점(축) 로그 - - - - 공정 시간 - - - 스텝 번호 - - - 자동 초점(축) 모드 - - - Sharpness 측정 값 - - - Z축 위치 - - - - Clone (Copy) - - 자동 초점(축) 로그 - - - - 생성자 - - - - - 생성자 - - 스텝 번호 - 자동 초점(축) 모드 - Sharpness 측정 값 - Z축 위치 - - - - 자동 초첨(축) 로그 매니저 - - - - - 자동 초첨(축) 로그에 공정시간을 더해 리턴한다. - - 서브 시스템 키 정보 - 자동 초첨(축) 로그 - 자동 초첨(축) 로그 - - - - 자동 초점(축) 셋업 시퀀스 요청 파라미터 - - - - FOV 키 정보 - - - 자동 초점(축) 레시피 - - - 메인 화면 타입 - - - - 자동 초점(축) 셋업 시퀀스 요청 파라미터 - - FOV 키 정보 - 자동 초점(축) 레시피 - 메인 화면 타입 - - - - 자동 초점(축) 셋업 시퀀스 결과 파라미터 - - - - 최적의 스텝 번호 - - - 최적의 Sharpness 측정 값 - - - 최적의 Z축 위치 - - - - 생성자 - - 최적의 스텝 번호 - 최적의 Sharpness 측정 값 - 최적의 Z축 위치 - - - - 자동 초점(축) 조절 - - - - - 생성자 - - - - - 센터 튜닝 셋업 시퀀스 요청 파라미터 - - - - 서브 시스템 정보 - - - 센터 튜닝 레시피 - - - 메인 화면 타입 - - - 얼라인 델타를 로그 뷰에 출력하기 위한 콜백 - - - - 생성자 - - 서브 시스템 정보 - 센터 튜닝 레시피 - 메인 화면 타입 - - - - 반복 얼라인을 통해 화면 중심에 패턴이 오도록 튜닝 - - - - - 축 반복도 측정 셋업 시퀀스 요청 파라미터 - - - - FOV 키 정보 - - - 메인 화면 타입 - - - 모터 이동 반복 횟수 - - - 축 반복도 측정 반복 횟수 - - - 패턴 정보 - - - - 생성자 - - FOV 키 정보 - 패턴 정보 - 모터 이동 반복 횟수 - 축 반복도 측정 반복 횟수 - 메인 화면 타입 - - - - 축 반복도 측정 - - - - - 생성자 - - - - - 제자리 반복도 측정 셋업 시퀀스 요청 파라미터 - - - - FOV 키 정보 - - - 메인 화면 타입 - - - 반복 횟수 - - - 패턴 정보 - - - - 생성자 - - FOV 키 정보 - 패턴 정보 - 반복 횟수 - 메인 화면 타입 - - - - 제자리 반복도 측정 셋업 시퀀스 결과 파라미터 - - - - 이미지 좌표 - - - 자재 좌표 - - - - 생성자 - - 이미지 좌표 - 자재 좌표 - - - - 제자리 반복도 측정 - - - - - 생성자 - - - - - 비전 반복도 로그 - - - - - 걸린 시간 - - - - - 반복 Step - - - - - 이미지 X 위치 - - - - - 이미지 Y위치 - - - - - 자재 X 위치 - - - - - 자재 Y위치 - - - - - 패턴 각도 - - - - - 가로 길이(Shape) - - - - - 세로 길이(Shape) - - - - - 반지름 길이(Shape) - - - - - 생성자 (for Shape) - - 반복 Step - 이미지 X 위치 - 이미지 Y 위치 - 자재 X 위치 - 자재 Y 위치 - 패턴 각도 - 가로 길이 - 세로 길이 - 반지름 길이 - - - - 생성자 (for not Shape) - - 반복 Step - 이미지 X 위치 - 이미지 Y 위치 - 자재 X 위치 - 자재 Y 위치 - 패턴 각도 - - - - 비전 반복도 결과 항목 매니저 - - - - - 비전 반복도 결과 항목을 Get 한다. - - - - 비전 반복도 결과 항목 - - - - 비전 시퀀스 컨텍스트의 키를 정의 - - - - CNTXT_KEY_PATTERN_DISTANCE_RESULTS - Key : AlignInfo.GetKey() - - - - CNTXT_KEY_LAST_MEASURE_FOV_ID - Key : AlignInfo.GetKey() - - - - CNTXT_KEY_GRAB_IMAGE - Key : FovInfo.GetKey() - - - - CNTXT_KEY_PATTERN_RESULT - Key : FovInfo.GetKey() - - - - CNTXT_KEY_ALIGN_RESULTS - Key : AlignInfo.GetKey() - - - - CNTXT_KEY_ALIGN_RESULT - Key : AlignInfo.GetKey() - - - - CNTXT_KEY_ALIGN_RESULT_WITH_OFFSET - Key : AlignInfo.GetKey() - - - - CNTXT_KEY_ATTACH_INSP_RESULT - Key : FovInfo.GetKey() - - - - CNTXT_KEY_ALIGN_PROC_PARAMS - Key : SubsysInfo.GetKey() - - - - CNTXT_KEY_BCR_RESULT - Key : FovInfo.GetKey() - - - - CNTXT_KEY_PATTERN_EXIST_RESULT - Key : FovInfo.GetKey() - - - - CNTXT_KEY_AUTO_FOCUS_RESULT - Key : FovInfo.GetKey() - - - - Material Info - - - - 플라잉 리소스를 초기화하고, 이미지 및 얼라인 데이터를 인덱스별로 관리 - - - - - 플라잉 시작 - - FOV 정보 - 얼라인 정보(조명 Set용) - 추가 파라미터 - 성공 유무 - - - - 플라잉 종료 - - FOV 정보 - 추가 파라미터 - 성공 유무 - - - - 플라잉 상태 체크 - - FOV정보 - 성공 유무 - - - - 현재 플라잉 인덱스 가져오기 - - 현재 플라잉 인덱스 - - - - 플라잉 이미지 가져오기 - - FOV 정보 - 플라잉 인덱스 - 플라잉 이미지 - - - - 플라잉 이미지 전체 가져오기 - - FOV 정보 - 플라잉 이미지 전체 - - - - 플라잉 합성(원장) 이미지 가져오기. *원장 : Child 이미지를 조합하여 한 장으로 만듬 - - 플아잉 합성(원장) 이미지 - - - - 플라잉 조명 설정 - - FOV 정보 - 얼라인 정보 - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionUI.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionUI.dll deleted file mode 100644 index 23f2991..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionUI.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionUI.xml b/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionUI.xml deleted file mode 100644 index 2a1dbaf..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/VisionUI.xml +++ /dev/null @@ -1,2853 +0,0 @@ - - - - VisionUI - - - - - 패턴 Distance 로그 뷰 - PatternDistanceLogView.xaml BehindCode - - - PatternDistanceLogView - - - - - 생성자 - - 서브시스템 정보 - - - - InitializeComponent - - - - 얼라인 로그 뷰 AlignLogView.xaml BehindCode - - AlignLogView - - - - - 생성자 - - 서브시스템 정보 - - - - InitializeComponent - - - - - 패턴 Distance 로그 뷰 모델 - - - - 선택된 날짜 - - - - 생성자 - - 서브시스템 정보 - - - - 패턴 Distance 결과값 업데이트 - - 이벤트 메세지 - - - - 얼라인 로그 뷰 모델 - - - - 얼라인 결과 아이템 리스트 - - - 선택된 날짜 - - - - 생성자 - - 서브시스템 정보 - 얼라인 로그 뷰 - - - - 얼라인 결과 업데이트 - - 이벤트 메세지 - - - - 여러개의 얼라인 결과 업데이트 - - 이벤트 메세지 - - - - 얼라인 레시피 세팅 뷰 - AlignRecipeSettingView.xaml BehindCode - - - AlignRecipeSettingView - - - - - 생성자 - - 얼라인 정보 - - - - Proc패턴 세팅 뷰 생성 - - - - - InitializeComponent - - - - 얼라인 리밋 - - - 얼라인 오프셋 - - - 얼라인 재시도 - - - 얼라인 타겟 Distance - - - 얼라인 프록 파라미터 - - - 인스펙션 파라미터 - - - - 생성자 - - 얼라인 정보 - - - - 얼라인 세팅 뷰 - AlignSettingView.xaml BehindCode - - - AlignSettingView - - - - - 생성자 - - 서브시스템 정보 - - - - 얼라인 탭 컨트롤 생성 - - - - - InitializeComponent - - - - - 얼라인 세팅 뷰 모델 - - - - 얼라인 시퀀스 버튼 커맨드 - - - 시퀀스 다이어그램 보여주는 버튼 커맨드 - - - - 생성자 - - 서브시스템 정보 - - - - 현재 얼라인 정보 설정 - - 얼라인 Id - - - - 시퀀스 다이어그램 실행시 상태 변경 이벤트 핸들러 메서드 - - 객체 - 이벤트 - - - - 패턴 로그 뷰 - PatternLogView.xaml BehindCode - - - PatternLogView - - - - - 패턴 로그 뷰 - - 서브시스템 정보 - - - - InitializeComponent - - - - 패턴 로그 뷰 모델 - - - Pattern 결과 Items - - - 선택한 날짜 - - - - 생성자 - - 서브시스템 정보 - - - - 패턴 결과 업데이트 - - 이벤트 메세지 - - - - 여러개의 패턴 결과 업데이트 - - 이벤트 메세지 - - - - SubMenuAlignView.xaml에 대한 상호 작용 논리 - - - SubMenuAlignView - - - - - 생성자 - - - - - InitializeComponent - - - - - 모양 타입 - Rectangle | Circle | TextBox | Path - - - - - 자재공차 테스트 모델 추상 클래스 - - - - ID - - - 이름 - - - 툴팁 - - - 모양 타입 - - - 설명 - - - Shape Visibility - - - Item이 선택되었는지 여부 - - - 캔버스 왼쪽위치 - - - 캔버스 상부쪽 위치 - - - 불투명도 0~1 - - - 선 두께 - - - 선 색상 - - - 도형 내부 채우는 색상 - - - 도형들의 Z 인덱스 (layer) - - - - 생성자 - - - - - 생성자 - - 이름 - - - - 원 모델 - - - - - 생성자 - - 이름 - 센터 X - 센터 Y - 반지름 - - - 원 높이 - - - 원 너비 - - - 반지름 - - - 위치변경 - - - - Path 모델 - - - - - 생성자 - - 이름 - - - - - Path 데이터 - - - - - 자재 공차 테스트 뷰 모델 - - - - - 캔번스 메인모델 모양 컬렉션(자재공차테스트모델) - - - - - 원의 포인트 - - 이름 - 원 모델 - - - - 기준 위치 - - - - - 측정 위치 - - - - - 레퍼런스 위치 - - - - - ICP 위치 - - - - - 얼라인 타입 - - - - - 센터 X 위치 ( Center Point Properties ) - - - - - 센터 Y 위치 ( Center Point Properties ) - - - - - 정보 텍스트 - - - - - 레퍼런스 확인 여부 - - - - - ICP 타입인지 확인여부 - - - - - 측정포인트 타입인지 확인여부 - - - - 측정 포인트 1의 X - - - 측정 포인트 1의 Y - - - 측정 포인트 2의 X - - - 측정 포인트 2의 Y - - - 측정 포인트 3의 X - - - 측정 포인트 3의 Y - - - 측정 포인트 4의 X - - - 측정 포인트 4의 Y - - - 얼라인 이동을 위한 dX - - - 얼라인 이동을 위한 dY - - - 얼라인 이동을 위한 dT - - - 얼라인 결과값 dX (기존) - - - 얼라인 결과값 dY (기존) - - - 얼라인 결과값 dT (기존) - - - 얼라인 결과값 dX (ICP) - - - 얼라인 결과값 dY (ICP) - - - 얼라인 결과값 dT (ICP) - - - Theta 기준점 X - - - Theta 기준점 Y - - - 기존 알고리즘 평균 제곱근 편차 - - - ICP 알고리즘 평균 제곱근 편차 - - - 첫번째 Fov - - - 두번째 Fov - - - 세번째 Fov - - - 네번째 Fov - - - 적용 커맨드 - - - 얼라인 커맨드 - - - 리셋 커맨드 - - - 이동 커맨드 - - - - 생성자 - - 서브시스템 정보 - - - - 모양 가져오기 - - 이름 - 모양모델 - - - - - ICP 알고리즘 계산 - - 평균값들 - 기준점들 - - - - - 자재 공차 테스트 뷰 - MaterialToleranceTestView.xaml behind code - - - MaterialToleranceTestView - - - - - 생성자 - - 서브시스템 정보 - - - - InitializeComponent - - - - - SubMenuProcTestView.xaml에 대한 상호 작용 논리 - - - SubMenuProcTestView - - - - - 생성자 - - - - - InitializeComponent - - - - - 메인 카메라 뷰 매니저 - - - - - 싱글톤 패턴 객체 - - - - - 메인 카메라 뷰 가져오기 - - 디스플레이 타입 - - - - - 생성자 - - - - - 메인 카메라 뷰 해제/제거 - - 디스플레이 타입 - - - - 카메라 Usercontrol 매니저 - - - - - 싱글톤 패턴 객체 - - - - - 개별 카메라 뷰 윈도우 띄우기 - - - - - - 떠있는 개별 카메라 뷰 모두 닫기 - - - - - 메인 카메라 윈도우 보여주기 - - - - - 카메라 라이브 전체 켜기 - - 라이브 전체 On시킬 디스플레이 타입 - - - - 카메라 라이브 전체 끄기 - - - - - 카메라 라이브 켜기 - - FOV 정보 - 디스플레이 유형 - - - - 카메라 라이브 중지 - - FOV 정보 - - - - CameraViewWindow.xaml BehindCode - - - CameraViewWindow - - - - - 생성자 - - Fov 정보 - 디스플레이 타입 - - - - InitializeComponent - - - - - 디스플레이 Mover 추상 클래스 - - - - - 모션카메라 뷰로 변환 - - 이미지 포인트 - 카메라 베이스 - 모션 포인트 - - - - XY 센터로 이동 - - 모션 포인트 - 이동 완료 여부(bool) - - - - XY 센터로 이동 - - 이미지 포인트 - 카메라 디바이스 - 이동 완료 여부(bool) - - - - 메인 카메라 뷰 - MainCameraView.xaml BehindCode - - - MainCameraView - - - - - 생성자 - - 디스플레이 타입 - - - - 디스플레이 타입 가져오기 - - 디스플레이 타입 - - - - 카메라 디바이스가 다시 Activated될 때, 메인 화면 카메라 뷰를 갱신 - - 이벤트 메시지 - - - - 현재 카메라 뷰 가져오기 - - 현재 카메라 뷰 - - - - Camera View 생성 - CameraView를 미리 만들어 놓기 위해 프로그램 로딩시 수행 (권장) - - - - - 메인 카메라 연결 해제 - - 카메라 뷰 - 유저컨트롤 리스트 (카메라 뷰) - - - - InitializeComponent - - - - - 메인 카메라 뷰 윈도우 - MainCameraViewWindow.xaml BehindCode - - - MainCameraViewWindow - - - - Static 객체(싱글톤) - - - - 싱글톤 객체 - - - - - 생성자 - - - - - 카메라 뷰 생성 - CameraView를 미리 만들어 놓기 위해 프로그램 로딩시 수행 - - - - - InitializeComponent - - - - - 서브 메뉴 클릭시, 메인 카메라 윈도우를 활성화 시킴. - - - SubMenuMainCamWindow - - - - - InitializeComponent - - - - - 어태치 검사 로그 뷰 - AttachInspLogView.xaml BehindCode - - - AttachInspLogView - - - - - 생성자 - - 서브시스템 정보 - - - - InitializeComponent - - - - - 어태치 검사 로그 뷰 모델 - - - - 어태치 검사 결과 아이템 집합 - - - 선택된 날짜 - - - - 생성자 - - 서브시스템 정보 - - - - 어태치 검사 결과 업데이트 - - 이벤트 메세지 - - - - 어태치 검사 뷰 - AttachInspView.xaml BehindCode - - - AttachInspView - - - - - 생성자 - - 서브시스템 정보 - - - - InitializeComponent - - - - 프로퍼티 변경 이벤트 핸들러 - - - - 생성자 - - 서브시스템 정보 - - - - 어태치 검사 레시피 세팅 뷰 - AttachInspRecipeSettingView.xaml BehindCode - - - AttachInspRecipeSettingView - - - - - 생성자 - - 서브시스템 정보 - - - - Proc패턴 세팅 뷰 생성 - - - - - 명시적 이벤트 해제 - - - - - InitializeComponent - - - - - 어태치 검사 레시피 세팅 뷰 모델 - - - - 어태치 검사 레시피 - - - - 생성자 - - 서브시스템 정보 - - - - 어태치 검사 뷰 (서브메뉴) - SubMenuAttachInspView.xaml BehindCode - - - SubMenuAttachInspView - - - - - 생성자 - - - - - InitializeComponent - - - - - MIL or Cognex 관련 뷰를 생성 및 관리한다. - - - - Force Ok 뷰 - - - - 카메라 뷰 - - Fov 정보 - 디스플레이 타입 - - - - - 카메라 뷰 해제 - - 카메라 뷰 - - - - 그래픽 컬러 가져오기 (from Align) - - 얼라인 상태 - 컬러 - - - - 그래픽 컬러 가져오기 (from Inspection) - - 인스펙션 상태 - 컬러 - - - - Fov 패턴 리스트 뷰 모델생성 - - Fov 정보 - 카메라 뷰 - Fov 패턴리스트 뷰모델 - - - - 캠 패턴 리스트 뷰 모델생성 - - Fov 정보 - 카메라 뷰 - 캠 패턴리스트 뷰모델 - - - - ForceOk 뷰 생성 - - Fov 정보 - 패턴 정보 - 찾은 이미지 - ForceOk 윈도우 - - - - Interaction logic for CoordSysComboBoxView.xaml - - - CoordSysComboBoxView - - - - - 좌표계 시스템 타입 DepdencyProperty - - - - - 좌표계 시스템 타입 - - - - - 생성자 - - - - - InitializeComponent - - - - - Static 좌표세팅 뷰 - StaticCoordSettingView.xaml behind code - - - StaticCoordSettingView - - - - - 생성자 - - - - - InitializeComponent - - - - - Interaction logic for CoordSysSettingView.xaml - - - CoordSysSettingView - - - - - 좌표계 시스템 이름 DepedencyProperty - - - - - 좌표계 시스템 이름 - - - - - 좌표계 시스템 타입 DepedencyProperty - - - - - 좌표계 시스템 타입 - - - - - 생성자 - - - - - InitializeComponent - - - - - 캠 레이아웃 세팅 뷰 - CamLayoutSettingView.xaml behind code - - - CamLayoutSettingView - - - - - 생성자 - - - - - InitializeComponent - - - - - Visible 변경 Command - - - - - 저장 Command - - - - - 활성화 여부 - 활성화 여부에 따라 카메라 디바이스 Active - - - - - 카메라 좌표계 시스템 타입 - - - - - 생성자 - - 캠 Id - - - - 레시피 업데이트 - - - - - Fov 좌표 뷰 모델 - - - - - Visible 변경 Command - - - - - 저장 커맨드 - - - - - FovId 리스트 - - - - - 선택된 FovId - - - - - Fov 센터 - - - - - Fov 센터 오프셋 - - - - - Fov 좌표 포지션 위치 - - - - - 생성자 - - 서브 시스템 레시피 - Fov Id - - - - 레시피상의 Fov 센터 - - - - - Fov 센터를 레시피에 저장하기 - - - - - 자재 위치 enum - - - - - Fov 좌표 관련 데이터 - FovId | FovCoordPos | FovCenter - - - - - Fov Id - - - - - Fov 좌표 위치 enum - - - - - Fov Center - - - - - 생성자 - - Fov id - Fov 좌표 위치 - Fov 센터 - - - - Static 좌표 세팅 뷰 모델 - - - - - Visible 변경 커맨드 - - - - - 창 닫기 커맨드 - - - - - Fov Distance X - - - - - Fov Distance Y - - - - - Static 센터 타입 - - - - - 폴리곤 점들 컬렉션 - - - - - 좌표계 타입의 : static 좌표계 - Flip 및 Rotation 관련 정보 - - - - UCFovCoord 뷰모델 (LT) - - - UCFovCoord 뷰모델 (RT) - - - UCFovCoord 뷰모델 (RB) - - - UCFovCoord 뷰모델 (LB) - - - - 좌표계 표시 단위 - MM | UM - - - - - 생성자 - - 서브시스템 레시피 - - - - 캘리브레이션 레시피로 부터 Static 센터 타입 설정하기 - - - - - 비전 레시피로 부터 좌표 단위 설정하기 - - - - - 자재 좌표로 Fov Id 가져오기 - - 자재좌표 - 좌표계 시스템 타입 - FovId - - - - Fov 좌표 위치 enum정보 값 가져오기 - - 자재좌표 - Fov좌표계 시스템타입 - Fov좌표위치정보 값(LT|RT|LB|RB) - - - - FovId 찾기 - - 목표 좌표위치정보 enum - 찾고자 하는 Fov Id값 - - - - View Model 세팅하기 - - - - - 캘리브레이션 레시피에 있는 값을 해당 View Property에 가져오기 - - - - - 폴리곤 점들 세팅하기 - - - - - 위치값 회전 및 Flip - - 변경할 위치값 - 각도 - 원점(기준점) - Y값 플립 여부 - - - - - 레시피로부터 좌표시스템타입 가져오기 - - - - - 레시피 저장하기 - - 성공여부 - - - - Interaction logic for UCFovCoordView.xaml behind code - - - UCFovCoordView - - - - - InitializeComponent - - - - - PolygonFit 컨버터 - 3개 Parameter를 가진 multiConverter - - [0] 포인트 컬렉션 | [1] 실제 Width | [2] 실제 Height - - - - 컨버팅 된 Point Collection - - - - 포인트 컨버터 - - Fitting 시킬 점 집합 - 실제 너비 - 실제 높이 - Fitting 된 포인트 - - - - not used - - null - - - - Interaction logic for UCStaticCoordinate.xaml - - - UCStaticCoordinate - - - - - IsRever - - - - Reverse 여부 확인 - - - 각도 Depedency Property - - - 각도 - - - - 폴리곤 포인트 컬렉션 Depedency Proprety - LowLow -> HighLow -> LowHigh -> HighHigh - - - - 폴리곤 포인트 컬렉션 - - - - LL 위치의 포인트 Depedency Property - - - - - LL 위치의 포인트 Thickness - - - - - HL 위치의 포인트 Depedency Property - - - - - HL 위치의 포인트 Thickness - - - - - HH 위치의 포인트 Depedency Property - - - - - HH 위치의 포인트 Thickness - - - - - LH 위치의 포인트 Depedency Property - - - - - LH 위치의 포인트 Thickness - - - - - 생성자 - - - - - InitializeComponent - - - - - 각도 컨버터 (multiValue Converter) - - - - - 컨버터 - - 값 ([0] (double)degree , [1] (bool)isReverse) - - - - 각도(degree) - - - - Interaction logic for UCVisionCoordinate.xaml - - - UCVisionCoordinate - - - - - 리버스인지 체크하는 DepednecyProperty - - - - - Reverse 확인 여부 버튼 변경 이벤트 핸들러 - - depedency 객체 - depedencyProperty 변경 이벤트 - - - - 리버스 여부 - - - - - X축 컬러 - - - - - Y축 컬러 - - - - - 각도 DepedencyProeprty - - - - - 각도 DepedencyProperty 변경 이벤트 핸들러 - - depedency 객체 - depedencyProperty 변경 이벤트 - - - - 각도 - - - - - 생성자 - - - - - InitializeComponent - - - - - 바코드 로그 뷰 - BcrLogView.xaml beindCode - - - BcrLogView - - - - - 생성자 - - 서브시스템 정보 - - - - InitializeComponent - - - - - 바코드 로그 뷰 모델 - - - - 바코드 결과 아이템 컬렉션 - - - 디스플레이 이름 - - - 선택 날짜 - - - - 생성자 - - 서브 시스템 정보 - - - - 바코드 결과 값 업데이트 - - 이벤트 메세지 - - - - 바코드 로그 서브 메뉴 뷰 - SubMenuBcrLogView.xaml behindCode - - - SubMenuBcrLogView - - - - - 생성자 - - - - - InitializeComponent - - - - - 강제 OK 핸들러 등록 - - - - - 등록 - - - - - 강제 OK 핸들러 - - - - - 핸들러 추가 - - 핸들러 사전 키 (Fov 정보) - - - - 강제 OK 결과 파라미터 - - - - - Found 상태 - - - - - 강제 OK 위치 값 - - - - - 새롭게 찾은 패턴 결과 - - - - - 복제 - - 복제된 ForceOKResult값 - - - - Interaction logic for ForceOkWindow.xaml - - - ForceOkWindow - - - - - InitializeComponent - - - - - 패턴 리스트 뷰 - PatternListView.xaml behind code - - - PatternListView - - - - - 생성자 - - fov 정보 - - - - 현재 선택된 패턴을 다른 FOV로 복사 - - - - - 선택된 소스 패턴의 메인/서브 패턴들을 모두 복사한다. - - - - - InitializeComponent - - - - - 패턴 등록 뷰 - PatternRegistrationView.xaml behind code - - - PatternRegistrationView - - - - - 생성자 - - Fov 정보 - - - - InitializeComponent - - - - - 패턴 등록 뷰 모델 - - - - - 생성자 - - Fov 정보 - - - - 패턴 콤보박스 정보 키 - - - - Fov Id - - - Proc 패턴 Id - - - - 생성자 - - Fov Id - Proc 패턴 Id - - - - 패턴 콤보박스 정보 값 - - - - 패턴 이름 - - - 패턴 콤보박스 - - - - 생성자 - - 패턴이름 - 패턴 콤보박스 - - - - 패턴 리스트에 등록된 패턴을 공정 패턴으로 지정 - - - ProcPatternSettingView - - - - - 생성자 - - 서브시스템 정보 - Proc Id - - - - 비전 레시피 Refresh - - - - - UI로 부터 레시피 업데이트 - - - - - InitializeComponent - - - - - 서브메뉴 : 캠 패턴 등록 뷰 - SubMenuCamPatternRegistrationView.xaml behind code - - - SubMenuCamPatternRegistrationView - - - - - 생성자 - - - - - InitializeComponent - - - - - 서브메뉴 : Fov패턴등록 View - SubmenuFovPatternRegistrationView.xaml behind code - - - SubMenuFovPatternRegistrationView - - - - - 생성자 - - - - - InitializeComponent - - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - UCLayoutView.xaml에 대한 상호 작용 논리 - - - UCLayoutView - - - - - 생성자 - - - - - InitializeComponent - - - - - Interaction logic for UCUnitSubsysSelect.xaml - - - UCUnitSubsysSelect - - - - - 생성자 - - - - - InitializeComponent - - - - - Interaction logic for UCVisionRecipeMenuView.xaml - - - UCVisionRecipeMenuView - - - - - 생성자 - - - - - InitializeComponent - - - - - VisionDef Ingredient 사용 - - - - - 생성자 - - 오로라 환경 - 프로퍼티 그리드만 사용할지 여부 - - - - VisionDef 모델 사용 - - - - - 생성자 - - 오로라 환경 - 프로퍼티 그리드만 사용할지 여부 - - - - VisionDef 레시피 사용 - - - - - 생성자 - - 오로라 환경 - 프로퍼티 그리드만 사용할지 여부 - - - - 비전 레시피 메뉴 뷰 모델 베이스(생성자) - - - 비전 레시피 메뉴 뷰 모델 베이스 (선언) - - - 비전레시피 메뉴 뷰모델 베이스 - - - - - 레시피 추가 - - SubsysRecipe - - - - 팝업창 생성 - - 타이틀 - 내용 - 사이즈 - 끝난 후 동작할 이벤트 핸들러 - 최상단 고정여부 - - - - - 좌표시스템 계산 - - 서브시스템 레시피 - - - 프로퍼티 선택 커맨드 - - - Fov Align 인지 확인 여부 - - - - 모든 값들을 Property grid로 표현 (Subsystem 관련 내용 나왔을때 Custom View 사용 x) - - - - - 선택된 서브시스템 아이템 - - - - - 선택된 서브시스템속성 이름 - - - - - 자재좌표 방향 - - - - - 모터 좌표 방향 - - - - - 얼라인 모터 사용 여부 - - - - - Theta 모터 방향 - - - - - Fov Distance X값 - - - - - Fov Ditance Y값 - - - - - 사용된 모터세팅 - - - - - 이동할 객체 X축 타입 - StaticMove | CamMove - - - - - 이동할 객체 Y축 타입 - StaticMove | CamMove - - - - - 자재좌표세팅 뷰 모델 - - - - 비전 속성 뷰 헤더 - - - 비전 속성 뷰 - - - 서브시스템 아이템이 선택되었는지 여부 확인 - - - - 처음 들어갔을 때 Selected Item을 index 가 0 인 값으로 설정해 주기 위한 Method - - - - - 모터 타입 - - - - - 캘리브레이션 로그 뷰 - CalLogView.xaml behind code - - - CalLogView - - - - - 생성자 - - 서브시스템 정보 - - - - InitializeComponent - - - - - 캘리브레이션 로그 뷰 모델 - - - - - 캘리브레이션 계획 아이템 컬렉션 - - - - 선택된 날짜 - - - - 생성자 - - 서브시스템 정보 - - - - 플랜 아이템컬렉션 설정 - - 설정 할 플랜아이템 컬렉션 - - - - 현재 시간 기준으로 CSV 불러오기 - - - - - 캘리브레이션 파라미터 뷰 - CalParamView.xaml behind code - - - CalParamView - - - - - 생성자 - - Fov 정보 - - - - InitializeComponent - - - - - 캘리브레이션 파라미터 뷰 모델 - - - - 캘리브레이션 레시피 - - - 캘리브레이션 Fov 레시피 - - - 레퍼런스 포인트 레시피 - - - - 생성자 - - Fov 정보 - - - - 저장 - - null - - - - 캘리브레이션 결과 저장 - - 캘리브레이션 결과값들 리스트 - 캘리브레이션 셋업 레시피 - - - - 캘리브레이션 세팅 뷰 - CalSettingView.xaml behind code - - - CalSettingView - - - - - 생성자 - - 서브시스템 정보 - - - - InitializeComponent - - - - - 캘리브레이션 세팅 뷰 모델 - - - - 캘리브레이션 플랜 아이템 컬렉션 - - - 캘리브레이션 플랜 생성 이벤트 핸들러 - - - 캘리브레이션 시퀀스 취소 이벤트 핸들러 - - - 캘리브레이션 셋업 레시피 - - - - 생성자 - - 서브시스템 정보 - - - - 시작 - - null - - - - 시퀀스 정지 - - null - - - - 세팅레시피 저장 - - null - - - - 캘리브레이션 뷰 - CalView.xaml behind code - - - CalView - - - - - 생성자 - - 서브시스템 정보 - - - - InitializeComponent - - - - - 캘리브레이션 뷰 모델 - - - - 캘리브레이션 세팅 뷰 모델 - - - 캘리브레이션 로그 뷰 모델 - - - 캘리브레이션 파라미터 뷰 모델 - - - - 생성자 - - 서브시스템 정보 - - - - 캘리브레이션 세팅 뷰 모델 설정(할당 및 이벤트 연결) - - 캘리브레이션 세팅 뷰 모델 - - - - 캘리브레이션 로그 뷰 모델 설정(할당) - - 캘리브레이션 로그 뷰 모델 - - - - 캘리브레이션 파라미터 뷰 모델 설정(할당) - - 캘리브레이션 파라미터 뷰 모델 - - - - SubMenuCalView.xaml에 대한 상호 작용 논리 - - - SubMenuCalView - - - - - 생성자 - - - - - InitializeComponent - - - - - 오토포커스 뷰 - AutoFocusView.xaml behind code - - - AutoFocusView - - - - - 생성자 - - Fov 정보 - - - - 오토포커스를 최선의 위치로 업데이트 (비동기) - - 이벤트 메세지 - - - - InitializeComponent - - - - - 오토 포커스 뷰 모델 - - - - 오토포커스 로그 아이템 컬렉션 - - - 오토포커스 로그 아이템 컬렉션(Roughly) - - - 오토포커스 로그 아이템 컬렉션(Delicately) - - - 오토포커스 레시피 - - - 선택된 날짜 - - - - 생성자 - - Fov 정보 - - - - 오토포커스 로그 클리어 - - - - - 오토포커스 로그 업데이트 - - 이벤트 메세지 - - - - 찾는 ROI 등록 - - null - - - - 오토포커스 시퀀스 시작 - - null - - - - 선명도 ROI 추가 - - - - - 오토포커스 시퀀스 완료후 작업내용 이벤트 핸들러 - - 오토포커스 시퀀스 완료 결과 - - - - 시퀀스 정지 - - - - - - 세이브 파라미터 - - null - - - - 오토포커스 파라미터들 업데이트 - 최적의 Step | Sharpness | BestPosZ - - 오토포커스 셋업 시퀀스 결과 파라미터 - - - - 현재 시간 기준으로 CSV 불러오기 - - - - - 서브메뉴 : 오토포커스 뷰 - SubMenuAutoFocusView.xaml behind code - - - SubMenuAutoFocusView - - - - - 생성자 - - - - - InitializeComponent - - - - - 센터 튜닝 로그 뷰 - CenterTuningLogView.xaml behind code - - - CenterTuningLogView - - - - - 생성자 - - 서브시스템 정보 - - - - InitializeComponent - - - - - 센터 튜닝 로그 아이템 - - - - 시간 - - - 현재 진행 횟수 - - - 얼라인 결과값 X - - - 얼라인 결과값 Y - - - 얼라인 결과값 T - - - - Clone (Copy) - - 센터 튜닝 로그 아이템 - - - - 센터 튜닝 로그 아이템 매니저 - - - - - 공정 시간을 포함한 센터 튜닝 로그 아이템으로 변환한다. - - 서브시스템 키 정보 - 센터 튜닝 로그 아이템 - 센터 튜닝 로그 아이템 - - - 선택된 날짜 - - - 센터 튜닝 로그 아이템 - - - - 센터 튜닝 로그 뷰 모델 - - 서브시스템 정보 - - - - 현재 시간 기준으로 CSV 불러오기 - - - - - 센터 튜닝 세팅 뷰 - CenterTuningSettingView.xaml behind code - - - CenterTuningSettingView - - - - - 생성자 - - 서브시스템 정보 - - - - InitializeComponent - - - - - 센터 튜닝 세팅 뷰 모델 - - - - 얼라인 델타 처리 이벤트 핸들러 - - - 시퀀스 시작 이벤트 핸들러 - - - 센터 튜닝 레시피 - - - - 생성자 - - 서브 시스템 정보 - - - - 시작 - - null - - - - 취소 - - null - - - - 저장 - - null - - - - 센터 튜닝 뷰 - CenterTuningView.xaml behind code - - - CenterTuningView - - - - - 생성자 - - 서브시스템 정보 - - - - InitializeComponent - - - - - 센터 튜닝 뷰 모델 - - - - 센터 튜닝 세팅 뷰 모델 - - - 센터 튜닝 로그 뷰 모델 - - - - 생성자 - - 서브시스템 정보 - - - - 서브메뉴 : 센터튜닝 뷰 - SubMenuCenterTuningView.xaml behind code - - - SubMenuCenterTuningView - - - - - 생성자 - - - - - InitializeComponent - - - - - Interaction logic for SubMenuVisionRepeatView.xaml - - - SubMenuVisionRepeatView - - - - - 생성자 - - - - - InitializeComponent - - - - - Interaction logic for VisionRepeatView.xaml - - - VisionRepeatView - - - - - 생성자 - - Fov 정보 - - - - InitializeComponent - - - - - 비전 반복 View Model - - - - - 비전 반복도 측정 레시피 - - - - 반복 횟수 - - - 활성화 - - - 비전 반복도 로그 아이템 리스트 - - - 패턴 종류가 Shape인 여부 - - - 선택한 날짜 - - - 평균 X (이미지 좌표) - - - 평균 Y (이미지 좌표) - - - SdX (이미지 좌표) - - - SdY (이미지 좌표) - - - 최소값 X (이미지 좌표) - - - 최소값 Y (이미지 좌표) - - - 최댓값 X (이미지 좌표) - - - 최댓값 Y (이미지 좌표) - - - 범위 X (이미지 좌표) - - - 범위 Y (이미지 좌표) - - - 반복도 로그 아이템리스트 (모터 좌표) - - - 평균 X (모터 좌표) - - - 평균 Y (모터 좌표) - - - SdX (모터 좌표) - - - SdY (모터 좌표) - - - 최소값 X (모터 좌표) - - - 최소값 Y (모터 좌표) - - - 최댓값 X (모터 좌표) - - - 최댓값 Y (모터 좌표) - - - 범위 X (모터 좌표) - - - 범위 Y (모터 좌표) - - - - 생성자 - - Fov 정보 - - - - 비전 반복도 시퀀스 시작 - - - - - - 다이나믹 반복 측정 - - - - - - 시퀀스 정지 - - null - - - - UI로부터 레시피 저장 - - null - - - - 비전 레시피 Refresh - - - - - 파일로부터 레시피 불러오기 - - - - - UI로부터 레시피 불러오기 - - - - - 현재 시간 기준으로 CSV 불러오기 - - - - - GeneratedInternalTypeHelper - - - - - CreateInstance - - - - - GetPropertyValue - - - - - SetPropertyValue - - - - - CreateDelegate - - - - - AddEventHandler - - - - diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/WeldingCommon.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/WeldingCommon.dll deleted file mode 100644 index 538f374..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/WeldingCommon.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/WeldingCommon.dll.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/WeldingCommon.dll.config deleted file mode 100644 index cb31d1b..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/WeldingCommon.dll.config +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/Xceed.Wpf.Toolkit.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/Xceed.Wpf.Toolkit.dll deleted file mode 100644 index 70b9372..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/Xceed.Wpf.Toolkit.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM1/1.png b/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM1/1.png deleted file mode 100644 index d46f1e3..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM1/1.png and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM1/2.png b/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM1/2.png deleted file mode 100644 index 3ac6db0..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM1/2.png and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM2/1.png b/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM2/1.png deleted file mode 100644 index be5755f..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM2/1.png and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM2/2.png b/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM2/2.png deleted file mode 100644 index 421e8b8..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM2/2.png and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM3/1.png b/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM3/1.png deleted file mode 100644 index d46f1e3..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM3/1.png and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM3/2.png b/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM3/2.png deleted file mode 100644 index 3ac6db0..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM3/2.png and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM4/1.png b/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM4/1.png deleted file mode 100644 index be5755f..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM4/1.png and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM4/2.png b/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM4/2.png deleted file mode 100644 index 421e8b8..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM4/2.png and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM5/1.png b/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM5/1.png deleted file mode 100644 index d46f1e3..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM5/1.png and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM5/2.png b/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM5/2.png deleted file mode 100644 index 3ac6db0..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM5/2.png and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM6/1.png b/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM6/1.png deleted file mode 100644 index be5755f..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM6/1.png and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM6/2.png b/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM6/2.png deleted file mode 100644 index 421e8b8..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM6/2.png and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM7/1.png b/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM7/1.png deleted file mode 100644 index d46f1e3..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM7/1.png and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM7/2.png b/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM7/2.png deleted file mode 100644 index 3ac6db0..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM7/2.png and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM8/1.png b/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM8/1.png deleted file mode 100644 index be5755f..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM8/1.png and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM8/2.png b/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM8/2.png deleted file mode 100644 index 421e8b8..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/_dummyImages/CAM8/2.png and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/arm64/libHarfBuzzSharp.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/arm64/libHarfBuzzSharp.dll deleted file mode 100644 index 6375c7b..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/arm64/libHarfBuzzSharp.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/arm64/libSkiaSharp.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/arm64/libSkiaSharp.dll deleted file mode 100644 index 6e936f3..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/arm64/libSkiaSharp.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/de/MahApps.Metro.resources.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/de/MahApps.Metro.resources.dll deleted file mode 100644 index 442bb53..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/de/MahApps.Metro.resources.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/hermes.csharp.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/hermes.csharp.dll deleted file mode 100644 index 4257531..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/hermes.csharp.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/hislog.config b/Machines/_out_prismatic_rd_ptop/x64-Debug/hislog.config deleted file mode 100644 index fa5ddfa..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/hislog.config +++ /dev/null @@ -1,49 +0,0 @@ -{ - "LogConfigs": [ - { - "logger_name": "Aurora", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "D:\\ILSOSConfig\\_log", - "log_save_level": 0, - "log_file_prefix": "Aurora", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - }, - { - "logger_name": "process", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "_process", - "log_save_level": 0, - "log_file_prefix": "process", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - }, - { - "logger_name": "vision", - "collector_mode": "MANUAL", - "console_out": false, - "file_out": true, - "log_save_dir": "_vision", - "log_save_level": 0, - "log_file_prefix": "vision", - "log_file_size": 5, - "log_file_keepdays": 60, - "socket_port_number_publish": 50109, - "socket_port_number_logtransfer": 51109, - "log_save_date": true, - "log_save_date_size": 100 - } - ] -} \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/hislog2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/hislog2.dll deleted file mode 100644 index 4cdeb79..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/hislog2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ko-KR/Aurora.resources.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/ko-KR/Aurora.resources.dll deleted file mode 100644 index ca2f6ed..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/ko-KR/Aurora.resources.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ko-KR/VisionCommonUI.resources.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/ko-KR/VisionCommonUI.resources.dll deleted file mode 100644 index d6a04d9..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/ko-KR/VisionCommonUI.resources.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/libSkiaSharp.dylib b/Machines/_out_prismatic_rd_ptop/x64-Debug/libSkiaSharp.dylib deleted file mode 100644 index 9895bde..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/libSkiaSharp.dylib and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/milBlob.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/milBlob.dll deleted file mode 100644 index 5ef8c39..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/milBlob.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/milcal.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/milcal.dll deleted file mode 100644 index 7f738ab..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/milcal.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/milcolor.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/milcolor.dll deleted file mode 100644 index 0e6d8db..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/milcolor.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/mildig.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/mildig.dll deleted file mode 100644 index 5ef6b55..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/mildig.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/miledge.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/miledge.dll deleted file mode 100644 index d307824..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/miledge.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/milmod.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/milmod.dll deleted file mode 100644 index 2a61a94..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/milmod.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/msvcp140d.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/msvcp140d.dll deleted file mode 100644 index 15f9db1..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/msvcp140d.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/opencv_world348.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/opencv_world348.dll deleted file mode 100644 index 688c5bb..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/opencv_world348.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/opencv_world470d.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/opencv_world470d.dll deleted file mode 100644 index 0e42041..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/opencv_world470d.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/sys_error/20260605_103407.659.log b/Machines/_out_prismatic_rd_ptop/x64-Debug/sys_error/20260605_103407.659.log deleted file mode 100644 index 8daa8b6..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/sys_error/20260605_103407.659.log +++ /dev/null @@ -1,60 +0,0 @@ -System.Exception: ERR_SCANNER_FAIL_TO_OPEN_DLL_FILE;ERROR CODE:1 - 위치: AuroraLaserScanner.ScannerRTC5.Open() 파일 D:\Sources\oc5-ptop-rectangletypewelder\AuroraDevices\AuroraLaserScanner\ScannerRTC5.cs:줄 34 - 위치: AuroraLaserScanner.ScannerObj.Initialize(ScannerConfig config) 파일 D:\Sources\oc5-ptop-rectangletypewelder\AuroraDevices\AuroraLaserScanner\ScannerObj.cs:줄 188 - 위치: AuroraLaserScanner.ScannerRTC5.Initialize(ScannerConfig config) 파일 D:\Sources\oc5-ptop-rectangletypewelder\AuroraDevices\AuroraLaserScanner\ScannerRTC5.cs:줄 50 - 위치: AuroraLaserScanner.Scanner.DoActivate(IDeviceConfig config) 파일 D:\Sources\oc5-ptop-rectangletypewelder\AuroraDevices\AuroraLaserScanner\Scanner.cs:줄 69 - 위치: Aurora.Api.Device.Activate(IDeviceConfig config) - 위치: Aurora.View.MainScreen.UCMainTitle.InitDevice(Device device) - 위치: System.Threading.Tasks.Task`1.InnerInvoke() - 위치: System.Threading.Tasks.Task.Execute() ---- 예외가 throw된 이전 위치의 스택 추적 끝 --- - 위치: System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw() - 위치: Aurora.View.WinDeviceInitViewModel.d__50.MoveNext() ---- 예외가 throw된 이전 위치의 스택 추적 끝 --- - 위치: System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw() - 위치: System.Windows.Threading.ExceptionWrapper.InternalRealCall(Delegate callback, Object args, Int32 numArgs) - 위치: System.Windows.Threading.ExceptionWrapper.TryCatchWhen(Object source, Delegate callback, Object args, Int32 numArgs, Delegate catchHandler) - 위치: System.Windows.Threading.DispatcherOperation.InvokeImpl() - 위치: MS.Internal.CulturePreservingExecutionContext.CallbackWrapper(Object obj) - 위치: System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state, Boolean preserveSyncCtx) - 위치: System.Threading.ExecutionContext.Run(ExecutionContext executionContext, ContextCallback callback, Object state, Boolean preserveSyncCtx) - 위치: System.Threading.ExecutionContext.Run(ExecutionContext executionContext, ContextCallback callback, Object state) - 위치: MS.Internal.CulturePreservingExecutionContext.Run(CulturePreservingExecutionContext executionContext, ContextCallback callback, Object state) - 위치: System.Windows.Threading.DispatcherOperation.Invoke() - 위치: System.Windows.Threading.Dispatcher.ProcessQueue() - 위치: System.Windows.Threading.Dispatcher.WndProcHook(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam, Boolean& handled) - 위치: MS.Win32.HwndWrapper.WndProc(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam, Boolean& handled) - 위치: MS.Win32.HwndSubclass.DispatcherCallbackOperation(Object o) - 위치: System.Windows.Threading.ExceptionWrapper.InternalRealCall(Delegate callback, Object args, Int32 numArgs) - 위치: System.Windows.Threading.ExceptionWrapper.TryCatchWhen(Object source, Delegate callback, Object args, Int32 numArgs, Delegate catchHandler) - 위치: System.Windows.Threading.Dispatcher.LegacyInvokeImpl(DispatcherPriority priority, TimeSpan timeout, Delegate method, Object args, Int32 numArgs) - 위치: MS.Win32.HwndSubclass.SubclassWndProc(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam) - 위치: MS.Win32.UnsafeNativeMethods.DispatchMessage(MSG& msg) - 위치: System.Windows.Threading.Dispatcher.PushFrameImpl(DispatcherFrame frame) - 위치: System.Windows.Window.ShowHelper(Object booleanBox) - 위치: System.Windows.Window.ShowDialog() - 위치: Aurora.View.MainScreen.UCMainTitle.UCDeviceStatusView_CustomMouseDown(Object sender, EventArgs e) - 위치: System.Windows.RoutedEventArgs.InvokeHandler(Delegate handler, Object target) - 위치: System.Windows.RoutedEventHandlerInfo.InvokeHandler(Object target, RoutedEventArgs routedEventArgs) - 위치: System.Windows.EventRoute.InvokeHandlersImpl(Object source, RoutedEventArgs args, Boolean reRaised) - 위치: System.Windows.UIElement.RaiseEventImpl(DependencyObject sender, RoutedEventArgs args) - 위치: System.Windows.UIElement.RaiseTrustedEvent(RoutedEventArgs args) - 위치: System.Windows.Input.InputManager.ProcessStagingArea() - 위치: System.Windows.Input.InputManager.ProcessInput(InputEventArgs input) - 위치: System.Windows.Input.InputProviderSite.ReportInput(InputReport inputReport) - 위치: System.Windows.Interop.HwndMouseInputProvider.ReportInput(IntPtr hwnd, InputMode mode, Int32 timestamp, RawMouseActions actions, Int32 x, Int32 y, Int32 wheel) - 위치: System.Windows.Interop.HwndMouseInputProvider.FilterMessage(IntPtr hwnd, WindowMessage msg, IntPtr wParam, IntPtr lParam, Boolean& handled) - 위치: System.Windows.Interop.HwndSource.InputFilterMessage(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam, Boolean& handled) - 위치: MS.Win32.HwndWrapper.WndProc(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam, Boolean& handled) - 위치: MS.Win32.HwndSubclass.DispatcherCallbackOperation(Object o) - 위치: System.Windows.Threading.ExceptionWrapper.InternalRealCall(Delegate callback, Object args, Int32 numArgs) - 위치: System.Windows.Threading.ExceptionWrapper.TryCatchWhen(Object source, Delegate callback, Object args, Int32 numArgs, Delegate catchHandler) - 위치: System.Windows.Threading.Dispatcher.LegacyInvokeImpl(DispatcherPriority priority, TimeSpan timeout, Delegate method, Object args, Int32 numArgs) - 위치: MS.Win32.HwndSubclass.SubclassWndProc(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam) - 위치: MS.Win32.UnsafeNativeMethods.DispatchMessage(MSG& msg) - 위치: System.Windows.Threading.Dispatcher.PushFrameImpl(DispatcherFrame frame) - 위치: System.Windows.Application.RunDispatcher(Object ignore) - 위치: System.Windows.Application.RunInternal(Window window) - 위치: Aurora.AuroraApp.Main() - 위치: System.AppDomain.DoCallBack(CrossAppDomainDelegate callBackDelegate) - 위치: AppDomainLauncher.Launcher.<>c__DisplayClass4_0.b__0() \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/sys_error/20260605_105501.683.log b/Machines/_out_prismatic_rd_ptop/x64-Debug/sys_error/20260605_105501.683.log deleted file mode 100644 index 360beef..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/sys_error/20260605_105501.683.log +++ /dev/null @@ -1,29 +0,0 @@ -System.Exception: ERR_IO_FAIL_TO_GET_BIT;ERROR CODE:3102 - 위치: AuroraIO.AJINEXTEK.AjinIO.ReadDiBit(Int32 index) 파일 D:\Sources\oc5-ptop-rectangletypewelder\AuroraDevices\AuroraIO\Vendor\AJINEXTEK\AjinIO.cs:줄 510 - 위치: AuroraIO.IODevice.ReadDI(Int32 index) 파일 D:\Sources\oc5-ptop-rectangletypewelder\AuroraDevices\AuroraIO\IODevice.cs:줄 212 - 위치: WeldingCommon.Views.UCScannerObjectTeachingControlBoxViewModel.OnMonitoring(Object sender, EventArgs e) 파일 D:\Sources\oc5-ptop-rectangletypewelder\WeldingComponents\WeldingCommon\Views\Recipes\UCScannerObjectTeachingControlBoxViewModel.cs:줄 181 - 위치: System.Windows.Threading.DispatcherTimer.FireTick(Object unused) - 위치: System.Windows.Threading.ExceptionWrapper.InternalRealCall(Delegate callback, Object args, Int32 numArgs) - 위치: System.Windows.Threading.ExceptionWrapper.TryCatchWhen(Object source, Delegate callback, Object args, Int32 numArgs, Delegate catchHandler) - 위치: System.Windows.Threading.DispatcherOperation.InvokeImpl() - 위치: MS.Internal.CulturePreservingExecutionContext.CallbackWrapper(Object obj) - 위치: System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state, Boolean preserveSyncCtx) - 위치: System.Threading.ExecutionContext.Run(ExecutionContext executionContext, ContextCallback callback, Object state, Boolean preserveSyncCtx) - 위치: System.Threading.ExecutionContext.Run(ExecutionContext executionContext, ContextCallback callback, Object state) - 위치: MS.Internal.CulturePreservingExecutionContext.Run(CulturePreservingExecutionContext executionContext, ContextCallback callback, Object state) - 위치: System.Windows.Threading.DispatcherOperation.Invoke() - 위치: System.Windows.Threading.Dispatcher.ProcessQueue() - 위치: System.Windows.Threading.Dispatcher.WndProcHook(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam, Boolean& handled) - 위치: MS.Win32.HwndWrapper.WndProc(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam, Boolean& handled) - 위치: MS.Win32.HwndSubclass.DispatcherCallbackOperation(Object o) - 위치: System.Windows.Threading.ExceptionWrapper.InternalRealCall(Delegate callback, Object args, Int32 numArgs) - 위치: System.Windows.Threading.ExceptionWrapper.TryCatchWhen(Object source, Delegate callback, Object args, Int32 numArgs, Delegate catchHandler) - 위치: System.Windows.Threading.Dispatcher.LegacyInvokeImpl(DispatcherPriority priority, TimeSpan timeout, Delegate method, Object args, Int32 numArgs) - 위치: MS.Win32.HwndSubclass.SubclassWndProc(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam) - 위치: MS.Win32.UnsafeNativeMethods.DispatchMessage(MSG& msg) - 위치: System.Windows.Threading.Dispatcher.PushFrameImpl(DispatcherFrame frame) - 위치: System.Windows.Application.RunDispatcher(Object ignore) - 위치: System.Windows.Application.RunInternal(Window window) - 위치: Aurora.AuroraApp.Main() - 위치: System.AppDomain.DoCallBack(CrossAppDomainDelegate callBackDelegate) - 위치: AppDomainLauncher.Launcher.<>c__DisplayClass4_0.b__0() \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/sys_error/20260605_105539.070.log b/Machines/_out_prismatic_rd_ptop/x64-Debug/sys_error/20260605_105539.070.log deleted file mode 100644 index 360beef..0000000 --- a/Machines/_out_prismatic_rd_ptop/x64-Debug/sys_error/20260605_105539.070.log +++ /dev/null @@ -1,29 +0,0 @@ -System.Exception: ERR_IO_FAIL_TO_GET_BIT;ERROR CODE:3102 - 위치: AuroraIO.AJINEXTEK.AjinIO.ReadDiBit(Int32 index) 파일 D:\Sources\oc5-ptop-rectangletypewelder\AuroraDevices\AuroraIO\Vendor\AJINEXTEK\AjinIO.cs:줄 510 - 위치: AuroraIO.IODevice.ReadDI(Int32 index) 파일 D:\Sources\oc5-ptop-rectangletypewelder\AuroraDevices\AuroraIO\IODevice.cs:줄 212 - 위치: WeldingCommon.Views.UCScannerObjectTeachingControlBoxViewModel.OnMonitoring(Object sender, EventArgs e) 파일 D:\Sources\oc5-ptop-rectangletypewelder\WeldingComponents\WeldingCommon\Views\Recipes\UCScannerObjectTeachingControlBoxViewModel.cs:줄 181 - 위치: System.Windows.Threading.DispatcherTimer.FireTick(Object unused) - 위치: System.Windows.Threading.ExceptionWrapper.InternalRealCall(Delegate callback, Object args, Int32 numArgs) - 위치: System.Windows.Threading.ExceptionWrapper.TryCatchWhen(Object source, Delegate callback, Object args, Int32 numArgs, Delegate catchHandler) - 위치: System.Windows.Threading.DispatcherOperation.InvokeImpl() - 위치: MS.Internal.CulturePreservingExecutionContext.CallbackWrapper(Object obj) - 위치: System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state, Boolean preserveSyncCtx) - 위치: System.Threading.ExecutionContext.Run(ExecutionContext executionContext, ContextCallback callback, Object state, Boolean preserveSyncCtx) - 위치: System.Threading.ExecutionContext.Run(ExecutionContext executionContext, ContextCallback callback, Object state) - 위치: MS.Internal.CulturePreservingExecutionContext.Run(CulturePreservingExecutionContext executionContext, ContextCallback callback, Object state) - 위치: System.Windows.Threading.DispatcherOperation.Invoke() - 위치: System.Windows.Threading.Dispatcher.ProcessQueue() - 위치: System.Windows.Threading.Dispatcher.WndProcHook(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam, Boolean& handled) - 위치: MS.Win32.HwndWrapper.WndProc(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam, Boolean& handled) - 위치: MS.Win32.HwndSubclass.DispatcherCallbackOperation(Object o) - 위치: System.Windows.Threading.ExceptionWrapper.InternalRealCall(Delegate callback, Object args, Int32 numArgs) - 위치: System.Windows.Threading.ExceptionWrapper.TryCatchWhen(Object source, Delegate callback, Object args, Int32 numArgs, Delegate catchHandler) - 위치: System.Windows.Threading.Dispatcher.LegacyInvokeImpl(DispatcherPriority priority, TimeSpan timeout, Delegate method, Object args, Int32 numArgs) - 위치: MS.Win32.HwndSubclass.SubclassWndProc(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam) - 위치: MS.Win32.UnsafeNativeMethods.DispatchMessage(MSG& msg) - 위치: System.Windows.Threading.Dispatcher.PushFrameImpl(DispatcherFrame frame) - 위치: System.Windows.Application.RunDispatcher(Object ignore) - 위치: System.Windows.Application.RunInternal(Window window) - 위치: Aurora.AuroraApp.Main() - 위치: System.AppDomain.DoCallBack(CrossAppDomainDelegate callBackDelegate) - 위치: AppDomainLauncher.Launcher.<>c__DisplayClass4_0.b__0() \ No newline at end of file diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/tbb12_debug.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/tbb12_debug.dll deleted file mode 100644 index f953bce..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/tbb12_debug.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/ucrtbased.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/ucrtbased.dll deleted file mode 100644 index a6fd420..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/ucrtbased.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/vcruntime140_1d.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/vcruntime140_1d.dll deleted file mode 100644 index c43cb11..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/vcruntime140_1d.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/vcruntime140d.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/vcruntime140d.dll deleted file mode 100644 index 3705b39..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/vcruntime140d.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/vi-VN/VisionCommonUI.resources.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/vi-VN/VisionCommonUI.resources.dll deleted file mode 100644 index 5965181..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/vi-VN/VisionCommonUI.resources.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/AuroraNative.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/AuroraNative.dll deleted file mode 100644 index 0457f45..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/AuroraNative.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/GrabberIF.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/GrabberIF.dll deleted file mode 100644 index dd769d9..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/GrabberIF.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/GrabberIFCli.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/GrabberIFCli.dll deleted file mode 100644 index 50847cd..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/GrabberIFCli.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/MockGrabber.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/MockGrabber.dll deleted file mode 100644 index 7d2d8a1..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/MockGrabber.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/ToastNotificationWPFShared.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/ToastNotificationWPFShared.dll deleted file mode 100644 index a8c32ef..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/ToastNotificationWPFShared.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/ToastNotifications.Messages.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/ToastNotifications.Messages.dll deleted file mode 100644 index ee8996c..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/ToastNotifications.Messages.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/ToastNotifications.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/ToastNotifications.dll deleted file mode 100644 index e7e9f68..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/ToastNotifications.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/hislog2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/hislog2.dll deleted file mode 100644 index 4cdeb79..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/hislog2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/msvcp140d.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/msvcp140d.dll deleted file mode 100644 index 15f9db1..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/msvcp140d.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/opencv_world470d.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/opencv_world470d.dll deleted file mode 100644 index 0e42041..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/opencv_world470d.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/tbb12_debug.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/tbb12_debug.dll deleted file mode 100644 index f953bce..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/tbb12_debug.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/ucrtbased.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/ucrtbased.dll deleted file mode 100644 index a6fd420..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/ucrtbased.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/vcruntime140_1d.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/vcruntime140_1d.dll deleted file mode 100644 index c43cb11..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/vcruntime140_1d.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/vcruntime140d.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/vcruntime140d.dll deleted file mode 100644 index 3705b39..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Debug/vcruntime140d.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/AuroraNative.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/AuroraNative.dll deleted file mode 100644 index 6f48c68..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/AuroraNative.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/GrabberIF.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/GrabberIF.dll deleted file mode 100644 index cbdf232..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/GrabberIF.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/GrabberIFCli.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/GrabberIFCli.dll deleted file mode 100644 index e42a9ca..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/GrabberIFCli.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/MockGrabber.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/MockGrabber.dll deleted file mode 100644 index d11f318..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/MockGrabber.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/ToastNotificationWPFShared.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/ToastNotificationWPFShared.dll deleted file mode 100644 index d5a5e8f..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/ToastNotificationWPFShared.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/ToastNotifications.Messages.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/ToastNotifications.Messages.dll deleted file mode 100644 index ee8996c..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/ToastNotifications.Messages.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/ToastNotifications.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/ToastNotifications.dll deleted file mode 100644 index e7e9f68..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/ToastNotifications.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/hislog2.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/hislog2.dll deleted file mode 100644 index 2f4bd3b..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/hislog2.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/opencv_world470.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/opencv_world470.dll deleted file mode 100644 index c1e53bb..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/opencv_world470.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/tbb12.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/tbb12.dll deleted file mode 100644 index 975bf5d..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64-Release/tbb12.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64/libHarfBuzzSharp.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64/libHarfBuzzSharp.dll deleted file mode 100644 index b9960fb..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64/libHarfBuzzSharp.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64/libSkiaSharp.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x64/libSkiaSharp.dll deleted file mode 100644 index 4257d59..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x64/libSkiaSharp.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x86/libHarfBuzzSharp.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x86/libHarfBuzzSharp.dll deleted file mode 100644 index b93bfdb..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x86/libHarfBuzzSharp.dll and /dev/null differ diff --git a/Machines/_out_prismatic_rd_ptop/x64-Debug/x86/libSkiaSharp.dll b/Machines/_out_prismatic_rd_ptop/x64-Debug/x86/libSkiaSharp.dll deleted file mode 100644 index b9e588c..0000000 Binary files a/Machines/_out_prismatic_rd_ptop/x64-Debug/x86/libSkiaSharp.dll and /dev/null differ